binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/AbstractAugmentGenerator.java

   1 /*
   2  * Copyright (c) 2021 PANTHEON.tech, 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.mdsal.binding.generator.impl.reactor;
   9
  10 import static com.google.common.base.Verify.verify;
  11 import static com.google.common.base.Verify.verifyNotNull;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.collect.ImmutableList;
  15 import java.util.Comparator;
  16 import java.util.Iterator;
  17 import java.util.List;
  18 import java.util.function.Function;
  19 import org.eclipse.jdt.annotation.NonNull;
  20 import org.opendaylight.mdsal.binding.generator.impl.reactor.CollisionDomain.Member;
  21 import org.opendaylight.mdsal.binding.generator.impl.rt.DefaultAugmentRuntimeType;
  22 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  23 import org.opendaylight.mdsal.binding.model.api.YangSourceDefinition;
  24 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
  25 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
  26 import org.opendaylight.mdsal.binding.model.ri.BindingTypes;
  27 import org.opendaylight.mdsal.binding.runtime.api.AugmentRuntimeType;
  28 import org.opendaylight.mdsal.binding.runtime.api.CaseRuntimeType;
  29 import org.opendaylight.mdsal.binding.runtime.api.RuntimeType;
  30 import org.opendaylight.yangtools.odlext.model.api.AugmentIdentifierEffectiveStatement;
  31 import org.opendaylight.yangtools.yang.common.AbstractQName;
  32 import org.opendaylight.yangtools.yang.common.QName;
  33 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  34 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentEffectiveStatement;
  35 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
  36 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
  37 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
  38 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  39
  40 /**
  41  * A generator corresponding to a {@code augment} statement. This class is further specialized for the two distinct uses
  42  * an augment is used.
  43  */
  44 abstract class AbstractAugmentGenerator
  45         extends AbstractCompositeGenerator<AugmentEffectiveStatement, AugmentRuntimeType> {
  46     /**
  47      * Comparator comparing target path length. This is useful for quickly determining order the order in which two
  48      * (or more) {@link AbstractAugmentGenerator}s need to be evaluated. This is necessary when augments are layered on
  49      * top of each other:
  50      *
  51      * <p>
  52      * <pre>
  53      *   <code>
  54      *     container foo;
  55      *
  56      *     augment /foo/bar {
  57      *       container baz;
  58      *     }
  59      *
  60      *     augment /foo {
  61      *       container bar;
  62      *     }
  63      *   </code>
  64      * </pre>
  65      *
  66      * <p>
  67      * Evaluating these in the order of increasing argument component count solves this without having to perform a full
  68      * analysis.
  69      *
  70      * <p>
  71      * Another problem we are solving here is augmentation target stability, as the declared order in YANG text may
  72      * change, which does not really change the semantics. If we only relied on length of argument, such a move would
  73      * result in changing the results of {@link #createMember(CollisionDomain)} and make upgrades rather unpredictable.
  74      * We solve this by using {@link QName#compareTo(QName)} to determine order.
  75      */
  76     static final Comparator<? super AbstractAugmentGenerator> COMPARATOR = (o1, o2) -> {
  77         final Iterator<QName> thisIt = o1.statement().argument().getNodeIdentifiers().iterator();
  78         final Iterator<QName> otherIt = o2.statement().argument().getNodeIdentifiers().iterator();
  79
  80         while (thisIt.hasNext()) {
  81             if (!otherIt.hasNext()) {
  82                 return 1;
  83             }
  84
  85             final int comp = thisIt.next().compareTo(otherIt.next());
  86             if (comp != 0) {
  87                 return comp;
  88             }
  89         }
  90
  91         return otherIt.hasNext() ? -1 : 0;
  92     };
  93
  94     private AbstractCompositeGenerator<?, ?> targetGen;
  95
  96     AbstractAugmentGenerator(final AugmentEffectiveStatement statement, final AbstractCompositeGenerator<?, ?> parent) {
  97         super(statement, parent);
  98     }
  99
 100     @Override
 101     final StatementNamespace namespace() {
 102         return StatementNamespace.AUGMENT;
 103     }
 104
 105     @Override
 106     final void pushToInference(final SchemaInferenceStack dataTree) {
 107         dataTree.enterSchemaTree(statement().argument());
 108     }
 109
 110     @Override
 111     final AbstractQName localName() {
 112         throw new UnsupportedOperationException();
 113     }
 114
 115     @Override
 116     ClassPlacement classPlacement() {
 117         // if the target is a choice we are NOT creating an explicit augmentation, but we still need a phantom to
 118         // reserve the appropriate package name
 119         final AbstractCompositeGenerator<?, ?> target = targetGenerator();
 120         return target instanceof ChoiceGenerator ? ClassPlacement.PHANTOM : super.classPlacement();
 121     }
 122
 123     @Override
 124     final Member createMember(final CollisionDomain domain) {
 125         final AbstractQName explicitIdentifier = statement()
 126             .findFirstEffectiveSubstatementArgument(AugmentIdentifierEffectiveStatement.class).orElse(null);
 127         if (explicitIdentifier != null) {
 128             return domain.addPrimary(this, new CamelCaseNamingStrategy(StatementNamespace.AUGMENT, explicitIdentifier));
 129         }
 130
 131         final Member target = targetGenerator().getMember();
 132         int offset = 1;
 133         for (Generator gen : getParent()) {
 134             if (gen == this) {
 135                 break;
 136             }
 137             if (gen instanceof AbstractAugmentGenerator aug && target.equalRoot(aug.targetGenerator().getMember())) {
 138                 offset++;
 139             }
 140         }
 141
 142         return domain.addSecondary(this, target, String.valueOf(offset), statement().argument());
 143     }
 144
 145     @Override
 146     final GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
 147         final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
 148
 149         YangSourceDefinition.of(currentModule().statement(), statement()).ifPresent(builder::setYangSourceDefinition);
 150         builder.addImplementsType(BindingTypes.augmentation(targetGenerator().getGeneratedType(builderFactory)));
 151         addUsesInterfaces(builder, builderFactory);
 152         addConcreteInterfaceMethods(builder);
 153
 154         addGetterMethods(builder, builderFactory);
 155         annotateDeprecatedIfNecessary(builder);
 156
 157         return builder.build();
 158     }
 159
 160     boolean matchesInstantiated(final AugmentEffectiveStatement statement) {
 161         return statement().equals(statement);
 162     }
 163
 164     final void fillRuntimeCasesIn(final AugmentResolver resolver, final ChoiceEffectiveStatement stmt,
 165             final List<CaseRuntimeType> toList) {
 166         toList.addAll(createBuilder(effectiveIn(stmt)).populate(resolver, this).getCaseChilden());
 167     }
 168
 169     final @NonNull AugmentRuntimeType runtimeTypeIn(final AugmentResolver resolver,
 170             final EffectiveStatement<?, ?> stmt) {
 171         verify(stmt instanceof SchemaTreeAwareEffectiveStatement, "Unexpected target statement %s", stmt);
 172         return verifyNotNull(createInternalRuntimeType(resolver,
 173             effectiveIn((SchemaTreeAwareEffectiveStatement<?, ?>) stmt)));
 174     }
 175
 176     abstract @NonNull TargetAugmentEffectiveStatement effectiveIn(SchemaTreeAwareEffectiveStatement<?, ?> target);
 177
 178     final @NonNull TargetAugmentEffectiveStatement effectiveIn(final SchemaTreeAwareEffectiveStatement<?, ?> target,
 179             final Function<QName, QName> transform) {
 180         final var augment = statement();
 181         final var stmts = augment.effectiveSubstatements();
 182         final var builder = ImmutableList.<EffectiveStatement<?, ?>>builderWithExpectedSize(stmts.size());
 183         for (var child : stmts) {
 184             if (child instanceof SchemaTreeEffectiveStatement<?> schemaTreeChild) {
 185                 final var qname = schemaTreeChild.argument();
 186                 // Note: a match in target may be missing -- for example if it was 'deviate unsupported'
 187                 target.findSchemaTreeNode(transform.apply(qname)).ifPresent(builder::add);
 188             } else {
 189                 builder.add(child);
 190             }
 191         }
 192         return new TargetAugmentEffectiveStatement(augment, target, builder.build());
 193     }
 194
 195     @Override
 196     final void addAsGetterMethod(final GeneratedTypeBuilderBase<?> builder, final TypeBuilderFactory builderFactory) {
 197         // Augments are never added as getters, as they are handled via Augmentable mechanics
 198     }
 199
 200     @Override
 201     CompositeRuntimeTypeBuilder<AugmentEffectiveStatement, AugmentRuntimeType> createBuilder(
 202             final AugmentEffectiveStatement statement) {
 203         return new CompositeRuntimeTypeBuilder<>(statement) {
 204             @Override
 205             AugmentRuntimeType build(final GeneratedType type, final AugmentEffectiveStatement statement,
 206                     final List<RuntimeType> children, final List<AugmentRuntimeType> augments) {
 207                 // 'augment' cannot be targeted by augment
 208                 verify(augments.isEmpty(), "Unexpected augments %s", augments);
 209                 return new DefaultAugmentRuntimeType(type, statement, children);
 210             }
 211         };
 212     }
 213
 214     final void setTargetGenerator(final AbstractCompositeGenerator<?, ?> targetGenerator) {
 215         verify(targetGen == null, "Attempted to relink %s, already have target %s", this, targetGen);
 216         targetGen = requireNonNull(targetGenerator);
 217     }
 218
 219     final @NonNull AbstractCompositeGenerator<?, ?> targetGenerator() {
 220         return verifyNotNull(targetGen, "No target for %s", this);
 221     }
 222 }