apr_hash.h

Go to the documentation of this file.

/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef APR_HASH_H
#define APR_HASH_H
 
#include "apr_pools.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define APR_HASH_KEY_STRING     (-1)
 
typedef struct apr_hash_t apr_hash_t;
 
typedef struct apr_hash_index_t apr_hash_index_t;
 
typedef unsigned int (*apr_hashfunc_t)(const char *key, apr_ssize_t *klen);
 
APR_DECLARE_NONSTD(unsigned int) apr_hashfunc_default(const char *key,
                                                      apr_ssize_t *klen);
 
APR_DECLARE(apr_hash_t *) apr_hash_make(apr_pool_t *pool);
 
APR_DECLARE(apr_hash_t *) apr_hash_make_custom(apr_pool_t *pool, 
                                               apr_hashfunc_t hash_func);
 
APR_DECLARE(apr_hash_t *) apr_hash_copy(apr_pool_t *pool,
                                        const apr_hash_t *h);
 
APR_DECLARE(void) apr_hash_set(apr_hash_t *ht, const void *key,
                               apr_ssize_t klen, const void *val);
 
APR_DECLARE(void *) apr_hash_get(apr_hash_t *ht, const void *key,
                                 apr_ssize_t klen);
 
APR_DECLARE(apr_hash_index_t *) apr_hash_first(apr_pool_t *p, apr_hash_t *ht);
 
APR_DECLARE(apr_hash_index_t *) apr_hash_next(apr_hash_index_t *hi);
 
APR_DECLARE(void) apr_hash_this(apr_hash_index_t *hi, const void **key, 
                                apr_ssize_t *klen, void **val);
 
APR_DECLARE(const void*) apr_hash_this_key(apr_hash_index_t *hi);
 
APR_DECLARE(apr_ssize_t) apr_hash_this_key_len(apr_hash_index_t *hi);
 
APR_DECLARE(void*) apr_hash_this_val(apr_hash_index_t *hi);
 
APR_DECLARE(unsigned int) apr_hash_count(apr_hash_t *ht);
 
APR_DECLARE(void) apr_hash_clear(apr_hash_t *ht);
 
APR_DECLARE(apr_hash_t *) apr_hash_overlay(apr_pool_t *p,
                                           const apr_hash_t *overlay, 
                                           const apr_hash_t *base);
 
APR_DECLARE(apr_hash_t *) apr_hash_merge(apr_pool_t *p,
                                         const apr_hash_t *h1,
                                         const apr_hash_t *h2,
                                         void * (*merger)(apr_pool_t *p,
                                                     const void *key,
                                                     apr_ssize_t klen,
                                                     const void *h1_val,
                                                     const void *h2_val,
                                                     const void *data),
                                         const void *data);
 
typedef int (apr_hash_do_callback_fn_t)(void *rec, const void *key,
                                                   apr_ssize_t klen,
                                                   const void *value);
 
APR_DECLARE(int) apr_hash_do(apr_hash_do_callback_fn_t *comp,
                             void *rec, const apr_hash_t *ht);
 
APR_POOL_DECLARE_ACCESSOR(hash);
 
#ifdef __cplusplus
}
#endif
 
#endif  /* !APR_HASH_H */