msi.gama.common.util.StringUtils.java Source code

Introduction

Here is the source code for msi.gama.common.util.StringUtils.java

Source

/*******************************************************************************************************
 *
 * msi.gama.common.util.StringUtils.java, in plugin msi.gama.core,
 * is part of the source code of the GAMA modeling and simulation platform (v. 1.8)
 * 
 * (c) 2007-2018 UMI 209 UMMISCO IRD/SU & Partners
 *
 * Visit https://github.com/gama-platform/gama for license information and contacts.
 * 
 ********************************************************************************************************/
package msi.gama.common.util;

import java.text.DecimalFormat;
import java.text.DecimalFormatSymbols;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.commons.lang.StringEscapeUtils;

import msi.gama.common.interfaces.IGamlable;
import msi.gama.util.GamaListFactory;
import msi.gama.util.IList;
import msi.gaml.types.Types;

/**
 * The class StringUtils.
 *
 * @author drogoul
 * @since 13 dc. 2011
 *
 */
@SuppressWarnings({ "rawtypes", "unchecked" })
public class StringUtils {

    final static String strings = "'(?:[^\\\\']+|\\\\.)*'"; // Old:
    // '[^'\\\r\n]*(?:\\.[^'\\\r\n]*)*'
    final static String operators = "::|<>|!=|>=|<=|//";
    public final static String ponctuation = "\\p{Punct}";
    public final static String literals = "\\w+\\$\\w+|\\#\\w+|\\d+\\.\\d+|\\w+\\.\\w+|\\w+";
    final static String regex = strings + "|" + literals + "|" + operators + "|" + ponctuation;

    static public String toGamlString(final String s) {
        if (s == null) {
            return null;
        }
        final StringBuilder sb = new StringBuilder(s.length());
        sb.append('\'');
        sb.append(s.replace("\\", "\\\\").replace("'", "\\'").replace("\"", "\\\"").replace("/", "\\/"));
        sb.append('\'');
        return sb.toString();
    }

    static public String toJavaString(final String s) {
        if (s == null) {
            return null;
        }
        final String t = s.trim();
        if (!isGamaString(t)) {
            return s;
        }
        if (t.length() >= 2) {
            return t.substring(1, t.length() - 1);
        }
        return s;
    }

    public static List<String> tokenize(final String expression) {
        if (expression == null) {
            return Collections.EMPTY_LIST;
        }
        final Pattern p = Pattern.compile(regex);
        final List<String> tokens = new ArrayList<String>();
        final Matcher m = p.matcher(expression);
        while (m.find()) {
            tokens.add(expression.substring(m.start(), m.end()));
        }
        return tokens;
    }

    /**
     * Unescape java.
     *
     * @param str
     *            the str
     *
     * @return the string
     */
    static public String unescapeJava(final String str) {
        if (str == null) {
            return null;
        }

        final StringBuilder writer = new StringBuilder(str.length());
        unescapeJava(writer, str);
        final String result = writer.toString();
        // DEBUG.LOG("String en entre:" + str + " ; en sortie:" +
        // result);
        // writer.setLength(0);
        return result;

    }

    // private static final StringBuilder writer = new StringBuilder();
    // private static final StringBuilder unicode = new StringBuilder(4);

    /**
     * Unescape java.
     *
     * @param out
     *            the out
     * @param str
     *            the str
     */
    static private void unescapeJava(final StringBuilder writer, final String str) {
        if (str == null) {
            return;
        }
        final int sz = str.length();

        boolean hadSlash = false;
        boolean inUnicode = false;
        StringBuilder unicode = null;
        for (int i = 0; i < sz; i++) {
            final char ch = str.charAt(i);
            if (inUnicode) {
                // if in unicode, then we're reading unicode
                // values in somehow
                if (unicode == null) {
                    unicode = new StringBuilder(4);
                }
                unicode.append(ch);
                if (unicode.length() == 4) {
                    // digits
                    // which represents our unicode character
                    final int value = Integer.parseInt(unicode.toString(), 16);
                    writer.append((char) value);
                    unicode.setLength(0);
                    inUnicode = false;
                    hadSlash = false;
                }
                continue;
            }
            if (hadSlash) {
                // handle an escaped value
                hadSlash = false;
                switch (ch) {
                case '\\':
                    writer.append('\\');
                    break;
                case '\'':
                    writer.append('\'');
                    break;
                case '\"':
                    writer.append('"');
                    break;
                case 'r':
                    writer.append('\r');
                    break;
                case 'f':
                    writer.append('\f');
                    break;
                case 't':
                    writer.append('\t');
                    break;
                case 'n':
                    writer.append('\n');
                    break;
                case 'b':
                    writer.append('\b');
                    break;
                case 'u': {
                    // uh-oh, we're in unicode country....
                    inUnicode = true;
                    break;
                }
                default:
                    writer.append(ch);
                    break;
                }
                continue;
            } else if (ch == '\\') {
                hadSlash = true;
                continue;
            }
            writer.append(ch);
        }
        if (hadSlash) {
            // string, let's output it anyway.
            writer.append('\\');
        }
    }

    static public boolean isGamaString(final String s) {
        if (s == null) {
            return false;
        }
        final int n = s.length();
        if (n == 0 || n == 1) {
            return false;
        }
        if (s.charAt(0) != '\'') {
            return false;
        }
        if (s.charAt(n - 1) != '\'') {
            return false;
        }
        return true;
    }

    public static final DecimalFormat DEFAULT_DECIMAL_FORMAT;
    public static final DecimalFormatSymbols SYMBOLS;

    static {
        SYMBOLS = new DecimalFormatSymbols();
        SYMBOLS.setDecimalSeparator('.');
        SYMBOLS.setInfinity("#infinity");
        SYMBOLS.setNaN("#nan");
        DEFAULT_DECIMAL_FORMAT = new DecimalFormat("##0.0################", SYMBOLS);
    }

    public static String toGaml(final Object val, final boolean includingBuiltIn) {
        if (val == null) {
            return "nil";
        }
        if (val instanceof IGamlable) {
            return ((IGamlable) val).serialize(includingBuiltIn);
        }
        if (val instanceof String) {
            return toGamlString((String) val);
        }
        if (val instanceof Double) {
            return DEFAULT_DECIMAL_FORMAT.format(val);
        }
        if (val instanceof Collection) {
            final IList l = GamaListFactory.create(Types.STRING);
            l.addAll((Collection) val);
            return toGaml(l, includingBuiltIn);
        }
        return String.valueOf(val);
    }

}