home *** CD-ROM | disk | FTP | other *** search
/ GameStar 2004 May / Gamestar_62_2004-05_dvd.iso / Programy / apache_2.0.48-win32-x86-no_ssl.msi / Data.Cab / F251748_apr_hash.h < prev    next >
C/C++ Source or Header  |  2003-03-05  |  9KB  |  244 lines
  1. /* ====================================================================
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Apache" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  *
  54.  * Portions of this software are based upon public domain software
  55.  * originally written at the National Center for Supercomputing Applications,
  56.  * University of Illinois, Urbana-Champaign.
  57.  */
  58.  
  59. #ifndef APR_HASH_H
  60. #define APR_HASH_H
  61.  
  62. /**
  63.  * @file apr_hash.h
  64.  * @brief APR Hash Tables
  65.  */
  66.  
  67. #include "apr_pools.h"
  68.  
  69. #ifdef __cplusplus
  70. extern "C" {
  71. #endif
  72.  
  73. /**
  74.  * @defgroup apr_hash Hash Tables
  75.  * @ingroup APR 
  76.  * @{
  77.  */
  78.  
  79. /**
  80.  * When passing a key to apr_hash_set or apr_hash_get, this value can be
  81.  * passed to indicate a string-valued key, and have apr_hash compute the
  82.  * length automatically.
  83.  *
  84.  * @remark apr_hash will use strlen(key) for the length. The null-terminator
  85.  *         is not included in the hash value (why throw a constant in?).
  86.  *         Since the hash table merely references the provided key (rather
  87.  *         than copying it), apr_hash_this() will return the null-term'd key.
  88.  */
  89. #define APR_HASH_KEY_STRING     (-1)
  90.  
  91. /**
  92.  * Abstract type for hash tables.
  93.  */
  94. typedef struct apr_hash_t apr_hash_t;
  95.  
  96. /**
  97.  * Abstract type for scanning hash tables.
  98.  */
  99. typedef struct apr_hash_index_t apr_hash_index_t;
  100.  
  101. /**
  102.  * Create a hash table.
  103.  * @param pool The pool to allocate the hash table out of
  104.  * @return The hash table just created
  105.   */
  106. APR_DECLARE(apr_hash_t *) apr_hash_make(apr_pool_t *pool);
  107.  
  108. /**
  109.  * Make a copy of a hash table
  110.  * @param pool The pool from which to allocate the new hash table
  111.  * @param h The hash table to clone
  112.  * @return The hash table just created
  113.  * @remark Makes a shallow copy
  114.  */
  115. APR_DECLARE(apr_hash_t *) apr_hash_copy(apr_pool_t *pool,
  116.                                         const apr_hash_t *h);
  117.  
  118. /**
  119.  * Associate a value with a key in a hash table.
  120.  * @param ht The hash table
  121.  * @param key Pointer to the key
  122.  * @param klen Length of the key. Can be APR_HASH_KEY_STRING to use the string length.
  123.  * @param val Value to associate with the key
  124.  * @remark If the value is NULL the hash entry is deleted.
  125.  */
  126. APR_DECLARE(void) apr_hash_set(apr_hash_t *ht, const void *key,
  127.                                apr_ssize_t klen, const void *val);
  128.  
  129. /**
  130.  * Look up the value associated with a key in a hash table.
  131.  * @param ht The hash table
  132.  * @param key Pointer to the key
  133.  * @param klen Length of the key. Can be APR_HASH_KEY_STRING to use the string length.
  134.  * @return Returns NULL if the key is not present.
  135.  */
  136. APR_DECLARE(void *) apr_hash_get(apr_hash_t *ht, const void *key,
  137.                                  apr_ssize_t klen);
  138.  
  139. /**
  140.  * Start iterating over the entries in a hash table.
  141.  * @param p The pool to allocate the apr_hash_index_t iterator. If this
  142.  *          pool is NULL, then an internal, non-thread-safe iterator is used.
  143.  * @param ht The hash table
  144.  * @remark  There is no restriction on adding or deleting hash entries during
  145.  * an iteration (although the results may be unpredictable unless all you do
  146.  * is delete the current entry) and multiple iterations can be in
  147.  * progress at the same time.
  148.  
  149.  * @example
  150.  */
  151. /**
  152.  * <PRE>
  153.  * 
  154.  * int sum_values(apr_pool_t *p, apr_hash_t *ht)
  155.  * {
  156.  *     apr_hash_index_t *hi;
  157.  *     void *val;
  158.  *     int sum = 0;
  159.  *     for (hi = apr_hash_first(p, ht); hi; hi = apr_hash_next(hi)) {
  160.  *         apr_hash_this(hi, NULL, NULL, &val);
  161.  *         sum += *(int *)val;
  162.  *     }
  163.  *     return sum;
  164.  * }
  165.  * </PRE>
  166.  */
  167. APR_DECLARE(apr_hash_index_t *) apr_hash_first(apr_pool_t *p, apr_hash_t *ht);
  168.  
  169. /**
  170.  * Continue iterating over the entries in a hash table.
  171.  * @param hi The iteration state
  172.  * @return a pointer to the updated iteration state.  NULL if there are no more  
  173.  *         entries.
  174.  */
  175. APR_DECLARE(apr_hash_index_t *) apr_hash_next(apr_hash_index_t *hi);
  176.  
  177. /**
  178.  * Get the current entry's details from the iteration state.
  179.  * @param hi The iteration state
  180.  * @param key Return pointer for the pointer to the key.
  181.  * @param klen Return pointer for the key length.
  182.  * @param val Return pointer for the associated value.
  183.  * @remark The return pointers should point to a variable that will be set to the
  184.  *         corresponding data, or they may be NULL if the data isn't interesting.
  185.  */
  186. APR_DECLARE(void) apr_hash_this(apr_hash_index_t *hi, const void **key, 
  187.                                 apr_ssize_t *klen, void **val);
  188.  
  189. /**
  190.  * Get the number of key/value pairs in the hash table.
  191.  * @param ht The hash table
  192.  * @return The number of key/value pairs in the hash table.
  193.  */
  194. APR_DECLARE(unsigned int) apr_hash_count(apr_hash_t *ht);
  195.  
  196. /**
  197.  * Merge two hash tables into one new hash table. The values of the overlay
  198.  * hash override the values of the base if both have the same key.
  199.  * @param p The pool to use for the new hash table
  200.  * @param overlay The table to add to the initial table
  201.  * @param base The table that represents the initial values of the new table
  202.  * @return A new hash table containing all of the data from the two passed in
  203.  */
  204. APR_DECLARE(apr_hash_t *) apr_hash_overlay(apr_pool_t *p,
  205.                                            const apr_hash_t *overlay, 
  206.                                            const apr_hash_t *base);
  207.  
  208. /**
  209.  * Merge two hash tables into one new hash table. If the same key
  210.  * is present in both tables, call the supplied merge function to
  211.  * produce a merged value for the key in the new table.
  212.  * @param p The pool to use for the new hash table
  213.  * @param h1 The first of the tables to merge
  214.  * @param h2 The second of the tables to merge
  215.  * @param merger A callback function to merge values, or NULL to
  216.  *  make values from h1 override values from h2 (same semantics as
  217.  *  apr_hash_overlay())
  218.  * @param data Client data to pass to the merger function
  219.  * @return A new hash table containing all of the data from the two passed in
  220.  */
  221. APR_DECLARE(apr_hash_t *) apr_hash_merge(apr_pool_t *p,
  222.                                          const apr_hash_t *h1,
  223.                                          const apr_hash_t *h2,
  224.                                          void * (*merger)(apr_pool_t *p,
  225.                                                      const void *key,
  226.                                                      apr_ssize_t klen,
  227.                                                      const void *h1_val,
  228.                                                      const void *h2_val,
  229.                                                      const void *data),
  230.                                          const void *data);
  231.  
  232. /**
  233.  * Get a pointer to the pool which the hash table was created in
  234.  */
  235. APR_POOL_DECLARE_ACCESSOR(hash);
  236.  
  237. /** @} */
  238.  
  239. #ifdef __cplusplus
  240. }
  241. #endif
  242.  
  243. #endif    /* !APR_HASH_H */
  244.