src/lib/signal_manager.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_SIGNAL_MANAGER_H
  22 #define DCPOMATIC_SIGNAL_MANAGER_H
  23
  24 #include <boost/asio.hpp>
  25 #include <boost/thread.hpp>
  26
  27 class Signaller;
  28
  29 /** A class to allow signals to be emitted from non-UI threads and handled
  30  *  by a UI thread.
  31  */
  32 class SignalManager : public boost::noncopyable
  33 {
  34 public:
  35         /** Create a SignalManager.  Must be called from the UI thread */
  36         SignalManager ()
  37                 : _work (_service)
  38         {
  39                 _ui_thread = boost::this_thread::get_id ();
  40         }
  41
  42         virtual ~SignalManager () {}
  43
  44         /* Do something next time the UI is idle */
  45         template <typename T>
  46         void when_idle (T f) {
  47                 _service.post (f);
  48         }
  49
  50         /** Call this in the UI when it is idle.
  51          *  @return Number of idle handlers that were executed.
  52          */
  53         size_t ui_idle () {
  54                 /* This executes one of the functors that has been post()ed to _service */
  55                 return _service.poll_one ();
  56         }
  57
  58         /** This should wake the UI and make it call ui_idle() */
  59         virtual void wake_ui () {
  60                 /* This is only a sensible implementation when there is no GUI */
  61                 ui_idle ();
  62         }
  63
  64 private:
  65         /** Emit a signal from any thread whose handlers will be called in the UI
  66          *  thread.  Use something like:
  67          *
  68          *  ui_signaller->emit (boost::bind (boost::ref (SomeSignal), parameter));
  69          */
  70         template <typename T>
  71         void emit (T f) {
  72                 if (boost::this_thread::get_id() == _ui_thread) {
  73                         /* already in the UI thread */
  74                         f ();
  75                 } else {
  76                         /* non-UI thread; post to the service and wake up the UI */
  77                         _service.post (f);
  78                         wake_ui ();
  79                 }
  80         }
  81
  82         friend class Signaller;
  83
  84         /** A io_service which is used as the conduit for messages */
  85         boost::asio::io_service _service;
  86         /** Object required to keep io_service from stopping when it has nothing to do */
  87         boost::asio::io_service::work _work;
  88         /** The UI thread's ID */
  89         boost::thread::id _ui_thread;
  90 };
  91
  92 extern SignalManager* signal_manager;
  93
  94 #endif