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