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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
#pragma once
#include <vector>
#include "RemoteCommandHandler.h"
template <class CCommandParser>
class TRemoteCommandHandlerTemplate : public IRemoteCommandHandler
{
public:
// Remote command execution status
enum CommandStatus {
EDone,
ESucceeded,
EFailed,
EShowUsage
};
// Remote command parsers
typedef CommandStatus (CCommandParser::*RemoteCommandParser)(const IRemoteCommand& remoteCommand, std::string& strResult);
private:
// Parser descriptions
class CRemoteCommandParserItem
{
public:
CRemoteCommandParserItem(const std::string& strCommandName,
RemoteCommandParser pfnParser,
uint32_t uiMinArgumentCount,
const std::string& strHelp,
const std::string& strDescription)
: _strCommandName(strCommandName),
_pfnParser(pfnParser),
_uiMinArgumentCount(uiMinArgumentCount),
_strHelp(strHelp),
_strDescription(strDescription) {}
const std::string& getCommandName() const
{
return _strCommandName;
}
const std::string& getDescription() const
{
return _strDescription;
}
// Usage
std::string usage() const
{
return _strCommandName + " " + _strHelp;
}
bool parse(CCommandParser* pCommandParser, const IRemoteCommand& remoteCommand, std::string& strResult) const
{
// Check enough arguments supplied
if (remoteCommand.getArgumentCount() < _uiMinArgumentCount) {
strResult = std::string("Not enough arguments supplied\nUsage:\n") + usage();
return false;
}
switch ((pCommandParser->*_pfnParser)(remoteCommand, strResult)) {
case EDone:
strResult = "Done";
// Fall through intentionally
case ESucceeded:
return true;
case EShowUsage:
strResult = usage();
// Fall through intentionally
case EFailed:
return false;
}
return false;
}
private:
std::string _strCommandName;
RemoteCommandParser _pfnParser;
uint32_t _uiMinArgumentCount;
std::string _strHelp;
std::string _strDescription;
};
public:
TRemoteCommandHandlerTemplate(CCommandParser* pCommandParser) : _pCommandParser(pCommandParser), _uiMaxCommandUsageLength(0)
{
// Help Command
addCommandParser("help", NULL, 0, "", "Show commands description and usage");
}
~TRemoteCommandHandlerTemplate()
{
uint32_t uiIndex;
for (uiIndex = 0; uiIndex < _remoteCommandParserVector.size(); uiIndex++) {
delete _remoteCommandParserVector[uiIndex];
}
}
// Parsers
bool addCommandParser(const std::string& strCommandName,
RemoteCommandParser pfnParser,
uint32_t uiMinArgumentCount,
const std::string& strHelp,
const std::string& strDescription)
{
if (findCommandParserItem(strCommandName)) {
// Already exists
return false;
}
// Add command
_remoteCommandParserVector.push_back(new CRemoteCommandParserItem(strCommandName, pfnParser, uiMinArgumentCount, strHelp, strDescription));
return true;
}
private:
// Command processing
bool remoteCommandProcess(const IRemoteCommand& remoteCommand, std::string& strResult)
{
// Dispatch
const CRemoteCommandParserItem* pRemoteCommandParserItem = findCommandParserItem(remoteCommand.getCommand());
if (!pRemoteCommandParserItem) {
// Not found
strResult = "Command not found!";
return false;
}
if (remoteCommand.getCommand() == "help") {
helpCommandProcess(strResult);
return true;
}
return pRemoteCommandParserItem->parse(_pCommandParser, remoteCommand, strResult);
}
// Max command usage length, use for formatting
void initMaxCommandUsageLength()
{
if (!_uiMaxCommandUsageLength) {
// Show usages
uint32_t uiIndex;
for (uiIndex = 0; uiIndex < _remoteCommandParserVector.size(); uiIndex++) {
const CRemoteCommandParserItem* pRemoteCommandParserItem = _remoteCommandParserVector[uiIndex];
uint32_t uiRemoteCommandUsageLength = pRemoteCommandParserItem->usage().length();
if (uiRemoteCommandUsageLength > _uiMaxCommandUsageLength) {
_uiMaxCommandUsageLength = uiRemoteCommandUsageLength;
}
}
}
}
/////////////////// Remote command parsers
/// Help
void helpCommandProcess(std::string& strResult)
{
initMaxCommandUsageLength();
strResult = "\n";
// Show usages
uint32_t uiIndex;
for (uiIndex = 0; uiIndex < _remoteCommandParserVector.size(); uiIndex++) {
const CRemoteCommandParserItem* pRemoteCommandParserItem = _remoteCommandParserVector[uiIndex];
std::string strUsage = pRemoteCommandParserItem->usage();
strResult += strUsage;
// Align
uint32_t uiToSpacesAdd = _uiMaxCommandUsageLength + 5 - strUsage.length();
while (uiToSpacesAdd--) {
strResult += " ";
}
strResult += std::string("=> ") + std::string(pRemoteCommandParserItem->getDescription()) + "\n";
}
}
const CRemoteCommandParserItem* findCommandParserItem(const std::string& strCommandName) const
{
uint32_t uiIndex;
for (uiIndex = 0; uiIndex < _remoteCommandParserVector.size(); uiIndex++) {
const CRemoteCommandParserItem* pRemoteCommandParserItem = _remoteCommandParserVector[uiIndex];
if (pRemoteCommandParserItem->getCommandName() == strCommandName) {
return pRemoteCommandParserItem;
}
}
return NULL;
}
private:
CCommandParser* _pCommandParser;
std::vector<CRemoteCommandParserItem*> _remoteCommandParserVector;
uint32_t _uiMaxCommandUsageLength;
};
|
