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  

XalanDOMStringHashTable.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 #if !defined(XALANDOMSTRINGHASHTABLE_HEADER_GUARD_1357924680)
00058 #define XALANDOMSTRINGHASHTABLE_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <PlatformSupport/PlatformSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #include <vector>
00068 
00069 
00070 
00071 #include <Include/XalanAutoPtr.hpp>
00072 
00073 
00074 
00075 #include <XalanDOM/XalanDOMString.hpp>
00076 
00077 
00078 
00079 class XALAN_PLATFORMSUPPORT_EXPORT XalanDOMStringHashTable
00080 {
00081 public:
00082 
00083 #if defined(XALAN_NO_NAMESPACES)
00084     typedef vector<const XalanDOMString*>   BucketType;
00085     typedef BucketType::size_type           bucket_size_type;
00086     typedef vector<bucket_size_type>        BucketCountsType;
00087 #else
00088     typedef std::vector<const XalanDOMString*>  BucketType;
00089     typedef BucketType::size_type               bucket_size_type;
00090     typedef std::vector<bucket_size_type>       BucketCountsType;
00091 #endif
00092 
00093 
00094     enum { eDefaultBucketCount = 101, eDefaultBucketSize = 15 };
00095 
00096 
00103     explicit
00104     XalanDOMStringHashTable(
00105             size_t              theBucketCount = eDefaultBucketCount,
00106             bucket_size_type    theBucketSize = eDefaultBucketSize);
00107 
00108     ~XalanDOMStringHashTable() { }
00109 
00113     void
00114     clear();
00115 
00121     size_t
00122     size() const
00123     {
00124         return m_count;
00125     }
00126 
00132     size_t
00133     bucketCount() const
00134     {
00135         return m_bucketCount;
00136     }
00137 
00143     void
00144     getBucketCounts(BucketCountsType&   theVector) const;
00145 
00152     size_t
00153     collisions() const
00154     {
00155         return m_collisions;
00156     }
00157 
00165     const XalanDOMString*
00166     find(
00167             const XalanDOMString&   theString,
00168             size_t*                 theBucketIndex = 0) const;
00169 
00182     const XalanDOMString*
00183     find(
00184             const XalanDOMChar*         theString,
00185             XalanDOMString::size_type   theLength = XalanDOMString::npos,
00186             size_t*                     theBucketIndex = 0) const;
00187 
00200     void
00201     insert(const XalanDOMString&    theString);
00202 
00218     void
00219     insert(
00220             const XalanDOMString&   theString,
00221             size_t                  theBucketIndex);
00222 
00223 #if defined(XALAN_NEEDS_EXPLICIT_TEMPLATE_INSTANTIATION)
00224     struct
00225     equalsXalanDOMString
00226     {
00227         equalsXalanDOMString(
00228                 const XalanDOMChar*         theString,
00229                 XalanDOMString::size_type   theLength) :
00230             m_string(theString),
00231             m_length(theLength)
00232         {
00233         }
00234 
00235         bool
00236         operator()(const XalanDOMString*    theString) const;
00237 
00238     private:
00239 
00240         const XalanDOMChar* const           m_string;
00241 
00242         const XalanDOMString::size_type     m_length;
00243     };
00244 #endif
00245 
00246 private:
00247 
00248     // Not implemented, for now...
00249     XalanDOMStringHashTable(const XalanDOMStringHashTable&);
00250 
00251     XalanDOMStringHashTable&
00252     operator=(const XalanDOMStringHashTable&);
00253 
00254     bool
00255     operator==(const XalanDOMStringHashTable&) const;
00256 
00257 
00258     // Data members...
00259     const size_t                    m_bucketCount;
00260 
00261     const bucket_size_type          m_bucketSize;
00262 
00263     XalanArrayAutoPtr<BucketType>   m_buckets;
00264 
00265     size_t                          m_count;
00266 
00267     unsigned int                    m_collisions;       
00268 };
00269 
00270 
00271 
00272 #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.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.