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