src/XSLT/XSLTResultTarget.hpp

/*
 * The Apache Software License, Version 1.1
 *
 *
 * Copyright (c) 1999 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) 1999, International
 * Business Machines, Inc., http://www.ibm.com.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 * $ Id: $
 
 */

#if !defined(XALAN_XSLTRESULTTARGET_HEADER_GUARD)
#define XALAN_XSLTRESULTTARGET_HEADER_GUARD

// Base include file.  Must be first.
#include "XSLTDefinitions.hpp"



#if defined(XALAN_OLD_STREAMS)
class ostream;
#else
#include <iosfwd>
#endif



#include <XalanDOM/XalanDOMString.hpp>



class FormatterListener;
class XalanDocument;
class XalanDocumentFragment;
class XalanElement;
class Writer;



class XALAN_XSLT_EXPORT XSLTResultTarget
{
public:

	explicit
	XSLTResultTarget();

	/**
	 * Create a new output target with a file name.
	 *
	 * @param fileName valid system file name
	 */
	XSLTResultTarget(const XalanDOMString&	fileName);

	/**
	 * Create a new output target with a file name.
	 *
	 * @param fileName valid system file name
	 */
	XSLTResultTarget(const char*	fileName);

	/**
	 * Create a new output target with a stream.
	 *
	 * @param byteStream a pointer to a std ostream for the output
	 */
#if defined(XALAN_NO_NAMESPACES)
	XSLTResultTarget(ostream*		theStream);
#else
	XSLTResultTarget(std::ostream*	theStream);
#endif

	/**
	 * Create a new output target with a stream.
	 *
	 * @param byteStream a reference to a std ostream for the output
	 */
#if defined(XALAN_NO_NAMESPACES)
	XSLTResultTarget(ostream&		theStream);
#else
	XSLTResultTarget(std::ostream&	theStream);
#endif

	/**
	 * Create a new output target with a character stream.
	 *
	 * @param characterStream pointer to character stream where the results
	 *                        will be written
	 */ 
	XSLTResultTarget(Writer*	characterStream);

	/**
	 * Create a new output target with a DOM document.
	 *
	 * @param n root of DOM node tree that holds results
	 */
	XSLTResultTarget(XalanDocument*		document);

	/**
	 * Create a new output target with a DOM document fragment.
	 *
	 * @param n root of DOM node tree that holds results
	 */
	XSLTResultTarget(XalanDocumentFragment*		documentFragment);

	/**
	 * Create a new output target with a DOM element.
	 *
	 * @param n root of DOM node tree that holds results
	 */
	XSLTResultTarget(XalanElement*	element);

	/**
	 * Create a new output target with a FormatterListener.
	 *
	 * @param flistener A FormatterListener instance for result tree events.
	 */
	XSLTResultTarget(FormatterListener&		flistener);

	/**
	 * Set the file name where the results will be written.
	 *
	 * @param fileName system identifier as a string
	 */
	void
	setFileName(const XalanDOMString&	fileName)
	{
		m_fileName = fileName;
	}

	/**
	 * Get the file name where the results will be written to.
	 * 
	 * @return file name string
	 */
	const XalanDOMString&
	getFileName() const
	{
		return m_fileName;
	}

	/**
	 * Set the byte stream for this output target.
	 *
	 * @param byteStream pointer to byte stream that will contain the result
	 *                   document
	 */
	void
#if defined(XALAN_NO_NAMESPACES)
	setByteStream(ostream*			byteStream)
#else
	setByteStream(std::ostream*		byteStream)
#endif
	{
		m_byteStream = byteStream;
	}

	/**
	 * Get the byte stream for this output target.
	 *
	 * @return pointer to byte stream, or null if none was supplied.
	 */
#if defined(XALAN_NO_NAMESPACES)
	ostream*
#else
	std::ostream*
#endif
	getByteStream() const
	{
		return m_byteStream;
	}

	/** 
	 * Set the character encoding, if known.
	 *
	 * @param encoding new encoding string
	 */
	void
	setEncoding(const XalanDOMString&	encoding)
	{
		m_encoding = encoding;
	}

	/**
	 * Get the character encoding in use.
	 *
	 * @return encoding string, or empty string if none was supplied.
	 */
	const XalanDOMString&
	getEncoding() const
	{
		return m_encoding;
	}

	/**
	 * Set the character stream for this output target.
	 *
	 * @param characterStream pointer to character stream that will contain 
	 *                        the result document
	 */
	void
	setCharacterStream(Writer*	characterStream)
	{
		m_characterStream = characterStream;
	}

	/**
	 * Get the character stream for this output target.
	 *
	 * @return pointer to character stream, or null if none was supplied.
	 */
	Writer*
	getCharacterStream() const
	{
		return m_characterStream;
	}

	bool
	hasDOMTarget() const
	{
		return m_document != 0 || m_documentFragment != 0 || m_element != 0;
	}

	/**
	 * Set the document node that will contain the result nodes.
	 *
	 * @param node DOM node to contain results
	 */
	void
	setDocument(XalanDocument*		document)
	{
		m_document = document;

		m_documentFragment = 0;
		m_element = 0;
	}

	/**
	 * Get the document node that will contain the result nodes.
	 *
	 * @return a pointer to the document node
	 */
	XalanDocument*
	getDocument() const
	{
		return m_document;
	}

	/**
	 * Set the document fragment node that will contain the result nodes.
	 *
	 * @param node DOM node to contain results
	 */
	void
	setDocumentFragment(XalanDocumentFragment*	documentFragment)
	{
		m_documentFragment = documentFragment;

		m_document = 0;
		m_element = 0;
	}

	/**
	 * Get the document node that will contain the result nodes.
	 *
	 * @return a pointer to the document node
	 */
	XalanDocumentFragment*
	getDocumentFragment() const
	{
		return m_documentFragment;
	}

	/**
	 * Set the element node that will contain the result nodes.
	 *
	 * @param node DOM node to contain results
	 */
	void
	setElement(XalanElement*	element)
	{
		m_element = element;

		m_documentFragment = 0;
		m_document = 0;
	}

	/**
	 * Get the document node that will contain the result nodes.
	 *
	 * @return a pointer to the document node
	 */
	XalanElement*
	getElement() const
	{
		return m_element;
	}

	/**
	 * Set a SAX DocumentHandler to process the result tree events.
	 *
	 * @param handler pointer to new handler
	 */
	void
	setDocumentHandler(FormatterListener*	handler)
	{
		m_formatterListener = handler;
	}

	/**
	 * Get the SAX DocumentHandler that will process the result tree events.
	 *
	 * @return pointer to current handler
	 */
	FormatterListener*
	getDocumentHandler() const
	{
		return m_formatterListener;
	}

	/**
	 * Set a FormatterListener to process the result tree events.
	 *
	 * @param handler pointer to new listener
	 */
	void
	setFormatterListener(FormatterListener*		handler)
	{
		m_formatterListener = handler;
	}

	/**
	 * Get the FormatterListener that will process the result tree events.
	 *
	 * @return pointer to new listener
	 */
	FormatterListener*
	getFormatterListener() const
	{
		return m_formatterListener;
	}

private:

	XalanDOMString			m_fileName;

#if defined(XALAN_NO_NAMESPACES)
	ostream*				m_byteStream;
#else
	std::ostream*			m_byteStream;
#endif

	XalanDOMString			m_encoding;

	Writer*					m_characterStream;

	XalanDocument*			m_document;

	XalanDocumentFragment*	m_documentFragment;

	XalanElement*			m_element;

	FormatterListener*		m_formatterListener;
};



#endif	// XALAN_XSLTRESULTTARGET_HEADER_GUARD