File: MyGUI_Delegate.h

package info (click to toggle)
mygui 3.4.3%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 38,792 kB
  • sloc: cpp: 133,849; ansic: 30,249; xml: 15,794; cs: 12,601; tcl: 776; python: 400; makefile: 35; sh: 4
file content (347 lines) | stat: -rw-r--r-- 9,290 bytes parent folder | download
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
/*
 * This source file is part of MyGUI. For the latest info, see http://mygui.info/
 * Distributed under the MIT License
 * (See accompanying file COPYING.MIT or copy at http://opensource.org/licenses/MIT)
 */

#ifndef MYGUI_DELEGATE_H_
#define MYGUI_DELEGATE_H_

#include "MyGUI_Diagnostic.h"
#include "MyGUI_Any.h"
#include <algorithm>
#include <list>
#include <memory>
#include <functional>

namespace MyGUI
{

	namespace delegates
	{
		// base class for unsubscribing from multi delegates
		class MYGUI_EXPORT IDelegateUnlink
		{
		public:
			virtual ~IDelegateUnlink() = default;

			IDelegateUnlink() :
				m_baseDelegateUnlink(this)
			{
			}
			bool compare(IDelegateUnlink* _unlink) const
			{
				return m_baseDelegateUnlink == _unlink->m_baseDelegateUnlink;
			}

		private:
			IDelegateUnlink* m_baseDelegateUnlink;
		};

		template<typename... Args>
		class DelegateFunction
		{
		public:
			using Function = std::function<void(Args...)>;

			// function or static class method
			DelegateFunction(Function _function, Any _functionPointer) :
				mFunction(_function),
				mFunctionPointer(_functionPointer)
			{
			}

			// non-static class method
			DelegateFunction(Function _function, Any _functionPointer, const IDelegateUnlink* _object) :
				mFunction(_function),
				mUnlink(_object),
				mObject(_object),
				mFunctionPointer(_functionPointer)
			{
			}

			// non-static class method
			DelegateFunction(Function _function, Any _functionPointer, const void* _object) :
				mFunction(_function),
				mObject(_object),
				mFunctionPointer(_functionPointer)
			{
			}

			void invoke(Args... args)
			{
				mFunction(args...);
			}

			bool compare(DelegateFunction<Args...>* _delegate) const
			{
				if (nullptr == _delegate)
					return false;
				return _delegate->mObject == mObject && _delegate->mFunctionPointer.compare(mFunctionPointer);
			}

			bool compare(IDelegateUnlink* _unlink) const
			{
				return mUnlink == _unlink;
			}

		private:
			Function mFunction;

			const IDelegateUnlink* mUnlink = nullptr;
			const void* mObject = nullptr;
			Any mFunctionPointer;
		};

	} // namespace delegates

	// Creates delegate from a function or a static class method
	template<typename... Args>
	inline delegates::DelegateFunction<Args...>* newDelegate(void (*_func)(Args... args))
	{
		return new delegates::DelegateFunction<Args...>(_func, _func);
	}

	// Creates delegate from a non-static class method
	template<typename T, typename... Args>
	inline delegates::DelegateFunction<Args...>* newDelegate(T* _object, void (T::*_method)(Args... args))
	{
		return new delegates::DelegateFunction<Args...>(
			[=](Args&&... args) { return (_object->*_method)(std::forward<decltype(args)>(args)...); },
			_method,
			_object);
	}
	template<typename T, typename... Args>
	inline delegates::DelegateFunction<Args...>* newDelegate(const T* _object, void (T::*_method)(Args... args) const)
	{
		return new delegates::DelegateFunction<Args...>(
			[=](Args&&... args) { return (_object->*_method)(std::forward<decltype(args)>(args)...); },
			_method,
			_object);
	}

	// Creates delegate from std::function
	// Require some user-defined delegateId, that should be used if operator-= is called to remove delegate.
	// delegateId need to be unique within single delegate.
	template<typename... Args>
	inline delegates::DelegateFunction<Args...>* newDelegate(
		const std::function<void(Args...)>& _function,
		int64_t delegateId)
	{
		return new delegates::DelegateFunction<Args...>(_function, delegateId);
	}


	template<typename>
	struct GetDelegateFunctionFromLambda;
	template<typename R, typename C, typename... Args>
	struct GetDelegateFunctionFromLambda<R (C::*)(Args...) const>
	{
		using type = MyGUI::delegates::DelegateFunction<Args...>;
	};

	// Creates delegate from lambda
	// Require some user-defined delegateId, that should be used if operator-= is called to remove delegate.
	// delegateId need to be unique within single delegate.
	template<typename TLambda>
	inline auto newDelegate(const TLambda& _function, int64_t delegateId)
	{
		using DelegateType = typename GetDelegateFunctionFromLambda<decltype(&TLambda::operator())>::type;
		return new DelegateType(_function, delegateId);
	}

	namespace delegates
	{

		template<typename... Args>
		class Delegate
		{
		public:
			using IDelegate = DelegateFunction<Args...>;

			bool empty() const
			{
				return !mDelegate;
			}

			void clear()
			{
				mDelegate.reset();
			}

			Delegate& operator=(IDelegate* _delegate)
			{
				mDelegate.reset(_delegate);
				return *this;
			}

			void operator()(Args... args) const
			{
				if (mDelegate)
					mDelegate->invoke(args...);
			}

		private:
			std::unique_ptr<IDelegate> mDelegate;
		};

		template<typename... Args>
		class MultiDelegate
		{
		public:
			using IDelegate = DelegateFunction<Args...>;
			using ListDelegate = typename std::list<std::unique_ptr<IDelegate>>;

			// These shouldn't be necessary, but MSVC (17.6.5) requires them anyway
			MultiDelegate() = default;
			MultiDelegate(MultiDelegate&&) noexcept = default;

			bool empty() const
			{
				for (const auto& delegate : mListDelegates)
				{
					if (delegate)
						return false;
				}
				return true;
			}

			void clear()
			{
				if (mRunning)
				{
					for (auto& delegate : mListDelegates)
						delegate.reset();
				}
				else
					mListDelegates.clear();
			}

			void clear(IDelegateUnlink* _unlink)
			{
				if (!_unlink)
					return;
				for (auto& delegate : mListDelegates)
				{
					if (delegate && delegate->compare(_unlink))
						delegate.reset();
				}
			}

			void operator+=(IDelegate* _delegate)
			{
				if (!_delegate)
					return;
				auto found = std::find_if(
					mListDelegates.begin(),
					mListDelegates.end(),
					[=](const auto& delegate) { return delegate && delegate->compare(_delegate); });
				if (found != mListDelegates.end())
					MYGUI_EXCEPT("Trying to add same delegate twice.");
				mListDelegates.emplace_back(_delegate);
			}

			void operator-=(IDelegate* _delegate)
			{
				if (!_delegate)
					return;
				auto found = std::find_if(
					mListDelegates.begin(),
					mListDelegates.end(),
					[=](const auto& delegate) { return delegate && delegate->compare(_delegate); });
				if (found != mListDelegates.end())
				{
					if (found->get() == _delegate)
						_delegate = nullptr;
					found->reset();
				}
				delete _delegate;
			}

			void operator()(Args... args) const
			{
				bool canErase = !mRunning;
				InvocationModificationGuard guard(*this);
				for (auto it = mListDelegates.begin(); it != mListDelegates.end();)
				{
					if (*it)
						(*it)->invoke(args...);
					else if (canErase)
					{
						it = mListDelegates.erase(it);
						continue;
					}
					++it;
				}
			}

			MYGUI_OBSOLETE("use : operator += ")
			MultiDelegate& operator=(IDelegate* _delegate)
			{
				clear();
				*this += _delegate;
				return *this;
			}

		private:
			mutable ListDelegate mListDelegates;
			mutable bool mRunning{false};

			class InvocationModificationGuard
			{
				const MultiDelegate* mDelegate;

			public:
				InvocationModificationGuard(const MultiDelegate& delegate)
				{
					if (delegate.mRunning)
						mDelegate = nullptr;
					else
					{
						mDelegate = &delegate;
						mDelegate->mRunning = true;
					}
				}
				~InvocationModificationGuard()
				{
					if (mDelegate)
						mDelegate->mRunning = false;
				}
			};
			friend class InvocationModificationGuard;
		};

#ifndef MYGUI_DONT_USE_OBSOLETE
		using CDelegate0 MYGUI_OBSOLETE("use : MyGUI::delegates::Delegate<>") = Delegate<>;
		template<typename... Args>
		using CDelegate1 MYGUI_OBSOLETE("use : MyGUI::delegates::Delegate") = Delegate<Args...>;
		template<typename... Args>
		using CDelegate2 MYGUI_OBSOLETE("use : MyGUI::delegates::Delegate") = Delegate<Args...>;
		template<typename... Args>
		using CDelegate3 MYGUI_OBSOLETE("use : MyGUI::delegates::Delegate") = Delegate<Args...>;
		template<typename... Args>
		using CDelegate4 MYGUI_OBSOLETE("use : MyGUI::delegates::Delegate") = Delegate<Args...>;
		template<typename... Args>
		using CDelegate5 MYGUI_OBSOLETE("use : MyGUI::delegates::Delegate") = Delegate<Args...>;
		template<typename... Args>
		using CDelegate6 MYGUI_OBSOLETE("use : MyGUI::delegates::Delegate") = Delegate<Args...>;

		using CMultiDelegate0 MYGUI_OBSOLETE("use : MyGUI::delegates::MultiDelegate<>") = MultiDelegate<>;
		template<typename... Args>
		using CMultiDelegate1 MYGUI_OBSOLETE("use : MyGUI::delegates::MultiDelegate") = MultiDelegate<Args...>;
		template<typename... Args>
		using CMultiDelegate2 MYGUI_OBSOLETE("use : MyGUI::delegates::MultiDelegate") = MultiDelegate<Args...>;
		template<typename... Args>
		using CMultiDelegate3 MYGUI_OBSOLETE("use : MyGUI::delegates::MultiDelegate") = MultiDelegate<Args...>;
		template<typename... Args>
		using CMultiDelegate4 MYGUI_OBSOLETE("use : MyGUI::delegates::MultiDelegate") = MultiDelegate<Args...>;
		template<typename... Args>
		using CMultiDelegate5 MYGUI_OBSOLETE("use : MyGUI::delegates::MultiDelegate") = MultiDelegate<Args...>;
		template<typename... Args>
		using CMultiDelegate6 MYGUI_OBSOLETE("use : MyGUI::delegates::MultiDelegate") = MultiDelegate<Args...>;
#endif
	}

} // namespace MyGUI

#endif // MYGUI_DELEGATE_H_