Updating skel application to use current parsing constructs
[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 <Your Name Here> <<Your Email Here>>
24  * 
25  * This is a skeleton for development of an Asterisk application 
26  * \ingroup applications
27  */
28
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <unistd.h>
32 #include <string.h>
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include "asterisk/file.h"
39 #include "asterisk/logger.h"
40 #include "asterisk/channel.h"
41 #include "asterisk/pbx.h"
42 #include "asterisk/module.h"
43 #include "asterisk/lock.h"
44 #include "asterisk/app.h"
45
46 static char *tdesc = "Trivial skeleton Application";
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 LOCAL_USER_DECL;
73
74 static int app_exec(struct ast_channel *chan, void *data)
75 {
76         int res = 0;
77         struct ast_flags flags;
78         struct localuser *u;
79         char *parse, *opts[OPTION_ARG_ARRAY_SIZE];
80         AST_DECLARE_APP_ARGS(args,
81                 AST_APP_ARG(dummy);
82                 AST_APP_ARG(options);
83         );
84
85         if (ast_strlen_zero(data)) {
86                 ast_log(LOG_WARNING, "%s requires an argument (dummy|[options])\n", app);
87                 return -1;
88         }
89
90         LOCAL_USER_ADD(u);
91
92         /* Do our thing here */
93
94         /* We need to make a copy of the input string if we are going to modify it! */
95         if (!(parse = ast_strdupa(data))) {
96                 LOCAL_USER_REMOVE(u);
97                 return -1;
98         }
99
100         AST_STANDARD_APP_ARGS(args, parse);
101
102         if (args.argc == 2)
103                 ast_app_parse_options(app_opts, &flags, opts, args.options);
104
105         if (!ast_strlen_zero(args.dummy)) 
106                 ast_log(LOG_NOTICE, "Dummy value is : %s\n", args.dummy);
107
108         if (ast_test_flag(&flags, OPTION_A))
109                 ast_log(LOG_NOTICE, "Option A is set\n");
110
111         if (ast_test_flag(&flags, OPTION_B))
112                 ast_log(LOG_NOTICE, "Option B is set with : %s\n", opts[OPTION_ARG_B] ? opts[OPTION_ARG_B] : "<unspecified>");
113
114         if (ast_test_flag(&flags, OPTION_C))
115                 ast_log(LOG_NOTICE, "Option C is set with : %s\n", opts[OPTION_ARG_C] ? opts[OPTION_ARG_C] : "<unspecified>");
116
117         LOCAL_USER_REMOVE(u);
118
119         return res;
120 }
121
122 int unload_module(void)
123 {
124         int res;
125
126         res = ast_unregister_application(app);
127
128         STANDARD_HANGUP_LOCALUSERS;
129
130         return res;     
131 }
132
133 int load_module(void)
134 {
135         return ast_register_application(app, app_exec, synopsis, descrip);
136 }
137
138 int reload(void)
139 {
140         /* This function will be called if a 'reload' is requested */
141
142         return 0;
143 }
144
145 char *description(void)
146 {
147         return tdesc;
148 }
149
150 int usecount(void)
151 {
152         int res;
153
154         STANDARD_USECOUNT(res);
155
156         return res;
157 }
158
159 char *key()
160 {
161         return ASTERISK_GPL_KEY;
162 }