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 normal getter methods.
 108      */
 109     public static final @NonNull String GETTER_PREFIX = "get";
 110
 111     /**
 112      * Prefix for non-null default wrapper methods. These methods always wrap a corresponding normal getter.
 113      */
 114     public static final @NonNull String NONNULL_PREFIX = "nonnull";
 115
 116     public static final @NonNull String RPC_INPUT_SUFFIX = "Input";
 117     public static final @NonNull String RPC_OUTPUT_SUFFIX = "Output";
 118
 119     private static final Interner<String> PACKAGE_INTERNER = Interners.newWeakInterner();
 120
 121     private BindingMapping() {
 122         // Hidden on purpose
 123     }
 124
 125     public static @NonNull String getRootPackageName(final QName module) {
 126         return getRootPackageName(module.getModule());
 127     }
 128
 129     public static @NonNull String getRootPackageName(final QNameModule module) {
 130         final StringBuilder packageNameBuilder = new StringBuilder().append(BindingMapping.PACKAGE_PREFIX).append('.');
 131
 132         String namespace = module.getNamespace().toString();
 133         namespace = COLON_SLASH_SLASH.matcher(namespace).replaceAll(QUOTED_DOT);
 134
 135         final char[] chars = namespace.toCharArray();
 136         for (int i = 0; i < chars.length; ++i) {
 137             switch (chars[i]) {
 138                 case '/':
 139                 case ':':
 140                 case '-':
 141                 case '@':
 142                 case '$':
 143                 case '#':
 144                 case '\'':
 145                 case '*':
 146                 case '+':
 147                 case ',':
 148                 case ';':
 149                 case '=':
 150                     chars[i] = '.';
 151                     break;
 152                 default:
 153                     // no-op
 154             }
 155         }
 156
 157         packageNameBuilder.append(chars);
 158         if (chars[chars.length - 1] != '.') {
 159             packageNameBuilder.append('.');
 160         }
 161
 162         final Optional<Revision> optRev = module.getRevision();
 163         if (optRev.isPresent()) {
 164             // Revision is in format 2017-10-26, we want the output to be 171026, which is a matter of picking the
 165             // right characters.
 166             final String rev = optRev.get().toString();
 167             checkArgument(rev.length() == 10, "Unsupported revision %s", rev);
 168             packageNameBuilder.append("rev").append(rev, 2, 4).append(rev, 5, 7).append(rev.substring(8));
 169         } else {
 170             // No-revision packages are special
 171             packageNameBuilder.append("norev");
 172         }
 173
 174         return normalizePackageName(packageNameBuilder.toString());
 175     }
 176
 177     public static @NonNull String normalizePackageName(final String packageName) {
 178         final StringBuilder builder = new StringBuilder();
 179         boolean first = true;
 180
 181         for (String p : DOT_SPLITTER.split(packageName.toLowerCase(Locale.ENGLISH))) {
 182             if (first) {
 183                 first = false;
 184             } else {
 185                 builder.append('.');
 186             }
 187
 188             if (Character.isDigit(p.charAt(0)) || BindingMapping.JAVA_RESERVED_WORDS.contains(p)) {
 189                 builder.append('_');
 190             }
 191             builder.append(p);
 192         }
 193
 194         // Prevent duplication of input string
 195         return PACKAGE_INTERNER.intern(builder.toString());
 196     }
 197
 198     public static @NonNull String getClassName(final String localName) {
 199         return toFirstUpper(toCamelCase(localName));
 200     }
 201
 202     public static @NonNull String getClassName(final QName name) {
 203         return toFirstUpper(toCamelCase(name.getLocalName()));
 204     }
 205
 206     public static @NonNull String getMethodName(final String yangIdentifier) {
 207         return toFirstLower(toCamelCase(yangIdentifier));
 208     }
 209
 210     public static @NonNull String getMethodName(final QName name) {
 211         return getMethodName(name.getLocalName());
 212     }
 213
 214     public static @NonNull String getGetterMethodName(final String localName) {
 215         return GETTER_PREFIX + toFirstUpper(getPropertyName(localName));
 216     }
 217
 218     public static @NonNull String getGetterMethodName(final QName name) {
 219         return GETTER_PREFIX + getGetterSuffix(name);
 220     }
 221
 222     public static boolean isGetterMethodName(final String methodName) {
 223         return methodName.startsWith(GETTER_PREFIX);
 224     }
 225
 226     public static @NonNull String getGetterMethodForNonnull(final String methodName) {
 227         checkArgument(isNonnullMethodName(methodName));
 228         return GETTER_PREFIX + methodName.substring(NONNULL_PREFIX.length());
 229     }
 230
 231     public static @NonNull String getNonnullMethodName(final String localName) {
 232         return NONNULL_PREFIX + toFirstUpper(getPropertyName(localName));
 233     }
 234
 235     public static boolean isNonnullMethodName(final String methodName) {
 236         return methodName.startsWith(NONNULL_PREFIX);
 237     }
 238
 239     public static @NonNull String getGetterSuffix(final QName name) {
 240         final String candidate = toFirstUpper(toCamelCase(name.getLocalName()));
 241         return "Class".equals(candidate) ? "XmlClass" : candidate;
 242     }
 243
 244     public static @NonNull String getPropertyName(final String yangIdentifier) {
 245         final String potential = toFirstLower(toCamelCase(yangIdentifier));
 246         if ("class".equals(potential)) {
 247             return "xmlClass";
 248         }
 249         return potential;
 250     }
 251
 252     private static @NonNull String toCamelCase(final String rawString) {
 253         StringBuilder builder = new StringBuilder();
 254         for (String comp : CAMEL_SPLITTER.split(rawString)) {
 255             builder.append(toFirstUpper(comp));
 256         }
 257         return checkNumericPrefix(builder.toString());
 258     }
 259
 260     private static @NonNull String checkNumericPrefix(final String rawString) {
 261         if (rawString.isEmpty()) {
 262             return rawString;
 263         }
 264         final char firstChar = rawString.charAt(0);
 265         return firstChar >= '0' && firstChar <= '9' ? "_" + rawString : rawString;
 266     }
 267
 268     /**
 269      * Returns the {@link String} {@code s} with an {@link Character#isUpperCase(char) upper case} first character.
 270      *
 271      * @param str the string that should get an upper case first character.
 272      * @return the {@link String} {@code str} with an upper case first character.
 273      */
 274     private static @NonNull String toFirstUpper(final @NonNull String str) {
 275         if (str.isEmpty()) {
 276             return str;
 277         }
 278         if (Character.isUpperCase(str.charAt(0))) {
 279             return str;
 280         }
 281         if (str.length() == 1) {
 282             return str.toUpperCase(Locale.ENGLISH);
 283         }
 284         return str.substring(0, 1).toUpperCase(Locale.ENGLISH) + str.substring(1);
 285     }
 286
 287     /**
 288      * Returns the {@link String} {@code s} with a {@link Character#isLowerCase(char) lower case} first character. This
 289      * function is null-safe.
 290      *
 291      * @param str the string that should get an lower case first character. May be <code>null</code>.
 292      * @return the {@link String} {@code str} with an lower case first character or <code>null</code> if the input
 293      *         {@link String} {@code str} was empty.
 294      */
 295     private static @NonNull String toFirstLower(final @NonNull String str) {
 296         if (str.isEmpty()) {
 297             return str;
 298         }
 299         if (Character.isLowerCase(str.charAt(0))) {
 300             return str;
 301         }
 302         if (str.length() == 1) {
 303             return str.toLowerCase(Locale.ENGLISH);
 304         }
 305         return str.substring(0, 1).toLowerCase(Locale.ENGLISH) + str.substring(1);
 306     }
 307
 308     /**
 309      * Returns the {@link String} {@code s} with a '$' character as suffix.
 310      *
 311      * @param qname RPC QName
 312      * @return The RPC method name as determined by considering the localname against the JLS.
 313      * @throws NullPointerException if {@code qname} is null
 314      */
 315     public static @NonNull String getRpcMethodName(final @NonNull QName qname) {
 316         final String methodName = getMethodName(qname);
 317         return JAVA_RESERVED_WORDS.contains(methodName) ? methodName + "$" : methodName;
 318     }
 319
 320     /**
 321      * Returns Java identifiers, conforming to JLS9 Section 3.8 to use for specified YANG assigned names
 322      * (RFC7950 Section 9.6.4). This method considers two distinct encodings: one the pre-Fluorine mapping, which is
 323      * okay and convenient for sane strings, and an escaping-based bijective mapping which works for all possible
 324      * Unicode strings.
 325      *
 326      * @param assignedNames Collection of assigned names
 327      * @return A BiMap keyed by assigned name, with Java identifiers as values
 328      * @throws NullPointerException if assignedNames is null or contains null items
 329      * @throws IllegalArgumentException if any of the names is empty
 330      */
 331     public static BiMap<String, String> mapEnumAssignedNames(final Collection<String> assignedNames) {
 332         /*
 333          * Original mapping assumed strings encountered are identifiers, hence it used getClassName to map the names
 334          * and that function is not an injection -- this is evidenced in MDSAL-208 and results in a failure to compile
 335          * generated code. If we encounter such a conflict or if the result is not a valid identifier (like '*'), we
 336          * abort and switch the mapping schema to mapEnumAssignedName(), which is a bijection.
 337          *
 338          * Note that assignedNames can contain duplicates, which must not trigger a duplication fallback.
 339          */
 340         final BiMap<String, String> javaToYang = HashBiMap.create(assignedNames.size());
 341         boolean valid = true;
 342         for (String name : assignedNames) {
 343             checkArgument(!name.isEmpty());
 344             if (!javaToYang.containsValue(name)) {
 345                 final String mappedName = getClassName(name);
 346                 if (!isValidJavaIdentifier(mappedName) || javaToYang.forcePut(mappedName, name) != null) {
 347                     valid = false;
 348                     break;
 349                 }
 350             }
 351         }
 352
 353         if (!valid) {
 354             // Fall back to bijective mapping
 355             javaToYang.clear();
 356             for (String name : assignedNames) {
 357                 javaToYang.put(mapEnumAssignedName(name), name);
 358             }
 359         }
 360
 361         return javaToYang.inverse();
 362     }
 363
 364     // See https://docs.oracle.com/javase/specs/jls/se9/html/jls-3.html#jls-3.8
 365     private static boolean isValidJavaIdentifier(final String str) {
 366         return !str.isEmpty() && !JAVA_RESERVED_WORDS.contains(str)
 367                 && Character.isJavaIdentifierStart(str.codePointAt(0))
 368                 && str.codePoints().skip(1).allMatch(Character::isJavaIdentifierPart);
 369     }
 370
 371     private static String mapEnumAssignedName(final String assignedName) {
 372         checkArgument(!assignedName.isEmpty());
 373
 374         // Mapping rules:
 375         // - if the string is a valid java identifier and does not contain '$', use it as-is
 376         if (assignedName.indexOf('$') == -1 && isValidJavaIdentifier(assignedName)) {
 377             return assignedName;
 378         }
 379
 380         // - otherwise prefix it with '$' and replace any invalid character (including '$') with '$XX$', where XX is
 381         //   hex-encoded unicode codepoint (including plane, stripping leading zeroes)
 382         final StringBuilder sb = new StringBuilder().append('$');
 383         assignedName.codePoints().forEachOrdered(codePoint -> {
 384             if (codePoint == '$' || !Character.isJavaIdentifierPart(codePoint)) {
 385                 sb.append('$').append(Integer.toHexString(codePoint).toUpperCase(Locale.ROOT)).append('$');
 386             } else {
 387                 sb.appendCodePoint(codePoint);
 388             }
 389         });
 390         return sb.toString();
 391     }
 392 }