Updating app_skel.c to follow coding guidelines
[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 static char *app = "Skel";
48 static char *synopsis = 
49 "Skeleton application.";
50 static char *descrip = "This application is a template to build other applications from.\n"
51  " It shows you the basic structure to create your own Asterisk applications.\n";
52
53 enum {
54         OPTION_A = (1 << 0),
55         OPTION_B = (1 << 1),
56         OPTION_C = (1 << 2),
57 } option_flags;
58
59 enum {
60         OPTION_ARG_B = 0,
61         OPTION_ARG_C = 1,
62         /* This *must* be the last value in this enum! */
63         OPTION_ARG_ARRAY_SIZE = 2,
64 } option_args;
65
66 AST_APP_OPTIONS(app_opts,{
67         AST_APP_OPTION('a', OPTION_A),
68         AST_APP_OPTION_ARG('b', OPTION_B, OPTION_ARG_B),
69         AST_APP_OPTION_ARG('c', OPTION_C, OPTION_ARG_C),
70 });
71
72
73 static int app_exec(struct ast_channel *chan, void *data)
74 {
75         int res = 0;
76         struct ast_flags flags;
77         char *parse, *opts[OPTION_ARG_ARRAY_SIZE];
78         AST_DECLARE_APP_ARGS(args,
79                 AST_APP_ARG(dummy);
80                 AST_APP_ARG(options);
81         );
82
83         if (ast_strlen_zero(data)) {
84                 ast_log(LOG_WARNING, "%s requires an argument (dummy[,options])\n", app);
85                 return -1;
86         }
87
88         /* Do our thing here */
89
90         /* We need to make a copy of the input string if we are going to modify it! */
91         parse = ast_strdupa(data);
92
93         AST_STANDARD_APP_ARGS(args, parse);
94
95         if (args.argc == 2) {
96                 ast_app_parse_options(app_opts, &flags, opts, args.options);
97         }
98
99         if (!ast_strlen_zero(args.dummy)) {
100                 ast_log(LOG_NOTICE, "Dummy value is : %s\n", args.dummy);
101         }
102
103         if (ast_test_flag(&flags, OPTION_A)) {
104                 ast_log(LOG_NOTICE, "Option A is set\n");
105         }
106
107         if (ast_test_flag(&flags, OPTION_B)) {
108                 ast_log(LOG_NOTICE, "Option B is set with : %s\n", opts[OPTION_ARG_B] ? opts[OPTION_ARG_B] : "<unspecified>");
109         }
110
111         if (ast_test_flag(&flags, OPTION_C)) {
112                 ast_log(LOG_NOTICE, "Option C is set with : %s\n", opts[OPTION_ARG_C] ? opts[OPTION_ARG_C] : "<unspecified>");
113         }
114
115         return res;
116 }
117
118 static int unload_module(void)
119 {
120         return ast_unregister_application(app);
121 }
122
123 static int load_module(void)
124 {
125         return ast_register_application(app, app_exec, synopsis, descrip) ? 
126                 AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
127 }
128
129 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Skeleton (sample) Application");