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  

XResultTreeFragAllocator.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 
00058 #if !defined(XRESULTTREEFRAGALLOCATOR_INCLUDE_GUARD_12455133)
00059 #define XRESULTTREEFRAGALLOCATOR_INCLUDE_GUARD_12455133
00060 
00061 
00062 
00063 // Base include file.  Must be first.
00064 #include <XSLT/XSLTDefinitions.hpp>
00065 
00066 
00067 
00068 #include <XSLT/XResultTreeFrag.hpp>
00069 
00070 
00071 
00072 #include <PlatformSupport/ReusableArenaAllocator.hpp>
00073 
00074 
00075 
00076 class XALAN_XSLT_EXPORT XResultTreeFragAllocator
00077 {
00078 public:
00079 
00080     typedef XResultTreeFrag                     data_type;
00081 
00082     typedef ReusableArenaAllocator<data_type>   ArenaAllocatorType;
00083     typedef ArenaAllocatorType::size_type       size_type;
00084 
00090     XResultTreeFragAllocator(size_type  theBlockCount);
00091 
00092     ~XResultTreeFragAllocator();
00093     
00101     data_type*
00102     create(ResultTreeFragBase&  theValue);
00103 
00111     data_type*
00112     create(const data_type&     theSource);
00113 
00121     data_type*
00122     clone(const XResultTreeFrag&    theSource);
00123 
00127     bool
00128     destroy(data_type*  theObject);
00129 
00133     bool
00134     ownsObject(const data_type*     theObject)
00135     {
00136         return m_allocator.ownsObject(theObject);
00137     }
00138     
00142     void
00143     reset();
00144 
00151     size_type
00152     getBlockCount() const
00153     {
00154         return m_allocator.getBlockCount();
00155     }
00156 
00162     size_type
00163     getBlockSize() const
00164     {
00165         return m_allocator.getBlockSize();
00166     }
00167 
00168 private:
00169 
00170     // Not implemented...
00171     XResultTreeFragAllocator(const XResultTreeFragAllocator&);
00172 
00173     XResultTreeFragAllocator&
00174     operator=(const XResultTreeFragAllocator&);
00175 
00176     // Data members...
00177     ArenaAllocatorType  m_allocator;
00178 };
00179 
00180 
00181 
00182 #endif  // XRESULTTREEFRAGALLOCATOR_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.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.