Couple of comments.
[ardour.git] / libs / gtkmm2ext / gtk_ui.cc
index f00c6cd1e1673042c2b9be17f041b43a6f41ff37..7695892a82556e09e2703f7dedc8f212d59a58e5 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 1999-2005 Paul Barton-Davis 
+    Copyright (C) 1999-2005 Paul Barton-Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -38,6 +38,7 @@
 #include <gtkmm2ext/popup.h>
 #include <gtkmm2ext/utils.h>
 #include <gtkmm2ext/window_title.h>
+#include <gtkmm2ext/actions.h>
 
 #include "i18n.h"
 
@@ -47,45 +48,52 @@ using namespace Glib;
 using namespace PBD;
 using std::map;
 
-pthread_t UI::gui_thread;
 UI       *UI::theGtkUI = 0;
 
 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();
 
-#include <pbd/abstract_ui.cc>  /* instantiate the template */
+#include "pbd/abstract_ui.cc"  /* instantiate the template */
 
-
-UI::UI (string namestr, int *argc, char ***argv) 
-       : AbstractUI<UIRequest> (namestr, true)
+UI::UI (string namestr, int *argc, char ***argv)
+       : AbstractUI<UIRequest> (namestr)
 {
        theMain = new Main (argc, argv);
+#ifndef GTK_NEW_TOOLTIP_API
        tips = new Tooltips;
+#endif
 
        _active = false;
 
        if (!theGtkUI) {
                theGtkUI = this;
-               gui_thread = pthread_self ();
        } else {
                fatal << "duplicate UI requested" << endmsg;
                /* NOTREACHED */
        }
 
-       /* add the pipe to the select/poll loop that GDK does */
+       /* the GUI event loop runs in the main thread of the app,
+          which is assumed to have called this.
+       */
+
+       run_loop_thread = Thread::self();
+       
+       /* store "this" as the UI-for-thread of this thread, same argument
+          as for previous line.
+       */
+
+       set_event_loop_for_thread (this);
+
+       /* attach our request source to the default main context */
 
-       gdk_input_add (signal_pipe[0],
-                      GDK_INPUT_READ,
-                      UI::signal_pipe_callback,
-                      this);
+       request_channel.ios()->attach (MainContext::get_default());
 
-       errors = new TextViewer (850,100);
-       errors->text().set_editable (false); 
+       errors = new TextViewer (800,600);
+       errors->text().set_editable (false);
        errors->text().set_name ("ErrorText");
 
        Glib::set_application_name(namestr);
@@ -96,8 +104,7 @@ UI::UI (string namestr, int *argc, char ***argv)
 
        errors->dismiss_button().set_name ("ErrorLogCloseButton");
        errors->signal_delete_event().connect (bind (sigc::ptr_fun (just_hide_it), (Window *) errors));
-
-       register_thread (pthread_self(), X_("GUI"));
+       errors->set_type_hint (Gdk::WINDOW_TYPE_HINT_UTILITY);
 
        //load_rcfile (rcfile);
 }
@@ -110,26 +117,37 @@ UI::~UI ()
 bool
 UI::caller_is_ui_thread ()
 {
-       return pthread_equal (gui_thread, pthread_self());
+       return Thread::self() == run_loop_thread;
 }
 
 int
 UI::load_rcfile (string path, bool themechange)
 {
+       /* Yes, pointers to Glib::RefPtr.  If these are not kept around,
+        * a segfault somewhere deep in the wonderfully robust glib will result.
+        * This does not occur if wiget.get_style is used instead of rc.get_style below,
+        * except that doesn't actually work... 
+        */
+
+       static Glib::RefPtr<Style>* fatal_style   = 0;
+       static Glib::RefPtr<Style>* error_style   = 0;
+       static Glib::RefPtr<Style>* warning_style = 0;
+       static Glib::RefPtr<Style>* info_style    = 0;
+
        if (path.length() == 0) {
                return -1;
        }
 
        if (access (path.c_str(), R_OK)) {
-               error << "UI: couldn't find rc file \"" 
+               error << "UI: couldn't find rc file \""
                      << path
                      << '"'
                      << endmsg;
                return -1;
        }
-       
+
        RC rc (path.c_str());
-       // RC::reset_styles (Gtk::Settings::get_default());
+       //RC::reset_styles (Gtk::Settings::get_default());
        gtk_rc_reset_styles (gtk_settings_get_default());
        theme_changed.emit();
 
@@ -140,18 +158,20 @@ UI::load_rcfile (string path, bool themechange)
        /* have to pack widgets into a toplevel window so that styles will stick */
 
        Window temp_window (WINDOW_TOPLEVEL);
+       temp_window.ensure_style ();
+
        HBox box;
-       Label a_widget1;
-       Label a_widget2;
-       Label a_widget3;
-       Label a_widget4;
+       Label fatal_widget;
+       Label error_widget;
+       Label warning_widget;
+       Label info_widget;
        RefPtr<Gtk::Style> style;
        RefPtr<TextBuffer> buffer (errors->text().get_buffer());
 
-       box.pack_start (a_widget1);
-       box.pack_start (a_widget2);
-       box.pack_start (a_widget3);
-       box.pack_start (a_widget4);
+       box.pack_start (fatal_widget);
+       box.pack_start (error_widget);
+       box.pack_start (warning_widget);
+       box.pack_start (info_widget);
 
        error_ptag = buffer->create_tag();
        error_mtag = buffer->create_tag();
@@ -162,49 +182,49 @@ UI::load_rcfile (string path, bool themechange)
        info_ptag = buffer->create_tag();
        info_mtag = buffer->create_tag();
 
-       a_widget1.set_name ("FatalMessage");
-       a_widget1.ensure_style ();
-       style = a_widget1.get_style();
-
-       fatal_ptag->property_font_desc().set_value(style->get_font());
-       fatal_ptag->property_foreground_gdk().set_value(style->get_fg(STATE_ACTIVE));
-       fatal_ptag->property_background_gdk().set_value(style->get_bg(STATE_ACTIVE));
-       fatal_mtag->property_font_desc().set_value(style->get_font());
-       fatal_mtag->property_foreground_gdk().set_value(style->get_fg(STATE_NORMAL));
-       fatal_mtag->property_background_gdk().set_value(style->get_bg(STATE_NORMAL));
-
-       a_widget2.set_name ("ErrorMessage");
-       a_widget2.ensure_style ();
-       style = a_widget2.get_style();
-
-       error_ptag->property_font_desc().set_value(style->get_font());
-       error_ptag->property_foreground_gdk().set_value(style->get_fg(STATE_ACTIVE));
-       error_ptag->property_background_gdk().set_value(style->get_bg(STATE_ACTIVE));
-       error_mtag->property_font_desc().set_value(style->get_font());
-       error_mtag->property_foreground_gdk().set_value(style->get_fg(STATE_NORMAL));
-       error_mtag->property_background_gdk().set_value(style->get_bg(STATE_NORMAL));
-
-       a_widget3.set_name ("WarningMessage");
-       a_widget3.ensure_style ();
-       style = a_widget3.get_style();
-
-       warning_ptag->property_font_desc().set_value(style->get_font());
-       warning_ptag->property_foreground_gdk().set_value(style->get_fg(STATE_ACTIVE));
-       warning_ptag->property_background_gdk().set_value(style->get_bg(STATE_ACTIVE));
-       warning_mtag->property_font_desc().set_value(style->get_font());
-       warning_mtag->property_foreground_gdk().set_value(style->get_fg(STATE_NORMAL));
-       warning_mtag->property_background_gdk().set_value(style->get_bg(STATE_NORMAL));
-
-       a_widget4.set_name ("InfoMessage");
-       a_widget4.ensure_style ();
-       style = a_widget4.get_style();
-
-       info_ptag->property_font_desc().set_value(style->get_font());
-       info_ptag->property_foreground_gdk().set_value(style->get_fg(STATE_ACTIVE));
-       info_ptag->property_background_gdk().set_value(style->get_bg(STATE_ACTIVE));
-       info_mtag->property_font_desc().set_value(style->get_font());
-       info_mtag->property_foreground_gdk().set_value(style->get_fg(STATE_NORMAL));
-       info_mtag->property_background_gdk().set_value(style->get_bg(STATE_NORMAL));
+       fatal_widget.set_name ("FatalMessage");
+       delete fatal_style;
+       fatal_style = new Glib::RefPtr<Style>(rc.get_style(fatal_widget));
+
+       fatal_ptag->property_font_desc().set_value((*fatal_style)->get_font());
+       fatal_ptag->property_foreground_gdk().set_value((*fatal_style)->get_fg(STATE_ACTIVE));
+       fatal_ptag->property_background_gdk().set_value((*fatal_style)->get_bg(STATE_ACTIVE));
+       fatal_mtag->property_font_desc().set_value((*fatal_style)->get_font());
+       fatal_mtag->property_foreground_gdk().set_value((*fatal_style)->get_fg(STATE_NORMAL));
+       fatal_mtag->property_background_gdk().set_value((*fatal_style)->get_bg(STATE_NORMAL));
+
+       error_widget.set_name ("ErrorMessage");
+       delete error_style;
+       error_style = new Glib::RefPtr<Style>(rc.get_style(error_widget));
+
+       error_ptag->property_font_desc().set_value((*error_style)->get_font());
+       error_ptag->property_foreground_gdk().set_value((*error_style)->get_fg(STATE_ACTIVE));
+       error_ptag->property_background_gdk().set_value((*error_style)->get_bg(STATE_ACTIVE));
+       error_mtag->property_font_desc().set_value((*error_style)->get_font());
+       error_mtag->property_foreground_gdk().set_value((*error_style)->get_fg(STATE_NORMAL));
+       error_mtag->property_background_gdk().set_value((*error_style)->get_bg(STATE_NORMAL));
+
+       warning_widget.set_name ("WarningMessage");
+       delete warning_style;
+       warning_style = new Glib::RefPtr<Style>(rc.get_style(warning_widget));
+
+       warning_ptag->property_font_desc().set_value((*warning_style)->get_font());
+       warning_ptag->property_foreground_gdk().set_value((*warning_style)->get_fg(STATE_ACTIVE));
+       warning_ptag->property_background_gdk().set_value((*warning_style)->get_bg(STATE_ACTIVE));
+       warning_mtag->property_font_desc().set_value((*warning_style)->get_font());
+       warning_mtag->property_foreground_gdk().set_value((*warning_style)->get_fg(STATE_NORMAL));
+       warning_mtag->property_background_gdk().set_value((*warning_style)->get_bg(STATE_NORMAL));
+
+       info_widget.set_name ("InfoMessage");
+       delete info_style;
+       info_style = new Glib::RefPtr<Style>(rc.get_style(info_widget));
+
+       info_ptag->property_font_desc().set_value((*info_style)->get_font());
+       info_ptag->property_foreground_gdk().set_value((*info_style)->get_fg(STATE_ACTIVE));
+       info_ptag->property_background_gdk().set_value((*info_style)->get_bg(STATE_ACTIVE));
+       info_mtag->property_font_desc().set_value((*info_style)->get_font());
+       info_mtag->property_foreground_gdk().set_value((*info_style)->get_fg(STATE_NORMAL));
+       info_mtag->property_background_gdk().set_value((*info_style)->get_bg(STATE_NORMAL));
 
        return 0;
 }
@@ -217,9 +237,12 @@ UI::run (Receiver &old_receiver)
        listen_to (warning);
        listen_to (fatal);
 
-       old_receiver.hangup ();
+       /* stop the old receiver (text/console) once we hit the first idle */
+
+       Glib::signal_idle().connect (bind_return (mem_fun (old_receiver, &Receiver::hangup), false));
+
        starting ();
-       _active = true; 
+       _active = true;
        theMain->run ();
        _active = false;
        stopping ();
@@ -233,14 +256,6 @@ UI::running ()
        return _active;
 }
 
-void
-UI::kill ()
-{
-       if (_active) {
-               pthread_kill (gui_thread, SIGKILL);
-       } 
-}
-
 void
 UI::quit ()
 {
@@ -281,19 +296,42 @@ UI::touch_display (Touchable *display)
        req->display = display;
 
        send_request (req);
-}      
+}
+
+void
+UI::set_tip (Widget &w, const gchar *tip)
+{
+       set_tip(&w, tip, "");
+}
+
+void
+UI::set_tip (Widget &w, const std::string& tip)
+{
+       set_tip(&w, tip.c_str(), "");
+}
 
 void
 UI::set_tip (Widget *w, const gchar *tip, const gchar *hlp)
 {
        UIRequest *req = get_request (SetTip);
 
+       std::string msg(tip);
+
+       Glib::RefPtr<Gtk::Action> action = w->get_action();
+       if (action) {
+               Gtk::AccelKey key;
+               bool has_key = ActionManager::lookup_entry(action->get_accel_path(), key);
+               if (has_key && key.get_abbrev() != "") {
+                       msg.append("\n\n Key: ").append(key.get_abbrev());
+               }
+       }
+
        if (req == 0) {
                return;
        }
 
        req->widget = w;
-       req->msg = tip;
+       req->msg = msg.c_str();
        req->msg2 = hlp;
 
        send_request (req);
@@ -303,7 +341,7 @@ void
 UI::set_state (Widget *w, StateType state)
 {
        UIRequest *req = get_request (StateChange);
-       
+
        if (req == 0) {
                return;
        }
@@ -331,16 +369,21 @@ UI::idle_add (int (*func)(void *), void *arg)
 
 /* END abstract_ui interfaces */
 
-void
-UI::signal_pipe_callback (void *arg, int fd, GdkInputCondition cond)
+/** Create a PBD::EventLoop::InvalidationRecord and attach a callback
+ *  to a given sigc::trackable so that PBD::EventLoop::invalidate_request
+ *  is called when that trackable is destroyed.
+ */
+PBD::EventLoop::InvalidationRecord*
+__invalidator (sigc::trackable& trackable, const char* file, int line)
 {
-       char buf[256];
-       
-       /* flush (nonblocking) pipe */
-       
-       while (read (fd, buf, 256) > 0);
-       
-       ((UI *) arg)->handle_ui_requests ();
+        PBD::EventLoop::InvalidationRecord* ir = new PBD::EventLoop::InvalidationRecord;
+
+        ir->file = file;
+        ir->line = line;
+
+        trackable.add_destroy_notify_callback (ir, PBD::EventLoop::invalidate_request);
+
+        return ir;
 }
 
 void
@@ -357,8 +400,12 @@ UI::do_request (UIRequest* req)
                do_quit ();
 
        } else if (req->type == CallSlot) {
-
-               req->slot ();
+#ifndef NDEBUG
+               if (getenv ("DEBUG_THREADED_SIGNALS")) {
+                       cerr << "call slot for " << name() << endl;
+               }
+#endif
+               req->the_slot ();
 
        } else if (req->type == TouchDisplay) {
 
@@ -373,14 +420,23 @@ UI::do_request (UIRequest* req)
 
        } else if (req->type == SetTip) {
 
-               /* XXX need to figure out how this works */
+#ifdef GTK_NEW_TOOLTIP_API
+               /* even if the installed GTK is up to date,
+                  at present (November 2008) our included
+                  version of gtkmm is not. so use the GTK
+                  API that we've verified has the right function.
+               */
+               gtk_widget_set_tooltip_text (req->widget->gobj(), req->msg);
+#else
+               tips->set_tip (*req->widget, req->msg, "");
+#endif
 
        } else {
 
                error << "GtkUI: unknown request type "
                      << (int) req->type
                      << endmsg;
-       }              
+       }
 }
 
 /*======================================================================
@@ -443,7 +499,7 @@ UI::process_error_message (Transmitter::Channel chn, const char *str)
 #endif
                break;
        case Transmitter::Info:
-#if OLD_STYLE_ERRORS   
+#if OLD_STYLE_ERRORS
                prefix = "[INFO]: ";
                ptag = info_ptag;
                mtag = info_mtag;
@@ -474,16 +530,16 @@ UI::process_error_message (Transmitter::Channel chn, const char *str)
                cerr << "programmer error in UI::check_error_messages (channel = " << chn << ")\n";
                ::exit (1);
        }
-       
+
        errors->text().get_buffer()->begin_user_action();
 
        if (fatal_received) {
                handle_fatal (str);
        } else {
-               
+
                display_message (prefix, prefix_len, ptag, mtag, str);
-               
-               if (!errors->is_visible()) {
+
+               if (!errors->is_visible() && chn != Transmitter::Info) {
                        toggle_errors();
                }
        }
@@ -503,7 +559,7 @@ UI::toggle_errors ()
 }
 
 void
-UI::display_message (const char *prefix, gint prefix_len, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
+UI::display_message (const char *prefix, gint /*prefix_len*/, RefPtr<TextBuffer::Tag> ptag, RefPtr<TextBuffer::Tag> mtag, const char *msg)
 {
        RefPtr<TextBuffer> buffer (errors->text().get_buffer());
 
@@ -512,36 +568,37 @@ UI::display_message (const char *prefix, gint prefix_len, RefPtr<TextBuffer::Tag
        buffer->insert_with_tag(buffer->end(), "\n", mtag);
 
        errors->scroll_to_bottom ();
-}      
+}
 
 void
 UI::handle_fatal (const char *message)
 {
-       Window win (WINDOW_POPUP);
-       VBox packer;
+       Dialog win;
        Label label (message);
        Button quit (_("Press To Exit"));
+       HBox hpacker;
 
        win.set_default_size (400, 100);
-       
-       string title;
-       title = name();
+
+       WindowTitle title(Glib::get_application_name());
        title += ": Fatal Error";
-       win.set_title (title);
+       win.set_title (title.get_string());
 
        win.set_position (WIN_POS_MOUSE);
-       win.add (packer);
+       win.set_border_width (12);
+
+       win.get_vbox()->pack_start (label, true, true);
+       hpacker.pack_start (quit, true, false);
+       win.get_vbox()->pack_start (hpacker, false, false);
 
-       packer.pack_start (label, true, true);
-       packer.pack_start (quit, false, false);
        quit.signal_clicked().connect(mem_fun(*this,&UI::quit));
-       
+
        win.show_all ();
        win.set_modal (true);
 
        theMain->run ();
-       
-       exit (1);
+
+       _exit (1);
 }
 
 void
@@ -550,11 +607,11 @@ UI::popup_error (const char *text)
        PopUp *pup;
 
        if (!caller_is_ui_thread()) {
-               error << "non-UI threads can't use UI::popup_error" 
+               error << "non-UI threads can't use UI::popup_error"
                      << endmsg;
                return;
        }
-       
+
        pup = new PopUp (WIN_POS_MOUSE, 0, true);
        pup->set_text (text);
        pup->touch ();
@@ -571,11 +628,11 @@ UI::flush_pending ()
 {
 #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 
+          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 
+          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(). 
+          g_main_poll_func().
 
           this hack (relies on code in gtk2_ardour/sync-menu.c) works
           around that.
@@ -599,7 +656,7 @@ UI::flush_pending ()
 }
 
 bool
-UI::just_hide_it (GdkEventAny *ev, Window *win)
+UI::just_hide_it (GdkEventAny */*ev*/, Window *win)
 {
        win->hide ();
        return true;
@@ -649,7 +706,7 @@ UI::color_selection_done (bool status)
 }
 
 bool
-UI::color_selection_deleted (GdkEventAny *ev)
+UI::color_selection_deleted (GdkEventAny */*ev*/)
 {
        Main::quit ();
        return true;