shcmd.h 文件参考

浏览源代码.

结构体
struct	CmdKeyLink

函数
unsigned int	OsCmdExec (CmdParsed *cmdParsed, char *cmdStr)
	执行命令,shell是运行程序的程序. 更多...
unsigned int	OsCmdKeyShift (const char *cmdKey, char *cmdOut, unsigned int size)
int	OsTabCompletion (char *cmdKey, unsigned int *len)
	tab键 更多...
void	OsShellCmdPush (const char *string, CmdKeyLink *cmdKeyLink)
	将shell命令 string 以 CmdKeyLink 方式加入链表 更多...
void	OsShellHistoryShow (unsigned int value, ShellCB *shellCB)
	显示shell命令历史记录,支持上下键方式 更多...
unsigned int	OsShellKeyInit (ShellCB *shellCB)
	shell 命令初始化 更多...
void	OsShellKeyDeInit (CmdKeyLink *cmdKeyLink)
	shell的析构函数 更多...
int	OsShellSetWorkingDirectory (const char *dir, size_t len)

函数说明

OsCmdExec()

unsigned int OsCmdExec	(	CmdParsed *	cmdParsed,
		char *	cmdStr
	)

执行命令,shell是运行程序的程序.

在文件 shcmd.c 第 586 行定义.

{
    /* TODO: complete the usrspace command */
    unsigned int ret = SH_OK;
    if (cmdParsed && cmdStr) {
        ret = SH_NOK;
    }
 
    return ret;
}

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

OsCmdKeyShift()

unsigned int OsCmdKeyShift	(	const char *	cmdKey,
		char *	cmdOut,
		unsigned int	size
	)

在文件 shcmd.c 第 386 行定义.

{
    char *output = NULL;
    char *outputBak = NULL;
    unsigned int len;
    int ret;
    bool quotes = FALSE;
 
    if ((cmdKey == NULL) || (cmdOut == NULL)) {
        return (unsigned int)SH_ERROR;
    }
 
    len = strlen(cmdKey);
    if ((*cmdKey == '\n') || (len >= size)) {
        return (unsigned int)SH_ERROR;
    }
    output = (char *)malloc(len + 1);
    if (output == NULL) {
        printf("malloc failure in %s[%d]\n", __FUNCTION__, __LINE__);
        return (unsigned int)SH_ERROR;
    }
 
    /* Backup the 'output' start address */
    outputBak = output;
    /* Scan each charactor in 'cmdKey',and squeeze the overmuch space and ignore invalid charactor */
    for (; *cmdKey != '\0'; cmdKey++) {
        /* Detected a Double Quotes, switch the matching status */
        if (*(cmdKey) == '\"') {
            SWITCH_QUOTES_STATUS(quotes);
        }
        /* Ignore the current charactor in following situation */
        /* 1) Quotes matching status is FALSE (which said that the space is not been marked by double quotes) */
        /* 2) Current charactor is a space */
        /* 3) Next charactor is a space too, or the string is been seeked to the end already(\0) */
        /* 4) Invalid charactor, such as single quotes */
        if ((*cmdKey == ' ') && ((*(cmdKey + 1) == ' ') || (*(cmdKey + 1) == '\0')) && QUOTES_STATUS_CLOSE(quotes)) {
            continue;
        }
        if (*cmdKey == '\'') {
            continue;
        }
        *output = *cmdKey;
        output++;
    }
    *output = '\0';
    /* Restore the 'output' start address */
    output = outputBak;
    len = strlen(output);
    /* Clear the space which is located at the first charactor in buffer */
    if (*output == ' ') {
        output++;
        len--;
    }
    /* Copy out the buffer which is been operated already */
    ret = strncpy_s(cmdOut, size, output, len);
    if (ret != SH_OK) {
        printf("%s,%d strncpy_s failed, err:%d!\n", __FUNCTION__, __LINE__, ret);
        free(outputBak);
        return SH_ERROR;
    }
    cmdOut[len] = '\0';
 
    free(outputBak);
    return SH_OK;
}

函数调用图:

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

OsShellCmdPush()

void OsShellCmdPush	(	const char *	string,
		CmdKeyLink *	cmdKeyLink
	)

将shell命令 string 以 CmdKeyLink 方式加入链表

在文件 shcmd.c 第 514 行定义.

{
    CmdKeyLink *cmdNewNode = NULL;
    unsigned int len;
 
    if ((string == NULL) || (strlen(string) == 0)) {
        return;
    }
 
    len = strlen(string);
    cmdNewNode = (CmdKeyLink *)malloc(sizeof(CmdKeyLink) + len + 1);
    if (cmdNewNode == NULL) {
        return;
    }
 
    (void)memset_s(cmdNewNode, sizeof(CmdKeyLink) + len + 1, 0, sizeof(CmdKeyLink) + len + 1);
    if (strncpy_s(cmdNewNode->cmdString, len + 1, string, len)) {
        free(cmdNewNode);
        return;
    }
 
    SH_ListTailInsert(&(cmdKeyLink->list), &(cmdNewNode->list));
 
    return;
}

函数调用图:

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

OsShellHistoryShow()

void OsShellHistoryShow	(	unsigned int	value,
		ShellCB *	shellCB
	)

显示shell命令历史记录,支持上下键方式

在文件 shcmd.c 第 540 行定义.

{
    CmdKeyLink *cmdtmp = NULL;
    CmdKeyLink *cmdNode = shellCB->cmdHistoryKeyLink;
    CmdKeyLink *cmdMask = shellCB->cmdMaskKeyLink;
    int ret;
 
    (void)pthread_mutex_lock(&shellCB->historyMutex);
    if (value == CMD_KEY_DOWN) {
        if (cmdMask == cmdNode) {
            goto END;
        }
 
        cmdtmp = SH_LIST_ENTRY(cmdMask->list.pstNext, CmdKeyLink, list);
        if (cmdtmp != cmdNode) {
            cmdMask = cmdtmp;
        } else {
            goto END;
        }
    } else if (value == CMD_KEY_UP) {
        cmdtmp = SH_LIST_ENTRY(cmdMask->list.pstPrev, CmdKeyLink, list);
        if (cmdtmp != cmdNode) {
            cmdMask = cmdtmp;
        } else {
            goto END;
        }
    }
 
    while (shellCB->shellBufOffset--) {
        printf("\b \b");
    }
    printf("%s", cmdMask->cmdString);
    shellCB->shellBufOffset = strlen(cmdMask->cmdString);
    (void)memset_s(shellCB->shellBuf, SHOW_MAX_LEN, 0, SHOW_MAX_LEN);
    ret = memcpy_s(shellCB->shellBuf, SHOW_MAX_LEN, cmdMask->cmdString, shellCB->shellBufOffset);
    if (ret != SH_OK) {
        printf("%s, %d memcpy failed!\n", __FUNCTION__, __LINE__);
        goto END;
    }
    shellCB->cmdMaskKeyLink = (void *)cmdMask;
 
END:
    (void)pthread_mutex_unlock(&shellCB->historyMutex);
    return;
}

函数调用图:

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

OsShellKeyDeInit()

void OsShellKeyDeInit

(

CmdKeyLink *

cmdKeyLink

)

shell的析构函数

在文件 shcmd.c 第 497 行定义.

{
    CmdKeyLink *cmdtmp = NULL;
    if (cmdKeyLink == NULL) {
        return;
    }
 
    while (!SH_ListEmpty(&(cmdKeyLink->list))) {
        cmdtmp = SH_LIST_ENTRY(cmdKeyLink->list.pstNext, CmdKeyLink, list);
        SH_ListDelete(&cmdtmp->list);
        free(cmdtmp);
    }
 
    cmdKeyLink->count = 0;
    free(cmdKeyLink);
}

函数调用图:

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

OsShellKeyInit()

unsigned int OsShellKeyInit

(

ShellCB *

shellCB

)

shell 命令初始化

在文件 shcmd.c 第 465 行定义.

{
    CmdKeyLink *cmdKeyLink = NULL;
    CmdKeyLink *cmdHistoryLink = NULL;
 
    if (shellCB == NULL) {
        return SH_ERROR;
    }
 
    cmdKeyLink = (CmdKeyLink *)malloc(sizeof(CmdKeyLink));
    if (cmdKeyLink == NULL) {
        printf("Shell CmdKeyLink memory alloc error!\n");
        return SH_ERROR;
    }
    cmdHistoryLink = (CmdKeyLink *)malloc(sizeof(CmdKeyLink));
    if (cmdHistoryLink == NULL) {
        free(cmdKeyLink);
        printf("Shell CmdHistoryLink memory alloc error!\n");
        return SH_ERROR;
    }
 
    cmdKeyLink->count = 0;
    SH_ListInit(&(cmdKeyLink->list));
    shellCB->cmdKeyLink = (void *)cmdKeyLink;
 
    cmdHistoryLink->count = 0;
    SH_ListInit(&(cmdHistoryLink->list));
    shellCB->cmdHistoryKeyLink = (void *)cmdHistoryLink;
    shellCB->cmdMaskKeyLink = (void *)cmdHistoryLink;
    return SH_OK;
}

函数调用图:

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

OsShellSetWorkingDirectory()

int OsShellSetWorkingDirectory	(	const char *	dir,
		size_t	len
	)

在文件 shcmd.c 第 99 行定义.

{
    if (dir == NULL) {
        return SH_NOK;
    }
 
    int ret = strncpy_s(OsGetShellCb()->shellWorkingDirectory, sizeof(OsGetShellCb()->shellWorkingDirectory),
                        dir, len);
    if (ret != SH_OK) {
        return SH_NOK;
    }
    return SH_OK;
}

函数调用图:

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

OsTabCompletion()

int OsTabCompletion	(	char *	cmdKey,
		unsigned int *	len
	)

tab键

在文件 shcmd.c 第 452 行定义.

{
    int count;
 
    if ((cmdKey == NULL) || (len == NULL)) {
        return (int)SH_ERROR;
    }
 
    count = OsTabMatchFile(cmdKey, len);
 
    return count;
}

函数调用图:

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