Merge remote-tracking branch 'remotes/origin/exportvis' into windows+cc

[ardour.git] / libs / pbd / pbd / base_ui.h

diff --git a/libs/pbd/pbd/base_ui.h b/libs/pbd/pbd/base_ui.h
index 20534aa7fd9d933f78370de11c7dbb90dc005c42..ea1afbbb5a3428e84fd4cc9b4fe0a02db45d2597 100644 (file)
--- a/libs/pbd/pbd/base_ui.h
+++ b/libs/pbd/pbd/base_ui.h
@@ -26,13 +26,23 @@
 #include <sigc++/slot.h>
 #include <sigc++/trackable.h>
 
-#include <glibmm/thread.h>
+#include <glibmm/threads.h>
 #include <glibmm/main.h>
 
+#include "pbd/libpbd_visibility.h"
 #include "pbd/crossthread.h"
-#include "pbd/ui_callback.h"
+#include "pbd/event_loop.h"
 
-class BaseUI : virtual public sigc::trackable, public PBD::UICallback 
+/** A BaseUI is an abstraction designed to be used with any "user
+ * interface" (not necessarily graphical) that needs to wait on
+ * events/requests and dispatch/process them as they arrive.
+ *
+ * This implementation starts up a thread that runs a Glib main loop
+ * to wait on events/requests etc. 
+ */
+
+
+class LIBPBD_API BaseUI : public sigc::trackable, public PBD::EventLoop
 {
   public:
        BaseUI (const std::string& name);
@@ -41,44 +51,73 @@ class BaseUI : virtual public sigc::trackable, public PBD::UICallback
        BaseUI* base_instance() { return base_ui_instance; }
 
        Glib::RefPtr<Glib::MainLoop> main_loop() const { return _main_loop; }
-       Glib::Thread* event_loop_thread() const { return run_loop_thread; }
-       bool caller_is_self () const { return Glib::Thread::self() == run_loop_thread; }
+        Glib::Threads::Thread* event_loop_thread() const { return run_loop_thread; }
+        bool caller_is_self () const { return Glib::Threads::Thread::self() == run_loop_thread; }
 
        std::string name() const { return _name; }
 
        bool ok() const { return _ok; }
        
-       enum RequestType {
-               range_guarantee = ~0
-       };
-
-       struct BaseRequestObject {
-           RequestType type;
-           sigc::slot<void> the_slot;
-       };
-
        static RequestType new_request_type();
        static RequestType CallSlot;
        static RequestType Quit;
 
+       /** start up a thread to run the main loop 
+        */
        void run ();
+
+       /** stop the thread running the main loop (and block
+        *   until it exits)
+        */
        void quit ();
 
   protected:
-       CrossThreadChannel request_channel;
        bool _ok; 
 
        Glib::RefPtr<Glib::MainLoop> _main_loop;
-       Glib::Thread*                 run_loop_thread;
+       Glib::RefPtr<Glib::MainContext> m_context;
+       Glib::Threads::Thread*       run_loop_thread;
+       Glib::Threads::Mutex        _run_lock;
+       Glib::Threads::Cond         _running;
+
+       /* this signals _running from within the event loop,
+          from an idle callback 
+       */
+
+       bool signal_running ();
+
+       /** Derived UI objects can implement thread_init()
+        * which will be called by the event loop thread
+        * immediately before it enters the event loop.
+        */
 
        virtual void thread_init () {};
+
+#ifdef PLATFORM_WINDOWS
+       static gboolean _request_handler (gpointer);
+       bool request_handler ();
+#else
+       /** Called when there input ready on the request_channel
+        */
        bool request_handler (Glib::IOCondition);
+#endif
 
+       void signal_new_request ();
+       void attach_request_source ();
+
+       /** Derived UI objects must implement this method,
+        * which will be called whenever there are requests
+        * to be dealt with.
+        */
        virtual void handle_ui_requests () = 0;
 
   private:
        std::string _name; 
        BaseUI* base_ui_instance;
+
+#ifndef PLATFORM_WINDOWS
+       CrossThreadChannel request_channel;
+#endif
        
        static uint64_t rt_bit;