f982b6a2df41e56c4052ec61579474f16f6f8be3
[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 #define OPTION_A        (1 << 0)        /* Option A */
54 #define OPTION_B        (1 << 1)        /* Option B(n) */
55 #define OPTION_C        (1 << 2)        /* Option C(str) */
56 #define OPTION_NULL     (1 << 3)        /* Dummy Termination */
57
58 AST_DECLARE_OPTIONS(app_opts,{
59         ['a'] = { OPTION_A },
60         ['b'] = { OPTION_B, 1 },
61         ['c'] = { OPTION_C, 2 }
62 });
63
64 LOCAL_USER_DECL;
65
66 static int app_exec(struct ast_channel *chan, void *data)
67 {
68         int res = 0;
69         struct ast_flags flags;
70         struct localuser *u;
71         char *options = NULL;
72         char *dummy = NULL;
73         char *args;
74         int argc = 0;
75         char *opts[2];
76         char *argv[2];
77
78         if (ast_strlen_zero(data)) {
79                 ast_log(LOG_WARNING, "%s requires an argument (dummy|[options])\n",app);
80                 return -1;
81         }
82
83         LOCAL_USER_ADD(u);
84
85         /* Do our thing here */
86
87         /* We need to make a copy of the input string if we are going to modify it! */
88         if (!(args = ast_strdupa(data))) {
89                 LOCAL_USER_REMOVE(u);
90                 return -1;
91         }
92         
93         if ((argc = ast_app_separate_args(args, '|', argv, sizeof(argv) / sizeof(argv[0])))) {
94                 dummy = argv[0];
95                 options = argv[1];
96                 ast_parseoptions(app_opts, &flags, opts, options);
97         }
98
99         if (!ast_strlen_zero(dummy)) 
100                 ast_log(LOG_NOTICE, "Dummy value is : %s\n", dummy);
101
102         if (ast_test_flag(&flags, OPTION_A))
103                 ast_log(LOG_NOTICE, "Option A is set\n");
104
105         if (ast_test_flag(&flags, OPTION_B))
106                 ast_log(LOG_NOTICE,"Option B is set with : %s\n", opts[0] ? opts[0] : "<unspecified>");
107
108         if (ast_test_flag(&flags, OPTION_C))
109                 ast_log(LOG_NOTICE,"Option C is set with : %s\n", opts[1] ? opts[1] : "<unspecified>");
110
111         LOCAL_USER_REMOVE(u);
112
113         return res;
114 }
115
116 int unload_module(void)
117 {
118         int res;
119
120         res = ast_unregister_application(app);
121
122         STANDARD_HANGUP_LOCALUSERS;
123
124         return res;     
125 }
126
127 int load_module(void)
128 {
129         return ast_register_application(app, app_exec, synopsis, descrip);
130 }
131
132 int reload(void)
133 {
134         /* This function will be called if a 'reload' is requested */
135
136         return 0;
137 }
138
139 char *description(void)
140 {
141         return tdesc;
142 }
143
144 int usecount(void)
145 {
146         int res;
147
148         STANDARD_USECOUNT(res);
149
150         return res;
151 }
152
153 char *key()
154 {
155         return ASTERISK_GPL_KEY;
156 }