## Xalan-C++ API Documentation

### The Xalan C++ XSLT Processor Version 1.5

Main Page 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
    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 XALAN_CPP_NAMESPACE_BEGIN
    00084
    00085
    00086
    00087 class PrefixResolver;
    00088
    00089
    00090
    00091 typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator          LocatorType;
    00092 typedef XERCES_CPP_NAMESPACE_QUALIFIER AttributeList    AttributeListType;
    00093
    00094
    00095
    00100 class XALAN_PLATFORMSUPPORT_EXPORT FormatterListener : public XERCES_CPP_NAMESPACE_QUALIFIER DocumentHandler
    00101 {
    00102 public:
    00103
    00104     typedef XERCES_CPP_NAMESPACE_QUALIFIER DocumentHandler  ParentType;
    00105
    00106     // A handy typedef...  Must match DocumentHandler's type for characters(), etc...
    00107     typedef unsigned int    size_type;
    00108
    00109     enum eFormat
    00110     {
    00111         OUTPUT_METHOD_NONE = 0,
    00112         OUTPUT_METHOD_XML = 1,
    00113         OUTPUT_METHOD_HTML = 2,
    00114         OUTPUT_METHOD_TEXT = 3,
    00115         OUTPUT_METHOD_DOM = 4,
    00116         OUTPUT_METHOD_OTHER = 5
    00117     };
    00118
    00119     FormatterListener(eFormat   theFormat);
    00120
    00121     virtual
    00122     ~FormatterListener();
    00123
    00124
    00125     eFormat
    00126     getOutputFormat() const
    00127     {
    00128         return m_outputFormat;
    00129     }
    00130
    00136     const PrefixResolver*
    00137     getPrefixResolver() const
    00138     {
    00139         return m_prefixResolver;
    00140     }
    00141
    00147     void
    00148     setPrefixResolver(const PrefixResolver*     thePrefixResolver)
    00149     {
    00150         m_prefixResolver = thePrefixResolver;
    00151     }
    00152
    00162     virtual void
    00163     charactersRaw(
    00164             const XMLCh* const  chars,
    00165             const size_type     length) = 0;
    00166
    00173     virtual void
    00174     comment(const XMLCh* const  data) = 0;
    00175
    00197     virtual void
    00198     cdata(
    00199             const XMLCh* const  ch,
    00200             const size_type     length) = 0;
    00201
    00208     virtual void
    00209     entityReference(const XMLCh* const  name) = 0;
    00210
    00211
    00212 // These methods are inherited from DocumentHandler ...
    00213
    00214     virtual void
    00215     characters(
    00216             const XMLCh* const  chars,
    00217             const size_type     length) = 0;
    00218
    00219     virtual void
    00220     endDocument() = 0;
    00221
    00222     virtual void
    00223     endElement(const XMLCh* const   name) = 0;
    00224
    00225     virtual void
    00226     ignorableWhitespace(
    00227             const XMLCh* const  chars,
    00228             const size_type     length) = 0;
    00229
    00230     virtual void
    00231     processingInstruction(
    00232             const XMLCh* const  target,
    00233             const XMLCh* const  data) = 0;
    00234
    00235     virtual void
    00236     resetDocument() = 0;
    00237
    00238     virtual void
    00239     setDocumentLocator(const LocatorType* const     locator) = 0;
    00240
    00241     virtual void
    00242     startDocument() = 0;
    00243
    00244     virtual void
    00245     startElement(
    00246             const   XMLCh* const    name,
    00247             AttributeListType&      attrs) = 0;
    00248
    00249
    00250     // Used when creating PI to work around limitations of
    00251     // our interfaces...
    00252     static const XalanDOMChar   s_piTarget[];
    00253
    00254     static const XalanDOMChar   s_piData[];
    00255
    00256 #if defined(XALAN_INLINE_INITIALIZATION)
    00257     static const XalanDOMString::size_type  s_piTargetLength = 5;
    00258     static const XalanDOMString::size_type  s_piDataLength = 3;
    00259 #else
    00260     static const XalanDOMString::size_type  s_piTargetLength;
    00261     static const XalanDOMString::size_type  s_piDataLength;
    00262 #endif
    00263
    00264 protected:
    00265
    00266     // Data membmers...
    00267     const PrefixResolver*   m_prefixResolver;
    00268
    00269 private:
    00270
    00271     // Not implemented...
    00272     FormatterListener(const FormatterListener&);
    00273
    00274     FormatterListener&
    00275     operator=(const FormatterListener&);
    00276
    00277     bool
    00278     operator==(const FormatterListener&) const;
    00279
    00280     // Data membmers...
    00281     const eFormat   m_outputFormat;
    00282 };
    00283
    00284
    00285
    00286 XALAN_CPP_NAMESPACE_END
    00287
    00288
    00289
    00290 #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.5 Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.