## Xalan-C++ API Documentation

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

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
    00067
    00068
    00069
    00070 // Base include file.  Must be first.
    00071 #include <xalanc/PlatformSupport/PlatformSupportDefinitions.hpp>
    00072
    00073
    00074
    00075 #include <xercesc/sax/DocumentHandler.hpp>
    00076
    00077
    00078
    00079 #include <xalanc/XalanDOM/XalanDOMString.hpp>
    00080
    00081
    00082
    00083 XALAN_CPP_NAMESPACE_BEGIN
    00084
    00085
    00086
    00087 class PrefixResolver;
    00088 class Writer;
    00089
    00090
    00091
    00092 typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator          LocatorType;
    00093 typedef XERCES_CPP_NAMESPACE_QUALIFIER AttributeList    AttributeListType;
    00094
    00095
    00096
    00101 class XALAN_PLATFORMSUPPORT_EXPORT FormatterListener : public XERCES_CPP_NAMESPACE_QUALIFIER DocumentHandler
    00102 {
    00103 public:
    00104
    00105     typedef XERCES_CPP_NAMESPACE_QUALIFIER DocumentHandler  ParentType;
    00106
    00107     // A handy typedef...  Must match DocumentHandler's type for characters(), etc...
    00108     typedef unsigned int    size_type;
    00109
    00110     enum eFormat
    00111     {
    00112         OUTPUT_METHOD_NONE = 0,
    00113         OUTPUT_METHOD_XML = 1,
    00114         OUTPUT_METHOD_HTML = 2,
    00115         OUTPUT_METHOD_TEXT = 3,
    00116         OUTPUT_METHOD_DOM = 4,
    00117         OUTPUT_METHOD_OTHER = 5
    00118     };
    00119
    00120     FormatterListener(eFormat   theFormat);
    00121
    00122     virtual
    00123     ~FormatterListener();
    00124
    00125
    00126     eFormat
    00127     getOutputFormat() const
    00128     {
    00129         return m_outputFormat;
    00130     }
    00131
    00137     const PrefixResolver*
    00138     getPrefixResolver() const
    00139     {
    00140         return m_prefixResolver;
    00141     }
    00142
    00148     void
    00149     setPrefixResolver(const PrefixResolver*     thePrefixResolver)
    00150     {
    00151         m_prefixResolver = thePrefixResolver;
    00152     }
    00153
    00163     virtual void
    00164     charactersRaw(
    00165             const XMLCh* const  chars,
    00166             const size_type     length) = 0;
    00167
    00174     virtual void
    00175     comment(const XMLCh* const  data) = 0;
    00176
    00198     virtual void
    00199     cdata(
    00200             const XMLCh* const  ch,
    00201             const size_type     length) = 0;
    00202
    00209     virtual void
    00210     entityReference(const XMLCh* const  name) = 0;
    00211
    00212
    00213 // These methods are inherited from DocumentHandler ...
    00214
    00215     virtual void
    00216     characters(
    00217             const XMLCh* const  chars,
    00218             const size_type     length) = 0;
    00219
    00220     virtual void
    00221     endDocument() = 0;
    00222
    00223     virtual void
    00224     endElement(const XMLCh* const   name) = 0;
    00225
    00226     virtual void
    00227     ignorableWhitespace(
    00228             const XMLCh* const  chars,
    00229             const size_type     length) = 0;
    00230
    00231     virtual void
    00232     processingInstruction(
    00233             const XMLCh* const  target,
    00234             const XMLCh* const  data) = 0;
    00235
    00236     virtual void
    00237     resetDocument() = 0;
    00238
    00239     virtual void
    00240     setDocumentLocator(const LocatorType* const     locator) = 0;
    00241
    00242     virtual void
    00243     startDocument() = 0;
    00244
    00245     virtual void
    00246     startElement(
    00247             const   XMLCh* const    name,
    00248             AttributeListType&      attrs) = 0;
    00249
    00250     virtual Writer*
    00251     getWriter() const;
    00252
    00253     virtual const XalanDOMString&
    00254     getDoctypeSystem() const;
    00255
    00256     virtual const XalanDOMString&
    00257     getDoctypePublic() const;
    00258
    00259     virtual const XalanDOMString&
    00260     getEncoding() const;
    00261
    00262     virtual const XalanDOMString&
    00263     getMediaType() const;
    00264
    00265     virtual int
    00266     getIndent() const;
    00267
    00268
    00269     // Used when creating PI to work around limitations of
    00270     // our interfaces...
    00271     static const XalanDOMChar   s_piTarget[];
    00272
    00273     static const XalanDOMChar   s_piData[];
    00274
    00275 #if defined(XALAN_INLINE_INITIALIZATION)
    00276     static const XalanDOMString::size_type  s_piTargetLength = 5;
    00277     static const XalanDOMString::size_type  s_piDataLength = 3;
    00278 #else
    00279     static const XalanDOMString::size_type  s_piTargetLength;
    00280     static const XalanDOMString::size_type  s_piDataLength;
    00281 #endif
    00282
    00283 protected:
    00284
    00285     // Data membmers...
    00286     const PrefixResolver*   m_prefixResolver;
    00287
    00288     static const XalanDOMString     s_emptyString;
    00289
    00290 private:
    00291
    00292     // Not implemented...
    00293     FormatterListener(const FormatterListener&);
    00294
    00295     FormatterListener&
    00296     operator=(const FormatterListener&);
    00297
    00298     bool
    00299     operator==(const FormatterListener&) const;
    00300
    00301     // Data membmers...
    00302     const eFormat   m_outputFormat;
    00303 };
    00304
    00305
    00306
    00307 XALAN_CPP_NAMESPACE_END
    00308
    00309
    00310
    00311 #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.6 Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.