binding2/mdsal-binding2-generator-impl/src/main/java/org/opendaylight/mdsal/binding/javav2/generator/impl/AugmentToGenType.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 com.google.common.annotations.Beta;
  12 import com.google.common.base.Optional;
  13 import com.google.common.base.Preconditions;
  14 import java.util.ArrayList;
  15 import java.util.Collections;
  16 import java.util.Comparator;
  17 import java.util.Iterator;
  18 import java.util.List;
  19 import java.util.Map;
  20 import java.util.Map.Entry;
  21 import java.util.Set;
  22 import java.util.stream.Collectors;
  23 import org.opendaylight.mdsal.binding.javav2.generator.spi.TypeProvider;
  24 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil;
  25 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
  26 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
  27 import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
  28 import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
  29 import org.opendaylight.yangtools.yang.common.QName;
  30 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  31 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
  32 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  33 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  34 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  35 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
  36 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  37 import org.opendaylight.yangtools.yang.model.api.Module;
  38 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  39 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  40 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  41 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  42 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  43 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  44
  45 @Beta
  46 final class AugmentToGenType {
  47
  48     /**
  49      * Comparator based on augment target path.
  50      */
  51     private static final Comparator<AugmentationSchema> AUGMENT_COMP = (o1, o2) -> {
  52         final Iterator<QName> thisIt = o1.getTargetPath().getPathFromRoot().iterator();
  53         final Iterator<QName> otherIt = o2.getTargetPath().getPathFromRoot().iterator();
  54
  55         while (thisIt.hasNext()) {
  56             if (!otherIt.hasNext()) {
  57                 return 1;
  58             }
  59
  60             final int comp = thisIt.next().compareTo(otherIt.next());
  61             if (comp != 0) {
  62                 return comp;
  63             }
  64         }
  65
  66         return otherIt.hasNext() ? -1 : 0;
  67     };
  68
  69     /**
  70      * Comparator based on augment target path.
  71      */
  72     private static final Comparator<Map.Entry<SchemaPath, List<AugmentationSchema>>> AUGMENTS_COMP = (o1, o2) -> {
  73         final Iterator<QName> thisIt = o1.getKey().getPathFromRoot().iterator();
  74         final Iterator<QName> otherIt = o2.getKey().getPathFromRoot().iterator();
  75
  76         while (thisIt.hasNext()) {
  77             if (!otherIt.hasNext()) {
  78                 return 1;
  79             }
  80
  81             final int comp = thisIt.next().compareTo(otherIt.next());
  82             if (comp != 0) {
  83                 return comp;
  84             }
  85         }
  86
  87         return otherIt.hasNext() ? -1 : 0;
  88     };
  89
  90     private AugmentToGenType() {
  91         throw new UnsupportedOperationException("Utility class");
  92     }
  93
  94     /**
  95      * Converts all <b>augmentation</b> of the module to the list
  96      * <code>Type</code> objects.
  97      *
  98      * @param module
  99      *            module from which is obtained list of all augmentation objects
 100      *            to iterate over them
 101      * @param schemaContext actual schema context
 102      * @param typeProvider actual type provider instance
 103      * @param genCtx generated input context
 104      * @param genTypeBuilders auxiliary type builders map
 105      * @param verboseClassComments verbosity switch
 106      *
 107      * @throws IllegalArgumentException
 108      *             <ul>
 109      *             <li>if the module is null</li>
 110      *             <li>if the name of module is null</li>
 111      *             </ul>
 112      * @throws IllegalStateException
 113      *             if set of augmentations from module is null
 114      */
 115     static Map<Module, ModuleContext> generate(final Module module, final SchemaContext schemaContext,
 116             final TypeProvider typeProvider, final Map<Module, ModuleContext> genCtx,
 117             Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments) {
 118
 119         Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
 120         Preconditions.checkArgument(module.getName() != null, "Module name cannot be NULL.");
 121         Preconditions.checkState(module.getAugmentations() != null, "Augmentations Set cannot be NULL.");
 122
 123         final String basePackageName = BindingMapping.getRootPackageName(module);
 124         final List<AugmentationSchema> augmentations = resolveAugmentations(module);
 125         Map<Module, ModuleContext> resultCtx = genCtx;
 126
 127         //let's group augments by target path
 128         Map<SchemaPath, List<AugmentationSchema>> augmentationsGrouped =
 129                 augmentations.stream().collect(Collectors.groupingBy(AugmentationSchema::getTargetPath));
 130
 131         List<Map.Entry<SchemaPath, List<AugmentationSchema>>> sortedAugmentationsGrouped =
 132                 new ArrayList<>(augmentationsGrouped.entrySet());
 133         Collections.sort(sortedAugmentationsGrouped, AUGMENTS_COMP);
 134
 135         //process child nodes of grouped augment entries
 136         for (Map.Entry<SchemaPath, List<AugmentationSchema>> schemaPathAugmentListEntry : sortedAugmentationsGrouped) {
 137             resultCtx = augmentationToGenTypes(basePackageName, schemaPathAugmentListEntry, module, schemaContext,
 138                     verboseClassComments, resultCtx, genTypeBuilders, typeProvider);
 139
 140             for (AugmentationSchema augSchema : schemaPathAugmentListEntry.getValue()) {
 141                 GenHelperUtil.processUsesAugments(schemaContext, augSchema, module, genCtx,
 142                         genTypeBuilders, verboseClassComments, typeProvider);
 143             }
 144
 145         }
 146
 147         return resultCtx;
 148     }
 149
 150     /**
 151      * Returns list of <code>AugmentationSchema</code> objects. The objects are
 152      * sorted according to the length of their target path from the shortest to
 153      * the longest.
 154      *
 155      * @param module
 156      *            module from which is obtained list of all augmentation objects
 157      * @return list of sorted <code>AugmentationSchema</code> objects obtained
 158      *         from <code>module</code>
 159      * @throws IllegalArgumentException
 160      *             if module is null
 161      * @throws IllegalStateException
 162      *             if set of module augmentations is null
 163      */
 164     private static List<AugmentationSchema> resolveAugmentations(final Module module) {
 165         Preconditions.checkArgument(module != null, "Module reference cannot be NULL.");
 166         Preconditions.checkState(module.getAugmentations() != null, "Augmentations Set cannot be NULL.");
 167
 168         final Set<AugmentationSchema> augmentations = module.getAugmentations();
 169         final List<AugmentationSchema> sortedAugmentations = new ArrayList<>(augmentations);
 170         Collections.sort(sortedAugmentations, AUGMENT_COMP);
 171
 172         return sortedAugmentations;
 173     }
 174
 175     /**
 176      * Converts <code>augSchema</code> to list of <code>Type</code> which
 177      * contains generated type for augmentation. In addition there are also
 178      * generated types for all containers, list and choices which are child of
 179      * <code>augSchema</code> node or a generated types for cases are added if
 180      * augmented node is choice.
 181      *
 182      * @param basePackageName
 183      *            string with the name of the package to which the augmentation
 184      *            belongs
 185      * @param schemaPathAugmentListEntry
 186      *            list of AugmentationSchema nodes grouped by target path
 187      * @param module current module
 188      * @param schemaContext actual schema context
 189      * @param verboseClassComments verbosity switch
 190      * @param genCtx generated input context
 191      * @param genTypeBuilders auxiliary type builders map
 192      * @param typeProvider actual type provider instance
 193      * @throws IllegalArgumentException
 194      *             if <code>augmentPackageName</code> equals null
 195      * @throws IllegalStateException
 196      *             if augment target path is null
 197      * @return generated context
 198      */
 199     private static Map<Module, ModuleContext> augmentationToGenTypes(final String basePackageName,
 200             final Entry<SchemaPath, List<AugmentationSchema>> schemaPathAugmentListEntry, final Module module,
 201             final SchemaContext schemaContext, final boolean verboseClassComments,
 202             Map<Module, ModuleContext> genCtx, Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders,
 203             final TypeProvider typeProvider) {
 204         Preconditions.checkArgument(basePackageName != null, "Package Name cannot be NULL.");
 205         Preconditions.checkArgument(schemaPathAugmentListEntry != null, "Augmentation List Entry cannot be NULL.");
 206         final SchemaPath targetPath = schemaPathAugmentListEntry.getKey();
 207         Preconditions.checkState(targetPath != null,
 208                 "Augmentation List Entry does not contain Target Path (Target Path is NULL).");
 209
 210         final List<AugmentationSchema> augmentationSchemaList = schemaPathAugmentListEntry.getValue();
 211         Preconditions.checkState(augmentationSchemaList.size() > 0,
 212                 "Augmentation List cannot be empty.");
 213
 214         SchemaNode targetSchemaNode = SchemaContextUtil.findDataSchemaNode(schemaContext, targetPath);
 215         if (targetSchemaNode instanceof DataSchemaNode && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
 216             if (targetSchemaNode instanceof DerivableSchemaNode) {
 217                 targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
 218             }
 219             if (targetSchemaNode == null) {
 220                 throw new IllegalStateException("Failed to find target node from grouping in augmentation " +
 221                         schemaPathAugmentListEntry.getValue().get(0)
 222                         + " in module " + module.getName());
 223             }
 224         }
 225         if (targetSchemaNode == null) {
 226             throw new IllegalArgumentException("augment target not found: " + targetPath);
 227         }
 228
 229         GeneratedTypeBuilder targetTypeBuilder = GenHelperUtil.findChildNodeByPath(targetSchemaNode.getPath(),
 230                 genCtx);
 231         if (targetTypeBuilder == null) {
 232             targetTypeBuilder = GenHelperUtil.findCaseByPath(targetSchemaNode.getPath(), genCtx);
 233         }
 234         if (targetTypeBuilder == null) {
 235             throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
 236         }
 237
 238         final String augmentNamespacePackageName =
 239                 BindingGeneratorUtil.packageNameForAugmentedGeneratedType(basePackageName, targetPath);
 240
 241         if (!(targetSchemaNode instanceof ChoiceSchemaNode)) {
 242             genCtx = GenHelperUtil.addRawAugmentGenTypeDefinition(module, augmentNamespacePackageName,
 243                     targetTypeBuilder.toInstance(), schemaPathAugmentListEntry.getValue(), genTypeBuilders, genCtx,
 244                     schemaContext, verboseClassComments, typeProvider);
 245         } else {
 246             genCtx = generateTypesFromAugmentedChoiceCases(schemaContext, module, basePackageName,
 247                     targetTypeBuilder.toInstance(), (ChoiceSchemaNode) targetSchemaNode,
 248                     schemaPathAugmentListEntry.getValue(),
 249                     null, genCtx, verboseClassComments, genTypeBuilders, typeProvider);
 250         }
 251         return genCtx;
 252     }
 253
 254     static Map<Module, ModuleContext> usesAugmentationToGenTypes(final SchemaContext schemaContext,
 255            final String augmentPackageName, final List<AugmentationSchema> schemaPathAugmentListEntry, final Module module,
 256            final UsesNode usesNode, final DataNodeContainer usesNodeParent, Map<Module, ModuleContext> genCtx,
 257            Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final boolean verboseClassComments,
 258            final TypeProvider typeProvider) {
 259
 260         Preconditions.checkArgument(augmentPackageName != null, "Package Name cannot be NULL.");
 261         Preconditions.checkArgument(schemaPathAugmentListEntry != null,
 262                 "Augmentation Schema List Entry cannot be NULL.");
 263         Preconditions.checkState(schemaPathAugmentListEntry.size() > 0,
 264                 "Augmentation Schema List cannot be empty");
 265
 266         final SchemaPath targetPath = schemaPathAugmentListEntry.get(0).getTargetPath();
 267         Preconditions.checkState(targetPath != null,
 268                 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
 269
 270         final SchemaNode targetSchemaNode = findOriginalTargetFromGrouping(schemaContext, targetPath, usesNode);
 271         if (targetSchemaNode == null) {
 272             throw new IllegalArgumentException("augment target not found: " + targetPath);
 273         }
 274
 275         GeneratedTypeBuilder targetTypeBuilder = GenHelperUtil.findChildNodeByPath(targetSchemaNode.getPath(),
 276                 genCtx);
 277         if (targetTypeBuilder == null) {
 278             targetTypeBuilder = GenHelperUtil.findCaseByPath(targetSchemaNode.getPath(), genCtx);
 279         }
 280         if (targetTypeBuilder == null) {
 281             throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
 282         }
 283
 284         if (!(targetSchemaNode instanceof ChoiceSchemaNode)) {
 285             String packageName = augmentPackageName;
 286             if (usesNodeParent instanceof SchemaNode) {
 287                 packageName = BindingGeneratorUtil.packageNameForAugmentedGeneratedType(augmentPackageName,
 288                         ((SchemaNode) usesNodeParent).getPath());
 289             } else if (usesNodeParent instanceof AugmentationSchema) {
 290                 Type parentTypeBuilder = genCtx.get(module).getTargetToAugmentation()
 291                         .get(((AugmentationSchema) usesNodeParent).getTargetPath());
 292                 packageName = BindingGeneratorUtil.packageNameForAugmentedGeneratedType(parentTypeBuilder.getPackageName(),
 293                         (AugmentationSchema)usesNodeParent);
 294             }
 295             genCtx = GenHelperUtil.addRawAugmentGenTypeDefinition(module, packageName,
 296                     targetTypeBuilder.toInstance(), schemaPathAugmentListEntry, genTypeBuilders, genCtx,
 297                     schemaContext, verboseClassComments, typeProvider);
 298             return genCtx;
 299         } else {
 300             genCtx = generateTypesFromAugmentedChoiceCases(schemaContext, module, augmentPackageName,
 301                     targetTypeBuilder.toInstance(), (ChoiceSchemaNode) targetSchemaNode,
 302                     schemaPathAugmentListEntry,
 303                     usesNodeParent, genCtx, verboseClassComments, genTypeBuilders, typeProvider);
 304             return genCtx;
 305         }
 306     }
 307
 308     /**
 309      * Convenient method to find node added by uses statement.
 310      * @param schemaContext
 311      * @param targetPath
 312      *            node path
 313      * @param parentUsesNode
 314      *            parent of uses node
 315      * @return node from its original location in grouping
 316      */
 317     private static DataSchemaNode findOriginalTargetFromGrouping(final SchemaContext schemaContext, final SchemaPath targetPath,
 318                                           final UsesNode parentUsesNode) {
 319         SchemaNode targetGrouping = null;
 320         QName current = parentUsesNode.getGroupingPath().getPathFromRoot().iterator().next();
 321         Module module = schemaContext.findModuleByNamespaceAndRevision(current.getNamespace(), current.getRevision());
 322         if (module == null) {
 323             throw new IllegalArgumentException("Fialed to find module for grouping in: " + parentUsesNode);
 324         } else {
 325             for (GroupingDefinition group : module.getGroupings()) {
 326                 if (group.getQName().equals(current)) {
 327                     targetGrouping = group;
 328                     break;
 329                 }
 330             }
 331         }
 332
 333         if (targetGrouping == null) {
 334             throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
 335         }
 336
 337         SchemaNode result = targetGrouping;
 338         for (final QName node : targetPath.getPathFromRoot()) {
 339             if (result instanceof DataNodeContainer) {
 340                 final QName resultNode = QName.create(result.getQName().getModule(), node.getLocalName());
 341                 result = ((DataNodeContainer) result).getDataChildByName(resultNode);
 342             } else if (result instanceof ChoiceSchemaNode) {
 343                 result = ((ChoiceSchemaNode) result).getCaseNodeByName(node.getLocalName());
 344             }
 345         }
 346         if (result == null) {
 347             return null;
 348         }
 349
 350         if (result instanceof DerivableSchemaNode) {
 351             DerivableSchemaNode castedResult = (DerivableSchemaNode) result;
 352             Optional<? extends SchemaNode> originalNode = castedResult
 353                     .getOriginal();
 354             if (castedResult.isAddedByUses() && originalNode.isPresent()) {
 355                 result = originalNode.get();
 356             }
 357         }
 358
 359         if (result instanceof DataSchemaNode) {
 360             DataSchemaNode resultDataSchemaNode = (DataSchemaNode) result;
 361             if (resultDataSchemaNode.isAddedByUses()) {
 362                 // The original node is required, but we have only the copy of
 363                 // the original node.
 364                 // Maybe this indicates a bug in Yang parser.
 365                 throw new IllegalStateException(
 366                         "Failed to generate code for augment in "
 367                                 + parentUsesNode);
 368             } else {
 369                 return resultDataSchemaNode;
 370             }
 371         } else {
 372             throw new IllegalStateException(
 373                     "Target node of uses-augment statement must be DataSchemaNode. Failed to generate code for augment in "
 374                             + parentUsesNode);
 375         }
 376     }
 377
 378     /**
 379      * Generates list of generated types for all the cases of a choice which are
 380      * added to the choice through the augment.
 381      *
 382      * @param schemaContext
 383      * @param module
 384      *            current module
 385      * @param basePackageName
 386      *            string contains name of package to which augment belongs. If
 387      *            an augmented choice is from an other package (pcg1) than an
 388      *            augmenting choice (pcg2) then case's of the augmenting choice
 389      *            will belong to pcg2.
 390      * @param targetType
 391      *            Type which represents target choice
 392      * @param targetNode
 393      *            node which represents target choice
 394      * @param schemaPathAugmentListEntry
 395      *            list of AugmentationSchema nodes grouped by target path
 396      * @return list of generated types which represents augmented cases of
 397      *         choice <code>refChoiceType</code>
 398      * @throws IllegalArgumentException
 399      *             <ul>
 400      *             <li>if <code>basePackageName</code> is null</li>
 401      *             <li>if <code>targetType</code> is null</li>
 402      *             <li>if <code>augmentedNodes</code> is null</li>
 403      *             </ul>
 404      */
 405     private static Map<Module, ModuleContext> generateTypesFromAugmentedChoiceCases(
 406             final SchemaContext schemaContext, final Module module,
 407             final String basePackageName, final Type targetType, final ChoiceSchemaNode targetNode,
 408             final List<AugmentationSchema> schemaPathAugmentListEntry,
 409             final DataNodeContainer usesNodeParent,
 410             Map<Module, ModuleContext> genCtx, final boolean verboseClassComments,
 411             Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders, final TypeProvider typeProvider) {
 412         Preconditions.checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
 413         Preconditions.checkArgument(targetType != null, "Referenced Choice Type cannot be NULL.");
 414         Preconditions.checkArgument(schemaPathAugmentListEntry != null, "Set of Choice Case Nodes cannot be NULL.");
 415
 416
 417         for (final AugmentationSchema augmentationSchema : schemaPathAugmentListEntry) {
 418             for (final DataSchemaNode caseNode : augmentationSchema.getChildNodes()) {
 419                 if (caseNode != null) {
 420                     final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName,
 421                             caseNode.getPath(), BindingNamespaceType.Data);
 422                     final GeneratedTypeBuilder caseTypeBuilder = GenHelperUtil.addDefaultInterfaceDefinition(packageName,
 423                             caseNode, module, genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
 424                     caseTypeBuilder.addImplementsType(targetType);
 425
 426                     SchemaNode parent;
 427                     final SchemaPath nodeSp = targetNode.getPath();
 428                     parent = SchemaContextUtil.findDataSchemaNode(schemaContext, nodeSp.getParent());
 429
 430                     GeneratedTypeBuilder childOfType = null;
 431                     if (parent instanceof Module) {
 432                         childOfType = genCtx.get(parent).getModuleNode();
 433                     } else if (parent instanceof ChoiceCaseNode) {
 434                         childOfType = GenHelperUtil.findCaseByPath(parent.getPath(), genCtx);
 435                     } else if (parent instanceof DataSchemaNode || parent instanceof NotificationDefinition) {
 436                         childOfType = GenHelperUtil.findChildNodeByPath(parent.getPath(), genCtx);
 437                     } else if (parent instanceof GroupingDefinition) {
 438                         childOfType = GenHelperUtil.findGroupingByPath(parent.getPath(), genCtx);
 439                     }
 440
 441                     if (childOfType == null) {
 442                         throw new IllegalArgumentException("Failed to find parent type of choice " + targetNode);
 443                     }
 444
 445                     ChoiceCaseNode node = null;
 446                     final String caseLocalName = caseNode.getQName().getLocalName();
 447                     if (caseNode instanceof ChoiceCaseNode) {
 448                         node = (ChoiceCaseNode) caseNode;
 449                     } else if (targetNode.getCaseNodeByName(caseLocalName) == null) {
 450                         final String targetNodeLocalName = targetNode.getQName().getLocalName();
 451                         for (DataSchemaNode dataSchemaNode : usesNodeParent.getChildNodes()) {
 452                             if (dataSchemaNode instanceof ChoiceSchemaNode && targetNodeLocalName.equals(dataSchemaNode.getQName
 453                                     ().getLocalName())) {
 454                                 node = ((ChoiceSchemaNode) dataSchemaNode).getCaseNodeByName(caseLocalName);
 455                                 break;
 456                             }
 457                         }
 458                     } else {
 459                         node = targetNode.getCaseNodeByName(caseLocalName);
 460                     }
 461                     final Iterable<DataSchemaNode> childNodes = node.getChildNodes();
 462                     if (childNodes != null) {
 463                         GenHelperUtil.resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType,
 464                                 childNodes, genCtx, schemaContext, verboseClassComments, genTypeBuilders, typeProvider);
 465                     }
 466                     genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
 467                     genCtx.get(module).addChoiceToCaseMapping(targetType, caseTypeBuilder, node);
 468                 }
 469             }
 470         }
 471         return genCtx;
 472     }
 473 }