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