Prefer testing the session instead of using a global variable

[ardour.git] / gtk2_ardour / splash.cc

diff --git a/gtk2_ardour/splash.cc b/gtk2_ardour/splash.cc
index cd09be05746f1f852476cb52cac0ccc24c02a002..756749c6e617729709a3b182c391a96c19915d67 100644 (file)
--- a/gtk2_ardour/splash.cc
+++ b/gtk2_ardour/splash.cc
@@ -21,13 +21,21 @@
 
 #include "pbd/failed_constructor.h"
 #include "pbd/file_utils.h"
+#include "pbd/stacktrace.h"
+
 #include "ardour/ardour.h"
 #include "ardour/filesystem_paths.h"
 
+#include "gtkmm2ext/utils.h"
+
+#ifdef check
+#undef check
+#endif
+
 #include "gui_thread.h"
 #include "splash.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace Gtk;
 using namespace Glib;
@@ -40,10 +48,14 @@ Splash* Splash::the_splash = 0;
 Splash::Splash ()
 {
        assert (the_splash == 0);
-       
+
        std::string splash_file;
 
-       if (!find_file_in_search_path (ardour_data_search_path(), "splash.png", splash_file)) {
+       Searchpath rc (ARDOUR::ardour_data_search_path());
+       rc.add_subdirectory_to_paths ("resources");
+
+       if (!find_file (rc, PROGRAM_NAME "-splash.png", splash_file)) {
+               cerr << "Cannot find splash screen image file\n";
                throw failed_constructor();
        }
 
@@ -52,6 +64,7 @@ Splash::Splash ()
        }
 
        catch (...) {
+               cerr << "Cannot construct splash screen image\n";
                throw failed_constructor();
        }
 
@@ -75,62 +88,64 @@ Splash::Splash ()
        add (darea);
 
        set_default_size (pixbuf->get_width(), pixbuf->get_height());
+       set_resizable (false);
+       set_type_hint(Gdk::WINDOW_TYPE_HINT_SPLASHSCREEN);
        the_splash = this;
 
+       expose_done = false;
+       expose_is_the_one = false;
+
        ARDOUR::BootMessage.connect (msg_connection, invalidator (*this), boost::bind (&Splash::boot_message, this, _1), gui_context());
 }
 
 Splash::~Splash ()
 {
+       idle_connection.disconnect ();
+       expose_done = true;
+       hide ();
        the_splash = 0;
 }
 
-bool
-Splash::wakeup_from_splash_sleep ()
-{
-       splash_done_visible = true;
-       return false;
-}
-
-bool
-Splash::splash_mapped (GdkEventAny*)
-{
-       Glib::signal_idle().connect (sigc::mem_fun (this, &Splash::wakeup_from_splash_sleep));
-       return false;
-}
-
-void
-Splash::display ()
-{
-       bool was_mapped = is_mapped ();
-       
-       if (!was_mapped) {
-               signal_map_event().connect (sigc::mem_fun (this, &Splash::splash_mapped), false);
-               splash_done_visible = false;
-       }
-
-       pop_front ();
-       present ();
-       
-       if (!was_mapped) {
-               while (!splash_done_visible) {
-                       gtk_main_iteration ();
-               }
-       }
-}
-
 void
 Splash::pop_back_for (Gtk::Window& win)
 {
+#if defined  __APPLE__ || defined PLATFORM_WINDOWS
+       /* April 2013: window layering on OS X is a bit different to X Window. at present,
+        * the "restack()" functionality in GDK will only operate on windows in the same
+        * "level" (e.g. two normal top level windows, or two utility windows) and will not
+        * work across them. The splashscreen is on its own "StatusWindowLevel" so restacking
+        * is not going to work.
+        *
+        * So for OS X, we just hide ourselves.
+        *
+        * Oct 2014: The Windows situation is similar, although it should be possible
+        * to play tricks with gdk's set_type_hint() or directly hack things using
+        * SetWindowLong() and UpdateLayeredWindow()
+        */
+       (void) win;
+       hide();
+#else
        set_keep_above (false);
        get_window()->restack (win.get_window(), false);
-       win.signal_hide().connect (sigc::mem_fun (*this, &Splash::pop_front));
+#endif
 }
 
 void
 Splash::pop_front ()
 {
-       set_keep_above (true);
+       if (get_window()) {
+#if defined  __APPLE__ || defined PLATFORM_WINDOWS
+               show ();
+#else
+               gdk_window_restack(get_window()->gobj(), NULL, true);
+#endif
+       }
+}
+
+void
+Splash::hide ()
+{
+       Gtk::Window::hide();
 }
 
 void
@@ -141,10 +156,15 @@ Splash::on_realize ()
        layout->set_font_description (get_style()->get_font());
 }
 
-
 bool
-Splash::on_button_release_event (GdkEventButton*)
+Splash::on_button_release_event (GdkEventButton* ev)
 {
+       RefPtr<Gdk::Window> window = get_window();
+
+       if (!window || ev->window != window->gobj()) {
+               return false;
+       }
+
        hide ();
        return true;
 }
@@ -170,6 +190,15 @@ Splash::expose (GdkEventExpose* ev)
 
        window->draw_layout (white, 10, pixbuf->get_height() - 30, layout);
 
+       /* this must execute AFTER the GDK idle update mechanism
+        */
+
+       if (expose_is_the_one) {
+               idle_connection = Glib::signal_idle().connect (
+                               sigc::mem_fun (this, &Splash::idle_after_expose),
+                               GDK_PRIORITY_REDRAW+2);
+       }
+
        return true;
 }
 
@@ -179,20 +208,61 @@ Splash::boot_message (std::string msg)
        message (msg);
 }
 
+bool
+Splash::idle_after_expose ()
+{
+       expose_done = true;
+       return false;
+}
+
+void
+Splash::display ()
+{
+       bool was_mapped = is_mapped ();
+
+       if (!was_mapped) {
+               expose_done = false;
+               expose_is_the_one = false;
+       }
+
+       pop_front ();
+       present ();
+
+       if (!was_mapped) {
+               while (!expose_done && gtk_events_pending()) {
+                       gtk_main_iteration ();
+               }
+               gdk_display_flush (gdk_display_get_default());
+       }
+}
+
 void
 Splash::message (const string& msg)
 {
        string str ("<b>");
-       str += msg;
+       str += Gtkmm2ext::markup_escape_text (msg);
        str += "</b>";
 
+       show ();
+
        layout->set_markup (str);
        Glib::RefPtr<Gdk::Window> win = darea.get_window();
 
        if (win) {
-               win->invalidate_rect (Gdk::Rectangle (0, darea.get_height() - 30,
-                                                     darea.get_width(), 30), true);
-               win->process_updates (true);
-               gdk_flush ();
+               if (win->is_visible ()) {
+                       win->invalidate_rect (Gdk::Rectangle (0, darea.get_height() - 30, darea.get_width(), 30), true);
+               } else {
+                       darea.queue_draw ();
+               }
+               if (expose_done) {
+                       ARDOUR::GUIIdle ();
+               }
        }
 }
+
+bool
+Splash::on_map_event (GdkEventAny* ev)
+{
+       expose_is_the_one = true;
+       return Window::on_map_event (ev);
+}