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