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.Verify.verifyNotNull;
11 import static java.util.Objects.requireNonNull;
13 import java.util.ArrayList;
14 import java.util.List;
15 import org.opendaylight.mdsal.binding.generator.impl.rt.DefaultTypedefRuntimeType;
16 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
17 import org.opendaylight.mdsal.binding.model.api.Type;
18 import org.opendaylight.mdsal.binding.model.api.YangSourceDefinition;
19 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder;
20 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
21 import org.opendaylight.mdsal.binding.model.ri.TypeConstants;
22 import org.opendaylight.mdsal.binding.model.ri.Types;
23 import org.opendaylight.mdsal.binding.runtime.api.TypedefRuntimeType;
24 import org.opendaylight.yangtools.yang.binding.contract.StatementNamespace;
25 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
26 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
27 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
28 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
31 * Generator corresponding to a {@code typedef} statement.
33 final class TypedefGenerator extends AbstractTypeObjectGenerator<TypedefEffectiveStatement, TypedefRuntimeType> {
35 * List of all generators for types directly derived from this typedef. We populate this list during initial type
36 * linking. It allows us to easily cascade inferences made by this typedef down the type derivation tree.
38 private List<AbstractTypeObjectGenerator<?, ?>> derivedGenerators = null;
40 TypedefGenerator(final TypedefEffectiveStatement statement, final AbstractCompositeGenerator<?, ?> parent) {
41 super(statement, parent);
45 StatementNamespace namespace() {
46 return StatementNamespace.TYPEDEF;
50 void pushToInference(final SchemaInferenceStack dataTree) {
51 dataTree.enterTypedef(statement().argument());
54 void addDerivedGenerator(final AbstractTypeObjectGenerator<?, ?> derivedGenerator) {
55 if (derivedGenerators == null) {
56 derivedGenerators = new ArrayList<>(4);
58 derivedGenerators.add(requireNonNull(derivedGenerator));
62 void bindDerivedGenerators(final TypeReference reference) {
63 // Trigger any derived resolvers ...
64 if (derivedGenerators != null) {
65 for (var derived : derivedGenerators) {
66 derived.bindTypeDefinition(reference);
69 // ... and make sure nobody can come in late
70 derivedGenerators = List.of();
74 ClassPlacement classPlacementImpl() {
75 return ClassPlacement.TOP_LEVEL;
79 TypeDefinition<?> extractTypeDefinition() {
80 return statement().getTypeDefinition();
84 GeneratedTransferObject createDerivedType(final TypeBuilderFactory builderFactory,
85 final GeneratedTransferObject baseType) {
86 final var builder = builderFactory.newGeneratedTOBuilder(typeName());
87 builder.setTypedef(true);
88 builder.setExtendsType(baseType);
89 builder.setIsUnion(baseType.isUnionType());
90 builder.setRestrictions(computeRestrictions());
91 YangSourceDefinition.of(currentModule().statement(), statement()).ifPresent(builder::setYangSourceDefinition);
93 final var typedef = statement().getTypeDefinition();
94 annotateDeprecatedIfNecessary(typedef, builder);
95 addStringRegExAsConstant(builder, resolveRegExpressions(typedef));
96 addUnits(builder, typedef);
98 if (typedef instanceof BitsTypeDefinition bits) {
99 addValidBits(builder, bits, baseType);
102 makeSerializable(builder);
103 return builder.build();
106 private static void addValidBits(final GeneratedTOBuilder builder, final BitsTypeDefinition typedef,
107 final GeneratedTransferObject baseType) {
108 final var baseDef = verifyNotNull(baseBitsDefinition(baseType), "Could not find definition in %s", baseType);
109 final var myBits = typedef.getBits();
110 if (myBits.size() != baseDef.getBits().size()) {
111 builder.addConstant(Types.immutableSetTypeFor(Types.STRING), TypeConstants.VALID_NAMES_NAME, typedef);
115 private static BitsTypeDefinition baseBitsDefinition(final GeneratedTransferObject gto) {
117 while (wlk != null) {
118 for (var constant : wlk.getConstantDefinitions()) {
119 if (TypeConstants.VALID_NAMES_NAME.equals(constant.getName())) {
120 return (BitsTypeDefinition) constant.getValue();
124 wlk = wlk.getSuperType();
130 TypedefRuntimeType createExternalRuntimeType(final Type type) {
131 return new DefaultTypedefRuntimeType(verifyGeneratedType(type), statement());
135 TypedefRuntimeType createInternalRuntimeType(final AugmentResolver resolver,
136 final TypedefEffectiveStatement statement, final Type type) {
137 // 'typedef' statements are not schema tree statements, they should not have internal references
138 throw new UnsupportedOperationException("Should never be called");
142 void addAsGetterMethod(final GeneratedTypeBuilderBase<?> builder, final TypeBuilderFactory builderFactory) {
143 // typedefs are a separate concept