X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fpbd%2Fpbd%2Fbase_ui.h;h=186a3c55a659e346c7e723d5a2ba4f457adf5623;hb=ff2fac11a03b7e13149b5069fda2bbc21cdd4e80;hp=614873e5d1110fc9dff3b4b32856257cbd5ee589;hpb=c38e02285fda1fd7966c9e4ad85994445247e6a6;p=ardour.git

diff --git a/libs/pbd/pbd/base_ui.h b/libs/pbd/pbd/base_ui.h
index 614873e5d1..186a3c55a6 100644
--- 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,12 +26,23 @@
 #include <sigc++/slot.h>
 #include <sigc++/trackable.h>
 
-#include <glibmm/thread.h>
+#include <glibmm/threads.h>
 #include <glibmm/main.h>
 
 #include "pbd/crossthread.h"
+#include "pbd/event_loop.h"
 
-class BaseUI : virtual public sigc::trackable {
+/** 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 BaseUI : public sigc::trackable, public PBD::EventLoop
+{
   public:
 	BaseUI (const std::string& name);
 	virtual ~BaseUI();
@@ -39,40 +50,56 @@ class BaseUI : virtual public sigc::trackable {
 	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 ();
-	void quit ();
 
-	virtual void call_slot (sigc::slot<void> theSlot) = 0;
+	/** 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::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 () {};
+
+	/** Called when there input ready on the request_channel
+	 */
 	bool request_handler (Glib::IOCondition);
 
+	/** 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: