yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/import_/RevisionImport.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.import_;
   9
  10 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.SOURCE_LINKAGE;
  11 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.findFirstDeclaredSubstatement;
  12 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
  13
  14 import java.net.URI;
  15 import java.util.Collection;
  16 import java.util.Optional;
  17 import org.opendaylight.yangtools.yang.common.QNameModule;
  18 import org.opendaylight.yangtools.yang.common.Revision;
  19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.ImportStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.NamespaceStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.RevisionDateStatement;
  24 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
  25 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  26 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.ModuleQNameToPrefix;
  27 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.URIStringToImportPrefix;
  28 import org.opendaylight.yangtools.yang.parser.spi.ModuleNamespace;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  37 import org.opendaylight.yangtools.yang.parser.spi.source.ImportPrefixToModuleCtx;
  38 import org.opendaylight.yangtools.yang.parser.spi.source.ImportedModuleContext;
  39 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
  40 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToSourceIdentifier;
  41
  42 final class RevisionImport {
  43
  44     private RevisionImport() {
  45         throw new UnsupportedOperationException("Utility class");
  46     }
  47
  48     static void onLinkageDeclared(
  49             final Mutable<String, ImportStatement, EffectiveStatement<String, ImportStatement>> stmt) {
  50         final ModelActionBuilder importAction = stmt.newInferenceAction(SOURCE_LINKAGE);
  51         final Prerequisite<StmtContext<?, ?, ?>> imported;
  52         final String moduleName = stmt.coerceStatementArgument();
  53         final Revision revision = firstAttributeOf(stmt.declaredSubstatements(), RevisionDateStatement.class);
  54         if (revision == null) {
  55             imported = importAction.requiresCtx(stmt, ModuleNamespace.class,
  56                 NamespaceKeyCriterion.latestRevisionModule(moduleName), SOURCE_LINKAGE);
  57         } else {
  58             imported = importAction.requiresCtx(stmt, ModuleNamespace.class,
  59                 RevisionSourceIdentifier.create(moduleName, Optional.of(revision)), SOURCE_LINKAGE);
  60         }
  61
  62         final Prerequisite<Mutable<?, ?, ?>> linkageTarget = importAction.mutatesCtx(stmt.getRoot(),
  63             SOURCE_LINKAGE);
  64
  65         importAction.apply(new InferenceAction() {
  66             @Override
  67             public void apply(final InferenceContext ctx) {
  68                 final StmtContext<?, ?, ?> importedModule = imported.resolve(ctx);
  69
  70                 final QNameModule mod = InferenceException.throwIfNull(stmt.getFromNamespace(
  71                     ModuleCtxToModuleQName.class, importedModule), stmt.getStatementSourceReference(),
  72                     "Failed to find module of %s", importedModule);
  73
  74                 linkageTarget.resolve(ctx).addToNs(ImportedModuleContext.class,
  75                     stmt.getFromNamespace(ModuleCtxToSourceIdentifier.class, importedModule), importedModule);
  76                 final String impPrefix = firstAttributeOf(stmt.declaredSubstatements(), PrefixStatement.class);
  77                 final URI modNs = firstAttributeOf(importedModule.declaredSubstatements(),
  78                     NamespaceStatement.class);
  79                 stmt.addToNs(ImportPrefixToModuleCtx.class, impPrefix, importedModule);
  80                 stmt.addToNs(ModuleQNameToPrefix.class, mod, impPrefix);
  81                 stmt.addToNs(URIStringToImportPrefix.class, modNs.toString(), impPrefix);
  82             }
  83
  84             @Override
  85             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
  86                 if (failed.contains(imported)) {
  87                     throw new InferenceException(stmt.getStatementSourceReference(),
  88                             "Imported module [%s] was not found.", moduleName);
  89                 }
  90             }
  91         });
  92     }
  93
  94     static SourceIdentifier getImportedSourceIdentifier(final StmtContext<String, ImportStatement, ?> stmt) {
  95         final StmtContext<Revision, ?, ?> revision = findFirstDeclaredSubstatement(stmt,
  96             RevisionDateStatement.class);
  97         return revision == null ? RevisionSourceIdentifier.create(stmt.getStatementArgument())
  98                 : RevisionSourceIdentifier.create(stmt.getStatementArgument(), revision.getStatementArgument());
  99     }
 100 }