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