binding/mdsal-binding-spec-util/src/main/java/org/opendaylight/mdsal/binding/spec/naming/BindingMapping.java

   1 /*
   2  * Copyright (c) 2013 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.spec.naming;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.base.CharMatcher;
  14 import com.google.common.base.Splitter;
  15 import com.google.common.collect.BiMap;
  16 import com.google.common.collect.HashBiMap;
  17 import com.google.common.collect.ImmutableSet;
  18 import com.google.common.collect.Interner;
  19 import com.google.common.collect.Interners;
  20 import java.util.Collection;
  21 import java.util.Locale;
  22 import java.util.Optional;
  23 import java.util.regex.Matcher;
  24 import java.util.regex.Pattern;
  25 import org.eclipse.jdt.annotation.NonNull;
  26 import org.opendaylight.yangtools.yang.binding.Augmentable;
  27 import org.opendaylight.yangtools.yang.binding.DataContainer;
  28 import org.opendaylight.yangtools.yang.binding.Identifiable;
  29 import org.opendaylight.yangtools.yang.binding.ScalarTypeObject;
  30 import org.opendaylight.yangtools.yang.common.QName;
  31 import org.opendaylight.yangtools.yang.common.QNameModule;
  32 import org.opendaylight.yangtools.yang.common.Revision;
  33
  34 @Beta
  35 public final class BindingMapping {
  36
  37     public static final @NonNull String VERSION = "0.6";
  38
  39     public static final ImmutableSet<String> JAVA_RESERVED_WORDS = ImmutableSet.of(
  40         // https://docs.oracle.com/javase/specs/jls/se9/html/jls-3.html#jls-3.9
  41         "abstract", "assert", "boolean", "break", "byte", "case", "catch", "char", "class", "const", "continue",
  42         "default", "do", "double", "else", "enum", "extends", "final", "finally", "float", "for", "goto", "if",
  43         "implements", "import", "instanceof", "int", "interface", "long", "native", "new", "package", "private",
  44         "protected", "public", "return", "short", "static", "strictfp", "super", "switch", "synchronized", "this",
  45         "throw", "throws", "transient", "try", "void", "volatile", "while", "_",
  46         // https://docs.oracle.com/javase/specs/jls/se9/html/jls-3.html#jls-3.10.3
  47         "false", "true",
  48         // https://docs.oracle.com/javase/specs/jls/se9/html/jls-3.html#jls-3.10.7
  49         "null");
  50
  51     public static final @NonNull String DATA_ROOT_SUFFIX = "Data";
  52     public static final @NonNull String RPC_SERVICE_SUFFIX = "Service";
  53     public static final @NonNull String NOTIFICATION_LISTENER_SUFFIX = "Listener";
  54     public static final @NonNull String QNAME_STATIC_FIELD_NAME = "QNAME";
  55     public static final @NonNull String PACKAGE_PREFIX = "org.opendaylight.yang.gen.v1";
  56     public static final @NonNull String AUGMENTATION_FIELD = "augmentation";
  57
  58     private static final Splitter CAMEL_SPLITTER = Splitter.on(CharMatcher.anyOf(" _.-/").precomputed())
  59             .omitEmptyStrings().trimResults();
  60     private static final Pattern COLON_SLASH_SLASH = Pattern.compile("://", Pattern.LITERAL);
  61     private static final String QUOTED_DOT = Matcher.quoteReplacement(".");
  62     private static final Splitter DOT_SPLITTER = Splitter.on('.');
  63
  64     public static final @NonNull String MODULE_INFO_CLASS_NAME = "$YangModuleInfoImpl";
  65     public static final @NonNull String MODULE_INFO_QNAMEOF_METHOD_NAME = "qnameOf";
  66     public static final @NonNull String MODEL_BINDING_PROVIDER_CLASS_NAME = "$YangModelBindingProvider";
  67
  68     /**
  69      * Name of {@link Augmentable#augmentation(Class)}.
  70      */
  71     public static final @NonNull String AUGMENTABLE_AUGMENTATION_NAME = "augmentation";
  72
  73     /**
  74      * Name of {@link Identifiable#key()}.
  75      */
  76     public static final @NonNull String IDENTIFIABLE_KEY_NAME = "key";
  77
  78     /**
  79      * Name of {@link DataContainer#implementedInterface()}.
  80      */
  81     public static final @NonNull String DATA_CONTAINER_IMPLEMENTED_INTERFACE_NAME = "implementedInterface";
  82
  83     /**
  84      * Name of default {@link Object#hashCode()} implementation for instantiated DataObjects. Each such generated
  85      * interface contains this static method.
  86      */
  87     public static final @NonNull String BINDING_HASHCODE_NAME = "bindingHashCode";
  88
  89     /**
  90      * Name of default {@link Object#equals(Object)} implementation for instantiated DataObjects. Each such generated
  91      * interface contains this static method.
  92      */
  93     public static final @NonNull String BINDING_EQUALS_NAME = "bindingEquals";
  94
  95     /**
  96      * Name of default {@link Object#toString()} implementation for instantiated DataObjects. Each such generated
  97      * interface contains this static method.
  98      */
  99     public static final @NonNull String BINDING_TO_STRING_NAME = "bindingToString";
 100
 101     /**
 102      * Name of {@link ScalarTypeObject#getValue()}.
 103      */
 104     public static final @NonNull String SCALAR_TYPE_OBJECT_GET_VALUE_NAME = "getValue";
 105
 106     /**
 107      * Prefix for getter methods working on top of boolean.
 108      */
 109     public static final @NonNull String BOOLEAN_GETTER_PREFIX = "is";
 110
 111     /**
 112      * Prefix for normal getter methods.
 113      */
 114     public static final @NonNull String GETTER_PREFIX = "get";
 115
 116     /**
 117      * Prefix for non-null default wrapper methods. These methods always wrap a corresponding normal getter.
 118      */
 119     public static final @NonNull String NONNULL_PREFIX = "nonnull";
 120
 121     public static final @NonNull String RPC_INPUT_SUFFIX = "Input";
 122     public static final @NonNull String RPC_OUTPUT_SUFFIX = "Output";
 123
 124     private static final Interner<String> PACKAGE_INTERNER = Interners.newWeakInterner();
 125
 126     private BindingMapping() {
 127         // Hidden on purpose
 128     }
 129
 130     public static @NonNull String getRootPackageName(final QName module) {
 131         return getRootPackageName(module.getModule());
 132     }
 133
 134     public static @NonNull String getRootPackageName(final QNameModule module) {
 135         final StringBuilder packageNameBuilder = new StringBuilder().append(BindingMapping.PACKAGE_PREFIX).append('.');
 136
 137         String namespace = module.getNamespace().toString();
 138         namespace = COLON_SLASH_SLASH.matcher(namespace).replaceAll(QUOTED_DOT);
 139
 140         final char[] chars = namespace.toCharArray();
 141         for (int i = 0; i < chars.length; ++i) {
 142             switch (chars[i]) {
 143                 case '/':
 144                 case ':':
 145                 case '-':
 146                 case '@':
 147                 case '$':
 148                 case '#':
 149                 case '\'':
 150                 case '*':
 151                 case '+':
 152                 case ',':
 153                 case ';':
 154                 case '=':
 155                     chars[i] = '.';
 156                     break;
 157                 default:
 158                     // no-op
 159             }
 160         }
 161
 162         packageNameBuilder.append(chars);
 163         if (chars[chars.length - 1] != '.') {
 164             packageNameBuilder.append('.');
 165         }
 166
 167         final Optional<Revision> optRev = module.getRevision();
 168         if (optRev.isPresent()) {
 169             // Revision is in format 2017-10-26, we want the output to be 171026, which is a matter of picking the
 170             // right characters.
 171             final String rev = optRev.get().toString();
 172             checkArgument(rev.length() == 10, "Unsupported revision %s", rev);
 173             packageNameBuilder.append("rev").append(rev, 2, 4).append(rev, 5, 7).append(rev.substring(8));
 174         } else {
 175             // No-revision packages are special
 176             packageNameBuilder.append("norev");
 177         }
 178
 179         return normalizePackageName(packageNameBuilder.toString());
 180     }
 181
 182     public static @NonNull String normalizePackageName(final String packageName) {
 183         final StringBuilder builder = new StringBuilder();
 184         boolean first = true;
 185
 186         for (String p : DOT_SPLITTER.split(packageName.toLowerCase(Locale.ENGLISH))) {
 187             if (first) {
 188                 first = false;
 189             } else {
 190                 builder.append('.');
 191             }
 192
 193             if (Character.isDigit(p.charAt(0)) || BindingMapping.JAVA_RESERVED_WORDS.contains(p)) {
 194                 builder.append('_');
 195             }
 196             builder.append(p);
 197         }
 198
 199         // Prevent duplication of input string
 200         return PACKAGE_INTERNER.intern(builder.toString());
 201     }
 202
 203     public static @NonNull String getClassName(final String localName) {
 204         return toFirstUpper(toCamelCase(localName));
 205     }
 206
 207     public static @NonNull String getClassName(final QName name) {
 208         return toFirstUpper(toCamelCase(name.getLocalName()));
 209     }
 210
 211     public static @NonNull String getMethodName(final String yangIdentifier) {
 212         return toFirstLower(toCamelCase(yangIdentifier));
 213     }
 214
 215     public static @NonNull String getMethodName(final QName name) {
 216         return getMethodName(name.getLocalName());
 217     }
 218
 219     public static @NonNull String getGetterPrefix(final boolean isBoolean) {
 220         return isBoolean ? BOOLEAN_GETTER_PREFIX : GETTER_PREFIX;
 221     }
 222
 223     public static @NonNull String getGetterMethodName(final String localName, final boolean isBoolean) {
 224         return getGetterPrefix(isBoolean) + toFirstUpper(getPropertyName(localName));
 225     }
 226
 227     public static @NonNull String getGetterMethodName(final QName name, final boolean isBoolean) {
 228         return getGetterPrefix(isBoolean) + getGetterSuffix(name);
 229     }
 230
 231     public static boolean isGetterMethodName(final String methodName) {
 232         return methodName.startsWith(GETTER_PREFIX) || methodName.startsWith(BOOLEAN_GETTER_PREFIX);
 233     }
 234
 235     public static @NonNull String getGetterMethodForNonnull(final String methodName) {
 236         checkArgument(isNonnullMethodName(methodName));
 237         return GETTER_PREFIX + methodName.substring(NONNULL_PREFIX.length());
 238     }
 239
 240     public static @NonNull String getNonnullMethodName(final String localName) {
 241         return NONNULL_PREFIX + toFirstUpper(getPropertyName(localName));
 242     }
 243
 244     public static boolean isNonnullMethodName(final String methodName) {
 245         return methodName.startsWith(NONNULL_PREFIX);
 246     }
 247
 248     public static @NonNull String getGetterSuffix(final QName name) {
 249         final String candidate = toFirstUpper(toCamelCase(name.getLocalName()));
 250         return "Class".equals(candidate) ? "XmlClass" : candidate;
 251     }
 252
 253     public static @NonNull String getPropertyName(final String yangIdentifier) {
 254         final String potential = toFirstLower(toCamelCase(yangIdentifier));
 255         if ("class".equals(potential)) {
 256             return "xmlClass";
 257         }
 258         return potential;
 259     }
 260
 261     private static @NonNull String toCamelCase(final String rawString) {
 262         StringBuilder builder = new StringBuilder();
 263         for (String comp : CAMEL_SPLITTER.split(rawString)) {
 264             builder.append(toFirstUpper(comp));
 265         }
 266         return checkNumericPrefix(builder.toString());
 267     }
 268
 269     private static @NonNull String checkNumericPrefix(final String rawString) {
 270         if (rawString.isEmpty()) {
 271             return rawString;
 272         }
 273         final char firstChar = rawString.charAt(0);
 274         return firstChar >= '0' && firstChar <= '9' ? "_" + rawString : rawString;
 275     }
 276
 277     /**
 278      * Returns the {@link String} {@code s} with an {@link Character#isUpperCase(char) upper case} first character.
 279      *
 280      * @param str the string that should get an upper case first character.
 281      * @return the {@link String} {@code str} with an upper case first character.
 282      */
 283     private static @NonNull String toFirstUpper(final @NonNull String str) {
 284         if (str.isEmpty()) {
 285             return str;
 286         }
 287         if (Character.isUpperCase(str.charAt(0))) {
 288             return str;
 289         }
 290         if (str.length() == 1) {
 291             return str.toUpperCase(Locale.ENGLISH);
 292         }
 293         return str.substring(0, 1).toUpperCase(Locale.ENGLISH) + str.substring(1);
 294     }
 295
 296     /**
 297      * Returns the {@link String} {@code s} with a {@link Character#isLowerCase(char) lower case} first character. This
 298      * function is null-safe.
 299      *
 300      * @param str the string that should get an lower case first character. May be <code>null</code>.
 301      * @return the {@link String} {@code str} with an lower case first character or <code>null</code> if the input
 302      *         {@link String} {@code str} was empty.
 303      */
 304     private static @NonNull String toFirstLower(final @NonNull String str) {
 305         if (str.isEmpty()) {
 306             return str;
 307         }
 308         if (Character.isLowerCase(str.charAt(0))) {
 309             return str;
 310         }
 311         if (str.length() == 1) {
 312             return str.toLowerCase(Locale.ENGLISH);
 313         }
 314         return str.substring(0, 1).toLowerCase(Locale.ENGLISH) + str.substring(1);
 315     }
 316
 317     /**
 318      * Returns the {@link String} {@code s} with a '$' character as suffix.
 319      *
 320      * @param qname RPC QName
 321      * @return The RPC method name as determined by considering the localname against the JLS.
 322      * @throws NullPointerException if {@code qname} is null
 323      */
 324     public static @NonNull String getRpcMethodName(final @NonNull QName qname) {
 325         final String methodName = getMethodName(qname);
 326         return JAVA_RESERVED_WORDS.contains(methodName) ? methodName + "$" : methodName;
 327     }
 328
 329     /**
 330      * Returns Java identifiers, conforming to JLS9 Section 3.8 to use for specified YANG assigned names
 331      * (RFC7950 Section 9.6.4). This method considers two distinct encodings: one the pre-Fluorine mapping, which is
 332      * okay and convenient for sane strings, and an escaping-based bijective mapping which works for all possible
 333      * Unicode strings.
 334      *
 335      * @param assignedNames Collection of assigned names
 336      * @return A BiMap keyed by assigned name, with Java identifiers as values
 337      * @throws NullPointerException if assignedNames is null or contains null items
 338      * @throws IllegalArgumentException if any of the names is empty
 339      */
 340     public static BiMap<String, String> mapEnumAssignedNames(final Collection<String> assignedNames) {
 341         /*
 342          * Original mapping assumed strings encountered are identifiers, hence it used getClassName to map the names
 343          * and that function is not an injection -- this is evidenced in MDSAL-208 and results in a failure to compile
 344          * generated code. If we encounter such a conflict or if the result is not a valid identifier (like '*'), we
 345          * abort and switch the mapping schema to mapEnumAssignedName(), which is a bijection.
 346          *
 347          * Note that assignedNames can contain duplicates, which must not trigger a duplication fallback.
 348          */
 349         final BiMap<String, String> javaToYang = HashBiMap.create(assignedNames.size());
 350         boolean valid = true;
 351         for (String name : assignedNames) {
 352             checkArgument(!name.isEmpty());
 353             if (!javaToYang.containsValue(name)) {
 354                 final String mappedName = getClassName(name);
 355                 if (!isValidJavaIdentifier(mappedName) || javaToYang.forcePut(mappedName, name) != null) {
 356                     valid = false;
 357                     break;
 358                 }
 359             }
 360         }
 361
 362         if (!valid) {
 363             // Fall back to bijective mapping
 364             javaToYang.clear();
 365             for (String name : assignedNames) {
 366                 javaToYang.put(mapEnumAssignedName(name), name);
 367             }
 368         }
 369
 370         return javaToYang.inverse();
 371     }
 372
 373     // See https://docs.oracle.com/javase/specs/jls/se9/html/jls-3.html#jls-3.8
 374     private static boolean isValidJavaIdentifier(final String str) {
 375         return !str.isEmpty() && !JAVA_RESERVED_WORDS.contains(str)
 376                 && Character.isJavaIdentifierStart(str.codePointAt(0))
 377                 && str.codePoints().skip(1).allMatch(Character::isJavaIdentifierPart);
 378     }
 379
 380     private static String mapEnumAssignedName(final String assignedName) {
 381         checkArgument(!assignedName.isEmpty());
 382
 383         // Mapping rules:
 384         // - if the string is a valid java identifier and does not contain '$', use it as-is
 385         if (assignedName.indexOf('$') == -1 && isValidJavaIdentifier(assignedName)) {
 386             return assignedName;
 387         }
 388
 389         // - otherwise prefix it with '$' and replace any invalid character (including '$') with '$XX$', where XX is
 390         //   hex-encoded unicode codepoint (including plane, stripping leading zeroes)
 391         final StringBuilder sb = new StringBuilder().append('$');
 392         assignedName.codePoints().forEachOrdered(codePoint -> {
 393             if (codePoint == '$' || !Character.isJavaIdentifierPart(codePoint)) {
 394                 sb.append('$').append(Integer.toHexString(codePoint).toUpperCase(Locale.ROOT)).append('$');
 395             } else {
 396                 sb.appendCodePoint(codePoint);
 397             }
 398         });
 399         return sb.toString();
 400     }
 401 }