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  

XStringAllocator.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 2000-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 
00058 #if !defined(XSTRINGALLOCATOR_INCLUDE_GUARD_1357924680)
00059 #define XSTRINGALLOCATOR_INCLUDE_GUARD_1357924680
00060 
00061 
00062 
00063 // Base include file.  Must be first.
00064 #include <xalanc/XPath/XPathDefinitions.hpp>
00065 
00066 
00067 
00068 #include <xalanc/XPath/XString.hpp>
00069 
00070 
00071 
00072 #include <xalanc/PlatformSupport/ReusableArenaAllocator.hpp>
00073 
00074 
00075 
00076 XALAN_CPP_NAMESPACE_BEGIN
00077 
00078 
00079 
00080 class XALAN_XPATH_EXPORT XStringAllocator
00081 {
00082 public:
00083 
00084     typedef XString         string_type;
00085 
00086     typedef ReusableArenaAllocator<string_type>     ArenaAllocatorType;
00087     typedef ArenaAllocatorType::size_type           size_type;
00088 
00094     XStringAllocator(size_type  theBlockCount);
00095 
00096     ~XStringAllocator();
00097 
00105     string_type*
00106     createString(const XalanDOMString&  theString);
00107 
00115     string_type*
00116     createString(const XalanDOMChar*    theString);
00117 
00126     string_type*
00127     createString(
00128             const XalanDOMChar*     theString,
00129             unsigned int            theLength);
00130 
00138     string_type*
00139     clone(const XString&    value);
00140 
00144     bool
00145     destroy(string_type*    theString);
00146 
00150     bool
00151     ownsObject(const string_type*   theObject)
00152     {
00153         return m_allocator.ownsObject(theObject);
00154     }
00155 
00159     void 
00160     reset();
00161 
00168     size_type
00169     getBlockCount() const
00170     {
00171         return m_allocator.getBlockCount();
00172     }
00173 
00179     size_type
00180     getBlockSize() const
00181     {
00182         return m_allocator.getBlockSize();
00183     }
00184 
00185 private:
00186 
00187     // Not implemented...
00188     XStringAllocator(const XStringAllocator&);
00189 
00190     XStringAllocator&
00191     operator=(const XStringAllocator&);
00192 
00193     // Data members...
00194     ArenaAllocatorType  m_allocator;
00195 };
00196 
00197 
00198 
00199 XALAN_CPP_NAMESPACE_END
00200 
00201 
00202 
00203 #endif  // XSTRINGALLOCATOR_INCLUDE_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.