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