--- /dev/null
+/*
+ * Copyright (c) 2021 PANTHEON.tech, s.r.o. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.mdsal.binding.generator.impl.reactor;
+
+import static com.google.common.base.Verify.verify;
+import static com.google.common.base.Verify.verifyNotNull;
+
+import java.util.Map;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.mdsal.binding.generator.impl.reactor.CollisionDomain.Member;
+import org.opendaylight.mdsal.binding.model.api.GeneratedType;
+import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
+import org.opendaylight.mdsal.binding.model.api.YangSourceDefinition;
+import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
+import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
+import org.opendaylight.mdsal.binding.model.util.BindingTypes;
+import org.opendaylight.mdsal.binding.model.util.TypeComments;
+import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
+import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.model.api.Module;
+import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
+
+/**
+ * Generator corresponding to a {@code module} statement. These generators are roots for generating types for a
+ * particular {@link QNameModule} as mapped into the root package.
+ */
+public final class ModuleGenerator extends AbstractCompositeGenerator<ModuleEffectiveStatement> {
+ private final @NonNull JavaTypeName yangModuleInfo;
+ private final @NonNull ClassPlacement placement;
+
+ /**
+ * Note that for sake of simplicity of lookup and child mapping, this instance serves as the root for all child
+ * generators, but mapping to {@link CollisionDomain}s and their {@link Member}s is rather weird. This generator
+ * actually produces one of <em>secondary</em> members, more precisely the {@link BindingMapping#DATA_ROOT_SUFFIX}
+ * one. Counter-intuitively the other secondary members live as children of this generator. To support this we have
+ * also have this field, which is actually the <em>primary</em> derived from the module's name.
+ */
+ private final Member prefixMember;
+
+ ModuleGenerator(final ModuleEffectiveStatement statement) {
+ super(statement);
+ yangModuleInfo = JavaTypeName.create(javaPackage(), BindingMapping.MODULE_INFO_CLASS_NAME);
+ placement = computePlacement();
+ prefixMember = placement != ClassPlacement.NONE || haveSecondary()
+ ? domain().addPrefix(new ModuleNamingStrategy(statement.argument())) : null;
+ }
+
+ private @NonNull ClassPlacement computePlacement() {
+ return statement().findFirstEffectiveSubstatement(DataTreeEffectiveStatement.class).isPresent()
+ || statement().findFirstEffectiveSubstatement(ChoiceEffectiveStatement.class).isPresent()
+ ? ClassPlacement.TOP_LEVEL : ClassPlacement.NONE;
+ }
+
+ private boolean haveSecondary() {
+ for (Generator child : this) {
+ if (child instanceof AbstractImplicitGenerator) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ @Override
+ ModuleGenerator currentModule() {
+ return this;
+ }
+
+ @Override
+ void pushToInference(final SchemaInferenceStack dataTree) {
+ // No-op
+ }
+
+ @Override
+ String createJavaPackage() {
+ return BindingMapping.getRootPackageName(statement().localQNameModule());
+ }
+
+ @Override
+ AbstractCompositeGenerator<?> getPackageParent() {
+ return this;
+ }
+
+ @Override
+ CollisionDomain parentDomain() {
+ return domain();
+ }
+
+ @Override
+ ClassPlacement classPlacement() {
+ return placement;
+ }
+
+ @Override
+ Member createMember(final CollisionDomain domain) {
+ return domain.addSecondary(prefixMember, BindingMapping.DATA_ROOT_SUFFIX);
+ }
+
+ @Override
+ GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
+ final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
+ builder.setModuleName(statement().argument().getLocalName());
+ builder.addImplementsType(BindingTypes.DATA_ROOT);
+
+ final int usesCount = addUsesInterfaces(builder, builderFactory);
+ // if we have more than 2 top level uses statements we need to define getImplementedInterface() on the top-level
+ // DataRoot object
+ if (usesCount > 1) {
+ narrowImplementedInterface(builder);
+ }
+
+ addGetterMethods(builder, builderFactory);
+
+ if (builderFactory instanceof TypeBuilderFactory.Codegen) {
+ final ModuleEffectiveStatement stmt = statement();
+ verify(stmt instanceof Module, "Unexpected module %s", stmt);
+ final Module module = (Module) stmt;
+
+ YangSourceDefinition.of(module).ifPresent(builder::setYangSourceDefinition);
+ TypeComments.description(module).ifPresent(builder::addComment);
+ module.getDescription().ifPresent(builder::setDescription);
+ module.getReference().ifPresent(builder::setReference);
+ }
+
+ return builder.build();
+ }
+
+ @NonNull Member getPrefixMember() {
+ return verifyNotNull(prefixMember);
+ }
+
+ void addQNameConstant(final GeneratedTypeBuilderBase<?> builder, final String localName) {
+ builder.addConstant(BindingTypes.QNAME, BindingMapping.QNAME_STATIC_FIELD_NAME,
+ Map.entry(yangModuleInfo, localName));
+ }
+}
Code Review / mdsal.git / blobdiff