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.stmt.BelongsToEffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  22 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  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.meta.AbstractUnqualifiedStatementSupport;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  39 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToModuleContext;
  40 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleCtx;
  41 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNamespaceForBelongsTo;
  42
  43 public final class BelongsToStatementSupport
  44         extends AbstractUnqualifiedStatementSupport<BelongsToStatement, BelongsToEffectiveStatement> {
  45     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
  46             SubstatementValidator.builder(YangStmtMapping.BELONGS_TO).addMandatory(YangStmtMapping.PREFIX).build();
  47
  48     public BelongsToStatementSupport(final YangParserConfiguration config) {
  49         super(YangStmtMapping.BELONGS_TO, StatementPolicy.reject(), config, SUBSTATEMENT_VALIDATOR);
  50     }
  51
  52     @Override
  53     public void onPreLinkageDeclared(final Mutable<Unqualified, BelongsToStatement, BelongsToEffectiveStatement> ctx) {
  54         ctx.addRequiredSource(new SourceIdentifier(ctx.getArgument()));
  55     }
  56
  57     @Override
  58     public void onLinkageDeclared(
  59             final Mutable<Unqualified, BelongsToStatement, BelongsToEffectiveStatement> belongsToCtx) {
  60         ModelActionBuilder belongsToAction = belongsToCtx.newInferenceAction(ModelProcessingPhase.SOURCE_LINKAGE);
  61
  62         final SourceIdentifier belongsToSourceIdentifier = new SourceIdentifier(belongsToCtx.getArgument());
  63         final Prerequisite<StmtContext<?, ?, ?>> belongsToPrereq = belongsToAction.requiresCtx(belongsToCtx,
  64             ModuleNamespaceForBelongsTo.class, belongsToCtx.getArgument(), ModelProcessingPhase.SOURCE_LINKAGE);
  65
  66         belongsToAction.apply(new InferenceAction() {
  67             @Override
  68             public void apply(final InferenceContext ctx) {
  69                 StmtContext<?, ?, ?> belongsToModuleCtx = belongsToPrereq.resolve(ctx);
  70
  71                 belongsToCtx.addToNs(BelongsToModuleContext.class, belongsToSourceIdentifier, belongsToModuleCtx);
  72                 belongsToCtx.addToNs(BelongsToPrefixToModuleCtx.class,
  73                     findFirstDeclaredSubstatement(belongsToCtx, PrefixStatement.class).getArgument(),
  74                     belongsToModuleCtx);
  75             }
  76
  77             @Override
  78             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
  79                 if (failed.contains(belongsToPrereq)) {
  80                     throw new InferenceException(belongsToCtx, "Module '%s' from belongs-to was not found",
  81                         belongsToCtx.argument());
  82                 }
  83             }
  84         });
  85     }
  86
  87     @Override
  88     protected BelongsToStatement createDeclared(final BoundStmtCtx<Unqualified> ctx,
  89             final ImmutableList<DeclaredStatement<?>> substatements) {
  90         return DeclaredStatements.createBelongsTo(ctx.getArgument(), substatements);
  91     }
  92
  93     @Override
  94     protected BelongsToStatement attachDeclarationReference(final BelongsToStatement stmt,
  95             final DeclarationReference reference) {
  96         return DeclaredStatementDecorators.decorateBelongsTo(stmt, reference);
  97     }
  98
  99     @Override
 100     protected BelongsToEffectiveStatement createEffective(final Current<Unqualified, BelongsToStatement> stmt,
 101             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 102         return EffectiveStatements.createBelongsTo(stmt.declared(), substatements);
 103     }
 104 }