binding2/mdsal-binding2-generator-util/src/main/java/org/opendaylight/mdsal/binding/javav2/generator/util/JavaIdentifierNormalizer.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 package org.opendaylight.mdsal.binding.javav2.generator.util;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.collect.ArrayListMultimap;
  12 import com.google.common.collect.ImmutableSet;
  13 import com.google.common.collect.ListMultimap;
  14 import java.util.List;
  15 import java.util.Set;
  16 import org.opendaylight.mdsal.binding.javav2.model.api.Enumeration;
  17 import org.opendaylight.mdsal.binding.javav2.model.api.Enumeration.Pair;
  18 import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
  19
  20 /**
  21  * This util class converts every non-java char in identifier to java char by
  22  * its unicode name (<a href=
  23  * "http://docs.oracle.com/javase/specs/jls/se8/html/jls-3.html#jls-3.8">JAVA SE
  24  * SPECIFICATIONS - Identifiers</a>). There are special types of mapping
  25  * non-java chars to original identifiers according to specific
  26  * {@linkplain JavaIdentifier java type}:
  27  * <ul>
  28  * <li>class, enum, interface</li>
  29  * <li>
  30  * <ul>
  31  * <li>without special separator</li>
  32  * <li>the first character of identifier, any other first character of
  33  * identifier part mapped by non-Java char name from unicode and char in
  34  * identifier behind non-java char name are converting to upper case</li>
  35  * <li>examples:</li>
  36  * <li>
  37  * <ul>
  38  * <li>example* - ExampleAsterisk</li>
  39  * <li>example*example - ExampleAserisksExample</li>
  40  * <li>\example - ReverseSolidusExample</li>
  41  * <li>1example - DigitOneExample</li>
  42  * <li>example1 - Example1</li>
  43  * <li>int - IntReservedKeyword</li>
  44  * <li>con - ConReservedKeyword</li>
  45  * </ul>
  46  * </li>
  47  * </ul>
  48  * </li>
  49  * <li>enum value, constant</li>
  50  * <li>
  51  * <ul>
  52  * <li>used underscore as special separator</li>
  53  * <li>converted identifier to upper case</li>
  54  * <li>examples:</li>
  55  * <li>
  56  * <ul>
  57  * <li>example* - EXAMPLE_ASTERISK</li>
  58  * <li>example*example - EXAMPLE_ASTERISK_EXAMPLE</li>
  59  * <li>\example - REVERSE_SOLIDUS_EXAMPLE</li>
  60  * <li>1example - DIGIT_ONE_EXAMPLE</li>
  61  * <li>example1 - EXAMPLE1</li>
  62  * <li>int - INT_RESERVED_KEYWORD</li>
  63  * <li>con - CON_RESERVED_KEYWORD</li>
  64  * </ul>
  65  * </li>
  66  * </ul>
  67  * </li>
  68  * <li>method, variable</li>
  69  * <li>
  70  * <li>
  71  * <ul>
  72  * <li>without special separator</li>
  73  * <li>the first character of identifier is converting to lower case</li>
  74  * <li>any other first character of identifier part mapped by non-Java char name
  75  * from unicode and char in identifier behind non-java char name are converting
  76  * to upper case</li>
  77  * <li>examples:</li>
  78  * <li>
  79  * <ul>
  80  * <li>example* - exampleAsterisk</li>
  81  * <li>example*example - exampleAserisksExample</li>
  82  * <li>\example - reverseSolidusExample</li>
  83  * <li>1example - digitOneExample</li>
  84  * <li>example1 - example1</li>
  85  * <li>int - intReservedKeyword</li>
  86  * <li>con - conReservedKeyword</li>
  87  * </ul>
  88  * </li>
  89  * </ul>
  90  * </li>
  91  * <li>package - full package name (<a href=
  92  * "https://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html">
  93  * Naming a package</a>)</li>
  94  * <li>
  95  * <li>
  96  * <ul>
  97  * <li>parts of package name are separated by dots</li>
  98  * <li>parts of package name are converting to lower case</li>
  99  * <li>if parts of package name are reserved Java or Windows keywords, such as
 100  * 'int' the suggested convention is to add an underscore to keyword</li>
 101  * <li>dash is parsed as underscore according to <a href=
 102  * "https://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html">
 103  * Naming a package</a></li>
 104  * <li>examples:</li>
 105  * <li>
 106  * <ul>
 107  * <li>org.example* - org.exampleasterisk</li>
 108  * <li>org.example*example - org.exampleasteriskexample</li>
 109  * <li>org.\example - org.reversesolidusexample</li>
 110  * <li>org.1example - org.digitoneexample</li>
 111  * <li>org.example1 - org.example1</li>
 112  * <li>org.int - org.int_</li>
 113  * <li>org.con - org.con_</li>
 114  * <li>org.foo-cont - org.foo_cont</li>
 115  * </ul>
 116  * </li>
 117  * </ul>
 118  * </li>
 119  * </ul>
 120  *
 121  * There is special case in CLASS, INTERFACE, ENUM, ENUM VALUE, CONSTANT, METHOD
 122  * and VARIABLE if identifier contains single dash - then the converter ignores
 123  * the single dash in the way of the non-java chars. In other way, if dash is
 124  * the first or the last char in the identifier or there is more dashes in a row
 125  * in the identifier, then these dashes are converted as non-java chars.
 126  * Example:
 127  * <ul>
 128  * <li>class, enum, interface</li>
 129  * <li>
 130  * <ul>
 131  * <li>foo-cont - FooCont</li>
 132  * <li>foo--cont - FooHyphenMinusHyphenMinusCont</li>
 133  * <li>-foo - HyphenMinusFoo</li>
 134  * <li>foo- - FooHyphenMinus</li>
 135  * </ul>
 136  * </li>
 137  * <li>enum value, constant
 138  * <li>
 139  * <ul>
 140  * <li>foo-cont - FOO_CONT</li>
 141  * <li>foo--cont - FOO_HYPHEN_MINUS_HYPHEN_MINUS_CONT</li>
 142  * <li>-foo - HYPHEN_MINUS_FOO</li>
 143  * <li>foo- - FOO_HYPHEN_MINUS</li>
 144  * </ul>
 145  * </li>
 146  * <li>method, variable</li>
 147  * <li>
 148  * <ul>
 149  * <li>foo-cont - fooCont</li>
 150  * <li>foo--cont - fooHyphenMinusHyphenMinusCont</li>
 151  * <li>-foo - hyphenMinusFoo</li>
 152  * <li>foo- - fooHyphenMinus</li>
 153  * </ul>
 154  * </li>
 155  * </ul>
 156  *
 157  * Next special case talks about normalizing class name which already exists in
 158  * package - but with different camel cases (foo, Foo, fOo, ...). To every next
 159  * classes with same names will by added their actual rank (serial number),
 160  * except the first one. This working for CLASS, ENUM and INTEFACE java
 161  * identifiers. If there exist the same ENUM VALUES in ENUM (with different
 162  * camel cases), then it's parsed with same logic like CLASSES, ENUMS and
 163  * INTERFACES but according to list of pairs of their ENUM parent. Example:
 164  *
 165  * <ul>
 166  * <li>class, enum, interface</li>
 167  * <li>
 168  * <ul>
 169  * <li>package name org.example, class (or interface or enum) Foo - normalized
 170  * to Foo
 171  * <li>package name org.example, class (or interface or enum) fOo - normalized
 172  * to Foo1
 173  * </ul>
 174  * </li>
 175  * <li>enum value</li>
 176  * <li>
 177  * <ul>
 178  * <li>
 179  *
 180  * <pre>
 181  * type enumeration {
 182  *     enum foo;
 183  *     enum Foo;
 184  * }
 185  * </pre>
 186  *
 187  * </li>
 188  * <li>YANG enum values will be mapped to 'FOO' and 'FOO_1' Java enum
 189  * values.</li>
 190  * </ul>
 191  * </li>
 192  * </ul>
 193  */
 194 @Beta
 195 public final class JavaIdentifierNormalizer {
 196
 197     private static final int FIRST_CHAR = 0;
 198     private static final int FIRST_INDEX = 1;
 199     private static final char UNDERSCORE = '_';
 200     private static final char DASH = '-';
 201     private static final String EMPTY_STRING = "";
 202     private static final String RESERVED_KEYWORD = "reserved_keyword";
 203     private static final ListMultimap<String, String> PACKAGES_MAP = ArrayListMultimap.create();
 204     public static final Set<String> SPECIAL_RESERVED_PATHS =
 205             ImmutableSet.of("org.opendaylight.yangtools.yang.model","org.opendaylight.yangtools.concepts","org.opendaylight.yangtools.yang.common",
 206                     "org.opendaylight.mdsal.binding.javav2.spec","java", "com");
 207
 208     private JavaIdentifierNormalizer() {
 209         throw new UnsupportedOperationException("Util class");
 210     }
 211
 212     /**
 213      * <p>
 214      * According to <a href="https://tools.ietf.org/html/rfc7950#section-9.6.4">YANG RFC 7950</a>,
 215      * all assigned names in an enumeration MUST be unique. Created names are contained in the list
 216      * of {@link Enumeration.Pair}. This method adds actual index with underscore behind name of new
 217      * enum value only if this name already exists in one of the list of {@link Enumeration.Pair}.
 218      * Then, the name will be converted to java chars according to {@link JavaIdentifier#ENUM_VALUE}
 219      * and returned.
 220      * </p>
 221      * Example:
 222      *
 223      * <pre>
 224      * type enumeration {
 225      *     enum foo;
 226      *     enum Foo;
 227      * }
 228      * </pre>
 229      *
 230      * YANG enum values will be mapped to 'FOO' and 'FOO_1' Java enum values.
 231      *
 232      * @param name
 233      *            - name of new enum value
 234      * @param values
 235      *            - list of all actual enum values
 236      * @return converted and fixed name of new enum value
 237      */
 238     public static String normalizeEnumValueIdentifier(final String name, final List<Pair> values) {
 239         return convertIdentifierEnumValue(name, name, values, FIRST_INDEX);
 240     }
 241
 242     /**
 243      * Normalizing full package name by non java chars and reserved keywords.
 244      *
 245      * @param fullPackageName
 246      *            - full package name
 247      * @return normalized name
 248      */
 249     public static String normalizeFullPackageName(final String fullPackageName) {
 250         final String[] packageNameParts = fullPackageName.split("\\.");
 251         final StringBuilder sb = new StringBuilder();
 252         for (int i = 0; i < packageNameParts.length; i++) {
 253             sb.append(normalizePartialPackageName(packageNameParts[i]));
 254             if (i != (packageNameParts.length - 1)) {
 255                 sb.append(".");
 256             }
 257         }
 258         return sb.toString();
 259     }
 260
 261     /**
 262      * Normalizing part of package name by non java chars.
 263      *
 264      * @param packageNamePart
 265      *            - part of package name
 266      * @return normalized name
 267      */
 268     public static String normalizePartialPackageName(final String packageNamePart) {
 269         // if part of package name consist from java or windows reserved word, return it with
 270         // underscore at the end and in lower case
 271         if (BindingMapping.JAVA_RESERVED_WORDS.contains(packageNamePart.toLowerCase())
 272                 || BindingMapping.WINDOWS_RESERVED_WORDS.contains(packageNamePart.toUpperCase())) {
 273             return new StringBuilder(packageNamePart).append(UNDERSCORE).toString().toLowerCase();
 274         }
 275         String normalizedPackageNamePart = packageNamePart;
 276         if (packageNamePart.contains(String.valueOf(DASH))) {
 277             normalizedPackageNamePart = packageNamePart.replaceAll(String.valueOf(DASH), String.valueOf(UNDERSCORE));
 278         }
 279         final StringBuilder sb = new StringBuilder();
 280         StringBuilder innserSb = new StringBuilder();
 281         for (int i = 0; i < normalizedPackageNamePart.length(); i++) {
 282             if (normalizedPackageNamePart.charAt(i) == UNDERSCORE) {
 283                 if (!innserSb.toString().isEmpty()) {
 284                     sb.append(normalizeSpecificIdentifier(innserSb.toString(), JavaIdentifier.PACKAGE));
 285                     innserSb = new StringBuilder();
 286                 }
 287                 sb.append(UNDERSCORE);
 288             } else {
 289                 innserSb.append(normalizedPackageNamePart.charAt(i));
 290             }
 291         }
 292         if (!innserSb.toString().isEmpty()) {
 293             sb.append(normalizeSpecificIdentifier(innserSb.toString(), JavaIdentifier.PACKAGE));
 294         }
 295         // returned normalized part of package name
 296         return sb.toString();
 297     }
 298
 299     /**
 300      * Find and convert non Java chars in identifiers of generated transfer objects, initially
 301      * derived from corresponding YANG according to
 302      * <a href="http://docs.oracle.com/javase/specs/jls/se8/html/jls-3.html#jls-3.8"> Java
 303      * Specifications - Identifiers</a>. If there is more same class names at the same package, then
 304      * append rank (serial number) to the end of them. Works for class, enum, interface.
 305      *
 306      * @param packageName
 307      *            - package of identifier
 308      * @param className
 309      *            - name of identifier
 310      * @return - java acceptable identifier
 311      */
 312     public static String normalizeClassIdentifier(final String packageName, final String className) {
 313         for (final String reservedPath : SPECIAL_RESERVED_PATHS) {
 314             if (packageName.startsWith(reservedPath)) {
 315                 return className;
 316             }
 317         }
 318         final String convertedClassName = normalizeSpecificIdentifier(className, JavaIdentifier.CLASS);
 319         return normalizeClassIdentifier(packageName, convertedClassName, convertedClassName, FIRST_INDEX);
 320     }
 321
 322     /**
 323      * Find and convert non Java chars in identifiers of generated transfer objects, initially
 324      * derived from corresponding YANG.
 325      *
 326      * @param identifier
 327      *            - name of identifier
 328      * @param javaIdentifier
 329      *            - java type of identifier
 330      * @return - java acceptable identifier
 331      */
 332     public static String normalizeSpecificIdentifier(final String identifier, final JavaIdentifier javaIdentifier) {
 333         final StringBuilder sb = new StringBuilder();
 334
 335         // if identifier isn't PACKAGE type then check it by reserved keywords
 336         if(javaIdentifier != JavaIdentifier.PACKAGE) {
 337             if (BindingMapping.JAVA_RESERVED_WORDS.contains(identifier.toLowerCase())
 338                     || BindingMapping.WINDOWS_RESERVED_WORDS.contains(identifier.toUpperCase())) {
 339                 return fixCasesByJavaType(
 340                         sb.append(identifier).append(UNDERSCORE).append(RESERVED_KEYWORD).toString().toLowerCase(),
 341                         javaIdentifier);
 342             }
 343         }
 344
 345         // check and convert first char in identifier if there is non-java char
 346         final char firstChar = identifier.charAt(FIRST_CHAR);
 347         if (!Character.isJavaIdentifierStart(firstChar)) {
 348             // converting first char of identifier
 349             sb.append(convertFirst(firstChar, existNext(identifier, FIRST_CHAR)));
 350         } else {
 351             sb.append(firstChar);
 352         }
 353         // check and convert other chars in identifier, if there is non-java char
 354         for (int i = 1; i < identifier.length(); i++) {
 355             final char actualChar = identifier.charAt(i);
 356             // ignore single dash as non java char - if there is more dashes in a row or dash is as
 357             // the last char in identifier then parse these dashes as non java chars
 358             if ((actualChar == '-') && existNext(identifier, i)) {
 359                 if ((identifier.charAt(i - 1) != DASH) && (identifier.charAt(i + 1) != DASH)) {
 360                     sb.append(UNDERSCORE);
 361                     continue;
 362                 }
 363             }
 364             if (!Character.isJavaIdentifierPart(actualChar)) {
 365                 // prepare actual string of sb for checking if underscore exist on position of the
 366                 // last char
 367                 final String partialConvertedIdentifier = sb.toString();
 368                 sb.append(convert(actualChar, existNext(identifier, i),
 369                         partialConvertedIdentifier.charAt(partialConvertedIdentifier.length() - 1)));
 370             } else {
 371                 sb.append(actualChar);
 372             }
 373         }
 374         // apply camel case in appropriate way
 375         return fixCasesByJavaType(sb.toString().replace("__", "_").toLowerCase(), javaIdentifier);
 376     }
 377
 378     /**
 379      * Checking while there doesn't exist any class name with the same name
 380      * (regardless of camel cases) in package.
 381      *
 382      * @param packageName
 383      *            - package of class name
 384      * @param origClassName
 385      *            - original class name
 386      * @param actualClassName
 387      *            - actual class name with rank (serial number)
 388      * @param rank
 389      *            - actual rank (serial number)
 390      * @return converted identifier
 391      */
 392     private static String normalizeClassIdentifier(final String packageName, final String origClassName,
 393             final String actualClassName, final int rank) {
 394         if (PACKAGES_MAP.containsKey(packageName)) {
 395             for (final String existingName : PACKAGES_MAP.get(packageName)) {
 396                 if (existingName.toLowerCase().equals(actualClassName.toLowerCase())) {
 397                     final int nextRank = rank + 1;
 398                     return normalizeClassIdentifier(packageName, origClassName,
 399                             new StringBuilder(origClassName).append(rank).toString(), nextRank);
 400                 }
 401             }
 402         }
 403         PACKAGES_MAP.put(packageName, actualClassName);
 404         return actualClassName;
 405     }
 406
 407     /**
 408      * Fix cases of converted identifiers by Java type
 409      *
 410      * @param string
 411      *            - converted identifier
 412      * @param javaIdentifier
 413      *            - java type of identifier
 414      * @return converted identifier with right cases according to java type
 415      */
 416     private static String fixCasesByJavaType(final String convertedIdentifier, final JavaIdentifier javaIdentifier) {
 417         switch (javaIdentifier) {
 418             case CLASS:
 419             case ENUM:
 420             case INTERFACE:
 421                 return capitalize(fixCases(convertedIdentifier));
 422             case ENUM_VALUE:
 423             case CONSTANT:
 424                 return convertedIdentifier.toUpperCase();
 425             case METHOD:
 426             case VARIABLE:
 427                 return fixCases(convertedIdentifier);
 428             case PACKAGE:
 429                 return convertedIdentifier.replaceAll(String.valueOf(UNDERSCORE), EMPTY_STRING);
 430             default:
 431                 throw new IllegalArgumentException("Unknown java type of identifier : " + javaIdentifier.toString());
 432         }
 433     }
 434
 435     /**
 436      * Delete unnecessary chars in converted identifier and apply camel case in appropriate way.
 437      *
 438      * @param convertedIdentifier
 439      *            - original converted identifier
 440      * @return resolved identifier
 441      */
 442     private static String fixCases(final String convertedIdentifier) {
 443         final StringBuilder sb = new StringBuilder();
 444         if (convertedIdentifier.contains(String.valueOf(UNDERSCORE))) {
 445             boolean isFirst = true;
 446             for (final String part : convertedIdentifier.split(String.valueOf(UNDERSCORE))) {
 447                 if (isFirst) {
 448                     isFirst = false;
 449                     sb.append(part);
 450                 } else {
 451                     sb.append(capitalize(part));
 452                 }
 453             }
 454         } else {
 455             sb.append(convertedIdentifier);
 456         }
 457         return sb.toString();
 458     }
 459
 460     /**
 461      * Check if there exist next char in identifier behind actual char position
 462      *
 463      * @param identifier
 464      *            - original identifier
 465      * @param actual
 466      *            - actual char position
 467      * @return true if there is another char, false otherwise
 468      */
 469     private static boolean existNext(final String identifier, final int actual) {
 470       return (identifier.length() - 1) < (actual + 1) ? false : true;
 471     }
 472
 473     /**
 474      * Converting first char of identifier. This happen only if this char is
 475      * non-java char
 476      *
 477      * @param c
 478      *            - first char
 479      * @param existNext
 480      *            - existing of next char behind actual char
 481      * @return converted char
 482      */
 483     private static String convertFirst(final char c, final boolean existNext) {
 484         String name = Character.getName(c);
 485         if (name.contains(String.valueOf(DASH))) {
 486             name = name.replaceAll(String.valueOf(DASH), String.valueOf(UNDERSCORE));
 487         }
 488         name = existNext ? (name + "_") : name;
 489         return name.contains(" ") ? name.replaceAll(" ", "_") : name;
 490     }
 491
 492     /**
 493      * Converting any char in java identifier, This happen only if this char is
 494      * non-java char
 495      *
 496      * @param c
 497      *            - actual char
 498      * @param existNext
 499      *            - existing of next char behind actual char
 500      * @param partialLastChar
 501      *            - last char of partial converted identifier
 502      * @return converted char
 503      */
 504     private static String convert(final char c, final boolean existNext, final char partialLastChar) {
 505         return partialLastChar == '_' ? convertFirst(c, existNext) : "_" + convertFirst(c, existNext);
 506     }
 507
 508     /**
 509      * Capitalize input string
 510      *
 511      * @param identifier
 512      *            - string to be capitalized
 513      */
 514     private static String capitalize(final String identifier) {
 515         return identifier.substring(FIRST_CHAR, FIRST_CHAR + 1).toUpperCase() + identifier.substring(1);
 516     }
 517
 518     private static String convertIdentifierEnumValue(final String name, final String origName, final List<Pair> values,
 519             final int rank) {
 520         String newName = name;
 521         for (final Pair pair : values) {
 522             if (pair.getName().toLowerCase().equals(name.toLowerCase())
 523                     || pair.getMappedName().toLowerCase().equals(name.toLowerCase())) {
 524                 int actualRank = rank;
 525                 final StringBuilder actualNameBuilder =
 526                         new StringBuilder(origName).append(UNDERSCORE).append(actualRank);
 527                 newName = convertIdentifierEnumValue(actualNameBuilder.toString(), origName, values, ++actualRank);
 528             }
 529         }
 530         return normalizeSpecificIdentifier(newName, JavaIdentifier.ENUM_VALUE);
 531     }
 532 }