libs/pbd/pbd/abstract_ui.h

   1 /*
   2     Copyright (C) 1998-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_abstract_ui_h__
  21 #define __pbd_abstract_ui_h__
  22
  23 #include <map>
  24 #include <string>
  25 #include <pthread.h>
  26
  27 #include <glibmm/threads.h>
  28
  29 #include "pbd/libpbd_visibility.h"
  30 #include "pbd/receiver.h"
  31 #include "pbd/ringbufferNPT.h"
  32 #include "pbd/signals.h"
  33 #include "pbd/base_ui.h"
  34
  35 /* We have a special case in libpbd of a template class that gets instantiated
  36  * as the base class of several classes in other libraries. It is not possible
  37  * to use LIBFOO_API to mark this visible, because the FOO in each case is
  38  * different. So we define this generic visible/export/hidden/import pair
  39  * of macros to try to deal with this special case. These should NEVER be
  40  * used anywhere except AbstractUI<T> (or similar cases if they arise.
  41  *
  42  * Note the assumption here that other libs are being built as DLLs if this one is.
  43  */
  44
  45 #ifdef ABSTRACT_UI_EXPORTS
  46 #define ABSTRACT_UI_API LIBPBD_DLL_EXPORT
  47 #else
  48 #define ABSTRACT_UI_API LIBPBD_DLL_IMPORT
  49 #endif
  50
  51
  52 class Touchable;
  53
  54 template<typename RequestObject>
  55 class ABSTRACT_UI_API AbstractUI : public BaseUI
  56 {
  57   public:
  58         AbstractUI (const std::string& name);
  59         virtual ~AbstractUI() {}
  60
  61         void register_thread (pthread_t, std::string, uint32_t num_requests);
  62         void call_slot (EventLoop::InvalidationRecord*, const boost::function<void()>&);
  63         Glib::Threads::Mutex& slot_invalidation_mutex() { return request_buffer_map_lock; }
  64
  65         Glib::Threads::Mutex request_buffer_map_lock;
  66         Glib::Threads::Mutex request_invalidation_lock;
  67
  68         static void* request_buffer_factory (uint32_t num_requests);
  69
  70   protected:
  71         struct RequestBuffer : public PBD::RingBufferNPT<RequestObject> {
  72                 bool dead;
  73                 RequestBuffer (uint32_t size)
  74                         : PBD::RingBufferNPT<RequestObject> (size)
  75                         , dead (false) {}
  76         };
  77         typedef typename RequestBuffer::rw_vector RequestBufferVector;
  78
  79 #if defined(COMPILER_MINGW) && defined(PTW32_VERSION)
  80         struct pthread_cmp
  81         {
  82                 bool operator() (const ptw32_handle_t& thread1, const ptw32_handle_t& thread2)
  83                 {
  84                         return thread1.p < thread2.p;
  85                 }
  86         };
  87         typedef typename std::map<pthread_t,RequestBuffer*, pthread_cmp>::iterator RequestBufferMapIterator;
  88         typedef std::map<pthread_t,RequestBuffer*, pthread_cmp> RequestBufferMap;
  89 #else
  90         typedef typename std::map<pthread_t,RequestBuffer*>::iterator RequestBufferMapIterator;
  91         typedef std::map<pthread_t,RequestBuffer*> RequestBufferMap;
  92 #endif
  93
  94         RequestBufferMap request_buffers;
  95         static Glib::Threads::Private<RequestBuffer> per_thread_request_buffer;
  96
  97         Glib::Threads::Mutex               request_list_lock;
  98         std::list<RequestObject*> request_list;
  99
 100         RequestObject* get_request (RequestType);
 101         void handle_ui_requests ();
 102         void send_request (RequestObject *);
 103
 104         virtual void do_request (RequestObject *) = 0;
 105         PBD::ScopedConnection new_thread_connection;
 106 };
 107
 108 #endif /* __pbd_abstract_ui_h__ */