mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
a6ca535955
Currently when the shell receives EOF on `native`, sending EOF
(ctrl + D) closes the stdin file descriptor, leading to all
consecutive reads to also return EOF.
The result is that `shell_run_forever()` will re-start the shell
forever in a loop, filling up the terminal with
> > > > > > > > > > > > > > > > > > > > > > …
until the user hits ctrl + C.
This is annoying.
Instead, cleanly shutdown RIOT when receiving EOF on native, which
should match the expected behaviour of most users.
131 lines
3.9 KiB
C
131 lines
3.9 KiB
C
/*
|
|
* Copyright (C) 2009-2013 Freie Universität Berlin
|
|
*
|
|
* This file is subject to the terms and conditions of the GNU Lesser
|
|
* General Public License v2.1. See the file LICENSE in the top level
|
|
* directory for more details.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup sys_shell Shell
|
|
* @ingroup sys
|
|
* @brief Simple shell interpreter
|
|
*
|
|
* @{
|
|
*
|
|
* @file
|
|
* @brief Shell interface definition
|
|
*/
|
|
|
|
#ifndef SHELL_H
|
|
#define SHELL_H
|
|
|
|
#include <stdint.h>
|
|
#include "periph/pm.h"
|
|
|
|
#include "kernel_defines.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Shutdown RIOT on shell exit
|
|
*/
|
|
#ifndef CONFIG_SHELL_SHUTDOWN_ON_EXIT
|
|
/* Some systems (e.g Ubuntu 20.04) close stdin on CTRL-D / EOF
|
|
* That means we can't just re-start the shell.
|
|
* Instead terminate RIOT, which is also the behavior a user would
|
|
* expect from a CLI application.
|
|
*/
|
|
# ifdef CPU_NATIVE
|
|
# define CONFIG_SHELL_SHUTDOWN_ON_EXIT 1
|
|
# endif
|
|
#endif
|
|
|
|
/**
|
|
* @brief Default shell buffer size (maximum line length shell can handle)
|
|
*/
|
|
#define SHELL_DEFAULT_BUFSIZE (128)
|
|
|
|
/**
|
|
* @brief Protype of a shell callback handler.
|
|
* @details 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.
|
|
* @param[in] argc Number of arguments supplied to the function invocation.
|
|
* @param[in] argv The supplied argument list.
|
|
*
|
|
* @return 0 on success
|
|
* @return Anything else on failure
|
|
*/
|
|
typedef int (*shell_command_handler_t)(int argc, char **argv);
|
|
|
|
/**
|
|
* @brief A single command in the list of the supported commands.
|
|
* @details The list of commands is NULL terminated,
|
|
* i.e. the last element must be ``{ NULL, NULL, NULL }``.
|
|
*/
|
|
typedef struct shell_command_t {
|
|
const char *name; /**< Name of the function */
|
|
const char *desc; /**< Description to print in the "help" command. */
|
|
shell_command_handler_t handler; /**< The callback function. */
|
|
} shell_command_t;
|
|
|
|
/**
|
|
* @brief Start a shell and exit once EOF is reached.
|
|
*
|
|
* @param[in] commands ptr to array of command structs
|
|
* @param[in] line_buf Buffer that will be used for reading a line
|
|
* @param[in] len nr of bytes that fit in line_buf
|
|
*/
|
|
void shell_run_once(const shell_command_t *commands, char *line_buf, int len);
|
|
|
|
/**
|
|
* @brief 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.
|
|
*
|
|
* @param[in] commands ptr to array of command structs
|
|
* @param[in] line_buf Buffer that will be used for reading a line
|
|
* @param[in] len nr of bytes that fit in line_buf
|
|
*/
|
|
static inline void shell_run_forever(const shell_command_t *commands,
|
|
char *line_buf, int len)
|
|
{
|
|
while (1) {
|
|
shell_run_once(commands, line_buf, len);
|
|
|
|
if (IS_ACTIVE(CONFIG_SHELL_SHUTDOWN_ON_EXIT)) {
|
|
pm_off();
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @brief Back-porting alias for @ref shell_run_forever
|
|
*
|
|
* @param[in] commands ptr to array of command structs
|
|
* @param[in] line_buf Buffer that will be used for reading a line
|
|
* @param[in] len nr of bytes that fit in line_buf
|
|
*/
|
|
static inline void shell_run(const shell_command_t *commands,
|
|
char *line_buf, int len)
|
|
{
|
|
shell_run_forever(commands, line_buf, len);
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* SHELL_H */
|
|
/** @} */
|