Skip to content

File wsh_shell_history.h

File List > src > wsh_shell_history.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
#ifndef __WSH_SHELL_HISTORY_H
#define __WSH_SHELL_HISTORY_H

#include "wsh_shell_cfg.h"
#include "wsh_shell_misc.h"
#include "wsh_shell_str.h"
#include "wsh_shell_types.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    WSH_SHELL_HIST_CMD_PREV = 0, 
    WSH_SHELL_HIST_CMD_NEXT      
} WSH_SHELL_HIST_CMD_DIR_t;

typedef struct {
    WshShell_Char_t StorageBuff[WSH_SHELL_HISTORY_BUFF_SIZE]; 
    WshShell_Size_t HeadIdx;                                  
    WshShell_Size_t TailIdx;                                  
    WshShell_Size_t LastSavedCmdIdx;  
    WSH_SHELL_HIST_CMD_DIR_t PrevDir; 
    WshShell_Bool_t LimitIsReached;   
} WshShellHistory_Data_t;

typedef struct {
    WshShell_U32_t Hash;         
    WshShellHistory_Data_t Data; 
} WshShellHistory_t;

typedef WshShellHistory_t (*WshShellHistory_ReadHandler_t)(void);

typedef void (*WshShellHistory_WriteHandler_t)(WshShellHistory_t);

typedef struct {
    WshShellHistory_ReadHandler_t Read;   
    WshShellHistory_WriteHandler_t Write; 
} WshShellHistory_IO_t;

void WshShellHistory_Init(WshShellHistory_IO_t* pHistIO, WshShellHistory_ReadHandler_t readFn,
                          WshShellHistory_WriteHandler_t writeFn);

void WshShellHistory_SaveCmd(WshShellHistory_IO_t* pHistIO, const WshShell_Char_t* pcCmdStr,
                             WshShell_Size_t cmdStrLen);

WshShell_Size_t WshShellHistory_GetPrevCmd(WshShellHistory_IO_t* pHistIO, WshShell_Char_t* pOutBuff,
                                           WshShell_Size_t outBuffSize);

WshShell_Size_t WshShellHistory_GetNextCmd(WshShellHistory_IO_t* pHistIO, WshShell_Char_t* pOutBuff,
                                           WshShell_Size_t outBuffSize);

WshShell_Size_t WshShellHistory_GetTokenNum(WshShellHistory_IO_t* pHistIO);

WshShell_Size_t WshShellHistory_GetTokenByIndex(WshShellHistory_IO_t* pHistIO,
                                                WshShell_Char_t* pOutBuff,
                                                WshShell_Size_t outBuffSize, WshShell_Size_t index);

void WshShellHistory_Flush(WshShellHistory_IO_t* pHistIO);

#ifdef __cplusplus
}
#endif

#endif /* __WSH_SHELL_HISTORY_H */