libs/gtkmm2ext/gtkmm2ext/gtk_ui.h

   1 /*
   2     Copyright (C) 1999 Paul Barton-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_gtk_ui_h__
  21 #define __pbd_gtk_ui_h__
  22
  23 #include <string>
  24 #include <queue>
  25 #include <map>
  26
  27 #include <stdint.h>
  28 #include <setjmp.h>
  29 #include <pthread.h>
  30 #include <gtkmm/widget.h>
  31 #include <gtkmm/style.h>
  32 #include <gtkmm/textbuffer.h>
  33 #include <gtkmm/main.h>
  34 #include <gdkmm/color.h>
  35 #include <pbd/abstract_ui.h>
  36 #include <pbd/ringbufferNPT.h>
  37
  38 #include <pbd/pool.h>
  39 #include <pbd/error.h>
  40 #include <pbd/receiver.h>
  41
  42 using std::string;
  43 using std::queue;
  44
  45 class Touchable;
  46
  47 namespace Gtkmm2ext {
  48
  49 class TextViewer;
  50
  51 extern BaseUI::RequestType ErrorMessage;
  52 extern BaseUI::RequestType Quit;
  53 extern BaseUI::RequestType CallSlot;
  54 extern BaseUI::RequestType TouchDisplay;
  55 extern BaseUI::RequestType StateChange;
  56 extern BaseUI::RequestType SetTip;
  57 extern BaseUI::RequestType AddIdle;
  58 extern BaseUI::RequestType AddTimeout;
  59
  60 struct UIRequest : public BaseUI::BaseRequestObject {
  61
  62      /* this once used anonymous unions to merge elements
  63         that are never part of the same request. that makes
  64         the creation of a legal copy constructor difficult
  65         because of the semantics of the slot member.
  66      */
  67
  68     Touchable *display;
  69     const char *msg;
  70     Gtk::StateType new_state;
  71     int (*function)(void *);
  72     Gtk::Widget *widget;
  73     Transmitter::Channel chn;
  74     void *arg;
  75     const char *msg2;
  76     sigc::slot<void> slot;
  77
  78     ~UIRequest () {
  79             if (type == ErrorMessage && msg) {
  80                     /* msg was strdup()'ed */
  81                     free ((char *)msg);
  82             }
  83     }
  84  };
  85
  86 class UI : public Receiver, public AbstractUI<UIRequest>
  87 {
  88   public:
  89         UI (string name, int *argc, char **argv[]);
  90         virtual ~UI ();
  91
  92         static UI *instance() { return theGtkUI; }
  93
  94         /* receiver interface */
  95
  96         void receive (Transmitter::Channel, const char *);
  97
  98         /* Abstract UI interfaces */
  99
 100         bool caller_is_ui_thread ();
 101
 102         static pthread_t thread_id() { return gui_thread; }
 103
 104         /* Gtk-UI specific interfaces */
 105
 106         bool running ();
 107         void quit    ();
 108         void kill    ();
 109         int  load_rcfile (string, bool themechange = false);
 110         void run (Receiver &old_receiver);
 111
 112         void set_state (Gtk::Widget *w, Gtk::StateType state);
 113         void popup_error (const char *text);
 114         void flush_pending ();
 115         void toggle_errors ();
 116         void touch_display (Touchable *);
 117         void set_tip (Gtk::Widget *w, const gchar *tip, const gchar *hlp);
 118         void idle_add (int (*func)(void *), void *arg);
 119
 120         template<class T> static bool idle_delete (T *obj) { delete obj; return false; }
 121         template<class T> static void delete_when_idle (T *obj) {
 122                 Glib::signal_idle().connect (bind (slot (&UI::idle_delete<T>), obj));
 123         }
 124
 125         Gdk::Color get_color (const string& prompt, bool& picked, const Gdk::Color *initial = 0);
 126
 127         /* starting is sent just before we enter the main loop,
 128            stopping just after we return from it (at the top level)
 129         */
 130
 131         sigc::signal<void> starting;
 132         sigc::signal<void> stopping;
 133
 134         sigc::signal<void> theme_changed;
 135
 136         static bool just_hide_it (GdkEventAny *, Gtk::Window *);
 137
 138         static pthread_t the_gui_thread() { return gui_thread; }
 139
 140   protected:
 141         virtual void handle_fatal (const char *);
 142         virtual void display_message (const char *prefix, gint prefix_len,
 143                                       Glib::RefPtr<Gtk::TextBuffer::Tag> ptag,
 144                                       Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
 145                                       const char *msg);
 146
 147   private:
 148         static UI *theGtkUI;
 149         static pthread_t gui_thread;
 150         bool _active;
 151         Gtk::Main *theMain;
 152         TextViewer *errors;
 153         Glib::RefPtr<Gtk::TextBuffer::Tag> error_ptag;
 154         Glib::RefPtr<Gtk::TextBuffer::Tag> error_mtag;
 155         Glib::RefPtr<Gtk::TextBuffer::Tag> fatal_ptag;
 156         Glib::RefPtr<Gtk::TextBuffer::Tag> fatal_mtag;
 157         Glib::RefPtr<Gtk::TextBuffer::Tag> info_ptag;
 158         Glib::RefPtr<Gtk::TextBuffer::Tag> info_mtag;
 159         Glib::RefPtr<Gtk::TextBuffer::Tag> warning_ptag;
 160         Glib::RefPtr<Gtk::TextBuffer::Tag> warning_mtag;
 161
 162         static void signal_pipe_callback (void *, gint, GdkInputCondition);
 163         void process_error_message (Transmitter::Channel, const char *);
 164         void do_quit ();
 165
 166         void color_selection_done (bool status);
 167         bool color_selection_deleted (GdkEventAny *);
 168         bool color_picked;
 169
 170         void do_request (UIRequest*);
 171 };
 172
 173 } /* namespace */
 174
 175 #endif /* __pbd_gtk_ui_h__ */