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.verifyNotNull;
13 import org.eclipse.jdt.annotation.NonNull;
14 import org.opendaylight.mdsal.binding.generator.impl.reactor.CollisionDomain.Member;
15 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
16 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
17 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
18 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
19 import org.opendaylight.mdsal.binding.model.ri.BindingTypes;
20 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
21 import org.opendaylight.yangtools.yang.common.AbstractQName;
22 import org.opendaylight.yangtools.yang.common.QNameModule;
23 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
26 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
29 * Generator corresponding to a {@code module} statement. These generators are roots for generating types for a
30 * particular {@link QNameModule} as mapped into the root package.
32 public final class ModuleGenerator extends AbstractCompositeGenerator<ModuleEffectiveStatement> {
33 private final @NonNull JavaTypeName yangModuleInfo;
34 private final @NonNull ClassPlacement placement;
37 * Note that for sake of simplicity of lookup and child mapping, this instance serves as the root for all child
38 * generators, but mapping to {@link CollisionDomain}s and their {@link Member}s is rather weird. This generator
39 * actually produces one of <em>secondary</em> members, more precisely the {@link BindingMapping#DATA_ROOT_SUFFIX}
40 * one. Counter-intuitively the other secondary members live as children of this generator. To support this we have
41 * also have this field, which is actually the <em>primary</em> derived from the module's name.
43 private final Member prefixMember;
45 ModuleGenerator(final ModuleEffectiveStatement statement) {
47 yangModuleInfo = JavaTypeName.create(javaPackage(), BindingMapping.MODULE_INFO_CLASS_NAME);
48 placement = computePlacement();
49 prefixMember = placement != ClassPlacement.NONE || haveSecondary()
50 ? domain().addPrefix(this, new ModuleNamingStrategy(statement.argument())) : null;
53 private @NonNull ClassPlacement computePlacement() {
54 return statement().findFirstEffectiveSubstatement(DataTreeEffectiveStatement.class).isPresent()
55 || statement().findFirstEffectiveSubstatement(ChoiceEffectiveStatement.class).isPresent()
56 ? ClassPlacement.TOP_LEVEL : ClassPlacement.NONE;
59 private boolean haveSecondary() {
60 for (Generator child : this) {
61 if (child instanceof AbstractImplicitGenerator) {
69 ModuleGenerator currentModule() {
74 void pushToInference(final SchemaInferenceStack dataTree) {
79 String createJavaPackage() {
80 return BindingMapping.getRootPackageName(statement().localQNameModule());
84 AbstractCompositeGenerator<?> getPackageParent() {
89 CollisionDomain parentDomain() {
94 ClassPlacement classPlacement() {
99 Member createMember(final CollisionDomain domain) {
100 return domain.addSecondary(this, prefixMember, BindingMapping.DATA_ROOT_SUFFIX);
104 GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
105 final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
106 builder.setModuleName(statement().argument().getLocalName());
107 builder.addImplementsType(BindingTypes.DATA_ROOT);
109 final int usesCount = addUsesInterfaces(builder, builderFactory);
110 // if we have more than 2 top level uses statements we need to define getImplementedInterface() on the top-level
113 narrowImplementedInterface(builder);
116 addGetterMethods(builder, builderFactory);
117 builderFactory.addCodegenInformation(statement(), builder);
119 return builder.build();
122 @NonNull Member getPrefixMember() {
123 return verifyNotNull(prefixMember);
126 void addQNameConstant(final GeneratedTypeBuilderBase<?> builder, final AbstractQName localName) {
127 builder.addConstant(BindingTypes.QNAME, BindingMapping.QNAME_STATIC_FIELD_NAME,
128 Map.entry(yangModuleInfo, localName.getLocalName()));