File: Console.h

package info (click to toggle)
spring 88.0%2Bdfsg1-1.1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 41,524 kB
  • sloc: cpp: 343,114; ansic: 38,414; python: 12,257; java: 12,203; awk: 5,748; sh: 1,204; xml: 997; perl: 405; objc: 192; makefile: 181; php: 134; sed: 2
file content (63 lines) | stat: -rwxr-xr-x 1,283 bytes parent folder | download | duplicates (2)
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
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */

#ifndef CONSOLE_H
#define CONSOLE_H

#include <map>
#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);
};

/**
 * @brief handles and forwards commands
 */
class Console
{
public:
	static Console& Instance();
	
	/**
	 * @brief register a command
	 * @param name the name of the command (e.g. "cheat")
	 * @param rec the CommandReceiver who want to recieve the command
	 */
	void AddCommandReceiver(const std::string& name, CommandReceiver* rec);
	
	/**
	 * @brief Execute an action
	 */
	bool ExecuteAction(const Action&);

private:
	Console();
	~Console();

	std::map<const std::string, CommandReceiver*> commandMap;
};

#endif // CONSOLE_H