michaelh/zephyr
1
0
Fork 0
Code Releases Activity

shell: allow disabling VT100 commands

Browse source 
Allow the user to disable VT100 commands to have a plain shell
without terminal emulation in order to avoid a lot of garbage
ASCII characters in shell output.

Signed-off-by: Bartosz Bilas <b.bilas@grinn-global.com>
This commit is contained in:
Bartosz Bilas 2021-06-07 18:48:27 +02:00 • committed by Carles Cufí
commit 75a2ef8fc0
3 changed files with 21 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
subsys/shell/Kconfig
View file

@ -111,8 +111,15 @@ config SHELL_START_OBSCURED
If enabled, don't echo actual character, but echo * instead.
This is used for login prompts.
config SHELL_VT100_COMMANDS
bool "Enable VT100 commands in shell"
default y
help
Enables VT100 commands in shell (e.g. cursor position, clear screen etc.).
config SHELL_VT100_COLORS
bool "Enable colors in shell"
depends on SHELL_VT100_COMMANDS
default y if !SHELL_MINIMAL
help
If enabled VT100 colors are used in shell (e.g. print errors in red).
@ -181,6 +188,7 @@ config SHELL_CMDS
config SHELL_CMDS_RESIZE
bool "Enable resize command"
depends on SHELL_CMDS
depends on SHELL_VT100_COMMANDS
default y if !SHELL_MINIMAL
help
By default shell assumes width of a terminal screen set to 80

12
subsys/shell/shell_cmds.c
View file

@ -192,6 +192,7 @@ static int terminal_size_get(const struct shell *shell)
return ret_val;
}
#ifdef CONFIG_SHELL_VT100_COMMANDS
static int cmd_clear(const struct shell *shell, size_t argc, char **argv)
{
ARG_UNUSED(argv);
@ -201,6 +202,7 @@ static int cmd_clear(const struct shell *shell, size_t argc, char **argv)
return 0;
}
#endif
static int cmd_bacskpace_mode_backspace(const struct shell *shell, size_t argc,
char **argv)
@ -224,6 +226,7 @@ static int cmd_bacskpace_mode_delete(const struct shell *shell, size_t argc,
return 0;
}
#ifdef CONFIG_SHELL_VT100_COMMANDS
static int cmd_colors_off(const struct shell *shell, size_t argc, char **argv)
{
ARG_UNUSED(argc);
@ -243,6 +246,7 @@ static int cmd_colors_on(const struct shell *shell, size_t argc, char **argv)
return 0;
}
#endif
static int cmd_echo_off(const struct shell *shell, size_t argc, char **argv)
{
@ -391,11 +395,13 @@ static int cmd_select(const struct shell *shell, size_t argc, char **argv)
return -EINVAL;
}
#ifdef CONFIG_SHELL_VT100_COMMANDS
SHELL_STATIC_SUBCMD_SET_CREATE(m_sub_colors,
SHELL_CMD_ARG(off, NULL, SHELL_HELP_COLORS_OFF, cmd_colors_off, 1, 0),
SHELL_CMD_ARG(on, NULL, SHELL_HELP_COLORS_ON, cmd_colors_on, 1, 0),
SHELL_SUBCMD_SET_END
);
#endif
SHELL_STATIC_SUBCMD_SET_CREATE(m_sub_echo,
SHELL_CMD_ARG(off, NULL, SHELL_HELP_ECHO_OFF, cmd_echo_off, 1, 0),
@ -422,7 +428,8 @@ SHELL_STATIC_SUBCMD_SET_CREATE(m_sub_backspace_mode,
SHELL_STATIC_SUBCMD_SET_CREATE(m_sub_shell,
SHELL_CMD(backspace_mode, &m_sub_backspace_mode,
SHELL_HELP_BACKSPACE_MODE, NULL),
SHELL_CMD(colors, &m_sub_colors, SHELL_HELP_COLORS, NULL),
SHELL_COND_CMD(CONFIG_SHELL_VT100_COMMANDS, colors, &m_sub_colors,
SHELL_HELP_COLORS, NULL),
SHELL_CMD_ARG(echo, &m_sub_echo, SHELL_HELP_ECHO, cmd_echo, 1, 1),
SHELL_COND_CMD(CONFIG_SHELL_STATS, stats, &m_sub_shell_stats,
SHELL_HELP_STATISTICS, NULL),
@ -435,7 +442,8 @@ SHELL_STATIC_SUBCMD_SET_CREATE(m_sub_resize,
SHELL_SUBCMD_SET_END
);
SHELL_CMD_ARG_REGISTER(clear, NULL, SHELL_HELP_CLEAR, cmd_clear, 1, 0);
SHELL_COND_CMD_ARG_REGISTER(CONFIG_SHELL_VT100_COMMANDS, clear, NULL,
SHELL_HELP_CLEAR, cmd_clear, 1, 0);
SHELL_CMD_REGISTER(shell, &m_sub_shell, SHELL_HELP_SHELL, NULL);
SHELL_COND_CMD_ARG_REGISTER(CONFIG_SHELL_HISTORY, history, NULL,
SHELL_HELP_HISTORY, cmd_history, 1, 0);

3
subsys/shell/shell_ops.h
View file

@ -28,6 +28,9 @@ static inline void z_shell_raw_fprintf(const struct shell_fprintf *const ctx,
/* Macro to send VT100 commands. */
#define Z_SHELL_VT100_CMD(_shell_, _cmd_) \
do { \
if (!IS_ENABLED(CONFIG_SHELL_VT100_COMMANDS)) \
break; \
\
static const char cmd[] = _cmd_; \
z_shell_raw_fprintf(_shell_->fprintf_ctx, "%s", cmd); \
} while (0)