src/lib/ui_signaller.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   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 DCPOMATIC_UI_SIGNALLER_H
  21 #define DCPOMATIC_UI_SIGNALLER_H
  22
  23 #include <boost/bind.hpp>
  24 #include <boost/asio.hpp>
  25 #include <boost/thread.hpp>
  26
  27 /** A class to allow signals to be emitted from non-UI threads and handled
  28  *  by a UI thread.
  29  */
  30 class UISignaller : public boost::noncopyable
  31 {
  32 public:
  33         /** Create a UISignaller.  Must be called from the UI thread */
  34         UISignaller ()
  35                 : _work (_service)
  36         {
  37                 _ui_thread = boost::this_thread::get_id ();
  38         }
  39
  40         /** Emit a signal from any thread whose handlers will be called in the UI
  41          *  thread.  Use something like:
  42          *
  43          *  ui_signaller->emit (boost::bind (boost::ref (SomeSignal), parameter));
  44          */
  45         template <typename T>
  46         void emit (T f) {
  47                 if (boost::this_thread::get_id() == _ui_thread) {
  48                         /* already in the UI thread */
  49                         f ();
  50                 } else {
  51                         /* non-UI thread; post to the service and wake up the UI */
  52                         _service.post (f);
  53                         wake_ui ();
  54                 }
  55         }
  56
  57         /* Do something next time the UI is idle */
  58         template <typename T>
  59         void when_idle (T f) {
  60                 _service.post (f);
  61         }
  62
  63         /** Call this in the UI when it is idle */
  64         size_t ui_idle () {
  65                 /* This executes any functors that have been post()ed to _service */
  66                 return _service.poll ();
  67         }
  68
  69         /** This should wake the UI and make it call ui_idle() */
  70         virtual void wake_ui () {
  71                 /* This is only a sensible implementation when there is no GUI... */
  72                 ui_idle ();
  73         }
  74
  75 private:
  76         /** A io_service which is used as the conduit for messages */
  77         boost::asio::io_service _service;
  78         /** Object required to keep io_service from stopping when it has nothing to do */
  79         boost::asio::io_service::work _work;
  80         /** The UI thread's ID */
  81         boost::thread::id _ui_thread;
  82 };
  83
  84 extern UISignaller* ui_signaller;
  85
  86 #endif