michaelh/zephyr
1
0
Fork 0
Code Releases Activity

shell: Add support for custom line2argv callback

Browse source 
This allows to define shells which are using different syntax for
commands parsing eg. foocmd=param1,param2.

This is usefull for providing compatibility with existing external
tools while allowing to use Zephyr's shell subsystem.

Signed-off-by: Szymon Janc <szymon.janc@codecoup.pl>
This commit is contained in:
Szymon Janc 2018-09-03 16:02:42 +02:00 • committed by Carles Cufí
commit 9d3237c89e
2 changed files with 27 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

24
include/shell/shell.h
View file

@ -38,10 +38,21 @@ struct shell_cmd {
*/ */
typedef const char *(*shell_prompt_function_t)(void); typedef const char *(*shell_prompt_function_t)(void);
/** @brief Callback for custom line2argv parsing
*
* If this callback is set, command parsing for specified module works only
* if it is selected as default module. This is to not break other modules.
*
* @returns Current prompt string.
*/
typedef size_t (*shell_line2argv_function_t)(char *str, char *argv[],
size_t size);
struct shell_module { struct shell_module {
const char *module_name; const char *module_name;
const struct shell_cmd *commands; const struct shell_cmd *commands;
shell_prompt_function_t prompt; shell_prompt_function_t prompt;
shell_line2argv_function_t line2argv;
}; };
/** @typedef shell_mcumgr_function_t /** @typedef shell_mcumgr_function_t
@ -109,15 +120,24 @@ typedef int (*shell_mcumgr_function_t)(const char *line, void *arg);
*/ */
#ifdef CONFIG_CONSOLE_SHELL #ifdef CONFIG_CONSOLE_SHELL
#define SHELL_REGISTER(_name, _commands) \ #define SHELL_REGISTER(_name, _commands) \
SHELL_REGISTER_WITH_PROMPT(_name, _commands, NULL) SHELL_REGISTER_WITH_PROMPT_AND_LINE2ARGV(_name, _commands, NULL, NULL)
#define SHELL_REGISTER_WITH_PROMPT(_name, _commands, _prompt) \ #define SHELL_REGISTER_WITH_PROMPT(_name, _commands, _prompt) \
SHELL_REGISTER_WITH_PROMPT_AND_LINE2ARGV(_name, _commands, _prompt, NULL)
#define SHELL_REGISTER_WITH_LINE2ARGV(_name, _commands, _line2argv) \
SHELL_REGISTER_WITH_PROMPT_AND_LINE2ARGV(_name, _commands, NULL, \
_line2argv)
#define SHELL_REGISTER_WITH_PROMPT_AND_LINE2ARGV(_name, _commands, _prompt, \
_line2argv) \
\ \
static struct shell_module (__shell__name) __used \ static struct shell_module (__shell__name) __used \
__attribute__((__section__(".shell_module_"))) = { \ __attribute__((__section__(".shell_module_"))) = { \
.module_name = _name, \ .module_name = _name, \
.commands = _commands, \ .commands = _commands, \
.prompt = _prompt \ .prompt = _prompt, \
.line2argv = _line2argv, \
} }
#define SHELL_REGISTER_COMMAND(name, callback, _help) \ #define SHELL_REGISTER_COMMAND(name, callback, _help) \

4
subsys/shell/shell.c
View file

@ -371,7 +371,11 @@ int shell_exec(char *line)
const struct shell_cmd *cmd; const struct shell_cmd *cmd;
int argc, err; int argc, err;
if (default_module && default_module->line2argv) {
argc = default_module->line2argv(line, argv, ARRAY_SIZE(argv));
} else {
argc = line2argv(line, argv, ARRAY_SIZE(argv)); argc = line2argv(line, argv, ARRAY_SIZE(argv));
}
if (!argc) { if (!argc) {
return -EINVAL; return -EINVAL;
} }