ISO88591Escaper


1   /*
2   Copyright (c) 2004, Dennis M. Sosnoski.
3   All rights reserved.
4   
5   Redistribution and use in source and binary forms, with or without modification,
6   are permitted provided that the following conditions are met:
7   
8    * Redistributions of source code must retain the above copyright notice, this
9      list of conditions and the following disclaimer.
10   * Redistributions in binary form must reproduce the above copyright notice,
11     this list of conditions and the following disclaimer in the documentation
12     and/or other materials provided with the distribution.
13   * Neither the name of JiBX nor the names of its contributors may be used
14     to endorse or promote products derived from this software without specific
15     prior written permission.
16  
17  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
21  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
24  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28  
29  package org.jibx.runtime.impl;
30  
31  import java.io.IOException  ;
32  import java.io.Writer  ;
33  
34  import org.jibx.runtime.ICharacterEscaper;
35  
36  /**
37   * Handler for writing ASCII output stream. This code is specifically for XML
38   * 1.0 and would require changes for XML 1.1 (to handle the added legal
39   * characters, rather than throwing an exception).
40   *
41   * @author Dennis M. Sosnoski
42   * @version 1.0
43   */
44  
45  public class ISO88591Escaper implements ICharacterEscaper
46  {
47      /** Singleton instance of class. */
48      private static final ISO88591Escaper s_instance = new ISO88591Escaper();
49      
50      /**
51       * Private constructor to prevent external creation.
52       */
53      
54      private ISO88591Escaper() {}
55      
56      /**
57       * Write attribute value with character entity substitutions. This assumes
58       * that attributes use the regular quote ('"') delimitor.
59       *
60       * @param text attribute value text
61       * @param writer sink for output text
62       * @throws IOException on error writing to document
63       */
64  
65      public void writeAttribute(String   text, Writer   writer) throws IOException   {
66          int mark = 0;
67          for (int i = 0; i < text.length(); i++) {
68              char chr = text.charAt(i);
69              if (chr == '"') {
70                  writer.write(text, mark, i-mark);
71                  mark = i+1;
72                  writer.write("&quot;");
73              } else if (chr == '&') {
74                  writer.write(text, mark, i-mark);
75                  mark = i+1;
76                  writer.write("&amp;");
77              } else if (chr == '<') {
78                  writer.write(text, mark, i-mark);
79                  mark = i+1;
80                  writer.write("&lt;");
81              } else if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
82                  text.charAt(i-2) == ']') {
83                  writer.write(text, mark, i-mark-2);
84                  mark = i+1;
85                  writer.write("]]&gt;");
86              } else if (chr < 0x20) {
87                  if (chr != 0x9 && chr != 0xA && chr != 0xD) {
88                      throw new IOException  ("Illegal character code 0x" +
89                          Integer.toHexString(chr) + " in attribute value text");
90                  }
91              } else if (chr >= 0x80) {
92                  if (chr < 0xA0 || chr > 0xFF) {
93                      writer.write(text, mark, i-mark);
94                      mark = i+1;
95                      if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
96                          chr == 0xFFF || chr > 0x10FFFF)) {
97                          throw new IOException  ("Illegal character code 0x" +
98                              Integer.toHexString(chr) +
99                              " in attribute value text");
100                     }
101                     writer.write("&#x");
102                     writer.write(Integer.toHexString(chr));
103                     writer.write(';');
104                 }
105             }
106         }
107         writer.write(text, mark, text.length()-mark);
108     }
109     
110     /**
111      * Write content value with character entity substitutions.
112      *
113      * @param text content value text
114      * @param writer sink for output text
115      * @throws IOException on error writing to document
116      */
117 
118     public void writeContent(String   text, Writer   writer) throws IOException   {
119         int mark = 0;
120         for (int i = 0; i < text.length(); i++) {
121             char chr = text.charAt(i);
122             if (chr == '&') {
123                 writer.write(text, mark, i-mark);
124                 mark = i+1;
125                 writer.write("&amp;");
126             } else if (chr == '<') {
127                 writer.write(text, mark, i-mark);
128                 mark = i+1;
129                 writer.write("&lt;");
130             } else if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
131                 text.charAt(i-2) == ']') {
132                 writer.write(text, mark, i-mark-2);
133                 mark = i+1;
134                 writer.write("]]&gt;");
135             } else if (chr < 0x20) {
136                 if (chr != 0x9 && chr != 0xA && chr != 0xD) {
137                     throw new IOException  ("Illegal character code 0x" +
138                         Integer.toHexString(chr) + " in content text");
139                 }
140             } else if (chr >= 0x80) {
141                 if (chr < 0xA0 || chr > 0xFF) {
142                     writer.write(text, mark, i-mark);
143                     mark = i+1;
144                     if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
145                         chr == 0xFFF || chr > 0x10FFFF)) {
146                         throw new IOException  ("Illegal character code 0x" +
147                             Integer.toHexString(chr) + " in content text");
148                     }
149                     writer.write("&#x");
150                     writer.write(Integer.toHexString(chr));
151                     writer.write(';');
152                 }
153             }
154         }
155         writer.write(text, mark, text.length()-mark);
156     }
157     
158     /**
159      * Write CDATA to document. This writes the beginning and ending sequences
160      * for a CDATA section as well as the actual text, verifying that only
161      * characters allowed by the encoding are included in the text.
162      *
163      * @param text content value text
164      * @param writer sink for output text
165      * @throws IOException on error writing to document
166      */
167 
168     public void writeCData(String   text, Writer   writer) throws IOException   {
169         writer.write("<![CDATA[");
170         for (int i = 0; i < text.length(); i++) {
171             char chr = text.charAt(i);
172             if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
173                 text.charAt(i-2) == ']') {
174                 throw new IOException  ("Sequence \"]]>\" is not allowed " +
175                     "within CDATA section text");
176             } else if (chr < 0x20) {
177                 if (chr != 0x9 && chr != 0xA && chr != 0xD) {
178                     throw new IOException  ("Illegal character code 0x" +
179                         Integer.toHexString(chr) + " in CDATA section");
180                 }
181             } else if (chr >= 0x80 && (chr < 0xA0 || chr > 0xFF)) {
182                 throw new IOException  ("Character code 0x" +
183                     Integer.toHexString(chr) +
184                     " not supported by encoding in CDATA section");
185             }
186         }
187         writer.write(text);
188         writer.write("]]>");
189     }
190     
191     /**
192      * Get instance of escaper.
193      *
194      * @return escaper instance
195      */
196     
197     public static ICharacterEscaper getInstance() {
198         return s_instance;
199     }
200 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags