shell.h 文件参考

#include <rtthread.h>
#include "finsh.h"

shell.h 的引用(Include)关系图:

此图展示该文件被哪些文件直接或间接地引用了:

浏览该文件的源代码.

结构体
struct	finsh_shell

宏定义
#define	FINSH_THREAD_PRIORITY   20
#define	FINSH_THREAD_STACK_SIZE   2048
#define	FINSH_CMD_SIZE   80
#define	FINSH_OPTION_ECHO   0x01
#define	FINSH_PROMPT   finsh_get_prompt()
#define	FINSH_THREAD_NAME   "tshell"

枚举
enum	input_stat { WAIT_NORMAL , WAIT_SPEC_KEY , WAIT_FUNC_KEY }

函数
const char *	finsh_get_prompt (void)
int	finsh_set_prompt (const char *prompt)
void	finsh_set_echo (rt_uint32_t echo)
rt_uint32_t	finsh_get_echo (void)
int	finsh_system_init (void)
const char *	finsh_get_device (void)
int	finsh_getchar (void)
rt_uint32_t	finsh_get_prompt_mode (void)
void	finsh_set_prompt_mode (rt_uint32_t prompt_mode)
void	finsh_thread_entry_sethook (void(*hook)(void))

宏定义说明

FINSH_THREAD_PRIORITY

#define FINSH_THREAD_PRIORITY   20

在文件 shell.h 第 18 行定义.

FINSH_THREAD_STACK_SIZE

#define FINSH_THREAD_STACK_SIZE   2048

在文件 shell.h 第 21 行定义.

FINSH_CMD_SIZE

#define FINSH_CMD_SIZE   80

在文件 shell.h 第 24 行定义.

FINSH_OPTION_ECHO

#define FINSH_OPTION_ECHO   0x01

在文件 shell.h 第 27 行定义.

FINSH_PROMPT

#define FINSH_PROMPT   finsh_get_prompt()

在文件 shell.h 第 29 行定义.

FINSH_THREAD_NAME

#define FINSH_THREAD_NAME   "tshell"

在文件 shell.h 第 52 行定义.

枚举类型说明

input_stat

enum input_stat

枚举值
WAIT_NORMAL
WAIT_SPEC_KEY
WAIT_FUNC_KEY

在文件 shell.h 第 55 行定义.

{
    WAIT_NORMAL,
    WAIT_SPEC_KEY,
    WAIT_FUNC_KEY,
};

函数说明

finsh_get_prompt()

const char * finsh_get_prompt

(

void

)

在文件 shell.c 第 95 行定义.

{
    static char finsh_prompt[RT_CONSOLEBUF_SIZE + 1] = {0};
 
    /* check prompt mode */
    if (!shell->prompt_mode)
    {
        finsh_prompt[0] = '\0';
        return finsh_prompt;
    }
 
    if (finsh_prompt_custom)
    {
        strncpy(finsh_prompt, finsh_prompt_custom, sizeof(finsh_prompt) - 1);
    }
    else
    {
        strcpy(finsh_prompt, _MSH_PROMPT);
    }
 
#if defined(DFS_USING_POSIX) && defined(DFS_USING_WORKDIR)
    /* get current working directory */
    getcwd(&finsh_prompt[rt_strlen(finsh_prompt)], RT_CONSOLEBUF_SIZE - rt_strlen(finsh_prompt));
#endif
 
    if (rt_strlen(finsh_prompt) + 2 < RT_CONSOLEBUF_SIZE)
    {
        finsh_prompt[rt_strlen(finsh_prompt)] = '>';
        finsh_prompt[rt_strlen(finsh_prompt) + 1] = '\0';
    }
 
    return finsh_prompt;
}

引用了 _MSH_PROMPT, getcwd() , 以及 shell.

函数调用图:

finsh_set_prompt()

int finsh_set_prompt

(

const char *

prompt

)

在文件 shell.c 第 71 行定义.

{
    if (finsh_prompt_custom)
    {
        rt_free(finsh_prompt_custom);
        finsh_prompt_custom = RT_NULL;
    }
 
    /* strdup */
    if (prompt)
    {
        finsh_prompt_custom = (char *)rt_malloc(strlen(prompt) + 1);
        if (finsh_prompt_custom)
        {
            strcpy(finsh_prompt_custom, prompt);
        }
    }
 
    return 0;
}

引用了 rt_free(), rt_malloc() , 以及 RT_NULL.

函数调用图:

finsh_system_init()

int finsh_system_init

(

void

)

在文件 shell.c 第 762 行定义.

{
    rt_err_t result = RT_EOK;
    rt_thread_t tid;
 
#ifdef FINSH_USING_SYMTAB
#ifdef __ARMCC_VERSION  /* ARM C Compiler */
    extern const int FSymTab$$Base;
    extern const int FSymTab$$Limit;
    finsh_system_function_init(&FSymTab$$Base, &FSymTab$$Limit);
#elif defined (__ICCARM__) || defined(__ICCRX__)      /* for IAR Compiler */
    finsh_system_function_init(__section_begin("FSymTab"),
                               __section_end("FSymTab"));
#elif defined (__GNUC__) || defined(__TI_COMPILER_VERSION__) || defined(__TASKING__)
    /* GNU GCC Compiler and TI CCS */
    extern const int __fsymtab_start;
    extern const int __fsymtab_end;
    finsh_system_function_init(&__fsymtab_start, &__fsymtab_end);
#elif defined(__ADSPBLACKFIN__) /* for VisualDSP++ Compiler */
    finsh_system_function_init(&__fsymtab_start, &__fsymtab_end);
#elif defined(_MSC_VER)
    unsigned int *ptr_begin, *ptr_end;
 
    if (shell)
    {
        rt_kprintf("finsh shell already init.\n");
        return RT_EOK;
    }
 
    ptr_begin = (unsigned int *)&__fsym_begin;
    ptr_begin += (sizeof(struct finsh_syscall) / sizeof(unsigned int));
    while (*ptr_begin == 0) ptr_begin ++;
 
    ptr_end = (unsigned int *) &__fsym_end;
    ptr_end --;
    while (*ptr_end == 0) ptr_end --;
 
    finsh_system_function_init(ptr_begin, ptr_end);
#endif
#endif
 
#ifdef RT_USING_HEAP
    /* create or set shell structure */
    shell = (struct finsh_shell *)rt_calloc(1, sizeof(struct finsh_shell));
    if (shell == RT_NULL)
    {
        rt_kprintf("no memory for shell\n");
        return -1;
    }
    tid = rt_thread_create(FINSH_THREAD_NAME,
                           finsh_thread_entry, RT_NULL,
                           FINSH_THREAD_STACK_SIZE, FINSH_THREAD_PRIORITY, 10);
#else
    shell = &_shell;
    tid = &finsh_thread;
    result = rt_thread_init(&finsh_thread,
                            FINSH_THREAD_NAME,
                            finsh_thread_entry, RT_NULL,
                            &finsh_thread_stack[0], sizeof(finsh_thread_stack),
                            FINSH_THREAD_PRIORITY, 10);
#endif /* RT_USING_HEAP */
 
    rt_sem_init(&(shell->rx_sem), "shrx", 0, 0);
    finsh_set_prompt_mode(1);
 
    if (tid != NULL && result == RT_EOK)
        rt_thread_startup(tid);
    return 0;
}

引用了 finsh_set_prompt_mode(), FINSH_THREAD_NAME, FINSH_THREAD_PRIORITY, FINSH_THREAD_STACK_SIZE, rt_calloc(), rt_kprintf, RT_NULL, rt_sem_init(), rt_thread_create(), rt_thread_init(), rt_thread_startup() , 以及 shell.

函数调用图:

这是这个函数的调用关系图:

finsh_getchar()

int finsh_getchar

(

void

)

在文件 shell.c 第 157 行定义.

{
#ifdef RT_USING_DEVICE
    char ch = 0;
#ifdef RT_USING_POSIX_STDIO
    if(read(rt_posix_stdio_get_console(), &ch, 1) > 0)
    {
        return ch;
    }
    else
    {
        return -1; /* EOF */
    }
#else
    rt_device_t device;
 
    RT_ASSERT(shell != RT_NULL);
 
    device = shell->device;
    if (device == RT_NULL)
    {
        return -1; /* EOF */
    }
 
    while (rt_device_read(device, -1, &ch, 1) != 1)
    {
        rt_sem_take(&shell->rx_sem, RT_WAITING_FOREVER);
        if (shell->device != device)
        {
            device = shell->device;
            if (device == RT_NULL)
            {
                return -1;
            }
        }
    }
    return ch;
#endif /* RT_USING_POSIX_STDIO */
#else
    extern char rt_hw_console_getchar(void);
    return rt_hw_console_getchar();
#endif /* RT_USING_DEVICE */
}

引用了 read(), RT_ASSERT, rt_device_read(), RT_NULL, rt_sem_take(), RT_WAITING_FOREVER , 以及 shell.

函数调用图: