*/
package org.opendaylight.mdsal.binding.runtime.api;
-import static com.google.common.base.Verify.verify;
-import static com.google.common.base.Verify.verifyNotNull;
-import static java.util.Objects.requireNonNull;
-
import com.google.common.annotations.Beta;
-import com.google.common.base.MoreObjects;
-import com.google.common.collect.BiMap;
-import com.google.common.collect.ImmutableMap;
-import com.google.common.collect.ImmutableMultimap;
-import com.google.common.collect.Multimap;
-import com.google.common.collect.MultimapBuilder;
-import java.util.Collection;
-import java.util.IdentityHashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Map.Entry;
import java.util.Optional;
import java.util.Set;
-import java.util.stream.Collectors;
import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.mdsal.binding.model.api.GeneratedType;
-import org.opendaylight.mdsal.binding.model.api.Type;
+import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
import org.opendaylight.yangtools.concepts.Immutable;
import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
-import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextProvider;
-import org.opendaylight.yangtools.yang.model.api.stmt.CaseEffectiveStatement;
-import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
/**
* The result of BindingGenerator run. Contains mapping between Types and SchemaNodes.
*/
@Beta
-public final class BindingRuntimeTypes implements EffectiveModelContextProvider, Immutable {
- private static final Logger LOG = LoggerFactory.getLogger(BindingRuntimeTypes.class);
-
- private final @NonNull EffectiveModelContext schemaContext;
- private final ImmutableMap<Type, AugmentationSchemaNode> typeToAugmentation;
- private final ImmutableMap<Type, WithStatus> typeToSchema;
- private final ImmutableMultimap<Type, Type> choiceToCases;
- private final ImmutableMap<QName, Type> identities;
- // Not Immutable as we use two different implementations
- private final Map<WithStatus, Type> schemaToType;
-
- public BindingRuntimeTypes(final EffectiveModelContext schemaContext,
- final Map<Type, AugmentationSchemaNode> typeToAugmentation,
- final Map<Type, WithStatus> typeToSchema, final Map<WithStatus, Type> schemaToType,
- final Map<QName, Type> identities) {
- this.schemaContext = requireNonNull(schemaContext);
- this.typeToAugmentation = ImmutableMap.copyOf(typeToAugmentation);
- this.typeToSchema = ImmutableMap.copyOf(typeToSchema);
- this.identities = ImmutableMap.copyOf(identities);
-
- // Careful to use identity for SchemaNodes, but only if needed
- // FIXME: 8.0.0: YT should be switching to identity for equals(), so this should become unnecessary
- Map<WithStatus, Type> copy;
- try {
- copy = ImmutableMap.copyOf(schemaToType);
- } catch (IllegalArgumentException e) {
- LOG.debug("Equality-duplicates found in {}", schemaToType.keySet());
- copy = new IdentityHashMap<>(schemaToType);
- }
+public interface BindingRuntimeTypes extends EffectiveModelContextProvider, RuntimeTypeContainer, Immutable {
- this.schemaToType = copy;
+ Optional<IdentityRuntimeType> findIdentity(QName qname);
- // Two-phase indexing of choice/case nodes. First we load all choices. Note we are using typeToSchema argument,
- // not field, so as not to instantiate its entrySet.
- final Set<GeneratedType> choiceTypes = typeToSchema.entrySet().stream()
- .filter(entry -> entry.getValue() instanceof ChoiceEffectiveStatement)
- .map(entry -> {
- final Type key = entry.getKey();
- verify(key instanceof GeneratedType, "Unexpected choice type %s", key);
- return (GeneratedType) key;
- })
- .collect(Collectors.toUnmodifiableSet());
+ Optional<RuntimeType> findSchema(JavaTypeName typeName);
- final Multimap<Type, Type> builder = MultimapBuilder.hashKeys(choiceTypes.size()).arrayListValues().build();
- for (Entry<Type, WithStatus> entry : typeToSchema.entrySet()) {
- if (entry.getValue() instanceof CaseEffectiveStatement) {
- final Type type = entry.getKey();
- verify(type instanceof GeneratedType, "Unexpected case type %s", type);
- builder.put(verifyNotNull(implementedChoiceType(((GeneratedType) type).getImplements(), choiceTypes),
- "Cannot determine choice type for %s", type), type);
- }
- }
+ Optional<InputRuntimeType> findRpcInput(QName rpcName);
- choiceToCases = ImmutableMultimap.copyOf(builder);
- }
+ Optional<OutputRuntimeType> findRpcOutput(QName rpcName);
- private static GeneratedType implementedChoiceType(final List<Type> impls, final Set<GeneratedType> choiceTypes) {
- for (Type impl : impls) {
- if (impl instanceof GeneratedType && choiceTypes.contains(impl)) {
- return (GeneratedType) impl;
- }
+ default @Nullable RuntimeType schemaTreeChild(final Absolute path) {
+ final var it = path.getNodeIdentifiers().iterator();
+ var tmp = schemaTreeChild(it.next());
+ while (it.hasNext() && tmp instanceof RuntimeTypeContainer) {
+ tmp = ((RuntimeTypeContainer) tmp).schemaTreeChild(it.next());
}
- return null;
- }
-
- public BindingRuntimeTypes(final EffectiveModelContext schemaContext,
- final Map<Type, AugmentationSchemaNode> typeToAugmentation,
- final BiMap<Type, WithStatus> typeToDefiningSchema, final Map<QName, Type> identities) {
- this(schemaContext, typeToAugmentation, typeToDefiningSchema, typeToDefiningSchema.inverse(), identities);
- }
-
- @Override
- public EffectiveModelContext getEffectiveModelContext() {
- return schemaContext;
- }
-
- public Optional<AugmentationSchemaNode> findAugmentation(final Type type) {
- return Optional.ofNullable(typeToAugmentation.get(type));
- }
-
- public Optional<Type> findIdentity(final QName qname) {
- return Optional.ofNullable(identities.get(qname));
+ return tmp;
}
- public Optional<WithStatus> findSchema(final Type type) {
- return Optional.ofNullable(typeToSchema.get(type));
- }
-
- public Optional<Type> findType(final WithStatus schema) {
- return Optional.ofNullable(schemaToType.get(schema));
- }
-
- public Optional<Type> findOriginalAugmentationType(final AugmentationSchemaNode augment) {
- // If the augment statement does not contain any child nodes, we did not generate an augmentation, as it would
- // be plain littering.
- // FIXME: MDSAL-695: this check is rather costly (involves filtering), can we just rely on the not being found
- // in the end? all we are saving is essentially two map lookups after all...
- if (augment.getChildNodes().isEmpty()) {
- return Optional.empty();
- }
-
- // FIXME: MDSAL-695: We should have enough information from mdsal-binding-generator to receive a (sparse) Map
- // for current -> original lookup. When combined with schemaToType, this amounts to the
- // inverse view of what 'typeToSchema' holds
- AugmentationSchemaNode current = augment;
- while (true) {
- // If this augmentation has been added through 'uses foo { augment bar { ... } }', we need to invert that
- // walk and arrive at the original declaration site, as that is where we generated 'grouping foo's
- // augmentation. That site may have a different module, hence the augment namespace may be different.
- final Optional<AugmentationSchemaNode> original = current.getOriginalDefinition();
- if (original.isEmpty()) {
- return findType(current);
- }
- current = original.orElseThrow();
- }
- }
-
- public Multimap<Type, Type> getChoiceToCases() {
- return choiceToCases;
- }
-
- public Collection<Type> findCases(final Type choiceType) {
- return choiceToCases.get(choiceType);
- }
-
- @Override
- public String toString() {
- return MoreObjects.toStringHelper(this)
- .add("typeToAugmentation", typeToAugmentation)
- .add("typeToSchema", typeToSchema)
- .add("choiceToCases", choiceToCases)
- .add("identities", identities)
- .toString();
- }
+ /**
+ * Lookup to all {@link CaseRuntimeType}s related to a {@link ChoiceRuntimeType}. This is important when dealing
+ * with sharing incurred by Binding Spec's reuse of constructs defined in a {@code grouping}.
+ *
+ * <p>
+ * As an example, consider {@link ChoiceRuntimeType} and {@link CaseRuntimeType} relationship to
+ * {@link GeneratedType}s in the following model:
+ * <pre>
+ * <code>
+ * grouping grp {
+ * container foo {
+ * choice bar;
+ * }
+ * }
+ *
+ * container foo {
+ * uses grp;
+ * }
+ *
+ * container bar {
+ * uses grp;
+ * }
+ *
+ * augment /foo/foo/bar {
+ * case baz
+ * }
+ *
+ * augment /bar/foo/bar {
+ * case xyzzy;
+ * }
+ * </code>
+ * </pre>
+ * YANG view of what is valid in {@code /foo/foo/bar} differs from what is valid in {@code /bar/foo/bar}, but this
+ * difference is not reflected in generated Java constructs. More notably, the two augments being in different
+ * modules. Since {@code choice bar}'s is part of a reusable construct, {@code grouping one}, DataObjects' copy
+ * builders can propagate them without translating them to the appropriate manifestation -- and they can do nothing
+ * about that as they lack the complete view of the effective model.
+ *
+ * <p>
+ * This method provides a bridge between a particular instantiation of a {@code choice} to {@link CaseRuntimeType}s
+ * valid in all instantiations.
+ *
+ * @param choiceType A ChoiceRuntimeType
+ * @return The set of {@link CaseRuntimeType}s known to this instance
+ * @throws NullPointerException if {@code ChoiceRuntimeType} is null
+ */
+ @NonNull Set<CaseRuntimeType> allCaseChildren(ChoiceRuntimeType choiceType);
}
Code Review / mdsal.git / blobdiff