File: Console.h

package info (click to toggle)
spring 106.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 55,260 kB
  • sloc: cpp: 543,946; ansic: 44,800; python: 12,575; java: 12,201; awk: 5,889; sh: 1,796; asm: 1,546; xml: 655; perl: 405; php: 211; objc: 194; makefile: 76; sed: 2
file content (73 lines) | stat: -rw-r--r-- 1,635 bytes parent folder | download | duplicates (3)
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
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */

#ifndef CONSOLE_H
#define CONSOLE_H

#include <vector>
#include <string>

class Action;

// TODO convert existing CommandReceiver's to use IUnsyncedActionExecutor's instead
/**
 * @brief this class can recieve commands (actions)
 * @deprecated Use IUnsyncedActionExecutor instead
 */
class CommandReceiver
{
public:
	CommandReceiver() {}
	virtual ~CommandReceiver() {}
	
	/**
	 * @brief callback function for all registered commands
	 */
	virtual void PushAction(const Action& action) = 0;

protected:
	/**
	 * @brief register a command
	 *
	 * PushAction will be called if this command is received by the console
	 */
	void RegisterAction(const std::string& name);
	void SortRegisteredActions();
};


/**
 * @brief handles and forwards commands
 */
class CommandConsole
{
public:
	typedef std::pair<std::string, CommandReceiver*> CmdPair;
	// typedef std::function<bool(const CmdPair& a, const CmdPair& b)> SortPred;

	/**
	 * @brief register a command
	 * @param name the name of the command (e.g. "cheat")
	 * @param rec the CommandReceiver who want to receive the command
	 */
	void AddCommandReceiver(const std::string& name, CommandReceiver* rec) { commandMap.emplace_back(name, rec); }
	void SortCommandMap();

	const std::vector<CmdPair>& GetCommandMap() const { return commandMap; }
	
	/**
	 * @brief Execute an action
	 */
	bool ExecuteAction(const Action&);

	void ResetState() {
		commandMap.clear();
		commandMap.reserve(32);
	}

private:
	std::vector<CmdPair> commandMap;
};

extern CommandConsole gameCommandConsole;
#endif // CONSOLE_H