yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/import_/ImportStatementSupport.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.import_;
   9
  10 import static com.google.common.base.Verify.verify;
  11 import static com.google.common.base.Verify.verifyNotNull;
  12 import static java.util.Objects.requireNonNull;
  13 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.SOURCE_PRE_LINKAGE;
  14 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
  15
  16 import com.google.common.annotations.Beta;
  17 import com.google.common.collect.ImmutableList;
  18 import java.util.Collection;
  19 import org.eclipse.jdt.annotation.NonNull;
  20 import org.opendaylight.yangtools.openconfig.model.api.OpenConfigStatements;
  21 import org.opendaylight.yangtools.yang.common.Empty;
  22 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  23 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  24 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  25 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  26 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.ImportEffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.ImportStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  30 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  31 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  32 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  33 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  34 import org.opendaylight.yangtools.yang.parser.spi.PreLinkageModuleNamespace;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStringStatementSupport;
  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.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.ImpPrefixToNamespace;
  46 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNameToNamespace;
  47 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  48
  49 @Beta
  50 public final class ImportStatementSupport
  51         extends AbstractStringStatementSupport<ImportStatement, ImportEffectiveStatement> {
  52     private static final SubstatementValidator RFC6020_VALIDATOR =
  53         SubstatementValidator.builder(YangStmtMapping.IMPORT)
  54             .addMandatory(YangStmtMapping.PREFIX)
  55             .addOptional(YangStmtMapping.REVISION_DATE)
  56             .addOptional(OpenConfigStatements.OPENCONFIG_VERSION)
  57             .build();
  58     private static final SubstatementValidator RFC7950_VALIDATOR =
  59         SubstatementValidator.builder(YangStmtMapping.IMPORT)
  60             .addMandatory(YangStmtMapping.PREFIX)
  61             .addOptional(YangStmtMapping.REVISION_DATE)
  62             .addOptional(OpenConfigStatements.OPENCONFIG_VERSION)
  63             .addOptional(YangStmtMapping.DESCRIPTION)
  64             .addOptional(YangStmtMapping.REFERENCE)
  65             .build();
  66
  67     private final SubstatementValidator validator;
  68
  69     private ImportStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
  70         super(YangStmtMapping.IMPORT, StatementPolicy.reject(), config);
  71         this.validator = requireNonNull(validator);
  72     }
  73
  74     public static @NonNull ImportStatementSupport rfc6020Instance(final YangParserConfiguration config) {
  75         return new ImportStatementSupport(config, RFC6020_VALIDATOR);
  76     }
  77
  78     public static @NonNull ImportStatementSupport rfc7950Instance(final YangParserConfiguration config) {
  79         return new ImportStatementSupport(config, RFC7950_VALIDATOR);
  80     }
  81
  82     @Override
  83     public void onPreLinkageDeclared(final Mutable<String, ImportStatement, ImportEffectiveStatement> stmt) {
  84         /*
  85          * Add ModuleIdentifier of a module which is required by this module.
  86          * Based on this information, required modules are searched from library
  87          * sources.
  88          */
  89         stmt.addRequiredSource(RevisionImport.getImportedSourceIdentifier(stmt));
  90
  91         final String moduleName = stmt.getArgument();
  92         final ModelActionBuilder importAction = stmt.newInferenceAction(SOURCE_PRE_LINKAGE);
  93         final Prerequisite<StmtContext<?, ?, ?>> imported = importAction.requiresCtx(stmt,
  94                 PreLinkageModuleNamespace.class, moduleName, SOURCE_PRE_LINKAGE);
  95         importAction.mutatesCtx(stmt.getRoot(), SOURCE_PRE_LINKAGE);
  96
  97         importAction.apply(new InferenceAction() {
  98             @Override
  99             public void apply(final InferenceContext ctx) {
 100                 final StmtContext<?, ?, ?> importedModuleContext = imported.resolve(ctx);
 101                 verify(moduleName.equals(importedModuleContext.getRawArgument()));
 102                 final XMLNamespace importedModuleNamespace = verifyNotNull(
 103                     importedModuleContext.getFromNamespace(ModuleNameToNamespace.class, moduleName));
 104                 final String impPrefix = SourceException.throwIfNull(
 105                     firstAttributeOf(stmt.declaredSubstatements(), PrefixStatement.class), stmt,
 106                     "Missing prefix statement");
 107
 108                 stmt.addToNs(ImpPrefixToNamespace.class, impPrefix, importedModuleNamespace);
 109             }
 110
 111             @Override
 112             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 113                 InferenceException.throwIf(failed.contains(imported), stmt, "Imported module [%s] was not found.",
 114                     moduleName);
 115             }
 116         });
 117     }
 118
 119     @Override
 120     public void onLinkageDeclared(final Mutable<String, ImportStatement, ImportEffectiveStatement> stmt) {
 121         if (stmt.isEnabledSemanticVersioning()) {
 122             SemanticVersionImport.onLinkageDeclared(stmt);
 123         } else {
 124             RevisionImport.onLinkageDeclared(stmt);
 125         }
 126     }
 127
 128     @Override
 129     protected SubstatementValidator getSubstatementValidator() {
 130         return validator;
 131     }
 132
 133     @Override
 134     protected ImportStatement createDeclared(final StmtContext<String, ImportStatement, ?> ctx,
 135             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 136         return DeclaredStatements.createImport(ctx.getRawArgument(), substatements);
 137     }
 138
 139     @Override
 140     protected ImportStatement attachDeclarationReference(final ImportStatement stmt,
 141             final DeclarationReference reference) {
 142         return DeclaredStatementDecorators.decorateImport(stmt, reference);
 143     }
 144
 145     @Override
 146     protected ImportEffectiveStatement createEffective(final Current<String, ImportStatement> stmt,
 147             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 148         InferenceException.throwIf(substatements.isEmpty(), stmt, "Unexpected empty effective import statement");
 149         return EffectiveStatements.createImport(stmt.declared(), substatements,
 150             verifyNotNull(stmt.getFromNamespace(ImportedVersionNamespace.class, Empty.getInstance())));
 151     }
 152 }