Start untangling header inclusion in a way that does not affect
[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
19 /*! \file
20  *
21  * \brief Skeleton application
22  *
23  * \author\verbatim <Your Name Here> <<Your Email Here>> \endverbatim
24  * 
25  * This is a skeleton for development of an Asterisk application 
26  * \ingroup applications
27  */
28
29 /*** MODULEINFO
30         <defaultenabled>no</defaultenabled>
31  ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36
37 #include "asterisk/file.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/module.h"
42 #include "asterisk/lock.h"
43 #include "asterisk/app.h"
44
45 static char *app = "Skel";
46 static char *synopsis = 
47 "Skeleton application.";
48 static char *descrip = "This application is a template to build other applications from.\n"
49  " It shows you the basic structure to create your own Asterisk applications.\n";
50
51 enum {
52         OPTION_A = (1 << 0),
53         OPTION_B = (1 << 1),
54         OPTION_C = (1 << 2),
55 } option_flags;
56
57 enum {
58         OPTION_ARG_B = 0,
59         OPTION_ARG_C = 1,
60         /* This *must* be the last value in this enum! */
61         OPTION_ARG_ARRAY_SIZE = 2,
62 } option_args;
63
64 AST_APP_OPTIONS(app_opts,{
65         AST_APP_OPTION('a', OPTION_A),
66         AST_APP_OPTION_ARG('b', OPTION_B, OPTION_ARG_B),
67         AST_APP_OPTION_ARG('c', OPTION_C, OPTION_ARG_C),
68 });
69
70
71 static int app_exec(struct ast_channel *chan, void *data)
72 {
73         int res = 0;
74         struct ast_flags flags;
75         char *parse, *opts[OPTION_ARG_ARRAY_SIZE];
76         AST_DECLARE_APP_ARGS(args,
77                 AST_APP_ARG(dummy);
78                 AST_APP_ARG(options);
79         );
80
81         if (ast_strlen_zero(data)) {
82                 ast_log(LOG_WARNING, "%s requires an argument (dummy[,options])\n", app);
83                 return -1;
84         }
85
86         /* Do our thing here */
87
88         /* We need to make a copy of the input string if we are going to modify it! */
89         parse = ast_strdupa(data);
90
91         AST_STANDARD_APP_ARGS(args, parse);
92
93         if (args.argc == 2)
94                 ast_app_parse_options(app_opts, &flags, opts, args.options);
95
96         if (!ast_strlen_zero(args.dummy)) 
97                 ast_log(LOG_NOTICE, "Dummy value is : %s\n", args.dummy);
98
99         if (ast_test_flag(&flags, OPTION_A))
100                 ast_log(LOG_NOTICE, "Option A is set\n");
101
102         if (ast_test_flag(&flags, OPTION_B))
103                 ast_log(LOG_NOTICE, "Option B is set with : %s\n", opts[OPTION_ARG_B] ? opts[OPTION_ARG_B] : "<unspecified>");
104
105         if (ast_test_flag(&flags, OPTION_C))
106                 ast_log(LOG_NOTICE, "Option C is set with : %s\n", opts[OPTION_ARG_C] ? opts[OPTION_ARG_C] : "<unspecified>");
107
108         return res;
109 }
110
111 static int unload_module(void)
112 {
113         int res;
114         res = ast_unregister_application(app);
115         return res;     
116 }
117
118 static int load_module(void)
119 {
120         if (ast_register_application(app, app_exec, synopsis, descrip))
121                 return AST_MODULE_LOAD_DECLINE;
122
123         return AST_MODULE_LOAD_SUCCESS;
124 }
125
126 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Skeleton (sample) Application");