00001 /* 00002 * Asterisk -- An open source telephony toolkit. 00003 * 00004 * Copyright (C) 1999 - 2005, Digium, Inc. 00005 * 00006 * Mark Spencer <markster@digium.com> 00007 * See http://www.asterisk.org for more information about 00008 * the Asterisk project. Please do not directly contact 00009 * any of the maintainers of this project for assistance; 00010 * the project provides a web site, mailing lists and IRC 00011 * channels for your use. 00012 * 00013 * This program is free software, distributed under the terms of 00014 * the GNU General Public License Version 2. See the LICENSE file 00015 * at the top of the source tree. 00016 */ 00017 00018 /*! \file 00019 * \brief Application convenience functions, designed to give consistent 00020 * look and feel to Asterisk apps. 00021 */ 00022 00023 #ifndef _ASTERISK_APP_H 00024 #define _ASTERISK_APP_H 00025 00026 #include "asterisk/strings.h" 00027 #include "asterisk/threadstorage.h" 00028 00029 struct ast_flags64; 00030 00031 #if defined(__cplusplus) || defined(c_plusplus) 00032 extern "C" { 00033 #endif 00034 00035 AST_THREADSTORAGE_EXTERNAL(ast_str_thread_global_buf); 00036 00037 /* IVR stuff */ 00038 00039 /*! \brief Callback function for IVR 00040 \return returns 0 on completion, -1 on hangup or digit if interrupted 00041 */ 00042 typedef int (*ast_ivr_callback)(struct ast_channel *chan, char *option, void *cbdata); 00043 00044 typedef enum { 00045 AST_ACTION_UPONE, /*!< adata is unused */ 00046 AST_ACTION_EXIT, /*!< adata is the return value for ast_ivr_menu_run if channel was not hungup */ 00047 AST_ACTION_CALLBACK, /*!< adata is an ast_ivr_callback */ 00048 AST_ACTION_PLAYBACK, /*!< adata is file to play */ 00049 AST_ACTION_BACKGROUND, /*!< adata is file to play */ 00050 AST_ACTION_PLAYLIST, /*!< adata is list of files, separated by ; to play */ 00051 AST_ACTION_MENU, /*!< adata is a pointer to an ast_ivr_menu */ 00052 AST_ACTION_REPEAT, /*!< adata is max # of repeats, cast to a pointer */ 00053 AST_ACTION_RESTART, /*!< adata is like repeat, but resets repeats to 0 */ 00054 AST_ACTION_TRANSFER, /*!< adata is a string with exten\verbatim[@context]\endverbatim */ 00055 AST_ACTION_WAITOPTION, /*!< adata is a timeout, or 0 for defaults */ 00056 AST_ACTION_NOOP, /*!< adata is unused */ 00057 AST_ACTION_BACKLIST, /*!< adata is list of files separated by ; allows interruption */ 00058 } ast_ivr_action; 00059 00060 /*! 00061 Special "options" are: 00062 \arg "s" - "start here (one time greeting)" 00063 \arg "g" - "greeting/instructions" 00064 \arg "t" - "timeout" 00065 \arg "h" - "hangup" 00066 \arg "i" - "invalid selection" 00067 00068 */ 00069 struct ast_ivr_option { 00070 char *option; 00071 ast_ivr_action action; 00072 void *adata; 00073 }; 00074 00075 struct ast_ivr_menu { 00076 char *title; /*!< Title of menu */ 00077 unsigned int flags; /*!< Flags */ 00078 struct ast_ivr_option *options; /*!< All options */ 00079 }; 00080 00081 #define AST_IVR_FLAG_AUTORESTART (1 << 0) 00082 00083 #define AST_IVR_DECLARE_MENU(holder, title, flags, foo...) \ 00084 static struct ast_ivr_option __options_##holder[] = foo;\ 00085 static struct ast_ivr_menu holder = { title, flags, __options_##holder } 00086 00087 enum ast_timelen { 00088 TIMELEN_HOURS, 00089 TIMELEN_MINUTES, 00090 TIMELEN_SECONDS, 00091 TIMELEN_MILLISECONDS, 00092 }; 00093 00094 /*! \brief Runs an IVR menu 00095 \return returns 0 on successful completion, -1 on hangup, or -2 on user error in menu */ 00096 int ast_ivr_menu_run(struct ast_channel *c, struct ast_ivr_menu *menu, void *cbdata); 00097 00098 /*! \brief Plays a stream and gets DTMF data from a channel 00099 * \param c Which channel one is interacting with 00100 * \param prompt File to pass to ast_streamfile (the one that you wish to play). 00101 * It is also valid for this to be multiple files concatenated by "&". 00102 * For example, "file1&file2&file3". 00103 * \param s The location where the DTMF data will be stored 00104 * \param maxlen Max Length of the data 00105 * \param timeout Timeout length waiting for data(in milliseconds). Set to 0 for standard timeout(six seconds), or -1 for no time out. 00106 * 00107 * This function was designed for application programmers for situations where they need 00108 * to play a message and then get some DTMF data in response to the message. If a digit 00109 * is pressed during playback, it will immediately break out of the message and continue 00110 * execution of your code. 00111 */ 00112 int ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout); 00113 00114 /*! \brief Full version with audiofd and controlfd. NOTE: returns '2' on ctrlfd available, not '1' like other full functions */ 00115 int ast_app_getdata_full(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd); 00116 00117 /*! 00118 * \since 1.8 00119 * \brief Run a macro on a channel, placing a second channel into autoservice. 00120 * 00121 * This is a shorthand method that makes it very easy to run a macro on any given 00122 * channel. It is perfectly reasonable to supply a NULL autoservice_chan here in case 00123 * there is no channel to place into autoservice. It is very important that the 00124 * autoservice_chan parameter is not locked prior to calling ast_app_run_macro. A 00125 * deadlock could result, otherwise. 00126 * 00127 * \param autoservice_chan A channel to place into autoservice while the macro is run 00128 * \param macro_chan The channel to run the macro on 00129 * \param macro_name The name of the macro to run 00130 * \param macro_args The arguments to pass to the macro 00131 * \retval 0 success 00132 * \retval -1 failure 00133 */ 00134 int ast_app_run_macro(struct ast_channel *autoservice_chan, struct ast_channel 00135 *macro_chan, const char * const macro_name, const char * const macro_args); 00136 00137 /*! 00138 * \brief Set voicemail function callbacks 00139 * \param[in] has_voicemail_func set function pointer 00140 * \param[in] inboxcount2_func set function pointer 00141 * \param[in] sayname_func set function pointer 00142 * \param[in] inboxcount_func set function pointer 00143 * \param[in] messagecount_func set function pointer 00144 * \version 1.6.1 Added inboxcount2_func, sayname_func 00145 */ 00146 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder), 00147 int (*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs), 00148 int (*inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs), 00149 int (*messagecount_func)(const char *context, const char *mailbox, const char *folder), 00150 int (*sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context)); 00151 00152 void ast_uninstall_vm_functions(void); 00153 00154 /*! 00155 * \brief Determine if a given mailbox has any voicemail 00156 * If folder is NULL, defaults to "INBOX". If folder is "INBOX", includes the 00157 * number of messages in the "Urgent" folder. 00158 * \retval 1 Mailbox has voicemail 00159 * \retval 0 No new voicemail in specified mailbox 00160 * \retval -1 Failure 00161 * \since 1.0 00162 */ 00163 int ast_app_has_voicemail(const char *mailbox, const char *folder); 00164 00165 /*! 00166 * \brief Determine number of new/old messages in a mailbox 00167 * \since 1.0 00168 * \param[in] mailbox Mailbox specification in the format mbox[@context][&mbox2[@context2]][...] 00169 * \param[out] newmsgs Number of messages in the "INBOX" folder. Includes number of messages in the "Urgent" folder, if any. 00170 * \param[out] oldmsgs Number of messages in the "Old" folder. 00171 * \retval 0 Success 00172 * \retval -1 Failure 00173 */ 00174 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs); 00175 00176 /*! 00177 * \brief Determine number of urgent/new/old messages in a mailbox 00178 * \param[in] mailbox the mailbox context to use 00179 * \param[out] urgentmsgs the urgent message count 00180 * \param[out] newmsgs the new message count 00181 * \param[out] oldmsgs the old message count 00182 * \return Returns 0 for success, negative upon error 00183 * \since 1.6.1 00184 */ 00185 int ast_app_inboxcount2(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs); 00186 00187 /*! 00188 * \brief Given a mailbox and context, play that mailbox owner's name to the channel specified 00189 * \param[in] chan Channel on which to play the name 00190 * \param[in] mailbox Mailbox number from which to retrieve the recording 00191 * \param[in] context Mailbox context from which to locate the mailbox number 00192 * \retval 0 Name played without interruption 00193 * \retval dtmf ASCII value of the DTMF which interrupted playback. 00194 * \retval -1 Unable to locate mailbox or hangup occurred. 00195 * \since 1.6.1 00196 */ 00197 int ast_app_sayname(struct ast_channel *chan, const char *mailbox, const char *context); 00198 00199 /*! 00200 * \brief Check number of messages in a given context, mailbox, and folder 00201 * \since 1.4 00202 * \param[in] context Mailbox context 00203 * \param[in] mailbox Mailbox number 00204 * \param[in] folder Mailbox folder 00205 * \return Number of messages in the given context, mailbox, and folder. If folder is NULL, folder "INBOX" is assumed. If folder is "INBOX", includes number of messages in the "Urgent" folder. 00206 */ 00207 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder); 00208 00209 /*! \brief Safely spawn an external program while closing file descriptors 00210 \note This replaces the \b system call in all Asterisk modules 00211 */ 00212 int ast_safe_system(const char *s); 00213 00214 /*! 00215 * \brief Replace the SIGCHLD handler 00216 * 00217 * Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie 00218 * processes from forking elsewhere in Asterisk. However, if you want to 00219 * wait*() on the process to retrieve information about it's exit status, 00220 * then this signal handler needs to be temporarily replaced. 00221 * 00222 * Code that executes this function *must* call ast_unreplace_sigchld() 00223 * after it is finished doing the wait*(). 00224 */ 00225 void ast_replace_sigchld(void); 00226 00227 /*! 00228 * \brief Restore the SIGCHLD handler 00229 * 00230 * This function is called after a call to ast_replace_sigchld. It restores 00231 * the SIGCHLD handler that cleans up any zombie processes. 00232 */ 00233 void ast_unreplace_sigchld(void); 00234 00235 /*! 00236 \brief Send DTMF to a channel 00237 00238 \param chan The channel that will receive the DTMF frames 00239 \param peer (optional) Peer channel that will be autoserviced while the 00240 primary channel is receiving DTMF 00241 \param digits This is a string of characters representing the DTMF digits 00242 to be sent to the channel. Valid characters are 00243 "0123456789*#abcdABCD". Note: You can pass arguments 'f' or 00244 'F', if you want to Flash the channel (if supported by the 00245 channel), or 'w' to add a 500 millisecond pause to the DTMF 00246 sequence. 00247 \param between This is the number of milliseconds to wait in between each 00248 DTMF digit. If zero milliseconds is specified, then the 00249 default value of 100 will be used. 00250 \param duration This is the duration that each DTMF digit should have. 00251 */ 00252 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration); 00253 00254 /*! \brief Stream a filename (or file descriptor) as a generator. */ 00255 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride); 00256 00257 /*! 00258 * \brief Stream a file with fast forward, pause, reverse, restart. 00259 * \param chan 00260 * \param file filename 00261 * \param fwd, rev, stop, pause, restart, skipms, offsetms 00262 * 00263 * Before calling this function, set this to be the number 00264 * of ms to start from the beginning of the file. When the function 00265 * returns, it will be the number of ms from the beginning where the 00266 * playback stopped. Pass NULL if you don't care. 00267 */ 00268 int ast_control_streamfile(struct ast_channel *chan, const char *file, const char *fwd, const char *rev, const char *stop, const char *pause, const char *restart, int skipms, long *offsetms); 00269 00270 /*! \brief Play a stream and wait for a digit, returning the digit that was pressed */ 00271 int ast_play_and_wait(struct ast_channel *chan, const char *fn); 00272 00273 /*! 00274 * \brief Record a file based on input from a channel 00275 * This function will play "auth-thankyou" upon successful recording. 00276 * 00277 * \param chan the channel being recorded 00278 * \param playfile Filename of sound to play before recording begins 00279 * \param recordfile Filename to save the recording 00280 * \param maxtime_sec Longest possible message length in seconds 00281 * \param fmt string containing all formats to be recorded delimited by '|' 00282 * \param duration pointer to integer for storing length of the recording 00283 * \param sound_duration pointer to integer for storing length of the recording minus all silence 00284 * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default 00285 * \param maxsilence_ms Length of time in milliseconds which will trigger a timeout from silence, -1 for default 00286 * \param path Optional filesystem path to unlock 00287 * \param acceptdtmf Character of DTMF to end and accept the recording 00288 * \param canceldtmf Character of DTMF to end and cancel the recording 00289 * 00290 * \retval -1 failure or hangup 00291 * \retval 'S' Recording ended from silence timeout 00292 * \retval 't' Recording ended from the message exceeding the maximum duration 00293 * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept. 00294 */ 00295 int ast_play_and_record_full(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int *sound_duration, int silencethreshold, int maxsilence_ms, const char *path, const char *acceptdtmf, const char *canceldtmf); 00296 00297 /*! 00298 * \brief Record a file based on input from a channel. Use default accept and cancel DTMF. 00299 * This function will play "auth-thankyou" upon successful recording. 00300 * 00301 * \param chan the channel being recorded 00302 * \param playfile Filename of sound to play before recording begins 00303 * \param recordfile Filename to save the recording 00304 * \param maxtime_sec Longest possible message length in seconds 00305 * \param fmt string containing all formats to be recorded delimited by '|' 00306 * \param duration pointer to integer for storing length of the recording 00307 * \param sound_duration pointer to integer for storing length of the recording minus all silence 00308 * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default 00309 * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default 00310 * \param path Optional filesystem path to unlock 00311 * 00312 * \retval -1 failure or hangup 00313 * \retval 'S' Recording ended from silence timeout 00314 * \retval 't' Recording ended from the message exceeding the maximum duration 00315 * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept. 00316 */ 00317 int ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int *sound_duration, int silencethreshold, int maxsilence_ms, const char *path); 00318 00319 /*! 00320 * \brief Record a file based on input frm a channel. Recording is performed in 'prepend' mode which works a little differently from normal recordings 00321 * This function will not play a success message due to post-recording control in the application this was added for. 00322 * 00323 * \param chan the channel being recorded 00324 * \param playfile Filename of sound to play before recording begins 00325 * \param recordfile Filename to save the recording 00326 * \param maxtime_sec Longest possible message length in seconds 00327 * \param fmt string containing all formats to be recorded delimited by '|' 00328 * \param duration pointer to integer for storing length of the recording 00329 * \param sound_duration pointer to integer for storing length of the recording minus all silence 00330 * \param beep whether to play a beep to prompt the recording 00331 * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default 00332 * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default. 00333 * 00334 * \retval -1 failure or hangup 00335 * \retval 'S' Recording ended from silence timeout 00336 * \retval 't' Recording either exceeded maximum duration or the call was ended via DTMF 00337 */ 00338 int ast_play_and_prepend(struct ast_channel *chan, char *playfile, char *recordfile, int maxtime_sec, char *fmt, int *duration, int *sound_duration, int beep, int silencethreshold, int maxsilence_ms); 00339 00340 enum ast_getdata_result { 00341 AST_GETDATA_FAILED = -1, 00342 AST_GETDATA_COMPLETE = 0, 00343 AST_GETDATA_TIMEOUT = 1, 00344 AST_GETDATA_INTERRUPTED = 2, 00345 /*! indicates a user terminated empty string rather than an empty string resulting 00346 * from a timeout or other factors */ 00347 AST_GETDATA_EMPTY_END_TERMINATED = 3, 00348 }; 00349 00350 enum AST_LOCK_RESULT { 00351 AST_LOCK_SUCCESS = 0, 00352 AST_LOCK_TIMEOUT = -1, 00353 AST_LOCK_PATH_NOT_FOUND = -2, 00354 AST_LOCK_FAILURE = -3, 00355 }; 00356 00357 /*! \brief Type of locking to use in ast_lock_path / ast_unlock_path */ 00358 enum AST_LOCK_TYPE { 00359 AST_LOCK_TYPE_LOCKFILE = 0, 00360 AST_LOCK_TYPE_FLOCK = 1, 00361 }; 00362 00363 /*! 00364 * \brief Set the type of locks used by ast_lock_path() 00365 * \param type the locking type to use 00366 */ 00367 void ast_set_lock_type(enum AST_LOCK_TYPE type); 00368 00369 /*! 00370 * \brief Lock a filesystem path. 00371 * \param path the path to be locked 00372 * \return one of \ref AST_LOCK_RESULT values 00373 */ 00374 enum AST_LOCK_RESULT ast_lock_path(const char *path); 00375 00376 /*! \brief Unlock a path */ 00377 int ast_unlock_path(const char *path); 00378 00379 /*! \brief Read a file into asterisk*/ 00380 char *ast_read_textfile(const char *file); 00381 00382 struct ast_group_info; 00383 00384 /*! \brief Split a group string into group and category, returning a default category if none is provided. */ 00385 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max); 00386 00387 /*! \brief Set the group for a channel, splitting the provided data into group and category, if specified. */ 00388 int ast_app_group_set_channel(struct ast_channel *chan, const char *data); 00389 00390 /*! \brief Get the current channel count of the specified group and category. */ 00391 int ast_app_group_get_count(const char *group, const char *category); 00392 00393 /*! \brief Get the current channel count of all groups that match the specified pattern and category. */ 00394 int ast_app_group_match_get_count(const char *groupmatch, const char *category); 00395 00396 /*! \brief Discard all group counting for a channel */ 00397 int ast_app_group_discard(struct ast_channel *chan); 00398 00399 /*! \brief Update all group counting for a channel to a new one */ 00400 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan); 00401 00402 /*! \brief Write Lock the group count list */ 00403 int ast_app_group_list_wrlock(void); 00404 00405 /*! \brief Read Lock the group count list */ 00406 int ast_app_group_list_rdlock(void); 00407 00408 /*! \brief Get the head of the group count list */ 00409 struct ast_group_info *ast_app_group_list_head(void); 00410 00411 /*! \brief Unlock the group count list */ 00412 int ast_app_group_list_unlock(void); 00413 00414 /*! 00415 \brief Define an application argument 00416 \param name The name of the argument 00417 */ 00418 #define AST_APP_ARG(name) char *name 00419 00420 /*! 00421 \brief Declare a structure to hold an application's arguments. 00422 \param name The name of the structure 00423 \param arglist The list of arguments, defined using AST_APP_ARG 00424 00425 This macro declares a structure intended to be used in a call 00426 to ast_app_separate_args(). The structure includes all the 00427 arguments specified, plus an argv array that overlays them and an 00428 argc argument counter. The arguments must be declared using AST_APP_ARG, 00429 and they will all be character pointers (strings). 00430 00431 \note The structure is <b>not</b> initialized, as the call to 00432 ast_app_separate_args() will perform that function before parsing 00433 the arguments. 00434 */ 00435 #define AST_DECLARE_APP_ARGS(name, arglist) AST_DEFINE_APP_ARGS_TYPE(, arglist) name 00436 00437 /*! 00438 \brief Define a structure type to hold an application's arguments. 00439 \param type The name of the structure type 00440 \param arglist The list of arguments, defined using AST_APP_ARG 00441 00442 This macro defines a structure type intended to be used in a call 00443 to ast_app_separate_args(). The structure includes all the 00444 arguments specified, plus an argv array that overlays them and an 00445 argc argument counter. The arguments must be declared using AST_APP_ARG, 00446 and they will all be character pointers (strings). 00447 00448 \note This defines a structure type, but does not declare an instance 00449 of the structure. That must be done separately. 00450 */ 00451 #define AST_DEFINE_APP_ARGS_TYPE(type, arglist) \ 00452 struct type { \ 00453 unsigned int argc; \ 00454 char *argv[0]; \ 00455 arglist \ 00456 } 00457 00458 /*! 00459 \brief Performs the 'standard' argument separation process for an application. 00460 \param args An argument structure defined using AST_DECLARE_APP_ARGS 00461 \param parse A modifiable buffer containing the input to be parsed 00462 00463 This function will separate the input string using the standard argument 00464 separator character ',' and fill in the provided structure, including 00465 the argc argument counter field. 00466 */ 00467 #define AST_STANDARD_APP_ARGS(args, parse) \ 00468 args.argc = __ast_app_separate_args(parse, ',', 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0]))) 00469 #define AST_STANDARD_RAW_ARGS(args, parse) \ 00470 args.argc = __ast_app_separate_args(parse, ',', 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0]))) 00471 00472 /*! 00473 \brief Performs the 'nonstandard' argument separation process for an application. 00474 \param args An argument structure defined using AST_DECLARE_APP_ARGS 00475 \param parse A modifiable buffer containing the input to be parsed 00476 \param sep A nonstandard separator character 00477 00478 This function will separate the input string using the nonstandard argument 00479 separator character and fill in the provided structure, including 00480 the argc argument counter field. 00481 */ 00482 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \ 00483 args.argc = __ast_app_separate_args(parse, sep, 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0]))) 00484 #define AST_NONSTANDARD_RAW_ARGS(args, parse, sep) \ 00485 args.argc = __ast_app_separate_args(parse, sep, 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0]))) 00486 00487 /*! 00488 \brief Separate a string into arguments in an array 00489 \param buf The string to be parsed (this must be a writable copy, as it will be modified) 00490 \param delim The character to be used to delimit arguments 00491 \param remove_chars Remove backslashes and quote characters, while parsing 00492 \param array An array of 'char *' to be filled in with pointers to the found arguments 00493 \param arraylen The number of elements in the array (i.e. the number of arguments you will accept) 00494 00495 Note: if there are more arguments in the string than the array will hold, the last element of 00496 the array will contain the remaining arguments, not separated. 00497 00498 The array will be completely zeroed by this function before it populates any entries. 00499 00500 \return The number of arguments found, or zero if the function arguments are not valid. 00501 */ 00502 unsigned int __ast_app_separate_args(char *buf, char delim, int remove_chars, char **array, int arraylen); 00503 #define ast_app_separate_args(a,b,c,d) __ast_app_separate_args(a,b,1,c,d) 00504 00505 /*! 00506 \brief A structure to hold the description of an application 'option'. 00507 00508 Application 'options' are single-character flags that can be supplied 00509 to the application to affect its behavior; they can also optionally 00510 accept arguments enclosed in parenthesis. 00511 00512 These structures are used by the ast_app_parse_options function, uses 00513 this data to fill in a flags structure (to indicate which options were 00514 supplied) and array of argument pointers (for those options that had 00515 arguments supplied). 00516 */ 00517 struct ast_app_option { 00518 /*! \brief The flag bit that represents this option. */ 00519 uint64_t flag; 00520 /*! \brief The index of the entry in the arguments array 00521 that should be used for this option's argument. */ 00522 unsigned int arg_index; 00523 }; 00524 00525 #define BEGIN_OPTIONS { 00526 #define END_OPTIONS } 00527 00528 /*! 00529 \brief Declares an array of options for an application. 00530 \param holder The name of the array to be created 00531 \param options The actual options to be placed into the array 00532 \sa ast_app_parse_options 00533 00534 This macro declares a 'static const' array of \c struct \c ast_option 00535 elements to hold the list of available options for an application. 00536 Each option must be declared using either the AST_APP_OPTION() 00537 or AST_APP_OPTION_ARG() macros. 00538 00539 Example usage: 00540 \code 00541 enum my_app_option_flags { 00542 OPT_JUMP = (1 << 0), 00543 OPT_BLAH = (1 << 1), 00544 OPT_BLORT = (1 << 2), 00545 }; 00546 00547 enum my_app_option_args { 00548 OPT_ARG_BLAH = 0, 00549 OPT_ARG_BLORT, 00550 !! this entry tells how many possible arguments there are, 00551 and must be the last entry in the list 00552 OPT_ARG_ARRAY_SIZE, 00553 }; 00554 00555 AST_APP_OPTIONS(my_app_options, { 00556 AST_APP_OPTION('j', OPT_JUMP), 00557 AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH), 00558 AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT), 00559 }); 00560 00561 static int my_app_exec(struct ast_channel *chan, void *data) 00562 { 00563 char *options; 00564 struct ast_flags opts = { 0, }; 00565 char *opt_args[OPT_ARG_ARRAY_SIZE]; 00566 00567 ... do any argument parsing here ... 00568 00569 if (ast_app_parse_options(my_app_options, &opts, opt_args, options)) { 00570 return -1; 00571 } 00572 } 00573 \endcode 00574 */ 00575 #define AST_APP_OPTIONS(holder, options...) \ 00576 static const struct ast_app_option holder[128] = options 00577 00578 /*! 00579 \brief Declares an application option that does not accept an argument. 00580 \param option The single character representing the option 00581 \param flagno The flag index to be set if this option is present 00582 \sa AST_APP_OPTIONS, ast_app_parse_options 00583 */ 00584 #define AST_APP_OPTION(option, flagno) \ 00585 [option] = { .flag = flagno } 00586 00587 /*! 00588 \brief Declares an application option that accepts an argument. 00589 \param option The single character representing the option 00590 \param flagno The flag index to be set if this option is present 00591 \param argno The index into the argument array where the argument should 00592 be placed 00593 \sa AST_APP_OPTIONS, ast_app_parse_options 00594 */ 00595 #define AST_APP_OPTION_ARG(option, flagno, argno) \ 00596 [option] = { .flag = flagno, .arg_index = argno + 1 } 00597 00598 /*! 00599 \brief Parses a string containing application options and sets flags/arguments. 00600 \param options The array of possible options declared with AST_APP_OPTIONS 00601 \param flags The flag structure to have option flags set 00602 \param args The array of argument pointers to hold arguments found 00603 \param optstr The string containing the options to be parsed 00604 \return zero for success, non-zero if an error occurs 00605 \sa AST_APP_OPTIONS 00606 */ 00607 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr); 00608 00609 /*! 00610 \brief Parses a string containing application options and sets flags/arguments. 00611 \param options The array of possible options declared with AST_APP_OPTIONS 00612 \param flags The 64-bit flag structure to have option flags set 00613 \param args The array of argument pointers to hold arguments found 00614 \param optstr The string containing the options to be parsed 00615 \return zero for success, non-zero if an error occurs 00616 \sa AST_APP_OPTIONS 00617 */ 00618 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr); 00619 00620 /*! \brief Given a list of options array, return an option string based on passed flags 00621 \param options The array of possible options declared with AST_APP_OPTIONS 00622 \param flags The flags of the options that you wish to populate the buffer with 00623 \param buf The buffer to fill with the string of options 00624 \param len The maximum length of buf 00625 */ 00626 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len); 00627 00628 /*! \brief Present a dialtone and collect a certain length extension. 00629 \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension. 00630 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */ 00631 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout); 00632 00633 /*! \brief Allow to record message and have a review option */ 00634 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path); 00635 00636 /*!\brief Decode an encoded control or extended ASCII character 00637 * \param[in] stream String to decode 00638 * \param[out] result Decoded character 00639 * \param[out] consumed Number of characters used in stream to encode the character 00640 * \retval -1 Stream is of zero length 00641 * \retval 0 Success 00642 */ 00643 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed); 00644 00645 /*!\brief Decode a stream of encoded control or extended ASCII characters 00646 * \param[in] stream Encoded string 00647 * \param[out] result Decoded string 00648 * \param[in] result_len Maximum size of the result buffer 00649 * \return A pointer to the result string 00650 */ 00651 char *ast_get_encoded_str(const char *stream, char *result, size_t result_len); 00652 00653 /*! \brief Decode a stream of encoded control or extended ASCII characters */ 00654 int ast_str_get_encoded_str(struct ast_str **str, int maxlen, const char *stream); 00655 00656 /*! 00657 * \brief Common routine for child processes, to close all fds prior to exec(2) 00658 * \param[in] n starting file descriptor number for closing all higher file descriptors 00659 * \since 1.6.1 00660 */ 00661 void ast_close_fds_above_n(int n); 00662 00663 /*! 00664 * \brief Common routine to safely fork without a chance of a signal handler firing badly in the child 00665 * \param[in] stop_reaper flag to determine if sigchld handler is replaced or not 00666 * \since 1.6.1 00667 */ 00668 int ast_safe_fork(int stop_reaper); 00669 00670 /*! 00671 * \brief Common routine to cleanup after fork'ed process is complete (if reaping was stopped) 00672 * \since 1.6.1 00673 */ 00674 void ast_safe_fork_cleanup(void); 00675 00676 /*! 00677 * \brief Common routine to parse time lengths, with optional time unit specifier 00678 * \param[in] timestr String to parse 00679 * \param[in] defunit Default unit type 00680 * \param[out] result Resulting value, specified in milliseconds 00681 * \retval 0 Success 00682 * \retval -1 Failure 00683 * \since 1.8 00684 */ 00685 int ast_app_parse_timelen(const char *timestr, int *result, enum ast_timelen defunit); 00686 00687 #if defined(__cplusplus) || defined(c_plusplus) 00688 } 00689 #endif 00690 00691 #endif /* _ASTERISK_APP_H */