Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.7

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-2004 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 <xalanc/XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00064 
00065 
00066 
00067 #include <vector>
00068 
00069 
00070 
00071 // Base class header file.
00072 #include <xalanc/PlatformSupport/FormatterListener.hpp>
00073 
00074 
00075 
00076 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00077 
00078 
00079 
00080 XALAN_CPP_NAMESPACE_BEGIN
00081 
00082 
00083 
00084 class PrefixResolver;
00085 class XalanNode;
00086 class XalanSourceTreeDocument;
00087 class XalanSourceTreeDocumentFragment;
00088 class XalanSourceTreeElement;
00089 
00090 
00091 
00096 class XALAN_XALANSOURCETREE_EXPORT FormatterToSourceTree : public FormatterListener
00097 {
00098 public:
00099 
00100 #if defined(XALAN_NO_STD_NAMESPACE)
00101     typedef vector<XalanSourceTreeElement*>         ElementStackType;
00102     typedef vector<XalanNode*>                      LastChildStackType;
00103 #else
00104     typedef std::vector<XalanSourceTreeElement*>    ElementStackType;
00105     typedef std::vector<XalanNode*>                 LastChildStackType;
00106 #endif
00107 
00108     enum { eDefaultStackSize = 50, eDefaultTextBufferSize = 100 };
00109 
00113     static void
00114     initialize();
00115 
00119     static void
00120     terminate();
00121 
00122 
00129     explicit
00130     FormatterToSourceTree(XalanSourceTreeDocument*  theDocument = 0);
00131 
00139     FormatterToSourceTree(
00140             XalanSourceTreeDocument*            theDocument,
00141             XalanSourceTreeDocumentFragment*    theDocumentFragment);
00142 
00143     virtual
00144     ~FormatterToSourceTree();
00145 
00146 
00147     XalanSourceTreeDocument*
00148     getDocument() const
00149     {
00150         return m_document;
00151     }
00152 
00153     void
00154     setDocument(XalanSourceTreeDocument*    theDocument)
00155     {
00156         m_document = theDocument;
00157     }
00158 
00159     XalanSourceTreeDocumentFragment*
00160     getDocumentFragment() const
00161     {
00162         return m_documentFragment;
00163     }
00164 
00165     void
00166     setDocumentFragment(XalanSourceTreeDocumentFragment*    theDocumentFragment)
00167     {
00168         m_documentFragment = theDocumentFragment;
00169     }
00170 
00171     XalanSourceTreeElement*
00172     getCurrentElement() const
00173     {
00174         return m_currentElement;
00175     }
00176 
00177     void
00178     setCurrentElement(XalanSourceTreeElement*   theElement)
00179     {
00180         m_currentElement = theElement;
00181     }
00182 
00183     // These methods are inherited from DocumentHandler ...
00184 
00185     virtual void
00186     charactersRaw(
00187             const XMLCh* const  chars,
00188             const unsigned int  length);
00189 
00190     virtual void
00191     comment(const XMLCh* const  data);
00192 
00193     virtual void
00194     cdata(
00195             const XMLCh* const  ch,
00196             const unsigned int  length);
00197 
00198     virtual void
00199     entityReference(const XMLCh* const  name);
00200 
00201     virtual void
00202     setDocumentLocator(const LocatorType* const     locator);
00203 
00204     virtual void
00205     startDocument();
00206 
00207     virtual void
00208     endDocument();
00209 
00210     virtual void
00211     startElement(
00212                 const XMLCh* const  name,
00213                 AttributeListType&  attrs);
00214 
00215     virtual void
00216     endElement(const XMLCh* const   name);
00217 
00218     virtual void
00219     characters(
00220                 const XMLCh* const  chars,
00221                 const unsigned int  length);
00222 
00223     virtual void
00224     ignorableWhitespace(
00225                 const XMLCh* const  chars,
00226                 const unsigned int  length);
00227 
00228     virtual void
00229     processingInstruction(
00230             const XMLCh* const  target,
00231             const XMLCh* const  data);
00232 
00233     virtual void
00234     resetDocument();
00235 
00236 private:
00237 
00238     // Some utility functions...
00239     void
00240     processAccumulatedText();
00241 
00242     XalanSourceTreeElement*
00243     createElementNode(
00244             const XalanDOMChar*         name,
00245             AttributeListType&          attrs,
00246             XalanSourceTreeElement*     theParentElement);
00247 
00248     void
00249     doCharacters(
00250             const XalanDOMChar*         chars,
00251             XalanDOMString::size_type   length);
00252 
00253     void
00254     doProcessingInstruction(
00255             const XalanDOMChar*     target,
00256             const XalanDOMChar*     data);
00257 
00258 
00259     // Data members...
00260     XalanSourceTreeDocument*            m_document;
00261 
00262     XalanSourceTreeDocumentFragment*    m_documentFragment;
00263 
00264     XalanSourceTreeElement*             m_currentElement;
00265 
00266     ElementStackType                    m_elementStack;
00267 
00268     // The last child appended to the current element.  This is
00269     // an important optimization, because XalanSourceTreeElement
00270     // does not have a pointer to it's last child.  Without this,
00271     // appending a child becomes a linear search.
00272     XalanNode*                          m_lastChild;
00273 
00274     // Stack of last children appended.  There is a one-to-one
00275     // correspondance to the entries in m_elementStack.
00276     LastChildStackType                  m_lastChildStack;
00277 
00278     XalanDOMString                      m_textBuffer;
00279 };
00280 
00281 
00282 
00283 XALAN_CPP_NAMESPACE_END
00284 
00285 
00286 
00287 #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++ XSLT Processor Version 1.7
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.