binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/YangDataGenerator.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 java.util.Objects.requireNonNull;
  11
  12 import java.util.List;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.opendaylight.mdsal.binding.generator.impl.reactor.CollisionDomain.Member;
  15 import org.opendaylight.mdsal.binding.generator.impl.rt.DefaultYangDataRuntimeType;
  16 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  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.runtime.api.AugmentRuntimeType;
  21 import org.opendaylight.mdsal.binding.runtime.api.RuntimeType;
  22 import org.opendaylight.mdsal.binding.runtime.api.YangDataRuntimeType;
  23 import org.opendaylight.yangtools.rfc8040.model.api.YangDataEffectiveStatement;
  24 import org.opendaylight.yangtools.yang.common.QNameModule;
  25 import org.opendaylight.yangtools.yang.common.UnresolvedQName;
  26 import org.opendaylight.yangtools.yang.common.UnresolvedQName.Unqualified;
  27 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  28
  29 /**
  30  * Generator corresponding to a {@code rc:yang-data} statement.
  31  */
  32 abstract sealed class YangDataGenerator
  33         extends AbstractCompositeGenerator<YangDataEffectiveStatement, YangDataRuntimeType> {
  34     private static final class WithIdentifier extends YangDataGenerator {
  35         private final @NonNull Unqualified identifier;
  36
  37         WithIdentifier(final YangDataEffectiveStatement statement, final ModuleGenerator parent,
  38                 final Unqualified identifier) {
  39             super(statement, parent);
  40             this.identifier = requireNonNull(identifier);
  41         }
  42
  43         @Override
  44         CamelCaseNamingStrategy createNamingStrategy() {
  45             return new CamelCaseNamingStrategy(namespace(), identifier);
  46         }
  47     }
  48
  49     private static final class WithString extends YangDataGenerator {
  50         WithString(final YangDataEffectiveStatement statement, final ModuleGenerator parent) {
  51             super(statement, parent);
  52         }
  53
  54         @Override
  55         YangDataNamingStrategy createNamingStrategy() {
  56             return new YangDataNamingStrategy(statement().argument());
  57         }
  58     }
  59
  60     private YangDataGenerator(final YangDataEffectiveStatement statement, final ModuleGenerator parent) {
  61         super(statement, parent);
  62     }
  63
  64     static @NonNull YangDataGenerator of(final YangDataEffectiveStatement statement, final ModuleGenerator parent) {
  65         // yang-data's argument is not guaranteed to comply with YANG 'identifier', but it usually does. If it does, we
  66         // use the usual mechanics, but if it does not, we have to deal with any old string, similar to what we do for
  67         // bit names. Here we decide which path to take.
  68         final String templateName = statement.argument();
  69         final var identifier = UnresolvedQName.tryLocalName(templateName);
  70         return identifier != null ? new WithIdentifier(statement, parent, identifier)
  71             : new WithString(statement, parent);
  72     }
  73
  74     @Override
  75     final void pushToInference(final SchemaInferenceStack dataTree) {
  76         final QNameModule moduleQName = currentModule().getQName().getModule();
  77         dataTree.enterYangData(moduleQName, statement().argument());
  78     }
  79
  80     @Override
  81     final ClassPlacement classPlacement() {
  82         return ClassPlacement.TOP_LEVEL;
  83     }
  84
  85     @Override
  86     final Member createMember(final CollisionDomain domain) {
  87         return domain.addPrimary(this, createNamingStrategy());
  88     }
  89
  90     abstract @NonNull ClassNamingStrategy createNamingStrategy();
  91
  92     @Override
  93     final StatementNamespace namespace() {
  94         return StatementNamespace.YANG_DATA;
  95     }
  96
  97     @Override
  98     final GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
  99         final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
 100
 101         builder.addImplementsType(BindingTypes.yangData(builder));
 102         addUsesInterfaces(builder, builderFactory);
 103         addConcreteInterfaceMethods(builder);
 104
 105         addGetterMethods(builder, builderFactory);
 106
 107         final var module = currentModule();
 108         module.addNameConstant(builder, statement().argument());
 109
 110         builder.setModuleName(module.statement().argument().getLocalName());
 111         builderFactory.addCodegenInformation(module, statement(), builder);
 112
 113         return builder.build();
 114     }
 115
 116     @Override
 117     final CompositeRuntimeTypeBuilder<YangDataEffectiveStatement, YangDataRuntimeType> createBuilder(
 118             final YangDataEffectiveStatement statement) {
 119         return new CompositeRuntimeTypeBuilder<>(statement) {
 120             @Override
 121             YangDataRuntimeType build(final GeneratedType type, final YangDataEffectiveStatement statement,
 122                     final List<RuntimeType> children, final List<AugmentRuntimeType> augments) {
 123                 return new DefaultYangDataRuntimeType(type, statement, children);
 124             }
 125         };
 126     }
 127
 128     @Override
 129     final void addAsGetterMethod(final GeneratedTypeBuilderBase<?> builder, final TypeBuilderFactory builderFactory) {
 130         // is not a part of any structure
 131     }
 132 }