Xalan-C++ API Documentation

The Xalan-C++ XSL Transformer Version 1.0

Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XercesTextOutputStream.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "Xalan" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 1999, International
00053  * Business Machines, Inc., http://www.ibm.com.  For more
00054  * information on the Apache Software Foundation, please see
00055  * <http://www.apache.org/>.
00056  */
00057 #if !defined(XERCESTEXTOUTPUTSTREAM_HEADER_GUARD_1357924680)
00058 #define XERCESTEXTOUTPUTSTREAM_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <XercesPlatformSupport/XercesPlatformSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #include <cstdio>
00068 #include <vector>
00069 
00070 
00071 
00072 // Base class header file.
00073 #include <PlatformSupport/TextOutputStream.hpp>
00074 
00075 
00076 
00077 #include <XercesPlatformSupport/XercesPlatformSupportException.hpp>
00078 
00079 
00080 
00081 // A base class for all text output streams.
00082 class XALAN_XERCESPLATFORMSUPPORT_EXPORT XercesTextOutputStream : public TextOutputStream
00083 {
00084 public :
00085 
00086     virtual
00087     ~XercesTextOutputStream();
00088 
00089     // These interfaces are inherited from TextOutputStream...
00090 
00091     virtual void
00092     flush();
00093 
00094     virtual void
00095     write(char  theChar);
00096 
00097     virtual void
00098     write(XalanDOMChar  theChar);
00099 
00100     virtual void
00101     write(const char*   theBuffer);
00102 
00103     virtual void
00104     write(const XalanDOMChar*   theBuffer);
00105 
00106     virtual void
00107     write(
00108             const char*     theBuffer,
00109             unsigned long   theBufferLength);
00110 
00111     virtual void
00112     write(
00113             const XalanDOMChar*     theBuffer,
00114             unsigned long           theBufferLength);
00115 
00116     enum
00117     {
00118         eDefaultBufferSize = 512
00119     };
00120 
00121     typedef std::vector<XalanDOMChar>   BufferType;
00122 
00123     virtual void
00124     setBufferSize(BufferType::size_type     theBufferSize);
00125 
00126 protected:
00127 
00133     explicit
00134     XercesTextOutputStream(BufferType::size_type    theBufferSize = eDefaultBufferSize);
00135 
00136     virtual void
00137     writeData(const char*       theBuffer,
00138               unsigned long     theBufferLength) = 0;
00139 
00140     virtual void
00141     doFlush() = 0;
00142 
00143 private:
00144 
00145     // These are not implemented...
00146     XercesTextOutputStream(const XercesTextOutputStream&);
00147 
00148     XercesTextOutputStream&
00149     operator=(const XercesTextOutputStream&);
00150 
00151     // Utility functions...
00152     void
00153     flushBuffer();
00154 
00155     void
00156     doWrite(const XalanDOMChar*     theBuffer);
00157 
00158     BufferType              m_buffer;
00159 
00160     BufferType::size_type   m_bufferSize;
00161 };
00162 
00163 
00164 
00165 class XALAN_XERCESPLATFORMSUPPORT_EXPORT XercesTextOutputStreamException : public XercesPlatformSupportException
00166 {
00167 public:
00168 
00169     virtual
00170     ~XercesTextOutputStreamException();
00171 
00172 protected:
00173 
00174     XercesTextOutputStreamException(
00175         const DOMString&    theMessage,
00176         const DOMString&    theType);
00177 };
00178 
00179 
00180 
00181 #endif  // TEXTFILEOUTPUTSTREAM_HEADER_GUARD_1357924680

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C++ header files.

Xalan-C++ XSL Transformer Version 1.0
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.