API 参考

struct xwsh_cmd {
        char * name;                               /**< 命令的名称 */
        xwer_t (*func)(xwsz_t argc, char ** argv); /**< 命令的函数 */
        char * desc;                               /**< 命令的描述 */
};

const struct xwsh_cmd my_cmd = {
        .name = "test",
        .func = my_test_func,
        .desc = "test command description"
};

#define XWSH_MAXINPUT 128U

xwer_t xwsh_start(xwstk_t * stack, xwsz_t stack_size);

xwstk_t stack[1024];
xwer_t rc = xwsh_start(stack, sizeof(stack));
if (rc < 0) {
        printf("Failed to start XWSH: %d\r\n", rc);
}

void xwsh_init(void);

xwsh_init();  // 显示 "Welcome to the XWOS-Vx.x.x!"

void xwsh_loop(char * buf);

char buf[XWSH_MAXINPUT];
xwsh_init();
while (1) {
        xwsh_loop(buf);  // 阻塞等待命令输入
}

xwer_t xwsh_set_ext_cmd_table(const struct xwsh_cmd cmd[], xwsz_t num);

const struct xwsh_cmd my_cmds[] = {
        { .name = "test", .func = test_func, .desc = "test" },
};
xwer_t rc = xwsh_set_ext_cmd_table(my_cmds, 1);
if (rc < 0) {
        printf("Failed to set command table: %d\r\n", rc);
}

#define XWSH_MAX_PARAM_NUM 16U

xwer_t xwsh_run_cmdline(char * line);

char line[] = "help";
xwer_t rc = xwsh_run_cmdline(line);  // 执行 help 命令

void xwsh_show_all_cmds(void);

xwsh_show_all_cmds();
// 输出：
// help    show this help
// clear   clear screen
// rd      read memory
// wr      write memory

void xwsh_show_logo(void);

xwsh_show_logo();
// 输出：
// [XWOS ASCII logo]
// Welcome to the XWOS-V1.0.0! Build time Feb 17 2026 10:30:00

void xwsh_cherryrl_init(void);

char * xwsh_cherryrl_readline(char buffer[]);

xwer_t command_handler(xwsz_t argc, char ** argv);

xwer_t my_command(xwsz_t argc, char ** argv)
{
        if (argc < 2) {
                printf("Usage: %s <param>\r\n", argv[0]);
                return -EINVAL;
        }
        
        printf("Parameter: %s\r\n", argv[1]);
        return XWOK;
}

xwer_t example_function(type param)
{
        xwer_t rc = XWOK;
        
        /* 参数验证 */
        if (!param) {
                rc = -EINVAL;
                goto err_param;
        }
        
        /* 主逻辑 */
        // ...
        
        return XWOK;
        
err_param:
        return rc;
}

#include <xwos/standard.h>
#include "xwmd/cli/xwsh/mi.h"
#include "xwmd/cli/xwsh/core.h"

/* 自定义命令 */
xwer_t custom_cmd(xwsz_t argc, char ** argv)
{
        printf("Custom command executed\r\n");
        printf("argc: %d\r\n", argc);
        for (xwsz_t i = 0; i < argc; i++) {
                printf("argv[%d]: %s\r\n", i, argv[i]);
        }
        return XWOK;
}

/* 命令表 */
const struct xwsh_cmd ext_cmds[] = {
        { .name = "custom", .func = custom_cmd, .desc = "custom command" },
};

int main(void)
{
        xwer_t rc;
        
        /* 1. 设置外部命令表（必须在启动前） */
        rc = xwsh_set_ext_cmd_table(ext_cmds, 
                                   sizeof(ext_cmds) / sizeof(ext_cmds[0]));
        if (rc < 0) {
                printf("Failed to set command table: %d\r\n", rc);
                return rc;
        }
        
        /* 2. 选择运行模式 */
#ifdef USE_STANDALONE_THREAD
        /* 独立线程模式 */
        xwstk_t stack[1024];
        rc = xwsh_start(stack, sizeof(stack));
        if (rc < 0) {
                printf("Failed to start XWSH: %d\r\n", rc);
                return rc;
        }
#else
        /* 嵌入式模式 */
        char buf[XWSH_MAXINPUT];
        xwsh_init();
        while (1) {
                xwsh_loop(buf);
        }
#endif
        
        return 0;
}

/* 不通过交互式 Shell，直接执行命令 */
void execute_command_directly(void)
{
        char cmd1[] = "help";
        char cmd2[] = "rd 0x20000000 16";
        
        /* 执行 help 命令 */
        xwer_t rc = xwsh_run_cmdline(cmd1);
        if (rc < 0) {
                printf("Command failed: %d\r\n", rc);
        }
        
        /* 执行内存读取命令 */
        rc = xwsh_run_cmdline(cmd2);
        if (rc < 0) {
                printf("Memory read failed: %d\r\n", rc);
        }
}