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  

XPathConstructionContext.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  * @author <a href="mailto:david_n_bertoni@lotus.com">David N. Bertoni</a>
00058  */
00059 #if !defined(XPATHCONSTRUCTIONCONTEXT_HEADER_GUARD_1357924680)
00060 #define XPATHCONSTRUCTIONCONTEXT_HEADER_GUARD_1357924680
00061 
00062 
00063 
00064 // Base include file.  Must be first.
00065 #include <xalanc/XPath/XPathDefinitions.hpp>
00066 
00067 
00068 
00069 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00070 
00071 
00072 
00073 XALAN_CPP_NAMESPACE_BEGIN
00074 
00075 
00076 
00077 //
00078 // An abstract class which provides support for constructing the internal
00079 // representation  of a stylesheet.
00080 //
00081 class XALAN_XPATH_EXPORT XPathConstructionContext
00082 {
00083 public:
00084 
00085     XPathConstructionContext();
00086 
00087     virtual
00088     ~XPathConstructionContext();
00089 
00090 
00095     virtual void
00096     reset() = 0;
00097 
00107     virtual const XalanDOMString&
00108     getPooledString(const XalanDOMString&   theString) = 0;
00109 
00120     virtual const XalanDOMString&
00121     getPooledString(
00122             const XalanDOMChar*         theString,
00123             XalanDOMString::size_type   theLength = XalanDOMString::npos) = 0;
00124 
00130     virtual XalanDOMString&
00131     getCachedString() = 0;
00132 
00140     virtual bool
00141     releaseCachedString(XalanDOMString&     theString) = 0;
00142 
00143     class GetAndReleaseCachedString
00144     {
00145     public:
00146 
00147         GetAndReleaseCachedString(XPathConstructionContext&     theConstructionContext) :
00148             m_constructionContext(&theConstructionContext),
00149             m_string(&theConstructionContext.getCachedString())
00150         {
00151         }
00152 
00153         // Note non-const copy semantics...
00154         GetAndReleaseCachedString(GetAndReleaseCachedString&    theSource) :
00155             m_constructionContext(theSource.m_constructionContext),
00156             m_string(theSource.m_string)
00157         {
00158             theSource.m_string = 0;
00159         }
00160 
00161         ~GetAndReleaseCachedString()
00162         {
00163             if (m_string != 0)
00164             {
00165                 m_constructionContext->releaseCachedString(*m_string);
00166             }
00167         }
00168 
00169         XalanDOMString&
00170         get() const
00171         {
00172             assert(m_string != 0);
00173 
00174             return *m_string;
00175         }
00176 
00177         XPathConstructionContext&
00178         getConstructionContext() const
00179         {
00180             return *m_constructionContext;
00181         }
00182 
00183     private:
00184 
00185         // Not implemented...
00186         GetAndReleaseCachedString&
00187         operator=(const GetAndReleaseCachedString&);
00188 
00189 
00190         // Data members...
00191         XPathConstructionContext*   m_constructionContext;
00192 
00193         XalanDOMString*             m_string;
00194     };
00195 
00196 };
00197 
00198 
00199 
00200 XALAN_CPP_NAMESPACE_END
00201 
00202 
00203 
00204 #endif  // XPATHCONSTRUCTIONCONTEXT_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.