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
|
// Copyright (C) by Josh Blum. See LICENSE.txt for licensing information.
#ifndef INCLUDED_GRAS_CALLABLE_HPP
#define INCLUDED_GRAS_CALLABLE_HPP
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning (disable:4251) // needs to have dll interface
#endif //_MSC_VER
#include <gras/gras.hpp>
#include <PMC/PMC.hpp>
#include <boost/shared_ptr.hpp>
#include <vector>
#include <string>
namespace gras
{
/*!
* The callable interface allows subclasses to export public methods,
* but without actually exporting traditional library symbols.
*
* Callable handles the template magic so you don't have to:
* - registering subclass methods is simple and easy on the user.
* - users call registered methods with natural code aesthetics.
*
* Register a method (in the constructor of MyClass):
* this->register_call("set_foo", &MyClass::set_foo);
*
* Call a method on a instance of MyClass:
* my_class->x("set_foo", new_foo_val);
*
* Why x for the call method?
* - The "x" is short, one character of screen width.
* - The "x" looks like "*", which is commonly used.
* - The overloaded () operator sucks with pointers.
* - The overloaded () operator has template issues.
*/
class GRAS_API Callable
{
public:
//! Default constructor
Callable(void);
//! Destructor (virtual for subclasses)
virtual ~Callable(void);
//! Get a list of names for registered calls
std::vector<std::string> get_registered_names(void) const;
protected:
/*!
* Unregister a previously registered call.
* Throws if the name is not found in the registry.
*/
void unregister_call(const std::string &name);
/*******************************************************************
* Register API - don't look here, template magic, not helpful
******************************************************************/
protected:
template <typename ClassType, typename ReturnType>
void register_call(const std::string &name, ReturnType(ClassType::*fcn)());
template <typename ClassType>
void register_call(const std::string &name, void(ClassType::*fcn)());
template <typename ClassType, typename ReturnType, typename A0>
void register_call(const std::string &name, ReturnType(ClassType::*fcn)(const A0 &));
template <typename ClassType, typename A0>
void register_call(const std::string &name, void(ClassType::*fcn)(const A0 &));
template <typename ClassType, typename ReturnType, typename A0, typename A1>
void register_call(const std::string &name, ReturnType(ClassType::*fcn)(const A0 &, const A1 &));
template <typename ClassType, typename A0, typename A1>
void register_call(const std::string &name, void(ClassType::*fcn)(const A0 &, const A1 &));
template <typename ClassType, typename ReturnType, typename A0, typename A1, typename A2>
void register_call(const std::string &name, ReturnType(ClassType::*fcn)(const A0 &, const A1 &, const A2 &));
template <typename ClassType, typename A0, typename A1, typename A2>
void register_call(const std::string &name, void(ClassType::*fcn)(const A0 &, const A1 &, const A2 &));
template <typename ClassType, typename ReturnType, typename A0, typename A1, typename A2, typename A3>
void register_call(const std::string &name, ReturnType(ClassType::*fcn)(const A0 &, const A1 &, const A2 &, const A3 &));
template <typename ClassType, typename A0, typename A1, typename A2, typename A3>
void register_call(const std::string &name, void(ClassType::*fcn)(const A0 &, const A1 &, const A2 &, const A3 &));
template <typename ClassType, typename ReturnType, typename A0, typename A1, typename A2, typename A3, typename A4>
void register_call(const std::string &name, ReturnType(ClassType::*fcn)(const A0 &, const A1 &, const A2 &, const A3 &, const A4 &));
template <typename ClassType, typename A0, typename A1, typename A2, typename A3, typename A4>
void register_call(const std::string &name, void(ClassType::*fcn)(const A0 &, const A1 &, const A2 &, const A3 &, const A4 &));
template <typename ClassType, typename ReturnType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5>
void register_call(const std::string &name, ReturnType(ClassType::*fcn)(const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &));
template <typename ClassType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5>
void register_call(const std::string &name, void(ClassType::*fcn)(const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &));
template <typename ClassType, typename ReturnType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6>
void register_call(const std::string &name, ReturnType(ClassType::*fcn)(const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &));
template <typename ClassType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6>
void register_call(const std::string &name, void(ClassType::*fcn)(const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &));
template <typename ClassType, typename ReturnType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6, typename A7>
void register_call(const std::string &name, ReturnType(ClassType::*fcn)(const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &, const A7 &));
template <typename ClassType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6, typename A7>
void register_call(const std::string &name, void(ClassType::*fcn)(const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &, const A7 &));
template <typename ClassType, typename ReturnType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6, typename A7, typename A8>
void register_call(const std::string &name, ReturnType(ClassType::*fcn)(const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &, const A7 &, const A8 &));
template <typename ClassType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6, typename A7, typename A8>
void register_call(const std::string &name, void(ClassType::*fcn)(const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &, const A7 &, const A8 &));
template <typename ClassType, typename ReturnType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6, typename A7, typename A8, typename A9>
void register_call(const std::string &name, ReturnType(ClassType::*fcn)(const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &, const A7 &, const A8 &, const A9 &));
template <typename ClassType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6, typename A7, typename A8, typename A9>
void register_call(const std::string &name, void(ClassType::*fcn)(const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &, const A7 &, const A8 &, const A9 &));
/*******************************************************************
* Call API - don't look here, template magic, not helpful
******************************************************************/
public:
template <typename ReturnType>
ReturnType x(const std::string &name);
inline
void x(const std::string &name);
template <typename ReturnType, typename A0>
ReturnType x(const std::string &name, const A0 &);
template <typename A0>
void x(const std::string &name, const A0 &);
template <typename ReturnType, typename A0, typename A1>
ReturnType x(const std::string &name, const A0 &, const A1 &);
template <typename A0, typename A1>
void x(const std::string &name, const A0 &, const A1 &);
template <typename ReturnType, typename A0, typename A1, typename A2>
ReturnType x(const std::string &name, const A0 &, const A1 &, const A2 &);
template <typename A0, typename A1, typename A2>
void x(const std::string &name, const A0 &, const A1 &, const A2 &);
template <typename ReturnType, typename A0, typename A1, typename A2, typename A3>
ReturnType x(const std::string &name, const A0 &, const A1 &, const A2 &, const A3 &);
template <typename A0, typename A1, typename A2, typename A3>
void x(const std::string &name, const A0 &, const A1 &, const A2 &, const A3 &);
template <typename ReturnType, typename A0, typename A1, typename A2, typename A3, typename A4>
ReturnType x(const std::string &name, const A0 &, const A1 &, const A2 &, const A3 &, const A4 &);
template <typename A0, typename A1, typename A2, typename A3, typename A4>
void x(const std::string &name, const A0 &, const A1 &, const A2 &, const A3 &, const A4 &);
template <typename ReturnType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5>
ReturnType x(const std::string &name, const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &);
template <typename A0, typename A1, typename A2, typename A3, typename A4, typename A5>
void x(const std::string &name, const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &);
template <typename ReturnType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6>
ReturnType x(const std::string &name, const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &);
template <typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6>
void x(const std::string &name, const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &);
template <typename ReturnType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6, typename A7>
ReturnType x(const std::string &name, const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &, const A7 &);
template <typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6, typename A7>
void x(const std::string &name, const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &, const A7 &);
template <typename ReturnType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6, typename A7, typename A8>
ReturnType x(const std::string &name, const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &, const A7 &, const A8 &);
template <typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6, typename A7, typename A8>
void x(const std::string &name, const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &, const A7 &, const A8 &);
template <typename ReturnType, typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6, typename A7, typename A8, typename A9>
ReturnType x(const std::string &name, const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &, const A7 &, const A8 &, const A9 &);
template <typename A0, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6, typename A7, typename A8, typename A9>
void x(const std::string &name, const A0 &, const A1 &, const A2 &, const A3 &, const A4 &, const A5 &, const A6 &, const A7 &, const A8 &, const A9 &);
/*******************************************************************
* Private registration hooks
******************************************************************/
protected:
void _register_call(const std::string &, void *);
public:
virtual PMCC _handle_call(const std::string &, const PMCC &);
private:
boost::shared_ptr<void> _call_registry;
};
} //namespace gras
#include <gras/detail/callable.hpp>
#ifdef _MSC_VER
#pragma warning(pop)
#endif //_MSC_VER
#endif /*INCLUDED_GRAS_CALLABLE_HPP*/
|
