Use g_setenv and g_getenv for portability
[ardour.git] / gtk2_ardour / main.cc
index a3ea0ca4b48ace53192923bbbcace281728a8380..cd26a8cf8f2259d90fd31cab908064d6861f76ff 100644 (file)
@@ -1,6 +1,6 @@
 /*
-    Copyright (C) 2001-2007 Paul Davis
-    
+    Copyright (C) 2001-2012 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/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 <fontconfig/fontconfig.h>
+
 #include "version.h"
+#include "utils.h"
 #include "ardour_ui.h"
 #include "opts.h"
 #include "enums.h"
 
 #include "i18n.h"
 
+#ifdef __APPLE__
+#include <Carbon/Carbon.h>
+#endif
+
+using namespace std;
 using namespace Gtk;
-using namespace GTK_ARDOUR;
+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;
-
-string
-which_ui_rcfile ()
-{
-       string rcfile;
-       char* env;
-
-       if ((env = getenv ("ARDOUR2_UI_RC")) != 0 && strlen (env)) {
-               rcfile = env;
-       } else {
-               rcfile = "ardour2_ui.rc";
-       }
-
-       rcfile = find_config_file (rcfile);
-       
-       if (rcfile.empty()) {
-               warning << _("Without a UI style file, ardour will look strange.\n Please set ARDOUR2_UI_RC to point to a valid UI style file") << endmsg;
-       } else {
-               cerr << "Loading ui configuration file " << rcfile << endl;
-       }
-       
-       return rcfile;
-}
-
-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));
-win.set_secondary_text(_("There are several possible reasons:\n\
+       MessageDialog win (string_compose (_("%1 could not connect to JACK."), PROGRAM_NAME),
+                          false,
+                          Gtk::MESSAGE_INFO,
+                          Gtk::BUTTONS_NONE);
+       win.set_secondary_text(string_compose (_("There are several possible reasons:\n\
 \n\
 1) JACK is not running.\n\
 2) JACK is running as another user, perhaps root.\n\
-3) There is already another client called \"ardour\".\n\
+3) There is already another client called \"%1\".\n\
 \n\
-Please consider the possibilities, and perhaps (re)start JACK."));
+Please consider the possibilities, and perhaps (re)start JACK."), PROGRAM_NAME));
 
        win.add_button (Stock::QUIT, RESPONSE_CLOSE);
        win.set_default_response (RESPONSE_CLOSE);
-       
+
        win.show_all ();
        win.set_position (Gtk::WIN_POS_CENTER);
 
@@ -120,62 +107,322 @@ Please consider the possibilities, and perhaps (re)start JACK."));
        win.run ();
 }
 
-static bool
-maybe_load_session ()
+static void export_search_path (const string& base_dir, const char* varname, const char* dir)
 {
-       /* If no session name is given: we're not loading a session yet, nor creating a new one */
-       if (!session_name.length()) {
-               ui->hide_splash ();
-               if (!Config->get_no_new_session_dialog()) {
-                      ui->new_session ();
-               }
+       string path;
+       const char * cstr = g_getenv (varname);
 
-               return true;
+       if (cstr) {
+               path = cstr;
+               path += ':';
+       } else {
+               path = "";
        }
+       path += base_dir;
+       path += dir;
 
-       /* Load session or start the new session dialog */
-       string name, path;
+       g_setenv (varname, path.c_str(), 1);
+}
+
+#ifdef __APPLE__
+
+#include <mach-o/dyld.h>
+#include <sys/param.h>
 
-       bool isnew;
+extern void set_language_preference (); // cocoacarbon.mm
 
-       if (Session::find_session (session_name, path, name, isnew)) {
-               error << string_compose(_("could not load command line session \"%1\""), session_name) << endmsg;
-               return false;
+void
+fixup_bundle_environment (int, char* [])
+{
+       if (!g_getenv ("ARDOUR_BUNDLED")) {
+               return;
        }
 
-       if (!new_session) {
+       EnvironmentalProtectionAgency::set_global_epa (new EnvironmentalProtectionAgency (true, "PREBUNDLE_ENV"));
+
+       set_language_preference ();
+
+       char execpath[MAXPATHLEN+1];
+       uint32_t pathsz = sizeof (execpath);
+
+       _NSGetExecutablePath (execpath, &pathsz);
+
+       std::string path;
+       std::string exec_dir = Glib::path_get_dirname (execpath);
+       std::string bundle_dir;
+       std::string userconfigdir = user_config_directory();
+
+       bundle_dir = Glib::path_get_dirname (exec_dir);
+
+#ifdef ENABLE_NLS
+       if (!ARDOUR::translations_are_enabled ()) {
+               localedir = "/this/cannot/exist";
+       } else {
+               /* force localedir into the bundle */
+               
+               vector<string> lpath;
+               lpath.push_back (bundle_dir);
+               lpath.push_back ("share");
+               lpath.push_back ("locale");
+               localedir = strdup (Glib::build_filename (lpath).c_str());
+       }
+#endif
+               
+       export_search_path (bundle_dir, "ARDOUR_DLL_PATH", "/lib");
+
+       /* 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.
+       */
+
+       export_search_path (bundle_dir, "ARDOUR_DATA_PATH", "/Resources");
+       export_search_path (bundle_dir, "ARDOUR_CONFIG_PATH", "/Resources");
+       export_search_path (bundle_dir, "ARDOUR_INSTANT_XML_PATH", "/Resources");
+       export_search_path (bundle_dir, "LADSPA_PATH", "/Plugins");
+       export_search_path (bundle_dir, "VAMP_PATH", "/lib");
+       export_search_path (bundle_dir, "SUIL_MODULE_DIR", "/lib");
+       export_search_path (bundle_dir, "GTK_PATH", "/lib/gtkengines");
+
+       g_setenv ("PATH", (bundle_dir + "/MacOS:" + std::string(getenv ("PATH"))).c_str(), 1);
+
+       /* unset GTK_RC_FILES so that we only load the RC files that we define
+        */
+
+       g_unsetenv ("GTK_RC_FILES");
+
+       /* 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 ...
+       */
+
+       if (g_mkdir_with_parents (userconfigdir.c_str(), 0755) < 0) {
+               error << string_compose (_("cannot create user %3 folder %1 (%2)"), userconfigdir, strerror (errno), PROGRAM_NAME)
+                     << endmsg;
+       } else {
+               
+               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 {
+                       pangorc << "[Pango]\nModuleFiles="
+                               << Glib::build_filename (bundle_dir, "Resources/pango.modules") 
+                               << endl;
+                       pangorc.close ();
                        
-               /* Loading a session, but the session doesn't exist */
-               if (isnew) {
-                       error << string_compose (_("\n\nNo session named \"%1\" exists.\n"
-                                                  "To create it from the command line, start ardour as \"ardour --new %1"), path) 
-                             << endmsg;
-                       return false;
+                       g_setenv ("PANGO_RC_FILE", path.c_str(), 1);
                }
+       }
+       
+       g_setenv ("CHARSETALIASDIR", bundle_dir.c_str(), 1);
+       g_setenv ("FONTCONFIG_FILE", Glib::build_filename (bundle_dir, "Resources/fonts.conf").c_str(), 1);
+       g_setenv ("GDK_PIXBUF_MODULE_FILE", Glib::build_filename (bundle_dir, "Resources/gdk-pixbuf.loaders").c_str(), 1);
+}
 
-               if (ui->load_session (path, name)) {
-                       /* it failed */
-                       return false;
-               }
+static void load_custom_fonts() {
+/* this code will only compile on OS X 10.6 and above, and we currently do not
+ * need it for earlier versions since we fall back on a non-monospace,
+ * non-custom font.
+ */
+#if MAC_OS_X_VERSION_MIN_REQUIRED >= 1060
+       std::string ardour_mono_file;
+
+       if (!find_file_in_search_path (ardour_data_search_path(), "ArdourMono.ttf", ardour_mono_file)) {
+               cerr << _("Cannot find ArdourMono TrueType font") << endl;
+       }
+
+       CFStringRef ttf;
+       CFURLRef fontURL;
+       CFErrorRef error;
+       ttf = CFStringCreateWithBytes(
+                       kCFAllocatorDefault, (UInt8*) ardour_mono_file.c_str(),
+                       ardour_mono_file.length(),
+                       kCFStringEncodingUTF8, FALSE);
+       fontURL = CFURLCreateWithFileSystemPath(kCFAllocatorDefault, ttf, kCFURLPOSIXPathStyle, TRUE);
+       if (CTFontManagerRegisterFontsForURL(fontURL, kCTFontManagerScopeProcess, &error) != true) {
+               cerr << _("Cannot load ArdourMono TrueType font.") << endl;
+       }
+#endif
+}
+
+#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 (!g_getenv ("ARDOUR_BUNDLED")) {
+               return;
+       }
 
+       EnvironmentalProtectionAgency::set_global_epa (new EnvironmentalProtectionAgency (true, "PREBUNDLE_ENV"));
+
+       std::string path;
+       std::string dir_path = Glib::path_get_dirname (Glib::path_get_dirname (argv[0]));
+       std::string userconfigdir = user_config_directory();
+
+#ifdef ENABLE_NLS
+       if (!ARDOUR::translations_are_enabled ()) {
+               localedir = "/this/cannot/exist";
        } else {
+               /* force localedir into the bundle */
+               vector<string> lpath;
+               lpath.push_back (dir_path);
+               lpath.push_back ("share");
+               lpath.push_back ("locale");
+               localedir = realpath (Glib::build_filename (lpath).c_str(), NULL);
+       }
+#endif
 
-               /*  TODO: This bit of code doesn't work properly yet
-                   Glib::signal_idle().connect (bind (mem_fun (*ui, &ARDOUR_UI::cmdline_new_session), path));
-                   ui->set_will_create_new_session_automatically (true); 
-               */
+       /* 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");
+       export_search_path (dir_path, "SUIL_MODULE_DIR", "/lib");
+       export_search_path (dir_path, "GTK_PATH", "/lib/gtkengines");
+
+       g_setenv ("PATH", (dir_path + "/bin:" + std::string(getenv ("PATH"))).c_str(), 1);
+
+       /* unset GTK_RC_FILES so that we only load the RC files that we define
+        */
+
+       g_unsetenv ("GTK_RC_FILES");
+
+       /* 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)) {
+               g_setenv ("FONTCONFIG_FILE", "/etc/fonts/fonts.conf", 1);
+               g_setenv ("FONTCONFIG_PATH", "/etc/fonts", 1);
+       } else {
+               error << _("No fontconfig file found on your system. Things may looked very odd or ugly") << endmsg;
+       }
+
+       /* 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 %3 folder %1 (%2)"), userconfigdir, strerror (errno), PROGRAM_NAME)
+                     << endmsg;
+       } else {
                
-               /* Show the NSD */
-               ui->hide_splash ();
-               if (!Config->get_no_new_session_dialog()) {
-                      ui->new_session ();
+               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 {
+                       pangorc << "[Pango]\nModuleFiles="
+                               << Glib::build_filename (userconfigdir, "pango.modules")
+                               << endl;
+                       pangorc.close ();
                }
+               
+               g_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.
+               */
+               
+               g_setenv ("GDK_PIXBUF_MODULE_FILE", Glib::build_filename (userconfigdir, "gdk-pixbuf.loaders").c_str(), 1);
+       }
+
+        /* this doesn't do much but setting it should prevent various parts of the GTK/GNU stack
+           from looking outside the bundle to find the charset.alias file.
+        */
+        g_setenv ("CHARSETALIASDIR", dir_path.c_str(), 1);
+
+}
+
+static void load_custom_fonts() {
+       std::string ardour_mono_file;
+       if (!find_file_in_search_path (ardour_data_search_path(), "ArdourMono.ttf", ardour_mono_file)) {
+               cerr << _("Cannot find ArdourMono TrueType font") << endl;
        }
 
-       return true;
+       FcConfig *config = FcInitLoadConfigAndFonts();
+       FcBool ret = FcConfigAppFontAddFile(config, reinterpret_cast<const FcChar8*>(ardour_mono_file.c_str()));
+       if (ret == FcFalse) {
+               cerr << _("Cannot load ArdourMono TrueType font.") << endl;
+       }
+       ret = FcConfigSetCurrent(config);
+       if (ret == FcFalse) {
+               cerr << _("Failed to set fontconfig configuration.") << endl;
+       }
+}
+
+#endif
+
+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 VST_SUPPORT
+#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.
@@ -185,21 +432,36 @@ int ardour_main (int argc, char *argv[])
 #else
 int main (int argc, char *argv[])
 #endif
-
 {
-       ARDOUR::AudioEngine *engine;
-       vector<Glib::ustring> null_file_list;
+       fixup_bundle_environment (argc, argv);
 
-        Glib::thread_init();
+       load_custom_fonts(); /* needs to happend before any gtk and pango init calls */
+
+       if (!Glib::thread_supported()) {
+               Glib::thread_init();
+       }
+
+#ifdef ENABLE_NLS
        gtk_set_locale ();
+#endif
+
+#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
+
+#ifdef ENABLE_NLS
+       cerr << "bnd txt domain [" << PACKAGE << "] to " << localedir << endl;
 
-       (void) bindtextdomain (PACKAGE, LOCALEDIR);
+       (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,
           we use that when handling them.
        */
        (void) bind_textdomain_codeset (PACKAGE,"UTF-8");
-       (void) textdomain (PACKAGE);
+#endif
 
        pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
 
@@ -210,6 +472,12 @@ int main (int argc, char *argv[])
        text_receiver.listen_to (fatal);
        text_receiver.listen_to (warning);
 
+#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
+       if (g_getenv ("BOOST_DEBUG")) {
+               boost_debug_shared_ptr_show_live_debugging (true);
+       }
+#endif
+
        if (parse_opts (argc, argv)) {
                exit (1);
        }
@@ -217,26 +485,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 ")
+            << 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
-                    << _("Some portions Copyright (C) Steve Harris, Ari Johnson, Brett Viren, Joel Baker") << endl
+               cerr << _("Copyright (C) 1999-2012 Paul Davis") << endl
+                    << _("Some portions Copyright (C) Steve Harris, Ari Johnson, Brett Viren, Joel Baker, Robin Gareus") << 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.")
@@ -247,65 +515,27 @@ int main (int argc, char *argv[])
 
        PBD::ID::init ();
 
-        try { 
-               ui = new ARDOUR_UI (&argc, &argv, which_ui_rcfile());
-       } catch (failed_constructor& err) {
-               error << _("could not create ARDOUR GUI") << endmsg;
-               exit (1);
-       }
-
-       if (!keybindings_path.empty()) {
-               ui->set_keybindings_path (keybindings_path);
+       if (::signal (SIGPIPE, sigpipe_handler)) {
+               cerr << _("Cannot xinstall SIGPIPE error handler") << endl;
        }
 
-       if (!no_splash) {
-               ui->show_splash ();
-               if (session_name.length()) {  
-                       g_timeout_add (4000, show_ui_callback, ui);
-               }
-       }
-
-       try {
-               ARDOUR::init (use_vst, try_hw_optimization);
-               setup_gtk_ardour_enums ();
-               Config->set_current_owner (ConfigVariableBase::Interface);
-
-               try { 
-                       engine = new ARDOUR::AudioEngine (jack_client_name);
-               } catch (AudioEngine::NoBackendAvailable& err) {
-                       gui_jack_error ();
-                       error << string_compose (_("Could not connect to JACK server as  \"%1\""), jack_client_name) <<  endmsg;
-                       return -1;
-               }
-               
-               ui->set_engine (*engine);
-
+       try {
+               ui = new ARDOUR_UI (&argc, &argv, localedir);
        } catch (failed_constructor& err) {
-               error << _("could not initialize Ardour.") << endmsg;
-               return -1;
-       } 
-
-       ui->start_engine ();
-
-       if (maybe_load_session ()) {
-               ui->run (text_receiver);
-               ui = 0;
+               error << string_compose (_("could not create %1 GUI"), PROGRAM_NAME) << endmsg;
+               exit (1);
        }
 
-       delete engine;
-       ARDOUR::cleanup ();
+       ui->run (text_receiver);
+       Gtkmm2ext::Application::instance()->cleanup();
+       ui = 0;
 
-       if (ui) {
-               ui->kill();
-       }
-               
+       ARDOUR::cleanup ();
        pthread_cancel_all ();
 
-       exit (0);
-
        return 0;
 }
-#ifdef VST_SUPPORT
+#ifdef WINDOWS_VST_SUPPORT
 } // end of extern C block
 #endif