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 0928512841231afca93c4aaf22dafdc3d6b419cc..ea1afbbb5a3428e84fd4cc9b4fe0a02db45d2597 100644 (file)
--- a/libs/pbd/pbd/base_ui.h
+++ b/libs/pbd/pbd/base_ui.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2007 Paul Davis 
+    Copyright (C) 2000-2009 Paul Davis 
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -26,40 +26,103 @@
 #include <sigc++/slot.h>
 #include <sigc++/trackable.h>
 
-class BaseUI : virtual public sigc::trackable {
+#include <glibmm/threads.h>
+#include <glibmm/main.h>
+
+#include "pbd/libpbd_visibility.h"
+#include "pbd/crossthread.h"
+#include "pbd/event_loop.h"
+
+/** 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 (std::string name, bool with_signal_pipes);
+       BaseUI (const std::string& name);
        virtual ~BaseUI();
 
        BaseUI* base_instance() { return base_ui_instance; }
 
+       Glib::RefPtr<Glib::MainLoop> main_loop() const { return _main_loop; }
+        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:
-       int signal_pipe[2];
        bool _ok; 
 
+       Glib::RefPtr<Glib::MainLoop> _main_loop;
+       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;
 
-       static uint32_t rt_bit;
+#ifndef PLATFORM_WINDOWS
+       CrossThreadChannel request_channel;
+#endif
+       
+       static uint64_t rt_bit;
 
-       int setup_signal_pipe ();
+       int setup_request_pipe ();
+       void main_thread ();
 };
 
 #endif /* __pbd_base_ui_h__ */