yang/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 java.util.Objects.requireNonNull;
  11 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.SOURCE_LINKAGE;
  12 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.findFirstDeclaredSubstatement;
  13
  14 import com.google.common.annotations.Beta;
  15 import com.google.common.collect.ImmutableList;
  16 import java.util.Collection;
  17 import java.util.Optional;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.opendaylight.yangtools.yang.common.Revision;
  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.RevisionSourceIdentifier;
  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.AbstractStringStatementSupport;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  43 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  44 import org.opendaylight.yangtools.yang.parser.spi.source.IncludedModuleContext;
  45 import org.opendaylight.yangtools.yang.parser.spi.source.IncludedSubmoduleNameToModuleCtx;
  46
  47 @Beta
  48 public final class IncludeStatementSupport
  49         extends AbstractStringStatementSupport<IncludeStatement, IncludeEffectiveStatement> {
  50     private static final SubstatementValidator RFC6020_VALIDATOR =
  51         SubstatementValidator.builder(YangStmtMapping.INCLUDE)
  52             .addOptional(YangStmtMapping.REVISION_DATE)
  53             .build();
  54     private static final SubstatementValidator RFC7950_VALIDATOR =
  55         SubstatementValidator.builder(YangStmtMapping.INCLUDE)
  56             .addOptional(YangStmtMapping.REVISION_DATE)
  57             .addOptional(YangStmtMapping.DESCRIPTION)
  58             .addOptional(YangStmtMapping.REFERENCE)
  59             .build();
  60
  61     private final SubstatementValidator validator;
  62
  63     IncludeStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
  64         super(YangStmtMapping.INCLUDE, StatementPolicy.reject(), config);
  65         this.validator = requireNonNull(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<String, IncludeStatement, IncludeEffectiveStatement> stmt) {
  78         final StmtContext<Revision, ?, ?> revision = findFirstDeclaredSubstatement(stmt,
  79             RevisionDateStatement.class);
  80         stmt.addRequiredSource(revision == null ? RevisionSourceIdentifier.create(stmt.argument())
  81             : RevisionSourceIdentifier.create(stmt.argument(), revision.argument()));
  82     }
  83
  84     @Override
  85     public void onLinkageDeclared(final Mutable<String, IncludeStatement, IncludeEffectiveStatement> stmt) {
  86         final String 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
 104                 stmt.addToNs(IncludedModuleContext.class, revision != null
 105                         ? RevisionSourceIdentifier.create(submoduleName, revision.argument())
 106                                 : RevisionSourceIdentifier.create(submoduleName), includedSubModuleContext);
 107                 stmt.addToNs(IncludedSubmoduleNameToModuleCtx.class, stmt.argument(), includedSubModuleContext);
 108             }
 109
 110             @Override
 111             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 112                 InferenceException.throwIf(failed.contains(requiresCtxPrerequisite), stmt,
 113                     "Included submodule '%s' was not found: ", stmt.argument());
 114             }
 115         });
 116     }
 117
 118     @Override
 119     protected SubstatementValidator getSubstatementValidator() {
 120         return validator;
 121     }
 122
 123     @Override
 124     protected IncludeStatement createDeclared(final StmtContext<String, IncludeStatement, ?> ctx,
 125             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 126         return DeclaredStatements.createInclude(ctx.getRawArgument(), ctx.getArgument(), substatements);
 127     }
 128
 129     @Override
 130     protected IncludeStatement attachDeclarationReference(final IncludeStatement stmt,
 131             final DeclarationReference reference) {
 132         return DeclaredStatementDecorators.decorateInclude(stmt, reference);
 133     }
 134
 135     @Override
 136     protected IncludeEffectiveStatement createEffective(final Current<String, IncludeStatement> stmt,
 137             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 138         return EffectiveStatements.createInclude(stmt.declared(), substatements);
 139     }
 140 }