/
CommandSystem.cpp
422 lines (339 loc) · 10.3 KB
/
CommandSystem.cpp
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
#include "CommandSystem.h"
#include "itextstream.h"
#include "iregistry.h"
#include "iradiant.h"
#include "debugging/debugging.h"
#include "command/ExecutionFailure.h"
#include "command/ExecutionNotPossible.h"
#include "messages/CommandExecutionFailed.h"
#include "CommandTokeniser.h"
#include "Command.h"
#include "Statement.h"
#include <functional>
#include "string/trim.h"
#include "string/predicate.h"
#include "module/StaticModule.h"
namespace cmd
{
namespace
{
const std::string RKEY_COMMANDSYSTEM_BINDS = "user/ui/commandsystem/binds";
}
// RegisterableModule implementation
const std::string& CommandSystem::getName() const {
static std::string _name(MODULE_COMMANDSYSTEM);
return _name;
}
const StringSet& CommandSystem::getDependencies() const {
static StringSet _dependencies;
if (_dependencies.empty())
{
_dependencies.insert(MODULE_XMLREGISTRY);
}
return _dependencies;
}
void CommandSystem::initialiseModule(const IApplicationContext& ctx)
{
rMessage() << "CommandSystem::initialiseModule called." << std::endl;
// Add the built-in commands
addCommand("bind", std::bind(&CommandSystem::bindCmd, this, std::placeholders::_1), { ARGTYPE_STRING, ARGTYPE_STRING });
addCommand("unbind", std::bind(&CommandSystem::unbindCmd, this, std::placeholders::_1), { ARGTYPE_STRING });
addCommand("listCmds", std::bind(&CommandSystem::listCmds, this, std::placeholders::_1));
addCommand("print", std::bind(&CommandSystem::printCmd, this, std::placeholders::_1), { ARGTYPE_STRING });
loadBinds();
}
void CommandSystem::shutdownModule()
{
rMessage() << "CommandSystem: shutting down." << std::endl;
// Save binds to registry
saveBinds();
// Free all commands
_commands.clear();
}
void CommandSystem::printCmd(const ArgumentList& args) {
for (ArgumentList::const_iterator i = args.begin(); i != args.end(); ++i) {
rMessage() << i->getString() << (i != args.begin() ? " " : "");
}
rMessage() << std::endl;
}
void CommandSystem::loadBinds() {
// Find all accelerators
xml::NodeList nodeList = GlobalRegistry().findXPath(RKEY_COMMANDSYSTEM_BINDS + "//bind");
if (nodeList.empty()) {
return;
}
// Load all bind commands from the nodes
for (std::size_t i = 0; i < nodeList.size(); ++i) {
xml::Node& node = nodeList[i];
std::string name = node.getAttributeValue("name");
std::string statement = node.getAttributeValue("value");
// remove all whitespace from the front and the tail
string::trim(statement);
// Create a new statement
StatementPtr st(new Statement(
statement,
(node.getAttributeValue("readonly") == "1")
));
std::pair<CommandMap::iterator, bool> result = _commands.insert(
CommandMap::value_type(name, st)
);
if (!result.second) {
rWarning() << "Duplicate statement detected: "
<< name << std::endl;
}
}
}
void CommandSystem::saveBinds() {
// Delete all previous binds
GlobalRegistry().deleteXPath(RKEY_COMMANDSYSTEM_BINDS + "//bind");
for (CommandMap::const_iterator i = _commands.begin(); i != _commands.end(); ++i)
{
// Check if this is actually a statement
StatementPtr st = std::dynamic_pointer_cast<Statement>(i->second);
if (st == NULL || st->isReadonly()) continue; // not a statement or readonly
xml::Node node = GlobalRegistry().createKeyWithName(RKEY_COMMANDSYSTEM_BINDS, "bind", i->first);
node.setAttributeValue("value", st->getValue());
}
}
void CommandSystem::bindCmd(const ArgumentList& args) {
// Sanity check
if (args.size() != 2) return;
// First argument is the command name
// Second argument is the command to be called plus its arguments
// Use a tokeniser to split the second argument into its pieces
// and trim all unnecessary whitespace
std::string input = args[1].getString();
// Add the statement - bind complete
addStatement(args[0].getString(), input);
}
void CommandSystem::unbindCmd(const ArgumentList& args)
{
// Sanity check
if (args.size() != 1) return;
// First argument is the statement to unbind
auto found = _commands.find(args[0].getString());
if (found == _commands.end())
{
rError() << "Cannot unbind: " << args[0].getString() << ": no such command." << std::endl;
return;
}
// Check if this is actually a statement
auto st = std::dynamic_pointer_cast<Statement>(found->second);
if (st && !st->isReadonly())
{
// This is a user-statement
_commands.erase(found);
}
else
{
rError() << "Cannot unbind built-in command: " << args[0].getString() << std::endl;
}
}
void CommandSystem::listCmds(const ArgumentList& args) {
// Dump all commands
for (CommandMap::const_iterator i = _commands.begin(); i != _commands.end(); ++i) {
rMessage() << i->first;
StatementPtr st = std::dynamic_pointer_cast<Statement>(i->second);
if (st != NULL) {
rMessage() << " => " << st->getValue();
}
rMessage() << std::endl;
}
}
void CommandSystem::foreachCommand(const std::function<void(const std::string&)>& functor)
{
for (const auto& pair : _commands)
{
functor(pair.first);
}
}
void CommandSystem::addCommand(const std::string& name, Function func,
const Signature& signature)
{
// Create a new command
auto cmd = std::make_shared<Command>(func, signature);
auto result = _commands.emplace(name, cmd);
if (!result.second)
{
rError() << "Cannot register command " << name
<< ", this command is already registered." << std::endl;
}
}
bool CommandSystem::commandExists(const std::string& name)
{
return _commands.find(name) != _commands.end();
}
void CommandSystem::removeCommand(const std::string& name)
{
auto i = _commands.find(name);
if (i != _commands.end())
{
_commands.erase(i);
}
}
void CommandSystem::addStatement(const std::string& statementName,
const std::string& str,
bool saveStatementToRegistry)
{
// Remove all whitespace at the front and the tail
auto st = std::make_shared<Statement>(
string::trim_copy(str),
!saveStatementToRegistry // read-only if we should not save this statement
);
auto result = _commands.emplace(statementName, st);
if (!result.second)
{
rError() << "Cannot register statement " << statementName
<< ", this statement is already registered." << std::endl;
}
}
void CommandSystem::foreachStatement(const std::function<void(const std::string&)>& functor,
bool customStatementsOnly)
{
for (const auto& pair : _commands)
{
auto statement = std::dynamic_pointer_cast<Statement>(pair.second);
if (statement && (!customStatementsOnly || !statement->isReadonly()))
{
functor(pair.first);
}
}
}
Signature CommandSystem::getSignature(const std::string& name)
{
// Lookup the named command
auto i = _commands.find(name);
// not found => empty signature
return i != _commands.end() ? i->second->getSignature() : Signature();
}
namespace local
{
// A statement consists of a command and a set of arguments
struct Statement
{
// The command to invoke
std::string command;
// The arguments to pass
ArgumentList args;
};
}
void CommandSystem::execute(const std::string& input)
{
// Instantiate a CommandTokeniser to analyse the given input string
CommandTokeniser tokeniser(input);
if (!tokeniser.hasMoreTokens()) return; // nothing to do!
std::vector<local::Statement> statements;
local::Statement curStatement;
while (tokeniser.hasMoreTokens())
{
// Inspect the next token
std::string token = tokeniser.nextToken();
if (token.empty()) {
continue; // skip empty tokens
}
else if (token == ";") {
// Finish the current statement
if (!curStatement.command.empty()) {
// Add the non-empty statement to our list
statements.push_back(curStatement);
}
// Clear the statement
curStatement = local::Statement();
continue;
}
// Token is not a semicolon
else if (curStatement.command.empty()) {
// The statement is still without command name, take this one
curStatement.command = token;
continue;
}
else {
// Non-empty token, command name is already known, so
// this must be an argument
curStatement.args.push_back(token);
}
}
// Check if we have an unfinished statement
if (!curStatement.command.empty()) {
// Add the non-empty statement to our list
statements.push_back(curStatement);
}
// Now execute the statements
for (const auto& statement : statements)
{
// Attempt ordinary command execution
executeCommand(statement.command, statement.args);
}
}
void CommandSystem::executeCommand(const std::string& name)
{
executeCommand(name, ArgumentList());
}
void CommandSystem::executeCommand(const std::string& name, const Argument& arg1)
{
ArgumentList args(1);
args[0] = arg1;
executeCommand(name, args);
}
void CommandSystem::executeCommand(const std::string& name, const Argument& arg1,
const Argument& arg2)
{
ArgumentList args(2);
args[0] = arg1;
args[1] = arg2;
executeCommand(name, args);
}
void CommandSystem::executeCommand(const std::string& name,
const Argument& arg1, const Argument& arg2,
const Argument& arg3)
{
ArgumentList args(3);
args[0] = arg1;
args[1] = arg2;
args[2] = arg3;
executeCommand(name, args);
}
void CommandSystem::executeCommand(const std::string& name, const ArgumentList& args)
{
// Find the named command
auto i = _commands.find(name);
if (i == _commands.end())
{
rError() << "Cannot execute command " << name << ": Command not found." << std::endl;
return;
}
try
{
i->second->execute(args);
}
catch (const ExecutionNotPossible& ex)
{
rError() << "Command '" << name << "' cannot be executed: " << ex.what() << std::endl;
// Dispatch this exception to the messagebus to potential listeners
radiant::CommandExecutionFailedMessage message(ex);
GlobalRadiantCore().getMessageBus().sendMessage(message);
}
catch (const ExecutionFailure& ex)
{
rError() << "Command '" << name << "' failed: " << ex.what() << std::endl;
// Dispatch this exception to the messagebus to potential listeners
radiant::CommandExecutionFailedMessage message(ex);
GlobalRadiantCore().getMessageBus().sendMessage(message);
}
}
AutoCompletionInfo CommandSystem::getAutoCompletionInfo(const std::string& prefix) {
AutoCompletionInfo returnValue;
returnValue.prefix = prefix;
for (const auto& pair : _commands)
{
// Check if the command matches the given prefix
if (string::istarts_with(pair.first, prefix))
{
returnValue.candidates.push_back(pair.first);
}
}
return returnValue;
}
// Static module instance
module::StaticModuleRegistration<CommandSystem> commandSystemModule;
} // namespace cmd