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.ModuleEffectiveStatement;
  29 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  30
  31 /**
  32  * Generator corresponding to a {@code module} statement. These generators are roots for generating types for a
  33  * particular {@link QNameModule} as mapped into the root package.
  34  */
  35 public final class ModuleGenerator extends AbstractCompositeGenerator<ModuleEffectiveStatement, ModuleRuntimeType> {
  36     private final @NonNull JavaTypeName yangModuleInfo;
  37
  38     /**
  39      * Note that for sake of simplicity of lookup and child mapping, this instance serves as the root for all child
  40      * generators, but mapping to {@link CollisionDomain}s and their {@link Member}s is rather weird. This generator
  41      * actually produces one of <em>secondary</em> members, more precisely the {@link BindingMapping#DATA_ROOT_SUFFIX}
  42      * one. Counter-intuitively the other secondary members live as children of this generator. To support this we have
  43      * also have this field, which is actually the <em>primary</em> derived from the module's name.
  44      */
  45     private final Member prefixMember;
  46
  47     ModuleGenerator(final ModuleEffectiveStatement statement) {
  48         super(statement);
  49         yangModuleInfo = JavaTypeName.create(javaPackage(), BindingMapping.MODULE_INFO_CLASS_NAME);
  50         prefixMember = domain().addPrefix(this, new ModuleNamingStrategy(statement.argument()));
  51     }
  52
  53     @Override
  54     ModuleGenerator currentModule() {
  55         return this;
  56     }
  57
  58     @Override
  59     void pushToInference(final SchemaInferenceStack dataTree) {
  60         // No-op
  61     }
  62
  63     @Override
  64     String createJavaPackage() {
  65         return BindingMapping.getRootPackageName(statement().localQNameModule());
  66     }
  67
  68     @Override
  69     AbstractCompositeGenerator<?, ?> getPackageParent() {
  70         return this;
  71     }
  72
  73     @Override
  74     CollisionDomain parentDomain() {
  75         return domain();
  76     }
  77
  78     @Override
  79     Member createMember(final CollisionDomain domain) {
  80         return domain.addSecondary(this, prefixMember, BindingMapping.DATA_ROOT_SUFFIX);
  81     }
  82
  83     @Override
  84     GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
  85         final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
  86         builder.setModuleName(statement().argument().getLocalName());
  87         builder.addImplementsType(BindingTypes.DATA_ROOT);
  88
  89         final int usesCount = addUsesInterfaces(builder, builderFactory);
  90         // if we have more than 2 top level uses statements we need to define getImplementedInterface() on the top-level
  91         // DataRoot object
  92         if (usesCount > 1) {
  93             narrowImplementedInterface(builder);
  94         }
  95
  96         addGetterMethods(builder, builderFactory);
  97         builderFactory.addCodegenInformation(statement(), builder);
  98
  99         return builder.build();
 100     }
 101
 102     @Override
 103     ModuleRuntimeType createRuntimeType(final GeneratedType type, final ModuleEffectiveStatement statement,
 104             final List<RuntimeType> children, final List<AugmentRuntimeType> augments) {
 105         return new DefaultModuleRuntimeType(type, statement, children, augments);
 106     }
 107
 108     @NonNull Member getPrefixMember() {
 109         return verifyNotNull(prefixMember);
 110     }
 111
 112     void addQNameConstant(final GeneratedTypeBuilderBase<?> builder, final AbstractQName localName) {
 113         builder.addConstant(BindingTypes.QNAME, BindingMapping.QNAME_STATIC_FIELD_NAME,
 114             Map.entry(yangModuleInfo, localName.getLocalName()));
 115     }
 116 }