Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.4

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

FormatterListener.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2002 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(FORMATTERLISTENER_HEADER_GUARD_1357924680)
00058 #define FORMATTERLISTENER_HEADER_GUARD_1357924680
00059 
00067 
00068 
00069 
00070 // Base include file.  Must be first.
00071 #include <PlatformSupport/PlatformSupportDefinitions.hpp>
00072 
00073 
00074 
00075 #include <xercesc/sax/DocumentHandler.hpp>
00076 
00077 
00078 
00079 #include <XalanDOM/XalanDOMString.hpp>
00080 
00081 
00082 
00083 class PrefixResolver;
00084 
00085 
00086 
00091 class XALAN_PLATFORMSUPPORT_EXPORT FormatterListener : public DocumentHandler
00092 {
00093 public:
00094 
00095     // A handy typedef...  Must match DocumentHandler's type for characters(), etc...
00096     typedef unsigned int    size_type;
00097 
00098     enum eFormat
00099     {
00100         OUTPUT_METHOD_NONE = 0,
00101         OUTPUT_METHOD_XML = 1,
00102         OUTPUT_METHOD_HTML = 2,
00103         OUTPUT_METHOD_TEXT = 3,
00104         OUTPUT_METHOD_DOM = 4,
00105         OUTPUT_METHOD_OTHER = 5
00106     };
00107 
00108     FormatterListener(eFormat   theFormat);
00109 
00110     virtual
00111     ~FormatterListener();
00112 
00113 
00114     eFormat
00115     getOutputFormat() const
00116     {
00117         return m_outputFormat;
00118     }
00119 
00125     const PrefixResolver*
00126     getPrefixResolver() const
00127     {
00128         return m_prefixResolver;
00129     }
00130 
00136     void
00137     setPrefixResolver(const PrefixResolver*     thePrefixResolver)
00138     {
00139         m_prefixResolver = thePrefixResolver;
00140     }
00141 
00151     virtual void
00152     charactersRaw(
00153             const XMLCh* const  chars,
00154             const size_type     length) = 0;
00155 
00162     virtual void
00163     comment(const XMLCh* const  data) = 0;
00164 
00186     virtual void
00187     cdata(
00188             const XMLCh* const  ch,
00189             const size_type     length) = 0;
00190 
00197     virtual void
00198     entityReference(const XMLCh* const  name) = 0;
00199 
00200 
00201 // These methods are inherited from DocumentHandler ...
00202 
00203     virtual void
00204     characters(
00205             const XMLCh* const  chars,
00206             const size_type     length) = 0;
00207 
00208     virtual void
00209     endDocument() = 0;
00210 
00211     virtual void
00212     endElement(const XMLCh* const   name) = 0;
00213 
00214     virtual void
00215     ignorableWhitespace(
00216             const XMLCh* const  chars,
00217             const size_type     length) = 0;
00218 
00219     virtual void
00220     processingInstruction(
00221             const XMLCh* const  target,
00222             const XMLCh* const  data) = 0;
00223 
00224     virtual void
00225     resetDocument() = 0;
00226 
00227     virtual void
00228     setDocumentLocator(const Locator* const     locator) = 0;
00229 
00230     virtual void
00231     startDocument() = 0;
00232 
00233     virtual void
00234     startElement(
00235             const   XMLCh* const    name,
00236             AttributeList&          attrs) = 0;
00237 
00238 
00239     // Used when creating PI to work around limitations of
00240     // our interfaces...
00241     static const XalanDOMChar   s_piTarget[];
00242 
00243     static const XalanDOMChar   s_piData[];
00244 
00245 #if defined(XALAN_INLINE_INITIALIZATION)
00246     static const XalanDOMString::size_type  s_piTargetLength = 5;
00247     static const XalanDOMString::size_type  s_piDataLength = 3;
00248 #else
00249     static const XalanDOMString::size_type  s_piTargetLength;
00250     static const XalanDOMString::size_type  s_piDataLength;
00251 #endif
00252 
00253 protected:
00254 
00255     // Data membmers...
00256     const PrefixResolver*   m_prefixResolver;
00257 
00258 private:
00259 
00260     // Not implemented...
00261     FormatterListener(const FormatterListener&);
00262 
00263     FormatterListener&
00264     operator=(const FormatterListener&);
00265 
00266     bool
00267     operator==(const FormatterListener&) const;
00268 
00269     // Data membmers...
00270     const eFormat           m_outputFormat;
00271 };
00272 
00273 
00274 
00275 #endif  // FORMATTERLISTENER_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.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.