更新日期: 2022/06/01 来源: https://gitee.com/weharmony/kernel_liteos_a_note
shcmdparse.h
浏览该文件的文档.
1/*
2 * Copyright (c) 2013-2019 Huawei Technologies Co., Ltd. All rights reserved.
3 * Copyright (c) 2020-2021 Huawei Device Co., Ltd. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this list of
9 * conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
12 * of conditions and the following disclaimer in the documentation and/or other materials
13 * provided with the distribution.
14 *
15 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
16 * to endorse or promote products derived from this software without specific prior written
17 * permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
26 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
28 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#ifndef _SHCMDPARSE_H
33#define _SHCMDPARSE_H
34
35#include "string.h"
36#include "show.h"
37
38#ifdef __cplusplus
39#if __cplusplus
40extern "C" {
41#endif
42#endif
43
44/*
45 * Description: the info struct after cmd parser
46 */
47typedef struct {//命令解析器
48 unsigned int paramCnt; /**< count of para \n 参数数量*/
49 CmdType cmdType; /**< cmd type, judge cmd keyword \n 命令类型*/
50 char cmdKeyword[CMD_KEY_LEN]; /**< cmd keyword str \n 关键字,最多16个字符*/
51 char *paramArray[CMD_MAX_PARAS];/**< 参数内容,最多32个参数 */
52} CmdParsed;
53
54extern unsigned int OsCmdParse(char *cmdStr, CmdParsed *cmdParsed);
55extern char *OsCmdParseStrdup(const char *str);
56extern unsigned int OsCmdParseOneToken(CmdParsed *cmdParsed, unsigned int index, const char *token);
57extern unsigned int OsCmdTokenSplit(char *cmdStr, char split, CmdParsed *cmdParsed);
58
59#ifdef __cplusplus
60#if __cplusplus
61}
62#endif
63#endif
64
65#endif /* _SHCMDPARSE_H */
unsigned int OsCmdParse(char *cmdStr, CmdParsed *cmdParsed)
解析cmd命令,将关键字,参数分离出来
Definition: shcmdparse.c:147
unsigned int OsCmdParseOneToken(CmdParsed *cmdParsed, unsigned int index, const char *token)
解析出一个参数
Definition: shcmdparse.c:73
unsigned int OsCmdTokenSplit(char *cmdStr, char split, CmdParsed *cmdParsed)
将shell命令按 ' ' 分开处理
Definition: shcmdparse.c:99
char * OsCmdParseStrdup(const char *str)
Definition: shcmdparse.c:39
CmdType
Definition: shell.h:88
unsigned int paramCnt
Definition: shcmdparse.h:48
CmdType cmdType
Definition: shcmdparse.h:49