c58d451e406df62eb7df802e60e1c0df1e104b71
[asterisk/asterisk.git] / apps / app_skel.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) <Year>, <Your Name Here>
5  *
6  * <Your Name Here> <<Your Email Here>>
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  * Please follow coding guidelines 
19  * http://svn.digium.com/view/asterisk/trunk/doc/CODING-GUIDELINES
20  */
21
22 /*! \file
23  *
24  * \brief Skeleton application
25  *
26  * \author\verbatim <Your Name Here> <<Your Email Here>> \endverbatim
27  * 
28  * This is a skeleton for development of an Asterisk application 
29  * \ingroup applications
30  */
31
32 /*** MODULEINFO
33         <defaultenabled>no</defaultenabled>
34  ***/
35
36 #include "asterisk.h"
37
38 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
39
40 #include "asterisk/file.h"
41 #include "asterisk/channel.h"
42 #include "asterisk/pbx.h"
43 #include "asterisk/module.h"
44 #include "asterisk/lock.h"
45 #include "asterisk/app.h"
46
47 /*** DOCUMENTATION
48         <application name="Skel" language="en_US">
49                 <synopsis>
50                         Simple one line explaination.
51                 </synopsis>
52                 <syntax>
53                         <parameter name="dummy" required="true"/>
54                         <parameter name="options">
55                                 <optionlist>
56                                         <option name="a">
57                                                 <para>Option A.</para>
58                                         </option>
59                                         <option name="b">
60                                                 <para>Option B.</para>
61                                         </option>
62                                         <option name="c">
63                                                 <para>Option C.</para>
64                                         </option>
65                                 </optionlist>
66                         </parameter>
67                 </syntax>
68                 <description>
69                 <para>This application is a template to build other applications from. 
70                 It shows you the basic structure to create your own Asterisk applications.</para>
71                 </description>
72         </application>
73  ***/
74
75 static char *app = "Skel";
76
77 enum option_flags {
78         OPTION_A = (1 << 0),
79         OPTION_B = (1 << 1),
80         OPTION_C = (1 << 2),
81 };
82
83 enum option_args {
84         OPTION_ARG_B = 0,
85         OPTION_ARG_C = 1,
86         /* This *must* be the last value in this enum! */
87         OPTION_ARG_ARRAY_SIZE = 2,
88 };
89
90 AST_APP_OPTIONS(app_opts,{
91         AST_APP_OPTION('a', OPTION_A),
92         AST_APP_OPTION_ARG('b', OPTION_B, OPTION_ARG_B),
93         AST_APP_OPTION_ARG('c', OPTION_C, OPTION_ARG_C),
94 });
95
96
97 static int app_exec(struct ast_channel *chan, const char *data)
98 {
99         int res = 0;
100         struct ast_flags flags;
101         char *parse, *opts[OPTION_ARG_ARRAY_SIZE];
102         AST_DECLARE_APP_ARGS(args,
103                 AST_APP_ARG(dummy);
104                 AST_APP_ARG(options);
105         );
106
107         if (ast_strlen_zero(data)) {
108                 ast_log(LOG_WARNING, "%s requires an argument (dummy[,options])\n", app);
109                 return -1;
110         }
111
112         /* Do our thing here */
113
114         /* We need to make a copy of the input string if we are going to modify it! */
115         parse = ast_strdupa(data);
116
117         AST_STANDARD_APP_ARGS(args, parse);
118
119         if (args.argc == 2) {
120                 ast_app_parse_options(app_opts, &flags, opts, args.options);
121         }
122
123         if (!ast_strlen_zero(args.dummy)) {
124                 ast_log(LOG_NOTICE, "Dummy value is : %s\n", args.dummy);
125         }
126
127         if (ast_test_flag(&flags, OPTION_A)) {
128                 ast_log(LOG_NOTICE, "Option A is set\n");
129         }
130
131         if (ast_test_flag(&flags, OPTION_B)) {
132                 ast_log(LOG_NOTICE, "Option B is set with : %s\n", opts[OPTION_ARG_B] ? opts[OPTION_ARG_B] : "<unspecified>");
133         }
134
135         if (ast_test_flag(&flags, OPTION_C)) {
136                 ast_log(LOG_NOTICE, "Option C is set with : %s\n", opts[OPTION_ARG_C] ? opts[OPTION_ARG_C] : "<unspecified>");
137         }
138
139         return res;
140 }
141
142 static int unload_module(void)
143 {
144         return ast_unregister_application(app);
145 }
146
147 static int load_module(void)
148 {
149         return ast_register_application_xml(app, app_exec) ? 
150                 AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
151 }
152
153 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Skeleton (sample) Application");