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