remove duplicate/wrong includes in last commit.
[ardour.git] / libs / gtkmm2ext / gtk_ui.cc
index 722b6a15ef11c18c50a3d5fa719eb67d2c10f4fb..4ca23b024088ec7f9eb0337e38848d366f13d97e 100644 (file)
 #include <pbd/touchable.h>
 #include <pbd/failed_constructor.h>
 #include <pbd/pthread_utils.h>
+#include <pbd/stacktrace.h>
 
 #include <gtkmm2ext/gtk_ui.h>
 #include <gtkmm2ext/textviewer.h>
 #include <gtkmm2ext/popup.h>
 #include <gtkmm2ext/utils.h>
+#include <gtkmm2ext/window_title.h>
 
 #include "i18n.h"
 
 using namespace Gtkmm2ext;
 using namespace Gtk;
 using namespace Glib;
+using namespace PBD;
 using std::map;
 
 pthread_t UI::gui_thread;
 UI       *UI::theGtkUI = 0;
 
-UI::UI (string name, int *argc, char ***argv, string rcfile) 
-       : _ui_name (name)
-{
-       theMain = new Main (argc, argv);
-       tips = new Tooltips;
+BaseUI::RequestType Gtkmm2ext::ErrorMessage = BaseUI::new_request_type();
+BaseUI::RequestType Gtkmm2ext::Quit = BaseUI::new_request_type();
+BaseUI::RequestType Gtkmm2ext::TouchDisplay = BaseUI::new_request_type();
+BaseUI::RequestType Gtkmm2ext::StateChange = BaseUI::new_request_type();
+BaseUI::RequestType Gtkmm2ext::SetTip = BaseUI::new_request_type();
+BaseUI::RequestType Gtkmm2ext::AddIdle = BaseUI::new_request_type();
+BaseUI::RequestType Gtkmm2ext::AddTimeout = BaseUI::new_request_type();
 
-       if (pthread_key_create (&thread_request_buffer_key, 0)) {
-               cerr << _("cannot create thread request buffer key") << endl;
-               throw failed_constructor();
-       }
+#include <pbd/abstract_ui.cc>  /* instantiate the template */
 
-       PBD::ThreadCreated.connect (mem_fun (*this, &UI::register_thread));
 
-       _ok = false;
+UI::UI (string namestr, int *argc, char ***argv) 
+       : AbstractUI<UIRequest> (namestr, true)
+{
+       theMain = new Main (argc, argv);
+
        _active = false;
 
        if (!theGtkUI) {
@@ -71,37 +76,44 @@ UI::UI (string name, int *argc, char ***argv, string rcfile)
                /* NOTREACHED */
        }
 
-       if (setup_signal_pipe ()) {
-               return;
-       }
+       /* add the pipe to the select/poll loop that GDK does */
+
+       gdk_input_add (signal_pipe[0],
+                      GDK_INPUT_READ,
+                      UI::signal_pipe_callback,
+                      this);
 
        errors = new TextViewer (850,100);
        errors->text().set_editable (false); 
        errors->text().set_name ("ErrorText");
 
-       string title;
-       title = _ui_name;
-       title += ": Log";
-       errors->set_title (title);
+       Glib::set_application_name(namestr);
+
+       WindowTitle title(Glib::get_application_name());
+       title += _("Log");
+       errors->set_title (title.get_string());
 
        errors->dismiss_button().set_name ("ErrorLogCloseButton");
-       errors->signal_delete_event().connect (bind (ptr_fun (just_hide_it), (Window *) errors));
+       errors->signal_delete_event().connect (bind (sigc::ptr_fun (just_hide_it), (Window *) errors));
 
        register_thread (pthread_self(), X_("GUI"));
 
-       load_rcfile (rcfile);
-
-       _ok = true;
+       //load_rcfile (rcfile);
 }
 
 UI::~UI ()
 {
-       close (signal_pipe[0]);
-       close (signal_pipe[1]);
+}
+
+
+bool
+UI::caller_is_ui_thread ()
+{
+       return pthread_equal (gui_thread, pthread_self());
 }
 
 int
-UI::load_rcfile (string path)
+UI::load_rcfile (string path, bool themechange)
 {
        if (path.length() == 0) {
                return -1;
@@ -116,6 +128,13 @@ UI::load_rcfile (string path)
        }
        
        RC rc (path.c_str());
+       // RC::reset_styles (Gtk::Settings::get_default());
+       gtk_rc_reset_styles (gtk_settings_get_default());
+       theme_changed.emit();
+
+       if (themechange) {
+               return 0; //Don't continue on every time there is a theme change
+       }
 
        /* have to pack widgets into a toplevel window so that styles will stick */
 
@@ -224,12 +243,17 @@ UI::kill ()
 void
 UI::quit ()
 {
-       request (Quit);
+       UIRequest *req = get_request (Quit);
+
+       if (req == 0) {
+               return;
+       }
+
+       send_request (req);
 }
 
 static bool idle_quit ()
 {
-       cerr << "idle quit, level = " << Main::level() << endl;
        Main::quit ();
        return true;
 }
@@ -237,19 +261,17 @@ static bool idle_quit ()
 void
 UI::do_quit ()
 {
-       Glib::signal_idle().connect (sigc::ptr_fun (idle_quit));
-}
-
-int
-UI::set_quit_context()
-{
-       return setjmp (quit_context);
+       if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
+               Main::quit ();
+       } else {
+               Glib::signal_idle().connect (sigc::ptr_fun (idle_quit));
+       }
 }
 
 void
 UI::touch_display (Touchable *display)
 {
-       Request *req = get_request (TouchDisplay);
+       UIRequest *req = get_request (TouchDisplay);
 
        if (req == 0) {
                return;
@@ -260,52 +282,10 @@ UI::touch_display (Touchable *display)
        send_request (req);
 }      
 
-void
-UI::call_slot (sigc::slot<void> slot)
-{
-       Request *req = get_request (CallSlot);
-
-       if (req == 0) {
-               return;
-       }
-
-       req->slot = slot;
-
-       send_request (req);
-}      
-
-void
-UI::call_slot_locked (sigc::slot<void> slot)
-{
-       if (caller_is_gui_thread()) {
-               call_slot (slot);
-               return;
-       }
-
-       Request *req = get_request (CallSlotLocked);
-
-       if (req == 0) {
-               return;
-       }
-
-       req->slot = slot;
-
-       pthread_mutex_init (&req->slot_lock, NULL);
-       pthread_cond_init (&req->slot_cond, NULL);
-       pthread_mutex_lock (&req->slot_lock);
-
-       send_request (req);
-
-       pthread_cond_wait (&req->slot_cond, &req->slot_lock);
-       pthread_mutex_unlock (&req->slot_lock);
-
-       delete req;
-}      
-
 void
 UI::set_tip (Widget *w, const gchar *tip, const gchar *hlp)
 {
-       Request *req = get_request (SetTip);
+       UIRequest *req = get_request (SetTip);
 
        if (req == 0) {
                return;
@@ -321,7 +301,7 @@ UI::set_tip (Widget *w, const gchar *tip, const gchar *hlp)
 void
 UI::set_state (Widget *w, StateType state)
 {
-       Request *req = get_request (StateChange);
+       UIRequest *req = get_request (StateChange);
        
        if (req == 0) {
                return;
@@ -336,7 +316,7 @@ UI::set_state (Widget *w, StateType state)
 void
 UI::idle_add (int (*func)(void *), void *arg)
 {
-       Request *req = get_request (AddIdle);
+       UIRequest *req = get_request (AddIdle);
 
        if (req == 0) {
                return;
@@ -348,118 +328,8 @@ UI::idle_add (int (*func)(void *), void *arg)
        send_request (req);
 }
 
-void
-UI::timeout_add (unsigned int timeout, int (*func)(void *), void *arg)
-{
-       Request *req = get_request (AddTimeout);
-
-       if (req == 0) {
-               return;
-       }
-
-       req->function = func;
-       req->arg = arg;
-       req->timeout = timeout;
-
-       send_request (req);
-}
-
 /* END abstract_ui interfaces */
 
-/* Handling requests */
-
-void
-UI::register_thread (pthread_t thread_id, string name)
-{
-       RingBufferNPT<Request>* b = new RingBufferNPT<Request> (128);
-
-       {
-               PBD::LockMonitor lm (request_buffer_map_lock, __LINE__, __FILE__);
-               request_buffers[thread_id] = b;
-       }
-
-       pthread_setspecific (thread_request_buffer_key, b);
-}
-
-UI::Request::Request()
-{
-
-}
-
-UI::Request*
-UI::get_request (RequestType rt)
-{
-       RingBufferNPT<Request>* rbuf = static_cast<RingBufferNPT<Request>* >(pthread_getspecific (thread_request_buffer_key));
-
-       if (rbuf == 0) {
-               /* Cannot happen, but if it does we can't use the error reporting mechanism */
-               cerr << _("programming error: ")
-                    << string_compose (X_("no GUI request buffer found for thread %1"), pthread_self())
-                    << endl;
-               abort ();
-       }
-       
-       RingBufferNPT<Request>::rw_vector vec;
-       
-       rbuf->get_write_vector (&vec);
-
-       if (vec.len[0] == 0) {
-               if (vec.len[1] == 0) {
-                       cerr << string_compose (X_("no space in GUI request buffer for thread %1"), pthread_self())
-                            << endl;
-                       return 0;
-               } else {
-                       vec.buf[1]->type = rt;
-                       return vec.buf[1];
-               }
-       } else {
-               vec.buf[0]->type = rt;
-               return vec.buf[0];
-       }
-}
-
-int
-UI::setup_signal_pipe ()
-{
-       /* setup the pipe that other threads send us notifications/requests
-          through.
-       */
-
-       if (pipe (signal_pipe)) {
-               error << "UI: cannot create error signal pipe ("
-                     << std::strerror (errno) << ")" 
-                     << endmsg;
-
-               return -1;
-       }
-
-       if (fcntl (signal_pipe[0], F_SETFL, O_NONBLOCK)) {
-               error << "UI: cannot set O_NONBLOCK on "
-                        "signal read pipe ("
-                     << std::strerror (errno) << ")"
-                     << endmsg;
-               return -1;
-       }
-
-       if (fcntl (signal_pipe[1], F_SETFL, O_NONBLOCK)) {
-               error << "UI: cannot set O_NONBLOCK on "
-                        "signal write pipe ("
-                     << std::strerror (errno) 
-                     << ")" 
-                     << endmsg;
-               return -1;
-       }
-
-       /* add the pipe to the select/poll loop that GDK does */
-
-       gdk_input_add (signal_pipe[0],
-                      GDK_INPUT_READ,
-                      UI::signal_pipe_callback,
-                      this);
-
-       return 0;
-}
-
 void
 UI::signal_pipe_callback (void *arg, int fd, GdkInputCondition cond)
 {
@@ -473,144 +343,43 @@ UI::signal_pipe_callback (void *arg, int fd, GdkInputCondition cond)
 }
 
 void
-UI::handle_ui_requests ()
+UI::do_request (UIRequest* req)
 {
-       RequestBufferMap::iterator i;
-
-       request_buffer_map_lock.lock ();
-
-       for (i = request_buffers.begin(); i != request_buffers.end(); ++i) {
-
-               RingBufferNPT<Request>::rw_vector vec;
-
-               while (true) {
-
-                       /* we must process requests 1 by 1 because
-                          the request may run a recursive main
-                          event loop that will itself call
-                          handle_ui_requests. when we return
-                          from the request handler, we cannot
-                          expect that the state of queued requests
-                          is even remotely consistent with
-                          the condition before we called it.
-                       */
-
-                       i->second->get_read_vector (&vec);
-
-                       if (vec.len[0] == 0) {
-                               break;
-                       } else {
-                               /* copy constructor does a deep
-                                  copy of the Request object,
-                                  unlike Ringbuffer::read()
-                               */
-                               Request req (*vec.buf[0]);
-                               i->second->increment_read_ptr (1);
-                               request_buffer_map_lock.unlock ();
-                               do_request (&req);
-                               request_buffer_map_lock.lock ();
-                       } 
-               }
-       }
-
-       request_buffer_map_lock.unlock ();
-}
+       if (req->type == ErrorMessage) {
 
-void
-UI::do_request (Request* req)
-{
-       switch (req->type) {
-       case ErrorMessage:
                process_error_message (req->chn, req->msg);
                free (const_cast<char*>(req->msg)); /* it was strdup'ed */
-               break;
-               
-       case Quit:
+               req->msg = 0; /* don't free it again in the destructor */
+
+       } else if (req->type == Quit) {
+
                do_quit ();
-               break;
-               
-       case CallSlot:
-               req->slot ();
-               break;
 
-       case CallSlotLocked:
-               pthread_mutex_lock (&req->slot_lock);
+       } else if (req->type == CallSlot) {
+
                req->slot ();
-               pthread_cond_signal (&req->slot_cond);
-               pthread_mutex_unlock (&req->slot_lock);
-               break;
-               
-       case TouchDisplay:
+
+       } else if (req->type == TouchDisplay) {
+
                req->display->touch ();
                if (req->display->delete_after_touch()) {
                        delete req->display;
                }
-               break;
-               
-       case StateChange:
+
+       } else if (req->type == StateChange) {
+
                req->widget->set_state (req->new_state);
-               break;
-               
-       case SetTip:
-               /* XXX need to figure out how this works */
-               break;
-               
-       case AddIdle:
-               gtk_idle_add (req->function, req->arg);
-               break;
-               
-       case AddTimeout:
-               gtk_timeout_add (req->timeout, req->function, req->arg);
-               break;
-               
-       default:
-               error << "UI: unknown request type "
-                     << (int) req->type
-                     << endmsg;
-       }              
-}
 
-void
-UI::send_request (Request *req)
-{
-       if (instance() == 0) {
-               return; /* XXX is this the right thing to do ? */
-       }
-       
-       if (caller_is_gui_thread()) {
-               // cerr << "GUI thread sent request " << req << " type = " << req->type << endl;
-               do_request (req);
-       } else {        
-               const char c = 0;
-               RingBufferNPT<Request*>* rbuf = static_cast<RingBufferNPT<Request*> *> (pthread_getspecific (thread_request_buffer_key));
-
-               if (rbuf == 0) {
-                       /* can't use the error system to report this, because this
-                          thread isn't registered!
-                       */
-                       cerr << _("programming error: ")
-                            << string_compose (X_("UI::send_request() called from %1, but no request buffer exists for that thread"),
-                                        pthread_self())
-                            << endl;
-                       abort ();
-               }
-               
-               // cerr << "thread " << pthread_self() << " sent request " << req << " type = " << req->type << endl;
-               rbuf->increment_write_ptr (1);
-               write (signal_pipe[1], &c, 1);
-       }
-}
+       } else if (req->type == SetTip) {
 
-void
-UI::request (RequestType rt)
-{
-       Request *req = get_request (rt);
+               /* XXX need to figure out how this works */
 
-       if (req == 0) {
-               return;
-       }
+       } else {
 
-       send_request (req);
+               error << "GtkUI: unknown request type "
+                     << (int) req->type
+                     << endmsg;
+       }              
 }
 
 /*======================================================================
@@ -620,10 +389,10 @@ UI::request (RequestType rt)
 void
 UI::receive (Transmitter::Channel chn, const char *str)
 {
-       if (caller_is_gui_thread()) {
+       if (caller_is_ui_thread()) {
                process_error_message (chn, str);
        } else {
-               Request* req = get_request (ErrorMessage);
+               UIRequest* req = get_request (ErrorMessage);
 
                if (req == 0) {
                        return;
@@ -644,7 +413,7 @@ UI::process_error_message (Transmitter::Channel chn, const char *str)
        RefPtr<Style> style;
        RefPtr<TextBuffer::Tag> ptag;
        RefPtr<TextBuffer::Tag> mtag;
-       char *prefix;
+       const char *prefix;
        size_t prefix_len;
        bool fatal_received = false;
 #ifndef OLD_STYLE_ERRORS
@@ -755,7 +524,7 @@ UI::handle_fatal (const char *message)
        win.set_default_size (400, 100);
        
        string title;
-       title = _ui_name;
+       title = name();
        title += ": Fatal Error";
        win.set_title (title);
 
@@ -779,7 +548,7 @@ UI::popup_error (const char *text)
 {
        PopUp *pup;
 
-       if (!caller_is_gui_thread()) {
+       if (!caller_is_ui_thread()) {
                error << "non-UI threads can't use UI::popup_error" 
                      << endmsg;
                return;
@@ -790,11 +559,32 @@ UI::popup_error (const char *text)
        pup->touch ();
 }
 
+#ifdef GTKOSX
+extern "C" {
+       int gdk_quartz_in_carbon_menu_event_handler ();
+}
+#endif
 
 void
 UI::flush_pending ()
 {
-       if (!caller_is_gui_thread()) {
+#ifdef GTKOSX
+       /* as of february 11th 2008, gtk/osx has a problem in that mac menu events
+          are handled using Carbon with an "internal" event handling system that 
+          doesn't pass things back to the glib/gtk main loop. this makes
+          gtk_main_iteration() block if we call it while in a menu event handler 
+          because glib gets confused and thinks there are two threads running
+          g_main_poll_func(). 
+
+          this hack (relies on code in gtk2_ardour/sync-menu.c) works
+          around that.
+       */
+
+       if (gdk_quartz_in_carbon_menu_event_handler()) {
+               return;
+       }
+#endif
+       if (!caller_is_ui_thread()) {
                error << "non-UI threads cannot call UI::flush_pending()"
                      << endmsg;
                return;
@@ -810,7 +600,7 @@ UI::flush_pending ()
 bool
 UI::just_hide_it (GdkEventAny *ev, Window *win)
 {
-       win->hide_all ();
+       win->hide ();
        return true;
 }