parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/BelongsToStatementSupport.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.meta;
   9
  10 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.findFirstDeclaredSubstatement;
  11
  12 import com.google.common.collect.ImmutableList;
  13 import java.util.Collection;
  14 import org.opendaylight.yangtools.yang.common.UnresolvedQName.Unqualified;
  15 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  16 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  17 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  18 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  19 import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToEffectiveStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  23 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  24 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  25 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  26 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  27 import org.opendaylight.yangtools.yang.parser.spi.ParserNamespaces;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractUnqualifiedStatementSupport;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  39
  40 public final class BelongsToStatementSupport
  41         extends AbstractUnqualifiedStatementSupport<BelongsToStatement, BelongsToEffectiveStatement> {
  42     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
  43             SubstatementValidator.builder(YangStmtMapping.BELONGS_TO).addMandatory(YangStmtMapping.PREFIX).build();
  44
  45     public BelongsToStatementSupport(final YangParserConfiguration config) {
  46         super(YangStmtMapping.BELONGS_TO, StatementPolicy.reject(), config, SUBSTATEMENT_VALIDATOR);
  47     }
  48
  49     @Override
  50     public void onPreLinkageDeclared(final Mutable<Unqualified, BelongsToStatement, BelongsToEffectiveStatement> ctx) {
  51         ctx.addRequiredSource(new SourceIdentifier(ctx.getArgument()));
  52     }
  53
  54     @Override
  55     public void onLinkageDeclared(
  56             final Mutable<Unqualified, BelongsToStatement, BelongsToEffectiveStatement> belongsToCtx) {
  57         ModelActionBuilder belongsToAction = belongsToCtx.newInferenceAction(ModelProcessingPhase.SOURCE_LINKAGE);
  58
  59         final var belongsToPrereq = belongsToAction.requiresCtx(belongsToCtx, ParserNamespaces.MODULE_FOR_BELONGSTO,
  60             belongsToCtx.getArgument(), ModelProcessingPhase.SOURCE_LINKAGE);
  61
  62         belongsToAction.apply(new InferenceAction() {
  63             @Override
  64             public void apply(final InferenceContext ctx) {
  65                 belongsToCtx.addToNs(ParserNamespaces.BELONGSTO_PREFIX_TO_MODULECTX,
  66                     findFirstDeclaredSubstatement(belongsToCtx, PrefixStatement.class).getArgument(),
  67                     belongsToPrereq.resolve(ctx));
  68             }
  69
  70             @Override
  71             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
  72                 if (failed.contains(belongsToPrereq)) {
  73                     throw new InferenceException(belongsToCtx, "Module '%s' from belongs-to was not found",
  74                         belongsToCtx.argument());
  75                 }
  76             }
  77         });
  78     }
  79
  80     @Override
  81     protected BelongsToStatement createDeclared(final BoundStmtCtx<Unqualified> ctx,
  82             final ImmutableList<DeclaredStatement<?>> substatements) {
  83         return DeclaredStatements.createBelongsTo(ctx.getArgument(), substatements);
  84     }
  85
  86     @Override
  87     protected BelongsToStatement attachDeclarationReference(final BelongsToStatement stmt,
  88             final DeclarationReference reference) {
  89         return DeclaredStatementDecorators.decorateBelongsTo(stmt, reference);
  90     }
  91
  92     @Override
  93     protected BelongsToEffectiveStatement createEffective(final Current<Unqualified, BelongsToStatement> stmt,
  94             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  95         return EffectiveStatements.createBelongsTo(stmt.declared(), substatements);
  96     }
  97 }