packaging tweaks for OS X
[ardour.git] / gtk2_ardour / main.cc
index 1e9b27d8a7eac1178f3c829120529cf131b7e719..284192ede24933fce2e26e3434d3e0b75c94e06f 100644 (file)
@@ -1,6 +1,6 @@
 /*
     Copyright (C) 2001-2007 Paul 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
     the Free Software Foundation; either version 2 of the License, or
 */
 
 #include <cstdlib>
+#include <signal.h>
+#include <cerrno>
+#include <fstream>
+#include <vector>
 
 #include <sigc++/bind.h>
 #include <gtkmm/settings.h>
 
-#include <pbd/error.h>
-#include <pbd/textreceiver.h>
-#include <pbd/failed_constructor.h>
-#include <pbd/pthread_utils.h>
+#include "pbd/error.h"
+#include "pbd/epa.h"
+#include "pbd/file_utils.h"
+#include "pbd/textreceiver.h"
+#include "pbd/failed_constructor.h"
+#include "pbd/pthread_utils.h"
+#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
+#include "pbd/boost_debug.h"
+#endif
 
 #include <jack/jack.h>
 
-#include <ardour/version.h>
-#include <ardour/ardour.h>
-#include <ardour/audioengine.h>
-#include <ardour/session_utils.h>
+#include "ardour/svn_revision.h"
+#include "ardour/version.h"
+#include "ardour/ardour.h"
+#include "ardour/audioengine.h"
+#include "ardour/session_utils.h"
+#include "ardour/filesystem_paths.h"
 
 #include <gtkmm/main.h>
+#include <gtkmm2ext/application.h>
 #include <gtkmm2ext/popup.h>
 #include <gtkmm2ext/utils.h>
 
-#include "svn_revision.h"
 #include "version.h"
+#include "utils.h"
 #include "ardour_ui.h"
 #include "opts.h"
 #include "enums.h"
 
 #include "i18n.h"
 
+using namespace std;
 using namespace Gtk;
 using namespace ARDOUR_COMMAND_LINE;
 using namespace ARDOUR;
 using namespace PBD;
-using namespace sigc;
 
 TextReceiver text_receiver ("ardour");
 
 extern int curvetest (string);
 
 static ARDOUR_UI  *ui = 0;
-static char* localedir = LOCALEDIR;
-
-gint
-show_ui_callback (void *arg)
-{
-       ARDOUR_UI * ui = (ARDOUR_UI *) arg;
-
-       ui->hide_splash();
-       
-       return FALSE;
-}
+static const char* localedir = LOCALEDIR;
 
 void
 gui_jack_error ()
 {
-       MessageDialog win (_("Ardour could not connect to JACK."),
-                    false,
-                    Gtk::MESSAGE_INFO,
-                    (Gtk::ButtonsType)(Gtk::BUTTONS_NONE));
+       MessageDialog win (string_compose (_("%1 could not connect to JACK."), PROGRAM_NAME),
+                          false,
+                          Gtk::MESSAGE_INFO,
+                          Gtk::BUTTONS_NONE);
 win.set_secondary_text(_("There are several possible reasons:\n\
 \n\
 1) JACK is not running.\n\
@@ -86,7 +88,7 @@ Please consider the possibilities, and perhaps (re)start JACK."));
 
        win.add_button (Stock::QUIT, RESPONSE_CLOSE);
        win.set_default_response (RESPONSE_CLOSE);
-       
+
        win.show_all ();
        win.set_position (Gtk::WIN_POS_CENTER);
 
@@ -99,96 +101,142 @@ Please consider the possibilities, and perhaps (re)start JACK."));
        win.run ();
 }
 
+static void export_search_path (const string& base_dir, const char* varname, const char* dir)
+{
+       string path;
+       const char * cstr = getenv (varname);
+
+       if (cstr) {
+               path = cstr;
+               path += ':';
+       } else {
+               path = "";
+       }
+       path += base_dir;
+       path += dir;
+
+       setenv (varname, path.c_str(), 1);
+}
 
 #ifdef __APPLE__
 
 #include <mach-o/dyld.h>
 #include <sys/param.h>
-#include <fstream>
+
+extern void set_language_preference (); // cocoacarbon.mm
 
 void
-fixup_bundle_environment ()
+fixup_bundle_environment (int, char* [])
 {
        if (!getenv ("ARDOUR_BUNDLED")) {
                return;
        }
 
+       EnvironmentalProtectionAgency::set_global_epa (new EnvironmentalProtectionAgency (true, "PREBUNDLE_ENV"));
+
+       set_language_preference ();
+
        char execpath[MAXPATHLEN+1];
        uint32_t pathsz = sizeof (execpath);
 
        _NSGetExecutablePath (execpath, &pathsz);
 
-       Glib::ustring exec_path (execpath);
-       Glib::ustring dir_path = Glib::path_get_dirname (exec_path);
-       Glib::ustring path;
+       std::string dir_path = Glib::path_get_dirname (execpath);
+       std::string path;
        const char *cstr = getenv ("PATH");
 
-       /* ensure that we find any bundled executables (e.g. JACK) */
+       /* ensure that we find any bundled executables (e.g. JACK),
+          and find them before any instances of the same name
+          elsewhere in PATH
+       */
 
        path = dir_path;
+
+       /* JACK is often in /usr/local/bin and since Info.plist refuses to
+          set PATH, we have to force this in order to discover a running
+          instance of JACK ...
+       */
+
+       path += ':';
+       path += "/usr/local/bin";
+
        if (cstr) {
                path += ':';
                path += cstr;
        }
        setenv ("PATH", path.c_str(), 1);
 
-       path = dir_path;
-       path += "/../Resources";
-       path += dir_path;
-       path += "/../Resources/Surfaces";
-       path += dir_path;
-       path += "/../Resources/Panners";
+       export_search_path (dir_path, "ARDOUR_DLL_PATH", "/../lib");
 
-       setenv ("ARDOUR_MODULE_PATH", path.c_str(), 1);
-
-       path = dir_path;
-       path += "/../Resources/icons:";
-       path += dir_path;
-       path += "/../Resources/pixmaps:";
-       path += dir_path;
-       path += "/../Resources/share:";
        path += dir_path;
        path += "/../Resources";
 
-       setenv ("ARDOUR_PATH", path.c_str(), 1);
-       setenv ("ARDOUR_CONFIG_PATH", path.c_str(), 1);
-       setenv ("ARDOUR_DATA_PATH", path.c_str(), 1);
+       /* inside an OS X .app bundle, there is no difference
+          between DATA and CONFIG locations, since OS X doesn't
+          attempt to do anything to expose the notion of
+          machine-independent shared data.
+       */
 
-       cstr = getenv ("LADSPA_PATH");
-       if (cstr) {
-               path = cstr;
-               path += ':';
-       }
-       path = dir_path;
-       path += "/../Plugins";
-       
-       setenv ("LADSPA_PATH", path.c_str(), 1);
+       export_search_path (dir_path, "ARDOUR_DATA_PATH", "/../Resources");
+       export_search_path (dir_path, "ARDOUR_CONFIG_PATH", "/../Resources");
+       export_search_path (dir_path, "ARDOUR_INSTANT_XML_PATH", "/../Resources");
 
-       path = dir_path;
-       path += "/../Frameworks/clearlooks";
+       export_search_path (dir_path, "LADSPA_PATH", "/../Plugins");
+       export_search_path (dir_path, "VAMP_PATH", "/../Frameworks");
 
+       path = dir_path;
+       path += "/../lib/clearlooks";
        setenv ("GTK_PATH", path.c_str(), 1);
 
-       path = dir_path;
-       path += "/../Resources/locale";
-       
-       localedir = strdup (path.c_str());
+       /* unset GTK_RC_FILES so that we only load the RC files that we define
+        */
 
-       /* write a pango.rc file and tell pango to use it */
+       unsetenv ("GTK_RC_FILES");
 
-       path = dir_path;
-       path += "/../Resources/pango.rc";
+       if (!ARDOUR::translations_are_disabled ()) {
+
+               path = dir_path;
+               path += "/../Resources/locale";
+
+               localedir = strdup (path.c_str());
+               setenv ("GTK_LOCALEDIR", localedir, 1);
+       }
+
+       /* write a pango.rc file and tell pango to use it. we'd love
+          to put this into the PROGRAM_NAME.app bundle and leave it there,
+          but the user may not have write permission. so ...
+
+          we also have to make sure that the user ardour directory
+          actually exists ...
+       */
+
+       try {
+               sys::create_directories (user_config_directory ());
+       }
+       catch (const sys::filesystem_error& ex) {
+               error << _("Could not create user configuration directory") << endmsg;
+       }
+
+       sys::path pangopath = user_config_directory();
+       pangopath /= "pango.rc";
+       path = pangopath.to_string();
 
        std::ofstream pangorc (path.c_str());
        if (!pangorc) {
                error << string_compose (_("cannot open pango.rc file %1") , path) << endmsg;
+               return;
        } else {
                pangorc << "[Pango]\nModuleFiles=";
-               Glib::ustring mpath = dir_path;
-               mpath += "/../Resources/pango.modules";
-               pangorc << mpath << endl;
-               
+
+               pangopath = dir_path;
+               pangopath /= "..";
+               pangopath /= "Resources";
+               pangopath /= "pango.modules";
+
+               pangorc << pangopath.to_string() << endl;
+
                pangorc.close ();
+
                setenv ("PANGO_RC_FILE", path.c_str(), 1);
        }
 
@@ -197,7 +245,7 @@ fixup_bundle_environment ()
        setenv ("CHARSETALIASDIR", path.c_str(), 1);
 
        // font config
-       
+
        path = dir_path;
        path += "/../Resources/fonts.conf";
 
@@ -212,17 +260,175 @@ fixup_bundle_environment ()
 
        if (getenv ("ARDOUR_WITH_JACK")) {
                // JACK driver dir
-               
+
                path = dir_path;
                path += "/../Frameworks";
-               
+
                setenv ("JACK_DRIVER_DIR", path.c_str(), 1);
        }
 }
 
+#else
+
+void
+fixup_bundle_environment (int /*argc*/, char* argv[])
+{
+       /* THIS IS FOR LINUX - its just about the only place where its
+        * acceptable to build paths directly using '/'.
+        */
+
+       if (!getenv ("ARDOUR_BUNDLED")) {
+               return;
+       }
+
+       EnvironmentalProtectionAgency::set_global_epa (new EnvironmentalProtectionAgency (true, "PREBUNDLE_ENV"));
+
+       Glib::ustring dir_path = Glib::path_get_dirname (Glib::path_get_dirname (argv[0]));
+       Glib::ustring path;
+       Glib::ustring userconfigdir = user_config_directory().to_string();
+
+       /* note that this function is POSIX/Linux specific, so using / as
+          a dir separator in this context is just fine.
+       */
+
+       export_search_path (dir_path, "ARDOUR_DLL_PATH", "/lib");
+       export_search_path (dir_path, "ARDOUR_CONFIG_PATH", "/etc");
+       export_search_path (dir_path, "ARDOUR_INSTANT_XML_PATH", "/share");
+       export_search_path (dir_path, "ARDOUR_DATA_PATH", "/share");
+
+       export_search_path (dir_path, "LADSPA_PATH", "/../plugins");
+       export_search_path (dir_path, "VAMP_PATH", "/lib");
+
+       path = dir_path;
+       path += "/lib/clearlooks";
+       setenv ("GTK_PATH", path.c_str(), 1);
+
+       /* unset GTK_RC_FILES so that we only load the RC files that we define
+        */
+
+       unsetenv ("GTK_RC_FILES");
+
+       if (!ARDOUR::translations_are_disabled ()) {
+               path = dir_path;
+               path += "/share/locale";
+
+               localedir = strdup (path.c_str());
+               setenv ("GTK_LOCALEDIR", localedir, 1);
+       }
+
+       /* Tell fontconfig where to find fonts.conf. Use the system version
+          if it exists, otherwise use the stuff we included in the bundle
+       */
+
+       if (Glib::file_test ("/etc/fonts/fonts.conf", Glib::FILE_TEST_EXISTS)) {
+               setenv ("FONTCONFIG_FILE", "/etc/fonts/fonts.conf", 1);
+               setenv ("FONTCONFIG_PATH", "/etc/fonts", 1);
+       } else {
+               /* use the one included in the bundle */
+               
+               path = Glib::build_filename (dir_path, "etc/fonts/fonts.conf");
+               setenv ("FONTCONFIG_FILE", path.c_str(), 1);
+               path = Glib::build_filename (dir_path, "etc/fonts");
+               setenv ("FONTCONFIG_PATH", "/etc/fonts", 1);
+       }
+
+       /* write a pango.rc file and tell pango to use it. we'd love
+          to put this into the Ardour.app bundle and leave it there,
+          but the user may not have write permission. so ...
+
+          we also have to make sure that the user ardour directory
+          actually exists ...
+       */
+
+       if (g_mkdir_with_parents (userconfigdir.c_str(), 0755) < 0) {
+               error << string_compose (_("cannot create user ardour folder %1 (%2)"), userconfigdir, strerror (errno))
+                     << endmsg;
+               return;
+       } 
+
+       Glib::ustring mpath;
+       
+       path = Glib::build_filename (userconfigdir, "pango.rc");
+       
+       std::ofstream pangorc (path.c_str());
+       if (!pangorc) {
+               error << string_compose (_("cannot open pango.rc file %1") , path) << endmsg;
+       } else {
+               mpath = Glib::build_filename (userconfigdir, "pango.modules");
+               
+               pangorc << "[Pango]\nModuleFiles=";
+               pangorc << mpath << endl;
+               pangorc.close ();
+       }
+       
+       setenv ("PANGO_RC_FILE", path.c_str(), 1);
+
+       /* similar for GDK pixbuf loaders, but there's no RC file required
+          to specify where it lives.
+       */
+       
+       mpath = Glib::build_filename (userconfigdir, "gdk-pixbuf.loaders");
+       setenv ("GDK_PIXBUF_MODULE_FILE", mpath.c_str(), 1);
+}
+
 #endif
 
-#ifdef VST_SUPPORT
+static gboolean
+tell_about_jack_death (void* /* ignored */)
+{
+       if (AudioEngine::instance()->processed_frames() == 0) {
+               /* died during startup */
+               MessageDialog msg (_("JACK exited"), false);
+               msg.set_position (Gtk::WIN_POS_CENTER);
+               msg.set_secondary_text (string_compose (_(
+"JACK exited unexpectedly, and without notifying %1.\n\
+\n\
+This could be due to misconfiguration or to an error inside JACK.\n\
+\n\
+Click OK to exit %1."), PROGRAM_NAME));
+
+               msg.run ();
+               _exit (0);
+
+       } else {
+
+               /* engine has already run, so this is a mid-session JACK death */
+
+               MessageDialog* msg = manage (new MessageDialog (_("JACK exited"), false));
+               msg->set_secondary_text (string_compose (_(
+"JACK exited unexpectedly, and without notifying %1.\n\
+\n\
+This is probably due to an error inside JACK. You should restart JACK\n\
+and reconnect %1 to it, or exit %1 now. You cannot save your\n\
+session at this time, because we would lose your connection information.\n"), PROGRAM_NAME));
+               msg->present ();
+       }
+       return false; /* do not call again */
+}
+
+static void
+sigpipe_handler (int /*signal*/)
+{
+       /* XXX fix this so that we do this again after a reconnect to JACK
+        */
+
+       static bool done_the_jack_thing = false;
+
+       if (!done_the_jack_thing) {
+               AudioEngine::instance()->died ();
+               g_idle_add (tell_about_jack_death, 0);
+               done_the_jack_thing =  true;
+       }
+}
+
+#ifdef HAVE_LV2
+void close_external_ui_windows();
+#endif
+
+#ifdef WINDOWS_VST_SUPPORT
+
+extern int windows_vst_gui_init (int* argc, char** argv[]);
+
 /* this is called from the entry point of a wine-compiled
    executable that is linked against gtk2_ardour built
    as a shared library.
@@ -233,15 +439,21 @@ int ardour_main (int argc, char *argv[])
 int main (int argc, char *argv[])
 #endif
 {
-       vector<Glib::ustring> null_file_list;
+       fixup_bundle_environment (argc, argv);
 
-#ifdef __APPLE__
-       fixup_bundle_environment ();
-#endif
+       if (!Glib::thread_supported()) {
+               Glib::thread_init();
+       }
 
-        Glib::thread_init();
        gtk_set_locale ();
 
+#ifdef WINDOWS_VST_SUPPORT
+       /* this does some magic that is needed to make GTK and Wine's own
+          X11 client interact properly.
+       */
+       windows_vst_gui_init (&argc, &argv);
+#endif
+
        (void) bindtextdomain (PACKAGE, localedir);
        /* our i18n translations are all in UTF-8, so make sure
           that even if the user locale doesn't specify UTF-8,
@@ -259,6 +471,12 @@ int main (int argc, char *argv[])
        text_receiver.listen_to (fatal);
        text_receiver.listen_to (warning);
 
+#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
+       if (getenv ("BOOST_DEBUG")) {
+               boost_debug_shared_ptr_show_live_debugging (true);
+       }
+#endif
+
        if (parse_opts (argc, argv)) {
                exit (1);
        }
@@ -266,26 +484,26 @@ int main (int argc, char *argv[])
        if (curvetest_file) {
                return curvetest (curvetest_file);
        }
-       
-       cout << _("Ardour/GTK ") 
+
+       cout << PROGRAM_NAME
             << VERSIONSTRING
-            << _("\n   (built using ")
-            << ardour_svn_revision
+            << _(" (built using ")
+            << svn_revision
 #ifdef __GNUC__
-            << _(" and GCC version ") << __VERSION__ 
+            << _(" and GCC version ") << __VERSION__
 #endif
             << ')'
             << endl;
-       
+
        if (just_version) {
                exit (0);
        }
 
        if (no_splash) {
-               cerr << _("Copyright (C) 1999-2007 Paul Davis") << endl
+               cerr << _("Copyright (C) 1999-2012 Paul Davis") << endl
                     << _("Some portions Copyright (C) Steve Harris, Ari Johnson, Brett Viren, Joel Baker") << endl
                     << endl
-                    << _("Ardour comes with ABSOLUTELY NO WARRANTY") << endl
+                    << string_compose (_("%1 comes with ABSOLUTELY NO WARRANTY"), PROGRAM_NAME) << endl
                     << _("not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.") << endl
                     << _("This is free software, and you are welcome to redistribute it ") << endl
                     << _("under certain conditions; see the source for copying conditions.")
@@ -296,31 +514,30 @@ int main (int argc, char *argv[])
 
        PBD::ID::init ();
 
-        try { 
+       if (::signal (SIGPIPE, sigpipe_handler)) {
+               cerr << _("Cannot xinstall SIGPIPE error handler") << endl;
+       }
+
+       try {
                ui = new ARDOUR_UI (&argc, &argv);
        } catch (failed_constructor& err) {
                error << _("could not create ARDOUR GUI") << endmsg;
                exit (1);
        }
 
-       if (!no_splash) {
-               ui->show_splash ();
-               if (session_name.length()) {  
-                       g_timeout_add (4000, show_ui_callback, ui);
-               }
-       }
-
-       if (!keybindings_path.empty()) {
-               ui->set_keybindings_path (keybindings_path);
-       }
-
        ui->run (text_receiver);
+       Gtkmm2ext::Application::instance()->cleanup();
        ui = 0;
 
        ARDOUR::cleanup ();
        pthread_cancel_all ();
+
+#ifdef HAVE_LV2
+       close_external_ui_windows();
+#endif
        return 0;
 }
-#ifdef VST_SUPPORT
+#ifdef WINDOWS_VST_SUPPORT
 } // end of extern C block
 #endif
+