binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/TypedefGenerator.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 java.util.Objects.requireNonNull;
  12
  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.GeneratedType;
  18 import org.opendaylight.mdsal.binding.model.api.Type;
  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.runtime.api.TypedefRuntimeType;
  22 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  24 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  25
  26 /**
  27  * Generator corresponding to a {@code typedef} statement.
  28  */
  29 final class TypedefGenerator extends AbstractTypeObjectGenerator<TypedefEffectiveStatement, TypedefRuntimeType> {
  30     /**
  31      * List of all generators for types directly derived from this typedef. We populate this list during initial type
  32      * linking. It allows us to easily cascade inferences made by this typedef down the type derivation tree.
  33      */
  34     private List<AbstractTypeObjectGenerator<?, ?>> derivedGenerators = null;
  35
  36     TypedefGenerator(final TypedefEffectiveStatement statement, final AbstractCompositeGenerator<?, ?> parent) {
  37         super(statement, parent);
  38     }
  39
  40     @Override
  41     StatementNamespace namespace() {
  42         return StatementNamespace.TYPEDEF;
  43     }
  44
  45     @Override
  46     void pushToInference(final SchemaInferenceStack dataTree) {
  47         dataTree.enterTypedef(statement().argument());
  48     }
  49
  50     void addDerivedGenerator(final AbstractTypeObjectGenerator<?, ?> derivedGenerator) {
  51         if (derivedGenerators == null) {
  52             derivedGenerators = new ArrayList<>(4);
  53         }
  54         derivedGenerators.add(requireNonNull(derivedGenerator));
  55     }
  56
  57     @Override
  58     void bindDerivedGenerators(final TypeReference reference) {
  59         // Trigger any derived resolvers ...
  60         if (derivedGenerators != null) {
  61             for (AbstractTypeObjectGenerator<?, ?> derived : derivedGenerators) {
  62                 derived.bindTypeDefinition(reference);
  63             }
  64         }
  65         // ... and make sure nobody can come in late
  66         derivedGenerators = List.of();
  67     }
  68
  69     @Override
  70     ClassPlacement classPlacementImpl() {
  71         return ClassPlacement.TOP_LEVEL;
  72     }
  73
  74     @Override
  75     TypeDefinition<?> extractTypeDefinition() {
  76         return statement().getTypeDefinition();
  77     }
  78
  79     @Override
  80     GeneratedTransferObject createDerivedType(final TypeBuilderFactory builderFactory,
  81             final GeneratedTransferObject baseType) {
  82         final GeneratedTOBuilder builder = builderFactory.newGeneratedTOBuilder(typeName());
  83         builder.setTypedef(true);
  84         builder.setExtendsType(baseType);
  85         builder.setIsUnion(baseType.isUnionType());
  86         builder.setRestrictions(computeRestrictions());
  87
  88         final TypeDefinition<?> typedef = statement().getTypeDefinition();
  89         annotateDeprecatedIfNecessary(typedef, builder);
  90         addStringRegExAsConstant(builder, resolveRegExpressions(typedef));
  91         addUnits(builder, typedef);
  92
  93         makeSerializable(builder);
  94         return builder.build();
  95     }
  96
  97     @Override
  98     TypedefRuntimeType createExternalRuntimeType(final Type type) {
  99         verify(type instanceof GeneratedType, "Unexpected type %s", type);
 100         return new DefaultTypedefRuntimeType((GeneratedType) type, statement());
 101     }
 102
 103     @Override
 104     TypedefRuntimeType createInternalRuntimeType(final ChildLookup lookup, final TypedefEffectiveStatement statement,
 105             final Type type) {
 106         // 'typedef' statements are not schema tree statements, they should not have internal references
 107         throw new UnsupportedOperationException("Should never be called");
 108     }
 109
 110     @Override
 111     void addAsGetterMethod(final GeneratedTypeBuilderBase<?> builder, final TypeBuilderFactory builderFactory) {
 112         // typedefs are a separate concept
 113     }
 114 }