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.model.api.YangStmtMapping;
  15 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  16 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  17 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  18 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToEffectiveStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  21 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
  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.AbstractStringStatementSupport;
  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 AbstractStringStatementSupport<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<String, BelongsToStatement, BelongsToEffectiveStatement> ctx) {
  54         ctx.addRequiredSource(getSourceIdentifier(ctx));
  55     }
  56
  57     @Override
  58     public void onLinkageDeclared(final Mutable<String, BelongsToStatement, BelongsToEffectiveStatement> belongsToCtx) {
  59         ModelActionBuilder belongsToAction = belongsToCtx.newInferenceAction(ModelProcessingPhase.SOURCE_LINKAGE);
  60
  61         final SourceIdentifier belongsToSourceIdentifier = getSourceIdentifier(belongsToCtx);
  62         final Prerequisite<StmtContext<?, ?, ?>> belongsToPrereq = belongsToAction.requiresCtx(belongsToCtx,
  63             ModuleNamespaceForBelongsTo.class, belongsToCtx.getArgument(), ModelProcessingPhase.SOURCE_LINKAGE);
  64
  65         belongsToAction.apply(new InferenceAction() {
  66             @Override
  67             public void apply(final InferenceContext ctx) {
  68                 StmtContext<?, ?, ?> belongsToModuleCtx = belongsToPrereq.resolve(ctx);
  69
  70                 belongsToCtx.addToNs(BelongsToModuleContext.class, belongsToSourceIdentifier, belongsToModuleCtx);
  71                 belongsToCtx.addToNs(BelongsToPrefixToModuleCtx.class,
  72                     findFirstDeclaredSubstatement(belongsToCtx, PrefixStatement.class).getArgument(),
  73                     belongsToModuleCtx);
  74             }
  75
  76             @Override
  77             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
  78                 if (failed.contains(belongsToPrereq)) {
  79                     throw new InferenceException(belongsToCtx, "Module '%s' from belongs-to was not found",
  80                         belongsToCtx.argument());
  81                 }
  82             }
  83         });
  84     }
  85
  86     @Override
  87     protected BelongsToStatement createDeclared(final BoundStmtCtx<String> ctx,
  88             final ImmutableList<DeclaredStatement<?>> substatements) {
  89         return DeclaredStatements.createBelongsTo(ctx.getRawArgument(), substatements);
  90     }
  91
  92     @Override
  93     protected BelongsToStatement attachDeclarationReference(final BelongsToStatement stmt,
  94             final DeclarationReference reference) {
  95         return DeclaredStatementDecorators.decorateBelongsTo(stmt, reference);
  96     }
  97
  98     @Override
  99     protected BelongsToEffectiveStatement createEffective(final Current<String, BelongsToStatement> stmt,
 100             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 101         return EffectiveStatements.createBelongsTo(stmt.declared(), substatements);
 102     }
 103
 104     private static SourceIdentifier getSourceIdentifier(final StmtContext<String, BelongsToStatement,
 105             BelongsToEffectiveStatement> belongsToCtx) {
 106         return RevisionSourceIdentifier.create(belongsToCtx.getArgument());
 107     }
 108 }