1
0
mirror of https://github.com/apache/httpd.git synced 2026-10-23 22:49:01 +03:00
Files
apache/include/util_cfgtree.h
Ian Holsman 8c1e315d3f Doxygen fixup / cleanup
submited by: Neale Ranns neale ranns.org
reviewed by: Ian Holsman



git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@263931 13f79535-47bb-0310-9956-ffa450edef68
2005-08-28 23:03:59 +00:00

88 lines
2.7 KiB
C

/* Copyright 2000-2005 The Apache Software Foundation or its licensors, as
* applicable.
*
* Licensed 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.
*/
/**
* @file util_cfgtree.h
* @brief Config Tree Package
*
* @defgroup APACHE_CORE_CONFIG_TREE Config Tree Package
* @ingroup APACHE_CORE_CONFIG
* @{
*/
#ifndef AP_CONFTREE_H
#define AP_CONFTREE_H
#include "ap_config.h"
typedef struct ap_directive_t ap_directive_t;
/**
* @brief Structure used to build the config tree.
*
* The config tree only stores
* the directives that will be active in the running server. Directives
* that contain other directions, such as <Directory ...> cause a sub-level
* to be created, where the included directives are stored. The closing
* directive (</Directory>) is not stored in the tree.
*/
struct ap_directive_t {
/** The current directive */
const char *directive;
/** The arguments for the current directive, stored as a space
* separated list */
const char *args;
/** The next directive node in the tree
* @defvar ap_directive_t *next */
struct ap_directive_t *next;
/** The first child node of this directive
* @defvar ap_directive_t *first_child */
struct ap_directive_t *first_child;
/** The parent node of this directive
* @defvar ap_directive_t *parent */
struct ap_directive_t *parent;
/** directive's module can store add'l data here */
void *data;
/* ### these may go away in the future, but are needed for now */
/** The name of the file this directive was found in */
const char *filename;
/** The line number the directive was on */
int line_num;
};
/**
* The root of the configuration tree
* @defvar ap_directive_t *conftree
*/
AP_DECLARE_DATA extern ap_directive_t *ap_conftree;
/**
* Add a node to the configuration tree.
* @param parent The current parent node. If the added node is a first_child,
then this is changed to the current node
* @param current The current node
* @param toadd The node to add to the tree
* @param child Is the node to add a child node
* @return the added node
*/
ap_directive_t *ap_add_node(ap_directive_t **parent, ap_directive_t *current,
ap_directive_t *toadd, int child);
#endif
/** @} */