libs/pbd/pbd/base_ui.h

   1 /*
   2     Copyright (C) 2000-2009 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __pbd_base_ui_h__
  21 #define __pbd_base_ui_h__
  22
  23 #include <string>
  24 #include <stdint.h>
  25
  26 #include <sigc++/slot.h>
  27 #include <sigc++/trackable.h>
  28
  29 #include <glibmm/threads.h>
  30 #include <glibmm/main.h>
  31
  32 #include "pbd/libpbd_visibility.h"
  33 #include "pbd/crossthread.h"
  34 #include "pbd/event_loop.h"
  35 #include "pbd/pthread_utils.h"
  36
  37 /** A BaseUI is an abstraction designed to be used with any "user
  38  * interface" (not necessarily graphical) that needs to wait on
  39  * events/requests and dispatch/process them as they arrive.
  40  *
  41  * This implementation starts up a thread that runs a Glib main loop
  42  * to wait on events/requests etc.
  43  */
  44
  45
  46 class LIBPBD_API BaseUI : public sigc::trackable, public PBD::EventLoop
  47 {
  48   public:
  49         BaseUI (const std::string& name);
  50         virtual ~BaseUI();
  51
  52         BaseUI* base_instance() { return base_ui_instance; }
  53
  54         Glib::RefPtr<Glib::MainLoop> main_loop() const { return _main_loop; }
  55         Glib::Threads::Thread* event_loop_thread() const { return run_loop_thread; }
  56         bool caller_is_self () const { return Glib::Threads::Thread::self() == run_loop_thread; }
  57
  58         bool ok() const { return _ok; }
  59
  60         static RequestType new_request_type();
  61         static RequestType CallSlot;
  62         static RequestType Quit;
  63
  64         /** start up a thread to run the main loop
  65          */
  66         void run ();
  67
  68         /** stop the thread running the main loop (and block
  69          *   until it exits)
  70          */
  71         void quit ();
  72
  73   protected:
  74         bool _ok;
  75
  76         Glib::RefPtr<Glib::MainLoop> _main_loop;
  77         Glib::RefPtr<Glib::MainContext> m_context;
  78         Glib::Threads::Thread*       run_loop_thread;
  79         Glib::Threads::Mutex        _run_lock;
  80         Glib::Threads::Cond         _running;
  81
  82         /* this signals _running from within the event loop,
  83            from an idle callback
  84         */
  85
  86         bool signal_running ();
  87
  88         /** Derived UI objects can implement thread_init()
  89          * which will be called by the event loop thread
  90          * immediately before it enters the event loop.
  91          */
  92
  93         virtual void thread_init () {};
  94
  95         int set_thread_priority (const int policy = PBD_SCHED_FIFO, int priority = 0) const;
  96
  97         /** Called when there input ready on the request_channel
  98          */
  99         bool request_handler (Glib::IOCondition);
 100
 101         void signal_new_request ();
 102         void attach_request_source ();
 103
 104         /** Derived UI objects must implement this method,
 105          * which will be called whenever there are requests
 106          * to be dealt with.
 107          */
 108         virtual void handle_ui_requests () = 0;
 109
 110   private:
 111         BaseUI* base_ui_instance;
 112
 113         CrossThreadChannel request_channel;
 114
 115         static uint64_t rt_bit;
 116
 117         int setup_request_pipe ();
 118         void main_thread ();
 119 };
 120
 121 #endif /* __pbd_base_ui_h__ */