src/lib/signal_manager.h

   1 /*
   2     Copyright (C) 2012-2021 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
  22 #ifndef DCPOMATIC_SIGNAL_MANAGER_H
  23 #define DCPOMATIC_SIGNAL_MANAGER_H
  24
  25
  26 #include "exception_store.h"
  27 #include <boost/asio.hpp>
  28 #include <boost/thread.hpp>
  29
  30
  31 class Signaller;
  32
  33
  34 /** A class to allow signals to be emitted from non-UI threads and handled
  35  *  by a UI thread.
  36  */
  37 class SignalManager : public ExceptionStore
  38 {
  39 public:
  40         /** Create a SignalManager.  Must be called from the UI thread */
  41         SignalManager ()
  42                 : _work (_service)
  43         {
  44                 _ui_thread = boost::this_thread::get_id ();
  45         }
  46
  47         virtual ~SignalManager () {}
  48
  49         SignalManager (Signaller const&) = delete;
  50         SignalManager& operator= (Signaller const&) = delete;
  51
  52         /* Do something next time the UI is idle */
  53         template <typename T>
  54         void when_idle (T f) {
  55                 _service.post (f);
  56         }
  57
  58         /** Call this in the UI when it is idle.
  59          *  @return Number of idle handlers that were executed.
  60          */
  61         size_t ui_idle () {
  62                 /* This executes one of the functors that has been post()ed to _service */
  63                 return _service.poll_one ();
  64         }
  65
  66         /** This should wake the UI and make it call ui_idle() */
  67         virtual void wake_ui () {
  68                 /* This is only a sensible implementation when there is no GUI */
  69                 ui_idle ();
  70         }
  71
  72 private:
  73         /** Emit a signal from any thread whose handlers will be called in the UI
  74          *  thread.  Use something like:
  75          *
  76          *  ui_signaller->emit (boost::bind (boost::ref (SomeSignal), parameter));
  77          */
  78         template <typename T>
  79         void emit (T f) {
  80                 if (boost::this_thread::get_id() == _ui_thread) {
  81                         /* already in the UI thread */
  82                         try {
  83                                 f ();
  84                         } catch (...) {
  85                                 store_current ();
  86                         }
  87                 } else {
  88                         /* non-UI thread; post to the service and wake up the UI */
  89                         _service.post (f);
  90                         wake_ui ();
  91                 }
  92         }
  93
  94         friend class Signaller;
  95
  96         /** A io_service which is used as the conduit for messages */
  97         boost::asio::io_service _service;
  98         /** Object required to keep io_service from stopping when it has nothing to do */
  99         boost::asio::io_service::work _work;
 100         /** The UI thread's ID */
 101         boost::thread::id _ui_thread;
 102 };
 103
 104
 105 extern SignalManager* signal_manager;
 106
 107
 108 #endif