parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/AbstractEffectiveModule.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;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.collect.Collections2;
  15 import com.google.common.collect.ImmutableList;
  16 import com.google.common.collect.ImmutableMap.Builder;
  17 import com.google.common.collect.ImmutableSet;
  18 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  19 import java.util.Collection;
  20 import java.util.LinkedHashSet;
  21 import java.util.Optional;
  22 import java.util.Set;
  23 import org.eclipse.jdt.annotation.NonNull;
  24 import org.opendaylight.yangtools.yang.common.QName;
  25 import org.opendaylight.yangtools.yang.common.UnresolvedQName.Unqualified;
  26 import org.opendaylight.yangtools.yang.common.YangVersion;
  27 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.Deviation;
  30 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
  31 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
  32 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  33 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  34 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  35 import org.opendaylight.yangtools.yang.model.api.ModuleLike;
  36 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  37 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  38 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  39 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  40 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  41 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  42 import org.opendaylight.yangtools.yang.model.api.stmt.ContactEffectiveStatement;
  43 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
  44 import org.opendaylight.yangtools.yang.model.api.stmt.ImportEffectiveStatement;
  45 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
  46 import org.opendaylight.yangtools.yang.model.api.stmt.OrganizationEffectiveStatement;
  47 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixEffectiveStatement;
  48 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  49 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionEffectiveStatement;
  50 import org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat;
  51 import org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.DefaultWithDataTree.WithTypedefNamespace;
  52 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.DocumentedNodeMixin;
  53 import org.opendaylight.yangtools.yang.parser.spi.ParserNamespaces;
  54 import org.opendaylight.yangtools.yang.parser.spi.meta.CommonStmtCtx;
  55 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  56 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  57
  58 @Beta
  59 public abstract class AbstractEffectiveModule<D extends DeclaredStatement<Unqualified>,
  60         E extends DataTreeAwareEffectiveStatement<Unqualified, D>>
  61         extends WithTypedefNamespace<Unqualified, D>
  62         implements ModuleLike, DocumentedNodeMixin<Unqualified, D>, NotificationNodeContainerCompat<Unqualified, D, E> {
  63     private final String prefix;
  64     private final ImmutableSet<GroupingDefinition> groupings;
  65     private final ImmutableSet<UsesNode> uses;
  66     private final ImmutableSet<TypeDefinition<?>> typeDefinitions;
  67
  68     // FIXME: these should be detected in inference
  69     @SuppressFBWarnings(value = "CT_CONSTRUCTOR_THROW", justification = "Legacy namespace indexing")
  70     protected AbstractEffectiveModule(final Current<Unqualified, D> stmt,
  71             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements, final String prefix) {
  72         super(stmt.declared(), substatements);
  73
  74         this.prefix = requireNonNull(prefix);
  75
  76         final Set<GroupingDefinition> mutableGroupings = new LinkedHashSet<>();
  77         final Set<UsesNode> mutableUses = new LinkedHashSet<>();
  78         final Set<TypeDefinition<?>> mutableTypeDefinitions = new LinkedHashSet<>();
  79
  80         for (var effectiveStatement : effectiveSubstatements()) {
  81             if (effectiveStatement instanceof UsesNode usesNode && !mutableUses.add(usesNode)) {
  82                 throw EffectiveStmtUtils.createNameCollisionSourceException(stmt, effectiveStatement);
  83             }
  84             if (effectiveStatement instanceof TypedefEffectiveStatement typedef
  85                     && !mutableTypeDefinitions.add(typedef.getTypeDefinition())) {
  86                 throw EffectiveStmtUtils.createNameCollisionSourceException(stmt, effectiveStatement);
  87             }
  88             if (effectiveStatement instanceof GroupingDefinition grouping && !mutableGroupings.add(grouping)) {
  89                 throw EffectiveStmtUtils.createNameCollisionSourceException(stmt, effectiveStatement);
  90             }
  91         }
  92
  93         groupings = ImmutableSet.copyOf(mutableGroupings);
  94         typeDefinitions = ImmutableSet.copyOf(mutableTypeDefinitions);
  95         uses = ImmutableSet.copyOf(mutableUses);
  96     }
  97
  98     @Override
  99     public Unqualified argument() {
 100         return getDeclared().argument();
 101     }
 102
 103     @Override
 104     public String getName() {
 105         return argument().getLocalName();
 106     }
 107
 108     @Override
 109     public String getPrefix() {
 110         return prefix;
 111     }
 112
 113     @Override
 114     public YangVersion getYangVersion() {
 115         return findFirstEffectiveSubstatementArgument(YangVersionEffectiveStatement.class)
 116                 .orElse(YangVersion.VERSION_1);
 117     }
 118
 119     @Override
 120     public Optional<String> getOrganization() {
 121         return findFirstEffectiveSubstatementArgument(OrganizationEffectiveStatement.class);
 122     }
 123
 124     @Override
 125     public Optional<String> getContact() {
 126         return findFirstEffectiveSubstatementArgument(ContactEffectiveStatement.class);
 127     }
 128
 129     @Override
 130     public Collection<? extends @NonNull ModuleImport> getImports() {
 131         return filterSubstatements(ModuleImport.class);
 132     }
 133
 134     @Override
 135     public Collection<? extends @NonNull FeatureDefinition> getFeatures() {
 136         return filterSubstatements(FeatureDefinition.class);
 137     }
 138
 139     @Override
 140     public Collection<? extends @NonNull NotificationDefinition> getNotifications() {
 141         return filterSubstatements(NotificationDefinition.class);
 142     }
 143
 144     @Override
 145     public Collection<? extends @NonNull AugmentationSchemaNode> getAugmentations() {
 146         return filterSubstatements(AugmentationSchemaNode.class);
 147     }
 148
 149     @Override
 150     public Collection<? extends @NonNull RpcDefinition> getRpcs() {
 151         return filterSubstatements(RpcDefinition.class);
 152     }
 153
 154     @Override
 155     public Collection<? extends @NonNull Deviation> getDeviations() {
 156         return filterSubstatements(Deviation.class);
 157     }
 158
 159     @Override
 160     public Collection<? extends @NonNull ExtensionDefinition> getExtensionSchemaNodes() {
 161         return filterSubstatements(ExtensionDefinition.class);
 162     }
 163
 164     @Override
 165     public Collection<? extends @NonNull IdentitySchemaNode> getIdentities() {
 166         return filterSubstatements(IdentitySchemaNode.class);
 167     }
 168
 169     @Override
 170     public final Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 171         return typeDefinitions;
 172     }
 173
 174     @Override
 175     public final Collection<? extends DataSchemaNode> getChildNodes() {
 176         return filterSubstatements(DataSchemaNode.class);
 177     }
 178
 179     @Override
 180     public final Collection<? extends GroupingDefinition> getGroupings() {
 181         return groupings;
 182     }
 183
 184     @Override
 185     @SuppressWarnings("checkstyle:hiddenField")
 186     public final DataSchemaNode dataChildByName(final QName name) {
 187         return dataSchemaNode(name);
 188     }
 189
 190     @Override
 191     public Collection<? extends UsesNode> getUses() {
 192         return uses;
 193     }
 194
 195     protected static final @NonNull String findPrefix(final CommonStmtCtx stmt,
 196             final Collection<? extends EffectiveStatement<?, ?>> substatements, final String type, final String name) {
 197         return substatements.stream()
 198             .filter(PrefixEffectiveStatement.class::isInstance)
 199             .map(prefix -> ((PrefixEffectiveStatement) prefix).argument())
 200             .findAny()
 201             .orElseThrow(() -> new SourceException(stmt, "Unable to resolve prefix for %s %s.", type, name));
 202     }
 203
 204     // Alright. this is quite ugly
 205     protected final void appendPrefixes(final Current<?, ?> stmt,
 206             final Builder<String, ModuleEffectiveStatement> builder) {
 207         streamEffectiveSubstatements(ImportEffectiveStatement.class)
 208             .map(imp -> imp.prefix().argument())
 209             .forEach(pfx -> {
 210                 final var importedCtx =
 211                     verifyNotNull(stmt.namespaceItem(ParserNamespaces.IMPORT_PREFIX_TO_MODULECTX, pfx),
 212                         "Failed to resolve prefix %s", pfx);
 213                 builder.put(pfx, (ModuleEffectiveStatement) importedCtx.buildEffective());
 214             });
 215     }
 216
 217     @SuppressWarnings("unchecked")
 218     private <T> @NonNull Collection<? extends T> filterSubstatements(final Class<T> type) {
 219         return (Collection<? extends T>) Collections2.filter(effectiveSubstatements(), type::isInstance);
 220     }
 221 }