src/org/apache/xalan/xsltc/runtime/output/StreamOutput.java - xalan-java - Git at Google

 /*
  * @(#)$Id$
  *
  * The Apache Software License, Version 1.1
  *
  *
  * Copyright (c) 2001 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  *
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in
  *    the documentation and/or other materials provided with the
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution,
  *    if any, must include the following acknowledgment:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
  *    Alternately, this acknowledgment may appear in the software itself,
  *    if and wherever such third-party acknowledgments normally appear.
  *
  * 4. The names "Xalan" and "Apache Software Foundation" must
  *    not be used to endorse or promote products derived from this
  *    software without prior written permission. For written
  *    permission, please contact apache@apache.org.
  *
  * 5. Products derived from this software may not be called "Apache",
  *    nor may "Apache" appear in their name, without prior written
  *    permission of the Apache Software Foundation.
  *
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES{} LOSS OF
  * USE, DATA, OR PROFITS{} OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  * ====================================================================
  *
  * This software consists of voluntary contributions made by many
  * individuals on behalf of the Apache Software Foundation and was
  * originally based on software copyright (c) 2001, Sun
  * Microsystems., http://www.sun.com.  For more
  * information on the Apache Software Foundation, please see
  * <http://www.apache.org/>.
  *
  * @author Santiago Pericas-Geertsen
  * @author G. Todd Miller
  *
  */

 package org.apache.xalan.xsltc.runtime.output;

 import java.io.Writer;
 import java.io.IOException;
 import java.io.OutputStream;
 import java.io.OutputStreamWriter;
 import java.io.UnsupportedEncodingException;

 import java.util.Vector;

 import org.apache.xalan.xsltc.TransletException;

 abstract class StreamOutput extends OutputBase {

     protected static final String AMP      = "&amp;";
     protected static final String LT       = "&lt;";
     protected static final String GT       = "&gt;";
     protected static final String CRLF     = "&#xA;";
     protected static final String QUOTE    = "&quot;";
     protected static final String NBSP     = "&nbsp;";

     protected static final String CHAR_ESC_START  = "&#";

     protected static final char[] INDENT = "                    ".toCharArray();
     protected static final int MAX_INDENT_LEVEL = (INDENT.length >> 1);
     protected static final int MAX_INDENT       = INDENT.length;

     protected static final int BUFFER_SIZE = 64 * 1024;
     protected static final int OUTPUT_BUFFER_SIZE = 4 * 1024;

     protected Writer  _writer;
     protected StringBuffer _buffer;

     protected boolean _is8859Encoded = false;
     protected boolean _indent     = false;
     protected boolean _omitHeader = false;
     protected String  _standalone = null;
     protected String  _version    = "1.0";

     protected boolean _lineFeedNextStartTag = false;
     protected boolean _linefeedNextEndTag   = false;
     protected boolean _indentNextEndTag     = false;
     protected int     _indentLevel          = 0;

     protected boolean _escaping     = true;
     protected String  _encoding     = "UTF-8";

     protected int     _indentNumber = 2;

     // protected HashSet _attributes = new HashSet();
     protected Vector _attributes = new Vector();

     static class Attribute {
 	public String name, value;

 	Attribute(String name, String value) {
 	    this.name = name;
 	    this.value = value;
 	}

 	public int hashCode() {
 	    return name.hashCode();
 	}

 	public boolean equals(Object obj) {
 	    try {
 		return name.equalsIgnoreCase(((Attribute) obj).name);
 	    }
 	    catch (ClassCastException e) {
 		return false;
 	    }
 	}
     }

     protected StreamOutput(StreamOutput output) {
 	_writer = output._writer;
 	_encoding = output._encoding;
 	_is8859Encoded = output._is8859Encoded;
 	_buffer = output._buffer;
 	_indentNumber = output._indentNumber;
     }

     protected StreamOutput(Writer writer, String encoding) {
 	_writer = writer;
 	_encoding = encoding;
 	_is8859Encoded = encoding.equalsIgnoreCase("iso-8859-1");
 	_buffer = new StringBuffer(BUFFER_SIZE);
     }

     protected StreamOutput(OutputStream out, String encoding)
 	throws IOException
     {
 	try {
 	    _writer = new OutputStreamWriter(out, _encoding = encoding);
 	    _is8859Encoded = encoding.equalsIgnoreCase("iso-8859-1");
 	}
 	catch (UnsupportedEncodingException e) {
 	    _writer = new OutputStreamWriter(out, _encoding = "utf-8");
 	}
 	_buffer = new StringBuffer(BUFFER_SIZE);
     }

     public void setIndentNumber(int value) {
 	_indentNumber = value;
     }

     /**
      * Set the output document system/public identifiers
      */
     public void setDoctype(String system, String pub) {
 	_doctypeSystem = system;
 	_doctypePublic = pub;
     }

     public void setIndent(boolean indent) {
 // System.out.println("StreamOutput.setIndent() indent = " + indent);
 	_indent = indent;
     }

     public void omitHeader(boolean value) {
         _omitHeader = value;
     }

     public void setStandalone(String standalone) {
 	_standalone = standalone;
     }

     public void setVersion(String version) {
 	_version = version;
     }

     protected void outputBuffer() {
 	try {
 	    int n = 0;
 	    final int length = _buffer.length();
 	    final String output = _buffer.toString();

 	    // Output buffer in chunks of OUTPUT_BUFFER_SIZE
 	    if (length > OUTPUT_BUFFER_SIZE) {
 		do {
 		    _writer.write(output, n, OUTPUT_BUFFER_SIZE);
 		    n += OUTPUT_BUFFER_SIZE;
 		} while (n + OUTPUT_BUFFER_SIZE < length);
 	    }
 	    _writer.write(output, n, length - n);
 	    _writer.flush();
 	}
 	catch (IOException e) {
 	    // ignore
 	}
     }

     protected void appendDTD(String name) {
 	_buffer.append("<!DOCTYPE ").append(name);
 	if (_doctypePublic == null) {
 	    _buffer.append(" SYSTEM");
 	}
 	else {
 	    _buffer.append(" PUBLIC \"").append(_doctypePublic).append("\"");
 	}
 	if (_doctypeSystem != null) {
 	    _buffer.append(" \"").append(_doctypeSystem).append("\">\n");
 	}
 	else {
 	    _buffer.append(">\n");
 	}
     }

     /**
      * Adds a newline in the output stream and indents to correct level
      */
     protected void indent(boolean linefeed) {
         if (linefeed) {
             _buffer.append('\n');
 	}

 	_buffer.append(INDENT, 0,
 	    _indentLevel < MAX_INDENT_LEVEL ? _indentLevel * _indentNumber
 		: MAX_INDENT);
     }

     protected void escapeCharacters(char[] ch, int off, int len) {
 	int limit = off + len;
 	int offset = off;

 	if (limit > ch.length) {
 	    limit = ch.length;
 	}

 	// Step through characters and escape all special characters
 	for (int i = off; i < limit; i++) {
 	    final char current = ch[i];

 	    switch (current) {
 	    case '&':
 		_buffer.append(ch, offset, i - offset);
 		_buffer.append(AMP);
 		offset = i + 1;
 		break;
 	    case '<':
 		_buffer.append(ch, offset, i - offset);
 		_buffer.append(LT);
 		offset = i + 1;
 		break;
 	    case '>':
 		_buffer.append(ch, offset, i - offset);
 		_buffer.append(GT);
 		offset = i + 1;
 		break;
 	    case '\u00a0':
 		_buffer.append(ch, offset, i - offset);
 		_buffer.append(NBSP);
 		offset = i + 1;
 		break;
 	    default:
 		if ((current >= '\u007F' && current < '\u00A0') ||
 		    (_is8859Encoded && current > '\u00FF'))
 		{
 		    _buffer.append(ch, offset, i - offset);
 		    _buffer.append(CHAR_ESC_START);
 		    _buffer.append(Integer.toString((int)ch[i]));
 		    _buffer.append(';');
 		    offset = i + 1;
 		}
 	    }
 	}
 	// Output remaining characters (that do not need escaping).
 	if (offset < limit) {
 	    _buffer.append(ch, offset, limit - offset);
 	}
     }

     protected void appendAttributes() {
 	// Append attributes to output buffer
 	if (!_attributes.isEmpty()) {
 	    int i = 0;
 	    final int length = _attributes.size();

 	    do {
 		final Attribute attr = (Attribute) _attributes.elementAt(i);
 		_buffer.append(' ').append(attr.name).append("=\"")
 		       .append(attr.value).append('"');
 	    } while (++i < length);

 	    _attributes.clear();
 	}
     }

     protected void closeStartTag() throws TransletException {
 	appendAttributes();
 	_buffer.append('>');
 	_startTagOpen = false;
     }

     /**
      * Ensure that comments do not include the sequence "--" and
      * that they do not end with "-".
      */
     protected void appendComment(String comment)
 	throws TransletException
     {
 	boolean lastIsDash = false;
 	final int n = comment.length();

 	_buffer.append("<!--");
 	for (int i = 0; i < n; i++) {
 	    final char ch = comment.charAt(i);
 	    final boolean isDash = (ch == '-');

 	    if (lastIsDash && isDash) {
 		_buffer.append(" -");
 	    }
 	    else {
 		_buffer.append(ch);
 	    }
 	    lastIsDash = isDash;
 	}
 	if (lastIsDash) {
 	    _buffer.append(' ');
 	}
 	_buffer.append("-->");
     }
 }
	/*
	* @(#)$Id$
	*
	* The Apache Software License, Version 1.1
	*
	*
	* Copyright (c) 2001 The Apache Software Foundation. All rights
	* reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	*
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	*
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in
	* the documentation and/or other materials provided with the
	* distribution.
	*
	* 3. The end-user documentation included with the redistribution,
	* if any, must include the following acknowledgment:
	* "This product includes software developed by the
	* Apache Software Foundation (http://www.apache.org/)."
	* Alternately, this acknowledgment may appear in the software itself,
	* if and wherever such third-party acknowledgments normally appear.
	*
	* 4. The names "Xalan" and "Apache Software Foundation" must
	* not be used to endorse or promote products derived from this
	* software without prior written permission. For written
	* permission, please contact apache@apache.org.
	*
	* 5. Products derived from this software may not be called "Apache",
	* nor may "Apache" appear in their name, without prior written
	* permission of the Apache Software Foundation.
	*
	* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
	* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES{} LOSS OF
	* USE, DATA, OR PROFITS{} OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
	* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
	* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	* SUCH DAMAGE.
	* ====================================================================
	*
	* This software consists of voluntary contributions made by many
	* individuals on behalf of the Apache Software Foundation and was
	* originally based on software copyright (c) 2001, Sun
	* Microsystems., http://www.sun.com. For more
	* information on the Apache Software Foundation, please see
	* <http://www.apache.org/>.
	*
	* @author Santiago Pericas-Geertsen
	* @author G. Todd Miller
	*
	*/

	package org.apache.xalan.xsltc.runtime.output;

	import java.io.Writer;
	import java.io.IOException;
	import java.io.OutputStream;
	import java.io.OutputStreamWriter;
	import java.io.UnsupportedEncodingException;

	import java.util.Vector;

	import org.apache.xalan.xsltc.TransletException;

	abstract class StreamOutput extends OutputBase {

	protected static final String AMP = "&";
	protected static final String LT = "<";
	protected static final String GT = ">";
	protected static final String CRLF = " ";
	protected static final String QUOTE = """;
	protected static final String NBSP = " ";

	protected static final String CHAR_ESC_START = "&#";

	protected static final char[] INDENT = " ".toCharArray();
	protected static final int MAX_INDENT_LEVEL = (INDENT.length >> 1);
	protected static final int MAX_INDENT = INDENT.length;

	protected static final int BUFFER_SIZE = 64 * 1024;
	protected static final int OUTPUT_BUFFER_SIZE = 4 * 1024;

	protected Writer _writer;
	protected StringBuffer _buffer;

	protected boolean _is8859Encoded = false;
	protected boolean _indent = false;
	protected boolean _omitHeader = false;
	protected String _standalone = null;
	protected String _version = "1.0";

	protected boolean _lineFeedNextStartTag = false;
	protected boolean _linefeedNextEndTag = false;
	protected boolean _indentNextEndTag = false;
	protected int _indentLevel = 0;

	protected boolean _escaping = true;
	protected String _encoding = "UTF-8";

	protected int _indentNumber = 2;

	// protected HashSet _attributes = new HashSet();
	protected Vector _attributes = new Vector();

	static class Attribute {
	public String name, value;

	Attribute(String name, String value) {
	this.name = name;
	this.value = value;
	}

	public int hashCode() {
	return name.hashCode();
	}

	public boolean equals(Object obj) {
	try {
	return name.equalsIgnoreCase(((Attribute) obj).name);
	}
	catch (ClassCastException e) {
	return false;
	}
	}
	}

	protected StreamOutput(StreamOutput output) {
	_writer = output._writer;
	_encoding = output._encoding;
	_is8859Encoded = output._is8859Encoded;
	_buffer = output._buffer;
	_indentNumber = output._indentNumber;
	}

	protected StreamOutput(Writer writer, String encoding) {
	_writer = writer;
	_encoding = encoding;
	_is8859Encoded = encoding.equalsIgnoreCase("iso-8859-1");
	_buffer = new StringBuffer(BUFFER_SIZE);
	}

	protected StreamOutput(OutputStream out, String encoding)
	throws IOException
	{
	try {
	_writer = new OutputStreamWriter(out, _encoding = encoding);
	_is8859Encoded = encoding.equalsIgnoreCase("iso-8859-1");
	}
	catch (UnsupportedEncodingException e) {
	_writer = new OutputStreamWriter(out, _encoding = "utf-8");
	}
	_buffer = new StringBuffer(BUFFER_SIZE);
	}

	public void setIndentNumber(int value) {
	_indentNumber = value;
	}

	/**
	* Set the output document system/public identifiers
	*/
	public void setDoctype(String system, String pub) {
	_doctypeSystem = system;
	_doctypePublic = pub;
	}

	public void setIndent(boolean indent) {
	// System.out.println("StreamOutput.setIndent() indent = " + indent);
	_indent = indent;
	}

	public void omitHeader(boolean value) {
	_omitHeader = value;
	}

	public void setStandalone(String standalone) {
	_standalone = standalone;
	}

	public void setVersion(String version) {
	_version = version;
	}

	protected void outputBuffer() {
	try {
	int n = 0;
	final int length = _buffer.length();
	final String output = _buffer.toString();

	// Output buffer in chunks of OUTPUT_BUFFER_SIZE
	if (length > OUTPUT_BUFFER_SIZE) {
	do {
	_writer.write(output, n, OUTPUT_BUFFER_SIZE);
	n += OUTPUT_BUFFER_SIZE;
	} while (n + OUTPUT_BUFFER_SIZE < length);
	}
	_writer.write(output, n, length - n);
	_writer.flush();
	}
	catch (IOException e) {
	// ignore
	}
	}

	protected void appendDTD(String name) {
	_buffer.append("<!DOCTYPE ").append(name);
	if (_doctypePublic == null) {
	_buffer.append(" SYSTEM");
	}
	else {
	_buffer.append(" PUBLIC \"").append(_doctypePublic).append("\"");
	}
	if (_doctypeSystem != null) {
	_buffer.append(" \"").append(_doctypeSystem).append("\">\n");
	}
	else {
	_buffer.append(">\n");
	}
	}

	/**
	* Adds a newline in the output stream and indents to correct level
	*/
	protected void indent(boolean linefeed) {
	if (linefeed) {
	_buffer.append('\n');
	}

	_buffer.append(INDENT, 0,
	_indentLevel < MAX_INDENT_LEVEL ? _indentLevel * _indentNumber
	: MAX_INDENT);
	}

	protected void escapeCharacters(char[] ch, int off, int len) {
	int limit = off + len;
	int offset = off;

	if (limit > ch.length) {
	limit = ch.length;
	}

	// Step through characters and escape all special characters
	for (int i = off; i < limit; i++) {
	final char current = ch[i];

	switch (current) {
	case '&':
	_buffer.append(ch, offset, i - offset);
	_buffer.append(AMP);
	offset = i + 1;
	break;
	case '<':
	_buffer.append(ch, offset, i - offset);
	_buffer.append(LT);
	offset = i + 1;
	break;
	case '>':
	_buffer.append(ch, offset, i - offset);
	_buffer.append(GT);
	offset = i + 1;
	break;
	case '\u00a0':
	_buffer.append(ch, offset, i - offset);
	_buffer.append(NBSP);
	offset = i + 1;
	break;
	default:
	if ((current >= '\u007F' && current < '\u00A0') \|\|
	(_is8859Encoded && current > '\u00FF'))
	{
	_buffer.append(ch, offset, i - offset);
	_buffer.append(CHAR_ESC_START);
	_buffer.append(Integer.toString((int)ch[i]));
	_buffer.append(';');
	offset = i + 1;
	}
	}
	}
	// Output remaining characters (that do not need escaping).
	if (offset < limit) {
	_buffer.append(ch, offset, limit - offset);
	}
	}

	protected void appendAttributes() {
	// Append attributes to output buffer
	if (!_attributes.isEmpty()) {
	int i = 0;
	final int length = _attributes.size();

	do {
	final Attribute attr = (Attribute) _attributes.elementAt(i);
	_buffer.append(' ').append(attr.name).append("=\"")
	.append(attr.value).append('"');
	} while (++i < length);

	_attributes.clear();
	}
	}

	protected void closeStartTag() throws TransletException {
	appendAttributes();
	_buffer.append('>');
	_startTagOpen = false;
	}

	/**
	* Ensure that comments do not include the sequence "--" and
	* that they do not end with "-".
	*/
	protected void appendComment(String comment)
	throws TransletException
	{
	boolean lastIsDash = false;
	final int n = comment.length();

	_buffer.append("<!--");
	for (int i = 0; i < n; i++) {
	final char ch = comment.charAt(i);
	final boolean isDash = (ch == '-');

	if (lastIsDash && isDash) {
	_buffer.append(" -");
	}
	else {
	_buffer.append(ch);
	}
	lastIsDash = isDash;
	}
	if (lastIsDash) {
	_buffer.append(' ');
	}
	_buffer.append("-->");
	}
	}