Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.4

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

XalanDOMStringCache.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(XALAN_DOMSTRINGCACHE_HEADER_GUARD)
00058 #define XALAN_DOMSTRINGCACHE_HEADER_GUARD
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <PlatformSupport/PlatformSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #include <deque>
00068 #include <vector>
00069 
00070 
00071 
00072 #include <XalanDOM/XalanDOMString.hpp>
00073 
00074 
00075 
00076 class XALAN_PLATFORMSUPPORT_EXPORT XalanDOMStringCache
00077 {
00078 public:
00079 
00080     enum { eDefaultMaximumSize = 100 };
00081 
00082 #if defined(XALAN_NO_NAMESPACES)
00083     typedef vector<XalanDOMString*>         StringListType;
00084 #else
00085     typedef std::vector<XalanDOMString*>    StringListType;
00086 #endif
00087 
00088     explicit
00089     XalanDOMStringCache(unsigned int    theMaximumSize = eDefaultMaximumSize);
00090 
00091     ~XalanDOMStringCache();
00092 
00093     unsigned int
00094     getMaximumSize() const
00095     {
00096         return m_maximumSize;
00097     }
00098 
00099     void
00100     setMaximumSize(unsigned int     theSize)
00101     {
00102         m_maximumSize = theSize;
00103     }
00104 
00105     XalanDOMString&
00106     get();
00107 
00108     bool
00109     release(XalanDOMString&     theString);
00110 
00111     /*
00112      * Clear all of the strings in the cache.  This
00113      * destroys all of the strings.
00114      *
00115      */
00116     void
00117     clear();
00118 
00119     /*
00120      * Reset the cache so that all strings that are
00121      * currently in use are available.
00122      */
00123     void
00124     reset();
00125 
00126     class GetAndRelease
00127     {
00128     public:
00129 
00130         GetAndRelease(XalanDOMStringCache&  theCache) :
00131             m_cache(theCache),
00132             m_string(&theCache.get())
00133         {
00134         }
00135 
00136         ~GetAndRelease()
00137         {
00138             m_cache.release(*m_string);
00139         }
00140 
00141         XalanDOMString&
00142         get() const
00143         {
00144             return *m_string;
00145         }
00146 
00147     private:
00148 
00149         XalanDOMStringCache&    m_cache;
00150 
00151         XalanDOMString* const   m_string;
00152     };
00153 
00154 private:
00155 
00156     // not implemented
00157     XalanDOMStringCache(const XalanDOMStringCache&);
00158 
00159     bool
00160     operator==(const XalanDOMStringCache&) const;
00161 
00162     XalanDOMStringCache&
00163     operator=(const XalanDOMStringCache&);
00164 
00168     StringListType  m_availableList;
00169 
00173     StringListType  m_busyList;
00174 
00175     unsigned int    m_maximumSize;
00176 };
00177 
00178 
00179 
00180 #endif  // XALAN_RESULTNAMESPACESSTACK_HEADER_GUARD

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.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.