更新日期: 2022/06/01 来源: https://gitee.com/weharmony/kernel_liteos_a_note
shcmd.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
33#ifndef _SHCMD_H
34#define _SHCMD_H
35
36#include "string.h"
37#include "stdlib.h"
38#include "shell_list.h"
39#include "shcmdparse.h"
40#include "sherr.h"
41#include "show.h"
42
43#ifdef __cplusplus
44#if __cplusplus
45extern "C" {
46#endif /* __cplusplus */
47#endif /* __cplusplus */
48/*! 一个shell命令的结构体,命令有长有短,鸿蒙采用了可变数组的方式实现 */
49typedef struct {
50 unsigned int count; ///< 字符数量
51 SH_List list; ///< 双向链表
52 char cmdString[0]; ///< 字符串,可变数组的一种实现方式.
54
55#define NEED_NEW_LINE(timesPrint, lineCap) ((timesPrint) % (lineCap) == 0)
56#define SCREEN_IS_FULL(timesPrint, lineCap) ((timesPrint) >= ((lineCap) * DEFAULT_SCREEN_HEIGHT))
57
58extern unsigned int OsCmdExec(CmdParsed *cmdParsed, char *cmdStr);
59extern unsigned int OsCmdKeyShift(const char *cmdKey, char *cmdOut, unsigned int size);
60extern int OsTabCompletion(char *cmdKey, unsigned int *len);
61extern void OsShellCmdPush(const char *string, CmdKeyLink *cmdKeyLink);
62extern void OsShellHistoryShow(unsigned int value, ShellCB *shellCB);
63extern unsigned int OsShellKeyInit(ShellCB *shellCB);
64extern void OsShellKeyDeInit(CmdKeyLink *cmdKeyLink);
65extern int OsShellSetWorkingDirectory(const char *dir, size_t len);
66
67#ifdef __cplusplus
68#if __cplusplus
69}
70#endif
71#endif
72
73#endif /* _SHCMD_H */
unsigned int OsCmdExec(CmdParsed *cmdParsed, char *cmdStr)
执行命令,shell是运行程序的程序.
Definition: shcmd.c:586
int OsShellSetWorkingDirectory(const char *dir, size_t len)
Definition: shcmd.c:99
unsigned int OsShellKeyInit(ShellCB *shellCB)
shell 命令初始化
Definition: shcmd.c:465
void OsShellHistoryShow(unsigned int value, ShellCB *shellCB)
显示shell命令历史记录,支持上下键方式
Definition: shcmd.c:540
void OsShellCmdPush(const char *string, CmdKeyLink *cmdKeyLink)
将shell命令 string 以 CmdKeyLink 方式加入链表
Definition: shcmd.c:514
int OsTabCompletion(char *cmdKey, unsigned int *len)
tab键
Definition: shcmd.c:452
void OsShellKeyDeInit(CmdKeyLink *cmdKeyLink)
shell的析构函数
Definition: shcmd.c:497
unsigned int OsCmdKeyShift(const char *cmdKey, char *cmdOut, unsigned int size)
Definition: shcmd.c:386
Definition: shell.h:71