binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/ModuleGenerator.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.verifyNotNull;
  11
  12 import java.util.List;
  13 import java.util.Map;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.opendaylight.mdsal.binding.generator.impl.reactor.CollisionDomain.Member;
  16 import org.opendaylight.mdsal.binding.generator.impl.rt.DefaultModuleRuntimeType;
  17 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  18 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  19 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
  20 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
  21 import org.opendaylight.mdsal.binding.model.ri.BindingTypes;
  22 import org.opendaylight.mdsal.binding.runtime.api.AugmentRuntimeType;
  23 import org.opendaylight.mdsal.binding.runtime.api.ModuleRuntimeType;
  24 import org.opendaylight.mdsal.binding.runtime.api.RuntimeType;
  25 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  26 import org.opendaylight.yangtools.yang.common.AbstractQName;
  27 import org.opendaylight.yangtools.yang.common.QNameModule;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
  31 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  32
  33 /**
  34  * Generator corresponding to a {@code module} statement. These generators are roots for generating types for a
  35  * particular {@link QNameModule} as mapped into the root package.
  36  */
  37 public final class ModuleGenerator extends AbstractCompositeGenerator<ModuleEffectiveStatement, ModuleRuntimeType> {
  38     private final @NonNull JavaTypeName yangModuleInfo;
  39     private final @NonNull ClassPlacement placement;
  40
  41     /**
  42      * Note that for sake of simplicity of lookup and child mapping, this instance serves as the root for all child
  43      * generators, but mapping to {@link CollisionDomain}s and their {@link Member}s is rather weird. This generator
  44      * actually produces one of <em>secondary</em> members, more precisely the {@link BindingMapping#DATA_ROOT_SUFFIX}
  45      * one. Counter-intuitively the other secondary members live as children of this generator. To support this we have
  46      * also have this field, which is actually the <em>primary</em> derived from the module's name.
  47      */
  48     private final Member prefixMember;
  49
  50     ModuleGenerator(final ModuleEffectiveStatement statement) {
  51         super(statement);
  52         yangModuleInfo = JavaTypeName.create(javaPackage(), BindingMapping.MODULE_INFO_CLASS_NAME);
  53         placement = computePlacement();
  54         prefixMember = placement != ClassPlacement.NONE || haveSecondary()
  55             ? domain().addPrefix(this, new ModuleNamingStrategy(statement.argument())) : null;
  56     }
  57
  58     private @NonNull ClassPlacement computePlacement() {
  59         return statement().findFirstEffectiveSubstatement(DataTreeEffectiveStatement.class).isPresent()
  60             || statement().findFirstEffectiveSubstatement(ChoiceEffectiveStatement.class).isPresent()
  61             ? ClassPlacement.TOP_LEVEL : ClassPlacement.NONE;
  62     }
  63
  64     private boolean haveSecondary() {
  65         for (Generator child : this) {
  66             if (child instanceof AbstractImplicitGenerator) {
  67                 return true;
  68             }
  69         }
  70         return false;
  71     }
  72
  73     @Override
  74     ModuleGenerator currentModule() {
  75         return this;
  76     }
  77
  78     @Override
  79     void pushToInference(final SchemaInferenceStack dataTree) {
  80         // No-op
  81     }
  82
  83     @Override
  84     String createJavaPackage() {
  85         return BindingMapping.getRootPackageName(statement().localQNameModule());
  86     }
  87
  88     @Override
  89     AbstractCompositeGenerator<?, ?> getPackageParent() {
  90         return this;
  91     }
  92
  93     @Override
  94     CollisionDomain parentDomain() {
  95         return domain();
  96     }
  97
  98     @Override
  99     ClassPlacement classPlacement() {
 100         return placement;
 101     }
 102
 103     @Override
 104     Member createMember(final CollisionDomain domain) {
 105         return domain.addSecondary(this, prefixMember, BindingMapping.DATA_ROOT_SUFFIX);
 106     }
 107
 108     @Override
 109     GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
 110         final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
 111         builder.setModuleName(statement().argument().getLocalName());
 112         builder.addImplementsType(BindingTypes.DATA_ROOT);
 113
 114         final int usesCount = addUsesInterfaces(builder, builderFactory);
 115         // if we have more than 2 top level uses statements we need to define getImplementedInterface() on the top-level
 116         // DataRoot object
 117         if (usesCount > 1) {
 118             narrowImplementedInterface(builder);
 119         }
 120
 121         addGetterMethods(builder, builderFactory);
 122         builderFactory.addCodegenInformation(statement(), builder);
 123
 124         return builder.build();
 125     }
 126
 127     @Override
 128     ModuleRuntimeType createRuntimeType(final GeneratedType type, final ModuleEffectiveStatement statement,
 129             final List<RuntimeType> children, final List<AugmentRuntimeType> augments) {
 130         return new DefaultModuleRuntimeType(type, statement, children, augments);
 131     }
 132
 133     @NonNull Member getPrefixMember() {
 134         return verifyNotNull(prefixMember);
 135     }
 136
 137     void addQNameConstant(final GeneratedTypeBuilderBase<?> builder, final AbstractQName localName) {
 138         builder.addConstant(BindingTypes.QNAME, BindingMapping.QNAME_STATIC_FIELD_NAME,
 139             Map.entry(yangModuleInfo, localName.getLocalName()));
 140     }
 141 }