michaelh/zephyr
1
0
Fork 0
Code Releases Activity

shell: rename shell_xxx_impl wrapper functions to shell_fprintf_xxx

Browse source 
Since the `_impl` naming convention is intended for internal use only,
renaming these functions to the `shell_fprintf_xxx` variant is
more suitable for calls outside the module:
- `shell_info_impl` to `shell_fprintf_info`
- `shell_print_impl` to `shell_fprintf_normal`
- `shell_warn_impl` to `shell_fprintf_warn`
- `shell_error_impl` to `shell_fprintf_error`

Signed-off-by: Pisit Sawangvonganan <pisit@ndrsolution.com>
This commit is contained in:
Pisit Sawangvonganan 2024-08-18 00:22:58 +07:00 • committed by Anas Nashif
commit d207edb1cf
3 changed files with 31 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

16
include/zephyr/shell/shell.h
View file

@ -1093,8 +1093,8 @@ void shell_hexdump(const struct shell *sh, const uint8_t *data, size_t len);
* @param[in] ... List of parameters to print. * @param[in] ... List of parameters to print.
*/ */
#define shell_info(_sh, _ft, ...) \ #define shell_info(_sh, _ft, ...) \
shell_info_impl(_sh, _ft "\n", ##__VA_ARGS__) shell_fprintf_info(_sh, _ft "\n", ##__VA_ARGS__)
void __printf_like(2, 3) shell_info_impl(const struct shell *sh, const char *fmt, ...); void __printf_like(2, 3) shell_fprintf_info(const struct shell *sh, const char *fmt, ...);
/** /**
* @brief Print normal message to the shell. * @brief Print normal message to the shell.
@ -1106,8 +1106,8 @@ void __printf_like(2, 3) shell_info_impl(const struct shell *sh, const char *fmt
* @param[in] ... List of parameters to print. * @param[in] ... List of parameters to print.
*/ */
#define shell_print(_sh, _ft, ...) \ #define shell_print(_sh, _ft, ...) \
shell_print_impl(_sh, _ft "\n", ##__VA_ARGS__) shell_fprintf_normal(_sh, _ft "\n", ##__VA_ARGS__)
void __printf_like(2, 3) shell_print_impl(const struct shell *sh, const char *fmt, ...); void __printf_like(2, 3) shell_fprintf_normal(const struct shell *sh, const char *fmt, ...);
/** /**
* @brief Print warning message to the shell. * @brief Print warning message to the shell.
@ -1119,8 +1119,8 @@ void __printf_like(2, 3) shell_print_impl(const struct shell *sh, const char *fm
* @param[in] ... List of parameters to print. * @param[in] ... List of parameters to print.
*/ */
#define shell_warn(_sh, _ft, ...) \ #define shell_warn(_sh, _ft, ...) \
shell_warn_impl(_sh, _ft "\n", ##__VA_ARGS__) shell_fprintf_warn(_sh, _ft "\n", ##__VA_ARGS__)
void __printf_like(2, 3) shell_warn_impl(const struct shell *sh, const char *fmt, ...); void __printf_like(2, 3) shell_fprintf_warn(const struct shell *sh, const char *fmt, ...);
/** /**
* @brief Print error message to the shell. * @brief Print error message to the shell.
@ -1132,8 +1132,8 @@ void __printf_like(2, 3) shell_warn_impl(const struct shell *sh, const char *fmt
* @param[in] ... List of parameters to print. * @param[in] ... List of parameters to print.
*/ */
#define shell_error(_sh, _ft, ...) \ #define shell_error(_sh, _ft, ...) \
shell_error_impl(_sh, _ft "\n", ##__VA_ARGS__) shell_fprintf_error(_sh, _ft "\n", ##__VA_ARGS__)
void __printf_like(2, 3) shell_error_impl(const struct shell *sh, const char *fmt, ...); void __printf_like(2, 3) shell_fprintf_error(const struct shell *sh, const char *fmt, ...);
/** /**
* @brief Process function, which should be executed when data is ready in the * @brief Process function, which should be executed when data is ready in the

10
subsys/net/lib/shell/net_shell_private.h
View file

@ -11,7 +11,7 @@
#define PR(fmt, ...) \ #define PR(fmt, ...) \
do { \ do { \
if (sh) { \ if (sh) { \
shell_print_impl(sh, fmt, ##__VA_ARGS__); \ shell_fprintf_normal(sh, fmt, ##__VA_ARGS__); \
} else { \ } else { \
printk(fmt, ##__VA_ARGS__); \ printk(fmt, ##__VA_ARGS__); \
} \ } \
@ -20,7 +20,7 @@
#define PR_SHELL(sh, fmt, ...) \ #define PR_SHELL(sh, fmt, ...) \
do { \ do { \
if (sh) { \ if (sh) { \
shell_print_impl(sh, fmt, ##__VA_ARGS__); \ shell_fprintf_normal(sh, fmt, ##__VA_ARGS__); \
} else { \ } else { \
printk(fmt, ##__VA_ARGS__); \ printk(fmt, ##__VA_ARGS__); \
} \ } \
@ -29,7 +29,7 @@
#define PR_ERROR(fmt, ...) \ #define PR_ERROR(fmt, ...) \
do { \ do { \
if (sh) { \ if (sh) { \
shell_error_impl(sh, fmt, ##__VA_ARGS__); \ shell_fprintf_error(sh, fmt, ##__VA_ARGS__); \
} else { \ } else { \
printk(fmt, ##__VA_ARGS__); \ printk(fmt, ##__VA_ARGS__); \
} \ } \
@ -38,7 +38,7 @@
#define PR_INFO(fmt, ...) \ #define PR_INFO(fmt, ...) \
do { \ do { \
if (sh) { \ if (sh) { \
shell_info_impl(sh, fmt, ##__VA_ARGS__); \ shell_fprintf_info(sh, fmt, ##__VA_ARGS__); \
} else { \ } else { \
printk(fmt, ##__VA_ARGS__); \ printk(fmt, ##__VA_ARGS__); \
} \ } \
@ -47,7 +47,7 @@
#define PR_WARNING(fmt, ...) \ #define PR_WARNING(fmt, ...) \
do { \ do { \
if (sh) { \ if (sh) { \
shell_warn_impl(sh, fmt, ##__VA_ARGS__); \ shell_fprintf_warn(sh, fmt, ##__VA_ARGS__); \
} else { \ } else { \
printk(fmt, ##__VA_ARGS__); \ printk(fmt, ##__VA_ARGS__); \
} \ } \

36
subsys/shell/shell.c
View file

@ -1548,10 +1548,10 @@ void shell_vfprintf(const struct shell *sh, enum shell_vt100_color color,
/* These functions mustn't be used from shell context to avoid deadlock: /* These functions mustn't be used from shell context to avoid deadlock:
* - shell_fprintf_impl * - shell_fprintf_impl
* - shell_info_impl * - shell_fprintf_info
* - shell_print_impl * - shell_fprintf_normal
* - shell_warn_impl * - shell_fprintf_warn
* - shell_error_impl * - shell_fprintf_error
* However, they can be used in shell command handlers. * However, they can be used in shell command handlers.
*/ */
void shell_fprintf_impl(const struct shell *sh, enum shell_vt100_color color, void shell_fprintf_impl(const struct shell *sh, enum shell_vt100_color color,
@ -1564,7 +1564,7 @@ void shell_fprintf_impl(const struct shell *sh, enum shell_vt100_color color,
va_end(args); va_end(args);
} }
void shell_info_impl(const struct shell *sh, const char *fmt, ...) void shell_fprintf_info(const struct shell *sh, const char *fmt, ...)
{ {
va_list args; va_list args;
@ -1573,7 +1573,7 @@ void shell_info_impl(const struct shell *sh, const char *fmt, ...)
va_end(args); va_end(args);
} }
void shell_print_impl(const struct shell *sh, const char *fmt, ...) void shell_fprintf_normal(const struct shell *sh, const char *fmt, ...)
{ {
va_list args; va_list args;
@ -1582,7 +1582,7 @@ void shell_print_impl(const struct shell *sh, const char *fmt, ...)
va_end(args); va_end(args);
} }
void shell_warn_impl(const struct shell *sh, const char *fmt, ...) void shell_fprintf_warn(const struct shell *sh, const char *fmt, ...)
{ {
va_list args; va_list args;
@ -1591,7 +1591,7 @@ void shell_warn_impl(const struct shell *sh, const char *fmt, ...)
va_end(args); va_end(args);
} }
void shell_error_impl(const struct shell *sh, const char *fmt, ...) void shell_fprintf_error(const struct shell *sh, const char *fmt, ...)
{ {
va_list args; va_list args;
@ -1607,35 +1607,35 @@ void shell_hexdump_line(const struct shell *sh, unsigned int offset,
int i; int i;
shell_print_impl(sh, "%08X: ", offset); shell_fprintf_normal(sh, "%08X: ", offset);
for (i = 0; i < SHELL_HEXDUMP_BYTES_IN_LINE; i++) { for (i = 0; i < SHELL_HEXDUMP_BYTES_IN_LINE; i++) {
if (i > 0 && !(i % 8)) { if (i > 0 && !(i % 8)) {
shell_print_impl(sh, " "); shell_fprintf_normal(sh, " ");
} }
if (i < len) { if (i < len) {
shell_print_impl(sh, "%02x ", shell_fprintf_normal(sh, "%02x ",
data[i] & 0xFF); data[i] & 0xFF);
} else { } else {
shell_print_impl(sh, " "); shell_fprintf_normal(sh, " ");
} }
} }
shell_print_impl(sh, "|"); shell_fprintf_normal(sh, "|");
for (i = 0; i < SHELL_HEXDUMP_BYTES_IN_LINE; i++) { for (i = 0; i < SHELL_HEXDUMP_BYTES_IN_LINE; i++) {
if (i > 0 && !(i % 8)) { if (i > 0 && !(i % 8)) {
shell_print_impl(sh, " "); shell_fprintf_normal(sh, " ");
} }
if (i < len) { if (i < len) {
char c = data[i]; char c = data[i];
shell_print_impl(sh, "%c", shell_fprintf_normal(sh, "%c",
isprint((int)c) != 0 ? c : '.'); isprint((int)c) != 0 ? c : '.');
} else { } else {
shell_print_impl(sh, " "); shell_fprintf_normal(sh, " ");
} }
} }