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