binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/AbstractTypeObjectGenerator.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.Preconditions.checkArgument;
  11 import static com.google.common.base.Verify.verify;
  12 import static com.google.common.base.Verify.verifyNotNull;
  13
  14 import com.google.common.base.VerifyException;
  15 import com.google.common.collect.ImmutableMap;
  16 import com.google.common.collect.Maps;
  17 import java.util.ArrayList;
  18 import java.util.HashMap;
  19 import java.util.List;
  20 import java.util.Map;
  21 import java.util.Optional;
  22 import java.util.stream.Collectors;
  23 import org.eclipse.jdt.annotation.NonNull;
  24 import org.eclipse.jdt.annotation.Nullable;
  25 import org.opendaylight.mdsal.binding.generator.BindingGeneratorUtil;
  26 import org.opendaylight.mdsal.binding.generator.impl.reactor.TypeReference.ResolvedLeafref;
  27 import org.opendaylight.mdsal.binding.model.api.ConcreteType;
  28 import org.opendaylight.mdsal.binding.model.api.Enumeration;
  29 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty;
  30 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
  31 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  32 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  33 import org.opendaylight.mdsal.binding.model.api.Restrictions;
  34 import org.opendaylight.mdsal.binding.model.api.Type;
  35 import org.opendaylight.mdsal.binding.model.api.YangSourceDefinition;
  36 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedPropertyBuilder;
  37 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder;
  38 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
  39 import org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder;
  40 import org.opendaylight.mdsal.binding.model.ri.BaseYangTypes;
  41 import org.opendaylight.mdsal.binding.model.ri.BindingTypes;
  42 import org.opendaylight.mdsal.binding.model.ri.TypeConstants;
  43 import org.opendaylight.mdsal.binding.model.ri.Types;
  44 import org.opendaylight.mdsal.binding.model.ri.generated.type.builder.AbstractEnumerationBuilder;
  45 import org.opendaylight.mdsal.binding.model.ri.generated.type.builder.GeneratedPropertyBuilderImpl;
  46 import org.opendaylight.mdsal.binding.runtime.api.RuntimeType;
  47 import org.opendaylight.yangtools.concepts.Immutable;
  48 import org.opendaylight.yangtools.yang.binding.RegexPatterns;
  49 import org.opendaylight.yangtools.yang.binding.TypeObject;
  50 import org.opendaylight.yangtools.yang.binding.contract.Naming;
  51 import org.opendaylight.yangtools.yang.common.QName;
  52 import org.opendaylight.yangtools.yang.common.YangConstants;
  53 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  54 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  55 import org.opendaylight.yangtools.yang.model.api.stmt.BaseEffectiveStatement;
  56 import org.opendaylight.yangtools.yang.model.api.stmt.LengthEffectiveStatement;
  57 import org.opendaylight.yangtools.yang.model.api.stmt.PathEffectiveStatement;
  58 import org.opendaylight.yangtools.yang.model.api.stmt.PatternEffectiveStatement;
  59 import org.opendaylight.yangtools.yang.model.api.stmt.PatternExpression;
  60 import org.opendaylight.yangtools.yang.model.api.stmt.RangeEffectiveStatement;
  61 import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
  62 import org.opendaylight.yangtools.yang.model.api.stmt.ValueRange;
  63 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
  64 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition.Bit;
  65 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
  66 import org.opendaylight.yangtools.yang.model.api.type.ModifierKind;
  67 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
  68 import org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition;
  69 import org.opendaylight.yangtools.yang.model.api.type.TypeDefinitions;
  70 import org.slf4j.Logger;
  71 import org.slf4j.LoggerFactory;
  72
  73 /**
  74  * Common base class for {@link TypedefGenerator} and {@link AbstractTypeAwareGenerator}. This encompasses three
  75  * different statements with two different semantics:
  76  * <ul>
  77  *   <li>{@link TypedefGenerator}s always result in a generated {@link TypeObject}, even if the semantics is exactly
  78  *       the same as its base type. This aligns with {@code typedef} defining a new type.<li>
  79  *   <li>{@link LeafGenerator}s and {@link LeafListGenerator}s, on the other hand, do not generate a {@link TypeObject}
  80  *       unless absolutely necassary. This aligns with {@code leaf} and {@code leaf-list} being mapped onto a property
  81  *       of its parent type.<li>
  82  * </ul>
  83  *
  84  * <p>
  85  * To throw a bit of confusion into the mix, there are three exceptions to those rules:
  86  * <ul>
  87  *   <li>
  88  *     {@code identityref} definitions never result in a type definition being emitted. The reason for this has to do
  89  *     with identity type mapping as well as history of our codebase.
  90  *
  91  *     <p>
  92  *     The problem at hand is inconsistency between the fact that identity is mapped to a {@link Class}, which is also
  93  *     returned from leaves which specify it like this:
  94  *     <pre>
  95  *       <code>
  96  *         identity iden;
  97  *
  98  *         container foo {
  99  *           leaf foo {
 100  *             type identityref {
 101  *               base iden;
 102  *             }
 103  *           }
 104  *         }
 105  *       </code>
 106  *     </pre>
 107  *     which results in fine-looking
 108  *     <pre>
 109  *       <code>
 110  *         interface Foo {
 111  *           Class&lt;? extends Iden&gt; getFoo();
 112  *         }
 113  *       </code>
 114  *     </pre>
 115  *
 116  *     <p>
 117  *     This gets more dicey if we decide to extend the previous snippet to also include:
 118  *     <pre>
 119  *       <code>
 120  *         typedef bar-ref {
 121  *           type identityref {
 122  *             base iden;
 123  *           }
 124  *         }
 125  *
 126  *         container bar {
 127  *           leaf bar {
 128  *             type bar-ref;
 129  *           }
 130  *         }
 131  *       </code>
 132  *     </pre>
 133  *
 134  *     <p>
 135  *     Now we have competing requirements: {@code typedef} would like us to use encapsulation to capture the defined
 136  *     type, while {@code getBar()} wants us to retain shape with getFoo(), as it should not matter how the
 137  *     {@code identityref} was formed. We need to pick between:
 138  *     <ol>
 139  *       <li>
 140  *         <pre>
 141  *           <code>
 142  *             public class BarRef extends ScalarTypeObject&lt;Class&lt;? extends Iden&gt;&gt; {
 143  *               Class&lt;? extends Iden&gt; getValue() {
 144  *                 // ...
 145  *               }
 146  *             }
 147  *
 148  *             interface Bar {
 149  *               BarRef getBar();
 150  *             }
 151  *           </code>
 152  *         </pre>
 153  *       </li>
 154  *       <li>
 155  *         <pre>
 156  *           <code>
 157  *             interface Bar {
 158  *               Class&lt;? extends Iden&gt; getBar();
 159  *             }
 160  *           </code>
 161  *         </pre>
 162  *       </li>
 163  *     </ol>
 164  *
 165  *     <p>
 166  *     Here the second option is more user-friendly, as the type system works along the lines of <b>reference</b>
 167  *     semantics, treating and {@code Bar.getBar()} and {@code Foo.getFoo()} as equivalent. The first option would
 168  *     force users to go through explicit encapsulation, for no added benefit as the {@code typedef} cannot possibly add
 169  *     anything useful to the actual type semantics.
 170  *   </li>
 171  *   <li>
 172  *     {@code leafref} definitions never result in a type definition being emitted. The reasons for this are similar to
 173  *     {@code identityref}, but have an additional twist: a {@leafref} can target a relative path, which may only be
 174  *     resolved at a particular instantiation.
 175  *
 176  *     Take the example of the following model:
 177  *     <pre>
 178  *       <code>
 179  *         grouping grp {
 180  *           typedef ref {
 181  *             type leafref {
 182  *               path ../xyzzy;
 183  *             }
 184  *           }
 185  *
 186  *           leaf foo {
 187  *             type ref;
 188  *           }
 189  *         }
 190  *
 191  *         container bar {
 192              uses grp;
 193  *
 194  *           leaf xyzzy {
 195  *             type string;
 196  *           }
 197  *         }
 198  *
 199  *         container baz {
 200  *           uses grp;
 201  *
 202  *           leaf xyzzy {
 203  *             type int32;
 204  *           }
 205  *         }
 206  *       </code>
 207  *     </pre>
 208  *
 209  *     The {@code typedef ref} points to outside of the grouping, and hence the type of {@code leaf foo} is polymorphic:
 210  *     the definition in {@code grouping grp} needs to use {@code Object}, whereas the instantiations in
 211  *     {@code container bar} and {@code container baz} need to use {@code String} and {@link Integer} respectively.
 212  *     Expressing the resulting interface contracts requires return type specialization and run-time checks. An
 213  *     intermediate class generated for the typedef would end up being a hindrance without any benefit.
 214  *   <li>
 215  *   <li>
 216  *     {@code enumeration} definitions never result in a derived type. This is because these are mapped to Java
 217  *     {@code enum}, which does not allow subclassing.
 218  *   <li>
 219  * </ul>
 220  *
 221  * <p>
 222  * At the end of the day, the mechanic translation rules are giving way to correctly mapping the semantics -- which in
 223  * both of the exception cases boil down to tracking type indirection. Intermediate constructs involved in tracking
 224  * type indirection in YANG constructs is therefore explicitly excluded from the generated Java code, but the Binding
 225  * Specification still takes them into account when determining types as outlined above.
 226  */
 227 abstract class AbstractTypeObjectGenerator<S extends EffectiveStatement<?, ?>, R extends RuntimeType>
 228         extends AbstractDependentGenerator<S, R> {
 229     private static final class UnionDependencies implements Immutable {
 230         private final Map<EffectiveStatement<?, ?>, TypeReference> identityTypes = new HashMap<>();
 231         private final Map<EffectiveStatement<?, ?>, TypeReference> leafTypes = new HashMap<>();
 232         private final Map<QName, TypedefGenerator> baseTypes = new HashMap<>();
 233
 234         UnionDependencies(final TypeEffectiveStatement<?> type, final GeneratorContext context) {
 235             resolveUnionDependencies(context, type);
 236         }
 237
 238         private void resolveUnionDependencies(final GeneratorContext context, final TypeEffectiveStatement<?> union) {
 239             for (EffectiveStatement<?, ?> stmt : union.effectiveSubstatements()) {
 240                 if (stmt instanceof TypeEffectiveStatement<?> type) {
 241                     final QName typeName = type.argument();
 242                     if (TypeDefinitions.IDENTITYREF.equals(typeName)) {
 243                         if (!identityTypes.containsKey(stmt)) {
 244                             identityTypes.put(stmt, TypeReference.identityRef(
 245                                 type.streamEffectiveSubstatements(BaseEffectiveStatement.class)
 246                                     .map(BaseEffectiveStatement::argument)
 247                                     .map(context::resolveIdentity)
 248                                     .collect(Collectors.toUnmodifiableList())));
 249                         }
 250                     } else if (TypeDefinitions.LEAFREF.equals(typeName)) {
 251                         if (!leafTypes.containsKey(stmt)) {
 252                             leafTypes.put(stmt, TypeReference.leafRef(context.resolveLeafref(
 253                                 type.findFirstEffectiveSubstatementArgument(PathEffectiveStatement.class)
 254                                 .orElseThrow())));
 255                         }
 256                     } else if (TypeDefinitions.UNION.equals(typeName)) {
 257                         resolveUnionDependencies(context, type);
 258                     } else if (!isBuiltinName(typeName) && !baseTypes.containsKey(typeName)) {
 259                         baseTypes.put(typeName, context.resolveTypedef(typeName));
 260                     }
 261                 }
 262             }
 263         }
 264     }
 265
 266     private static final Logger LOG = LoggerFactory.getLogger(AbstractTypeObjectGenerator.class);
 267     static final ImmutableMap<QName, Type> SIMPLE_TYPES = ImmutableMap.<QName, Type>builder()
 268         .put(TypeDefinitions.BINARY, BaseYangTypes.BINARY_TYPE)
 269         .put(TypeDefinitions.BOOLEAN, BaseYangTypes.BOOLEAN_TYPE)
 270         .put(TypeDefinitions.DECIMAL64, BaseYangTypes.DECIMAL64_TYPE)
 271         .put(TypeDefinitions.EMPTY, BaseYangTypes.EMPTY_TYPE)
 272         .put(TypeDefinitions.INSTANCE_IDENTIFIER, BaseYangTypes.INSTANCE_IDENTIFIER)
 273         .put(TypeDefinitions.INT8, BaseYangTypes.INT8_TYPE)
 274         .put(TypeDefinitions.INT16, BaseYangTypes.INT16_TYPE)
 275         .put(TypeDefinitions.INT32, BaseYangTypes.INT32_TYPE)
 276         .put(TypeDefinitions.INT64, BaseYangTypes.INT64_TYPE)
 277         .put(TypeDefinitions.STRING, BaseYangTypes.STRING_TYPE)
 278         .put(TypeDefinitions.UINT8, BaseYangTypes.UINT8_TYPE)
 279         .put(TypeDefinitions.UINT16, BaseYangTypes.UINT16_TYPE)
 280         .put(TypeDefinitions.UINT32, BaseYangTypes.UINT32_TYPE)
 281         .put(TypeDefinitions.UINT64, BaseYangTypes.UINT64_TYPE)
 282         .build();
 283
 284     private final TypeEffectiveStatement<?> type;
 285
 286     // FIXME: these fields should be better-controlled with explicit sequencing guards. It it currently stands, we are
 287     //        expending two (or more) additional fields to express downstream linking. If we had the concept of
 288     //        resolution step (an enum), we could just get by with a simple queue of Step/Callback pairs, which would
 289     //        trigger as needed. See how we manage baseGen/inferred fields.
 290
 291     /**
 292      * The generator corresponding to our YANG base type. It produces the superclass of our encapsulated type. If it is
 293      * {@code null}, this generator is the root of the hierarchy.
 294      */
 295     private TypedefGenerator baseGen;
 296     private TypeReference refType;
 297     private List<GeneratedType> auxiliaryGeneratedTypes = List.of();
 298     private UnionDependencies unionDependencies;
 299     private List<AbstractTypeObjectGenerator<?, ?>> inferred = List.of();
 300
 301     /**
 302      * The type of single-element return type of the getter method associated with this generator. This is retained for
 303      * run-time type purposes. It may be uninitialized, in which case this object must have a generated type.
 304      */
 305     private Type methodReturnTypeElement;
 306
 307     AbstractTypeObjectGenerator(final S statement, final AbstractCompositeGenerator<?, ?> parent) {
 308         super(statement, parent);
 309         type = statement().findFirstEffectiveSubstatement(TypeEffectiveStatement.class).orElseThrow();
 310     }
 311
 312     @Override
 313     public final List<GeneratedType> auxiliaryGeneratedTypes() {
 314         return auxiliaryGeneratedTypes;
 315     }
 316
 317     @Override
 318     final void linkDependencies(final GeneratorContext context) {
 319         verify(inferred != null, "Duplicate linking of %s", this);
 320
 321         final QName typeName = type.argument();
 322         if (isBuiltinName(typeName)) {
 323             verify(inferred.isEmpty(), "Unexpected non-empty downstreams in %s", this);
 324             inferred = null;
 325             return;
 326         }
 327
 328         final AbstractExplicitGenerator<S, R> prev = previous();
 329         if (prev != null) {
 330             verify(prev instanceof AbstractTypeObjectGenerator, "Unexpected previous %s", prev);
 331             ((AbstractTypeObjectGenerator<S, R>) prev).linkInferred(this);
 332         } else {
 333             linkBaseGen(context.resolveTypedef(typeName));
 334         }
 335     }
 336
 337     private void linkInferred(final AbstractTypeObjectGenerator<?, ?> downstream) {
 338         if (inferred == null) {
 339             downstream.linkBaseGen(verifyNotNull(baseGen, "Mismatch on linking between %s and %s", this, downstream));
 340             return;
 341         }
 342
 343         if (inferred.isEmpty()) {
 344             inferred = new ArrayList<>(2);
 345         }
 346         inferred.add(downstream);
 347     }
 348
 349     private void linkBaseGen(final TypedefGenerator upstreamBaseGen) {
 350         verify(baseGen == null, "Attempted to replace base %s with %s in %s", baseGen, upstreamBaseGen, this);
 351         final List<AbstractTypeObjectGenerator<?, ?>> downstreams = verifyNotNull(inferred,
 352             "Duplicated linking of %s", this);
 353         baseGen = verifyNotNull(upstreamBaseGen);
 354         baseGen.addDerivedGenerator(this);
 355         inferred = null;
 356
 357         for (AbstractTypeObjectGenerator<?, ?> downstream : downstreams) {
 358             downstream.linkBaseGen(upstreamBaseGen);
 359         }
 360     }
 361
 362     void bindTypeDefinition(final GeneratorContext context) {
 363         if (baseGen != null) {
 364             // We have registered with baseGen, it will push the type to us
 365             return;
 366         }
 367
 368         final QName arg = type.argument();
 369         if (TypeDefinitions.IDENTITYREF.equals(arg)) {
 370             refType = TypeReference.identityRef(type.streamEffectiveSubstatements(BaseEffectiveStatement.class)
 371                 .map(BaseEffectiveStatement::argument)
 372                 .map(context::resolveIdentity)
 373                 .collect(Collectors.toUnmodifiableList()));
 374         } else if (TypeDefinitions.LEAFREF.equals(arg)) {
 375             final AbstractTypeObjectGenerator<?, ?> targetGenerator = context.resolveLeafref(
 376                 type.findFirstEffectiveSubstatementArgument(PathEffectiveStatement.class).orElseThrow());
 377             checkArgument(targetGenerator != this, "Effective model contains self-referencing leaf %s",
 378                 statement().argument());
 379             refType = TypeReference.leafRef(targetGenerator);
 380         } else if (TypeDefinitions.UNION.equals(arg)) {
 381             unionDependencies = new UnionDependencies(type, context);
 382             LOG.trace("Resolved union {} to dependencies {}", type, unionDependencies);
 383         }
 384
 385         LOG.trace("Resolved base {} to generator {}", type, refType);
 386         bindDerivedGenerators(refType);
 387     }
 388
 389     final void bindTypeDefinition(final @Nullable TypeReference reference) {
 390         refType = reference;
 391         LOG.trace("Resolved derived {} to generator {}", type, refType);
 392     }
 393
 394     private static boolean isBuiltinName(final QName typeName) {
 395         return YangConstants.RFC6020_YANG_MODULE.equals(typeName.getModule());
 396     }
 397
 398     abstract void bindDerivedGenerators(@Nullable TypeReference reference);
 399
 400     @Override
 401     final ClassPlacement classPlacement() {
 402         if (refType != null) {
 403             // Reference types never create a new type
 404             return ClassPlacement.NONE;
 405         }
 406         if (isDerivedEnumeration()) {
 407             // Types derived from an enumeration never create a new type, as that would have to be a subclass of an enum
 408             // and since enums are final, that can never happen.
 409             return ClassPlacement.NONE;
 410         }
 411         return classPlacementImpl();
 412     }
 413
 414     @NonNull ClassPlacement classPlacementImpl() {
 415         // TODO: make this a lot more accurate by comparing the effective delta between the base type and the effective
 416         //       restricted type. We should not be generating a type for constructs like:
 417         //
 418         //         leaf foo {
 419         //           type uint8 { range 0..255; }
 420         //         }
 421         //
 422         //       or
 423         //
 424         //         typedef foo {
 425         //           type uint8 { range 0..100; }
 426         //         }
 427         //
 428         //         leaf foo {
 429         //           type foo { range 0..100; }
 430         //         }
 431         //
 432         //       Which is relatively easy to do for integral types, but is way more problematic for 'pattern'
 433         //       restrictions. Nevertheless we can define the mapping in a way which can be implemented with relative
 434         //       ease.
 435         return baseGen != null || SIMPLE_TYPES.containsKey(type.argument()) || isAddedByUses() || isAugmenting()
 436             ? ClassPlacement.NONE : ClassPlacement.MEMBER;
 437     }
 438
 439     @Override
 440     final GeneratedType getGeneratedType(final TypeBuilderFactory builderFactory) {
 441         // For derived enumerations defer to base type
 442         return isDerivedEnumeration() ? baseGen.getGeneratedType(builderFactory)
 443             : super.getGeneratedType(builderFactory);
 444     }
 445
 446     final boolean isEnumeration() {
 447         return baseGen != null ? baseGen.isEnumeration() : TypeDefinitions.ENUMERATION.equals(type.argument());
 448     }
 449
 450     final boolean isDerivedEnumeration() {
 451         return baseGen != null && baseGen.isEnumeration();
 452     }
 453
 454     @Override
 455     Type methodReturnType(final TypeBuilderFactory builderFactory) {
 456         return methodReturnElementType(builderFactory);
 457     }
 458
 459     @Override
 460     final Type runtimeJavaType() {
 461         if (methodReturnTypeElement != null) {
 462             return methodReturnTypeElement;
 463         }
 464         final var genType = generatedType();
 465         if (genType.isPresent()) {
 466             return genType.orElseThrow();
 467         }
 468         final var prev = verifyNotNull(previous(), "No previous generator for %s", this);
 469         return prev.runtimeJavaType();
 470     }
 471
 472     final @NonNull Type methodReturnElementType(final @NonNull TypeBuilderFactory builderFactory) {
 473         var local = methodReturnTypeElement;
 474         if (local == null) {
 475             methodReturnTypeElement = local = createMethodReturnElementType(builderFactory);
 476         }
 477         return local;
 478     }
 479
 480     private @NonNull Type createMethodReturnElementType(final @NonNull TypeBuilderFactory builderFactory) {
 481         final GeneratedType generatedType = tryGeneratedType(builderFactory);
 482         if (generatedType != null) {
 483             // We have generated a type here, so return it. This covers 'bits', 'enumeration' and 'union'.
 484             return generatedType;
 485         }
 486
 487         if (refType != null) {
 488             // This is a reference type of some kind. Defer to its judgement as to what the return type is.
 489             return refType.methodReturnType(builderFactory);
 490         }
 491
 492         final AbstractExplicitGenerator<?, ?> prev = previous();
 493         if (prev != null) {
 494             // We have been added through augment/uses, defer to the original definition
 495             return prev.methodReturnType(builderFactory);
 496         }
 497
 498         final Type baseType;
 499         if (baseGen == null) {
 500             final QName qname = type.argument();
 501             baseType = verifyNotNull(SIMPLE_TYPES.get(qname), "Cannot resolve type %s in %s", qname, this);
 502         } else {
 503             // We are derived from a base generator. Defer to its type for return.
 504             baseType = baseGen.getGeneratedType(builderFactory);
 505         }
 506
 507         return restrictType(baseType, computeRestrictions(), builderFactory);
 508     }
 509
 510     private static @NonNull Type restrictType(final @NonNull Type baseType, final Restrictions restrictions,
 511             final TypeBuilderFactory builderFactory) {
 512         if (restrictions == null || restrictions.isEmpty()) {
 513             // No additional restrictions, return base type
 514             return baseType;
 515         }
 516
 517         if (!(baseType instanceof GeneratedTransferObject gto)) {
 518             // This is a simple Java type, just wrap it with new restrictions
 519             return Types.restrictedType(baseType, restrictions);
 520         }
 521
 522         // Base type is a GTO, we need to re-adjust it with new restrictions
 523         final GeneratedTOBuilder builder = builderFactory.newGeneratedTOBuilder(gto.getIdentifier());
 524         final GeneratedTransferObject parent = gto.getSuperType();
 525         if (parent != null) {
 526             builder.setExtendsType(parent);
 527         }
 528         builder.setRestrictions(restrictions);
 529         for (GeneratedProperty gp : gto.getProperties()) {
 530             builder.addProperty(gp.getName())
 531                 .setValue(gp.getValue())
 532                 .setReadOnly(gp.isReadOnly())
 533                 .setAccessModifier(gp.getAccessModifier())
 534                 .setReturnType(gp.getReturnType())
 535                 .setFinal(gp.isFinal())
 536                 .setStatic(gp.isStatic());
 537         }
 538         return builder.build();
 539     }
 540
 541     @Override
 542     final void addAsGetterMethodOverride(final GeneratedTypeBuilderBase<?> builder,
 543             final TypeBuilderFactory builderFactory) {
 544         if (!(refType instanceof ResolvedLeafref)) {
 545             // We are not dealing with a leafref or have nothing to add
 546             return;
 547         }
 548
 549         final AbstractTypeObjectGenerator<?, ?> prev =
 550             (AbstractTypeObjectGenerator<?, ?>) verifyNotNull(previous(), "Missing previous link in %s", this);
 551         if (prev.refType instanceof ResolvedLeafref) {
 552             // We should be already inheriting the correct type
 553             return;
 554         }
 555
 556         // Note: this may we wrapped for leaf-list, hence we need to deal with that
 557         final Type myType = methodReturnType(builderFactory);
 558         LOG.trace("Override of {} to {}", this, myType);
 559         final MethodSignatureBuilder getter = constructGetter(builder, myType);
 560         getter.addAnnotation(OVERRIDE_ANNOTATION);
 561         annotateDeprecatedIfNecessary(getter);
 562     }
 563
 564     final @Nullable Restrictions computeRestrictions() {
 565         final List<ValueRange> length = type.findFirstEffectiveSubstatementArgument(LengthEffectiveStatement.class)
 566             .orElse(List.of());
 567         final List<ValueRange> range = type.findFirstEffectiveSubstatementArgument(RangeEffectiveStatement.class)
 568             .orElse(List.of());
 569         final List<PatternExpression> patterns = type.streamEffectiveSubstatements(PatternEffectiveStatement.class)
 570             .map(PatternEffectiveStatement::argument)
 571             .collect(Collectors.toUnmodifiableList());
 572
 573         if (length.isEmpty() && range.isEmpty() && patterns.isEmpty()) {
 574             return null;
 575         }
 576
 577         return BindingGeneratorUtil.getRestrictions(extractTypeDefinition());
 578     }
 579
 580     @Override
 581     final GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
 582         if (baseGen != null) {
 583             final GeneratedType baseType = baseGen.getGeneratedType(builderFactory);
 584             verify(baseType instanceof GeneratedTransferObject, "Unexpected base type %s", baseType);
 585             return createDerivedType(builderFactory, (GeneratedTransferObject) baseType);
 586         }
 587
 588         // FIXME: why do we need this boolean?
 589         final boolean isTypedef = this instanceof TypedefGenerator;
 590         final QName arg = type.argument();
 591         if (TypeDefinitions.BITS.equals(arg)) {
 592             return createBits(builderFactory, statement(), typeName(), currentModule(),
 593                 (BitsTypeDefinition) extractTypeDefinition(), isTypedef);
 594         } else if (TypeDefinitions.ENUMERATION.equals(arg)) {
 595             return createEnumeration(builderFactory, statement(), typeName(), currentModule(),
 596                 (EnumTypeDefinition) extractTypeDefinition());
 597         } else if (TypeDefinitions.UNION.equals(arg)) {
 598             final List<GeneratedType> tmp = new ArrayList<>(1);
 599             final GeneratedTransferObject ret = createUnion(tmp, builderFactory, statement(), unionDependencies,
 600                 typeName(), currentModule(), type, isTypedef, extractTypeDefinition());
 601             auxiliaryGeneratedTypes = List.copyOf(tmp);
 602             return ret;
 603         } else {
 604             return createSimple(builderFactory, statement(), typeName(), currentModule(),
 605                 verifyNotNull(SIMPLE_TYPES.get(arg), "Unhandled type %s", arg), extractTypeDefinition());
 606         }
 607     }
 608
 609     private static @NonNull GeneratedTransferObject createBits(final TypeBuilderFactory builderFactory,
 610             final EffectiveStatement<?, ?> definingStatement, final JavaTypeName typeName, final ModuleGenerator module,
 611             final BitsTypeDefinition typedef, final boolean isTypedef) {
 612         final GeneratedTOBuilder builder = builderFactory.newGeneratedTOBuilder(typeName);
 613         builder.setTypedef(isTypedef);
 614         builder.addImplementsType(BindingTypes.BITS_TYPE_OBJECT);
 615         builder.setBaseType(typedef);
 616         YangSourceDefinition.of(module.statement(), definingStatement).ifPresent(builder::setYangSourceDefinition);
 617
 618         for (Bit bit : typedef.getBits()) {
 619             final String name = bit.getName();
 620             GeneratedPropertyBuilder genPropertyBuilder = builder.addProperty(Naming.getPropertyName(name));
 621             genPropertyBuilder.setReadOnly(true);
 622             genPropertyBuilder.setReturnType(Types.primitiveBooleanType());
 623
 624             builder.addEqualsIdentity(genPropertyBuilder);
 625             builder.addHashIdentity(genPropertyBuilder);
 626             builder.addToStringProperty(genPropertyBuilder);
 627         }
 628         builder.addConstant(Types.immutableSetTypeFor(Types.STRING), TypeConstants.VALID_NAMES_NAME, typedef);
 629
 630         // builder.setSchemaPath(typedef.getPath());
 631         builder.setModuleName(module.statement().argument().getLocalName());
 632         builderFactory.addCodegenInformation(typedef, builder);
 633         annotateDeprecatedIfNecessary(typedef, builder);
 634         makeSerializable(builder);
 635         return builder.build();
 636     }
 637
 638     private static @NonNull Enumeration createEnumeration(final TypeBuilderFactory builderFactory,
 639             final EffectiveStatement<?, ?> definingStatement, final JavaTypeName typeName,
 640             final ModuleGenerator module, final EnumTypeDefinition typedef) {
 641         // TODO units for typedef enum
 642         final AbstractEnumerationBuilder builder = builderFactory.newEnumerationBuilder(typeName);
 643         YangSourceDefinition.of(module.statement(), definingStatement).ifPresent(builder::setYangSourceDefinition);
 644
 645         typedef.getDescription().map(BindingGeneratorUtil::encodeAngleBrackets)
 646             .ifPresent(builder::setDescription);
 647         typedef.getReference().ifPresent(builder::setReference);
 648
 649         builder.setModuleName(module.statement().argument().getLocalName());
 650         builder.updateEnumPairsFromEnumTypeDef(typedef);
 651         return builder.toInstance();
 652     }
 653
 654     private static @NonNull GeneratedType createSimple(final TypeBuilderFactory builderFactory,
 655             final EffectiveStatement<?, ?> definingStatement, final JavaTypeName typeName, final ModuleGenerator module,
 656             final Type javaType, final TypeDefinition<?> typedef) {
 657         final String moduleName = module.statement().argument().getLocalName();
 658         final GeneratedTOBuilder builder = builderFactory.newGeneratedTOBuilder(typeName);
 659         builder.setTypedef(true);
 660         builder.addImplementsType(BindingTypes.scalarTypeObject(javaType));
 661         YangSourceDefinition.of(module.statement(), definingStatement).ifPresent(builder::setYangSourceDefinition);
 662
 663         final GeneratedPropertyBuilder genPropBuilder = builder.addProperty(TypeConstants.VALUE_PROP);
 664         genPropBuilder.setReturnType(javaType);
 665         builder.addEqualsIdentity(genPropBuilder);
 666         builder.addHashIdentity(genPropBuilder);
 667         builder.addToStringProperty(genPropBuilder);
 668
 669         builder.setRestrictions(BindingGeneratorUtil.getRestrictions(typedef));
 670
 671 //        builder.setSchemaPath(typedef.getPath());
 672         builder.setModuleName(moduleName);
 673         builderFactory.addCodegenInformation(typedef, builder);
 674
 675         annotateDeprecatedIfNecessary(typedef, builder);
 676
 677         if (javaType instanceof ConcreteType
 678             // FIXME: This looks very suspicious: we should by checking for Types.STRING
 679             && "String".equals(javaType.getName()) && typedef.getBaseType() != null) {
 680             addStringRegExAsConstant(builder, resolveRegExpressions(typedef));
 681         }
 682         addUnits(builder, typedef);
 683
 684         makeSerializable(builder);
 685         return builder.build();
 686     }
 687
 688     private static @NonNull GeneratedTransferObject createUnion(final List<GeneratedType> auxiliaryGeneratedTypes,
 689             final TypeBuilderFactory builderFactory, final EffectiveStatement<?, ?> definingStatement,
 690             final UnionDependencies dependencies, final JavaTypeName typeName, final ModuleGenerator module,
 691             final TypeEffectiveStatement<?> type, final boolean isTypedef, final TypeDefinition<?> typedef) {
 692         final GeneratedUnionBuilder builder = builderFactory.newGeneratedUnionBuilder(typeName);
 693         YangSourceDefinition.of(module.statement(), definingStatement).ifPresent(builder::setYangSourceDefinition);
 694         builder.addImplementsType(BindingTypes.UNION_TYPE_OBJECT);
 695         builder.setIsUnion(true);
 696
 697 //        builder.setSchemaPath(typedef.getPath());
 698         builder.setModuleName(module.statement().argument().getLocalName());
 699         builderFactory.addCodegenInformation(definingStatement, builder);
 700
 701         annotateDeprecatedIfNecessary(definingStatement, builder);
 702
 703         // Pattern string is the key, XSD regex is the value. The reason for this choice is that the pattern carries
 704         // also negation information and hence guarantees uniqueness.
 705         final Map<String, String> expressions = new HashMap<>();
 706
 707         // Linear list of properties generated from subtypes. We need this information for runtime types, as it allows
 708         // direct mapping of type to corresponding property -- without having to resort to re-resolving the leafrefs
 709         // again.
 710         final List<String> typeProperties = new ArrayList<>();
 711
 712         for (EffectiveStatement<?, ?> stmt : type.effectiveSubstatements()) {
 713             if (stmt instanceof TypeEffectiveStatement<?> subType) {
 714                 final QName subName = subType.argument();
 715                 final String localName = subName.getLocalName();
 716
 717                 String propSource = localName;
 718                 final Type generatedType;
 719                 if (TypeDefinitions.UNION.equals(subName)) {
 720                     final JavaTypeName subUnionName = typeName.createEnclosed(
 721                         provideAvailableNameForGenTOBuilder(typeName.simpleName()));
 722                     final GeneratedTransferObject subUnion = createUnion(auxiliaryGeneratedTypes, builderFactory,
 723                         definingStatement, dependencies, subUnionName, module, subType, isTypedef,
 724                         subType.getTypeDefinition());
 725                     builder.addEnclosingTransferObject(subUnion);
 726                     propSource = subUnionName.simpleName();
 727                     generatedType = subUnion;
 728                 } else if (TypeDefinitions.ENUMERATION.equals(subName)) {
 729                     final Enumeration subEnumeration = createEnumeration(builderFactory, definingStatement,
 730                         typeName.createEnclosed(Naming.getClassName(localName), "$"), module,
 731                         (EnumTypeDefinition) subType.getTypeDefinition());
 732                     builder.addEnumeration(subEnumeration);
 733                     generatedType = subEnumeration;
 734                 } else if (TypeDefinitions.BITS.equals(subName)) {
 735                     final GeneratedTransferObject subBits = createBits(builderFactory, definingStatement,
 736                         typeName.createEnclosed(Naming.getClassName(localName), "$"), module,
 737                         (BitsTypeDefinition) subType.getTypeDefinition(), isTypedef);
 738                     builder.addEnclosingTransferObject(subBits);
 739                     generatedType = subBits;
 740                 } else if (TypeDefinitions.IDENTITYREF.equals(subName)) {
 741                     propSource = stmt.findFirstEffectiveSubstatement(BaseEffectiveStatement.class)
 742                         .orElseThrow(() -> new VerifyException(String.format("Invalid identityref "
 743                             + "definition %s in %s, missing BASE statement", stmt, definingStatement)))
 744                         .argument().getLocalName();
 745                     generatedType = verifyNotNull(dependencies.identityTypes.get(stmt),
 746                         "Cannot resolve identityref %s in %s", stmt, definingStatement)
 747                         .methodReturnType(builderFactory);
 748                 } else if (TypeDefinitions.LEAFREF.equals(subName)) {
 749                     generatedType = verifyNotNull(dependencies.leafTypes.get(stmt),
 750                         "Cannot resolve leafref %s in %s", stmt, definingStatement)
 751                         .methodReturnType(builderFactory);
 752                 } else {
 753                     Type baseType = SIMPLE_TYPES.get(subName);
 754                     if (baseType == null) {
 755                         // This has to be a reference to a typedef, let's lookup it up and pick up its type
 756                         final AbstractTypeObjectGenerator<?, ?> baseGen = verifyNotNull(
 757                             dependencies.baseTypes.get(subName), "Cannot resolve base type %s in %s", subName,
 758                             definingStatement);
 759                         baseType = baseGen.methodReturnType(builderFactory);
 760
 761                         // FIXME: This is legacy behaviour for leafrefs:
 762                         if (baseGen.refType instanceof TypeReference.Leafref) {
 763                             // if there already is a compatible property, do not generate a new one
 764                             final Type search = baseType;
 765
 766                             final String matching = builder.getProperties().stream()
 767                                 .filter(prop -> search == ((GeneratedPropertyBuilderImpl) prop).getReturnType())
 768                                 .findFirst()
 769                                 .map(GeneratedPropertyBuilder::getName)
 770                                 .orElse(null);
 771                             if (matching != null) {
 772                                 typeProperties.add(matching);
 773                                 continue;
 774                             }
 775
 776                             // ... otherwise generate this weird property name
 777                             propSource = Naming.getUnionLeafrefMemberName(builder.getName(), baseType.getName());
 778                         }
 779                     }
 780
 781                     expressions.putAll(resolveRegExpressions(subType.getTypeDefinition()));
 782
 783                     generatedType = restrictType(baseType,
 784                         BindingGeneratorUtil.getRestrictions(type.getTypeDefinition()), builderFactory);
 785                 }
 786
 787                 final String propName = Naming.getPropertyName(propSource);
 788                 typeProperties.add(propName);
 789
 790                 if (builder.containsProperty(propName)) {
 791                     /*
 792                      *  FIXME: this is not okay, as we are ignoring multiple base types. For example in the case of:
 793                      *
 794                      *    type union {
 795                      *      type string {
 796                      *        length 1..5;
 797                      *      }
 798                      *      type string {
 799                      *        length 8..10;
 800                      *      }
 801                      *    }
 802                      *
 803                      *  We are ending up losing the information about 8..10 being an alternative. This is also the case
 804                      *  for leafrefs -- we are performing property compression as well (see above). While it is alluring
 805                      *  to merge these into 'length 1..5|8..10', that may not be generally feasible.
 806                      *
 807                      *  We should resort to a counter of conflicting names, i.e. the second string would be mapped to
 808                      *  'string1' or similar.
 809                      */
 810                     continue;
 811                 }
 812
 813                 final GeneratedPropertyBuilder propBuilder = builder
 814                     .addProperty(propName)
 815                     .setReturnType(generatedType);
 816
 817                 builder.addEqualsIdentity(propBuilder);
 818                 builder.addHashIdentity(propBuilder);
 819                 builder.addToStringProperty(propBuilder);
 820             }
 821         }
 822
 823         // Record property names if needed
 824         builder.setTypePropertyNames(typeProperties);
 825
 826         addStringRegExAsConstant(builder, expressions);
 827         addUnits(builder, typedef);
 828
 829         makeSerializable(builder);
 830         return builder.build();
 831     }
 832
 833     // FIXME: we should not rely on TypeDefinition
 834     abstract @NonNull TypeDefinition<?> extractTypeDefinition();
 835
 836     abstract @NonNull GeneratedTransferObject createDerivedType(@NonNull TypeBuilderFactory builderFactory,
 837         @NonNull GeneratedTransferObject baseType);
 838
 839     /**
 840      * Adds to the {@code genTOBuilder} the constant which contains regular expressions from the {@code expressions}.
 841      *
 842      * @param genTOBuilder generated TO builder to which are {@code regular expressions} added
 843      * @param expressions list of string which represent regular expressions
 844      */
 845     static void addStringRegExAsConstant(final GeneratedTOBuilder genTOBuilder, final Map<String, String> expressions) {
 846         if (!expressions.isEmpty()) {
 847             genTOBuilder.addConstant(Types.listTypeFor(BaseYangTypes.STRING_TYPE), TypeConstants.PATTERN_CONSTANT_NAME,
 848                 ImmutableMap.copyOf(expressions));
 849         }
 850     }
 851
 852     /**
 853      * Converts the pattern constraints from {@code typedef} to the list of the strings which represents these
 854      * constraints.
 855      *
 856      * @param typedef extended type in which are the pattern constraints sought
 857      * @return list of strings which represents the constraint patterns
 858      * @throws IllegalArgumentException if <code>typedef</code> equals null
 859      */
 860     static Map<String, String> resolveRegExpressions(final TypeDefinition<?> typedef) {
 861         return typedef instanceof StringTypeDefinition stringTypedef
 862             // TODO: run diff against base ?
 863             ? resolveRegExpressions(stringTypedef.getPatternConstraints())
 864                 : ImmutableMap.of();
 865     }
 866
 867     /**
 868      * Converts the pattern constraints to the list of the strings which represents these constraints.
 869      *
 870      * @param patternConstraints list of pattern constraints
 871      * @return list of strings which represents the constraint patterns
 872      */
 873     private static Map<String, String> resolveRegExpressions(final List<PatternConstraint> patternConstraints) {
 874         if (patternConstraints.isEmpty()) {
 875             return ImmutableMap.of();
 876         }
 877
 878         final Map<String, String> regExps = Maps.newHashMapWithExpectedSize(patternConstraints.size());
 879         for (PatternConstraint patternConstraint : patternConstraints) {
 880             String regEx = patternConstraint.getJavaPatternString();
 881
 882             // The pattern can be inverted
 883             final Optional<ModifierKind> optModifier = patternConstraint.getModifier();
 884             if (optModifier.isPresent()) {
 885                 regEx = applyModifier(optModifier.orElseThrow(), regEx);
 886             }
 887
 888             regExps.put(regEx, patternConstraint.getRegularExpressionString());
 889         }
 890
 891         return regExps;
 892     }
 893
 894     /**
 895      * Returns string which contains the same value as <code>name</code> but integer suffix is incremented by one. If
 896      * <code>name</code> contains no number suffix, a new suffix initialized at 1 is added. A suffix is actually
 897      * composed of a '$' marker, which is safe, as no YANG identifier can contain '$', and a unsigned decimal integer.
 898      *
 899      * @param name string with name of augmented node
 900      * @return string with the number suffix incremented by one (or 1 is added)
 901      */
 902     private static String provideAvailableNameForGenTOBuilder(final String name) {
 903         final int dollar = name.indexOf('$');
 904         if (dollar == -1) {
 905             return name + "$1";
 906         }
 907
 908         final int newSuffix = Integer.parseUnsignedInt(name.substring(dollar + 1)) + 1;
 909         verify(newSuffix > 0, "Suffix counter overflow");
 910         return name.substring(0, dollar + 1) + newSuffix;
 911     }
 912
 913     private static String applyModifier(final ModifierKind modifier, final String pattern) {
 914         return switch (modifier) {
 915             case INVERT_MATCH -> RegexPatterns.negatePatternString(pattern);
 916         };
 917     }
 918 }