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