Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

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

FormatterToSourceTree.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2000 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(FORMATTERTOSOURCETREE_HEADER_GUARD_1357924680)
00058 #define FORMATTERTOSOURCETREE_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00064 
00065 
00066 
00067 #include <vector>
00068 
00069 
00070 
00071 // Base class header file.
00072 #include <PlatformSupport/FormatterListener.hpp>
00073 
00074 
00075 
00076 #include <XalanDOM/XalanDOMString.hpp>
00077 
00078 
00079 
00080 class PrefixResolver;
00081 class XalanDocument;
00082 class XalanDocumentFragment;
00083 class XalanElement;
00084 class XalanNode;
00085 class XalanSourceTreeDocument;
00086 class XalanSourceTreeElement;
00087 
00088 
00089 
00094 class XALAN_XALANSOURCETREE_EXPORT FormatterToSourceTree : public FormatterListener
00095 {
00096 public:
00097 
00101     static void
00102     initialize();
00103 
00107     static void
00108     terminate();
00109 
00110 
00117     explicit
00118     FormatterToSourceTree(XalanSourceTreeDocument*  theDocument = 0);
00119 
00127     FormatterToSourceTree(
00128             XalanSourceTreeDocument*    theDocument,
00129             XalanDocumentFragment*      theDocumentFragment);
00130 
00131     virtual
00132     ~FormatterToSourceTree();
00133 
00134 
00135     XalanSourceTreeDocument*
00136     getDocument() const
00137     {
00138         return m_document;
00139     }
00140 
00141     void
00142     setDocument(XalanSourceTreeDocument*    theDocument)
00143     {
00144         m_document = theDocument;
00145     }
00146 
00147     XalanDocumentFragment*
00148     getDocumentFragment() const
00149     {
00150         return m_documentFragment;
00151     }
00152 
00153     void
00154     setDocumentFragment(XalanDocumentFragment*  theDocumentFragment)
00155     {
00156         m_documentFragment = theDocumentFragment;
00157     }
00158 
00159     XalanSourceTreeElement*
00160     getCurrentElement() const
00161     {
00162         return m_currentElement;
00163     }
00164 
00165     void
00166     setCurrentElement(XalanSourceTreeElement*   theElement)
00167     {
00168         m_currentElement = theElement;
00169     }
00170 
00171     // These methods are inherited from DocumentHandler ...
00172 
00173     virtual void
00174     charactersRaw(
00175             const XMLCh* const  chars,
00176             const unsigned int  length);
00177 
00178     virtual void
00179     comment(const XMLCh* const  data);
00180 
00181     virtual void
00182     cdata(
00183             const XMLCh* const  ch,
00184             const unsigned int  length);
00185 
00186     virtual void
00187     entityReference(const XMLCh* const  name);
00188 
00189     virtual void
00190     setDocumentLocator(const Locator* const     locator);
00191 
00192     virtual void
00193     startDocument();
00194 
00195     virtual void
00196     endDocument();
00197 
00198     virtual void
00199     startElement(
00200                 const   XMLCh* const    name,
00201                 AttributeList&          attrs);
00202 
00203     virtual void
00204     endElement(const XMLCh* const   name);
00205 
00206     virtual void
00207     characters(
00208                 const XMLCh* const  chars,
00209                 const unsigned int  length);
00210 
00211     virtual void
00212     ignorableWhitespace(
00213                 const XMLCh* const  chars,
00214                 const unsigned int  length);
00215 
00216     virtual void
00217     processingInstruction(
00218             const XMLCh* const  target,
00219             const XMLCh* const  data);
00220 
00221     virtual void
00222     resetDocument();
00223 
00224 private:
00225 
00226     // Some utility functions...
00227     void
00228     processAccumulatedText();
00229 
00230     XalanSourceTreeElement*
00231     createElementNode(
00232             const XalanDOMChar*         name,
00233             AttributeList&              attrs,
00234             XalanSourceTreeElement*     theParentElement);
00235 
00236     void
00237     doCharacters(
00238             const XalanDOMChar*     chars,
00239             unsigned int            length);
00240 
00241     void
00242     doProcessingInstruction(
00243             const XalanDOMChar*     target,
00244             const XalanDOMChar*     data);
00245 
00246 
00247     // Data members...
00248     XalanSourceTreeDocument*                        m_document;
00249 
00250     XalanDocumentFragment*                          m_documentFragment;
00251 
00252     XalanSourceTreeElement*                         m_currentElement;
00253 
00254 #if defined(XALAN_NO_NAMESPACES)
00255     typedef vector<XalanSourceTreeElement*>         ElementStackType;
00256 #else
00257     typedef std::vector<XalanSourceTreeElement*>    ElementStackType;
00258 #endif
00259 
00260     ElementStackType                                m_elementStack;
00261 
00262     XalanDOMString                                  m_textBuffer;
00263 };
00264 
00265 
00266 
00267 #endif  // FORMATTERTOSOURCETREE_HEADER_GUARD_1357924680

Interpreting class diagrams

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

Xalan-C++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.