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  

XalanDOMStringAllocator.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 
00058 #if !defined(XALANDOMSTRINGALLOCATOR_INCLUDE_GUARD_12455133)
00059 #define XALANDOMSTRINGALLOCATOR_INCLUDE_GUARD_12455133
00060 
00061 
00062 
00063 // Base include file.  Must be first.
00064 #include <xalanc/PlatformSupport/PlatformSupportDefinitions.hpp>
00065 
00066 
00067 
00068 #include <xalanc/PlatformSupport/ArenaAllocator.hpp>
00069 
00070 
00071 
00072 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00073 
00074 
00075 
00076 XALAN_CPP_NAMESPACE_BEGIN
00077 
00078 
00079 
00080 class XALAN_PLATFORMSUPPORT_EXPORT XalanDOMStringAllocator
00081 {
00082 public:
00083 
00084     typedef XalanDOMString                  data_type;
00085     typedef data_type::size_type            data_type_size_type;
00086 
00087 #if defined(XALAN_NO_DEFAULT_TEMPLATE_ARGUMENTS)
00088     typedef ArenaBlock<data_type>           ArenaBlockType;
00089 
00090     typedef ArenaAllocator<data_type,
00091                            ArenaBlockType>  ArenaAllocatorType;
00092 #else
00093     typedef ArenaAllocator<data_type>       ArenaAllocatorType;
00094 #endif
00095 
00096     typedef ArenaAllocatorType::size_type   size_type;
00097 
00098     enum { eDefaultBlockSize = 32 };
00099 
00100 
00106     XalanDOMStringAllocator(size_type   theBlockCount);
00107 
00108     ~XalanDOMStringAllocator();
00109 
00118     data_type*
00119     create(
00120             const char*             theString,
00121 #if defined(_MSC_VER)
00122             // $$$ ToDo: Some strange bug in MSVC++ complains when using data_type::npos here.
00123             data_type_size_type     theCount = data_type_size_type(-1));
00124 #else
00125     data_type_size_type     theCount = data_type_size_type(data_type::npos));
00126 #endif
00127 
00137     data_type*
00138     create(
00139             const data_type&        theSource,
00140             data_type_size_type     theStartPosition = 0,
00141             data_type_size_type     theCount = data_type_size_type(data_type::npos));
00142 
00151     data_type*
00152     create(
00153             const XalanDOMChar*     theString,
00154             data_type_size_type     theCount = data_type_size_type(data_type::npos));
00155 
00164     data_type*
00165     create(
00166             data_type_size_type     theCount,
00167             XalanDOMChar            theChar);
00168 
00172     bool
00173     ownsObject(const data_type*     theObject)
00174     {
00175         return m_allocator.ownsObject(theObject);
00176     }
00177     
00181     void
00182     reset()
00183     {
00184         m_allocator.reset();
00185     }
00186 
00192     size_type
00193     getBlockCount() const
00194     {
00195         return m_allocator.getBlockCount();
00196     }
00197 
00204     size_type
00205     getBlockSize() const
00206     {
00207         return m_allocator.getBlockSize();
00208     }
00209 
00210 private:
00211 
00212     // Not implemented...
00213     XalanDOMStringAllocator(const XalanDOMStringAllocator&);
00214 
00215     XalanDOMStringAllocator&
00216     operator=(const XalanDOMStringAllocator&);
00217 
00218     // Data members...
00219     ArenaAllocatorType  m_allocator;
00220 };
00221 
00222 
00223 
00224 XALAN_CPP_NAMESPACE_END
00225 
00226 
00227 
00228 #endif  // XALANDOMSTRINGALLOCATOR_INCLUDE_GUARD_12455133

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.