parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/IncludeStatementSupport.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.ModelProcessingPhase.SOURCE_LINKAGE;
  11 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.findFirstDeclaredSubstatement;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.collect.ImmutableList;
  15 import java.util.Collection;
  16 import java.util.Optional;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.opendaylight.yangtools.yang.common.Revision;
  19 import org.opendaylight.yangtools.yang.common.UnresolvedQName.Unqualified;
  20 import org.opendaylight.yangtools.yang.common.YangVersion;
  21 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  22 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  23 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  24 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.IncludeEffectiveStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.IncludeStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.RevisionDateStatement;
  28 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
  29 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  30 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  31 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  32 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  33 import org.opendaylight.yangtools.yang.parser.spi.SubmoduleNamespace;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractUnqualifiedStatementSupport;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
  43 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  44 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  45 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  46 import org.opendaylight.yangtools.yang.parser.spi.source.IncludedModuleContext;
  47 import org.opendaylight.yangtools.yang.parser.spi.source.IncludedSubmoduleNameToModuleCtx;
  48 import org.opendaylight.yangtools.yang.parser.spi.source.YangVersionLinkageException;
  49
  50 @Beta
  51 public final class IncludeStatementSupport
  52         extends AbstractUnqualifiedStatementSupport<IncludeStatement, IncludeEffectiveStatement> {
  53     private static final SubstatementValidator RFC6020_VALIDATOR =
  54         SubstatementValidator.builder(YangStmtMapping.INCLUDE)
  55             .addOptional(YangStmtMapping.REVISION_DATE)
  56             .build();
  57     private static final SubstatementValidator RFC7950_VALIDATOR =
  58         SubstatementValidator.builder(YangStmtMapping.INCLUDE)
  59             .addOptional(YangStmtMapping.REVISION_DATE)
  60             .addOptional(YangStmtMapping.DESCRIPTION)
  61             .addOptional(YangStmtMapping.REFERENCE)
  62             .build();
  63
  64     IncludeStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
  65         super(YangStmtMapping.INCLUDE, StatementPolicy.reject(), config, validator);
  66     }
  67
  68     public static @NonNull IncludeStatementSupport rfc6020Instance(final YangParserConfiguration config) {
  69         return new IncludeStatementSupport(config, RFC6020_VALIDATOR);
  70     }
  71
  72     public static @NonNull IncludeStatementSupport rfc7950Instance(final YangParserConfiguration config) {
  73         return new IncludeStatementSupport(config, RFC7950_VALIDATOR);
  74     }
  75
  76     @Override
  77     public void onPreLinkageDeclared(final Mutable<Unqualified, IncludeStatement, IncludeEffectiveStatement> stmt) {
  78         final StmtContext<Revision, ?, ?> revision = findFirstDeclaredSubstatement(stmt,
  79             RevisionDateStatement.class);
  80         stmt.addRequiredSource(revision == null ? RevisionSourceIdentifier.create(stmt.argument(), Optional.empty())
  81             : RevisionSourceIdentifier.create(stmt.argument(), revision.argument()));
  82     }
  83
  84     @Override
  85     public void onLinkageDeclared(final Mutable<Unqualified, IncludeStatement, IncludeEffectiveStatement> stmt) {
  86         final Unqualified submoduleName = stmt.getArgument();
  87         final StmtContext<Revision, ?, ?> revision = findFirstDeclaredSubstatement(stmt, RevisionDateStatement.class);
  88
  89         final ModelActionBuilder includeAction = stmt.newInferenceAction(SOURCE_LINKAGE);
  90         final Prerequisite<StmtContext<?, ?, ?>> requiresCtxPrerequisite;
  91         if (revision == null) {
  92             requiresCtxPrerequisite = includeAction.requiresCtx(stmt, SubmoduleNamespace.class,
  93                 NamespaceKeyCriterion.latestRevisionModule(submoduleName), SOURCE_LINKAGE);
  94         } else {
  95             requiresCtxPrerequisite = includeAction.requiresCtx(stmt, SubmoduleNamespace.class,
  96                 RevisionSourceIdentifier.create(submoduleName, Optional.of(revision.argument())), SOURCE_LINKAGE);
  97         }
  98
  99         includeAction.apply(new InferenceAction() {
 100             @Override
 101             public void apply(final InferenceContext ctx) {
 102                 final StmtContext<?, ?, ?> includedSubModuleContext = requiresCtxPrerequisite.resolve(ctx);
 103                 final YangVersion modVersion = stmt.getRoot().yangVersion();
 104                 final YangVersion subVersion = includedSubModuleContext.yangVersion();
 105                 if (subVersion != modVersion) {
 106                     throw new YangVersionLinkageException(stmt,
 107                         "Cannot include a version %s submodule in a version %s module", subVersion, modVersion);
 108                 }
 109
 110                 stmt.addToNs(IncludedModuleContext.class, revision != null
 111                     ? RevisionSourceIdentifier.create(submoduleName, revision.argument())
 112                         : RevisionSourceIdentifier.create(submoduleName, Optional.empty()), includedSubModuleContext);
 113                 stmt.addToNs(IncludedSubmoduleNameToModuleCtx.class, stmt.argument(), includedSubModuleContext);
 114             }
 115
 116             @Override
 117             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 118                 InferenceException.throwIf(failed.contains(requiresCtxPrerequisite), stmt,
 119                     "Included submodule '%s' was not found: ", stmt.argument());
 120             }
 121         });
 122     }
 123
 124     @Override
 125     protected IncludeStatement createDeclared(final BoundStmtCtx<Unqualified> ctx,
 126             final ImmutableList<DeclaredStatement<?>> substatements) {
 127         return DeclaredStatements.createInclude(ctx.getArgument(), substatements);
 128     }
 129
 130     @Override
 131     protected IncludeStatement attachDeclarationReference(final IncludeStatement stmt,
 132             final DeclarationReference reference) {
 133         return DeclaredStatementDecorators.decorateInclude(stmt, reference);
 134     }
 135
 136     @Override
 137     protected IncludeEffectiveStatement createEffective(final Current<Unqualified, IncludeStatement> stmt,
 138             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 139         return EffectiveStatements.createInclude(stmt.declared(), substatements);
 140     }
 141 }