File: fcallback.h

package info (click to toggle)
finalcut 0.9.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,832 kB
  • sloc: cpp: 90,264; makefile: 546; sh: 412
file content (418 lines) | stat: -rw-r--r-- 15,669 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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
/***********************************************************************
* fcallback.h - Implements the callback functionality                  *
*                                                                      *
* This file is part of the FINAL CUT widget toolkit                    *
*                                                                      *
* Copyright 2020-2022 Markus Gans                                      *
*                                                                      *
* FINAL CUT is free software; you can redistribute it and/or modify    *
* it under the terms of the GNU Lesser General Public License as       *
* published by the Free Software Foundation; either version 3 of       *
* the License, or (at your option) any later version.                  *
*                                                                      *
* FINAL CUT is distributed in the hope that it will be useful, but     *
* WITHOUT ANY WARRANTY; without even the implied warranty of           *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
* GNU Lesser General Public License for more details.                  *
*                                                                      *
* You should have received a copy of the GNU Lesser General Public     *
* License along with this program.  If not, see                        *
* <http://www.gnu.org/licenses/>.                                      *
***********************************************************************/

/*  Standalone class
 *  ════════════════
 *
 * ▕▔▔▔▔▔▔▔▔▔▔▔▏1     *▕▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▏
 * ▕ FCallback ▏- - - -▕ FCallbackData ▏
 * ▕▁▁▁▁▁▁▁▁▁▁▁▏       ▕▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▏
 */

#ifndef FCALLBACK_H
#define FCALLBACK_H

#if !defined (USE_FINAL_H) && !defined (COMPILE_FINAL_CUT)
  #error "Only <final/final.h> can be included directly."
#endif

#include <utility>
#include <vector>

#include "final/ftypes.h"
#include "final/util/fstring.h"

namespace finalcut
{

// class forward declaration
class FWidget;

//----------------------------------------------------------------------
// struct FCallbackData
//----------------------------------------------------------------------

struct FCallbackData
{
  // Constructor
  FCallbackData() = default;

  template <typename FuncPtr>
  FCallbackData (FString&& s, FWidget* i, FuncPtr m, FCall&& c)
    : cb_signal(std::move(s))
    , cb_instance(i)
    , cb_function_ptr(m)
    , cb_function(std::move(c))
  { }

  FCallbackData (const FCallbackData&) = default;
  FCallbackData (FCallbackData&&) noexcept = default;

  auto operator = (const FCallbackData&) -> FCallbackData& = default;
  auto operator = (FCallbackData&&) noexcept -> FCallbackData& = default;

  // Data members
  FString   cb_signal{};
  FWidget*  cb_instance{};
  void*     cb_function_ptr{};
  FCall     cb_function{};
};


//----------------------------------------------------------------------
// class FCallback
//----------------------------------------------------------------------

class FCallback
{
  public:
    // Using-declaration
    template <typename T>
    using enable_if_ObjectPointer_t =
        std::enable_if_t< ! std::is_member_function_pointer<T>::value
                       && ! std::is_function<std::remove_pointer_t<T>>::value
                       && ! std::is_function<T>::value
                       && std::is_pointer<T>::value
                       && std::is_object<T>::value
                       && ! std::is_class<T>::value
                       , std::nullptr_t >;
    template <typename T>
    using enable_if_ClassObject_t =
        std::enable_if_t< ! std::is_member_function_pointer<T>::value
                       && ! std::is_function<std::remove_pointer_t<T>>::value
                       && ! std::is_function<T>::value
                       && ! std::is_pointer<T>::value
                       && std::is_object<T>::value
                       && std::is_class<T>::value
                       , std::nullptr_t >;
    template <typename T>
    using enable_if_MemberFunctionPointer_t =
        std::enable_if_t< std::is_member_function_pointer<T>::value
                       && ! std::is_function<std::remove_pointer_t<T>>::value
                       && ! std::is_function<T>::value
                       && ! std::is_pointer<T>::value
                       && std::is_object<T>::value
                       && ! std::is_class<T>::value
                       , std::nullptr_t >;
    template <typename T>
    using enable_if_FunctionPointer_t =
        std::enable_if_t< ! std::is_member_function_pointer<T>::value
                       && std::is_function<std::remove_pointer_t<T>>::value
                       && ! std::is_function<T>::value
                       && std::is_pointer<T>::value
                       && std::is_object<T>::value
                       && ! std::is_class<T>::value
                       , std::nullptr_t >;
    template <typename T>
    using enable_if_FunctionReference_t =
        std::enable_if_t< ! std::is_member_function_pointer<T>::value
                       && std::is_function<std::remove_pointer_t<T>>::value
                       && std::is_function<T>::value
                       && ! std::is_pointer<T>::value
                       && ! std::is_object<T>::value
                       && ! std::is_class<T>::value
                       , std::nullptr_t >;

    // Constructors
    FCallback() = default;

    // Disable copy constructor
    FCallback (const FCallback&) = delete;

    // Destructor
    ~FCallback() noexcept = default;

    // Disable copy assignment operator (=)
    auto operator = (const FCallback&) -> FCallback& = delete;

    // Accessors
    auto getClassName() const -> FString;
    auto getCallbackCount() const -> std::size_t;

    // Methods
    template <typename Object
            , typename Function
            , enable_if_ObjectPointer_t<Object> = nullptr
            , enable_if_MemberFunctionPointer_t<Function> = nullptr
            , typename... Args>
    void addCallback ( FString&&  cb_signal
                     , Object&&   cb_instance
                     , Function&& cb_member
                     , Args&&...  args) noexcept;
    template <typename Object
             , typename Function
             , enable_if_ObjectPointer_t<Object> = nullptr
             , enable_if_ClassObject_t<Function> = nullptr
             , typename... Args>
    void addCallback ( FString&&  cb_signal
                     , Object&&   cb_instance
                     , Function&& cb_function
                     , Args&&...  args) noexcept;
    template < typename Function
             , enable_if_ClassObject_t<Function> = nullptr
             , typename... Args>
    void addCallback ( FString&&  cb_signal
                     , Function&& cb_function
                     , Args&&...  args) noexcept;
    template <typename Function
            , enable_if_ClassObject_t<Function> = nullptr
            , typename... Args>
    void addCallback ( FString&& cb_signal
                     , Function& cb_function
                     , Args&&... args) noexcept;
    template <typename Function
            , enable_if_FunctionReference_t<Function> = nullptr
            , typename... Args>
    void addCallback ( FString&& cb_signal
                     , Function& cb_function
                     , Args&&... args) noexcept;
    template <typename Function
            , enable_if_FunctionPointer_t<Function> = nullptr
            , typename... Args>
    void addCallback ( FString&&  cb_signal
                     , Function&& cb_function
                     , Args&&...  args) noexcept;
    template <typename Object
            , enable_if_ObjectPointer_t<Object> = nullptr>
    void delCallback (Object&& cb_instance) noexcept;
    void delCallback (const FString& cb_signal);
    template <typename Object
            , enable_if_ObjectPointer_t<Object> = nullptr>
    void delCallback ( const FString& cb_signal
                     , Object&& cb_instance ) noexcept;
    template <typename FunctionPtr
            , enable_if_FunctionPointer_t<FunctionPtr> = nullptr>
    void delCallback (FunctionPtr&& cb_func_ptr) noexcept;
    template <typename Function
            , enable_if_FunctionReference_t<Function> = nullptr>
    void delCallback (const Function& cb_function);
    void delCallback();
    void emitCallback (const FString& emit_signal) const;

  private:
    // Using-declaration
    using FCallbackObjects = std::vector<FCallbackData>;

    // Data members
    FCallbackObjects  callback_objects{};
};

// FCallback inline functions
//----------------------------------------------------------------------
inline auto FCallback::getClassName() const -> FString
{ return "FCallback"; }

//----------------------------------------------------------------------
inline auto FCallback::getCallbackCount() const -> std::size_t
{ return callback_objects.size(); }

//----------------------------------------------------------------------
template <typename Object
        , typename Function
        , FCallback::enable_if_ObjectPointer_t<Object>
        , FCallback::enable_if_MemberFunctionPointer_t<Function>
        , typename... Args>
inline void FCallback::addCallback ( FString&&  cb_signal
                                   , Object&&   cb_instance
                                   , Function&& cb_member
                                   , Args&&...  args) noexcept
{
  // Add a member function pointer as callback

  Object instance = cb_instance;
  auto fn = std::bind ( std::forward<Function>(cb_member)
                      , std::forward<Object>(cb_instance)
                      , std::forward<Args>(args)... );
  callback_objects.emplace_back (std::move(cb_signal), instance, nullptr, fn);
}

//----------------------------------------------------------------------
template <typename Object
         , typename Function
         , FCallback::enable_if_ObjectPointer_t<Object>
         , FCallback::enable_if_ClassObject_t<Function>
         , typename... Args>
inline void FCallback::addCallback ( FString&&  cb_signal
                                   , Object&&   cb_instance
                                   , Function&& cb_function
                                   , Args&&...  args) noexcept
{
  // Add a function object to an instance as callback

  auto fn = std::bind (std::forward<Function>(cb_function), std::forward<Args>(args)...);
  callback_objects.emplace_back (std::move(cb_signal), cb_instance, nullptr, fn);
}

//----------------------------------------------------------------------
template <typename Function
        , FCallback::enable_if_ClassObject_t<Function>
        , typename... Args>
inline void FCallback::addCallback ( FString&&  cb_signal
                                   , Function&& cb_function
                                   , Args&&...  args) noexcept
{
  // Add a function object as callback

  auto fn = std::bind ( std::forward<Function>(cb_function)
                      , std::forward<Args>(args)... );
  callback_objects.emplace_back (std::move(cb_signal), nullptr, nullptr, fn);
}

//----------------------------------------------------------------------
template <typename Function
        , FCallback::enable_if_ClassObject_t<Function>
        , typename... Args>
inline void FCallback::addCallback ( FString&& cb_signal
                                   , Function& cb_function
                                   , Args&&... args) noexcept
{
  // Add a function object reference as callback

  auto fn = std::bind (cb_function, std::forward<Args>(args)...);
  callback_objects.emplace_back (std::move(cb_signal), nullptr, nullptr, fn);
}

//----------------------------------------------------------------------
template <typename Function
        , FCallback::enable_if_FunctionReference_t<Function>
        , typename... Args>
inline void FCallback::addCallback ( FString&& cb_signal
                                   , Function& cb_function
                                   , Args&&... args) noexcept
{
  // Add a function reference as callback

  auto ptr = reinterpret_cast<void*>(&cb_function);
  auto fn = std::bind (cb_function, std::forward<Args>(args)...);
  callback_objects.emplace_back (std::move(cb_signal), nullptr, ptr, fn);
}

//----------------------------------------------------------------------
template <typename Function
        , FCallback::enable_if_FunctionPointer_t<Function>
        , typename... Args>
inline void FCallback::addCallback ( FString&&  cb_signal
                                   , Function&& cb_function
                                   , Args&&...  args) noexcept
{
  // Add a function pointer as callback

  auto ptr = reinterpret_cast<void*>(cb_function);
  auto fn = std::bind ( std::forward<Function>(cb_function)
                      , std::forward<Args>(args)... );
  callback_objects.emplace_back(std::move(cb_signal), nullptr, ptr, fn);
}

//----------------------------------------------------------------------
template <typename Object
        , FCallback::enable_if_ObjectPointer_t<Object>>
inline void FCallback::delCallback (Object&& cb_instance) noexcept
{
  // Deletes entries with the given instance from the callback list

  if ( callback_objects.empty() )
    return;

  auto iter = callback_objects.cbegin();

  while ( iter != callback_objects.cend() )
  {
    if ( iter->cb_instance == cb_instance )
      iter = callback_objects.erase(iter);
    else
      ++iter;
  }
}

//----------------------------------------------------------------------
template <typename Object
        , FCallback::enable_if_ObjectPointer_t<Object>>
inline void FCallback::delCallback ( const FString& cb_signal
                                   , Object&& cb_instance ) noexcept
{
  // Deletes entries with the given signal and instance
  // from the callback list

  if ( callback_objects.empty() )
    return;

  auto iter = callback_objects.cbegin();

  while ( iter != callback_objects.cend() )
  {
    if ( iter->cb_signal == cb_signal
      && iter->cb_instance == cb_instance )
      iter = callback_objects.erase(iter);
    else
      ++iter;
  }
}

//----------------------------------------------------------------------
template <typename FunctionPtr
        , FCallback::enable_if_FunctionPointer_t<FunctionPtr>>
inline void FCallback::delCallback (FunctionPtr&& cb_func_ptr) noexcept
{
  // Deletes entries with the given function pointer
  // from the callback list

  if ( callback_objects.empty() )
    return;

  auto ptr = reinterpret_cast<void*>(cb_func_ptr);
  auto iter = callback_objects.cbegin();

  while ( iter != callback_objects.cend() )
  {
    if ( iter->cb_function_ptr == ptr )
      iter = callback_objects.erase(iter);
    else
      ++iter;
  }
}

//----------------------------------------------------------------------
template <typename Function
        , FCallback::enable_if_FunctionReference_t<Function>>
inline void FCallback::delCallback (const Function& cb_function)
{
  // Deletes entries with the given function reference
  // from the callback list

  if ( callback_objects.empty() )
    return;

  auto ptr = reinterpret_cast<void*>(&cb_function);
  auto iter = callback_objects.cbegin();

  while ( iter != callback_objects.cend() )
  {
    if ( iter->cb_function_ptr == ptr )
      iter = callback_objects.erase(iter);
    else
      ++iter;
  }
}

}  // namespace finalcut

#endif  // FCALLBACK_H