annotate foosdk/sdk/foobar2000/helpers/callInMainThreadHelper.h @ 1:20d02a178406 default tip

*: check in everything else yay
author Paper <paper@tflc.us>
date Mon, 05 Jan 2026 02:15:46 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
1 #pragma once
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
2 #include <SDK/main_thread_callback.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
3
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
4 // ======================================================================================================
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
5 // Obsolete helpers - they still work, but it's easier to just use fb2k::inMainThread().
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
6 // ======================================================================================================
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
7
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
8
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
9 // Proxy class - friend this to allow callInMainThread to access your private methods
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
10 class callInMainThread {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
11 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
12 template<typename host_t, typename param_t>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
13 static void callThis(host_t * host, param_t & param) {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
14 host->inMainThread(param);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
15 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
16 template<typename host_t>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
17 static void callThis( host_t * host ) {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
18 host->inMainThread();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
19 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
20 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
21
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
22 // Internal class, do not use.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
23 template<typename service_t, typename param_t>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
24 class _callInMainThreadSvc_t : public main_thread_callback {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
25 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
26 _callInMainThreadSvc_t(service_t * host, param_t const & param) : m_host(host), m_param(param) {}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
27 void callback_run() {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
28 callInMainThread::callThis(m_host.get_ptr(), m_param);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
29 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
30 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
31 service_ptr_t<service_t> m_host;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
32 param_t m_param;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
33 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
34
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
35
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
36 // Main thread callback helper. You can use this to easily invoke inMainThread(someparam) on your class without writing any wrapper code.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
37 // Requires myservice_t to be a fb2k service class with reference counting.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
38 template<typename myservice_t, typename param_t>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
39 static void callInMainThreadSvc(myservice_t * host, param_t const & param) {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
40 typedef _callInMainThreadSvc_t<myservice_t, param_t> impl_t;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
41 service_ptr_t<impl_t> obj = new service_impl_t<impl_t>(host, param);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
42 main_thread_callback_manager::get()->add_callback( obj );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
43 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
44
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
45 //! Helper class to call methods of your class (host class) in main thread with convenience. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
46 //! Deals with the otherwise ugly scenario of your class becoming invalid while a method is queued. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
47 //! Have this as a member of your class, then use m_mthelper.add( this, somearg ) ; to defer a call to this->inMainThread(somearg). \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
48 //! If your class becomes invalid before inMainThread is executed, the pending callback is discarded. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
49 //! You can optionally call shutdown() to invalidate all pending callbacks early (in a destructor of your class - without waiting for callInMainThreadHelper destructor to do the job. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
50 //! In order to let callInMainThreadHelper access your private methods, declare friend class callInMainThread. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
51 //! Note that callInMainThreadHelper is expected to be created and destroyed in main thread.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
52 class callInMainThreadHelper {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
53 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
54
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
55 typedef std::function< void () > func_t;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
56
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
57 typedef pfc::rcptr_t< bool > killswitch_t;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
58
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
59 class entryFunc : public main_thread_callback {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
60 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
61 entryFunc( func_t const & func, killswitch_t ks ) : m_ks(ks), m_func(func) {}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
62
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
63 void callback_run() {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
64 if (!*m_ks) m_func();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
65 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
66
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
67 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
68 killswitch_t m_ks;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
69 func_t m_func;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
70 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
71
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
72 template<typename host_t, typename arg_t>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
73 class entry : public main_thread_callback {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
74 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
75 entry( host_t * host, arg_t const & arg, killswitch_t ks ) : m_ks(ks), m_host(host), m_arg(arg) {}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
76 void callback_run() {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
77 if (!*m_ks) callInMainThread::callThis( m_host, m_arg );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
78 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
79 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
80 killswitch_t m_ks;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
81 host_t * m_host;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
82 arg_t m_arg;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
83 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
84 template<typename host_t>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
85 class entryVoid : public main_thread_callback {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
86 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
87 entryVoid( host_t * host, killswitch_t ks ) : m_ks(ks), m_host(host) {}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
88 void callback_run() {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
89 if (!*m_ks) callInMainThread::callThis( m_host );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
90 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
91 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
92 killswitch_t m_ks;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
93 host_t * m_host;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
94 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
95
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
96 void add(func_t f) {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
97 add_( new service_impl_t< entryFunc > ( f, m_ks ) );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
98 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
99
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
100 template<typename host_t, typename arg_t>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
101 void add( host_t * host, arg_t const & arg) {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
102 add_( new service_impl_t< entry<host_t, arg_t> >( host, arg, m_ks ) );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
103 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
104 template<typename host_t>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
105 void add( host_t * host ) {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
106 add_( new service_impl_t< entryVoid<host_t> >( host, m_ks ) );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
107 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
108 void add_( main_thread_callback::ptr cb ) {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
109 main_thread_callback_add( cb );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
110 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
111
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
112 callInMainThreadHelper() {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
113 m_ks.new_t();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
114 * m_ks = false;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
115 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
116 void shutdown() {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
117 PFC_ASSERT( core_api::is_main_thread() );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
118 * m_ks = true;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
119 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
120 ~callInMainThreadHelper() {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
121 shutdown();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
122 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
123
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
124 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
125 killswitch_t m_ks;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
126
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
127 };