yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/import_/AbstractImportStatementSupport.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 org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.SOURCE_PRE_LINKAGE;
  11 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
  12
  13 import com.google.common.base.Verify;
  14 import com.google.common.collect.ImmutableList;
  15 import java.net.URI;
  16 import java.util.Collection;
  17 import java.util.Optional;
  18 import org.opendaylight.yangtools.concepts.SemVer;
  19 import org.opendaylight.yangtools.yang.common.QNameModule;
  20 import org.opendaylight.yangtools.yang.common.Revision;
  21 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  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.ImportEffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.ImportStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.RevisionDateEffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.repo.api.SemVerSourceIdentifier;
  29 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseStringStatementSupport;
  30 import org.opendaylight.yangtools.yang.parser.spi.PreLinkageModuleNamespace;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  39 import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToNamespace;
  40 import org.opendaylight.yangtools.yang.parser.spi.source.ImportPrefixToSemVerSourceIdentifier;
  41 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNameToNamespace;
  42 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  43
  44 abstract class AbstractImportStatementSupport
  45         extends BaseStringStatementSupport<ImportStatement, ImportEffectiveStatement> {
  46     AbstractImportStatementSupport() {
  47         super(YangStmtMapping.IMPORT);
  48     }
  49
  50     @Override
  51     public final String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  52         return value;
  53     }
  54
  55     @Override
  56     public final void onPreLinkageDeclared(final Mutable<String, ImportStatement, ImportEffectiveStatement> stmt) {
  57         /*
  58          * Add ModuleIdentifier of a module which is required by this module.
  59          * Based on this information, required modules are searched from library
  60          * sources.
  61          */
  62         stmt.addRequiredSource(RevisionImport.getImportedSourceIdentifier(stmt));
  63
  64         final String moduleName = stmt.coerceStatementArgument();
  65         final ModelActionBuilder importAction = stmt.newInferenceAction(SOURCE_PRE_LINKAGE);
  66         final Prerequisite<StmtContext<?, ?, ?>> imported = importAction.requiresCtx(stmt,
  67                 PreLinkageModuleNamespace.class, moduleName, SOURCE_PRE_LINKAGE);
  68         final Prerequisite<Mutable<?, ?, ?>> linkageTarget = importAction
  69                 .mutatesCtx(stmt.getRoot(), SOURCE_PRE_LINKAGE);
  70
  71         importAction.apply(new InferenceAction() {
  72             @Override
  73             public void apply(final InferenceContext ctx) {
  74                 final StmtContext<?, ?, ?> importedModuleContext = imported.resolve(ctx);
  75                 Verify.verify(moduleName.equals(importedModuleContext.getStatementArgument()));
  76                 final URI importedModuleNamespace = importedModuleContext.getFromNamespace(ModuleNameToNamespace.class,
  77                         moduleName);
  78                 Verify.verifyNotNull(importedModuleNamespace);
  79                 final String impPrefix = SourceException.throwIfNull(
  80                     firstAttributeOf(stmt.declaredSubstatements(), PrefixStatement.class),
  81                     stmt.getStatementSourceReference(), "Missing prefix statement");
  82
  83                 stmt.addToNs(ImpPrefixToNamespace.class, impPrefix, importedModuleNamespace);
  84             }
  85
  86             @Override
  87             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
  88                 InferenceException.throwIf(failed.contains(imported), stmt.getStatementSourceReference(),
  89                         "Imported module [%s] was not found.", moduleName);
  90             }
  91         });
  92     }
  93
  94     @Override
  95     public final void onLinkageDeclared(final Mutable<String, ImportStatement, ImportEffectiveStatement> stmt) {
  96         if (stmt.isEnabledSemanticVersioning()) {
  97             SemanticVersionImport.onLinkageDeclared(stmt);
  98         } else {
  99             RevisionImport.onLinkageDeclared(stmt);
 100         }
 101     }
 102
 103     @Override
 104     protected final ImportStatement createDeclared(final StmtContext<String, ImportStatement, ?> ctx,
 105             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 106         return new ImportStatementImpl(ctx, substatements);
 107     }
 108
 109     @Override
 110     protected final ImportStatement createEmptyDeclared(final StmtContext<String, ImportStatement, ?> ctx) {
 111         throw new IllegalStateException("Unexpected empty declared import statement");
 112     }
 113
 114     @Override
 115     protected final ImportEffectiveStatement createEffective(
 116             final StmtContext<String, ImportStatement, ImportEffectiveStatement> ctx, final ImportStatement declared,
 117             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 118
 119         final String prefix = declared.getPrefix().getValue();
 120         final SemVer semVer;
 121         final Revision revision;
 122         if (!ctx.isEnabledSemanticVersioning()) {
 123             final Optional<Revision> optRev = substatements.stream()
 124                     .filter(RevisionDateEffectiveStatement.class::isInstance)
 125                     .findFirst()
 126                     .map(stmt -> ((RevisionDateEffectiveStatement) stmt).argument());
 127             revision = optRev.isPresent() ? optRev.get() : getImportedRevision(ctx, declared.getModule(), prefix);
 128             semVer = null;
 129         } else {
 130             final SemVerSourceIdentifier importedModuleIdentifier = ctx.getFromNamespace(
 131                 ImportPrefixToSemVerSourceIdentifier.class, prefix);
 132             revision = importedModuleIdentifier.getRevision().orElse(null);
 133             semVer = importedModuleIdentifier.getSemanticVersion().orElse(null);
 134         }
 135
 136         return new ImportEffectiveStatementImpl(declared, substatements, revision, semVer);
 137     }
 138
 139     @Override
 140     protected final ImportEffectiveStatement createEmptyEffective(
 141             final StmtContext<String, ImportStatement, ImportEffectiveStatement> ctx, final ImportStatement declared) {
 142         throw new IllegalStateException("Unexpected empty effective import statement");
 143     }
 144
 145     private static Revision getImportedRevision(final StmtContext<String, ImportStatement, ?> ctx,
 146             final String moduleName, final String prefix) {
 147         // When 'revision-date' of an import is not specified in yang source, we need to find revision of imported
 148         // module.
 149         final QNameModule importedModule = StmtContextUtils.getModuleQNameByPrefix(ctx, prefix);
 150         SourceException.throwIfNull(importedModule, ctx.getStatementSourceReference(),
 151                 "Unable to find import of module %s with prefix %s.", moduleName, prefix);
 152         return importedModule.getRevision().orElse(null);
 153     }
 154 }