doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java - maven-doxia - Git at Google

 package org.apache.maven.doxia.util;

 /*
  * 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.
  */

 import java.io.UnsupportedEncodingException;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;

 import javax.swing.text.html.HTML.Tag;

 import org.apache.commons.lang3.StringEscapeUtils;
 import org.apache.maven.doxia.markup.HtmlMarkup;
 import org.codehaus.plexus.util.StringUtils;

 /**
  * The <code>HtmlTools</code> class defines methods to HTML handling.
  *
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
  * @version $Id$
  * @since 1.0
  */
 public class HtmlTools
 {
     private static final Tag[] ALL_TAGS  =
     {
         HtmlMarkup.A, HtmlMarkup.ABBR, HtmlMarkup.ACRONYM, HtmlMarkup.ADDRESS, HtmlMarkup.APPLET,
         HtmlMarkup.AREA, HtmlMarkup.B, HtmlMarkup.BASE, HtmlMarkup.BASEFONT, HtmlMarkup.BDO,
         HtmlMarkup.BIG, HtmlMarkup.BLOCKQUOTE, HtmlMarkup.BODY, HtmlMarkup.BR, HtmlMarkup.BUTTON,
         HtmlMarkup.CAPTION, HtmlMarkup.CENTER, HtmlMarkup.CITE, HtmlMarkup.CODE, HtmlMarkup.COL,
         HtmlMarkup.COLGROUP, HtmlMarkup.DD, HtmlMarkup.DEL, HtmlMarkup.DFN, HtmlMarkup.DIR,
         HtmlMarkup.DIV, HtmlMarkup.DL, HtmlMarkup.DT, HtmlMarkup.EM, HtmlMarkup.FIELDSET,
         HtmlMarkup.FONT, HtmlMarkup.FORM, HtmlMarkup.FRAME, HtmlMarkup.FRAMESET, HtmlMarkup.H1,
         HtmlMarkup.H2, HtmlMarkup.H3, HtmlMarkup.H4, HtmlMarkup.H5, HtmlMarkup.H6, HtmlMarkup.HEAD,
         HtmlMarkup.HR, HtmlMarkup.HTML, HtmlMarkup.I, HtmlMarkup.IFRAME, HtmlMarkup.IMG,
         HtmlMarkup.INPUT, HtmlMarkup.INS, HtmlMarkup.ISINDEX, HtmlMarkup.KBD, HtmlMarkup.LABEL,
         HtmlMarkup.LEGEND, HtmlMarkup.LI, HtmlMarkup.LINK, HtmlMarkup.MAP, HtmlMarkup.MENU,
         HtmlMarkup.META, HtmlMarkup.NOFRAMES, HtmlMarkup.NOSCRIPT, HtmlMarkup.OBJECT, HtmlMarkup.OL,
         HtmlMarkup.OPTGROUP, HtmlMarkup.OPTION, HtmlMarkup.P, HtmlMarkup.PARAM, HtmlMarkup.PRE,
         HtmlMarkup.Q, HtmlMarkup.S, HtmlMarkup.SAMP, HtmlMarkup.SCRIPT, HtmlMarkup.SELECT,
         HtmlMarkup.SMALL, HtmlMarkup.SPAN, HtmlMarkup.STRIKE, HtmlMarkup.STRONG, HtmlMarkup.STYLE,
         HtmlMarkup.SUB, HtmlMarkup.SUP, HtmlMarkup.TABLE, HtmlMarkup.TBODY, HtmlMarkup.TD,
         HtmlMarkup.TEXTAREA, HtmlMarkup.TFOOT, HtmlMarkup.TH, HtmlMarkup.THEAD, HtmlMarkup.TITLE,
         HtmlMarkup.TR, HtmlMarkup.TT, HtmlMarkup.U, HtmlMarkup.UL, HtmlMarkup.VAR
     };

     private static final Map<String, Tag> TAG_MAP = new HashMap<String, Tag>( ALL_TAGS.length );

     private static final int ASCII = 0x7E;

     static
     {
         for ( Tag tag : ALL_TAGS )
         {
             TAG_MAP.put( tag.toString(), tag );
         }
     }

     /**
      * Returns a tag for a defined HTML tag name. This is one of
      * the tags defined in {@link org.apache.maven.doxia.markup.HtmlMarkup}.
      * If the given name does not represent one of the defined tags, then
      * <code>null</code> will be returned.
      *
      * @param tagName the <code>String</code> name requested.
      * @return a tag constant corresponding to the <code>tagName</code>,
      *    or <code>null</code> if not found.
      * @see <a href="http://www.w3.org/TR/html401/index/elements.html">http://www.w3.org/TR/html401/index/elements.html</a>
      * @since 1.1
      */
     public static Tag getHtmlTag( String tagName )
     {
         Object t =  TAG_MAP.get( tagName );

         return (Tag) t;
     }

     /**
      * Escape special HTML characters in a String in <code>xml</code> mode.
      *
      * <b>Note</b>: this method doesn't escape non-ascii characters by numeric characters references.
      *
      * @param text the String to escape, may be null.
      * @return The escaped text or the empty string if text == null.
      * @see #escapeHTML(String,boolean)
      */
     public static String escapeHTML( String text )
     {
         return escapeHTML( text, true );
     }

     /**
      * Escape special HTML characters in a String.
      *
      * <pre>
      * &lt; becomes <code>&#38;lt;</code>
      * &gt; becomes <code>&#38;gt;</code>
      * &amp; becomes <code>&#38;amp;</code>
      * " becomes <code>&#38;quot;</code>
      * ' becomes <code>&#38;apos;</code> if xmlMode = true
      * </pre>
      *
      * If <code>xmlMode</code> is true, every other character than the above remains unchanged,
      * if <code>xmlMode</code> is false, non-ascii characters get replaced by their hex code.
      *
      * <b>Note</b>: all characters are encoded, i.e.:
      * <pre>
      * \u0159       = &#38;#x159;
      * \uD835\uDFED = &#38;#x1d7ed;
      * </pre>
      *
      * @param text The String to escape, may be null.
      * @param xmlMode <code>true</code> to replace also ' to &#38;apos, <code>false</code> to replace non-ascii
      * characters by numeric characters references.
      * @return The escaped text or the empty string if text == null.
      * @since 1.1
      * @see <a href="http://www.w3.org/TR/2000/REC-xml-20001006#sec-predefined-ent">http://www.w3.org/TR/2000/REC-xml-20001006#sec-predefined-ent</a>
      * @see <a href="http://www.w3.org/TR/html401/charset.html#h-5.3">http://www.w3.org/TR/html401/charset.html#h-5.3</a>
      */
     public static String escapeHTML( final String text, final boolean xmlMode )
     {
         if ( text == null )
         {
             return "";
         }

         int length = text.length();
         StringBuilder buffer = new StringBuilder( length );

         for ( int i = 0; i < length; ++i )
         {
             char c = text.charAt( i );
             switch ( c )
             {
                 case '<':
                     buffer.append( "&lt;" );
                     break;
                 case '>':
                     buffer.append( "&gt;" );
                     break;
                 case '&':
                     buffer.append( "&amp;" );
                     break;
                 case '\"':
                     buffer.append( "&quot;" );
                     break;
                 default:
                     if ( xmlMode )
                     {
                         if ( c == '\'' )
                         {
                             buffer.append( "&apos;" );
                         }
                         else
                         {
                             buffer.append( c );
                         }
                     }
                     else
                     {
                         if ( c <= ASCII )
                         {
                             // ASCII.
                             buffer.append( c );
                         }
                         else
                         {
                             buffer.append( "&#x" );
                             if ( isHighSurrogate( c ) )
                             {
                                 buffer.append( Integer.toHexString( toCodePoint( c, text.charAt( ++i ) ) ) );
                             }
                             else
                             {
                                 buffer.append( Integer.toHexString( c ) );
                             }
                             buffer.append( ';' );
                         }
                     }
             }
         }

         return buffer.toString();
     }

     /**
      * Unescapes HTML entities in a string in non xml mode.
      *
      * @param text the <code>String</code> to unescape, may be null.
      * @return a new unescaped <code>String</code>, <code>null</code> if null string input.
      * @since 1.1.1.
      * @see #unescapeHTML(String, boolean)
      */
     public static String unescapeHTML( String text )
     {
         return unescapeHTML( text, false );
     }

     /**
      * Unescapes HTML entities in a string.
      *
      * <p> Unescapes a string containing entity escapes to a string
      * containing the actual Unicode characters corresponding to the
      * escapes. Supports HTML 4.0 entities.</p>
      *
      * <p>For example, the string "&amp;lt;Fran&amp;ccedil;ais&amp;gt;"
      * will become "&lt;Fran&ccedil;ais&gt;".</p>
      *
      * <b>Note</b>: all unicode entities are decoded, i.e.:
      * <pre>
      * &#38;#x159;   = \u0159
      * &#38;#x1d7ed; = \uD835\uDFED
      * </pre>
      *
      * @param text the <code>String</code> to unescape, may be null.
      * @param xmlMode set to <code>true</code> to replace &#38;apos by '.
      * @return a new unescaped <code>String</code>, <code>null</code> if null string input.
      * @since 1.1.1.
      */
     public static String unescapeHTML( String text, boolean xmlMode )
     {
         if ( text == null )
         {
             return null;
         }

         String unescaped;
         if ( xmlMode )
         {
             unescaped = StringEscapeUtils.unescapeXml( text );
         }
         else
         {
             // StringEscapeUtils.unescapeHtml4 returns entities it doesn't recognize unchanged
             unescaped = StringEscapeUtils.unescapeHtml4( text );
         }

         String tmp = unescaped;
         List<String> entities = new ArrayList<String>();
         while ( true )
         {
             int i = tmp.indexOf( "&#x" );
             if ( i == -1 )
             {
                 break;
             }

             tmp = tmp.substring( i + 3 );
             if ( tmp.indexOf( ';' ) != -1 )
             {
                 String entity = tmp.substring( 0, tmp.indexOf( ';' ) );
                 try
                 {
                     Integer.parseInt( entity, 16 );
                     entities.add( entity );
                 }
                 catch ( NumberFormatException e )
                 {
                     // nop
                 }
             }
         }

         for ( String entity : entities )
         {
             int codePoint = Integer.parseInt( entity, 16 );
             unescaped = StringUtils.replace( unescaped, "&#x" + entity + ";", new String( toChars( codePoint ) ) );
         }

         return unescaped;
     }

     /**
      * Encode an url
      *
      * @param url the String to encode, may be null
      * @return the text encoded, null if null String input
      */
     public static String encodeURL( String url )
     {
         if ( url == null )
         {
             return null;
         }

         StringBuilder encoded = new StringBuilder();
         int length = url.length();

         char[] unicode = new char[1];

         for ( int i = 0; i < length; ++i )
         {
             char c = url.charAt( i );

             switch ( c )
             {
                 case ';':
                 case '/':
                 case '?':
                 case ':':
                 case '@':
                 case '&':
                 case '=':
                 case '+':
                 case '$':
                 case ',':
                 case '[':
                 case ']': // RFC 2732 (IPV6)
                 case '-':
                 case '_':
                 case '.':
                 case '!':
                 case '~':
                 case '*':
                 case '\'':
                 case '(':
                 case ')':
                 case '#': // XLink mark
                     encoded.append( c );
                     break;
                 default:
                     if ( ( c >= 'a' && c <= 'z' ) || ( c >= 'A' && c <= 'Z' ) || ( c >= '0' && c <= '9' ) )
                     {
                         encoded.append( c );
                     }
                     else
                     {
                         byte[] bytes;

                         try
                         {
                             if ( isHighSurrogate( c ) )
                             {
                                 int codePoint = toCodePoint( c, url.charAt( ++i ) );
                                 unicode = toChars( codePoint );
                                 bytes = ( new String( unicode, 0, unicode.length ) ).getBytes( "UTF8" );
                             }
                             else
                             {
                                 unicode[0] = c;
                                 bytes = ( new String( unicode, 0, 1 ) ).getBytes( "UTF8" );
                             }
                         }
                         catch ( UnsupportedEncodingException cannotHappen )
                         {
                             bytes = new byte[0];
                         }

                         for ( int j = 0; j < bytes.length; ++j )
                         {
                             encoded.append( '%' );
                             encoded.append( String.format( "%02X", bytes[j] ) );
                         }
                     }
             }
         }

         return encoded.toString();
     }

     /**
      * Construct a valid id.
      *
      * <p>
      *   <b>Note</b>: this method is identical to
      *   {@link DoxiaUtils#encodeId(String,boolean) DoxiaUtils.encodeId( id, false )},
      *   the rules to encode an id are laid out there.
      * </p>
      *
      * @param id The id to be encoded.
      * @return The trimmed and encoded id, or null if id is null.
      * @see DoxiaUtils#encodeId(java.lang.String,boolean)
      */
     public static String encodeId( String id )
     {
         return DoxiaUtils.encodeId( id, false );
     }

     /**
      * Determines if the specified text is a valid id according to the rules
      * laid out in {@link #encodeId(String)}.
      *
      * @param text The text to be tested.
      * @return <code>true</code> if the text is a valid id, otherwise <code>false</code>.
      * @see DoxiaUtils#isValidId(String)
      */
     public static boolean isId( String text )
     {
         return DoxiaUtils.isValidId( text );
     }

     private HtmlTools()
     {
         // utility class
     }

 //
 // Imported code from ASF Harmony project rev 770909
 // http://svn.apache.org/repos/asf/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Character.java
 //

     private static final char LUNATE_SIGMA = 0x3FF;
     private static final char NON_PRIVATE_USE_HIGH_SURROGATE = 0xD800;
     private static final char LOW_SURROGATE = 0xDC00;

     private static int toCodePoint( char high, char low )
     {
         // See RFC 2781, Section 2.2
         // http://www.faqs.org/rfcs/rfc2781.html
         int h = ( high & LUNATE_SIGMA ) << 10;
         int l = low & LUNATE_SIGMA;
         return ( h | l ) + MIN_SUPPLEMENTARY_CODE_POINT;
     }

     private static final char MIN_HIGH_SURROGATE = '\uD800';
     private static final char MAX_HIGH_SURROGATE = '\uDBFF';

     private static boolean isHighSurrogate( char ch )
     {
         return ( MIN_HIGH_SURROGATE <= ch && MAX_HIGH_SURROGATE >= ch );
     }

     private static final int MIN_CODE_POINT = 0x000000;
     private static final int MAX_CODE_POINT = 0x10FFFF;
     private static final int MIN_SUPPLEMENTARY_CODE_POINT = 0x10000;

     private static boolean isValidCodePoint( int codePoint )
     {
         return ( MIN_CODE_POINT <= codePoint && MAX_CODE_POINT >= codePoint );
     }

     private static boolean isSupplementaryCodePoint( int codePoint )
     {
         return ( MIN_SUPPLEMENTARY_CODE_POINT <= codePoint && MAX_CODE_POINT >= codePoint );
     }

     /**
      * Converts the given code point to an equivalent character array.
      *
      * @param codePoint the code point to convert.
      * @return If codePoint is a supplementary code point, returns a character array of length 2,
      * otherwise a character array of length 1 containing only the original int as a char.
      */
     public static char[] toChars( int codePoint )
     {
         if ( !isValidCodePoint( codePoint ) )
         {
             throw new IllegalArgumentException();
         }

         if ( isSupplementaryCodePoint( codePoint ) )
         {
             int cpPrime = codePoint - MIN_SUPPLEMENTARY_CODE_POINT;
             int high = NON_PRIVATE_USE_HIGH_SURROGATE | ( ( cpPrime >> 10 ) & LUNATE_SIGMA );
             int low = LOW_SURROGATE | ( cpPrime & LUNATE_SIGMA );
             return new char[] { (char) high, (char) low };
         }
         return new char[] { (char) codePoint };
     }
 }
	package org.apache.maven.doxia.util;

	/*
	* 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.
	*/

	import java.io.UnsupportedEncodingException;
	import java.util.ArrayList;
	import java.util.HashMap;
	import java.util.List;
	import java.util.Map;

	import javax.swing.text.html.HTML.Tag;

	import org.apache.commons.lang3.StringEscapeUtils;
	import org.apache.maven.doxia.markup.HtmlMarkup;
	import org.codehaus.plexus.util.StringUtils;

	/**
	* The <code>HtmlTools</code> class defines methods to HTML handling.
	*
	* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
	* @version $Id$
	* @since 1.0
	*/
	public class HtmlTools
	{
	private static final Tag[] ALL_TAGS =
	{
	HtmlMarkup.A, HtmlMarkup.ABBR, HtmlMarkup.ACRONYM, HtmlMarkup.ADDRESS, HtmlMarkup.APPLET,
	HtmlMarkup.AREA, HtmlMarkup.B, HtmlMarkup.BASE, HtmlMarkup.BASEFONT, HtmlMarkup.BDO,
	HtmlMarkup.BIG, HtmlMarkup.BLOCKQUOTE, HtmlMarkup.BODY, HtmlMarkup.BR, HtmlMarkup.BUTTON,
	HtmlMarkup.CAPTION, HtmlMarkup.CENTER, HtmlMarkup.CITE, HtmlMarkup.CODE, HtmlMarkup.COL,
	HtmlMarkup.COLGROUP, HtmlMarkup.DD, HtmlMarkup.DEL, HtmlMarkup.DFN, HtmlMarkup.DIR,
	HtmlMarkup.DIV, HtmlMarkup.DL, HtmlMarkup.DT, HtmlMarkup.EM, HtmlMarkup.FIELDSET,
	HtmlMarkup.FONT, HtmlMarkup.FORM, HtmlMarkup.FRAME, HtmlMarkup.FRAMESET, HtmlMarkup.H1,
	HtmlMarkup.H2, HtmlMarkup.H3, HtmlMarkup.H4, HtmlMarkup.H5, HtmlMarkup.H6, HtmlMarkup.HEAD,
	HtmlMarkup.HR, HtmlMarkup.HTML, HtmlMarkup.I, HtmlMarkup.IFRAME, HtmlMarkup.IMG,
	HtmlMarkup.INPUT, HtmlMarkup.INS, HtmlMarkup.ISINDEX, HtmlMarkup.KBD, HtmlMarkup.LABEL,
	HtmlMarkup.LEGEND, HtmlMarkup.LI, HtmlMarkup.LINK, HtmlMarkup.MAP, HtmlMarkup.MENU,
	HtmlMarkup.META, HtmlMarkup.NOFRAMES, HtmlMarkup.NOSCRIPT, HtmlMarkup.OBJECT, HtmlMarkup.OL,
	HtmlMarkup.OPTGROUP, HtmlMarkup.OPTION, HtmlMarkup.P, HtmlMarkup.PARAM, HtmlMarkup.PRE,
	HtmlMarkup.Q, HtmlMarkup.S, HtmlMarkup.SAMP, HtmlMarkup.SCRIPT, HtmlMarkup.SELECT,
	HtmlMarkup.SMALL, HtmlMarkup.SPAN, HtmlMarkup.STRIKE, HtmlMarkup.STRONG, HtmlMarkup.STYLE,
	HtmlMarkup.SUB, HtmlMarkup.SUP, HtmlMarkup.TABLE, HtmlMarkup.TBODY, HtmlMarkup.TD,
	HtmlMarkup.TEXTAREA, HtmlMarkup.TFOOT, HtmlMarkup.TH, HtmlMarkup.THEAD, HtmlMarkup.TITLE,
	HtmlMarkup.TR, HtmlMarkup.TT, HtmlMarkup.U, HtmlMarkup.UL, HtmlMarkup.VAR
	};

	private static final Map<String, Tag> TAG_MAP = new HashMap<String, Tag>( ALL_TAGS.length );

	private static final int ASCII = 0x7E;

	static
	{
	for ( Tag tag : ALL_TAGS )
	{
	TAG_MAP.put( tag.toString(), tag );
	}
	}

	/**
	* Returns a tag for a defined HTML tag name. This is one of
	* the tags defined in {@link org.apache.maven.doxia.markup.HtmlMarkup}.
	* If the given name does not represent one of the defined tags, then
	* <code>null</code> will be returned.
	*
	* @param tagName the <code>String</code> name requested.
	* @return a tag constant corresponding to the <code>tagName</code>,
	* or <code>null</code> if not found.
	* @see <a href="http://www.w3.org/TR/html401/index/elements.html">http://www.w3.org/TR/html401/index/elements.html</a>
	* @since 1.1
	*/
	public static Tag getHtmlTag( String tagName )
	{
	Object t = TAG_MAP.get( tagName );

	return (Tag) t;
	}

	/**
	* Escape special HTML characters in a String in <code>xml</code> mode.
	*
	* <b>Note</b>: this method doesn't escape non-ascii characters by numeric characters references.
	*
	* @param text the String to escape, may be null.
	* @return The escaped text or the empty string if text == null.
	* @see #escapeHTML(String,boolean)
	*/
	public static String escapeHTML( String text )
	{
	return escapeHTML( text, true );
	}

	/**
	* Escape special HTML characters in a String.
	*
	* <pre>
	* < becomes <code>&lt;</code>
	* > becomes <code>&gt;</code>
	* & becomes <code>&amp;</code>
	* " becomes <code>&quot;</code>
	* ' becomes <code>&apos;</code> if xmlMode = true
	* </pre>
	*
	* If <code>xmlMode</code> is true, every other character than the above remains unchanged,
	* if <code>xmlMode</code> is false, non-ascii characters get replaced by their hex code.
	*
	* <b>Note</b>: all characters are encoded, i.e.:
	* <pre>
	* \u0159 = &#x159;
	* \uD835\uDFED = &#x1d7ed;
	* </pre>
	*
	* @param text The String to escape, may be null.
	* @param xmlMode <code>true</code> to replace also ' to &apos, <code>false</code> to replace non-ascii
	* characters by numeric characters references.
	* @return The escaped text or the empty string if text == null.
	* @since 1.1
	* @see <a href="http://www.w3.org/TR/2000/REC-xml-20001006#sec-predefined-ent">http://www.w3.org/TR/2000/REC-xml-20001006#sec-predefined-ent</a>
	* @see <a href="http://www.w3.org/TR/html401/charset.html#h-5.3">http://www.w3.org/TR/html401/charset.html#h-5.3</a>
	*/
	public static String escapeHTML( final String text, final boolean xmlMode )
	{
	if ( text == null )
	{
	return "";
	}

	int length = text.length();
	StringBuilder buffer = new StringBuilder( length );

	for ( int i = 0; i < length; ++i )
	{
	char c = text.charAt( i );
	switch ( c )
	{
	case '<':
	buffer.append( "<" );
	break;
	case '>':
	buffer.append( ">" );
	break;
	case '&':
	buffer.append( "&" );
	break;
	case '\"':
	buffer.append( """ );
	break;
	default:
	if ( xmlMode )
	{
	if ( c == '\'' )
	{
	buffer.append( "'" );
	}
	else
	{
	buffer.append( c );
	}
	}
	else
	{
	if ( c <= ASCII )
	{
	// ASCII.
	buffer.append( c );
	}
	else
	{
	buffer.append( "&#x" );
	if ( isHighSurrogate( c ) )
	{
	buffer.append( Integer.toHexString( toCodePoint( c, text.charAt( ++i ) ) ) );
	}
	else
	{
	buffer.append( Integer.toHexString( c ) );
	}
	buffer.append( ';' );
	}
	}
	}
	}

	return buffer.toString();
	}

	/**
	* Unescapes HTML entities in a string in non xml mode.
	*
	* @param text the <code>String</code> to unescape, may be null.
	* @return a new unescaped <code>String</code>, <code>null</code> if null string input.
	* @since 1.1.1.
	* @see #unescapeHTML(String, boolean)
	*/
	public static String unescapeHTML( String text )
	{
	return unescapeHTML( text, false );
	}

	/**
	* Unescapes HTML entities in a string.
	*
	* <p> Unescapes a string containing entity escapes to a string
	* containing the actual Unicode characters corresponding to the
	* escapes. Supports HTML 4.0 entities.</p>
	*
	* <p>For example, the string "&lt;Fran&ccedil;ais&gt;"
	* will become "<Français>".</p>
	*
	* <b>Note</b>: all unicode entities are decoded, i.e.:
	* <pre>
	* &#x159; = \u0159
	* &#x1d7ed; = \uD835\uDFED
	* </pre>
	*
	* @param text the <code>String</code> to unescape, may be null.
	* @param xmlMode set to <code>true</code> to replace &apos by '.
	* @return a new unescaped <code>String</code>, <code>null</code> if null string input.
	* @since 1.1.1.
	*/
	public static String unescapeHTML( String text, boolean xmlMode )
	{
	if ( text == null )
	{
	return null;
	}

	String unescaped;
	if ( xmlMode )
	{
	unescaped = StringEscapeUtils.unescapeXml( text );
	}
	else
	{
	// StringEscapeUtils.unescapeHtml4 returns entities it doesn't recognize unchanged
	unescaped = StringEscapeUtils.unescapeHtml4( text );
	}

	String tmp = unescaped;
	List<String> entities = new ArrayList<String>();
	while ( true )
	{
	int i = tmp.indexOf( "&#x" );
	if ( i == -1 )
	{
	break;
	}

	tmp = tmp.substring( i + 3 );
	if ( tmp.indexOf( ';' ) != -1 )
	{
	String entity = tmp.substring( 0, tmp.indexOf( ';' ) );
	try
	{
	Integer.parseInt( entity, 16 );
	entities.add( entity );
	}
	catch ( NumberFormatException e )
	{
	// nop
	}
	}
	}

	for ( String entity : entities )
	{
	int codePoint = Integer.parseInt( entity, 16 );
	unescaped = StringUtils.replace( unescaped, "&#x" + entity + ";", new String( toChars( codePoint ) ) );
	}

	return unescaped;
	}

	/**
	* Encode an url
	*
	* @param url the String to encode, may be null
	* @return the text encoded, null if null String input
	*/
	public static String encodeURL( String url )
	{
	if ( url == null )
	{
	return null;
	}

	StringBuilder encoded = new StringBuilder();
	int length = url.length();

	char[] unicode = new char[1];

	for ( int i = 0; i < length; ++i )
	{
	char c = url.charAt( i );

	switch ( c )
	{
	case ';':
	case '/':
	case '?':
	case ':':
	case '@':
	case '&':
	case '=':
	case '+':
	case '$':
	case ',':
	case '[':
	case ']': // RFC 2732 (IPV6)
	case '-':
	case '_':
	case '.':
	case '!':
	case '~':
	case '*':
	case '\'':
	case '(':
	case ')':
	case '#': // XLink mark
	encoded.append( c );
	break;
	default:
	if ( ( c >= 'a' && c <= 'z' ) \|\| ( c >= 'A' && c <= 'Z' ) \|\| ( c >= '0' && c <= '9' ) )
	{
	encoded.append( c );
	}
	else
	{
	byte[] bytes;

	try
	{
	if ( isHighSurrogate( c ) )
	{
	int codePoint = toCodePoint( c, url.charAt( ++i ) );
	unicode = toChars( codePoint );
	bytes = ( new String( unicode, 0, unicode.length ) ).getBytes( "UTF8" );
	}
	else
	{
	unicode[0] = c;
	bytes = ( new String( unicode, 0, 1 ) ).getBytes( "UTF8" );
	}
	}
	catch ( UnsupportedEncodingException cannotHappen )
	{
	bytes = new byte[0];
	}

	for ( int j = 0; j < bytes.length; ++j )
	{
	encoded.append( '%' );
	encoded.append( String.format( "%02X", bytes[j] ) );
	}
	}
	}
	}

	return encoded.toString();
	}

	/**
	* Construct a valid id.
	*
	* <p>
	* <b>Note</b>: this method is identical to
	* {@link DoxiaUtils#encodeId(String,boolean) DoxiaUtils.encodeId( id, false )},
	* the rules to encode an id are laid out there.
	* </p>
	*
	* @param id The id to be encoded.
	* @return The trimmed and encoded id, or null if id is null.
	* @see DoxiaUtils#encodeId(java.lang.String,boolean)
	*/
	public static String encodeId( String id )
	{
	return DoxiaUtils.encodeId( id, false );
	}

	/**
	* Determines if the specified text is a valid id according to the rules
	* laid out in {@link #encodeId(String)}.
	*
	* @param text The text to be tested.
	* @return <code>true</code> if the text is a valid id, otherwise <code>false</code>.
	* @see DoxiaUtils#isValidId(String)
	*/
	public static boolean isId( String text )
	{
	return DoxiaUtils.isValidId( text );
	}

	private HtmlTools()
	{
	// utility class
	}

	//
	// Imported code from ASF Harmony project rev 770909
	// http://svn.apache.org/repos/asf/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Character.java
	//

	private static final char LUNATE_SIGMA = 0x3FF;
	private static final char NON_PRIVATE_USE_HIGH_SURROGATE = 0xD800;
	private static final char LOW_SURROGATE = 0xDC00;

	private static int toCodePoint( char high, char low )
	{
	// See RFC 2781, Section 2.2
	// http://www.faqs.org/rfcs/rfc2781.html
	int h = ( high & LUNATE_SIGMA ) << 10;
	int l = low & LUNATE_SIGMA;
	return ( h \| l ) + MIN_SUPPLEMENTARY_CODE_POINT;
	}

	private static final char MIN_HIGH_SURROGATE = '\uD800';
	private static final char MAX_HIGH_SURROGATE = '\uDBFF';

	private static boolean isHighSurrogate( char ch )
	{
	return ( MIN_HIGH_SURROGATE <= ch && MAX_HIGH_SURROGATE >= ch );
	}

	private static final int MIN_CODE_POINT = 0x000000;
	private static final int MAX_CODE_POINT = 0x10FFFF;
	private static final int MIN_SUPPLEMENTARY_CODE_POINT = 0x10000;

	private static boolean isValidCodePoint( int codePoint )
	{
	return ( MIN_CODE_POINT <= codePoint && MAX_CODE_POINT >= codePoint );
	}

	private static boolean isSupplementaryCodePoint( int codePoint )
	{
	return ( MIN_SUPPLEMENTARY_CODE_POINT <= codePoint && MAX_CODE_POINT >= codePoint );
	}

	/**
	* Converts the given code point to an equivalent character array.
	*
	* @param codePoint the code point to convert.
	* @return If codePoint is a supplementary code point, returns a character array of length 2,
	* otherwise a character array of length 1 containing only the original int as a char.
	*/
	public static char[] toChars( int codePoint )
	{
	if ( !isValidCodePoint( codePoint ) )
	{
	throw new IllegalArgumentException();
	}

	if ( isSupplementaryCodePoint( codePoint ) )
	{
	int cpPrime = codePoint - MIN_SUPPLEMENTARY_CODE_POINT;
	int high = NON_PRIVATE_USE_HIGH_SURROGATE \| ( ( cpPrime >> 10 ) & LUNATE_SIGMA );
	int low = LOW_SURROGATE \| ( cpPrime & LUNATE_SIGMA );
	return new char[] { (char) high, (char) low };
	}
	return new char[] { (char) codePoint };
	}
	}