Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

XPathAllocator.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 2001-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(XPATHALLOCATOR_INCLUDE_GUARD_135792455)
00059 #define XPATHALLOCATOR_INCLUDE_GUARD_135792455
00060 
00061 
00062 
00063 // Base include file.  Must be first.
00064 #include <xalanc/XPath/XPathDefinitions.hpp>
00065 
00066 
00067 
00068 #include <xalanc/PlatformSupport/ArenaAllocator.hpp>
00069 
00070 
00071 
00072 #include <xalanc/XPath/XPath.hpp>
00073 
00074 
00075 
00076 XALAN_CPP_NAMESPACE_BEGIN
00077 
00078 
00079 
00080 class XALAN_XPATH_EXPORT XPathAllocator
00081 {
00082 public:
00083 
00084     typedef XPath                           object_type;
00085 
00086 #if defined(XALAN_NO_DEFAULT_TEMPLATE_ARGUMENTS)
00087     typedef ArenaBlock<object_type>         ArenaBlockType;
00088 
00089     typedef ArenaAllocator<object_type,
00090                            ArenaBlockType>  ArenaAllocatorType;
00091 #else
00092     typedef ArenaAllocator<object_type>     ArenaAllocatorType;
00093 #endif
00094 
00095     typedef ArenaAllocatorType::size_type   size_type;
00096 
00102     XPathAllocator(size_type    theBlockCount);
00103 
00104     ~XPathAllocator();
00105 
00111     object_type*
00112     create();
00113 
00117     bool
00118     ownsObject(const object_type*   theObject)
00119     {
00120         return m_allocator.ownsObject(theObject);
00121     }
00122 
00126     void
00127     reset();
00128 
00134     size_type
00135     getBlockCount() const
00136     {
00137         return m_allocator.getBlockCount();
00138     }
00139 
00145     size_type
00146     getBlockSize() const
00147     {
00148         return m_allocator.getBlockSize();
00149     }
00150 
00151 private:
00152 
00153     // Not implemented...
00154     XPathAllocator(const XPathAllocator&);
00155 
00156     XPathAllocator&
00157     operator=(const XPathAllocator&);
00158 
00159     // Data members...
00160     ArenaAllocatorType  m_allocator;
00161 };
00162 
00163 
00164 
00165 XALAN_CPP_NAMESPACE_END
00166 
00167 
00168 
00169 #endif  // XNUMBERALLOCATOR_INCLUDE_GUARD_135792455

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.