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  

XalanSourceTreeParserLiaison.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2001 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(XALANSOURCETREEPARSERLIAISON_HEADER_GUARD_1357924680)
00058 #define XALANSOURCETREEPARSERLIAISON_HEADER_GUARD_1357924680
00059 
00060 
00061 // Base include file.  Must be first.
00062 #include <XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00063 
00064 
00065 
00066 // Standard Library header files.
00067 #include <map>
00068 
00069 
00070 
00071 #include <XercesParserLiaison/XercesDOMSupport.hpp>
00072 #include <XercesParserLiaison/XercesParserLiaison.hpp>
00073 
00074 
00075 
00076 class ContentHandler;
00077 class DTDHandler;
00078 class LexicalHandler;
00079 class XalanSourceTreeDOMSupport;
00080 class XalanSourceTreeDocument;
00081 
00082 
00083 
00084 class XALAN_XALANSOURCETREE_EXPORT  XalanSourceTreeParserLiaison : public XMLParserLiaison
00085 {
00086 public:
00087 
00096     XalanSourceTreeParserLiaison(
00097             XalanSourceTreeDOMSupport&  theSupport,
00098             DocumentNumberType          theStartingNumber = 0);
00099 
00105     XalanSourceTreeParserLiaison(DocumentNumberType     theStartingNumber = 0);
00106 
00107     virtual
00108     ~XalanSourceTreeParserLiaison();
00109 
00116     bool
00117     getPoolAllText() const
00118     {
00119         return m_poolAllText;
00120     }
00121 
00128     void
00129     setPoolAllText(bool fValue)
00130     {
00131         m_poolAllText = fValue;
00132     }
00133 
00134     // These interfaces are inherited from XMLParserLiaison...
00135 
00136     virtual void
00137     reset();
00138 
00139     virtual ExecutionContext*
00140     getExecutionContext() const;
00141 
00142     virtual void
00143     setExecutionContext(ExecutionContext&   theContext);
00144 
00145     virtual XalanDocument*
00146     parseXMLStream(
00147             const InputSource&      reader,
00148             const XalanDOMString&   identifier = XalanDOMString());
00149 
00150     virtual void
00151     parseXMLStream(
00152             const InputSource&      inputSource,
00153             DocumentHandler&        handler,
00154             const XalanDOMString&   identifier = XalanDOMString());
00155 
00156     virtual XalanDocument*
00157     createDocument();
00158 
00159     virtual XalanDocument*
00160     createDOMFactory();
00161 
00162     virtual void
00163     destroyDocument(XalanDocument*  theDocument);
00164 
00165     virtual DocumentNumberType
00166     getNextDocumentNumber();
00167 
00168     virtual int
00169     getIndent() const;
00170 
00171     virtual void
00172     setIndent(int   i);
00173 
00174     virtual bool
00175     getUseValidation() const;
00176 
00177     virtual void
00178     setUseValidation(bool   b);
00179 
00180     virtual const XalanDOMString
00181     getParserDescription() const;
00182 
00183     virtual EntityResolver*
00184     getEntityResolver() const;
00185 
00186     virtual void
00187     setEntityResolver(EntityResolver*   resolver);
00188 
00189 
00190     // These interfaces are new to XalanSourceTreeParserLiaison...
00191 
00201     virtual void
00202     parseXMLStream(
00203             const InputSource&      theInputSource,
00204             ContentHandler&         theContentHandler,
00205             DTDHandler*             theDTDHandler = 0,
00206             LexicalHandler*         theLexicalHandler = 0,
00207             const XalanDOMString&   theIdentifier = XalanDOMString());
00208 
00219     virtual bool
00220     getIncludeIgnorableWhitespace() const;
00221 
00240     virtual void
00241     setIncludeIgnorableWhitespace(bool  include);
00242 
00248     virtual ErrorHandler*
00249     getErrorHandler() const;
00250 
00261     virtual void
00262     setErrorHandler(ErrorHandler*   handler);
00263 
00273     virtual bool
00274     getDoNamespaces() const;
00275 
00293     virtual void
00294     setDoNamespaces(bool    newState);
00295 
00305     virtual bool
00306     getExitOnFirstFatalError() const;
00307 
00323     virtual void
00324     setExitOnFirstFatalError(bool   newState);
00325 
00335     XalanSourceTreeDocument*
00336     mapDocument(const XalanDocument*    theDocument) const;
00337 
00343     XalanSourceTreeDocument*
00344     createXalanSourceTreeDocument();
00345 
00346     bool
00347     setPersistent(XalanSourceTreeDocument*  theDocument);
00348 
00349     bool
00350     unsetPersistent(XalanSourceTreeDocument*    theDocument);
00351 
00352 #if defined(XALAN_NO_NAMESPACES)
00353     typedef map<const XalanDocument*,
00354                 XalanSourceTreeDocument*,
00355                 less<const XalanDocument*> >    DocumentMapType;
00356 #else
00357     typedef std::map<const XalanDocument*,
00358                      XalanSourceTreeDocument*>  DocumentMapType;
00359 #endif
00360 
00361     DocumentNumberType
00362     getDocumentNumber() const
00363     {
00364         return m_documentNumber;
00365     }
00366 
00367 private:
00368 
00369     // Not implemented...
00370     XalanSourceTreeParserLiaison(const XalanSourceTreeParserLiaison&);
00371 
00372     XalanSourceTreeParserLiaison&
00373     operator=(const XalanSourceTreeParserLiaison&);
00374 
00375 
00376     // Data members...
00377     DocumentNumberType          m_documentNumber;
00378 
00379     XercesParserLiaison         m_xercesParserLiaison;
00380 
00381     DocumentMapType             m_documentMap;
00382 
00383     DocumentMapType             m_persistentDocumentMap;
00384 
00385     bool                        m_poolAllText;
00386 
00387     static const XalanDOMChar   validationString[];
00388 };
00389 
00390 
00391 
00392 #endif  // XALANSOURCETREEPARSERLIAISON_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.