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