shcmd.h 文件参考

浏览源代码.

结构体
struct	CmdItem
struct	CmdItemNode
struct	CmdModInfo
struct	CmdKeyLink

类型定义
typedef BOOL(*	CmdVerifyTransID) (UINT32 transID)

函数
UINT32	OsCmdInit (VOID)
CmdModInfo *	OsCmdInfoGet (VOID)
	获取全局变量 更多...
UINT32	OsCmdExec (CmdParsed *cmdParsed, CHAR *cmdStr)
	执行命令,shell是运行程序的程序. 更多...
UINT32	OsCmdKeyShift (const CHAR *cmdKey, CHAR *cmdOut, UINT32 size)
INT32	OsTabCompletion (CHAR *cmdKey, UINT32 *len)
	tab键 更多...
VOID	OsShellCmdPush (const CHAR *string, CmdKeyLink *cmdKeyLink)
	将shell命令 string 以 CmdKeyLink 方式加入链表 更多...
VOID	OsShellHistoryShow (UINT32 value, ShellCB *shellCB)
	显示shell命令历史记录,支持上下键方式 更多...
UINT32	OsShellKeyInit (ShellCB *shellCB)
	shell 命令初始化 更多...
VOID	OsShellKeyDeInit (CmdKeyLink *cmdKeyLink)
	shell的析构函数 更多...
UINT32	OsShellSysCmdRegister (VOID)
	注册系统自带的shell命令 更多...

类型定义说明

CmdVerifyTransID

typedef BOOL(* CmdVerifyTransID) (UINT32 transID)

在文件 shcmd.h 第 51 行定义.

函数说明

OsCmdExec()

UINT32 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;
}

函数调用图:

OsCmdInfoGet()

CmdModInfo * OsCmdInfoGet

(

VOID

)

获取全局变量

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

{
    return &g_cmdInfo;
}

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

OsCmdInit()

UINT32 OsCmdInit

(

VOID

)

命令初始化,用于存放支持的命令,目前鸿蒙支持如下命令 arp cat cd chgrp chmod chown cp cpup
date dhclient dmesg dns format free help hwi
ifconfig ipdebug kill log ls lsfd memcheck mkdir
mount netstat oom partinfo partition ping ping6 pwd
reset rm rmdir sem statfs su swtmr sync
systeminfo task telnet test tftp touch umount uname
watch writeproc

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

{
    UINT32 ret;
    LOS_ListInit(&(g_cmdInfo.cmdList.list));//初始化双向链表
    g_cmdInfo.listNum = 0;  //命令数量
    g_cmdInfo.initMagicFlag = SHELL_INIT_MAGIC_FLAG;//魔法数字
    ret = LOS_MuxInit(&g_cmdInfo.muxLock, NULL);//初始化互斥量,确保链表安全访问
    if (ret != LOS_OK) {
        PRINT_ERR("Create mutex for shell cmd info failed\n");
        return OS_ERROR;
    }
    return LOS_OK;
}

函数调用图:

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

OsCmdKeyShift()

UINT32 OsCmdKeyShift	(	const CHAR *	cmdKey,
		CHAR *	cmdOut,
		UINT32	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	(	UINT32	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()

UINT32 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;
}

函数调用图:

OsShellSysCmdRegister()

UINT32 OsShellSysCmdRegister

(

VOID

)

注册系统自带的shell命令

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

{
    UINT32 i;
    UINT8 *cmdItemGroup = NULL;
    UINT32 index = ((UINTPTR)(&g_shellcmdEnd) - (UINTPTR)(&g_shellcmd[0])) / sizeof(CmdItem);//获取个数
    CmdItemNode *cmdItem = NULL;
 
    cmdItemGroup = (UINT8 *)LOS_MemAlloc(m_aucSysMem0, index * sizeof(CmdItemNode));//分配命令项
    if (cmdItemGroup == NULL) {
        PRINT_ERR("[%s]System memory allocation failure!\n", __FUNCTION__);
        return (UINT32)OS_ERROR;
    }
 
    for (i = 0; i < index; ++i) {//循环插入
        cmdItem = (CmdItemNode *)(cmdItemGroup + i * sizeof(CmdItemNode));
        cmdItem->cmd = &g_shellcmd[i];//一个个取
        OsCmdAscendingInsert(cmdItem);//按升序插入到链表中
    }
    g_cmdInfo.listNum += index;//命令数量叠加
    return LOS_OK;
}

函数调用图:

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

OsTabCompletion()

INT32 OsTabCompletion	(	CHAR *	cmdKey,
		UINT32 *	len
	)

tab键

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

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

函数调用图: