Version 0.1.10 from FTP
[asterisk/asterisk.git] / include / asterisk / config.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Configuration File Parser
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #ifndef _ASTERISK_CONFIG_H
15 #define _ASTERISK_CONFIG_H
16
17 #if defined(__cplusplus) || defined(c_plusplus)
18 extern "C" {
19 #endif
20
21 struct ast_config;
22
23 struct ast_variable {
24         char *name;
25         char *value;
26         int lineno;
27         struct ast_variable *next;
28 };
29
30 //! Load a config file
31 /*! 
32  * \param configfile path of file to open.  If no preceding '/' character, path is considered relative to AST_CONFIG_DIR
33  * Create a config structure from a given configuration file.
34  * Returns NULL on error, or an ast_config data structure on success
35  */
36 struct ast_config *ast_load(char *configfile);
37
38 //! Removes a config
39 /*!
40  * \param config config data structure associated with the config.
41  * Free memory associated with a given config
42  * Returns nothing
43  */
44 void ast_destroy(struct ast_config *config);
45
46 //! Goes through categories
47 /*!
48  * \param config Which config file you wish to "browse"
49  * \param prev A pointer to a previous category.
50  * This funtion is kind of non-intuitive in it's use.  To begin, one passes NULL as the second arguement.  It will return a pointer to the string of the first category in the file.  From here on after, one must then pass the previous usage's return value as the second pointer, and it will return a pointer to the category name afterwards.  Note:  If you manually strcpy a string into a character array and pass it thinking it will return your category, it will not; the comparisons are not done doing strcmp, they are done by checking whether the value of the string POINTER is the same.
51  * Returns a category on success, or NULL on failure/no-more-categories
52  */
53 char *ast_category_browse(struct ast_config *config, char *prev);
54
55 //! Goes through variables
56 /*!
57  * Somewhat similar in intent as the ast_category_browse.  The category MUST be an actual pointer to an actual category (such as one obtained by using ast_category_browse()).
58  * List variables of config file
59  * Returns ast_variable list on success, or NULL on failure
60  */
61 struct ast_variable *ast_variable_browse(struct ast_config *config, char *category);
62
63 //! Gets a variable
64 /*!
65  * \param config which (opened) config to use
66  * \param category category under which the variable lies (must be a pointer to the category, such as one given by ast_category_browse)
67  * \param value which variable you wish to get the data for
68  * Goes through a given config file in the given category and searches for the given variable
69  * Returns the variable value on success, or NULL if unable to find it.
70  * Retrieve a specific variable */
71 char *ast_variable_retrieve(struct ast_config *config, char *category, char *value);
72
73 //! Make sure something is true
74 /*!
75  * Determine affermativeness of a boolean value.
76  * This function checks to see whether a string passed to it is an indication of an affirmitave value.  It checks to see if the string is "yes", "true", "y", "t", and "1".  
77  * Returns 0 if the value of s is a NULL pointer, 0 on "truth", and -1 on falsehood.
78  */
79 int ast_true(char *val);
80
81 //! Check for category duplicates
82 /*!
83  * \param config which config to use
84  * \param category_name name of the category you're looking for
85  * This will search through the categories within a given config file and search for a match.  The passed category_name can be a regular string (as opposed to a pointer of an existent string, lol)
86  * Browse config structure and check for category duplicity Return non-zero if found */
87 int ast_category_exist(struct ast_config *config, char *category_name);
88
89 #if defined(__cplusplus) || defined(c_plusplus)
90 }
91 #endif
92
93
94
95 #endif