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