Skip to content

File wsh_shell_cmd.h

File List > src > wsh_shell_cmd.h

Go to the documentation of this file

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
#ifndef __WSH_SHELL_CMD_H
#define __WSH_SHELL_CMD_H

#include "wsh_shell_cfg.h"
#include "wsh_shell_io.h"
#include "wsh_shell_option.h"
#include "wsh_shell_str.h"
#include "wsh_shell_types.h"

#ifdef __cplusplus
extern "C" {
#endif

// Forward declaration of command structure
struct WshShellCmd;

typedef WSH_SHELL_RET_STATE_t (*WshShellCmdHandler_t)(const struct WshShellCmd* pcCmd, WshShell_Size_t argc,
                                                      const WshShell_Char_t* pArgv[], void* pShellCtx);

typedef struct WshShellCmd {
    const WshShell_Char_t* Name;     
    const WshShell_Char_t* Descr;    
    WshShell_Size_t Groups;          
    const WshShellOption_t* Options; 
    WshShell_Size_t OptNum;          
    WshShellCmdHandler_t Handler;    
#if WSH_SHELL_SUBCOMMANDS
    const struct WshShellCmd* const* SubCmds; 
    WshShell_Size_t SubCmdNum;                
#endif
} WshShellCmd_t;

typedef struct {
    const WshShellCmd_t** List; 
    WshShell_Size_t Num;        
} WshShellCmd_Table_t;

WSH_SHELL_RET_STATE_t WshShellCmd_Attach(WshShellCmd_Table_t* pShellCommands, const WshShellCmd_t* pcCmdTable[],
                                         WshShell_Size_t cmdNum);

void WshShellCmd_DeAttach(WshShellCmd_Table_t* pShellCommands);

WshShell_Size_t WshShellCmd_GetCmdNum(WshShellCmd_Table_t* pShellCommands);

const WshShellCmd_t* WshShellCmd_GetCmdByIndex(WshShellCmd_Table_t* pShellCommands, WshShell_Size_t idx);

const WshShellCmd_t* WshShellCmd_SearchCmd(WshShellCmd_Table_t* pShellCommands, const WshShell_Char_t* pcCmdName);

#if WSH_SHELL_SUBCOMMANDS
WshShell_Size_t WshShellCmd_GetSubCmdNum(const WshShellCmd_t* pcCmd);

const WshShellCmd_t* WshShellCmd_GetSubCmdByIndex(const WshShellCmd_t* pcCmd, WshShell_Size_t idx);

const WshShellCmd_t* WshShellCmd_SearchSubCmd(const WshShellCmd_t* pcCmd, const WshShell_Char_t* pcSubName);
#endif /* WSH_SHELL_SUBCOMMANDS */

const WshShellOption_t* WshShellCmd_FindOptByName(const WshShellCmd_t* pcCmd, const WshShell_Char_t* pcName);

WshShellOption_Ctx_t WshShellCmd_ParseOpt(const WshShellCmd_t* pcCmd, WshShell_Size_t argc,
                                          const WshShell_Char_t* pArgv[], WshShell_Size_t rights,
                                          WshShell_Size_t* pTokenPos);

WSH_SHELL_RET_STATE_t WshShellCmd_GetOptValue(WshShellOption_Ctx_t* pOptCtx, WshShell_Size_t argc,
                                              const WshShell_Char_t* pArgv[], WshShell_Size_t valueSize, void* pValue);

void WshShellCmd_PrintOptionsOverview(const WshShellCmd_t* pcCmd);

#ifdef __cplusplus
}
#endif

#endif /* __WSH_SHELL_CMD_H */