Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.7

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

FormatterToText.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2004 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(FORMATTERTOTEXT_HEADER_GUARD_1357924680)
00058 #define FORMATTERTOTEXT_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <xalanc/XMLSupport/XMLSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00068 
00069 
00070 
00071 // Base class header file.
00072 #include <xalanc/PlatformSupport/FormatterListener.hpp>
00073 
00074 
00075 
00076 XALAN_CPP_NAMESPACE_BEGIN
00077 
00078 
00079 
00080 class Writer;
00081 
00082 
00083 
00088 class XALAN_XMLSUPPORT_EXPORT FormatterToText : public FormatterListener
00089 {
00090 public:
00091 
00095     FormatterToText();
00096 
00104     FormatterToText(
00105             Writer&     writer,
00106             bool        normalizeLinefeed = true,
00107             bool        handleIgnorableWhitespace = true);
00108 
00117     FormatterToText(
00118             Writer&                 writer,
00119             const XalanDOMString&   encoding,
00120             bool                    normalizeLinefeed = true,
00121             bool                    handleIgnorableWhitespace = true);
00122 
00123     virtual
00124     ~FormatterToText();
00125 
00126 
00127     Writer*
00128     getWriter() const
00129     {
00130         return m_writer;
00131     }
00132 
00133     void
00134     setWriter(Writer*   theWriter)
00135     {
00136         m_writer = theWriter;
00137 
00138         update(false);
00139     }
00140 
00141     void
00142     clearEncoding();
00143 
00144     const XalanDOMString&
00145     getEncoding() const
00146     {
00147         return m_encoding;
00148     }
00149 
00150     void
00151     setEncoding(const XalanDOMString&   theEncoding)
00152     {
00153         m_encoding = theEncoding;
00154 
00155         update(false);
00156     }
00157 
00158     XalanDOMChar
00159     getMaxCharacter() const
00160     {
00161         return m_maxCharacter;
00162     }
00163 
00164     void
00165     setMaxCharacter(XalanDOMChar    theMaxChar)
00166     {
00167         m_maxCharacter = theMaxChar;
00168     }
00169 
00170     bool
00171     getNormalizeLinefeed() const
00172     {
00173         return m_normalize;
00174     }
00175 
00176     void
00177     setNormalizeLinefeed(bool   fNormalize)
00178     {
00179         m_normalize = fNormalize;
00180     }
00181 
00182     bool
00183     getHandleIgnorableWhitespace() const
00184     {
00185         return m_handleIgnorableWhitespace;
00186     }
00187 
00188     void
00189     setHandleIgnorableWhitespace(bool   fHandle)
00190     {
00191         m_handleIgnorableWhitespace = fHandle;
00192     }
00193 
00194     // These methods are inherited from FormatterListener ...
00195 
00196     virtual void
00197     setDocumentLocator(const LocatorType* const     locator);
00198 
00199     virtual void
00200     startDocument();
00201 
00202     virtual void
00203     endDocument();
00204 
00205     virtual void
00206     startElement(
00207             const XMLCh* const  name,
00208             AttributeListType&  attrs);
00209 
00210     virtual void
00211     endElement(const XMLCh* const   name);
00212 
00213     virtual void
00214     characters(
00215             const XMLCh* const  chars,
00216             const unsigned int  length);
00217 
00218     virtual void
00219     charactersRaw(
00220             const XMLCh* const  chars,
00221             const unsigned int  length);
00222 
00223     virtual void
00224     entityReference(const XMLCh* const  name);
00225 
00226     virtual void
00227     ignorableWhitespace(
00228             const XMLCh* const  chars,
00229             const unsigned int  length);
00230 
00231     virtual void
00232     processingInstruction(
00233             const XMLCh* const  target,
00234             const XMLCh* const  data);
00235 
00236     virtual void
00237     resetDocument();
00238 
00239     virtual void
00240     comment(const XMLCh* const  data);
00241 
00242     virtual void
00243     cdata(
00244             const XMLCh* const  ch,
00245             const unsigned int  length);
00246 
00247 private:
00248 
00249     // These are not implemented.
00250     FormatterToText(const FormatterToText&);
00251 
00252     FormatterToText&
00253     operator=(const FormatterToText&);
00254 
00255     bool
00256     operator==(const FormatterToText&) const;
00257 
00258     // Utility function to update various member variables
00259     // when data changes.
00260     void
00261     update(bool fNormalizationOnly);
00262 
00263     // Data members...
00264     Writer*         m_writer;
00265 
00266     XalanDOMChar    m_maxCharacter;
00267 
00268     XalanDOMString  m_encoding;
00269 
00270     bool            m_haveEncoding;
00271 
00272     bool            m_normalize;
00273 
00274     bool            m_handleIgnorableWhitespace;
00275 
00276     const XalanDOMChar*         m_newlineString;
00277 
00278     XalanDOMString::size_type   m_newlineStringLength;
00279 };
00280 
00281 
00282 
00283 XALAN_CPP_NAMESPACE_END
00284 
00285 
00286 
00287 #endif  // FORMATTERTOTEXT_HEADER_GUARD_1357924680

Interpreting class diagrams

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

Xalan-C++ XSLT Processor Version 1.7
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.