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