Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
blob: 7c5635f41a0bab9f86769ab161ffe83ae131c16b (plain)
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
/*
   core/func.h
   This file is part of the Osirion project and is distributed under
   the terms of the GNU General Public License version 2
*/

#ifndef __INCLUDED_CORE_FUNC_H__
#define __INCLUDED_CORE_FUNC_H__

#include "core/player.h"

#include <sstream>
#include <string>
#include <map>

namespace core
{

/// function pointer type for local functions
typedef void(* FuncPtr)(std::string const &args);

/// fuction pointer for game functions
typedef void(* GameFuncPtr)(Player *player, std::string const &args);

/// a function pointer encapsulation class
class Func 
{
public:
	/// function flags
	enum Flags {Game=1, Shared=2};
	
	/// create a new function
	Func(char const * name, void *ptr, unsigned int flags = 0);
	
	~Func();

/*----- inspectors ------------------------------------------------ */

	/// returns the fucuntion flags
	inline unsigned int flags() const { return func_flags; }

	/// returns the name of the function
	inline std::string const &name() const { return func_name; }

	/// returns the info of the function
	inline std::string const &info() { return func_info; }

/*----- mutators -------------------------------------------------- */
	
	/// set the info string
	void set_info(const char *);

	/// execute the function if the Game flag is not set
	void exec(std::string const &args);
	
	/// execute the function if the Game flag is set
	void exec(Player *player, std::string const &args);

/* ---- Static functions for the Func registry -------------------- */

	/// type definition
	typedef std::map<std::string, Func*> Registry;

	/// add a function to the registry
	static Func *add(const char *name, FuncPtr functionptr, unsigned int flags=0);

	/// add a game function to the registry and set the Game flag
	static Func *add(const char *name, GameFuncPtr functionptr, unsigned int flags=0);

	/// remove a function from the registry
	static void remove(const char *name);

	/// remove a function from the registry
	static void remove(std::string const &name);

	/// find a fuction pointer, return 0 if it could not be found
	static Func *find(std::string const &name);

	/// list the function registry
	static void list();

	/// the function registry
	static inline Registry & registry() { return func_registry; }

private:
	std::string		func_name;
	std::string		func_info;
	unsigned int 		func_flags;
	void 			*func_ptr;

	static Registry		func_registry;
};

}

#endif // __INCLUDED_CORE_FUNC_H__