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