Simple shell interpreter. More...
Simple shell interpreter.
Modules | |
Shell compile time configurations | |
Files | |
file | shell.h |
Shell interface definition. | |
Data Structures | |
struct | shell_command_t |
A single command in the list of the supported commands. More... | |
Macros | |
#define | SHELL_DEFAULT_BUFSIZE (128) |
Default shell buffer size (maximum line length shell can handle) | |
#define | SHELL_COMMAND(name, help, func) |
Define shell command. More... | |
Typedefs | |
typedef int(* | shell_command_handler_t) (int argc, char **argv) |
Protype of a shell callback handler. More... | |
typedef struct shell_command_t | shell_command_t |
A single command in the list of the supported commands. More... | |
Functions | |
void | shell_post_readline_hook (void) |
Optional hook after readline has triggered. More... | |
void | shell_pre_command_hook (int argc, char **argv) |
Optional hook before shell command is called. More... | |
void | shell_post_command_hook (int ret, int argc, char **argv) |
Optional hook after shell command is called. More... | |
void | shell_run_once (const shell_command_t *commands, char *line_buf, int len) |
Start a shell and exit once EOF is reached. More... | |
static void | shell_run_forever (const shell_command_t *commands, char *line_buf, int len) |
Start a shell and restart it if it exits. More... | |
static void | shell_run (const shell_command_t *commands, char *line_buf, int len) |
Back-porting alias for shell_run_forever. More... | |
#define SHELL_COMMAND | ( | name, | |
help, | |||
func | |||
) |
Define shell command.
This macro is a helper for defining a shell command and adding it to the shell commands XFA (cross file array).
Shell commands added using this macros will be sorted after builtins and commands passed via parameter to shell_run_once()
. If a command with the same name exists in any of those, they will make a command added via this macro inaccassible.
Commands added with this macro will be sorted alphanumerically by name
.
Example:
typedef int(* shell_command_handler_t) (int argc, char **argv) |
Protype of a shell callback handler.
The functions supplied to shell_run() must use this signature. The argument list is terminated with a NULL, i.e argv[argc] == NULL`.
argv[0]`` is the function name.
Escape sequences are removed before the function is called.
The called function may edit argv
and the contained strings, but it must be taken care of not to leave the boundaries of the array. This functionality can be used by getopt() or a similar function.
[in] | argc | Number of arguments supplied to the function invocation. |
[in] | argv | The supplied argument list. |
typedef struct shell_command_t shell_command_t |
A single command in the list of the supported commands.
The list of commands is NULL terminated, i.e. the last element must be { NULL, NULL, NULL }
.
void shell_post_command_hook | ( | int | ret, |
int | argc, | ||
char ** | argv | ||
) |
Optional hook after shell command is called.
User implemented function gets called before a valid shell command will be called.
shell_hooks
module.[in] | ret | Return value of the shell command. |
[in] | argc | Number of arguments supplied to the function invocation. |
[in] | argv | The supplied argument list. |
void shell_post_readline_hook | ( | void | ) |
Optional hook after readline has triggered.
User implemented function gets called after the shell readline is complete.
shell_hooks
module. void shell_pre_command_hook | ( | int | argc, |
char ** | argv | ||
) |
Optional hook before shell command is called.
User implemented function gets called before a valid shell command will be called.
shell_hooks
module.[in] | argc | Number of arguments supplied to the function invocation. |
[in] | argv | The supplied argument list. |
|
inlinestatic |
Back-porting alias for shell_run_forever.
[in] | commands | ptr to array of command structs |
[in] | line_buf | Buffer that will be used for reading a line |
[in] | len | nr of bytes that fit in line_buf |
|
inlinestatic |
Start a shell and restart it if it exits.
If CONFIG_SHELL_SHUTDOWN_ON_EXIT
is set (e.g. on native) the shell will instead shut down RIOT once EOF is reached.
[in] | commands | ptr to array of command structs |
[in] | line_buf | Buffer that will be used for reading a line |
[in] | len | nr of bytes that fit in line_buf |
void shell_run_once | ( | const shell_command_t * | commands, |
char * | line_buf, | ||
int | len | ||
) |
Start a shell and exit once EOF is reached.
[in] | commands | ptr to array of command structs |
[in] | line_buf | Buffer that will be used for reading a line |
[in] | len | nr of bytes that fit in line_buf |