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