e6b2e9a750
This patch adds 'const' tags to a number of Asterisk APIs where they are appropriate (where the API already demanded that the function argument not be modified, but the compiler was not informed of that fact). The list includes: - CLI command handlers - CLI command handler arguments - AGI command handlers - AGI command handler arguments - Dialplan application handler arguments - Speech engine API function arguments In addition, various file-scope and function-scope constant arrays got 'const' and/or 'static' qualifiers where they were missing. Review: https://reviewboard.asterisk.org/r/251/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@196072 65c4cc65-6c06-0410-ace0-fbb531ad65f3
154 lines
3.6 KiB
C
154 lines
3.6 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) <Year>, <Your Name Here>
|
|
*
|
|
* <Your Name Here> <<Your Email Here>>
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*
|
|
* Please follow coding guidelines
|
|
* http://svn.digium.com/view/asterisk/trunk/doc/CODING-GUIDELINES
|
|
*/
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Skeleton application
|
|
*
|
|
* \author\verbatim <Your Name Here> <<Your Email Here>> \endverbatim
|
|
*
|
|
* This is a skeleton for development of an Asterisk application
|
|
* \ingroup applications
|
|
*/
|
|
|
|
/*** MODULEINFO
|
|
<defaultenabled>no</defaultenabled>
|
|
***/
|
|
|
|
#include "asterisk.h"
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
#include "asterisk/file.h"
|
|
#include "asterisk/channel.h"
|
|
#include "asterisk/pbx.h"
|
|
#include "asterisk/module.h"
|
|
#include "asterisk/lock.h"
|
|
#include "asterisk/app.h"
|
|
|
|
/*** DOCUMENTATION
|
|
<application name="Skel" language="en_US">
|
|
<synopsis>
|
|
Simple one line explaination.
|
|
</synopsis>
|
|
<syntax>
|
|
<parameter name="dummy" required="true"/>
|
|
<parameter name="options">
|
|
<optionlist>
|
|
<option name="a">
|
|
<para>Option A.</para>
|
|
</option>
|
|
<option name="b">
|
|
<para>Option B.</para>
|
|
</option>
|
|
<option name="c">
|
|
<para>Option C.</para>
|
|
</option>
|
|
</optionlist>
|
|
</parameter>
|
|
</syntax>
|
|
<description>
|
|
<para>This application is a template to build other applications from.
|
|
It shows you the basic structure to create your own Asterisk applications.</para>
|
|
</description>
|
|
</application>
|
|
***/
|
|
|
|
static char *app = "Skel";
|
|
|
|
enum {
|
|
OPTION_A = (1 << 0),
|
|
OPTION_B = (1 << 1),
|
|
OPTION_C = (1 << 2),
|
|
} option_flags;
|
|
|
|
enum {
|
|
OPTION_ARG_B = 0,
|
|
OPTION_ARG_C = 1,
|
|
/* This *must* be the last value in this enum! */
|
|
OPTION_ARG_ARRAY_SIZE = 2,
|
|
} option_args;
|
|
|
|
AST_APP_OPTIONS(app_opts,{
|
|
AST_APP_OPTION('a', OPTION_A),
|
|
AST_APP_OPTION_ARG('b', OPTION_B, OPTION_ARG_B),
|
|
AST_APP_OPTION_ARG('c', OPTION_C, OPTION_ARG_C),
|
|
});
|
|
|
|
|
|
static int app_exec(struct ast_channel *chan, const char *data)
|
|
{
|
|
int res = 0;
|
|
struct ast_flags flags;
|
|
char *parse, *opts[OPTION_ARG_ARRAY_SIZE];
|
|
AST_DECLARE_APP_ARGS(args,
|
|
AST_APP_ARG(dummy);
|
|
AST_APP_ARG(options);
|
|
);
|
|
|
|
if (ast_strlen_zero(data)) {
|
|
ast_log(LOG_WARNING, "%s requires an argument (dummy[,options])\n", app);
|
|
return -1;
|
|
}
|
|
|
|
/* Do our thing here */
|
|
|
|
/* We need to make a copy of the input string if we are going to modify it! */
|
|
parse = ast_strdupa(data);
|
|
|
|
AST_STANDARD_APP_ARGS(args, parse);
|
|
|
|
if (args.argc == 2) {
|
|
ast_app_parse_options(app_opts, &flags, opts, args.options);
|
|
}
|
|
|
|
if (!ast_strlen_zero(args.dummy)) {
|
|
ast_log(LOG_NOTICE, "Dummy value is : %s\n", args.dummy);
|
|
}
|
|
|
|
if (ast_test_flag(&flags, OPTION_A)) {
|
|
ast_log(LOG_NOTICE, "Option A is set\n");
|
|
}
|
|
|
|
if (ast_test_flag(&flags, OPTION_B)) {
|
|
ast_log(LOG_NOTICE, "Option B is set with : %s\n", opts[OPTION_ARG_B] ? opts[OPTION_ARG_B] : "<unspecified>");
|
|
}
|
|
|
|
if (ast_test_flag(&flags, OPTION_C)) {
|
|
ast_log(LOG_NOTICE, "Option C is set with : %s\n", opts[OPTION_ARG_C] ? opts[OPTION_ARG_C] : "<unspecified>");
|
|
}
|
|
|
|
return res;
|
|
}
|
|
|
|
static int unload_module(void)
|
|
{
|
|
return ast_unregister_application(app);
|
|
}
|
|
|
|
static int load_module(void)
|
|
{
|
|
return ast_register_application_xml(app, app_exec) ?
|
|
AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
|
|
}
|
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Skeleton (sample) Application");
|