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.binding.contract.StatementNamespace;
  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().name();
  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         dataTree.enterYangData(statement().argument());
  77     }
  78
  79     @Override
  80     final ClassPlacement classPlacement() {
  81         return ClassPlacement.TOP_LEVEL;
  82     }
  83
  84     @Override
  85     final Member createMember(final CollisionDomain domain) {
  86         return domain.addPrimary(this, createNamingStrategy());
  87     }
  88
  89     abstract @NonNull ClassNamingStrategy createNamingStrategy();
  90
  91     @Override
  92     final StatementNamespace namespace() {
  93         return StatementNamespace.YANG_DATA;
  94     }
  95
  96     @Override
  97     final GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
  98         final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
  99
 100         builder.addImplementsType(BindingTypes.yangData(builder));
 101         addUsesInterfaces(builder, builderFactory);
 102         addConcreteInterfaceMethods(builder);
 103
 104         addGetterMethods(builder, builderFactory);
 105
 106         final var module = currentModule();
 107         module.addNameConstant(builder, statement().argument());
 108
 109         builder.setModuleName(module.statement().argument().getLocalName());
 110         builderFactory.addCodegenInformation(module, statement(), builder);
 111
 112         return builder.build();
 113     }
 114
 115     @Override
 116     final CompositeRuntimeTypeBuilder<YangDataEffectiveStatement, YangDataRuntimeType> createBuilder(
 117             final YangDataEffectiveStatement statement) {
 118         return new CompositeRuntimeTypeBuilder<>(statement) {
 119             @Override
 120             YangDataRuntimeType build(final GeneratedType type, final YangDataEffectiveStatement statement,
 121                     final List<RuntimeType> children, final List<AugmentRuntimeType> augments) {
 122                 return new DefaultYangDataRuntimeType(type, statement, children);
 123             }
 124         };
 125     }
 126
 127     @Override
 128     final void addAsGetterMethod(final GeneratedTypeBuilderBase<?> builder, final TypeBuilderFactory builderFactory) {
 129         // is not a part of any structure
 130     }
 131 }