1. /*
  2. * The Apache Software License, Version 1.1
  3. *
  4. *
  5. * Copyright (c) 2000-2002 The Apache Software Foundation. All rights
  6. * reserved.
  7. *
  8. * Redistribution and use in source and binary forms, with or without
  9. * modification, are permitted provided that the following conditions
  10. * are met:
  11. *
  12. * 1. Redistributions of source code must retain the above copyright
  13. * notice, this list of conditions and the following disclaimer.
  14. *
  15. * 2. Redistributions in binary form must reproduce the above copyright
  16. * notice, this list of conditions and the following disclaimer in
  17. * the documentation and/or other materials provided with the
  18. * distribution.
  19. *
  20. * 3. The end-user documentation included with the redistribution,
  21. * if any, must include the following acknowledgment:
  22. * "This product includes software developed by the
  23. * Apache Software Foundation (http://www.apache.org/)."
  24. * Alternately, this acknowledgment may appear in the software itself,
  25. * if and wherever such third-party acknowledgments normally appear.
  26. *
  27. * 4. The names "Xerces" and "Apache Software Foundation" must
  28. * not be used to endorse or promote products derived from this
  29. * software without prior written permission. For written
  30. * permission, please contact apache@apache.org.
  31. *
  32. * 5. Products derived from this software may not be called "Apache",
  33. * nor may "Apache" appear in their name, without prior written
  34. * permission of the Apache Software Foundation.
  35. *
  36. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  37. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  38. * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  39. * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  40. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  41. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  42. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  43. * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  44. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  45. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  46. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  47. * SUCH DAMAGE.
  48. * ====================================================================
  49. *
  50. * This software consists of voluntary contributions made by many
  51. * individuals on behalf of the Apache Software Foundation and was
  52. * originally based on software copyright (c) 1999, International
  53. * Business Machines, Inc., http://www.apache.org. For more
  54. * information on the Apache Software Foundation, please see
  55. * <http://www.apache.org/>.
  56. */
  57. package com.sun.org.apache.xml.internal.serialize;
  58. import java.io.OutputStream;
  59. import java.io.OutputStreamWriter;
  60. import java.io.UnsupportedEncodingException;
  61. import java.io.Writer;
  62. import com.sun.org.apache.xerces.internal.util.EncodingMap;
  63. import java.nio.charset.Charset;
  64. import java.nio.charset.CharsetEncoder;
  65. import java.nio.charset.UnsupportedCharsetException;
  66. import java.nio.charset.IllegalCharsetNameException;
  67. /**
  68. * This class represents an encoding.
  69. *
  70. * @version $Id: EncodingInfo.java,v 1.2 2003/12/05 10:08:55 vk112360 Exp $
  71. */
  72. public class EncodingInfo {
  73. // Method: sun.io.CharToByteConverter.getConverter(java.lang.String)
  74. private static java.lang.reflect.Method fgGetConverterMethod = null;
  75. // Method: sun.io.CharToByteConverter.canConvert(char)
  76. private static java.lang.reflect.Method fgCanConvertMethod = null;
  77. // Flag indicating whether or not sun.io.CharToByteConverter is available.
  78. private static boolean fgConvertersAvailable = false;
  79. // An array to hold the argument for a method of CharToByteConverter.
  80. private Object [] fArgsForMethod = null;
  81. // name of encoding as registered with IANA;
  82. // preferably a MIME name, but aliases are fine too.
  83. String ianaName;
  84. String javaName;
  85. int lastPrintable;
  86. // The charToByteConverter with which we test unusual characters.
  87. Object fCharToByteConverter = null;
  88. // Is the converter null because it can't be instantiated
  89. // for some reason (perhaps we're running with insufficient authority as
  90. // an applet?
  91. boolean fHaveTriedCToB = false;
  92. Charset nioCharset = null;
  93. CharsetEncoder nioCharEncoder = null;
  94. /**
  95. * Creates new <code>EncodingInfo</code> instance.
  96. */
  97. public EncodingInfo(String ianaName, String javaName, int lastPrintable) {
  98. this.ianaName = ianaName;
  99. this.javaName = EncodingMap.getIANA2JavaMapping(ianaName);
  100. this.lastPrintable = lastPrintable;
  101. try{
  102. nioCharset = Charset.forName(this.javaName);
  103. if(nioCharset.canEncode())
  104. nioCharEncoder = nioCharset.newEncoder();
  105. }catch(IllegalCharsetNameException ie){
  106. nioCharset = null;
  107. nioCharEncoder = null;
  108. }catch(UnsupportedCharsetException ue){
  109. nioCharset = null;
  110. nioCharEncoder = null;
  111. }
  112. }
  113. /**
  114. * Returns a MIME charset name of this encoding.
  115. */
  116. public String getIANAName() {
  117. return this.ianaName;
  118. }
  119. /**
  120. * Returns a writer for this encoding based on
  121. * an output stream.
  122. *
  123. * @return A suitable writer
  124. * @exception UnsupportedEncodingException There is no convertor
  125. * to support this encoding
  126. */
  127. public Writer getWriter(OutputStream output)
  128. throws UnsupportedEncodingException {
  129. // this should always be true!
  130. if (javaName != null)
  131. return new OutputStreamWriter(output, javaName);
  132. javaName = EncodingMap.getIANA2JavaMapping(ianaName);
  133. if(javaName == null)
  134. // use UTF-8 as preferred encoding
  135. return new OutputStreamWriter(output, "UTF8");
  136. return new OutputStreamWriter(output, javaName);
  137. }
  138. /**
  139. * Checks whether the specified character is printable or not
  140. * in this encoding.
  141. *
  142. * @param ch a code point (0-0x10ffff)
  143. */
  144. public boolean isPrintable(char ch) {
  145. if(ch <= this.lastPrintable)
  146. return true;
  147. if(nioCharEncoder != null)
  148. return nioCharEncoder.canEncode(ch);
  149. //We should not reach here , if we reach due to
  150. //charset not supporting encoding then fgConvertersAvailable
  151. //should take care of returning false.
  152. if(fCharToByteConverter == null) {
  153. if(fHaveTriedCToB || !fgConvertersAvailable) {
  154. // forget it; nothing we can do...
  155. return false;
  156. }
  157. if (fArgsForMethod == null) {
  158. fArgsForMethod = new Object [1];
  159. }
  160. // try and create it:
  161. try {
  162. fArgsForMethod[0] = javaName;
  163. fCharToByteConverter = fgGetConverterMethod.invoke(null, fArgsForMethod);
  164. } catch(Exception e) {
  165. // don't try it again...
  166. fHaveTriedCToB = true;
  167. return false;
  168. }
  169. }
  170. try {
  171. fArgsForMethod[0] = new Character(ch);
  172. return ((Boolean) fgCanConvertMethod.invoke(fCharToByteConverter, fArgsForMethod)).booleanValue();
  173. } catch (Exception e) {
  174. // obviously can't use this converter; probably some kind of
  175. // security restriction
  176. fCharToByteConverter = null;
  177. fHaveTriedCToB = false;
  178. return false;
  179. }
  180. }
  181. // is this an encoding name recognized by this JDK?
  182. // if not, will throw UnsupportedEncodingException
  183. public static void testJavaEncodingName(String name) throws UnsupportedEncodingException {
  184. final byte [] bTest = {(byte)'v', (byte)'a', (byte)'l', (byte)'i', (byte)'d'};
  185. String s = new String(bTest, name);
  186. }
  187. // Attempt to get methods for char to byte
  188. // converter on class initialization.
  189. static {
  190. try {
  191. Class clazz = Class.forName("sun.io.CharToByteConverter");
  192. fgGetConverterMethod = clazz.getMethod("getConverter", new Class [] {String.class});
  193. fgCanConvertMethod = clazz.getMethod("canConvert", new Class [] {Character.TYPE});
  194. fgConvertersAvailable = true;
  195. }
  196. // ClassNotFoundException, NoSuchMethodException or SecurityException
  197. // Whatever the case, we cannot use sun.io.CharToByteConverter.
  198. catch (Exception exc) {
  199. fgGetConverterMethod = null;
  200. fgCanConvertMethod = null;
  201. fgConvertersAvailable = false;
  202. }
  203. }
  204. }