Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.3

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

XalanDOMStringPool.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(XALANDOMSTRINGPOOL_HEADER_GUARD_1357924680)
00058 #define XALANDOMSTRINGPOOL_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <PlatformSupport/PlatformSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #include <deque>
00068 #include <map>
00069 
00070 
00071 
00072 #include <PlatformSupport/ArenaAllocator.hpp>
00073 #include <PlatformSupport/DOMStringHelper.hpp>
00074 #include <PlatformSupport/XalanDOMStringHashTable.hpp>
00075 
00076 
00077 
00078 class XALAN_PLATFORMSUPPORT_EXPORT XalanDOMStringPool
00079 {
00080 public:
00081 
00082     enum { eDefaultBlockSize = 1024,
00083            eDefaultBucketCount = XalanDOMStringHashTable::eDefaultBucketCount,
00084            eDefaultBucketSize = XalanDOMStringHashTable::eDefaultBucketSize };
00085 
00086 #if defined(XALAN_NO_DEFAULT_TEMPLATE_ARGUMENTS)
00087     typedef ArenaBlock<XalanDOMString>      ArenaBlockType;
00088 
00089     typedef ArenaAllocator<XalanDOMString,
00090                            ArenaBlockType>  ArenaAllocatorType;
00091 #else
00092     typedef ArenaAllocator<XalanDOMString>  ArenaAllocatorType;
00093 #endif
00094 
00095     typedef ArenaAllocatorType::size_type               block_size_type;
00096     typedef size_t                                      bucket_count_type;
00097     typedef XalanDOMStringHashTable::bucket_size_type   bucket_size_type;
00098 
00106     explicit
00107     XalanDOMStringPool(
00108             block_size_type     theBlockSize = eDefaultBlockSize,
00109             bucket_count_type   theBucketCount = eDefaultBucketCount,
00110             bucket_size_type    theBucketSize = eDefaultBucketSize);
00111 
00112     virtual
00113     ~XalanDOMStringPool();
00114 
00119     virtual void
00120     clear();
00121 
00127     virtual size_t
00128     size() const;
00129 
00136     virtual const XalanDOMString&
00137     get(const XalanDOMString&   theString);
00138 
00146     virtual const XalanDOMString&
00147     get(
00148             const XalanDOMChar*         theString,
00149             XalanDOMString::size_type   theLength = XalanDOMString::npos);
00150 
00157     const XalanDOMStringHashTable&
00158     getHashTable() const
00159     {
00160         return m_hashTable;
00161     }
00162 
00163 private:
00164 
00165     // Not implemented, for now...
00166     XalanDOMStringPool(const XalanDOMStringPool&);
00167 
00168     XalanDOMStringPool&
00169     operator=(const XalanDOMStringPool&);
00170 
00171     bool
00172     operator==(const XalanDOMStringPool&) const;
00173 
00174     // Data members...
00175     ArenaAllocatorType              m_stringAllocator;
00176 
00177     size_t                          m_stringCount;
00178 
00179     XalanDOMStringHashTable         m_hashTable;
00180 
00181     static const XalanDOMString     s_emptyString;
00182 };
00183 
00184 
00185 
00186 #endif  // !defined(XALANDOMSTRINGPOOL_HEADER_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.3
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.