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.Set;
  24 import java.util.regex.Matcher;
  25 import java.util.regex.Pattern;
  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 String VERSION = "0.6";
  37
  38     public static final Set<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 String DATA_ROOT_SUFFIX = "Data";
  51     public static final String RPC_SERVICE_SUFFIX = "Service";
  52     public static final String NOTIFICATION_LISTENER_SUFFIX = "Listener";
  53     public static final String QNAME_STATIC_FIELD_NAME = "QNAME";
  54     public static final String PACKAGE_PREFIX = "org.opendaylight.yang.gen.v1";
  55     public static final 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 String MODULE_INFO_CLASS_NAME = "$YangModuleInfoImpl";
  64     public static final String MODULE_INFO_QNAMEOF_METHOD_NAME = "qnameOf";
  65     public static final String MODEL_BINDING_PROVIDER_CLASS_NAME = "$YangModelBindingProvider";
  66
  67     /**
  68      * Name of {@link Augmentable#augmentation(Class)}.
  69      */
  70     public static final String AUGMENTABLE_AUGMENTATION_NAME = "augmentation";
  71
  72     /**
  73      * Name of {@link Identifiable#key()}.
  74      */
  75     public static final String IDENTIFIABLE_KEY_NAME = "key";
  76
  77     /**
  78      * Name of {@link DataContainer#getImplementedInterface()}.
  79      */
  80     // FIXME: 4.0.0: remove this constant
  81     public static final String DATA_CONTAINER_GET_IMPLEMENTED_INTERFACE_NAME = "getImplementedInterface";
  82
  83     /**
  84      * Name of {@link DataContainer#implementedInterface()}.
  85      */
  86     public static final String DATA_CONTAINER_IMPLEMENTED_INTERFACE_NAME = "implementedInterface";
  87
  88     /**
  89      * Prefix for getter methods working on top of boolean.
  90      */
  91     public static final String BOOLEAN_GETTER_PREFIX = "is";
  92
  93     /**
  94      * Prefix for normal getter methods.
  95      */
  96     public static final String GETTER_PREFIX = "get";
  97
  98     /**
  99      * Prefix for non-null default wrapper methods. These methods always wrap a corresponding normal getter.
 100      */
 101     public static final String NONNULL_PREFIX = "nonnull";
 102
 103     public static final String RPC_INPUT_SUFFIX = "Input";
 104     public static final String RPC_OUTPUT_SUFFIX = "Output";
 105
 106     private static final Interner<String> PACKAGE_INTERNER = Interners.newWeakInterner();
 107
 108     private BindingMapping() {
 109         throw new UnsupportedOperationException("Utility class should not be instantiated");
 110     }
 111
 112     public static String getRootPackageName(final QName module) {
 113         return getRootPackageName(module.getModule());
 114     }
 115
 116     public static String getRootPackageName(final QNameModule module) {
 117         checkArgument(module != null, "Module must not be null");
 118         checkArgument(module.getRevision() != null, "Revision must not be null");
 119         checkArgument(module.getNamespace() != null, "Namespace must not be null");
 120         final StringBuilder packageNameBuilder = new StringBuilder();
 121
 122         packageNameBuilder.append(BindingMapping.PACKAGE_PREFIX);
 123         packageNameBuilder.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 String normalizePackageName(final String packageName) {
 171         if (packageName == null) {
 172             return null;
 173         }
 174
 175         final StringBuilder builder = new StringBuilder();
 176         boolean first = true;
 177
 178         for (String p : DOT_SPLITTER.split(packageName.toLowerCase(Locale.ENGLISH))) {
 179             if (first) {
 180                 first = false;
 181             } else {
 182                 builder.append('.');
 183             }
 184
 185             if (Character.isDigit(p.charAt(0)) || BindingMapping.JAVA_RESERVED_WORDS.contains(p)) {
 186                 builder.append('_');
 187             }
 188             builder.append(p);
 189         }
 190
 191         // Prevent duplication of input string
 192         return PACKAGE_INTERNER.intern(builder.toString());
 193     }
 194
 195     public static String getClassName(final String localName) {
 196         checkArgument(localName != null, "Name should not be null.");
 197         return toFirstUpper(toCamelCase(localName));
 198     }
 199
 200     public static String getClassName(final QName name) {
 201         checkArgument(name != null, "Name should not be null.");
 202         return toFirstUpper(toCamelCase(name.getLocalName()));
 203     }
 204
 205     public static String getMethodName(final String yangIdentifier) {
 206         checkArgument(yangIdentifier != null,"Identifier should not be null");
 207         return toFirstLower(toCamelCase(yangIdentifier));
 208     }
 209
 210     public static String getMethodName(final QName name) {
 211         checkArgument(name != null, "Name should not be null.");
 212         return getMethodName(name.getLocalName());
 213     }
 214
 215     public static String getGetterPrefix(final boolean isBoolean) {
 216         return isBoolean ? BOOLEAN_GETTER_PREFIX : GETTER_PREFIX;
 217     }
 218
 219     public static String getGetterMethodName(final String localName, final boolean isBoolean) {
 220         return getGetterPrefix(isBoolean) + toFirstUpper(getPropertyName(localName));
 221     }
 222
 223     public static String getGetterMethodName(final QName name, final boolean isBoolean) {
 224         return getGetterPrefix(isBoolean) + getGetterSuffix(name);
 225     }
 226
 227     public static boolean isGetterMethodName(final String methodName) {
 228         return methodName.startsWith(GETTER_PREFIX) || methodName.startsWith(BOOLEAN_GETTER_PREFIX);
 229     }
 230
 231     public static String getGetterMethodForNonnull(final String methodName) {
 232         checkArgument(isNonnullMethodName(methodName));
 233         return GETTER_PREFIX + methodName.substring(NONNULL_PREFIX.length());
 234     }
 235
 236     public static String getNonnullMethodName(final String localName) {
 237         return NONNULL_PREFIX + toFirstUpper(getPropertyName(localName));
 238     }
 239
 240     public static boolean isNonnullMethodName(final String methodName) {
 241         return methodName.startsWith(NONNULL_PREFIX);
 242     }
 243
 244     public static String getGetterSuffix(final QName name) {
 245         checkArgument(name != null, "Name should not be null.");
 246         final String candidate = toFirstUpper(toCamelCase(name.getLocalName()));
 247         return "Class".equals(candidate) ? "XmlClass" : candidate;
 248     }
 249
 250     public static String getPropertyName(final String yangIdentifier) {
 251         final String potential = toFirstLower(toCamelCase(yangIdentifier));
 252         if ("class".equals(potential)) {
 253             return "xmlClass";
 254         }
 255         return potential;
 256     }
 257
 258     private static String toCamelCase(final String rawString) {
 259         checkArgument(rawString != null, "String should not be null");
 260         Iterable<String> components = CAMEL_SPLITTER.split(rawString);
 261         StringBuilder builder = new StringBuilder();
 262         for (String comp : components) {
 263             builder.append(toFirstUpper(comp));
 264         }
 265         return checkNumericPrefix(builder.toString());
 266     }
 267
 268     private static String checkNumericPrefix(final String rawString) {
 269         if (rawString == null || rawString.isEmpty()) {
 270             return rawString;
 271         }
 272         final char firstChar = rawString.charAt(0);
 273         return firstChar >= '0' && firstChar <= '9' ? "_" + rawString : rawString;
 274     }
 275
 276     /**
 277      * Returns the {@link String} {@code s} with an {@link Character#isUpperCase(char) upper case} first character. This
 278      * function is null-safe.
 279      *
 280      * @param str the string that should get an upper case first character. May be <code>null</code>.
 281      * @return the {@link String} {@code str} with an upper case first character or <code>null</code> if the input
 282      *         {@link String} {@code str} was <code>null</code>.
 283      */
 284     public static String toFirstUpper(final String str) {
 285         if (str == null || str.length() == 0) {
 286             return str;
 287         }
 288         if (Character.isUpperCase(str.charAt(0))) {
 289             return str;
 290         }
 291         if (str.length() == 1) {
 292             return str.toUpperCase(Locale.ENGLISH);
 293         }
 294         return str.substring(0, 1).toUpperCase(Locale.ENGLISH) + str.substring(1);
 295     }
 296
 297     /**
 298      * Returns the {@link String} {@code s} with a {@link Character#isLowerCase(char) lower case} first character. This
 299      * function is null-safe.
 300      *
 301      * @param str the string that should get an lower case first character. May be <code>null</code>.
 302      * @return the {@link String} {@code str} with an lower case first character or <code>null</code> if the input
 303      *         {@link String} {@code str} was <code>null</code>.
 304      */
 305     private static String toFirstLower(final String str) {
 306         if (str == null || str.length() == 0) {
 307             return str;
 308         }
 309         if (Character.isLowerCase(str.charAt(0))) {
 310             return str;
 311         }
 312         if (str.length() == 1) {
 313             return str.toLowerCase(Locale.ENGLISH);
 314         }
 315         return str.substring(0, 1).toLowerCase(Locale.ENGLISH) + str.substring(1);
 316     }
 317
 318     /**
 319      * Returns Java identifiers, conforming to JLS9 Section 3.8 to use for specified YANG assigned names
 320      * (RFC7950 Section 9.6.4). This method considers two distinct encodings: one the pre-Fluorine mapping, which is
 321      * okay and convenient for sane strings, and an escaping-based bijective mapping which works for all possible
 322      * Unicode strings.
 323      *
 324      * @param assignedNames Collection of assigned names
 325      * @return A BiMap keyed by assigned name, with Java identifiers as values
 326      * @throws NullPointerException if assignedNames is null or contains null items
 327      * @throws IllegalArgumentException if any of the names is empty
 328      */
 329     public static BiMap<String, String> mapEnumAssignedNames(final Collection<String> assignedNames) {
 330         /*
 331          * Original mapping assumed strings encountered are identifiers, hence it used getClassName to map the names
 332          * and that function is not an injection -- this is evidenced in MDSAL-208 and results in a failure to compile
 333          * generated code. If we encounter such a conflict or if the result is not a valid identifier (like '*'), we
 334          * abort and switch the mapping schema to mapEnumAssignedName(), which is a bijection.
 335          *
 336          * Note that assignedNames can contain duplicates, which must not trigger a duplication fallback.
 337          */
 338         final BiMap<String, String> javaToYang = HashBiMap.create(assignedNames.size());
 339         boolean valid = true;
 340         for (String name : assignedNames) {
 341             checkArgument(!name.isEmpty());
 342             if (!javaToYang.containsValue(name)) {
 343                 final String mappedName = getClassName(name);
 344                 if (!isValidJavaIdentifier(mappedName) || javaToYang.forcePut(mappedName, name) != null) {
 345                     valid = false;
 346                     break;
 347                 }
 348             }
 349         }
 350
 351         if (!valid) {
 352             // Fall back to bijective mapping
 353             javaToYang.clear();
 354             for (String name : assignedNames) {
 355                 javaToYang.put(mapEnumAssignedName(name), name);
 356             }
 357         }
 358
 359         return javaToYang.inverse();
 360     }
 361
 362     // See https://docs.oracle.com/javase/specs/jls/se9/html/jls-3.html#jls-3.8
 363     private static boolean isValidJavaIdentifier(final String str) {
 364         return !str.isEmpty() && !JAVA_RESERVED_WORDS.contains(str)
 365                 && Character.isJavaIdentifierStart(str.codePointAt(0))
 366                 && str.codePoints().skip(1).allMatch(Character::isJavaIdentifierPart);
 367     }
 368
 369     private static String mapEnumAssignedName(final String assignedName) {
 370         checkArgument(!assignedName.isEmpty());
 371
 372         // Mapping rules:
 373         // - if the string is a valid java identifier and does not contain '$', use it as-is
 374         if (assignedName.indexOf('$') == -1 && isValidJavaIdentifier(assignedName)) {
 375             return assignedName;
 376         }
 377
 378         // - otherwise prefix it with '$' and replace any invalid character (including '$') with '$XX$', where XX is
 379         //   hex-encoded unicode codepoint (including plane, stripping leading zeroes)
 380         final StringBuilder sb = new StringBuilder().append('$');
 381         assignedName.codePoints().forEachOrdered(codePoint -> {
 382             if (codePoint == '$' || !Character.isJavaIdentifierPart(codePoint)) {
 383                 sb.append('$').append(Integer.toHexString(codePoint).toUpperCase(Locale.ROOT)).append('$');
 384             } else {
 385                 sb.appendCodePoint(codePoint);
 386             }
 387         });
 388         return sb.toString();
 389     }
 390 }