Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

apr_hash.h

Go to the documentation of this file.
00001 /* ====================================================================
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Apache" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation.  For more
00051  * information on the Apache Software Foundation, please see
00052  * <http://www.apache.org/>.
00053  *
00054  * Portions of this software are based upon public domain software
00055  * originally written at the National Center for Supercomputing Applications,
00056  * University of Illinois, Urbana-Champaign.
00057  */
00058 
00059 #ifndef APR_HASH_H
00060 #define APR_HASH_H
00061 
00067 #include "apr_pools.h"
00068 
00069 #ifdef __cplusplus
00070 extern "C" {
00071 #endif
00072 
00089 #define APR_HASH_KEY_STRING     (-1)
00090 
00094 typedef struct apr_hash_t apr_hash_t;
00095 
00099 typedef struct apr_hash_index_t apr_hash_index_t;
00100 
00106 APR_DECLARE(apr_hash_t *) apr_hash_make(apr_pool_t *pool);
00107 
00115 APR_DECLARE(apr_hash_t *) apr_hash_copy(apr_pool_t *pool,
00116                                         const apr_hash_t *h);
00117 
00126 APR_DECLARE(void) apr_hash_set(apr_hash_t *ht, const void *key,
00127                                apr_ssize_t klen, const void *val);
00128 
00136 APR_DECLARE(void *) apr_hash_get(apr_hash_t *ht, const void *key,
00137                                  apr_ssize_t klen);
00138 
00167 APR_DECLARE(apr_hash_index_t *) apr_hash_first(apr_pool_t *p, apr_hash_t *ht);
00168 
00175 APR_DECLARE(apr_hash_index_t *) apr_hash_next(apr_hash_index_t *hi);
00176 
00186 APR_DECLARE(void) apr_hash_this(apr_hash_index_t *hi, const void **key, 
00187                                 apr_ssize_t *klen, void **val);
00188 
00194 APR_DECLARE(unsigned int) apr_hash_count(apr_hash_t *ht);
00195 
00204 APR_DECLARE(apr_hash_t *) apr_hash_overlay(apr_pool_t *p,
00205                                            const apr_hash_t *overlay, 
00206                                            const apr_hash_t *base);
00207 
00221 APR_DECLARE(apr_hash_t *) apr_hash_merge(apr_pool_t *p,
00222                                          const apr_hash_t *h1,
00223                                          const apr_hash_t *h2,
00224                                          void * (*merger)(apr_pool_t *p,
00225                                                      const void *key,
00226                                                      apr_ssize_t klen,
00227                                                      const void *h1_val,
00228                                                      const void *h2_val,
00229                                                      const void *data),
00230                                          const void *data);
00231 
00235 APR_POOL_DECLARE_ACCESSOR(hash);
00236 
00239 #ifdef __cplusplus
00240 }
00241 #endif
00242 
00243 #endif  /* !APR_HASH_H */

Generated on Tue Aug 23 04:59:10 2005 for Apache Portable Runtime by  doxygen 1.3.9.1