Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.3

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 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 <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 
00101     static void
00102     initialize();
00103 
00107     static void
00108     terminate();
00109 
00110 
00111     enum eFormat
00112     {
00113         OUTPUT_METHOD_NONE = 0,
00114         OUTPUT_METHOD_XML = 1,
00115         OUTPUT_METHOD_HTML = 2,
00116         OUTPUT_METHOD_TEXT = 3,
00117         OUTPUT_METHOD_DOM = 4,
00118         OUTPUT_METHOD_OTHER = 5
00119     };
00120 
00121     FormatterListener(eFormat   theFormat);
00122 
00123     virtual
00124     ~FormatterListener();
00125 
00126 
00127     eFormat
00128     getOutputFormat() const
00129     {
00130         return m_outputFormat;
00131     }
00132 
00138     const PrefixResolver*
00139     getPrefixResolver() const
00140     {
00141         return m_prefixResolver;
00142     }
00143 
00149     void
00150     setPrefixResolver(const PrefixResolver*     thePrefixResolver)
00151     {
00152         m_prefixResolver = thePrefixResolver;
00153     }
00154 
00164     virtual void
00165     charactersRaw(
00166             const XMLCh* const  chars,
00167             const size_type     length) = 0;
00168 
00175     virtual void
00176     comment(const XMLCh* const  data) = 0;
00177 
00199     virtual void
00200     cdata(
00201             const XMLCh* const  ch,
00202             const size_type     length) = 0;
00203 
00210     virtual void
00211     entityReference(const XMLCh* const  name) = 0;
00212 
00213 
00214 // These methods are inherited from DocumentHandler ...
00215 
00216     virtual void
00217     characters(
00218             const XMLCh* const  chars,
00219             const size_type     length) = 0;
00220 
00221     virtual void
00222     endDocument() = 0;
00223 
00224     virtual void
00225     endElement(const XMLCh* const   name) = 0;
00226 
00227     virtual void
00228     ignorableWhitespace(
00229             const XMLCh* const  chars,
00230             const size_type     length) = 0;
00231 
00232     virtual void
00233     processingInstruction(
00234             const XMLCh* const  target,
00235             const XMLCh* const  data) = 0;
00236 
00237     virtual void
00238     resetDocument() = 0;
00239 
00240     virtual void
00241     setDocumentLocator(const Locator* const     locator) = 0;
00242 
00243     virtual void
00244     startDocument() = 0;
00245 
00246     virtual void
00247     startElement(
00248             const   XMLCh* const    name,
00249             AttributeList&          attrs) = 0;
00250 
00251 
00252     // Used when creating PI to work around limitations of
00253     // our interfaces...
00254     static const XalanDOMString&    s_xsltNextIsRawString;
00255 
00256     static const XalanDOMString&    s_formatterListenerString;
00257 
00258 protected:
00259 
00260     const PrefixResolver*   m_prefixResolver;
00261 
00262 private:
00263 
00264     const eFormat           m_outputFormat;
00265 };
00266 
00267 
00268 
00269 #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.3
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.