parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/submodule/SubmoduleEffectiveStatementImpl.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.submodule;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.collect.ImmutableMap;
  14 import com.google.common.collect.ImmutableMap.Builder;
  15 import com.google.common.collect.ImmutableSet;
  16 import com.google.common.collect.Iterables;
  17 import com.google.common.collect.Maps;
  18 import java.util.Collection;
  19 import java.util.HashSet;
  20 import java.util.Map;
  21 import java.util.Map.Entry;
  22 import java.util.Optional;
  23 import java.util.Set;
  24 import org.eclipse.jdt.annotation.NonNull;
  25 import org.opendaylight.yangtools.yang.common.QNameModule;
  26 import org.opendaylight.yangtools.yang.common.Revision;
  27 import org.opendaylight.yangtools.yang.common.UnresolvedQName.Unqualified;
  28 import org.opendaylight.yangtools.yang.model.api.Submodule;
  29 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToEffectiveStatement;
  32 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
  33 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement.PrefixToEffectiveModuleNamespace;
  34 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement.QNameModuleToPrefixNamespace;
  35 import org.opendaylight.yangtools.yang.model.api.stmt.RevisionEffectiveStatement;
  36 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleEffectiveStatement;
  37 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
  38 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractEffectiveModule;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.CommonStmtCtx;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  43 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  44 import org.opendaylight.yangtools.yang.parser.spi.source.SourceParserNamespaces;
  45
  46 final class SubmoduleEffectiveStatementImpl
  47         extends AbstractEffectiveModule<SubmoduleStatement, SubmoduleEffectiveStatement>
  48         implements Submodule, SubmoduleEffectiveStatement, MutableStatement {
  49     private final ImmutableMap<String, ModuleEffectiveStatement> prefixToModule;
  50     private final ImmutableMap<QNameModule, String> namespaceToPrefix;
  51     private final QNameModule qnameModule;
  52
  53     private Set<StmtContext<?, SubmoduleStatement, SubmoduleEffectiveStatement>> submoduleContexts;
  54     private ImmutableSet<Submodule> submodules;
  55     private boolean sealed;
  56
  57     SubmoduleEffectiveStatementImpl(final Current<Unqualified, SubmoduleStatement> stmt,
  58             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  59         super(stmt, substatements, findSubmodulePrefix(stmt, substatements));
  60
  61         final QNameModule belongsToModuleQName = stmt.getFromNamespace(SourceParserNamespaces.MODULE_NAME_TO_QNAME,
  62             findBelongsTo(stmt, substatements).argument());
  63
  64         final Builder<String, ModuleEffectiveStatement> prefixToModuleBuilder = ImmutableMap.builder();
  65         appendPrefixes(stmt, prefixToModuleBuilder);
  66         prefixToModule = prefixToModuleBuilder.build();
  67
  68         final Map<QNameModule, String> tmp = Maps.newLinkedHashMapWithExpectedSize(prefixToModule.size());
  69         for (Entry<String, ModuleEffectiveStatement> e : prefixToModule.entrySet()) {
  70             tmp.putIfAbsent(e.getValue().localQNameModule(), e.getKey());
  71         }
  72         namespaceToPrefix = ImmutableMap.copyOf(tmp);
  73
  74         final Optional<Revision> submoduleRevision = findFirstEffectiveSubstatementArgument(
  75             RevisionEffectiveStatement.class);
  76         qnameModule = QNameModule.create(belongsToModuleQName.getNamespace(), submoduleRevision).intern();
  77
  78         /*
  79          * Because of possible circular chains of includes between submodules we can
  80          * collect only submodule contexts here and then build them during
  81          * sealing of this statement.
  82          */
  83         final Map<Unqualified, StmtContext<?, ?, ?>> includedSubmodulesMap = stmt.localNamespacePortion(
  84             SourceParserNamespaces.INCLUDED_SUBMODULE_NAME_TO_MODULECTX);
  85         if (includedSubmodulesMap != null) {
  86             final Set<StmtContext<?, SubmoduleStatement, SubmoduleEffectiveStatement>> submoduleContextsInit =
  87                 new HashSet<>();
  88             for (final StmtContext<?, ?, ?> submoduleCtx : includedSubmodulesMap.values()) {
  89                 submoduleContextsInit.add(
  90                     (StmtContext<?, SubmoduleStatement, SubmoduleEffectiveStatement>)submoduleCtx);
  91             }
  92             submoduleContexts = ImmutableSet.copyOf(submoduleContextsInit);
  93         } else {
  94             submoduleContexts = ImmutableSet.of();
  95         }
  96
  97         if (submoduleContexts.isEmpty()) {
  98             submodules = ImmutableSet.of();
  99             sealed = true;
 100         } else {
 101             sealed = false;
 102         }
 103     }
 104
 105     @Override
 106     public QNameModule getQNameModule() {
 107         return qnameModule;
 108     }
 109
 110     @Override
 111     @SuppressWarnings("unchecked")
 112     public <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
 113             final @NonNull Class<N> namespace) {
 114         if (PrefixToEffectiveModuleNamespace.class.equals(namespace)) {
 115             return Optional.of((Map<K, V>) prefixToModule);
 116         }
 117         if (QNameModuleToPrefixNamespace.class.equals(namespace)) {
 118             return Optional.of((Map<K, V>) namespaceToPrefix);
 119         }
 120         return super.getNamespaceContents(namespace);
 121     }
 122
 123     @Override
 124     public Collection<? extends @NonNull Submodule> getSubmodules() {
 125         checkState(sealed, "Attempt to get base submodules from unsealed submodule effective statement %s",
 126             qnameModule);
 127         return submodules;
 128     }
 129
 130     @Override
 131     public SubmoduleEffectiveStatement asEffectiveStatement() {
 132         return this;
 133     }
 134
 135     @Override
 136     public void seal() {
 137         if (!sealed) {
 138             submodules = ImmutableSet.copyOf(Iterables.transform(submoduleContexts,
 139                 ctx -> (Submodule) ctx.buildEffective()));
 140             submoduleContexts = ImmutableSet.of();
 141             sealed = true;
 142         }
 143     }
 144
 145     private static @NonNull BelongsToEffectiveStatement findBelongsTo(final CommonStmtCtx stmt,
 146             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 147         return substatements.stream()
 148             .filter(BelongsToEffectiveStatement.class::isInstance)
 149             .map(BelongsToEffectiveStatement.class::cast)
 150             .findAny().orElseThrow(() -> new SourceException(stmt,
 151                 "Unable to find belongs-to statement in submodule %s.", stmt.rawArgument()));
 152     }
 153
 154     private static @NonNull String findSubmodulePrefix(final CommonStmtCtx stmt,
 155             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 156         return findPrefix(stmt, findBelongsTo(stmt, substatements).effectiveSubstatements(), "submodule",
 157             stmt.getRawArgument());
 158     }
 159 }