2 * Copyright (c) 2021 PANTHEON.tech, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.generator.impl.reactor;
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;
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;
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.mdsal.binding.spec.naming.BindingMapping;
48 import org.opendaylight.yangtools.concepts.Immutable;
49 import org.opendaylight.yangtools.yang.binding.RegexPatterns;
50 import org.opendaylight.yangtools.yang.binding.TypeObject;
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;
74 * Common base class for {@link TypedefGenerator} and {@link AbstractTypeAwareGenerator}. This encompasses three
75 * different statements with two different semantics:
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>
85 * To throw a bit of confusion into the mix, there are three exceptions to those rules:
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.
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:
107 * which results in fine-looking
111 * Class<? extends Iden> getFoo();
117 * This gets more dicey if we decide to extend the previous snippet to also include:
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:
142 * public class BarRef extends ScalarTypeObject<Class<? extends Iden>> {
143 * Class<? extends Iden> getValue() {
158 * Class<? extends Iden> getBar();
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.
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.
176 * Take the example of the following model:
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.
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.
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.
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<>();
234 UnionDependencies(final TypeEffectiveStatement<?> type, final GeneratorContext context) {
235 resolveUnionDependencies(context, type);
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())));
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)
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));
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)
284 private final TypeEffectiveStatement<?> type;
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.
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.
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();
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.
305 private Type methodReturnTypeElement;
307 AbstractTypeObjectGenerator(final S statement, final AbstractCompositeGenerator<?, ?> parent) {
308 super(statement, parent);
309 type = statement().findFirstEffectiveSubstatement(TypeEffectiveStatement.class).orElseThrow();
313 public final List<GeneratedType> auxiliaryGeneratedTypes() {
314 return auxiliaryGeneratedTypes;
318 final void linkDependencies(final GeneratorContext context) {
319 verify(inferred != null, "Duplicate linking of %s", this);
321 final QName typeName = type.argument();
322 if (isBuiltinName(typeName)) {
323 verify(inferred.isEmpty(), "Unexpected non-empty downstreams in %s", this);
328 final AbstractExplicitGenerator<S, R> prev = previous();
330 verify(prev instanceof AbstractTypeObjectGenerator, "Unexpected previous %s", prev);
331 ((AbstractTypeObjectGenerator<S, R>) prev).linkInferred(this);
333 linkBaseGen(context.resolveTypedef(typeName));
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));
343 if (inferred.isEmpty()) {
344 inferred = new ArrayList<>(2);
346 inferred.add(downstream);
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);
357 for (AbstractTypeObjectGenerator<?, ?> downstream : downstreams) {
358 downstream.linkBaseGen(upstreamBaseGen);
362 void bindTypeDefinition(final GeneratorContext context) {
363 if (baseGen != null) {
364 // We have registered with baseGen, it will push the type to us
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);
385 LOG.trace("Resolved base {} to generator {}", type, refType);
386 bindDerivedGenerators(refType);
389 final void bindTypeDefinition(final @Nullable TypeReference reference) {
391 LOG.trace("Resolved derived {} to generator {}", type, refType);
394 private static boolean isBuiltinName(final QName typeName) {
395 return YangConstants.RFC6020_YANG_MODULE.equals(typeName.getModule());
398 abstract void bindDerivedGenerators(@Nullable TypeReference reference);
401 final ClassPlacement classPlacement() {
402 if (refType != null) {
403 // Reference types never create a new type
404 return ClassPlacement.NONE;
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;
411 return classPlacementImpl();
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:
419 // type uint8 { range 0..255; }
425 // type uint8 { range 0..100; }
429 // type foo { range 0..100; }
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
435 return baseGen != null || SIMPLE_TYPES.containsKey(type.argument()) || isAddedByUses() || isAugmenting()
436 ? ClassPlacement.NONE : ClassPlacement.MEMBER;
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);
446 final boolean isEnumeration() {
447 return baseGen != null ? baseGen.isEnumeration() : TypeDefinitions.ENUMERATION.equals(type.argument());
450 final boolean isDerivedEnumeration() {
451 return baseGen != null && baseGen.isEnumeration();
455 Type methodReturnType(final TypeBuilderFactory builderFactory) {
456 return methodReturnElementType(builderFactory);
460 final Type runtimeJavaType() {
461 if (methodReturnTypeElement != null) {
462 return methodReturnTypeElement;
464 final var genType = generatedType();
465 if (genType.isPresent()) {
466 return genType.orElseThrow();
468 final var prev = verifyNotNull(previous(), "No previous generator for %s", this);
469 return prev.runtimeJavaType();
472 final @NonNull Type methodReturnElementType(final @NonNull TypeBuilderFactory builderFactory) {
473 var local = methodReturnTypeElement;
475 methodReturnTypeElement = local = createMethodReturnElementType(builderFactory);
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;
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);
492 final AbstractExplicitGenerator<?, ?> prev = previous();
494 // We have been added through augment/uses, defer to the original definition
495 return prev.methodReturnType(builderFactory);
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);
503 // We are derived from a base generator. Defer to its type for return.
504 baseType = baseGen.getGeneratedType(builderFactory);
507 return restrictType(baseType, computeRestrictions(), builderFactory);
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
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);
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);
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());
538 return builder.build();
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
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
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);
564 final @Nullable Restrictions computeRestrictions() {
565 final List<ValueRange> length = type.findFirstEffectiveSubstatementArgument(LengthEffectiveStatement.class)
567 final List<ValueRange> range = type.findFirstEffectiveSubstatementArgument(RangeEffectiveStatement.class)
569 final List<PatternExpression> patterns = type.streamEffectiveSubstatements(PatternEffectiveStatement.class)
570 .map(PatternEffectiveStatement::argument)
571 .collect(Collectors.toUnmodifiableList());
573 if (length.isEmpty() && range.isEmpty() && patterns.isEmpty()) {
577 return BindingGeneratorUtil.getRestrictions(extractTypeDefinition());
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);
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, typeName(), currentModule(), extractTypeDefinition(), isTypedef);
593 } else if (TypeDefinitions.ENUMERATION.equals(arg)) {
594 return createEnumeration(builderFactory, typeName(), currentModule(),
595 (EnumTypeDefinition) extractTypeDefinition());
596 } else if (TypeDefinitions.UNION.equals(arg)) {
597 final List<GeneratedType> tmp = new ArrayList<>(1);
598 final GeneratedTransferObject ret = createUnion(tmp, builderFactory, statement(), unionDependencies,
599 typeName(), currentModule(), type, isTypedef, extractTypeDefinition());
600 auxiliaryGeneratedTypes = List.copyOf(tmp);
603 return createSimple(builderFactory, typeName(), currentModule(),
604 verifyNotNull(SIMPLE_TYPES.get(arg), "Unhandled type %s", arg), extractTypeDefinition());
608 private static @NonNull GeneratedTransferObject createBits(final TypeBuilderFactory builderFactory,
609 final JavaTypeName typeName, final ModuleGenerator module, final TypeDefinition<?> typedef,
610 final boolean isTypedef) {
611 final GeneratedTOBuilder builder = builderFactory.newGeneratedTOBuilder(typeName);
612 builder.setTypedef(isTypedef);
613 builder.addImplementsType(BindingTypes.TYPE_OBJECT);
614 builder.setBaseType(typedef);
616 for (Bit bit : ((BitsTypeDefinition) typedef).getBits()) {
617 final String name = bit.getName();
618 GeneratedPropertyBuilder genPropertyBuilder = builder.addProperty(BindingMapping.getPropertyName(name));
619 genPropertyBuilder.setReadOnly(true);
620 genPropertyBuilder.setReturnType(BaseYangTypes.BOOLEAN_TYPE);
622 builder.addEqualsIdentity(genPropertyBuilder);
623 builder.addHashIdentity(genPropertyBuilder);
624 builder.addToStringProperty(genPropertyBuilder);
627 // builder.setSchemaPath(typedef.getPath());
628 builder.setModuleName(module.statement().argument().getLocalName());
629 builderFactory.addCodegenInformation(typedef, builder);
630 annotateDeprecatedIfNecessary(typedef, builder);
631 makeSerializable(builder);
632 return builder.build();
635 private static @NonNull Enumeration createEnumeration(final TypeBuilderFactory builderFactory,
636 final JavaTypeName typeName, final ModuleGenerator module, final EnumTypeDefinition typedef) {
637 // TODO units for typedef enum
638 final AbstractEnumerationBuilder builder = builderFactory.newEnumerationBuilder(typeName);
640 typedef.getDescription().map(BindingGeneratorUtil::encodeAngleBrackets)
641 .ifPresent(builder::setDescription);
642 typedef.getReference().ifPresent(builder::setReference);
644 builder.setModuleName(module.statement().argument().getLocalName());
645 builder.updateEnumPairsFromEnumTypeDef(typedef);
646 return builder.toInstance();
649 private static @NonNull GeneratedType createSimple(final TypeBuilderFactory builderFactory,
650 final JavaTypeName typeName, final ModuleGenerator module, final Type javaType,
651 final TypeDefinition<?> typedef) {
652 final String moduleName = module.statement().argument().getLocalName();
653 final GeneratedTOBuilder builder = builderFactory.newGeneratedTOBuilder(typeName);
654 builder.setTypedef(true);
655 builder.addImplementsType(BindingTypes.scalarTypeObject(javaType));
657 final GeneratedPropertyBuilder genPropBuilder = builder.addProperty(TypeConstants.VALUE_PROP);
658 genPropBuilder.setReturnType(javaType);
659 builder.addEqualsIdentity(genPropBuilder);
660 builder.addHashIdentity(genPropBuilder);
661 builder.addToStringProperty(genPropBuilder);
663 builder.setRestrictions(BindingGeneratorUtil.getRestrictions(typedef));
665 // builder.setSchemaPath(typedef.getPath());
666 builder.setModuleName(moduleName);
667 builderFactory.addCodegenInformation(typedef, builder);
669 annotateDeprecatedIfNecessary(typedef, builder);
671 if (javaType instanceof ConcreteType
672 // FIXME: This looks very suspicious: we should by checking for Types.STRING
673 && "String".equals(javaType.getName()) && typedef.getBaseType() != null) {
674 addStringRegExAsConstant(builder, resolveRegExpressions(typedef));
676 addUnits(builder, typedef);
678 makeSerializable(builder);
679 return builder.build();
682 private static @NonNull GeneratedTransferObject createUnion(final List<GeneratedType> auxiliaryGeneratedTypes,
683 final TypeBuilderFactory builderFactory, final EffectiveStatement<?, ?> definingStatement,
684 final UnionDependencies dependencies, final JavaTypeName typeName, final ModuleGenerator module,
685 final TypeEffectiveStatement<?> type, final boolean isTypedef, final TypeDefinition<?> typedef) {
686 final GeneratedUnionBuilder builder = builderFactory.newGeneratedUnionBuilder(typeName);
687 YangSourceDefinition.of(module.statement(), definingStatement).ifPresent(builder::setYangSourceDefinition);
688 builder.addImplementsType(BindingTypes.TYPE_OBJECT);
689 builder.setIsUnion(true);
691 // builder.setSchemaPath(typedef.getPath());
692 builder.setModuleName(module.statement().argument().getLocalName());
693 builderFactory.addCodegenInformation(definingStatement, builder);
695 annotateDeprecatedIfNecessary(definingStatement, builder);
697 // Pattern string is the key, XSD regex is the value. The reason for this choice is that the pattern carries
698 // also negation information and hence guarantees uniqueness.
699 final Map<String, String> expressions = new HashMap<>();
701 // Linear list of properties generated from subtypes. We need this information for runtime types, as it allows
702 // direct mapping of type to corresponding property -- without having to resort to re-resolving the leafrefs
704 final List<String> typeProperties = new ArrayList<>();
706 for (EffectiveStatement<?, ?> stmt : type.effectiveSubstatements()) {
707 if (stmt instanceof TypeEffectiveStatement<?> subType) {
708 final QName subName = subType.argument();
709 final String localName = subName.getLocalName();
711 String propSource = localName;
712 final Type generatedType;
713 if (TypeDefinitions.UNION.equals(subName)) {
714 final JavaTypeName subUnionName = typeName.createEnclosed(
715 provideAvailableNameForGenTOBuilder(typeName.simpleName()));
716 final GeneratedTransferObject subUnion = createUnion(auxiliaryGeneratedTypes, builderFactory,
717 definingStatement, dependencies, subUnionName, module, subType, isTypedef,
718 subType.getTypeDefinition());
719 builder.addEnclosingTransferObject(subUnion);
720 propSource = subUnionName.simpleName();
721 generatedType = subUnion;
722 } else if (TypeDefinitions.ENUMERATION.equals(subName)) {
723 final Enumeration subEnumeration = createEnumeration(builderFactory,
724 typeName.createEnclosed(BindingMapping.getClassName(localName), "$"), module,
725 (EnumTypeDefinition) subType.getTypeDefinition());
726 builder.addEnumeration(subEnumeration);
727 generatedType = subEnumeration;
728 } else if (TypeDefinitions.BITS.equals(subName)) {
729 final GeneratedTransferObject subBits = createBits(builderFactory,
730 typeName.createEnclosed(BindingMapping.getClassName(localName), "$"), module,
731 subType.getTypeDefinition(), isTypedef);
732 builder.addEnclosingTransferObject(subBits);
733 generatedType = subBits;
734 } else if (TypeDefinitions.IDENTITYREF.equals(subName)) {
735 propSource = stmt.findFirstEffectiveSubstatement(BaseEffectiveStatement.class)
736 .orElseThrow(() -> new VerifyException(String.format("Invalid identityref "
737 + "definition %s in %s, missing BASE statement", stmt, definingStatement)))
738 .argument().getLocalName();
739 generatedType = verifyNotNull(dependencies.identityTypes.get(stmt),
740 "Cannot resolve identityref %s in %s", stmt, definingStatement)
741 .methodReturnType(builderFactory);
742 } else if (TypeDefinitions.LEAFREF.equals(subName)) {
743 generatedType = verifyNotNull(dependencies.leafTypes.get(stmt),
744 "Cannot resolve leafref %s in %s", stmt, definingStatement)
745 .methodReturnType(builderFactory);
747 Type baseType = SIMPLE_TYPES.get(subName);
748 if (baseType == null) {
749 // This has to be a reference to a typedef, let's lookup it up and pick up its type
750 final AbstractTypeObjectGenerator<?, ?> baseGen = verifyNotNull(
751 dependencies.baseTypes.get(subName), "Cannot resolve base type %s in %s", subName,
753 baseType = baseGen.methodReturnType(builderFactory);
755 // FIXME: This is legacy behaviour for leafrefs:
756 if (baseGen.refType instanceof TypeReference.Leafref) {
757 // if there already is a compatible property, do not generate a new one
758 final Type search = baseType;
760 final String matching = builder.getProperties().stream()
761 .filter(prop -> search == ((GeneratedPropertyBuilderImpl) prop).getReturnType())
763 .map(GeneratedPropertyBuilder::getName)
765 if (matching != null) {
766 typeProperties.add(matching);
770 // ... otherwise generate this weird property name
771 propSource = BindingMapping.getUnionLeafrefMemberName(builder.getName(),
776 expressions.putAll(resolveRegExpressions(subType.getTypeDefinition()));
778 generatedType = restrictType(baseType,
779 BindingGeneratorUtil.getRestrictions(type.getTypeDefinition()), builderFactory);
782 final String propName = BindingMapping.getPropertyName(propSource);
783 typeProperties.add(propName);
785 if (builder.containsProperty(propName)) {
787 * FIXME: this is not okay, as we are ignoring multiple base types. For example in the case of:
798 * We are ending up losing the information about 8..10 being an alternative. This is also the case
799 * for leafrefs -- we are performing property compression as well (see above). While it is alluring
800 * to merge these into 'length 1..5|8..10', that may not be generally feasible.
802 * We should resort to a counter of conflicting names, i.e. the second string would be mapped to
803 * 'string1' or similar.
808 final GeneratedPropertyBuilder propBuilder = builder
809 .addProperty(propName)
810 .setReturnType(generatedType);
812 builder.addEqualsIdentity(propBuilder);
813 builder.addHashIdentity(propBuilder);
814 builder.addToStringProperty(propBuilder);
818 // Record property names if needed
819 builder.setTypePropertyNames(typeProperties);
821 addStringRegExAsConstant(builder, expressions);
822 addUnits(builder, typedef);
824 makeSerializable(builder);
825 return builder.build();
828 // FIXME: we should not rely on TypeDefinition
829 abstract @NonNull TypeDefinition<?> extractTypeDefinition();
831 abstract @NonNull GeneratedTransferObject createDerivedType(@NonNull TypeBuilderFactory builderFactory,
832 @NonNull GeneratedTransferObject baseType);
835 * Adds to the {@code genTOBuilder} the constant which contains regular expressions from the {@code expressions}.
837 * @param genTOBuilder generated TO builder to which are {@code regular expressions} added
838 * @param expressions list of string which represent regular expressions
840 static void addStringRegExAsConstant(final GeneratedTOBuilder genTOBuilder, final Map<String, String> expressions) {
841 if (!expressions.isEmpty()) {
842 genTOBuilder.addConstant(Types.listTypeFor(BaseYangTypes.STRING_TYPE), TypeConstants.PATTERN_CONSTANT_NAME,
843 ImmutableMap.copyOf(expressions));
848 * Converts the pattern constraints from {@code typedef} to the list of the strings which represents these
851 * @param typedef extended type in which are the pattern constraints sought
852 * @return list of strings which represents the constraint patterns
853 * @throws IllegalArgumentException if <code>typedef</code> equals null
855 static Map<String, String> resolveRegExpressions(final TypeDefinition<?> typedef) {
856 return typedef instanceof StringTypeDefinition stringTypedef
857 // TODO: run diff against base ?
858 ? resolveRegExpressions(stringTypedef.getPatternConstraints())
863 * Converts the pattern constraints to the list of the strings which represents these constraints.
865 * @param patternConstraints list of pattern constraints
866 * @return list of strings which represents the constraint patterns
868 private static Map<String, String> resolveRegExpressions(final List<PatternConstraint> patternConstraints) {
869 if (patternConstraints.isEmpty()) {
870 return ImmutableMap.of();
873 final Map<String, String> regExps = Maps.newHashMapWithExpectedSize(patternConstraints.size());
874 for (PatternConstraint patternConstraint : patternConstraints) {
875 String regEx = patternConstraint.getJavaPatternString();
877 // The pattern can be inverted
878 final Optional<ModifierKind> optModifier = patternConstraint.getModifier();
879 if (optModifier.isPresent()) {
880 regEx = applyModifier(optModifier.get(), regEx);
883 regExps.put(regEx, patternConstraint.getRegularExpressionString());
890 * Returns string which contains the same value as <code>name</code> but integer suffix is incremented by one. If
891 * <code>name</code> contains no number suffix, a new suffix initialized at 1 is added. A suffix is actually
892 * composed of a '$' marker, which is safe, as no YANG identifier can contain '$', and a unsigned decimal integer.
894 * @param name string with name of augmented node
895 * @return string with the number suffix incremented by one (or 1 is added)
897 private static String provideAvailableNameForGenTOBuilder(final String name) {
898 final int dollar = name.indexOf('$');
903 final int newSuffix = Integer.parseUnsignedInt(name.substring(dollar + 1)) + 1;
904 verify(newSuffix > 0, "Suffix counter overflow");
905 return name.substring(0, dollar + 1) + newSuffix;
908 private static String applyModifier(final ModifierKind modifier, final String pattern) {
909 return switch (modifier) {
910 case INVERT_MATCH -> RegexPatterns.negatePatternString(pattern);