/*
* Copyright 2003-2016 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package jetbrains.mps.util;
import jetbrains.mps.util.annotation.ToRemove;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.mps.openapi.model.SModel;
import org.jetbrains.mps.openapi.model.SModelName;
import org.jetbrains.mps.openapi.model.SModelReference;
import org.jetbrains.mps.openapi.model.SNode;
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.StringTokenizer;
import java.util.regex.Pattern;
public class NameUtil {
private static final Pattern VALID_IDENTIFIER_PATTERN = Pattern.compile("[a-zA-Z[_]][a-zA-Z0-9[_]]*");
private static final String DOT_STRUCTURE_DOT = "." + "structure" + ".";
private static final HashSet<String> PREPOSITIONS;
private static final HashSet<String> PARTICLES;
private static final HashSet<String> ARTICLES;
private static final Map<String, String> ourCompactNamespaceCache;
static {
// map, ordered by access (least recently to most recently)
ourCompactNamespaceCache = new LinkedHashMap<String, String>(128, 0.75f, true) {
@Override
protected boolean removeEldestEntry(Map.Entry<String, String> eldest) {
// eldest is the least recently accessed element of the map
return size() > 1000;
}
};
}
private static final Map<Character, String> ESCAPE_INVISIBLE_CHARS_MAP = new HashMap<Character, String>();
private static final Map<Character, String> ESCAPE_MAP = new HashMap<Character, String>();
static {
ESCAPE_INVISIBLE_CHARS_MAP.put('\000', "\\000");
ESCAPE_INVISIBLE_CHARS_MAP.put('\b', "\\b");
ESCAPE_INVISIBLE_CHARS_MAP.put('\t', "\\t");
ESCAPE_INVISIBLE_CHARS_MAP.put('\n', "\\n");
ESCAPE_INVISIBLE_CHARS_MAP.put('\f', "\\f");
ESCAPE_INVISIBLE_CHARS_MAP.put('\r', "\\r");
ESCAPE_MAP.put('\000', "\\000");
ESCAPE_MAP.put('\b', "\\b");
ESCAPE_MAP.put('\t', "\\t");
ESCAPE_MAP.put('\n', "\\n");
ESCAPE_MAP.put('\f', "\\f");
ESCAPE_MAP.put('\r', "\\r");
ESCAPE_MAP.put('\"', "\\\"");
ESCAPE_MAP.put('\\', "\\\\");
String[] preps = {
"about", "above", "across", "after", "against", "along", "among", "around", "at",
"before", "behind", "below", "beneath", "beside", "between", "by", "down",
"during", "except", "for", "from", "in", "in front of", "inside", "instead of",
"into", "like", "near", "of", "off", "on", "onto", "on top of",
"out of", "outside", "over", "past", "since", "through", "to", "toward",
"under", "underneath", "until", "up", "upon", "with", "within", "without"};
PREPOSITIONS = new HashSet<String>(Arrays.asList(preps));
String[] articles = {"a", "an", "the"};
ARTICLES = new HashSet<String>(Arrays.asList(articles));
String[] particles = {"and", "or", "not", "as"};
PARTICLES = new HashSet<String>(Arrays.asList(particles));
}
// ------ Naming policy methods --------
public static boolean satisfiesNamingPolicy(String s) {
return EqualUtil.equals(captionWithNamingPolicy(s), s);
}
public static boolean satisfiesPartNamingPolicy(String s) {
return EqualUtil.equals(captionPartWithNamingPolicy(s), s);
}
public static String captionWithNamingPolicy(String s) {
if (s == null) return null;
return captionPartWithNamingPolicy(s).trim();
}
public static String captionPartWithNamingPolicy(String s) {
if (s == null || s.length() == 0) return s;
final String quote = "'";
StringBuilder result = new StringBuilder(s.length());
StringTokenizer st = new StringTokenizer(s, quote + " ", true);
boolean inQuoted = false;
while (st.hasMoreTokens()) {
String token = st.nextToken();
if (token.equals(quote)) {
result.append(token);
inQuoted = !inQuoted;
} else {
if (inQuoted) {
result.append(token);
} else {
result.append(captionPartWithNamingPolicyNoQuoting(token));
}
}
}
return removeDoubleSpaces(result.toString());
}
private static String captionPartWithNamingPolicyNoQuoting(String s) {
if (s.length() == 0) return s;
StringBuilder result = new StringBuilder(s.length());
StringTokenizer st = new StringTokenizer(s);
if (s.startsWith(" ")) result.append(" ");
while (st.hasMoreTokens()) {
result.append(wordWithNamingPolicy(st.nextToken())).append(" ");
}
if (!s.endsWith(" ")) {
result.delete(result.length() - 1, result.length());
}
return removeDoubleSpaces(result.toString());
}
private static String removeDoubleSpaces(String s) {
char[] chars = new char[s.length()];
int charNum = 0;
boolean space = false;
for (char c : s.toCharArray()) {
boolean add = (c != ' ' || !space);
space = (c == ' ');
if (add) {
chars[charNum++] = c;
}
}
return new String(chars, 0, charNum);
}
private static String wordWithNamingPolicy(@NotNull String s) {
if (s.length() == 0) return s;
if (s.matches("'.*'")) return s;
if (isAuxiliaryWord(s)) return decapitalize(s);
return capitalize(s);
}
private static boolean isAuxiliaryWord(String s) {
return PREPOSITIONS.contains(s.toLowerCase()) || PARTICLES.contains(s.toLowerCase()) || ARTICLES.contains(s.toLowerCase());
}
// ------ Capitalization methods methods --------
public static String capitalize(String s) {
if (s == null || s.isEmpty()) return s;
char[] chars = s.toCharArray();
chars[0] = Character.toTitleCase(chars[0]);
return new String(chars);
}
public static String multiWordCapitalize(String s) {
if (s == null || s.length() == 0) {
return s;
}
char[] result = s.toCharArray();
boolean capitalizeNext = true;
for (int i = 0; i < result.length; i++) {
char ch = result[i];
if (Character.isWhitespace(ch)) {
capitalizeNext = true;
} else if (capitalizeNext) {
result[i] = Character.toTitleCase(ch);
capitalizeNext = false;
}
}
return new String(result);
}
public static String decapitalize(String s) {
if (s == null || s.isEmpty() || Character.isLowerCase(s.charAt(0))) {
return s;
}
StringBuilder result = new StringBuilder(s);
for (int i = 0; i < result.length() && Character.isUpperCase(result.charAt(i)); i++) {
// decapitalizing first/last characters and any other if next one is capital character
// desired behavior: EDTExecutor -> edtExecutor
if (i == 0 || i == result.length() - 1 || Character.isUpperCase(result.charAt(i + 1))) {
result.setCharAt(i, Character.toLowerCase(result.charAt(i)));
}
}
return result.toString();
}
public static String multiWordDecapitalize(String s) {
if (StringUtil.isEmpty(s)) {
return s;
}
StringBuilder result = new StringBuilder(s.length());
StringTokenizer st = new StringTokenizer(s);
while (st.hasMoreTokens()) {
result.append(decapitalize(st.nextToken())).append(" ");
}
return result.substring(0, result.length() - 1);
}
// ----- Pluralize/singularize utils -----
public static String pluralize(String singular) {
if (StringUtil.isEmpty(singular)) return singular;
// This condition is to distinguish "berry"->"berries" and "array"->"arrays"
if (singular.endsWith("y") && singular.length() > 1
&& isConsonant(singular.charAt(singular.length() - 2))) {
return singular.substring(0, singular.length() - 1) + "ies";
}
if (singular.endsWith("s") || singular.endsWith("x")) {
return singular + "es";
}
return singular + "s";
}
public static String singularize(String plural) {
if (StringUtil.isEmpty(plural)) return plural;
if (plural.endsWith("ies")) {
return plural.substring(0, plural.length() - 3) + "y";
}
if (plural.endsWith("es")) {
return plural.substring(0, plural.length() - 2);
}
if (plural.endsWith("s")) {
return plural.substring(0, plural.length() - 1);
}
return plural;
}
private static boolean isConsonant(char ch) {
return "bcdfghjklmnpqrstvwxz".indexOf(ch) != -1;
}
/**
* Return numerical string for given quantity of objects and singular form of object name.
* For example, for <code>(5, "issue")</code> returns <code>"5 issues"</code>.
*
* @param quantity quantity of counted objects
* @param singular singular form of counted objects
* @return numerical string
*/
public static String formatNumericalString(int quantity, String singular) {
return quantity + " " + (quantity == 1 ? singular : pluralize(singular));
}
/* "aaaBBB" -> "AAA_BBB" */
public static String toConstantName(String s) {
if (s == null) {
return s;
}
if (s.length() == 0) {
return s;
}
StringBuffer sb = new StringBuffer();
for (int i = 0; i < s.length(); i++) {
char c = s.charAt(i);
if (Character.isUpperCase(c) && i > 0) {
sb.append('_');
}
sb.append(Character.toUpperCase(c));
}
return sb.toString();
}
public static List<String> splitByCamels(String source) {
if (source == null) return null;
List<String> result = new ArrayList<String>();
StringBuilder current = new StringBuilder();
for (int i = source.length() - 1; i >= 0; i--) {
char c = source.charAt(i);
current.insert(0, c);
if (i > 0 && Character.isUpperCase(c)) {
result.add(decapitalize(current.toString()));
//current = new StringBuffer();
}
}
if (current.length() > 0) {
result.add(current.toString());
}
return result;
}
public static String shortNameFromLongName(String fqName) {
if (fqName == null) {
return null;
}
int offset = fqName.lastIndexOf('.');
if (offset < 0) return fqName;
return fqName.substring(offset + 1);
}
public static String namespaceFromLongName(String fqName) {
if (fqName == null) {
return null;
}
int offset = fqName.lastIndexOf('.');
if (offset < 0) {
return "";
}
return fqName.substring(0, offset);
}
public static String namespaceFromConceptFQName(String fqName) {
if (fqName == null) return null;
int offset = fqName.lastIndexOf(DOT_STRUCTURE_DOT);
if (offset > 0) {
return fqName.substring(0, offset);
}
return "";
}
public static String conceptFQNameFromNamespaceAndShortName(String namespace, String shortName) {
return namespace + DOT_STRUCTURE_DOT + shortName;
}
public static String longNameFromNamespaceAndShortName(String namespace, String name) {
if (StringUtil.isEmpty(namespace)) {
return name;
}
return namespace + '.' + name;
}
public static String nodeFQName(SNode node) {
if (node == null) {
return null;
}
String name = node.getName();
SModel model = node.getModel();
if (model == null) return name;
return getModelLongName(model) + '.' + name;
}
public static String compactNodeFQName(SNode node) {
if (node == null) {
return "null";
}
String name = node.getName();
SModel model = node.getModel();
if (model == null) {
return name;
}
return compactNamespace(getModelLongName(model)) + '.' + name;
}
/**
* @deprecated Use {@link SModelName#getLongName()} instead
* @param model not null
* @return qualified name of the model without stereotype
*/
@Deprecated
@ToRemove(version = 3.4)
public static String getModelLongName(SModel model) {
return model.getName().getLongName();
}
/**
* @deprecated Use {@link SModelName#getLongName()} instead
* @param modelRef not null
* @return qualified name of the model without stereotype
*/
@Deprecated
@ToRemove(version = 3.4)
public static String getModelLongName(SModelReference modelRef) {
return modelRef.getName().getLongName();
}
public static String compactModelName(SModelReference ref) {
String compactNamespace = NameUtil.compactNamespace(ref.getName().getLongName());
if (ref.getName().hasStereotype()) {
return compactNamespace + '@' + ref.getName().getStereotype().charAt(0);
} else {
return compactNamespace;
}
}
public static String escapeInvisibleCharacters(String s) {
return escapeString(s, ESCAPE_INVISIBLE_CHARS_MAP);
}
public static String escapeString(String s) {
return escapeString(s, ESCAPE_MAP);
}
private static String escapeString(String s, Map<Character, String> substitutionMap) {
if (s == null) return null;
StringBuilder stringBuilder = new StringBuilder();
int length = s.length();
for (int idx = 0; idx < length; idx++) {
char ch = s.charAt(idx);
if (substitutionMap.containsKey(ch)) {
stringBuilder.append(substitutionMap.get(ch));
} else {
stringBuilder.append(ch);
}
}
return stringBuilder.toString();
}
public static String escapeChar(char c) {
if (c == '\'') {
return "\\'";
}
if (ESCAPE_MAP.containsKey(c)) {
return ESCAPE_MAP.get(c);
}
return c + "";
}
public static String toSystemDependentPath(String path) {
path = path.replace('\\', File.separatorChar);
path = path.replace('/', File.separatorChar);
return path;
}
public static String toValidIdentifier(String s) {
if (s == null) return null;
if (VALID_IDENTIFIER_PATTERN.matcher(s).matches()) return s;
StringBuffer sb = new StringBuffer();
for (int i = 0; i < s.length(); i++) {
char c = s.charAt(i);
if (i == 0 && Character.isDigit(c)) {
sb.append('_');
}
if (c == '_' || Character.isLetterOrDigit(c)) {
sb.append(c);
} else {
sb.append('_');
}
}
return sb.toString();
}
public static String toValidCamelIdentifier(String s) {
if (VALID_IDENTIFIER_PATTERN.matcher(s).matches()) return s;
StringBuilder sb = new StringBuilder();
boolean upperCaseNext = false;
for (int i = 0; i < s.length(); i++) {
char c = s.charAt(i);
if (i == 0 && Character.isDigit(c)) {
sb.append('_');
}
if (c == '_' || Character.isLetterOrDigit(c)) {
if (upperCaseNext) {
upperCaseNext = false;
c = Character.toUpperCase(c);
}
sb.append(c);
} else {
upperCaseNext = true;
}
}
return sb.toString();
}
//platform-dependent path string
public static String pathFromNamespace(String namespace) {
return namespace.replace('.', File.separatorChar);
}
public static String namespaceFromPath(String path) {
return path.replace('/', '.').replace(File.separatorChar, '.');
}
/**
* Strips optional quotes from the beggining and ending of the quotedString.
*
* @param quotedString string to strip quotes.
* @param optionalOpenQuote optional open quote. If quotedString starts with it then it will be stripped.
* @param optionalCloseQuote optional close quote. If quotedString ends with it then it will be stripped.
* @return quotedString with stripped quotes.
*/
public static String stripQuotes(String quotedString, String optionalOpenQuote, String optionalCloseQuote) {
if (quotedString != null) {
if (quotedString.length() >= optionalOpenQuote.length() && quotedString.startsWith(optionalOpenQuote)) {
quotedString = quotedString.substring(optionalOpenQuote.length());
}
if (quotedString.length() >= optionalCloseQuote.length() && quotedString.endsWith(optionalCloseQuote)) {
quotedString = quotedString.substring(0, quotedString.length() - optionalCloseQuote.length());
}
}
return quotedString;
}
public static String compactNamespace(String namespace) {
String result = ourCompactNamespaceCache.get(namespace);
if (result != null) {
return result;
}
synchronized (ourCompactNamespaceCache) {
result = ourCompactNamespaceCache.get(namespace);
if (result == null) {
result = _compactNamespace(namespace);
ourCompactNamespaceCache.put(namespace, result);
}
return result;
}
}
private static String _compactNamespace(String namespace) {
if (namespace.length() > 10) {
String[] parts = namespace.split("\\.");
StringBuilder result = new StringBuilder();
for (int i = 0; i < parts.length; i++) {
if (i != 0) {
result.append('.');
}
if (i < parts.length - 2) {
result.append(parts[i].charAt(0));
} else {
result.append(parts[i]);
}
}
return result.toString();
}
return namespace;
}
public static String getGetterName(String property) {
return "get" + capitalize(property);
}
public static String getSetterName(String property) {
return "set" + capitalize(property);
}
public static String getAdderName(String property) {
return "add" + capitalize(property);
}
public static String getRemoverName(String property) {
return "remove" + capitalize(property);
}
public static String getPropertyNameFromGetterOrSetter(String name) {
assert name.startsWith("get") || name.startsWith("set");
String propertyName = name.substring(3);
if (propertyName.isEmpty()) return propertyName;
char[] result = propertyName.toCharArray();
result[0] = Character.toLowerCase(result[0]);
return new String(result);
}
}