This rather large commit changes the way modules are loaded.
[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 *app = "Skel";
47 static char *synopsis = 
48 "Skeleton application.";
49 static char *descrip = "This application is a template to build other applications from.\n"
50  " It shows you the basic structure to create your own Asterisk applications.\n";
51
52 enum {
53         OPTION_A = (1 << 0),
54         OPTION_B = (1 << 1),
55         OPTION_C = (1 << 2),
56 } option_flags;
57
58 enum {
59         OPTION_ARG_B = 0,
60         OPTION_ARG_C = 1,
61         /* This *must* be the last value in this enum! */
62         OPTION_ARG_ARRAY_SIZE = 2,
63 } option_args;
64
65 AST_APP_OPTIONS(app_opts,{
66         AST_APP_OPTION('a', OPTION_A),
67         AST_APP_OPTION_ARG('b', OPTION_B, OPTION_ARG_B),
68         AST_APP_OPTION_ARG('c', OPTION_C, OPTION_ARG_C),
69 });
70
71 LOCAL_USER_DECL;
72
73 static int app_exec(struct ast_channel *chan, void *data)
74 {
75         int res = 0;
76         struct ast_flags flags;
77         struct localuser *u;
78         char *parse, *opts[OPTION_ARG_ARRAY_SIZE];
79         AST_DECLARE_APP_ARGS(args,
80                 AST_APP_ARG(dummy);
81                 AST_APP_ARG(options);
82         );
83
84         if (ast_strlen_zero(data)) {
85                 ast_log(LOG_WARNING, "%s requires an argument (dummy|[options])\n", app);
86                 return -1;
87         }
88
89         LOCAL_USER_ADD(u);
90
91         /* Do our thing here */
92
93         /* We need to make a copy of the input string if we are going to modify it! */
94         if (!(parse = ast_strdupa(data))) {
95                 LOCAL_USER_REMOVE(u);
96                 return -1;
97         }
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         LOCAL_USER_REMOVE(u);
117
118         return res;
119 }
120
121 static int unload_module(void *mod)
122 {
123         int res;
124         res = ast_unregister_application(app);
125         return res;     
126 }
127
128 static int load_module(void *mod)
129 {
130         return ast_register_application(app, app_exec, synopsis, descrip);
131 }
132
133 static const char *description(void)
134 {
135         return "Trivial skeleton Application";
136 }
137
138 static const char *key(void)
139 {
140         return ASTERISK_GPL_KEY;
141 }
142
143 STD_MOD1;