2 Copyright (C) 2000-2009 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __pbd_base_ui_h__
21 #define __pbd_base_ui_h__
26 #include <sigc++/slot.h>
27 #include <sigc++/trackable.h>
29 #include <glibmm/threads.h>
30 #include <glibmm/main.h>
32 #include "pbd/libpbd_visibility.h"
33 #include "pbd/crossthread.h"
34 #include "pbd/event_loop.h"
36 /** A BaseUI is an abstraction designed to be used with any "user
37 * interface" (not necessarily graphical) that needs to wait on
38 * events/requests and dispatch/process them as they arrive.
40 * This implementation starts up a thread that runs a Glib main loop
41 * to wait on events/requests etc.
45 class LIBPBD_API BaseUI : public sigc::trackable, public PBD::EventLoop
48 BaseUI (const std::string& name);
51 BaseUI* base_instance() { return base_ui_instance; }
53 Glib::RefPtr<Glib::MainLoop> main_loop() const { return _main_loop; }
54 Glib::Threads::Thread* event_loop_thread() const { return run_loop_thread; }
55 bool caller_is_self () const { return Glib::Threads::Thread::self() == run_loop_thread; }
57 std::string name() const { return _name; }
59 bool ok() const { return _ok; }
61 static RequestType new_request_type();
62 static RequestType CallSlot;
63 static RequestType Quit;
65 /** start up a thread to run the main loop
69 /** stop the thread running the main loop (and block
75 CrossThreadChannel request_channel;
78 Glib::RefPtr<Glib::MainLoop> _main_loop;
79 Glib::Threads::Thread* run_loop_thread;
80 Glib::Threads::Mutex _run_lock;
81 Glib::Threads::Cond _running;
83 /* this signals _running from within the event loop,
87 bool signal_running ();
89 /** Derived UI objects can implement thread_init()
90 * which will be called by the event loop thread
91 * immediately before it enters the event loop.
94 virtual void thread_init () {};
96 /** Called when there input ready on the request_channel
98 bool request_handler (Glib::IOCondition);
100 /** Derived UI objects must implement this method,
101 * which will be called whenever there are requests
104 virtual void handle_ui_requests () = 0;
108 BaseUI* base_ui_instance;
110 static uint64_t rt_bit;
112 int setup_request_pipe ();
116 #endif /* __pbd_base_ui_h__ */