apr_tables.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_TABLES_H
#define APR_TABLES_H

#include "apr.h"
#include "apr_pools.h"

#if APR_HAVE_STDARG_H
#include <stdarg.h>     /* for va_list */
#endif

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

typedef struct apr_table_t apr_table_t;

typedef struct apr_array_header_t apr_array_header_t;

struct apr_array_header_t {
    apr_pool_t *pool;
    int elt_size;
    int nelts;
    int nalloc;
    char *elts;
};

typedef struct apr_table_entry_t apr_table_entry_t;

struct apr_table_entry_t {
    char *key;          /* maybe NULL in future;
                         * check when iterating thru table_elts
                         */
    char *val;

    apr_uint32_t key_checksum;
};

APR_DECLARE(const apr_array_header_t *) apr_table_elts(const apr_table_t *t);

APR_DECLARE(int) apr_is_empty_table(const apr_table_t *t);

APR_DECLARE(int) apr_is_empty_array(const apr_array_header_t *a);

APR_DECLARE(apr_array_header_t *) apr_array_make(apr_pool_t *p,
                                                 int nelts, int elt_size);

APR_DECLARE(void *) apr_array_push(apr_array_header_t *arr);

#define APR_ARRAY_IDX(ary,i,type) (((type *)(ary)->elts)[i])

#define APR_ARRAY_PUSH(ary,type) (*((type *)apr_array_push(ary)))

APR_DECLARE(void *) apr_array_pop(apr_array_header_t *arr);

APR_DECLARE(void) apr_array_clear(apr_array_header_t *arr);

APR_DECLARE(void) apr_array_cat(apr_array_header_t *dst,
                                const apr_array_header_t *src);

APR_DECLARE(apr_array_header_t *) apr_array_copy(apr_pool_t *p,
                                      const apr_array_header_t *arr);
APR_DECLARE(apr_array_header_t *) apr_array_copy_hdr(apr_pool_t *p,
                                      const apr_array_header_t *arr);

APR_DECLARE(apr_array_header_t *) apr_array_append(apr_pool_t *p,
                                      const apr_array_header_t *first,
                                      const apr_array_header_t *second);

APR_DECLARE(char *) apr_array_pstrcat(apr_pool_t *p,
                                      const apr_array_header_t *arr,
                                      const char sep);

APR_DECLARE(apr_table_t *) apr_table_make(apr_pool_t *p, int nelts);

APR_DECLARE(apr_table_t *) apr_table_copy(apr_pool_t *p,
                                          const apr_table_t *t);

APR_DECLARE(apr_table_t *) apr_table_clone(apr_pool_t *p,
                                           const apr_table_t *t);

APR_DECLARE(void) apr_table_clear(apr_table_t *t);

APR_DECLARE(const char *) apr_table_get(const apr_table_t *t, const char *key);

APR_DECLARE(void) apr_table_set(apr_table_t *t, const char *key,
                                const char *val);

APR_DECLARE(void) apr_table_setn(apr_table_t *t, const char *key,
                                 const char *val);

APR_DECLARE(void) apr_table_unset(apr_table_t *t, const char *key);

APR_DECLARE(void) apr_table_merge(apr_table_t *t, const char *key,
                                  const char *val);

APR_DECLARE(void) apr_table_mergen(apr_table_t *t, const char *key,
                                   const char *val);

APR_DECLARE(void) apr_table_add(apr_table_t *t, const char *key,
                                const char *val);

APR_DECLARE(void) apr_table_addn(apr_table_t *t, const char *key,
                                 const char *val);

APR_DECLARE(apr_table_t *) apr_table_overlay(apr_pool_t *p,
                                             const apr_table_t *overlay,
                                             const apr_table_t *base);

typedef int (apr_table_do_callback_fn_t)(void *rec, const char *key, 
                                                    const char *value);

APR_DECLARE_NONSTD(int) apr_table_do(apr_table_do_callback_fn_t *comp,
                                     void *rec, const apr_table_t *t, ...)
#if defined(__GNUC__) && __GNUC__ >= 4
    __attribute__((sentinel))
#endif
    ;

APR_DECLARE(int) apr_table_vdo(apr_table_do_callback_fn_t *comp,
                               void *rec, const apr_table_t *t, va_list vp);

#define APR_OVERLAP_TABLES_SET   (0)

#define APR_OVERLAP_TABLES_MERGE (1)

APR_DECLARE(void) apr_table_overlap(apr_table_t *a, const apr_table_t *b,
                                     unsigned flags);

APR_DECLARE(void) apr_table_compress(apr_table_t *t, unsigned flags);

#ifdef __cplusplus
}
#endif

#endif  /* ! APR_TABLES_H */