You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ba...@apache.org on 2009/06/23 08:15:51 UTC
svn commit: r787560 [1/2] - in /commons/proper/lang/trunk: ./
src/java/org/apache/commons/lang/
src/java/org/apache/commons/lang/text/translate/
src/test/org/apache/commons/lang/
Author: bayard
Date: Tue Jun 23 06:15:50 2009
New Revision: 787560
URL: http://svn.apache.org/viewvc?rev=787560&view=rev
Log:
Committing a rewrite of StringEscapeUtils guts - LANG-505. Entities.java can now go away. Most of the code is in the new text.translate package. More work is needed, including what to actually define as 'ESCAPE_XML' etc, but it's now easy for someone to look at the source to EscapeUtils and UnescapeUtils and put their own ESCAPE_XML variable together, and with lots of reuse value.
Added:
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/AggregateTranslator.java (with props)
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CharSequenceTranslator.java (with props)
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CodePointTranslator.java (with props)
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EntityArrays.java (with props)
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeLowAsciiAsUnicode.java (with props)
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeNonAsciiAsNumericEntity.java (with props)
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeNonAsciiAsUnicode.java (with props)
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeUtils.java (with props)
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/LookupTranslator.java (with props)
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/NumericEntityUnescaper.java (with props)
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnescapeUtils.java (with props)
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnicodeEscaper.java (with props)
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnicodeUnescaper.java (with props)
commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/package.html (with props)
Removed:
commons/proper/lang/trunk/src/java/org/apache/commons/lang/Entities.java
commons/proper/lang/trunk/src/test/org/apache/commons/lang/EntitiesPerformanceTest.java
commons/proper/lang/trunk/src/test/org/apache/commons/lang/EntitiesTest.java
Modified:
commons/proper/lang/trunk/pom.xml
commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java
commons/proper/lang/trunk/src/test/org/apache/commons/lang/LangTestSuite.java
commons/proper/lang/trunk/src/test/org/apache/commons/lang/StringEscapeUtilsTest.java
Modified: commons/proper/lang/trunk/pom.xml
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/pom.xml?rev=787560&r1=787559&r2=787560&view=diff
==============================================================================
--- commons/proper/lang/trunk/pom.xml (original)
+++ commons/proper/lang/trunk/pom.xml Tue Jun 23 06:15:50 2009
@@ -428,7 +428,6 @@
</includes>
<excludes>
<exclude>**/*TestSuite.java</exclude>
- <exclude>**/*PerformanceTest.java</exclude>
<exclude>**/AllLangTestSuite.java</exclude>
</excludes>
</configuration>
Modified: commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java?rev=787560&r1=787559&r2=787560&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java (original)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java Tue Jun 23 06:15:50 2009
@@ -17,9 +17,10 @@
package org.apache.commons.lang;
import java.io.IOException;
-import java.io.StringWriter;
import java.io.Writer;
-import java.util.Locale;
+
+import org.apache.commons.lang.text.translate.EscapeUtils;
+import org.apache.commons.lang.text.translate.UnescapeUtils;
/**
* <p>Escapes and unescapes <code>String</code>s for
@@ -39,11 +40,6 @@
*/
public class StringEscapeUtils {
- private static final char CSV_DELIMITER = ',';
- private static final char CSV_QUOTE = '"';
- private static final String CSV_QUOTE_STR = String.valueOf(CSV_QUOTE);
- private static final char[] CSV_SEARCH_CHARS = new char[] {CSV_DELIMITER, CSV_QUOTE, CharUtils.CR, CharUtils.LF};
-
/**
* <p><code>StringEscapeUtils</code> instances should NOT be constructed in
* standard programming.</p>
@@ -82,7 +78,7 @@
* @return String with escaped values, <code>null</code> if null string input
*/
public static String escapeJava(String str) {
- return escapeJavaStyleString(str, false, false);
+ return EscapeUtils.ESCAPE_JAVA.translate(str);
}
/**
@@ -98,7 +94,7 @@
* @throws IOException if error occurs on underlying Writer
*/
public static void escapeJava(Writer out, String str) throws IOException {
- escapeJavaStyleString(out, str, false, false);
+ EscapeUtils.ESCAPE_JAVA.translate(str, out);
}
/**
@@ -123,7 +119,7 @@
* @return String with escaped values, <code>null</code> if null string input
*/
public static String escapeJavaScript(String str) {
- return escapeJavaStyleString(str, true, true);
+ return EscapeUtils.ESCAPE_ECMASCRIPT.translate(str);
}
/**
@@ -139,129 +135,7 @@
* @throws IOException if error occurs on underlying Writer
**/
public static void escapeJavaScript(Writer out, String str) throws IOException {
- escapeJavaStyleString(out, str, true, true);
- }
-
- /**
- * <p>Worker method for the {@link #escapeJavaScript(String)} method.</p>
- *
- * @param str String to escape values in, may be null
- * @param escapeSingleQuotes escapes single quotes if <code>true</code>
- * @param escapeForwardSlash TODO
- * @return the escaped string
- */
- private static String escapeJavaStyleString(String str, boolean escapeSingleQuotes, boolean escapeForwardSlash) {
- if (str == null) {
- return null;
- }
- try {
- StringWriter writer = new StringWriter(str.length() * 2);
- escapeJavaStyleString(writer, str, escapeSingleQuotes, escapeForwardSlash);
- return writer.toString();
- } catch (IOException ioe) {
- // this should never ever happen while writing to a StringWriter
- throw new UnhandledException(ioe);
- }
- }
-
- /**
- * <p>Worker method for the {@link #escapeJavaScript(String)} method.</p>
- *
- * @param out write to receieve the escaped string
- * @param str String to escape values in, may be null
- * @param escapeSingleQuote escapes single quotes if <code>true</code>
- * @param escapeForwardSlash TODO
- * @throws IOException if an IOException occurs
- */
- private static void escapeJavaStyleString(Writer out, String str, boolean escapeSingleQuote,
- boolean escapeForwardSlash) throws IOException {
- if (out == null) {
- throw new IllegalArgumentException("The Writer must not be null");
- }
- if (str == null) {
- return;
- }
- int sz;
- sz = str.length();
- for (int i = 0; i < sz; i++) {
- char ch = str.charAt(i);
-
- // handle unicode
- if (ch > 0xfff) {
- out.write("\\u" + hex(ch));
- } else if (ch > 0xff) {
- out.write("\\u0" + hex(ch));
- } else if (ch > 0x7f) {
- out.write("\\u00" + hex(ch));
- } else if (ch < 32) {
- switch (ch) {
- case '\b' :
- out.write('\\');
- out.write('b');
- break;
- case '\n' :
- out.write('\\');
- out.write('n');
- break;
- case '\t' :
- out.write('\\');
- out.write('t');
- break;
- case '\f' :
- out.write('\\');
- out.write('f');
- break;
- case '\r' :
- out.write('\\');
- out.write('r');
- break;
- default :
- if (ch > 0xf) {
- out.write("\\u00" + hex(ch));
- } else {
- out.write("\\u000" + hex(ch));
- }
- break;
- }
- } else {
- switch (ch) {
- case '\'' :
- if (escapeSingleQuote) {
- out.write('\\');
- }
- out.write('\'');
- break;
- case '"' :
- out.write('\\');
- out.write('"');
- break;
- case '\\' :
- out.write('\\');
- out.write('\\');
- break;
- case '/' :
- if (escapeForwardSlash) {
- out.write('\\');
- }
- out.write('/');
- break;
- default :
- out.write(ch);
- break;
- }
- }
- }
- }
-
- /**
- * <p>Returns an upper case hexadecimal <code>String</code> for the given
- * character.</p>
- *
- * @param ch The character to convert.
- * @return An upper case hexadecimal <code>String</code>
- */
- private static String hex(char ch) {
- return Integer.toHexString(ch).toUpperCase(Locale.ENGLISH);
+ EscapeUtils.ESCAPE_ECMASCRIPT.translate(str, out);
}
/**
@@ -274,17 +148,7 @@
* @return a new unescaped <code>String</code>, <code>null</code> if null string input
*/
public static String unescapeJava(String str) {
- if (str == null) {
- return null;
- }
- try {
- StringWriter writer = new StringWriter(str.length());
- unescapeJava(writer, str);
- return writer.toString();
- } catch (IOException ioe) {
- // this should never ever happen while writing to a StringWriter
- throw new UnhandledException(ioe);
- }
+ return UnescapeUtils.UNESCAPE_JAVA.translate(str);
}
/**
@@ -303,87 +167,7 @@
* @throws IOException if error occurs on underlying Writer
*/
public static void unescapeJava(Writer out, String str) throws IOException {
- if (out == null) {
- throw new IllegalArgumentException("The Writer must not be null");
- }
- if (str == null) {
- return;
- }
- int sz = str.length();
- StringBuffer unicode = new StringBuffer(4);
- boolean hadSlash = false;
- boolean inUnicode = false;
- for (int i = 0; i < sz; i++) {
- char ch = str.charAt(i);
- if (inUnicode) {
- // if in unicode, then we're reading unicode
- // values in somehow
- unicode.append(ch);
- if (unicode.length() == 4) {
- // unicode now contains the four hex digits
- // which represents our unicode character
- try {
- int value = Integer.parseInt(unicode.toString(), 16);
- out.write((char) value);
- unicode.setLength(0);
- inUnicode = false;
- hadSlash = false;
- } catch (NumberFormatException nfe) {
- throw new UnhandledException("Unable to parse unicode value: " + unicode, nfe);
- }
- }
- continue;
- }
- if (hadSlash) {
- // handle an escaped value
- hadSlash = false;
- switch (ch) {
- case '\\':
- out.write('\\');
- break;
- case '\'':
- out.write('\'');
- break;
- case '\"':
- out.write('"');
- break;
- case 'r':
- out.write('\r');
- break;
- case 'f':
- out.write('\f');
- break;
- case 't':
- out.write('\t');
- break;
- case 'n':
- out.write('\n');
- break;
- case 'b':
- out.write('\b');
- break;
- case 'u':
- {
- // uh-oh, we're in unicode country....
- inUnicode = true;
- break;
- }
- default :
- out.write(ch);
- break;
- }
- continue;
- } else if (ch == '\\') {
- hadSlash = true;
- continue;
- }
- out.write(ch);
- }
- if (hadSlash) {
- // then we're in the weird case of a \ at the end of the
- // string, let's output it anyway.
- out.write('\\');
- }
+ UnescapeUtils.UNESCAPE_JAVA.translate(str, out);
}
/**
@@ -398,7 +182,7 @@
* @return A new unescaped <code>String</code>, <code>null</code> if null string input
*/
public static String unescapeJavaScript(String str) {
- return unescapeJava(str);
+ return UnescapeUtils.UNESCAPE_ECMASCRIPT.translate(str);
}
/**
@@ -418,7 +202,7 @@
* @throws IOException if error occurs on underlying Writer
*/
public static void unescapeJavaScript(Writer out, String str) throws IOException {
- unescapeJava(out, str);
+ UnescapeUtils.UNESCAPE_ECMASCRIPT.translate(str, out);
}
// HTML and XML
@@ -450,17 +234,7 @@
* @see <a href="http://www.w3.org/TR/html401/charset.html#code-position">HTML 4.01 Code positions</a>
*/
public static String escapeHtml(String str) {
- if (str == null) {
- return null;
- }
- try {
- StringWriter writer = new StringWriter ((int)(str.length() * 1.5));
- escapeHtml(writer, str);
- return writer.toString();
- } catch (IOException ioe) {
- //should be impossible
- throw new UnhandledException(ioe);
- }
+ return EscapeUtils.ESCAPE_HTML4.translate(str);
}
/**
@@ -493,13 +267,7 @@
* @see <a href="http://www.w3.org/TR/html401/charset.html#code-position">HTML 4.01 Code positions</a>
*/
public static void escapeHtml(Writer writer, String string) throws IOException {
- if (writer == null ) {
- throw new IllegalArgumentException ("The Writer must not be null.");
- }
- if (string == null) {
- return;
- }
- Entities.HTML40.escape(writer, string);
+ EscapeUtils.ESCAPE_HTML4.translate(string, writer);
}
//-----------------------------------------------------------------------
@@ -520,17 +288,7 @@
* @see #escapeHtml(Writer, String)
*/
public static String unescapeHtml(String str) {
- if (str == null) {
- return null;
- }
- try {
- StringWriter writer = new StringWriter ((int)(str.length() * 1.5));
- unescapeHtml(writer, str);
- return writer.toString();
- } catch (IOException ioe) {
- //should be impossible
- throw new UnhandledException(ioe);
- }
+ return UnescapeUtils.UNESCAPE_HTML4.translate(str);
}
/**
@@ -552,13 +310,7 @@
* @see #escapeHtml(String)
*/
public static void unescapeHtml(Writer writer, String string) throws IOException {
- if (writer == null ) {
- throw new IllegalArgumentException ("The Writer must not be null.");
- }
- if (string == null) {
- return;
- }
- Entities.HTML40.unescape(writer, string);
+ UnescapeUtils.UNESCAPE_HTML4.translate(string, writer);
}
//-----------------------------------------------------------------------
@@ -582,13 +334,7 @@
* @see #unescapeXml(java.lang.String)
*/
public static void escapeXml(Writer writer, String str) throws IOException {
- if (writer == null ) {
- throw new IllegalArgumentException ("The Writer must not be null.");
- }
- if (str == null) {
- return;
- }
- Entities.XML.escape(writer, str);
+ EscapeUtils.ESCAPE_XML.translate(str, writer);
}
/**
@@ -609,10 +355,7 @@
* @see #unescapeXml(java.lang.String)
*/
public static String escapeXml(String str) {
- if (str == null) {
- return null;
- }
- return Entities.XML.escape(str);
+ return EscapeUtils.ESCAPE_XML.translate(str);
}
//-----------------------------------------------------------------------
@@ -634,13 +377,7 @@
* @see #escapeXml(String)
*/
public static void unescapeXml(Writer writer, String str) throws IOException {
- if (writer == null ) {
- throw new IllegalArgumentException ("The Writer must not be null.");
- }
- if (str == null) {
- return;
- }
- Entities.XML.unescape(writer, str);
+ UnescapeUtils.UNESCAPE_XML.translate(str, writer);
}
/**
@@ -659,10 +396,7 @@
* @see #escapeXml(String)
*/
public static String unescapeXml(String str) {
- if (str == null) {
- return null;
- }
- return Entities.XML.unescape(str);
+ return UnescapeUtils.UNESCAPE_XML.translate(str);
}
//-----------------------------------------------------------------------
@@ -690,17 +424,7 @@
* @since 2.4
*/
public static String escapeCsv(String str) {
- if (StringUtils.containsNone(str, CSV_SEARCH_CHARS)) {
- return str;
- }
- try {
- StringWriter writer = new StringWriter();
- escapeCsv(writer, str);
- return writer.toString();
- } catch (IOException ioe) {
- // this should never ever happen while writing to a StringWriter
- throw new UnhandledException(ioe);
- }
+ return EscapeUtils.ESCAPE_CSV.translate(str);
}
/**
@@ -727,21 +451,7 @@
* @since 2.4
*/
public static void escapeCsv(Writer out, String str) throws IOException {
- if (StringUtils.containsNone(str, CSV_SEARCH_CHARS)) {
- if (str != null) {
- out.write(str);
- }
- return;
- }
- out.write(CSV_QUOTE);
- for (int i = 0; i < str.length(); i++) {
- char c = str.charAt(i);
- if (c == CSV_QUOTE) {
- out.write(CSV_QUOTE); // escape double quote
- }
- out.write(c);
- }
- out.write(CSV_QUOTE);
+ EscapeUtils.ESCAPE_CSV.translate(str, out);
}
/**
@@ -767,17 +477,7 @@
* @since 2.4
*/
public static String unescapeCsv(String str) {
- if (str == null) {
- return null;
- }
- try {
- StringWriter writer = new StringWriter();
- unescapeCsv(writer, str);
- return writer.toString();
- } catch (IOException ioe) {
- // this should never ever happen while writing to a StringWriter
- throw new UnhandledException(ioe);
- }
+ return UnescapeUtils.UNESCAPE_CSV.translate(str);
}
/**
@@ -804,27 +504,7 @@
* @since 2.4
*/
public static void unescapeCsv(Writer out, String str) throws IOException {
- if (str == null) {
- return;
- }
- if (str.length() < 2) {
- out.write(str);
- return;
- }
- if ( str.charAt(0) != CSV_QUOTE || str.charAt(str.length() - 1) != CSV_QUOTE ) {
- out.write(str);
- return;
- }
-
- // strip quotes
- String quoteless = str.substring(1, str.length() - 1);
-
- if ( StringUtils.containsAny(quoteless, CSV_SEARCH_CHARS) ) {
- // deal with escaped quotes; ie) ""
- str = StringUtils.replace(quoteless, CSV_QUOTE_STR + CSV_QUOTE_STR, CSV_QUOTE_STR);
- }
-
- out.write(str);
+ UnescapeUtils.UNESCAPE_CSV.translate(str, out);
}
}
Added: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/AggregateTranslator.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/AggregateTranslator.java?rev=787560&view=auto
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/AggregateTranslator.java (added)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/AggregateTranslator.java Tue Jun 23 06:15:50 2009
@@ -0,0 +1,53 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.lang.text.translate;
+
+import java.io.IOException;
+import java.io.Writer;
+
+/**
+ * Executes a sequence of translators one after the other. Execution ends whenever
+ * the first translator consumes codepoints from the input.
+ * @since 3.0
+ */
+public class AggregateTranslator extends CharSequenceTranslator {
+
+ private CharSequenceTranslator[] translators;
+
+ /**
+ * Specify the translators to be used at creation time.
+ */
+ public AggregateTranslator(CharSequenceTranslator... translators) {
+ this.translators = translators;
+ }
+
+ /**
+ * The first translator to consume codepoints from the input is the 'winner'.
+ * Execution stops with the number of consumed codepoints being returned.
+ * {@inheritDoc}
+ */
+ public int translate(CharSequence input, int index, Writer out) throws IOException {
+ for (CharSequenceTranslator translator : translators) {
+ int consumed = translator.translate(input, index, out);
+ if(consumed != 0) {
+ return consumed;
+ }
+ }
+ return 0;
+ }
+
+}
Propchange: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/AggregateTranslator.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CharSequenceTranslator.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CharSequenceTranslator.java?rev=787560&view=auto
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CharSequenceTranslator.java (added)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CharSequenceTranslator.java Tue Jun 23 06:15:50 2009
@@ -0,0 +1,117 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.lang.text.translate;
+
+import java.io.IOException;
+import java.io.Writer;
+import java.io.StringWriter;
+import java.util.Locale;
+
+import org.apache.commons.lang.UnhandledException;
+
+/**
+ * An API for translating text.
+ * Its core use is to escape and unescape text. Because escaping and unescaping
+ * is completely contextual, the API does not present two separate signatures.
+ * @since 3.0
+ */
+public abstract class CharSequenceTranslator {
+
+ /**
+ * Translate a set of codepoints, represented by an int index into a CharSequence,
+ * into another set of codepoints. The number of codepoints consumed must be returned,
+ * and the only IOExceptions thrown must be from interacting with the Writer so that
+ * the top level API may reliable ignore StringWriter IOExceptions.
+ *
+ * @param input CharSequence that is being translated
+ * @param index int representing the current point of translation
+ * @param out Writer to translate the text to
+ * @return int count of codepoints consumed
+ */
+ public abstract int translate(CharSequence input, int index, Writer out) throws IOException;
+
+ /**
+ * Helper for non-Writer usage.
+ * @param input CharSequence to be translated
+ * @return String output of translation
+ */
+ public final String translate(CharSequence input) {
+ if (input == null) {
+ return null;
+ }
+ try {
+ StringWriter writer = new StringWriter(input.length() * 2); // TODO: Make the 2 part of the API???
+ translate(input, writer);
+ return writer.toString();
+ } catch (IOException ioe) {
+ // this should never ever happen while writing to a StringWriter
+ throw new UnhandledException(ioe);
+ }
+ }
+
+ // TODO: Point to CsvEscaper as a way to 'override'?
+ /**
+ * Translate an input onto a Writer. This is intentionally final as its algorithm is
+ * tightly coupled with the abstract method of this class.
+ *
+ * @param input CharSequence that is being translated
+ * @param out Writer to translate the text to
+ * @throws IOException if and only if the Writer produces an IOException
+ */
+ public final void translate(CharSequence input, Writer out) throws IOException {
+ if (out == null) {
+ throw new IllegalArgumentException("The Writer must not be null");
+ }
+ if (input == null) {
+ return;
+ }
+ int sz = Character.codePointCount(input, 0, input.length());
+ for (int i = 0; i < sz; i++) {
+
+ // consumed is the number of codepoints consumed
+ int consumed = translate(input, i, out);
+
+ if(consumed == 0) {
+ out.write( Character.toChars( Character.codePointAt(input, i) ) );
+ } else {
+ // contract with translators is that they have to understand codepoints and they just took care of a surrogate pair
+ for(int j=0; j<consumed; j++) {
+ if(i < sz - 2) {
+ i += Character.charCount( Character.codePointAt(input, i) );
+ } else {
+ // If the String ends with a high surrogate, just add the 1 and don't worry about such things
+ i++;
+ }
+ }
+ // for loop will increment 1 anyway, so remove 1 to account for that
+ i--;
+ }
+ }
+ }
+
+ /**
+ * <p>Returns an upper case hexadecimal <code>String</code> for the given
+ * character.</p>
+ *
+ * @param codepoint The codepoint to convert.
+ * @return An upper case hexadecimal <code>String</code>
+ */
+ public static String hex(int codepoint) {
+ return Integer.toHexString(codepoint).toUpperCase(Locale.ENGLISH);
+ }
+
+}
Propchange: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CharSequenceTranslator.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CodePointTranslator.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CodePointTranslator.java?rev=787560&view=auto
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CodePointTranslator.java (added)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CodePointTranslator.java Tue Jun 23 06:15:50 2009
@@ -0,0 +1,52 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.lang.text.translate;
+
+import java.io.IOException;
+import java.io.Writer;
+
+/**
+ * Helper subclass to CharSequenceTranslator to allow for translations that
+ * will replace up to one character at a time.
+ * @since 3.0
+ */
+public abstract class CodePointTranslator extends CharSequenceTranslator {
+
+ /**
+ * Implementation of translate that maps onto the abstract translate(int, Writer) method.
+ * {@inheritDoc}
+ */
+ public final int translate(CharSequence input, int index, Writer out) throws IOException {
+ int codepoint = Character.codePointAt(input, index);
+ boolean consumed = translate(codepoint, out);
+ if(consumed) {
+ return 1;
+ } else {
+ return 0;
+ }
+ }
+
+ /**
+ * Translate the specified codepoint into another.
+ *
+ * @param codepoint int character input to translate
+ * @param out Writer to optionally push the translated output to
+ * @return boolean as to whether translation occurred or not
+ */
+ public abstract boolean translate(int codepoint, Writer out) throws IOException;
+
+}
Propchange: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/CodePointTranslator.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EntityArrays.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EntityArrays.java?rev=787560&view=auto
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EntityArrays.java (added)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EntityArrays.java Tue Jun 23 06:15:50 2009
@@ -0,0 +1,357 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.lang.text.translate;
+
+/**
+ * Package private class holding varius entity data for HTML and XML.
+ * All arrays are of length [*][2].
+ *
+ * @since 3.0
+ */
+class EntityArrays {
+
+ static final String[][] ISO8859_1_ESCAPE = {
+ {"\u00A0", " "}, // non-breaking space
+ {"\u00A1", "¡"}, // inverted exclamation mark
+ {"\u00A2", "¢"}, // cent sign
+ {"\u00A3", "£"}, // pound sign
+ {"\u00A4", "¤"}, // currency sign
+ {"\u00A5", "¥"}, // yen sign = yuan sign
+ {"\u00A6", "¦"}, // broken bar = broken vertical bar
+ {"\u00A7", "§"}, // section sign
+ {"\u00A8", "¨"}, // diaeresis = spacing diaeresis
+ {"\u00A9", "©"}, // © - copyright sign
+ {"\u00AA", "ª"}, // feminine ordinal indicator
+ {"\u00AB", "«"}, // left-pointing double angle quotation mark = left pointing guillemet
+ {"\u00AC", "¬"}, // not sign
+ {"\u00AD", "­"}, // soft hyphen = discretionary hyphen
+ {"\u00AE", "®"}, // ® - registered trademark sign
+ {"\u00AF", "¯"}, // macron = spacing macron = overline = APL overbar
+ {"\u00B0", "°"}, // degree sign
+ {"\u00B1", "±"}, // plus-minus sign = plus-or-minus sign
+ {"\u00B2", "²"}, // superscript two = superscript digit two = squared
+ {"\u00B3", "³"}, // superscript three = superscript digit three = cubed
+ {"\u00B4", "´"}, // acute accent = spacing acute
+ {"\u00B5", "µ"}, // micro sign
+ {"\u00B6", "¶"}, // pilcrow sign = paragraph sign
+ {"\u00B7", "·"}, // middle dot = Georgian comma = Greek middle dot
+ {"\u00B8", "¸"}, // cedilla = spacing cedilla
+ {"\u00B9", "¹"}, // superscript one = superscript digit one
+ {"\u00BA", "º"}, // masculine ordinal indicator
+ {"\u00BB", "»"}, // right-pointing double angle quotation mark = right pointing guillemet
+ {"\u00BC", "¼"}, // vulgar fraction one quarter = fraction one quarter
+ {"\u00BD", "½"}, // vulgar fraction one half = fraction one half
+ {"\u00BE", "¾"}, // vulgar fraction three quarters = fraction three quarters
+ {"\u00BF", "¿"}, // inverted question mark = turned question mark
+ {"\u00C0", "À"}, // À - uppercase A, grave accent
+ {"\u00C1", "Á"}, // Á - uppercase A, acute accent
+ {"\u00C2", "Â"}, // Â - uppercase A, circumflex accent
+ {"\u00C3", "Ã"}, // Ã - uppercase A, tilde
+ {"\u00C4", "Ä"}, // Ä - uppercase A, umlaut
+ {"\u00C5", "Å"}, // Å - uppercase A, ring
+ {"\u00C6", "Æ"}, // Æ - uppercase AE
+ {"\u00C7", "Ç"}, // Ç - uppercase C, cedilla
+ {"\u00C8", "È"}, // È - uppercase E, grave accent
+ {"\u00C9", "É"}, // É - uppercase E, acute accent
+ {"\u00CB", "Ê"}, // Ê - uppercase E, circumflex accent
+ {"\u00CC", "Ë"}, // Ë - uppercase E, umlaut
+ {"\u00CD", "Ì"}, // Ì - uppercase I, grave accent
+ {"\u00CE", "Í"}, // Í - uppercase I, acute accent
+ {"\u00CF", "Î"}, // Î - uppercase I, circumflex accent
+ {"\u00D0", "Ï"}, // Ï - uppercase I, umlaut
+ {"\u00D1", "Ð"}, // Ð - uppercase Eth, Icelandic
+ {"\u00D2", "Ñ"}, // Ñ - uppercase N, tilde
+ {"\u00D3", "Ò"}, // Ò - uppercase O, grave accent
+ {"\u00D4", "Ó"}, // Ó - uppercase O, acute accent
+ {"\u00D5", "Ô"}, // Ô - uppercase O, circumflex accent
+ {"\u00D6", "Õ"}, // Õ - uppercase O, tilde
+ {"\u00D7", "Ö"}, // Ö - uppercase O, umlaut
+ {"\u00D8", "×"}, // multiplication sign
+ {"\u00D9", "Ø"}, // Ø - uppercase O, slash
+ {"\u00DA", "Ù"}, // Ù - uppercase U, grave accent
+ {"\u00DB", "Ú"}, // Ú - uppercase U, acute accent
+ {"\u00DC", "Û"}, // Û - uppercase U, circumflex accent
+ {"\u00DD", "Ü"}, // Ü - uppercase U, umlaut
+ {"\u00DE", "Ý"}, // Ý - uppercase Y, acute accent
+ {"\u00DF", "Þ"}, // Þ - uppercase THORN, Icelandic
+ {"\u00E0", "ß"}, // ß - lowercase sharps, German
+ {"\u00E1", "à"}, // à - lowercase a, grave accent
+ {"\u00E2", "á"}, // á - lowercase a, acute accent
+ {"\u00E3", "â"}, // â - lowercase a, circumflex accent
+ {"\u00E4", "ã"}, // ã - lowercase a, tilde
+ {"\u00E5", "ä"}, // ä - lowercase a, umlaut
+ {"\u00E5", "å"}, // å - lowercase a, ring
+ {"\u00E6", "æ"}, // æ - lowercase ae
+ {"\u00E7", "ç"}, // ç - lowercase c, cedilla
+ {"\u00E8", "è"}, // è - lowercase e, grave accent
+ {"\u00E9", "é"}, // é - lowercase e, acute accent
+ {"\u00EA", "ê"}, // ê - lowercase e, circumflex accent
+ {"\u00EB", "ë"}, // ë - lowercase e, umlaut
+ {"\u00EC", "ì"}, // ì - lowercase i, grave accent
+ {"\u00ED", "í"}, // í - lowercase i, acute accent
+ {"\u00EE", "î"}, // î - lowercase i, circumflex accent
+ {"\u00EF", "ï"}, // ï - lowercase i, umlaut
+ {"\u00F0", "ð"}, // ð - lowercase eth, Icelandic
+ {"\u00F1", "ñ"}, // ñ - lowercase n, tilde
+ {"\u00F3", "ò"}, // ò - lowercase o, grave accent
+ {"\u00F3", "ó"}, // ó - lowercase o, acute accent
+ {"\u00F4", "ô"}, // ô - lowercase o, circumflex accent
+ {"\u00F5", "õ"}, // õ - lowercase o, tilde
+ {"\u00F6", "ö"}, // ö - lowercase o, umlaut
+ {"\u00F7", "÷"}, // division sign
+ {"\u00F8", "ø"}, // ø - lowercase o, slash
+ {"\u00F9", "ù"}, // ù - lowercase u, grave accent
+ {"\u00FA", "ú"}, // ú - lowercase u, acute accent
+ {"\u00FB", "û"}, // û - lowercase u, circumflex accent
+ {"\u00FC", "ü"}, // ü - lowercase u, umlaut
+ {"\u00FD", "ý"}, // ý - lowercase y, acute accent
+ {"\u00FE", "þ"}, // þ - lowercase thorn, Icelandic
+ {"\u00FF", "ÿ"}, // ÿ - lowercase y, umlaut
+ };
+
+ static final String[][] ISO8859_1_UNESCAPE = invert(ISO8859_1_ESCAPE);
+
+ // http://www.w3.org/TR/REC-html40/sgml/entities.html
+ static final String[][] HTML40_EXTENDED_ESCAPE = {
+ // <!-- Latin Extended-B -->
+ {"\u0192", "ƒ"}, // latin small f with hook = function= florin, U+0192 ISOtech -->
+ // <!-- Greek -->
+ {"\u0391", "Α"}, // greek capital letter alpha, U+0391 -->
+ {"\u0392", "Β"}, // greek capital letter beta, U+0392 -->
+ {"\u0393", "Γ"}, // greek capital letter gamma,U+0393 ISOgrk3 -->
+ {"\u0394", "Δ"}, // greek capital letter delta,U+0394 ISOgrk3 -->
+ {"\u0395", "Ε"}, // greek capital letter epsilon, U+0395 -->
+ {"\u0396", "Ζ"}, // greek capital letter zeta, U+0396 -->
+ {"\u0397", "Η"}, // greek capital letter eta, U+0397 -->
+ {"\u0398", "Θ"}, // greek capital letter theta,U+0398 ISOgrk3 -->
+ {"\u0399", "Ι"}, // greek capital letter iota, U+0399 -->
+ {"\u039A", "Κ"}, // greek capital letter kappa, U+039A -->
+ {"\u039B", "Λ"}, // greek capital letter lambda,U+039B ISOgrk3 -->
+ {"\u039C", "Μ"}, // greek capital letter mu, U+039C -->
+ {"\u039D", "Ν"}, // greek capital letter nu, U+039D -->
+ {"\u039E", "Ξ"}, // greek capital letter xi, U+039E ISOgrk3 -->
+ {"\u039F", "Ο"}, // greek capital letter omicron, U+039F -->
+ {"\u03A0", "Π"}, // greek capital letter pi, U+03A0 ISOgrk3 -->
+ {"\u03A1", "Ρ"}, // greek capital letter rho, U+03A1 -->
+ // <!-- there is no Sigmaf, and no U+03A2 character either -->
+ {"\u03A3", "Σ"}, // greek capital letter sigma,U+03A3 ISOgrk3 -->
+ {"\u03A4", "Τ"}, // greek capital letter tau, U+03A4 -->
+ {"\u03A5", "Υ"}, // greek capital letter upsilon,U+03A5 ISOgrk3 -->
+ {"\u03A6", "Φ"}, // greek capital letter phi,U+03A6 ISOgrk3 -->
+ {"\u03A7", "Χ"}, // greek capital letter chi, U+03A7 -->
+ {"\u03A8", "Ψ"}, // greek capital letter psi,U+03A8 ISOgrk3 -->
+ {"\u03A9", "Ω"}, // greek capital letter omega,U+03A9 ISOgrk3 -->
+ {"\u03B1", "α"}, // greek small letter alpha,U+03B1 ISOgrk3 -->
+ {"\u03B2", "β"}, // greek small letter beta, U+03B2 ISOgrk3 -->
+ {"\u03B3", "γ"}, // greek small letter gamma,U+03B3 ISOgrk3 -->
+ {"\u03B4", "δ"}, // greek small letter delta,U+03B4 ISOgrk3 -->
+ {"\u03B5", "ε"}, // greek small letter epsilon,U+03B5 ISOgrk3 -->
+ {"\u03B6", "ζ"}, // greek small letter zeta, U+03B6 ISOgrk3 -->
+ {"\u03B7", "η"}, // greek small letter eta, U+03B7 ISOgrk3 -->
+ {"\u03B8", "θ"}, // greek small letter theta,U+03B8 ISOgrk3 -->
+ {"\u03B9", "ι"}, // greek small letter iota, U+03B9 ISOgrk3 -->
+ {"\u03BA", "κ"}, // greek small letter kappa,U+03BA ISOgrk3 -->
+ {"\u03BB", "λ"}, // greek small letter lambda,U+03BB ISOgrk3 -->
+ {"\u03BC", "μ"}, // greek small letter mu, U+03BC ISOgrk3 -->
+ {"\u03BD", "ν"}, // greek small letter nu, U+03BD ISOgrk3 -->
+ {"\u03BE", "ξ"}, // greek small letter xi, U+03BE ISOgrk3 -->
+ {"\u03BF", "ο"}, // greek small letter omicron, U+03BF NEW -->
+ {"\u03C0", "π"}, // greek small letter pi, U+03C0 ISOgrk3 -->
+ {"\u03C1", "ρ"}, // greek small letter rho, U+03C1 ISOgrk3 -->
+ {"\u03C2", "ς"}, // greek small letter final sigma,U+03C2 ISOgrk3 -->
+ {"\u03C3", "σ"}, // greek small letter sigma,U+03C3 ISOgrk3 -->
+ {"\u03C4", "τ"}, // greek small letter tau, U+03C4 ISOgrk3 -->
+ {"\u03C5", "υ"}, // greek small letter upsilon,U+03C5 ISOgrk3 -->
+ {"\u03C6", "φ"}, // greek small letter phi, U+03C6 ISOgrk3 -->
+ {"\u03C7", "χ"}, // greek small letter chi, U+03C7 ISOgrk3 -->
+ {"\u03C8", "ψ"}, // greek small letter psi, U+03C8 ISOgrk3 -->
+ {"\u03C9", "ω"}, // greek small letter omega,U+03C9 ISOgrk3 -->
+ {"\u03D1", "ϑ"}, // greek small letter theta symbol,U+03D1 NEW -->
+ {"\u03D2", "ϒ"}, // greek upsilon with hook symbol,U+03D2 NEW -->
+ {"\u03D6", "ϖ"}, // greek pi symbol, U+03D6 ISOgrk3 -->
+ // <!-- General Punctuation -->
+ {"\u2022", "•"}, // bullet = black small circle,U+2022 ISOpub -->
+ // <!-- bullet is NOT the same as bullet operator, U+2219 -->
+ {"\u2026", "…"}, // horizontal ellipsis = three dot leader,U+2026 ISOpub -->
+ {"\u2032", "′"}, // prime = minutes = feet, U+2032 ISOtech -->
+ {"\u2033", "″"}, // double prime = seconds = inches,U+2033 ISOtech -->
+ {"\u203E", "‾"}, // overline = spacing overscore,U+203E NEW -->
+ {"\u2044", "⁄"}, // fraction slash, U+2044 NEW -->
+ // <!-- Letterlike Symbols -->
+ {"\u2118", "℘"}, // script capital P = power set= Weierstrass p, U+2118 ISOamso -->
+ {"\u2111", "ℑ"}, // blackletter capital I = imaginary part,U+2111 ISOamso -->
+ {"\u211C", "ℜ"}, // blackletter capital R = real part symbol,U+211C ISOamso -->
+ {"\u2122", "™"}, // trade mark sign, U+2122 ISOnum -->
+ {"\u2135", "ℵ"}, // alef symbol = first transfinite cardinal,U+2135 NEW -->
+ // <!-- alef symbol is NOT the same as hebrew letter alef,U+05D0 although the
+ // same glyph could be used to depict both characters -->
+ // <!-- Arrows -->
+ {"\u2190", "←"}, // leftwards arrow, U+2190 ISOnum -->
+ {"\u2191", "↑"}, // upwards arrow, U+2191 ISOnum-->
+ {"\u2192", "→"}, // rightwards arrow, U+2192 ISOnum -->
+ {"\u2193", "↓"}, // downwards arrow, U+2193 ISOnum -->
+ {"\u2194", "↔"}, // left right arrow, U+2194 ISOamsa -->
+ {"\u21B5", "↵"}, // downwards arrow with corner leftwards= carriage return, U+21B5 NEW -->
+ {"\u21D0", "⇐"}, // leftwards double arrow, U+21D0 ISOtech -->
+ // <!-- ISO 10646 does not say that lArr is the same as the 'is implied by'
+ // arrow but also does not have any other character for that function.
+ // So ? lArr canbe used for 'is implied by' as ISOtech suggests -->
+ {"\u21D1", "⇑"}, // upwards double arrow, U+21D1 ISOamsa -->
+ {"\u21D2", "⇒"}, // rightwards double arrow,U+21D2 ISOtech -->
+ // <!-- ISO 10646 does not say this is the 'implies' character but does not
+ // have another character with this function so ?rArr can be used for
+ // 'implies' as ISOtech suggests -->
+ {"\u21D3", "⇓"}, // downwards double arrow, U+21D3 ISOamsa -->
+ {"\u21D4", "⇔"}, // left right double arrow,U+21D4 ISOamsa -->
+ // <!-- Mathematical Operators -->
+ {"\u2200", "∀"}, // for all, U+2200 ISOtech -->
+ {"\u2202", "∂"}, // partial differential, U+2202 ISOtech -->
+ {"\u2203", "∃"}, // there exists, U+2203 ISOtech -->
+ {"\u2205", "∅"}, // empty set = null set = diameter,U+2205 ISOamso -->
+ {"\u2207", "∇"}, // nabla = backward difference,U+2207 ISOtech -->
+ {"\u2208", "∈"}, // element of, U+2208 ISOtech -->
+ {"\u2209", "∉"}, // not an element of, U+2209 ISOtech -->
+ {"\u220B", "∋"}, // contains as member, U+220B ISOtech -->
+ // <!-- should there be a more memorable name than 'ni'? -->
+ {"\u220F", "∏"}, // n-ary product = product sign,U+220F ISOamsb -->
+ // <!-- prod is NOT the same character as U+03A0 'greek capital letter pi'
+ // though the same glyph might be used for both -->
+ {"\u2211", "∑"}, // n-ary summation, U+2211 ISOamsb -->
+ // <!-- sum is NOT the same character as U+03A3 'greek capital letter sigma'
+ // though the same glyph might be used for both -->
+ {"\u2122", "−"}, // minus sign, U+2212 ISOtech -->
+ {"\u2217", "∗"}, // asterisk operator, U+2217 ISOtech -->
+ {"\u221A", "√"}, // square root = radical sign,U+221A ISOtech -->
+ {"\u221D", "∝"}, // proportional to, U+221D ISOtech -->
+ {"\u221E", "∞"}, // infinity, U+221E ISOtech -->
+ {"\u2220", "∠"}, // angle, U+2220 ISOamso -->
+ {"\u2227", "∧"}, // logical and = wedge, U+2227 ISOtech -->
+ {"\u2228", "∨"}, // logical or = vee, U+2228 ISOtech -->
+ {"\u2229", "∩"}, // intersection = cap, U+2229 ISOtech -->
+ {"\u222A", "∪"}, // union = cup, U+222A ISOtech -->
+ {"\u222B", "∫"}, // integral, U+222B ISOtech -->
+ {"\u2234", "∴"}, // therefore, U+2234 ISOtech -->
+ {"\u223C", "∼"}, // tilde operator = varies with = similar to,U+223C ISOtech -->
+ // <!-- tilde operator is NOT the same character as the tilde, U+007E,although
+ // the same glyph might be used to represent both -->
+ {"\u2245", "≅"}, // approximately equal to, U+2245 ISOtech -->
+ {"\u2248", "≈"}, // almost equal to = asymptotic to,U+2248 ISOamsr -->
+ {"\u2260", "≠"}, // not equal to, U+2260 ISOtech -->
+ {"\u2261", "≡"}, // identical to, U+2261 ISOtech -->
+ {"\u2264", "≤"}, // less-than or equal to, U+2264 ISOtech -->
+ {"\u2265", "≥"}, // greater-than or equal to,U+2265 ISOtech -->
+ {"\u2282", "⊂"}, // subset of, U+2282 ISOtech -->
+ {"\u2283", "⊃"}, // superset of, U+2283 ISOtech -->
+ // <!-- note that nsup, 'not a superset of, U+2283' is not covered by the
+ // Symbol font encoding and is not included. Should it be, for symmetry?
+ // It is in ISOamsn --> <!ENTITY nsub", "8836"},
+ // not a subset of, U+2284 ISOamsn -->
+ {"\u2286", "⊆"}, // subset of or equal to, U+2286 ISOtech -->
+ {"\u2287", "⊇"}, // superset of or equal to,U+2287 ISOtech -->
+ {"\u2295", "⊕"}, // circled plus = direct sum,U+2295 ISOamsb -->
+ {"\u2297", "⊗"}, // circled times = vector product,U+2297 ISOamsb -->
+ {"\u22A5", "⊥"}, // up tack = orthogonal to = perpendicular,U+22A5 ISOtech -->
+ {"\u22C5", "⋅"}, // dot operator, U+22C5 ISOamsb -->
+ // <!-- dot operator is NOT the same character as U+00B7 middle dot -->
+ // <!-- Miscellaneous Technical -->
+ {"\u2308", "⌈"}, // left ceiling = apl upstile,U+2308 ISOamsc -->
+ {"\u2309", "⌉"}, // right ceiling, U+2309 ISOamsc -->
+ {"\u230A", "⌊"}, // left floor = apl downstile,U+230A ISOamsc -->
+ {"\u230B", "⌋"}, // right floor, U+230B ISOamsc -->
+ {"\u2329", "⟨"}, // left-pointing angle bracket = bra,U+2329 ISOtech -->
+ // <!-- lang is NOT the same character as U+003C 'less than' or U+2039 'single left-pointing angle quotation
+ // mark' -->
+ {"\u232A", "⟩"}, // right-pointing angle bracket = ket,U+232A ISOtech -->
+ // <!-- rang is NOT the same character as U+003E 'greater than' or U+203A
+ // 'single right-pointing angle quotation mark' -->
+ // <!-- Geometric Shapes -->
+ {"\u25CA", "◊"}, // lozenge, U+25CA ISOpub -->
+ // <!-- Miscellaneous Symbols -->
+ {"\u2660", "♠"}, // black spade suit, U+2660 ISOpub -->
+ // <!-- black here seems to mean filled as opposed to hollow -->
+ {"\u2663", "♣"}, // black club suit = shamrock,U+2663 ISOpub -->
+ {"\u2665", "♥"}, // black heart suit = valentine,U+2665 ISOpub -->
+ {"\u2666", "♦"}, // black diamond suit, U+2666 ISOpub -->
+
+ // <!-- Latin Extended-A -->
+ {"\u0152", "Œ"}, // -- latin capital ligature OE,U+0152 ISOlat2 -->
+ {"\u0153", "œ"}, // -- latin small ligature oe, U+0153 ISOlat2 -->
+ // <!-- ligature is a misnomer, this is a separate character in some languages -->
+ {"\u0160", "Š"}, // -- latin capital letter S with caron,U+0160 ISOlat2 -->
+ {"\u0161", "š"}, // -- latin small letter s with caron,U+0161 ISOlat2 -->
+ {"\u0178", "Ÿ"}, // -- latin capital letter Y with diaeresis,U+0178 ISOlat2 -->
+ // <!-- Spacing Modifier Letters -->
+ {"\u02C6", "ˆ"}, // -- modifier letter circumflex accent,U+02C6 ISOpub -->
+ {"\u02DC", "˜"}, // small tilde, U+02DC ISOdia -->
+ // <!-- General Punctuation -->
+ {"\u2002", " "}, // en space, U+2002 ISOpub -->
+ {"\u2003", " "}, // em space, U+2003 ISOpub -->
+ {"\u2009", " "}, // thin space, U+2009 ISOpub -->
+ {"\u200C", "‌"}, // zero width non-joiner,U+200C NEW RFC 2070 -->
+ {"\u200D", "‍"}, // zero width joiner, U+200D NEW RFC 2070 -->
+ {"\u200E", "‎"}, // left-to-right mark, U+200E NEW RFC 2070 -->
+ {"\u200F", "‏"}, // right-to-left mark, U+200F NEW RFC 2070 -->
+ {"\u2013", "–"}, // en dash, U+2013 ISOpub -->
+ {"\u2014", "—"}, // em dash, U+2014 ISOpub -->
+ {"\u2018", "‘"}, // left single quotation mark,U+2018 ISOnum -->
+ {"\u2019", "’"}, // right single quotation mark,U+2019 ISOnum -->
+ {"\u201A", "‚"}, // single low-9 quotation mark, U+201A NEW -->
+ {"\u201C", "“"}, // left double quotation mark,U+201C ISOnum -->
+ {"\u201D", "”"}, // right double quotation mark,U+201D ISOnum -->
+ {"\u201E", "„"}, // double low-9 quotation mark, U+201E NEW -->
+ {"\u2020", "†"}, // dagger, U+2020 ISOpub -->
+ {"\u2021", "‡"}, // double dagger, U+2021 ISOpub -->
+ {"\u2030", "‰"}, // per mille sign, U+2030 ISOtech -->
+ {"\u2039", "‹"}, // single left-pointing angle quotation mark,U+2039 ISO proposed -->
+ // <!-- lsaquo is proposed but not yet ISO standardized -->
+ {"\u203A", "›"}, // single right-pointing angle quotation mark,U+203A ISO proposed -->
+ // <!-- rsaquo is proposed but not yet ISO standardized -->
+ {"\u20AC", "€"}, // -- euro sign, U+20AC NEW -->
+ };
+
+ static final String[][] HTML40_EXTENDED_UNESCAPE = invert(HTML40_EXTENDED_ESCAPE);
+
+ static final String[][] BASIC_ESCAPE = {
+ {"\"", """}, // " - double-quote
+ {"&", "&"}, // & - ampersand
+ {"<", "<"}, // < - less-than
+ {">", ">"}, // > - greater-than
+ };
+
+ static final String[][] BASIC_UNESCAPE = invert(BASIC_ESCAPE);
+
+ static final String[][] APOS_ESCAPE = {
+ {"'", "'"}, // XML apostrophe
+ };
+
+ static final String[][] APOS_UNESCAPE = invert(APOS_ESCAPE);
+
+ /**
+ * Used to invert an escape array into an unescape array
+ * @param array String[][] to be inverted
+ * @return String[][] inverted array
+ */
+ static String[][] invert(String[][] array) {
+ String[][] newarray = new String[array.length][2];
+ for(int i = 0; i<array.length; i++) {
+ newarray[i][0] = array[i][1];
+ newarray[i][1] = array[i][0];
+ }
+ return newarray;
+ }
+
+}
Propchange: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EntityArrays.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeLowAsciiAsUnicode.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeLowAsciiAsUnicode.java?rev=787560&view=auto
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeLowAsciiAsUnicode.java (added)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeLowAsciiAsUnicode.java Tue Jun 23 06:15:50 2009
@@ -0,0 +1,69 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.lang.text.translate;
+
+import java.io.IOException;
+import java.io.Writer;
+
+/**
+ * Escapes ASCII under 32 to Unicode, except for the following
+ * special values, '\b \n \t \f \r', which are escaped to their
+ * Java types.
+ * @since 3.0
+ */
+// TODO: Is this not the combination of a LookupTranslator for the 5
+// TODO: special values, followed by a UnicodeEscaper?
+// TODO: It means passing a numerical range to the UnicodeEscaper
+// TOOD: to make it only hit < 32.
+public class EscapeLowAsciiAsUnicode extends UnicodeEscaper {
+
+ /**
+ * {@inheritDoc}
+ */
+ public boolean translate(int ch, Writer out) throws IOException {
+ if (ch < 32) {
+ switch (ch) {
+ case '\b' :
+ out.write('\\');
+ out.write('b');
+ break;
+ case '\n' :
+ out.write('\\');
+ out.write('n');
+ break;
+ case '\t' :
+ out.write('\\');
+ out.write('t');
+ break;
+ case '\f' :
+ out.write('\\');
+ out.write('f');
+ break;
+ case '\r' :
+ out.write('\\');
+ out.write('r');
+ break;
+ default :
+ super.translate(ch, out);
+ break;
+ }
+ return true;
+ } else {
+ return false;
+ }
+ }
+}
Propchange: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeLowAsciiAsUnicode.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeNonAsciiAsNumericEntity.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeNonAsciiAsNumericEntity.java?rev=787560&view=auto
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeNonAsciiAsNumericEntity.java (added)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeNonAsciiAsNumericEntity.java Tue Jun 23 06:15:50 2009
@@ -0,0 +1,44 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.lang.text.translate;
+
+import java.io.IOException;
+import java.io.Writer;
+
+/**
+ * Translates codepoints greater than ASCII 127 to their numerical
+ * XML entity.
+ * @since 3.0
+ */
+public class EscapeNonAsciiAsNumericEntity extends CodePointTranslator {
+
+ /**
+ * {@inheritDoc}
+ */
+ public boolean translate(int codepoint, Writer out) throws IOException {
+ // TODO: if (codepoint > 0xffff) {
+ if (codepoint > 0x7f) {
+ out.write("&#");
+ out.write(Integer.toString(codepoint, 10));
+ out.write(';');
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+}
Propchange: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeNonAsciiAsNumericEntity.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeNonAsciiAsUnicode.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeNonAsciiAsUnicode.java?rev=787560&view=auto
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeNonAsciiAsUnicode.java (added)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeNonAsciiAsUnicode.java Tue Jun 23 06:15:50 2009
@@ -0,0 +1,44 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.lang.text.translate;
+
+import java.io.IOException;
+import java.io.Writer;
+
+/**
+ * Translates codepoints greater than ASCII 127 to the unicode.
+ * @since 3.0
+ */
+public class EscapeNonAsciiAsUnicode extends UnicodeEscaper {
+
+ /**
+ * {@inheritDoc}
+ */
+ public boolean translate(int codepoint, Writer out) throws IOException {
+ // if (codepoint > 0xffff) {
+ // TODO: Figure out what to do. Output as two unicodes?
+ // Does this make this a Java-specific output class?
+
+ if (codepoint > 0x7f) {
+ super.translate(codepoint, out);
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+}
Propchange: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeNonAsciiAsUnicode.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeUtils.java?rev=787560&view=auto
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeUtils.java (added)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeUtils.java Tue Jun 23 06:15:50 2009
@@ -0,0 +1,108 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.lang.text.translate;
+
+import java.io.IOException;
+import java.io.Writer;
+
+// CsvEscaper
+import org.apache.commons.lang.StringUtils;
+import org.apache.commons.lang.CharUtils;
+
+/**
+ * Helper class defining various standard language escape functions.
+ * @since 3.0
+ */
+public class EscapeUtils {
+
+ public static final CharSequenceTranslator ESCAPE_JAVA =
+ new AggregateTranslator(
+ new LookupTranslator(
+ new String[][] {
+ {"\"", "\\\""},
+ {"\\", "\\\\"}
+ }),
+ new EscapeLowAsciiAsUnicode(),
+ new EscapeNonAsciiAsUnicode()
+ );
+
+ public static final CharSequenceTranslator ESCAPE_ECMASCRIPT =
+ new AggregateTranslator(
+ new LookupTranslator(
+ new String[][] {
+ {"'", "\\'"},
+ {"\"", "\\\""},
+ {"\\", "\\\\"},
+ {"/", "\\/"}
+ }),
+ new EscapeLowAsciiAsUnicode(),
+ new EscapeNonAsciiAsUnicode()
+ );
+
+ public static final CharSequenceTranslator ESCAPE_XML =
+ new AggregateTranslator(
+ new LookupTranslator(EntityArrays.BASIC_ESCAPE),
+ new LookupTranslator(EntityArrays.APOS_ESCAPE),
+ new EscapeNonAsciiAsNumericEntity()
+ );
+
+ public static final CharSequenceTranslator ESCAPE_HTML3 =
+ new AggregateTranslator(
+ new LookupTranslator(EntityArrays.BASIC_ESCAPE),
+ new LookupTranslator(EntityArrays.ISO8859_1_ESCAPE),
+ new EscapeNonAsciiAsNumericEntity()
+ );
+
+ public static final CharSequenceTranslator ESCAPE_HTML4 =
+ new AggregateTranslator(
+ new LookupTranslator(EntityArrays.BASIC_ESCAPE),
+ new LookupTranslator(EntityArrays.ISO8859_1_ESCAPE),
+ new LookupTranslator(EntityArrays.HTML40_EXTENDED_ESCAPE),
+ new EscapeNonAsciiAsNumericEntity()
+ );
+
+ public static final CharSequenceTranslator ESCAPE_CSV = new CsvEscaper();
+
+ // TODO: Create a parent class - 'SinglePassTranslator' ?
+ // TODO: It would handle the index checking, and length returning, and
+ // TODO: could also have an optimization check method.
+ static class CsvEscaper extends CharSequenceTranslator {
+
+ private static final char CSV_DELIMITER = ',';
+ private static final char CSV_QUOTE = '"';
+ private static final String CSV_QUOTE_STR = String.valueOf(CSV_QUOTE);
+ private static final char[] CSV_SEARCH_CHARS = new char[] {CSV_DELIMITER, CSV_QUOTE, CharUtils.CR, CharUtils.LF};
+
+ // TODO: Replace with a RegexTranslator. That should consume the number of characters the regex uses up?
+ public int translate(CharSequence input, int index, Writer out) throws IOException {
+
+ if(index != 0) {
+ throw new IllegalStateException("CsvEscaper should never reach the [1] index");
+ }
+
+ if (StringUtils.containsNone(input.toString(), CSV_SEARCH_CHARS)) {
+ out.write(input.toString());
+ } else {
+ out.write(CSV_QUOTE);
+ out.write(StringUtils.replace(input.toString(), CSV_QUOTE_STR, CSV_QUOTE_STR + CSV_QUOTE_STR));
+ out.write(CSV_QUOTE);
+ }
+ return input.length();
+ }
+ }
+
+}
Propchange: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/EscapeUtils.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/LookupTranslator.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/LookupTranslator.java?rev=787560&view=auto
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/LookupTranslator.java (added)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/LookupTranslator.java Tue Jun 23 06:15:50 2009
@@ -0,0 +1,52 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.lang.text.translate;
+
+import java.io.IOException;
+import java.io.Writer;
+
+/**
+ * Translates a value using a lookup table.
+ * @since 3.0
+ */
+public class LookupTranslator extends CharSequenceTranslator {
+
+ protected CharSequence[][] lookup;
+
+ /**
+ * Define the lookup table to be used in translation
+ *
+ * @param CharSequence[][] Lookup table of size [*][2]
+ */
+ public LookupTranslator(CharSequence[][] lookup) {
+ this.lookup = lookup;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public int translate(CharSequence input, int index, Writer out) throws IOException {
+ CharSequence subsequence = input.subSequence(index, input.length());
+ for(CharSequence[] seq : lookup) {
+ if( subsequence.toString().startsWith(seq[0].toString()) ) {
+ out.write(seq[1].toString());
+ return seq[0].length();
+ }
+ }
+ return 0;
+ }
+}
Propchange: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/LookupTranslator.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/NumericEntityUnescaper.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/NumericEntityUnescaper.java?rev=787560&view=auto
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/NumericEntityUnescaper.java (added)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/NumericEntityUnescaper.java Tue Jun 23 06:15:50 2009
@@ -0,0 +1,66 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.lang.text.translate;
+
+import java.io.IOException;
+import java.io.Writer;
+
+/**
+ * Translate XML numeric entities of the form &#[xX]?\d+; to
+ * the specific codepoint.
+ * @since 3.0
+ */
+public class NumericEntityUnescaper extends CharSequenceTranslator {
+
+ /**
+ * {@inheritDoc}
+ */
+ public int translate(CharSequence input, int index, Writer out) throws IOException {
+ // TODO: Protect from ArrayIndexOutOfBounds
+ if(input.charAt(index) == '&' && input.charAt(index + 1) == '#') {
+ int start = index + 2;
+ boolean isHex = false;
+
+ char firstChar = input.charAt(start);
+ if(firstChar == 'x' || firstChar == 'X') {
+ start++;
+ isHex = true;
+ }
+
+ int end = start;
+ while(input.charAt(end) != ';') {
+ end++;
+ }
+
+ int entityValue;
+ try {
+ if(isHex) {
+ entityValue = Integer.parseInt(input.subSequence(start, end).toString(), 16);
+ } else {
+ entityValue = Integer.parseInt(input.subSequence(start, end).toString(), 10);
+ }
+ } catch(NumberFormatException nfe) {
+ return 0;
+ }
+
+ // TODO: if(entityValue > 0xFFFF) {
+ out.write(entityValue);
+ return 2 + (end - start) + (isHex ? 1 : 0) + 1;
+ }
+ return 0;
+ }
+}
Propchange: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/NumericEntityUnescaper.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnescapeUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnescapeUtils.java?rev=787560&view=auto
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnescapeUtils.java (added)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnescapeUtils.java Tue Jun 23 06:15:50 2009
@@ -0,0 +1,101 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.lang.text.translate;
+
+import java.io.IOException;
+import java.io.Writer;
+
+// CsvUnescaper
+import org.apache.commons.lang.StringUtils;
+import org.apache.commons.lang.CharUtils;
+
+/**
+ * Helper class defining various standard language unescape functions.
+ * @since 3.0
+ */
+public class UnescapeUtils {
+
+ // throw "illegal character: \92" as an Exception if a \ on the end of the Java (as per the compiler)?
+ public static final CharSequenceTranslator UNESCAPE_JAVA =
+ new AggregateTranslator(
+ new UnicodeUnescaper(),
+ new LookupTranslator(
+ new String[][] {
+ {"\\\\", "\\"},
+ {"\\\"", "\""},
+ {"\\'", "'"},
+ {"\\r", "\r"},
+ {"\\f", "\f"},
+ {"\\t", "\t"},
+ {"\\n", "\n"},
+ {"\\b", "\b"},
+ {"\\", ""}
+ })
+ );
+
+ public static final CharSequenceTranslator UNESCAPE_ECMASCRIPT = UNESCAPE_JAVA;
+
+ public static final CharSequenceTranslator UNESCAPE_HTML4 =
+ new AggregateTranslator(
+ new LookupTranslator(EntityArrays.BASIC_UNESCAPE),
+ new LookupTranslator(EntityArrays.ISO8859_1_UNESCAPE),
+ new LookupTranslator(EntityArrays.HTML40_EXTENDED_UNESCAPE),
+ new NumericEntityUnescaper()
+ );
+
+ public static final CharSequenceTranslator UNESCAPE_XML =
+ new AggregateTranslator(
+ new LookupTranslator(EntityArrays.BASIC_UNESCAPE),
+ new LookupTranslator(EntityArrays.APOS_UNESCAPE),
+ new NumericEntityUnescaper()
+ );
+
+ public static final CharSequenceTranslator UNESCAPE_CSV = new CsvUnescaper();
+
+ static class CsvUnescaper extends CharSequenceTranslator {
+
+ private static final char CSV_DELIMITER = ',';
+ private static final char CSV_QUOTE = '"';
+ private static final String CSV_QUOTE_STR = String.valueOf(CSV_QUOTE);
+ private static final char[] CSV_SEARCH_CHARS = new char[] {CSV_DELIMITER, CSV_QUOTE, CharUtils.CR, CharUtils.LF};
+
+ // TODO: Replace with a RegexTranslator. That should consume the number of characters the regex uses up?
+ public int translate(CharSequence input, int index, Writer out) throws IOException {
+
+ if(index != 0) {
+ throw new IllegalStateException("CsvUnescaper should never reach the [1] index");
+ }
+
+ if ( input.charAt(0) != CSV_QUOTE || input.charAt(input.length() - 1) != CSV_QUOTE ) {
+ out.write(input.toString());
+ return input.length();
+ }
+
+ // strip quotes
+ String quoteless = input.subSequence(1, input.length() - 1).toString();
+
+ if ( StringUtils.containsAny(quoteless, CSV_SEARCH_CHARS) ) {
+ // deal with escaped quotes; ie) ""
+ out.write(StringUtils.replace(quoteless, CSV_QUOTE_STR + CSV_QUOTE_STR, CSV_QUOTE_STR));
+ } else {
+ out.write(input.toString());
+ }
+ return input.length();
+ }
+ }
+
+}
Propchange: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnescapeUtils.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnicodeEscaper.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnicodeEscaper.java?rev=787560&view=auto
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnicodeEscaper.java (added)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnicodeEscaper.java Tue Jun 23 06:15:50 2009
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.lang.text.translate;
+
+import java.io.IOException;
+import java.io.Writer;
+
+/**
+ * Translates codepoints to their unicode escape value.
+ * @since 3.0
+ */
+public class UnicodeEscaper extends CodePointTranslator {
+
+ /**
+ * {@inheritDoc}
+ */
+ public boolean translate(int codepoint, Writer out) throws IOException {
+ if (codepoint > 0xffff) {
+ // TODO: Figure out what to do. Output as two unicodes?
+ // Does this make this a Java-specific output class?
+ out.write("\\u" + hex(codepoint));
+ } else if (codepoint > 0xfff) {
+ out.write("\\u" + hex(codepoint));
+ } else if (codepoint > 0xff) {
+ out.write("\\u0" + hex(codepoint));
+ } else if (codepoint > 0xf) {
+ out.write("\\u00" + hex(codepoint));
+ } else {
+ out.write("\\u000" + hex(codepoint));
+ }
+ return true;
+ }
+}
Propchange: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnicodeEscaper.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnicodeUnescaper.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnicodeUnescaper.java?rev=787560&view=auto
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnicodeUnescaper.java (added)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnicodeUnescaper.java Tue Jun 23 06:15:50 2009
@@ -0,0 +1,63 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.lang.text.translate;
+
+import java.io.IOException;
+import java.io.Writer;
+
+import org.apache.commons.lang.UnhandledException;
+
+/**
+ * Translates escaped unicode values of the form \\u+\d\d\d\d back to
+ * unicode.
+ * @since 3.0
+ */
+public class UnicodeUnescaper extends CharSequenceTranslator {
+
+ /**
+ * {@inheritDoc}
+ */
+ public int translate(CharSequence input, int index, Writer out) throws IOException {
+ if(input.charAt(index) == '\\') {
+ if( (index + 1 < input.length()) && input.charAt(index + 1) == 'u') {
+ // consume optional additional 'u' chars
+ int i=2;
+ while( (index + i < input.length()) && input.charAt(index + i) == 'u') {
+ i++;
+ }
+
+ if( (index + i + 4 <= input.length()) ) {
+ // Get 4 hex digits
+ CharSequence unicode = input.subSequence(index + i, index + i + 4);
+
+ try {
+ int value = Integer.parseInt(unicode.toString(), 16);
+ out.write((char) value);
+ } catch (NumberFormatException nfe) {
+ throw new UnhandledException("Unable to parse unicode value: " + unicode, nfe);
+ }
+ return i + 4;
+ } else {
+ throw new IllegalArgumentException("Less than 4 hex digits in unicode value: '" +
+ input.subSequence(index, input.length()) +
+ "' due to end of CharSequence");
+ }
+ }
+ }
+ return 0;
+ }
+}
Propchange: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/UnicodeUnescaper.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/package.html
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/package.html?rev=787560&view=auto
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/package.html (added)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/package.html Tue Jun 23 06:15:50 2009
@@ -0,0 +1,26 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You 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.
+-->
+<html>
+<body>
+<p>
+An API for creating text translation routines from a set of smaller
+building blocks. Originally created to make it possible for the user to
+customize the rules in the StringEscapeUtils class.
+</p>
+@since 3.0
+</body>
+</html>
Propchange: commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/translate/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Modified: commons/proper/lang/trunk/src/test/org/apache/commons/lang/LangTestSuite.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/test/org/apache/commons/lang/LangTestSuite.java?rev=787560&r1=787559&r2=787560&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/test/org/apache/commons/lang/LangTestSuite.java (original)
+++ commons/proper/lang/trunk/src/test/org/apache/commons/lang/LangTestSuite.java Tue Jun 23 06:15:50 2009
@@ -62,7 +62,6 @@
suite.addTest(CharSetUtilsTest.suite());
suite.addTest(CharUtilsTest.suite());
suite.addTest(ClassUtilsTest.suite());
- suite.addTest(EntitiesTest.suite());
suite.addTest(EnumUtilsTest.suite());
suite.addTest(IllegalClassExceptionTest.suite());
suite.addTest(IncompleteArgumentExceptionTest.suite());