File wsh_shell_cfg_def.h

FileList > src > wsh_shell_cfg_def.h

Go to the source code of this file

• #include "wsh_shell_types.h"

Public Types

Type	Name
enum	WSH_SHELL_CMD_GROUP_t

Public Static Functions

Type	Name
bool	WshShellRetState_TranslateToProject (WSH_SHELL_RET_STATE_t state)

Macros

Type	Name
define	RET_STATE_MAP_TABLE () /* multi line expression */
define	WSH_SHELL_ASSERT (exp)
define	WSH_SHELL_AUTOCOMPLETE 1
define	WSH_SHELL_AUTOCOMPLETE_PAD_LEN 32
define	WSH_SHELL_AUTOCOMPLETE_PAD_SYM '.'
define	WSH_SHELL_CMD_ARGS_MAX_NUM 16
define	WSH_SHELL_CMD_GROUP_ALL ((WshShell\_Size\_t)(~0U))
define	WSH_SHELL_CMD_GROUP_LIST /* multi line expression */
define	WSH_SHELL_CMD_NAME_LEN 16
define	WSH_SHELL_CMD_OPTIONS_MAX_NUM 16
define	WSH_SHELL_CMD_PRINT_OPT_OVERVIEW 1
define	WSH_SHELL_DEF_COMMAND 1
define	WSH_SHELL_DEV_NAME_LEN 16
define	WSH_SHELL_ESC_BUFF_LEN 8
define	WSH_SHELL_HEADER "\ \_\_ \_\_ \_\_\_\_ \r\n\ \_ \_\_\_\_\_\_\_/ /\_ \_\_\_\_\_/ /\_ \_\_\_ / / / \r\n\\| \| /\| / / \_\_\_/ \_\_ \\\_\_\_\_\_\_/ \_\_\_/ \_\_ \\/ \_ \\/ / /\r\n\\| \|/ \|/ (\_\_ ) / / /\_\_\_\_\_(\_\_ ) / / / \_\_/ / / \r\n\\|\_\_/\|\_\_/\_\_\_\_/\_/ /\_/ /\_\_\_\_/\_/ /\_/\\\_\_\_/\_/\_/ \r\n\\r\n"
define	WSH_SHELL_HISTORY 1
define	WSH_SHELL_HISTORY_BUFF_SIZE 256
define	WSH_SHELL_INTERACTIVE_MODE 1
define	WSH_SHELL_INTR_BUFF_LEN 64
define	WSH_SHELL_LOGIN_LEN 16
define	WSH_SHELL_MEMCMP (pD, pS, sz) memcmp((pD), (pS), (sz))
define	WSH_SHELL_MEMCPY (pD, pS, sz) memcpy((pD), (pS), (sz))
define	WSH_SHELL_MEMSET (pD, c, sz) memset((pD), (c), (sz))
define	WSH_SHELL_OPTION_LONG_NAME_LEN 16
define	WSH_SHELL_OPTION_SHORT_NAME_LEN 2
define	WSH_SHELL_PASS_LEN 16
define	WSH_SHELL_PRINT (_f_, ...) /* multi line expression */
define	WSH_SHELL_PRINT_ERR_ENABLE 1
define	WSH_SHELL_PRINT_INFO_ENABLE 1
define	WSH_SHELL_PRINT_OPT_HELP_ENABLE 1
define	WSH_SHELL_PRINT_SYS_ENABLE 1
define	WSH_SHELL_PRINT_WARN_ENABLE 1
define	WSH_SHELL_PROMPT_WAIT 1
define	WSH_SHELL_PS1_CUSTOM 1
define	WSH_SHELL_PS1_MAX_LEN 128
define	WSH_SHELL_PS1_TEMPLATE "%r%b%c6%d%c7@%c5%u%c2%i %c7> %r%c7"
define	WSH_SHELL_SALT_LEN 16
define	WSH_SHELL_SALT_PASS_HASH_LEN 64
define	WSH_SHELL_SNPRINTF (buf, size, ...) snprintf((buf), (size), \_\_VA\_ARGS\_\_)
define	WSH_SHELL_STRCMP (pS1, pS2) strcmp((pS1), (pS2))
define	WSH_SHELL_STRCPY (pD, pS) strcpy((pD), (pS))
define	WSH_SHELL_STRLEN (pS) strlen((pS))
define	WSH_SHELL_STRNCMP (pS1, pS2, len) strncmp((pS1), (pS2), (len))
define	WSH_SHELL_STRNCPY (pD, pS, sz) strncpy((pD), (pS), (sz))
define	WSH_SHELL_STRNLEN (pS, len) strnlen((pS), (len))
define	WSH_SHELL_STRTOF (pN, pE) strtof((pN), (pE))
define	WSH_SHELL_STRTOL (pS, pE, radix) strtol((pS), (pE), (radix))
define	WSH_SHELL_TARGET_OS "Bare-metal"
define	X_ENTRY (name, value) name = value,
define	X_MAP_ENTRY (proj, shell) /* multi line expression */

Public Types Documentation

enum WSH_SHELL_CMD_GROUP_t

enum WSH_SHELL_CMD_GROUP_t {
    WSH_SHELL_CMD_GROUP_LIST
};

---

Public Static Functions Documentation

function WshShellRetState_TranslateToProject

static inline bool WshShellRetState_TranslateToProject (
    WSH_SHELL_RET_STATE_t state
) 

---

Macro Definition Documentation

define RET_STATE_MAP_TABLE

#define RET_STATE_MAP_TABLE (

) `/* multi line expression */`

---

define WSH_SHELL_ASSERT

#define WSH_SHELL_ASSERT (
    exp
) 

---

define WSH_SHELL_AUTOCOMPLETE

#define WSH_SHELL_AUTOCOMPLETE `1`

---

define WSH_SHELL_AUTOCOMPLETE_PAD_LEN

#define WSH_SHELL_AUTOCOMPLETE_PAD_LEN `32`

---

define WSH_SHELL_AUTOCOMPLETE_PAD_SYM

#define WSH_SHELL_AUTOCOMPLETE_PAD_SYM `'.'`

---

define WSH_SHELL_CMD_ARGS_MAX_NUM

#define WSH_SHELL_CMD_ARGS_MAX_NUM `16`

---

define WSH_SHELL_CMD_GROUP_ALL

#define WSH_SHELL_CMD_GROUP_ALL `((WshShell_Size_t)(~0U))`

---

define WSH_SHELL_CMD_GROUP_LIST

#define WSH_SHELL_CMD_GROUP_LIST `/* multi line expression */`

---

define WSH_SHELL_CMD_NAME_LEN

#define WSH_SHELL_CMD_NAME_LEN `16`

---

define WSH_SHELL_CMD_OPTIONS_MAX_NUM

#define WSH_SHELL_CMD_OPTIONS_MAX_NUM `16`

---

define WSH_SHELL_CMD_PRINT_OPT_OVERVIEW

#define WSH_SHELL_CMD_PRINT_OPT_OVERVIEW `1`

---

define WSH_SHELL_DEF_COMMAND

#define WSH_SHELL_DEF_COMMAND `1`

---

define WSH_SHELL_DEV_NAME_LEN

#define WSH_SHELL_DEV_NAME_LEN `16`

---

define WSH_SHELL_ESC_BUFF_LEN

#define WSH_SHELL_ESC_BUFF_LEN `8`

---

define WSH_SHELL_HEADER

#define WSH_SHELL_HEADER `"\                __               __         ____  \r\n\ _      _______/ /_        _____/ /_  ___  / / /  \r\n\| | /| / / ___/ __ \\______/ ___/ __ \\/ _ \\/ / /\r\n\| |/ |/ (__  ) / / /_____(__  ) / / /  __/ / /    \r\n\|__/|__/____/_/ /_/     /____/_/ /_/\\___/_/_/    \r\n\\r\n"`

---

define WSH_SHELL_HISTORY

#define WSH_SHELL_HISTORY `1`

---

define WSH_SHELL_HISTORY_BUFF_SIZE

#define WSH_SHELL_HISTORY_BUFF_SIZE `256`

---

define WSH_SHELL_INTERACTIVE_MODE

#define WSH_SHELL_INTERACTIVE_MODE `1`

---

define WSH_SHELL_INTR_BUFF_LEN

#define WSH_SHELL_INTR_BUFF_LEN `64`

---

define WSH_SHELL_LOGIN_LEN

#define WSH_SHELL_LOGIN_LEN `16`

---

define WSH_SHELL_MEMCMP

#define WSH_SHELL_MEMCMP (
    pD,
    pS,
    sz
) `memcmp((pD), (pS), (sz))`

---

define WSH_SHELL_MEMCPY

#define WSH_SHELL_MEMCPY (
    pD,
    pS,
    sz
) `memcpy((pD), (pS), (sz))`

---

define WSH_SHELL_MEMSET

#define WSH_SHELL_MEMSET (
    pD,
    c,
    sz
) `memset((pD), (c), (sz))`

---

define WSH_SHELL_OPTION_LONG_NAME_LEN

#define WSH_SHELL_OPTION_LONG_NAME_LEN `16`

---

define WSH_SHELL_OPTION_SHORT_NAME_LEN

#define WSH_SHELL_OPTION_SHORT_NAME_LEN `2`

---

define WSH_SHELL_PASS_LEN

#define WSH_SHELL_PASS_LEN `16`

---

define WSH_SHELL_PRINT

#define WSH_SHELL_PRINT (
    _f_,
    ...
) `/* multi line expression */`

---

define WSH_SHELL_PRINT_ERR_ENABLE

#define WSH_SHELL_PRINT_ERR_ENABLE `1`

---

define WSH_SHELL_PRINT_INFO_ENABLE

#define WSH_SHELL_PRINT_INFO_ENABLE `1`

---

define WSH_SHELL_PRINT_OPT_HELP_ENABLE

#define WSH_SHELL_PRINT_OPT_HELP_ENABLE `1`

---

define WSH_SHELL_PRINT_SYS_ENABLE

#define WSH_SHELL_PRINT_SYS_ENABLE `1`

---

define WSH_SHELL_PRINT_WARN_ENABLE

#define WSH_SHELL_PRINT_WARN_ENABLE `1`

---

define WSH_SHELL_PROMPT_WAIT

#define WSH_SHELL_PROMPT_WAIT `1`

---

define WSH_SHELL_PS1_CUSTOM

#define WSH_SHELL_PS1_CUSTOM `1`

---

define WSH_SHELL_PS1_MAX_LEN

#define WSH_SHELL_PS1_MAX_LEN `128`

---

define WSH_SHELL_PS1_TEMPLATE

#define WSH_SHELL_PS1_TEMPLATE `"%r%b%c6%d%c7@%c5%u%c2%i %c7> %r%c7"`

---

define WSH_SHELL_SALT_LEN

#define WSH_SHELL_SALT_LEN `16`

---

define WSH_SHELL_SALT_PASS_HASH_LEN

#define WSH_SHELL_SALT_PASS_HASH_LEN `64`

---

define WSH_SHELL_SNPRINTF

#define WSH_SHELL_SNPRINTF (
    buf,
    size,
    ...
) `snprintf((buf), (size), __VA_ARGS__)`

---

define WSH_SHELL_STRCMP

#define WSH_SHELL_STRCMP (
    pS1,
    pS2
) `strcmp((pS1), (pS2))`

---

define WSH_SHELL_STRCPY

#define WSH_SHELL_STRCPY (
    pD,
    pS
) `strcpy((pD), (pS))`

---

define WSH_SHELL_STRLEN

#define WSH_SHELL_STRLEN (
    pS
) `strlen((pS))`

---

define WSH_SHELL_STRNCMP

#define WSH_SHELL_STRNCMP (
    pS1,
    pS2,
    len
) `strncmp((pS1), (pS2), (len))`

---

define WSH_SHELL_STRNCPY

#define WSH_SHELL_STRNCPY (
    pD,
    pS,
    sz
) `strncpy((pD), (pS), (sz))`

---

define WSH_SHELL_STRNLEN

#define WSH_SHELL_STRNLEN (
    pS,
    len
) `strnlen((pS), (len))`

---

define WSH_SHELL_STRTOF

#define WSH_SHELL_STRTOF (
    pN,
    pE
) `strtof((pN), (pE))`

---

define WSH_SHELL_STRTOL

#define WSH_SHELL_STRTOL (
    pS,
    pE,
    radix
) `strtol((pS), (pE), (radix))`

---

define WSH_SHELL_TARGET_OS

#define WSH_SHELL_TARGET_OS `"Bare-metal"`

---

define X_ENTRY

#define X_ENTRY (
    name,
    value
) `name = value,`

---

define X_MAP_ENTRY

#define X_MAP_ENTRY (
    proj,
    shell
) `/* multi line expression */`

---

---

The documentation for this class was generated from the following file src/wsh_shell_cfg_def.h