granicus.if.org Git - apache/blob - include/util_cfgtree.h

   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
  55 #ifndef AP_CONFTREE_H
  56 #define AP_CONFTREE_H
  57
  58 #include "ap_config.h"
  59
  60 /**
  61  * @package Config Tree Package
  62  */
  63
  64 typedef struct ap_directive_t ap_directive_t;
  65
  66 /**
  67  * Structure used to build the config tree.  The config tree only stores
  68  * the directives that will be active in the running server.  Directives
  69  * that contain other directions, such as <Directory ...> cause a sub-level
  70  * to be created, where the included directives are stored.  The closing
  71  * directive (</Directory>) is not stored in the tree.
  72  */
  73 struct ap_directive_t {
  74     /** The current directive */
  75     const char *directive;
  76     /** The arguments for the current directive, stored as a space
  77      *  separated list */
  78     const char *args;
  79     /** The next directive node in the tree
  80      *  @defvar ap_directive_t *next */
  81     struct ap_directive_t *next;
  82     /** The first child node of this directive
  83      *  @defvar ap_directive_t *first_child */
  84     struct ap_directive_t *first_child;
  85     /** The parent node of this directive
  86      *  @defvar ap_directive_t *parent */
  87     struct ap_directive_t *parent;
  88
  89     /** directive's module can store add'l data here */
  90     void *data;
  91
  92     /* ### these may go away in the future, but are needed for now */
  93     /** The name of the file this directive was found in */
  94     const char *filename;
  95     /** The line number the directive was on */
  96     int line_num;
  97 };
  98
  99 /**
 100  * The root of the configuration tree
 101  * @defvar ap_directive_t *conftree
 102  */
 103 AP_DECLARE_DATA extern ap_directive_t *ap_conftree;
 104
 105 /**
 106  * Add a node to the configuration tree.
 107  * @param parent The current parent node.  If the added node is a first_child,
 108                  then this is changed to the current node
 109  * @param current The current node
 110  * @param toadd The node to add to the tree
 111  * @param child Is the node to add a child node
 112  * @return the added node
 113  */
 114 ap_directive_t *ap_add_node(ap_directive_t **parent, ap_directive_t *current,
 115                             ap_directive_t *toadd, int child);
 116
 117 #endif