binding2/mdsal-binding2-generator-impl/src/main/java/org/opendaylight/mdsal/binding/javav2/generator/impl/ModuleToGenType.java

   1 /*
   2  * Copyright (c) 2017 Cisco Systems, Inc. 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
   9 package org.opendaylight.mdsal.binding.javav2.generator.impl;
  10
  11 import static com.google.common.base.Preconditions.checkArgument;
  12 import static org.opendaylight.mdsal.binding.javav2.generator.impl.AuxiliaryGenUtils.createDescription;
  13 import static org.opendaylight.mdsal.binding.javav2.generator.impl.GenHelperUtil.groupingsToGenTypes;
  14 import static org.opendaylight.mdsal.binding.javav2.generator.impl.GenHelperUtil.moduleTypeBuilder;
  15 import static org.opendaylight.mdsal.binding.javav2.generator.impl.GenHelperUtil.resolveNotification;
  16 import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingTypes.NOTIFICATION_LISTENER;
  17
  18 import com.google.common.annotations.Beta;
  19 import com.google.common.base.Preconditions;
  20 import com.google.common.collect.ImmutableSet;
  21 import java.util.Collection;
  22 import java.util.HashMap;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.Set;
  26 import org.opendaylight.mdsal.binding.javav2.generator.spi.TypeProvider;
  27 import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
  28 import org.opendaylight.mdsal.binding.javav2.generator.yang.types.TypeProviderImpl;
  29 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
  30 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
  31 import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
  32 import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
  33 import org.opendaylight.yangtools.yang.common.QName;
  34 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  35 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  36 import org.opendaylight.yangtools.yang.model.api.Module;
  37 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  38 import org.opendaylight.yangtools.yang.model.api.NotificationNodeContainer;
  39 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  40 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  41 import org.opendaylight.yangtools.yang.model.util.DataNodeIterator;
  42
  43 @Beta
  44 final class ModuleToGenType {
  45
  46     private ModuleToGenType() {
  47         throw new UnsupportedOperationException("Utility class");
  48     }
  49
  50     static Map<Module, ModuleContext> generate(final Module module, final Map<String, Map<String, GeneratedTypeBuilder>>
  51             genTypeBuilders, final SchemaContext schemaContext, final TypeProvider typeProvider, Map<Module,
  52             ModuleContext> genCtx, final boolean verboseClassComments) {
  53
  54         genCtx.put(module, new ModuleContext());
  55         genCtx = allTypeDefinitionsToGenTypes(module, genCtx, typeProvider);
  56         genCtx = groupingsToGenTypes(module, module.getGroupings(), genCtx, schemaContext, verboseClassComments,
  57                 genTypeBuilders, typeProvider);
  58         genCtx = allIdentitiesToGenTypes(module, schemaContext, genCtx, verboseClassComments,  genTypeBuilders, typeProvider);
  59         genCtx = notificationsToGenType(module, genCtx, schemaContext, genTypeBuilders, verboseClassComments, typeProvider);
  60
  61         if (!module.getChildNodes().isEmpty()) {
  62             final GeneratedTypeBuilder moduleType = GenHelperUtil.moduleToDataType(module, genCtx, verboseClassComments);
  63             genCtx.get(module).addModuleNode(moduleType);
  64             final String basePackageName = BindingMapping.getRootPackageName(module);
  65             GenHelperUtil.resolveDataSchemaNodes(module, basePackageName, moduleType, moduleType, module
  66                     .getChildNodes(), genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider,
  67                     BindingNamespaceType.Data);
  68         }
  69
  70         //after potential parent data schema nodes
  71         genCtx = actionsAndRPCMethodsToGenType(module, genCtx, schemaContext, verboseClassComments,
  72                 genTypeBuilders, typeProvider);
  73
  74         return genCtx;
  75     }
  76
  77     /**
  78      * Converts all extended type definitions of module to the list of
  79      * <code>Type</code> objects.
  80      *
  81      * @param module
  82      *            module from which is obtained set of type definitions
  83      * @throws IllegalArgumentException
  84      *             <ul>
  85      *             <li>if module is null</li>
  86      *             <li>if name of module is null</li>
  87      *             </ul>
  88      * @throws IllegalStateException
  89      *             if set of type definitions from module is null
  90      */
  91     private static Map<Module, ModuleContext> allTypeDefinitionsToGenTypes(final Module module, final Map<Module, ModuleContext> genCtx,
  92             final TypeProvider typeProvider) {
  93         Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
  94         Preconditions.checkArgument(module.getName() != null, "Module name cannot be NULL.");
  95         final DataNodeIterator it = new DataNodeIterator(module);
  96         final List<TypeDefinition<?>> typeDefinitions = it.allTypedefs();
  97         Preconditions.checkState(typeDefinitions != null, "Type Definitions for module «module.name» cannot be NULL.");
  98
  99         typeDefinitions.stream().filter(typedef -> typedef != null).forEach(typedef -> {
 100             final Type type = ((TypeProviderImpl) typeProvider).generatedTypeForExtendedDefinitionType(typedef,
 101                     typedef);
 102             if (type != null) {
 103                 final ModuleContext ctx = genCtx.get(module);
 104                 ctx.addTypedefType(typedef.getPath(), type);
 105                 ctx.addTypeToSchema(type, typedef);
 106             }
 107         });
 108         return genCtx;
 109     }
 110
 111     private static Map<Module, ModuleContext> actionsAndRPCMethodsToGenType(final Module module, Map<Module,
 112             ModuleContext> genCtx, final SchemaContext schemaContext, final boolean verboseClassComments,
 113             final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
 114
 115         genCtx = RpcActionGenHelper.rpcMethodsToGenType(module, genCtx, schemaContext, verboseClassComments,
 116                 genTypeBuilders, typeProvider);
 117         genCtx = RpcActionGenHelper.actionMethodsToGenType(module, genCtx, schemaContext, verboseClassComments,
 118                 genTypeBuilders, typeProvider);
 119
 120         return genCtx;
 121     }
 122
 123     /**
 124      * Converts all <b>identities</b> of the module to the list of
 125      * <code>Type</code> objects.
 126      *
 127      * @param module
 128      *            module from which is obtained set of all identity objects to
 129      *            iterate over them
 130      * @param schemaContext
 131      *            schema context only used as input parameter for method
 132      *            {@link GenHelperUtil#identityToGenType(Module, String, IdentitySchemaNode, SchemaContext, Map, boolean, Map, TypeProvider, Map)}
 133      * @param genCtx generated context
 134      * @return returns generated context
 135      *
 136      */
 137     private static Map<Module, ModuleContext> allIdentitiesToGenTypes(final Module module,
 138             final SchemaContext schemaContext, Map<Module, ModuleContext> genCtx, boolean verboseClassComments,
 139             final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
 140
 141         final Set<IdentitySchemaNode> schemaIdentities = module.getIdentities();
 142         final String basePackageName = BindingMapping.getRootPackageName(module);
 143
 144         if (schemaIdentities != null && !schemaIdentities.isEmpty()) {
 145             for (final IdentitySchemaNode identity : schemaIdentities) {
 146                 GenHelperUtil.identityToGenType(module, basePackageName, identity, schemaContext, genCtx,
 147                     verboseClassComments);
 148             }
 149         }
 150
 151         return genCtx;
 152     }
 153
 154     /**
 155      * Converts all <b>notifications</b> of the module to the list of
 156      * <code>Type</code> objects. In addition are to this list added containers
 157      * and lists which are part of this notification.
 158      *
 159      * @param module
 160      *            module from which is obtained set of all notification objects
 161      *            to iterate over them
 162      * @throws IllegalArgumentException
 163      *             <ul>
 164      *             <li>if the module equals null</li>
 165      *             <li>if the name of module equals null</li>
 166      *             </ul>
 167      * @throws IllegalStateException
 168      *             if set of notifications from module is null
 169      */
 170     private static Map<Module, ModuleContext> notificationsToGenType(final Module module, final Map<Module, ModuleContext> genCtx,
 171             final SchemaContext schemaContext, final Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 172             final boolean verboseClassComments, final TypeProvider typeProvider) {
 173         checkArgument(module != null, "Module reference cannot be NULL.");
 174         checkArgument(module.getName() != null, "Module name cannot be NULL.");
 175         final Set<NotificationDefinition> notifications = module.getNotifications();
 176         if (notifications.isEmpty()) {
 177             return genCtx;
 178         }
 179
 180         final GeneratedTypeBuilder listenerInterface = moduleTypeBuilder(module, "Listener", verboseClassComments);
 181         listenerInterface.addImplementsType(NOTIFICATION_LISTENER);
 182         final String basePackageName = BindingMapping.getRootPackageName(module);
 183
 184         for (final NotificationDefinition notification : notifications) {
 185             if (notification != null) {
 186                 resolveNotification(listenerInterface, null, basePackageName, notification, module, schemaContext,
 187                         verboseClassComments, genTypeBuilders, typeProvider, genCtx);
 188             }
 189         }
 190
 191         //YANG 1.1 allows notifications be tied to containers and lists
 192         final Collection<DataSchemaNode> potentials = module.getChildNodes();
 193         Set<NotificationDefinition> tiedNotifications = null;
 194
 195         for (final DataSchemaNode potential : potentials) {
 196             if (potential instanceof NotificationNodeContainer) {
 197                 tiedNotifications = ((NotificationNodeContainer) potential)
 198                         .getNotifications();
 199                 for (final NotificationDefinition tiedNotification: tiedNotifications) {
 200                     if (tiedNotification != null) {
 201                         resolveNotification(listenerInterface, potential.getQName().getLocalName(), basePackageName,
 202                                 tiedNotification, module, schemaContext, verboseClassComments, genTypeBuilders,
 203                                 typeProvider, genCtx);
 204                     }
 205                 }
 206             }
 207         }
 208
 209         if (tiedNotifications != null) {
 210             listenerInterface.setDescription(createDescription(ImmutableSet.<NotificationDefinition>builder()
 211                 .addAll(notifications).addAll(tiedNotifications).build(), module, verboseClassComments));
 212         } else {
 213             listenerInterface.setDescription(createDescription(notifications, module, verboseClassComments));
 214         }
 215
 216         genCtx.get(module).addTopLevelNodeType(listenerInterface);
 217
 218         return genCtx;
 219     }
 220 }