yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/include/AbstractIncludeStatementSupport.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.include;
   9
  10 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.SOURCE_LINKAGE;
  11 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.findFirstDeclaredSubstatement;
  12
  13 import java.util.Collection;
  14 import java.util.Optional;
  15 import org.opendaylight.yangtools.yang.common.Revision;
  16 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  17 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  18 import org.opendaylight.yangtools.yang.model.api.stmt.IncludeStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.RevisionDateStatement;
  20 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
  21 import org.opendaylight.yangtools.yang.parser.spi.SubmoduleNamespace;
  22 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  23 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  31 import org.opendaylight.yangtools.yang.parser.spi.source.IncludedModuleContext;
  32 import org.opendaylight.yangtools.yang.parser.spi.source.IncludedSubmoduleNameToModuleCtx;
  33
  34 abstract class AbstractIncludeStatementSupport extends
  35         AbstractStatementSupport<String, IncludeStatement, EffectiveStatement<String, IncludeStatement>> {
  36
  37     AbstractIncludeStatementSupport() {
  38         super(YangStmtMapping.INCLUDE);
  39     }
  40
  41     @Override
  42     public final String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  43         return value;
  44     }
  45
  46     @Override
  47     public final IncludeStatement createDeclared(final StmtContext<String, IncludeStatement, ?> ctx) {
  48         return new IncludeStatementImpl(ctx);
  49     }
  50
  51     @Override
  52     public final EffectiveStatement<String, IncludeStatement> createEffective(
  53             final StmtContext<String, IncludeStatement, EffectiveStatement<String, IncludeStatement>> ctx) {
  54         return new IncludeEffectiveStatementImpl(ctx);
  55     }
  56
  57     @Override
  58     public final void onPreLinkageDeclared(
  59             final Mutable<String, IncludeStatement, EffectiveStatement<String, IncludeStatement>> stmt) {
  60         final StmtContext<Revision, ?, ?> revision = findFirstDeclaredSubstatement(stmt,
  61             RevisionDateStatement.class);
  62         stmt.addRequiredSource(revision == null ? RevisionSourceIdentifier.create(stmt.getStatementArgument())
  63             : RevisionSourceIdentifier.create(stmt.getStatementArgument(), revision.getStatementArgument()));
  64     }
  65
  66     @Override
  67     public final void onLinkageDeclared(
  68             final Mutable<String, IncludeStatement, EffectiveStatement<String, IncludeStatement>> stmt) {
  69         final String submoduleName = stmt.getStatementArgument();
  70         final StmtContext<Revision, ?, ?> revision = findFirstDeclaredSubstatement(stmt,
  71             RevisionDateStatement.class);
  72
  73         final ModelActionBuilder includeAction = stmt.newInferenceAction(SOURCE_LINKAGE);
  74         final Prerequisite<StmtContext<?, ?, ?>> requiresCtxPrerequisite;
  75         if (revision == null) {
  76             requiresCtxPrerequisite = includeAction.requiresCtx(stmt, SubmoduleNamespace.class,
  77                 NamespaceKeyCriterion.latestRevisionModule(submoduleName), SOURCE_LINKAGE);
  78         } else {
  79             requiresCtxPrerequisite = includeAction.requiresCtx(stmt, SubmoduleNamespace.class,
  80                 RevisionSourceIdentifier.create(submoduleName, Optional.of(revision.getStatementArgument())),
  81                 SOURCE_LINKAGE);
  82         }
  83
  84         includeAction.apply(new InferenceAction() {
  85             @Override
  86             public void apply(final InferenceContext ctx) {
  87                 final StmtContext<?, ?, ?> includedSubModuleContext = requiresCtxPrerequisite.resolve(ctx);
  88
  89                 stmt.addToNs(IncludedModuleContext.class, revision != null
  90                         ? RevisionSourceIdentifier.create(submoduleName, revision.getStatementArgument())
  91                                 : RevisionSourceIdentifier.create(submoduleName), includedSubModuleContext);
  92                 stmt.addToNs(IncludedSubmoduleNameToModuleCtx.class, stmt.getStatementArgument(),
  93                     includedSubModuleContext);
  94             }
  95
  96             @Override
  97             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
  98                 InferenceException.throwIf(failed.contains(requiresCtxPrerequisite),
  99                     stmt.getStatementSourceReference(),
 100                     "Included submodule '%s' was not found: ", stmt.getStatementArgument());
 101             }
 102         });
 103     }
 104 }