All Downloads are FREE. Search and download functionalities are using the official Maven repository.

soot.util.StringTools Maven / Gradle / Ivy

There is a newer version: 2.5.0-9
Show newest version
/* Soot - a J*va Optimization Framework
 * Copyright (C) 1997-1999 Raja Vallee-Rai
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/*
 * Modified by the Sable Research Group and others 1997-1999.  
 * See the 'credits' file distributed with Soot for the complete list of
 * contributors.  (Soot is distributed at http://www.sable.mcgill.ca/soot)
 */

/* 04.04.2006 mbatch  added handling of \r, as compilers throw error if unicode */

package soot.util;

import java.text.*;

/** Utility methods for string manipulations commonly used in Soot. */
public class StringTools
{

    /** Returns fromString, but with non-isalpha() characters printed as
     * '\\unnnn'.  Used by SootClass to generate output. */
    public static java.lang.String getEscapedStringOf(String fromString)
    {
       char[] fromStringArray;
       int cr, lf, ch;
        StringBuffer whole = new StringBuffer();
        StringBuffer mini = new StringBuffer();

       fromStringArray = fromString.toCharArray();

       cr = lineSeparator.charAt(0);
       lf = -1;

       if (lineSeparator.length() == 2)
           lf = lineSeparator.charAt(1);

       for (char element : fromStringArray) {
           ch = element;
           if (((ch >= 32 && ch <= 126) || ch == cr || ch == lf) && ch != '\\')
           {
               whole.append((char) ch);

               continue;
           }
           
           mini.setLength(0);
           mini.append(Integer.toHexString(ch));

           while (mini.length() < 4)
               mini.insert(0, "0");

           mini.insert(0, "\\u");
           whole.append(mini.toString());
       }

       return whole.toString();
    }

    /** Convenience field storing the system line separator. */
    public final static String lineSeparator = System.getProperty("line.separator");;

    /** Returns fromString, but with certain characters printed as
     * if they were in a Java string literal.  
     * Used by StringConstant.toString() */
    public static java.lang.String getQuotedStringOf(String fromString)
    {
        StringBuffer toStringBuffer;
        char[] fromStringArray;

        toStringBuffer = new java.lang.StringBuffer();
        fromStringArray = fromString.toCharArray();

        toStringBuffer.append("\"");

        for (char ch : fromStringArray) {
            {
              if (ch == '\\')
                { toStringBuffer.append("\\\\"); continue; }
              if (ch == '\'')
                { toStringBuffer.append("\\\'"); continue; }
              if (ch == '\"')
                { toStringBuffer.append("\\\""); continue; }
              if (ch == '\n')
                { toStringBuffer.append("\\n"); continue; }
              if (ch == '\t')
                { toStringBuffer.append("\\t"); continue; }
              /* 04.04.2006 mbatch  added handling of \r, as compilers throw error if unicode */ 
              if (ch == '\r')
              { toStringBuffer.append("\\r"); continue; }
              /* 10.04.2006 Nomait A Naeem  added handling of \f, as compilers throw error if unicode */
              if(ch == '\f')
              { toStringBuffer.append("\\f"); continue; }
              else if(ch >= 32 && ch <= 126)
                {toStringBuffer.append(ch); continue;}
            }
            
            toStringBuffer.append(getUnicodeStringFromChar(ch));
        }

        toStringBuffer.append("\"");
        return toStringBuffer.toString();
    }

    /** Returns a String containing the escaped \\unnnn
     * representation for ch. */
    public static String getUnicodeStringFromChar(char ch)
    {
        String s = Integer.toHexString(ch);
        String padding = null;
        
        switch(s.length()) {
        case 1:
            padding = "000";
            break;
        case 2:
            padding = "00";
            break;
        case 3:
            padding = "0";
            break;
        case 4:
            padding = "";
            break;
        }   
        
        return "\\u" + padding + s;
    }
  
    /** Returns a String de-escaping the \\unnnn
     * representation for any escaped characters in the string. */
    public static String getUnEscapedStringOf(String str) 
    {
        StringBuffer buf = new StringBuffer();
        CharacterIterator iter = new StringCharacterIterator(str);
        
        for(char ch = iter.first(); ch != CharacterIterator.DONE; ch = iter.next()) 
        {
            if (ch != '\\') 
                buf.append(ch);
            else 
            {  // enter escaped mode
                ch = iter.next();
                char format;

                if(ch == '\\') 
                    buf.append(ch);
                else if ( (format = getCFormatChar(ch)) != '\0') 
                    buf.append(format);
                else if(ch == 'u') 
                {  //enter unicode mode
                    StringBuffer mini = new StringBuffer(4);
                    for(int i = 0; i <4; i++)
                        mini.append(iter.next());
                    
                    ch = (char) Integer.parseInt(mini.toString(), 16);
                    buf.append(ch); 
                } else {
                    throw new RuntimeException("Unexpected char: " + ch);
                }
            }
        }
        return buf.toString();
    }

    /** Returns the canonical C-string representation of c. */
    public static char getCFormatChar(char c)
    {
        char res;

        switch(c) {
        case 'n':
            res = '\n';
            break;
        case 't':
            res = '\t';
            break;
        case 'r':
            res = '\r';
            break;
        case 'b':
            res = '\b';
            break;
        case '\"':
            res = '\"';
            break;
        case '\'':
            res = '\'';
            break;
            
        default:
            res = '\0';
            break;
        } 
        return res;
    }

    /**
     * Replaces all occurrences of the given substring with the
     * given replacement string.
     *
     * @param orig The string in which all occurrences of the substring
     *             are to be replaced.
     *
     * @param toBeReplaced The substring which is to be replaced.
     *
     * @param replacment The string which is to replace 
     *                   toBeReplaced. 
     *
     * @return The resulting {@link String}.
     *
     * 

This method provides a facility similar to the * String.replaceAll() method available in Java 1.4, except that * it can only replace substrings rather than regular expressions. * So if Soot ever abandons compatibility with pre-1.4 * definitions of the Java API, it can also abandon replaceAllIn(). */ public static String replaceAll(String orig, String toBeReplaced, String replacement) { int quarryLength = toBeReplaced.length(); if (quarryLength <= 0) { return orig; } int index = orig.indexOf(toBeReplaced); if (index < 0) { return orig; } else { int from = 0; StringBuffer sb; if (quarryLength < replacement.length()) { sb = new StringBuffer(orig.length()); } else { sb = new StringBuffer(orig.length() * 2); } do { sb.append(orig.substring(from, index)); sb.append(replacement); from = index + quarryLength; index = orig.indexOf(toBeReplaced, from); } while (index >= 0); sb.append(orig.substring(from)); return sb.toString(); } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy