Fix up some doxygen issues.
[asterisk/asterisk.git] / include / asterisk / extconf.h
1 /*  
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007, Digium, Inc.
5  *
6  * Steve Murphy <murf@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18 /*! \file 
19  * \brief External configuration handlers (realtime and static configuration)
20  * \author Steve Murphy <murf@digium.com>
21  *
22  */
23
24 #ifndef _ASTERISK_EXTCONF_H
25 #define _ASTERISK_EXTCONF_H
26
27 #if defined(__cplusplus) || defined(c_plusplus)
28 extern "C" {
29 #endif
30
31 #ifdef NOTYET
32 /* I'm going to define all the structs mentioned below, to avoid
33    possible conflicts in declarations that might be introduced, 
34    if we just include the files that define them-- this may be
35    unnecessary */
36
37 struct ast_comment {
38         struct ast_comment *next;
39         char cmt[0];
40 };
41
42 struct ast_variable {
43         char *name;
44         char *value;
45         int lineno;
46         int object;             /*!< 0 for variable, 1 for object */
47         int blanklines;         /*!< Number of blanklines following entry */
48         struct ast_comment *precomments;
49         struct ast_comment *sameline;
50         struct ast_variable *next;
51         char stuff[0];
52 };
53
54 struct ast_category {
55         char name[80];
56         int ignored;                    /*!< do not let user of the config see this category */
57         int include_level;      
58         struct ast_comment *precomments;
59         struct ast_comment *sameline;
60         struct ast_variable *root;
61         struct ast_variable *last;
62         struct ast_category *next;
63 };
64
65 struct ast_config {
66         struct ast_category *root;
67         struct ast_category *last;
68         struct ast_category *current;
69         struct ast_category *last_browse;               /*!< used to cache the last category supplied via category_browse */
70         int include_level;
71         int max_include_level;
72 };
73
74 /* ================== above: the config world; below, the dialplan world */
75
76 /*! \brief A registered application */
77 struct ast_app {
78         int (*execute)(struct ast_channel *chan, void *data);
79         const char *synopsis;                   /*!< Synopsis text for 'show applications' */
80         const char *description;                /*!< Description (help text) for 'show application &lt;name&gt;' */
81         AST_RWLIST_ENTRY(ast_app) list;         /*!< Next app in list */
82         void *module;                   /*!< Module this app belongs to */
83         char name[0];                           /*!< Name of the application */
84 };
85 /*!
86    \brief An extension
87         The dialplan is saved as a linked list with each context
88         having it's own linked list of extensions - one item per
89         priority.
90 */
91 struct ast_exten {
92         char *exten;                    /*!< Extension name */
93         int matchcid;                   /*!< Match caller id ? */
94         const char *cidmatch;           /*!< Caller id to match for this extension */
95         int priority;                   /*!< Priority */
96         const char *label;              /*!< Label */
97         struct ast_context *parent;     /*!< The context this extension belongs to  */
98         const char *app;                /*!< Application to execute */
99         struct ast_app *cached_app;     /*!< Cached location of application */
100         void *data;                     /*!< Data to use (arguments) */
101         void (*datad)(void *);          /*!< Data destructor */
102         struct ast_exten *peer;         /*!< Next higher priority with our extension */
103         const char *registrar;          /*!< Registrar */
104         struct ast_exten *next;         /*!< Extension with a greater ID */
105         char stuff[0];
106 };
107 /* from pbx.h */
108 typedef int (*ast_state_cb_type)(char *context, char* id, enum ast_extension_states state, void *data);
109 struct ast_timing {
110         int hastime;                            /*!< If time construct exists */
111         unsigned int monthmask;                 /*!< Mask for month */
112         unsigned int daymask;                   /*!< Mask for date */
113         unsigned int dowmask;                   /*!< Mask for day of week (mon-sun) */
114         unsigned int minmask[24];               /*!< Mask for minute */
115 };
116 /*! \brief include= support in extensions.conf */
117 struct ast_include {
118         const char *name;
119         const char *rname;                      /*!< Context to include */
120         const char *registrar;                  /*!< Registrar */
121         int hastime;                            /*!< If time construct exists */
122         struct ast_timing timing;               /*!< time construct */
123         struct ast_include *next;               /*!< Link them together */
124         char stuff[0];
125 };
126
127 /*! \brief Switch statement in extensions.conf */
128 struct ast_sw {
129         char *name;
130         const char *registrar;                  /*!< Registrar */
131         char *data;                             /*!< Data load */
132         int eval;
133         AST_LIST_ENTRY(ast_sw) list;
134         char *tmpdata;
135         char stuff[0];
136 };
137
138 *! \brief Ignore patterns in dial plan */
139 struct ast_ignorepat {
140         const char *registrar;
141         struct ast_ignorepat *next;
142         const char pattern[0];
143 };
144
145 /*! \brief An extension context */
146 struct ast_context {
147         ast_rwlock_t lock;                      /*!< A lock to prevent multiple threads from clobbering the context */
148         struct ast_exten *root;                 /*!< The root of the list of extensions */
149         struct ast_context *next;               /*!< Link them together */
150         struct ast_include *includes;           /*!< Include other contexts */
151         struct ast_ignorepat *ignorepats;       /*!< Patterns for which to continue playing dialtone */
152         const char *registrar;                  /*!< Registrar */
153         AST_LIST_HEAD_NOLOCK(, ast_sw) alts;    /*!< Alternative switches */
154         ast_mutex_t macrolock;                  /*!< A lock to implement "exclusive" macros - held whilst a call is executing in the macro */
155         char name[0];                           /*!< Name of the context */
156 };
157
158 #endif
159
160 struct ast_config *localized_config_load(const char *filename);
161 struct ast_config *localized_config_load_with_comments(const char *filename);
162 struct ast_category *localized_category_get(const struct ast_config *config, const char *category_name);
163 int localized_config_text_file_save(const char *configfile, const struct ast_config *cfg, const char *generator);
164 struct ast_context *localized_walk_contexts(struct ast_context *con);
165 struct ast_exten *localized_walk_context_extensions(struct ast_context *con,
166                                                                                                         struct ast_exten *exten);
167 struct ast_exten *localized_walk_extension_priorities(struct ast_exten *exten,
168                                                                                                           struct ast_exten *priority);
169 struct ast_include *localized_walk_context_includes(struct ast_context *con,
170                                                                                                         struct ast_include *inc);
171 struct ast_sw *localized_walk_context_switches(struct ast_context *con,
172                                                                                            struct ast_sw *sw);
173
174 void localized_context_destroy(struct ast_context *con, const char *registrar);
175 int localized_pbx_load_module(void);
176
177 struct ast_context *localized_context_create(struct ast_context **extcontexts, const char *name, const char *registrar);
178 int localized_pbx_builtin_setvar(struct ast_channel *chan, void *data);
179 int localized_context_add_ignorepat2(struct ast_context *con, const char *value, const char *registrar);
180 int localized_context_add_switch2(struct ast_context *con, const char *value,
181                                                                  const char *data, int eval, const char *registrar);
182 int localized_context_add_include2(struct ast_context *con, const char *value,
183                                                                   const char *registrar);
184 int localized_add_extension2(struct ast_context *con,
185                                                          int replace, const char *extension, int priority, const char *label, const char *callerid,
186                                                          const char *application, void *data, void (*datad)(void *),
187                                                          const char *registrar);
188 void localized_merge_contexts_and_delete(struct ast_context **extcontexts, const char *registrar);
189 int localized_context_verify_includes(struct ast_context *con);
190 void localized_use_conf_dir(void);
191 void localized_use_local_dir(void);
192
193
194 #ifndef _ASTERISK_PBX_H
195 /*!
196  * When looking up extensions, we can have different requests
197  * identified by the 'action' argument, as follows.
198  * Note that the coding is such that the low 4 bits are the
199  * third argument to extension_match_core.
200  */
201 enum ext_match_t {
202         E_MATCHMORE =   0x00,   /* extension can match but only with more 'digits' */
203         E_CANMATCH =    0x01,   /* extension can match with or without more 'digits' */
204         E_MATCH =       0x02,   /* extension is an exact match */
205         E_MATCH_MASK =  0x03,   /* mask for the argument to extension_match_core() */
206         E_SPAWN =       0x12,   /* want to spawn an extension. Requires exact match */
207         E_FINDLABEL =   0x22    /* returns the priority for a given label. Requires exact match */
208 };
209 #define AST_PBX_MAX_STACK  128
210
211 /* request and result for pbx_find_extension */
212 struct pbx_find_info {
213 #if 0
214         const char *context;
215         const char *exten;
216         int priority;
217 #endif
218
219         char *incstack[AST_PBX_MAX_STACK];      /* filled during the search */
220         int stacklen;                   /* modified during the search */
221         int status;                     /* set on return */
222         struct ast_switch *swo;         /* set on return */
223         const char *data;               /* set on return */
224         const char *foundcontext;       /* set on return */
225 };
226
227 #define STATUS_NO_CONTEXT       1
228 #define STATUS_NO_EXTENSION     2
229 #define STATUS_NO_PRIORITY      3
230 #define STATUS_NO_LABEL         4
231 #define STATUS_SUCCESS          5 
232
233 #endif
234
235 struct ast_exten *localized_find_extension(struct ast_context *bypass,
236                                                                                   struct pbx_find_info *q,
237                                                                                   const char *context, 
238                                                                                   const char *exten, 
239                                                                                   int priority,
240                                                                                   const char *label, 
241                                                                                   const char *callerid, 
242                                                                                   enum ext_match_t action);
243
244
245 #if defined(__cplusplus) || defined(c_plusplus)
246 }
247 #endif
248
249 #endif /* _ASTERISK_PBX_H */