binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/ListGenerator.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 org.opendaylight.mdsal.binding.model.ri.BindingTypes.keyAware;
  11
  12 import java.util.List;
  13 import org.eclipse.jdt.annotation.Nullable;
  14 import org.opendaylight.mdsal.binding.generator.impl.rt.DefaultListRuntimeType;
  15 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  16 import org.opendaylight.mdsal.binding.model.api.MethodSignature.ValueMechanics;
  17 import org.opendaylight.mdsal.binding.model.api.Type;
  18 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
  19 import org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder;
  20 import org.opendaylight.mdsal.binding.model.ri.Types;
  21 import org.opendaylight.mdsal.binding.runtime.api.AugmentRuntimeType;
  22 import org.opendaylight.mdsal.binding.runtime.api.KeyRuntimeType;
  23 import org.opendaylight.mdsal.binding.runtime.api.ListRuntimeType;
  24 import org.opendaylight.mdsal.binding.runtime.api.RuntimeType;
  25 import org.opendaylight.yangtools.yang.binding.contract.Naming;
  26 import org.opendaylight.yangtools.yang.binding.contract.StatementNamespace;
  27 import org.opendaylight.yangtools.yang.common.Ordering;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  31
  32 /**
  33  * Generator corresponding to a {@code list} statement.
  34  */
  35 final class ListGenerator extends CompositeSchemaTreeGenerator<ListEffectiveStatement, ListRuntimeType> {
  36     private final @Nullable KeyGenerator keyGen;
  37
  38     ListGenerator(final ListEffectiveStatement statement, final AbstractCompositeGenerator<?, ?> parent) {
  39         super(statement, parent);
  40         keyGen = statement.findFirstEffectiveSubstatement(KeyEffectiveStatement.class)
  41             .map(key -> new KeyGenerator(key, parent, this))
  42             .orElse(null);
  43     }
  44
  45     @Override
  46     StatementNamespace namespace() {
  47         return StatementNamespace.LIST;
  48     }
  49
  50     @Nullable KeyGenerator keyGenerator() {
  51         return keyGen;
  52     }
  53
  54     @Override
  55     void pushToInference(final SchemaInferenceStack dataTree) {
  56         dataTree.enterDataTree(statement().argument());
  57     }
  58
  59     @Override
  60     GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
  61         final var builder = builderFactory.newGeneratedTypeBuilder(typeName());
  62         addImplementsChildOf(builder);
  63         addAugmentable(builder);
  64         addUsesInterfaces(builder, builderFactory);
  65         addConcreteInterfaceMethods(builder);
  66
  67         final var module = currentModule();
  68         module.addQNameConstant(builder, localName());
  69
  70         final var local = keyGen;
  71         if (local != null) {
  72             // Add yang.binding.Identifiable and its key() method
  73             final var keyType = local.getGeneratedType(builderFactory);
  74             builder.addImplementsType(keyAware(keyType));
  75             builder.addMethod(Naming.KEY_AWARE_KEY_NAME)
  76                 .setReturnType(keyType)
  77                 .addAnnotation(OVERRIDE_ANNOTATION);
  78         }
  79
  80         addGetterMethods(builder, builderFactory);
  81
  82         annotateDeprecatedIfNecessary(builder);
  83         builderFactory.addCodegenInformation(module, statement(), builder);
  84         builder.setModuleName(module.statement().argument().getLocalName());
  85         //    builder.setSchemaPath(node.getPath());
  86
  87         return builder.build();
  88     }
  89
  90     private @Nullable KeyRuntimeType keyRuntimeType() {
  91         final var local = keyGen;
  92         return local != null ? local.getRuntimeType() : null;
  93     }
  94
  95     @Override
  96     Type methodReturnType(final TypeBuilderFactory builderFactory) {
  97         final var generatedType = super.methodReturnType(builderFactory);
  98         // We are wrapping the generated type in either a List or a Map based on presence of the key
  99         final var local = keyGen;
 100         if (local != null && statement().ordering() == Ordering.SYSTEM) {
 101             return Types.mapTypeFor(local.getGeneratedType(builderFactory), generatedType);
 102         }
 103
 104         return Types.listTypeFor(generatedType);
 105     }
 106
 107     @Override
 108     MethodSignatureBuilder constructGetter(final GeneratedTypeBuilderBase<?> builder, final Type returnType) {
 109         final var ret = super.constructGetter(builder, returnType).setMechanics(ValueMechanics.NULLIFY_EMPTY);
 110
 111         final var nonnull = builder
 112             .addMethod(Naming.getNonnullMethodName(localName().getLocalName()))
 113             .setReturnType(returnType)
 114             .setDefault(true);
 115         annotateDeprecatedIfNecessary(nonnull);
 116
 117         return ret;
 118     }
 119
 120     @Override
 121     CompositeRuntimeTypeBuilder<ListEffectiveStatement, ListRuntimeType> createBuilder(
 122             final ListEffectiveStatement statement) {
 123         return new CompositeRuntimeTypeBuilder<>(statement) {
 124             @Override
 125             ListRuntimeType build(final GeneratedType type, final ListEffectiveStatement statement,
 126                     final List<RuntimeType> children, final List<AugmentRuntimeType> augments) {
 127                 // FIXME: the key here is not rebased correctly :(
 128                 return new DefaultListRuntimeType(type, statement, children, augments, keyRuntimeType());
 129             }
 130         };
 131     }
 132 }