X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fpbd%2Fpbd%2Fbase_ui.h;h=186a3c55a659e346c7e723d5a2ba4f457adf5623;hb=ff2fac11a03b7e13149b5069fda2bbc21cdd4e80;hp=b4570f87076bfec2d7686056ddcf13f7ba8cb3fd;hpb=481f7c39655afec832ac10430dd61a3bb464aa58;p=ardour.git diff --git a/libs/pbd/pbd/base_ui.h b/libs/pbd/pbd/base_ui.h index b4570f8707..186a3c55a6 100644 --- a/libs/pbd/pbd/base_ui.h +++ b/libs/pbd/pbd/base_ui.h @@ -1,3 +1,22 @@ +/* + 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 + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +*/ + #ifndef __pbd_base_ui_h__ #define __pbd_base_ui_h__ @@ -7,40 +26,90 @@ #include #include -class BaseUI : virtual public sigc::trackable { +#include +#include + +#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 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 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 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]; + CrossThreadChannel request_channel; bool _ok; + Glib::RefPtr _main_loop; + 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: std::string _name; BaseUI* base_ui_instance; + + static uint64_t rt_bit; - static uint32_t rt_bit; - - int setup_signal_pipe (); + int setup_request_pipe (); + void main_thread (); }; #endif /* __pbd_base_ui_h__ */