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