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