2 * Copyright (c) 2021 PANTHEON.tech, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.generator.impl.reactor;
10 import static com.google.common.base.Verify.verify;
11 import static com.google.common.base.Verify.verifyNotNull;
13 import java.util.ArrayList;
14 import java.util.List;
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.yangtools.binding.contract.Naming;
20 import org.opendaylight.yangtools.binding.contract.StatementNamespace;
21 import org.opendaylight.yangtools.binding.model.api.GeneratedType;
22 import org.opendaylight.yangtools.binding.model.api.JavaTypeName;
23 import org.opendaylight.yangtools.binding.model.api.type.builder.GeneratedTypeBuilderBase;
24 import org.opendaylight.yangtools.binding.model.ri.BindingTypes;
25 import org.opendaylight.yangtools.binding.runtime.api.AugmentRuntimeType;
26 import org.opendaylight.yangtools.binding.runtime.api.ModuleRuntimeType;
27 import org.opendaylight.yangtools.binding.runtime.api.RuntimeType;
28 import org.opendaylight.yangtools.binding.runtime.api.YangDataRuntimeType;
29 import org.opendaylight.yangtools.yang.common.AbstractQName;
30 import org.opendaylight.yangtools.yang.common.QNameModule;
31 import org.opendaylight.yangtools.yang.common.YangDataName;
32 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
33 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
36 * Generator corresponding to a {@code module} statement. These generators are roots for generating types for a
37 * particular {@link QNameModule} as mapped into the root package.
39 public final class ModuleGenerator extends AbstractCompositeGenerator<ModuleEffectiveStatement, ModuleRuntimeType> {
40 private final @NonNull JavaTypeName yangModuleInfo;
43 * Note that for sake of simplicity of lookup and child mapping, this instance serves as the root for all child
44 * generators, but mapping to {@link CollisionDomain}s and their {@link Member}s is rather weird. This generator
45 * actually produces one of <em>secondary</em> members, more precisely the {@link Naming#DATA_ROOT_SUFFIX} one.
46 * Counter-intuitively the other secondary members live as children of this generator. To support this we also have
47 * this field, which is actually the <em>primary</em> derived from the module's name.
49 private final Member prefixMember;
51 ModuleGenerator(final ModuleEffectiveStatement statement) {
53 yangModuleInfo = JavaTypeName.create(Naming.getServicePackageName(statement.localQNameModule()),
54 Naming.MODULE_INFO_CLASS_NAME);
55 prefixMember = domain().addPrefix(this, new ModuleNamingStrategy(statement.argument()));
59 StatementNamespace namespace() {
60 return StatementNamespace.DATA_ROOT;
64 ModuleGenerator currentModule() {
69 void pushToInference(final SchemaInferenceStack dataTree) {
74 String createJavaPackage() {
75 return Naming.getRootPackageName(statement().localQNameModule());
79 AbstractCompositeGenerator<?, ?> getPackageParent() {
84 CollisionDomain parentDomain() {
89 Member createMember(final CollisionDomain domain) {
90 return domain.addSecondary(this, prefixMember, Naming.DATA_ROOT_SUFFIX);
94 GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
95 final var builder = builderFactory.newGeneratedTypeBuilder(typeName());
96 builder.setModuleName(statement().argument().getLocalName());
97 builder.addImplementsType(BindingTypes.DATA_ROOT);
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
103 narrowImplementedInterface(builder);
106 addGetterMethods(builder, builderFactory);
107 builderFactory.addCodegenInformation(statement(), builder);
109 return builder.build();
112 @NonNull Member getPrefixMember() {
113 return verifyNotNull(prefixMember);
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()));
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));
127 CompositeRuntimeTypeBuilder<ModuleEffectiveStatement, ModuleRuntimeType> createBuilder(
128 final ModuleEffectiveStatement statement) {
129 return new CompositeRuntimeTypeBuilder<>(statement) {
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);
135 final var yangDataChildren = new ArrayList<YangDataRuntimeType>();
136 for (var child : ModuleGenerator.this) {
137 if (child instanceof YangDataGenerator yangDataGen) {
138 yangDataChildren.add(yangDataGen.getRuntimeType());
142 return new DefaultModuleRuntimeType(type, statement, children, yangDataChildren);