gtk2_ardour/bundle_env_msvc.cc

   1 /*
   2     Copyright (C) 2014 John Emmas
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "bundle_env.h"
  21 #include "i18n.h"
  22
  23 #include <shlobj.h>
  24 #include <stdlib.h>
  25
  26 #include <iostream>
  27 #include <string>
  28 #include <vector>
  29 #include <fstream>
  30
  31 #include <glibmm.h>
  32 #include <glib/gstdio.h>
  33
  34 #include <fontconfig/fontconfig.h>
  35
  36 #include "ardour/ardour.h"
  37 #include "ardour/search_paths.h"
  38 #include "ardour/filesystem_paths.h"
  39
  40 #include "pbd/file_utils.h"
  41 #include "pbd/epa.h"
  42
  43 using namespace std;
  44 using namespace PBD;
  45 using namespace ARDOUR;
  46
  47 std::string
  48 get_windows_drive_volume_letter()
  49 {
  50 static std::string ret;
  51 char path[PATH_MAX+1];
  52 LPITEMIDLIST pidl = 0;
  53
  54         if (!ret.length()) {
  55                 if (S_OK == SHGetSpecialFolderLocation (0, CSIDL_WINDOWS, &pidl))
  56                 {
  57                         if (SHGetPathFromIDListA (pidl, path)) {
  58                                 path[2] = '\0'; // Gives us just the drive letter and colon
  59                                 ret = path;
  60                         }
  61
  62                         CoTaskMemFree (pidl);
  63                 }
  64                 // The above should never fail - but just in case...
  65                 else if (char *env_path = getenv ("windir"))
  66                 {
  67                         strcpy (path, env_path);
  68                         path[2] = '\0'; // Gives us just the drive letter and colon
  69                         ret = path;
  70                 }
  71         }
  72
  73         return ret;
  74 }
  75
  76 const string
  77 get_module_folder ()
  78 {
  79 std::string ret;
  80
  81         // Gives the top-level Ardour installation folder (on Windows)
  82         // Typically, this will be somehwere like "C:\Program Files"
  83
  84         gchar* pExeRoot = g_win32_get_package_installation_directory_of_module (0);
  85
  86         if (0 == pExeRoot) {
  87                 pExeRoot = g_build_filename("C:\\", "Program Files", PROGRAM_NAME, 0);
  88         }
  89
  90         if (pExeRoot) {
  91                 gchar  tmp[PATH_MAX+1];
  92                 gchar* p;
  93
  94                 strcpy(tmp, pExeRoot);
  95                 if (0 != (p = strrchr (tmp, G_DIR_SEPARATOR))) {
  96                         *p = '\0';
  97
  98                         if (0 != (p = g_build_filename(tmp, 0))) {
  99                                 ret = p;
 100                                 g_free (p);
 101                         }
 102                 }
 103
 104                 g_free (pExeRoot);
 105         }
 106
 107         return (ret);
 108 }
 109
 110 bool
 111 fixup_config_file (Glib::ustring str_file_to_fix)
 112 {
 113 FILE* fd;
 114 char  buf[4096];
 115 bool  conversion_needed = false;
 116 bool  succeeded = false;
 117
 118         fstream file_to_fix (fd = g_fopen(str_file_to_fix.c_str(), "r+b"));
 119
 120         if (file_to_fix.is_open()) {
 121                 vector<std::string> lines;
 122                 std::string line;
 123
 124                 file_to_fix.seekg (0, std::ios::beg);
 125                 file_to_fix.seekp (0, std::ios::beg);
 126
 127                 try {
 128                         while (!file_to_fix.eof() && file_to_fix.getline (buf, sizeof(buf))) {
 129                                 line = buf;
 130
 131                                 if (!conversion_needed && (std::string::npos != line.find("$(")))
 132                                         conversion_needed = true;
 133                                 lines.push_back(line);
 134                         }
 135
 136                         if (conversion_needed) {
 137                                 bool error = false;
 138                                 std::string::size_type token_begin, token_end;
 139                                 vector<string>::iterator i;
 140
 141                                 for (i = lines.begin(); i != lines.end(); ++i) {
 142                                         if (string::npos != (token_begin = i->find("$("))) {
 143                                                 if (string::npos != (token_end = i->find(")", token_begin))) {
 144                                                         std::string str_replace_with;
 145                                                         std::string str_to_replace = i->substr(token_begin, ((token_end+1)-token_begin));
 146
 147                                                         if (0 == str_to_replace.compare("$(CWD)")) {
 148                                                                 // Replace our token with the current working directory
 149                                                                 if (getcwd(buf, sizeof(buf))) {
 150                                                                         if (buf[strlen(buf)-1] == G_DIR_SEPARATOR)
 151                                                                                 buf[strlen(buf)-1] = '\0';
 152                                                                         str_replace_with = buf;
 153
 154                                                                         // Replace the first occurrence of our token with the required string
 155                                                                         i->erase(token_begin, ((token_end+1)-token_begin));
 156                                                                         i->insert(token_begin, str_replace_with);
 157                                                                 } else {
 158                                                                         error = true;
 159                                                                 }
 160                                                         } else if (0 == str_to_replace.compare("$(WINDRIVE)")){
 161                                                                 // Replace our token with the drive letter (and colon) for the user's Windows volume
 162                                                                 str_replace_with = get_windows_drive_volume_letter();
 163
 164                                                                 // Replace the first occurrence of our token with the required string
 165                                                                 i->erase(token_begin, ((token_end+1)-token_begin));
 166                                                                 i->insert(token_begin, str_replace_with);
 167                                                         } else {
 168                                                                 // Assume that our token represents an environment variable
 169                                                                 std::string envvar_name = str_to_replace.substr(2, str_to_replace.length()-3);
 170
 171                                                                 if (const char *envvar_value = getenv(envvar_name.c_str())) {
 172                                                                         strcpy(buf, envvar_value);
 173                                                                         if (buf[strlen(buf)-1] == G_DIR_SEPARATOR)
 174                                                                                 buf[strlen(buf)-1] = '\0';
 175                                                                         str_replace_with = buf;
 176
 177                                                                         // Replace the first occurrence of our token with the required string
 178                                                                         i->erase(token_begin, ((token_end+1)-token_begin));
 179                                                                         i->insert(token_begin, str_replace_with);
 180                                                                 } else {
 181                                                                         error = true;
 182                                                                         cerr << _("ERROR: unknown environment variable") << endl;
 183                                                                 }
 184                                                         }
 185                                                 }
 186                                         }
 187                                 }
 188
 189                                 if (!error) {
 190                                         file_to_fix.clear ();                  // Clear the EOF flag etc
 191                                         file_to_fix.seekg (0, std::ios::beg);  // Seek our 'get' ptr to the file start pos
 192                                                                                                                    // (our 'put' ptr shouldn't have moved yet).
 193                                         chsize(fileno (fd), 0);                // Truncate the file, ready for re-writing
 194
 195                                         for (i = lines.begin(); i != lines.end(); ++i) {
 196
 197                                                 // Write the converted contents to our file
 198                                                 file_to_fix << (*i).c_str() << endl;
 199                                         }
 200
 201                                         try {
 202                                                 file_to_fix.close();
 203                                                 succeeded = true;
 204                                         } catch (...) {}
 205                                 }
 206                         } else {
 207                                 file_to_fix.close();
 208                                 succeeded = true;
 209                         }
 210                 } catch (...) {
 211                         file_to_fix.close();
 212                         succeeded = false;
 213                 }
 214         } else {
 215                 cerr << _("ERROR: Could not open config file '") << str_file_to_fix << "'" << endl;
 216         }
 217
 218         return succeeded;
 219 }
 220
 221 void
 222 fixup_fonts_config ()
 223 {
 224 string fonts_conf_file;
 225
 226 #ifdef DEBUG
 227         fonts_conf_file = get_module_folder();
 228
 229         if (!fonts_conf_file.empty()) {
 230                 fonts_conf_file += "\\";
 231                 fonts_conf_file += PROGRAM_NAME;
 232                 fonts_conf_file += FONTS_CONF_LOCATION;
 233 #else
 234         if (PBD::find_file_in_search_path (ARDOUR::ardour_config_search_path(), "fonts.conf", fonts_conf_file)) {
 235 #endif
 236                 Glib::setenv ("FONTCONFIG_FILE", fonts_conf_file, true);
 237
 238                 if (0 == fixup_config_file (fonts_conf_file))
 239                         cerr << _("ERROR: processing error for 'fonts.conf' file") << endl;
 240         } else {
 241                 cerr << _("ERROR: Malformed module folder (fonts.conf)") << endl;
 242         }
 243 }
 244
 245 void
 246 fixup_pango_config ()
 247 {
 248 string pango_modules_file;
 249
 250 #if defined(DEBUG) || defined(RDC_BUILD)
 251         // Make sure we pick up the debuggable DLLs !!!
 252         pango_modules_file = get_module_folder();
 253
 254         if (!pango_modules_file.empty()) {
 255                 pango_modules_file += "\\";
 256                 pango_modules_file += PROGRAM_NAME;
 257                 pango_modules_file += PANGO_CONF_LOCATION;
 258 #if 0
 259 // JE - handy for non-English locale testing (Greek, in this case)
 260                 Glib::ustring pango_modules_path = Glib::locale_to_utf8("C:\\Program Files\\Mixbus3\\etc\\��������\\pango.modules");
 261 /**/
 262 #else
 263                 Glib::ustring pango_modules_path = pango_modules_file;
 264 #endif
 265                 pango_modules_path.resize (pango_modules_path.size()-14); // Remove "/pango.modules" from the end
 266 #else
 267         if (PBD::find_file_in_search_path (ARDOUR::ardour_config_search_path(), "pango.modules", pango_modules_file)) {
 268
 269                 Glib::ustring pango_modules_path = pango_modules_file;
 270                 pango_modules_path.resize (pango_modules_path.size()-14); // Remove "/pango.modules" from the end
 271 #endif
 272                 // Set an environment variable so we can find our pango modules. Note
 273                 // that this requires a modified version of libpango (pango-utils.c)
 274                 Glib::setenv ("PANGO_MODULE_PATH", Glib::filename_from_utf8(pango_modules_path), true);
 275
 276                 if (0 == fixup_config_file (pango_modules_file))
 277                         cerr << _("ERROR: processing error for 'pango.modules' file") << endl;
 278         } else {
 279                 cerr << _("ERROR: Malformed module folder (pango.modules)") << endl;
 280         }
 281 }
 282
 283 void
 284 fixup_pixbuf_loaders_config ()
 285 {
 286 string gdk_pixbuf_loaders_file;
 287
 288 #if defined(DEBUG) || defined(RDC_BUILD)
 289         // Make sure we pick up the debuggable DLLs !!!
 290         gdk_pixbuf_loaders_file = get_module_folder();
 291
 292         if (!gdk_pixbuf_loaders_file.empty()) {
 293                 gdk_pixbuf_loaders_file += "\\";
 294                 gdk_pixbuf_loaders_file += PROGRAM_NAME;
 295                 gdk_pixbuf_loaders_file += PIXBUFLOADERS_CONF_LOCATION;
 296 #else
 297         if (PBD::find_file_in_search_path (ARDOUR::ardour_config_search_path(), "gdk-pixbuf.loaders", gdk_pixbuf_loaders_file)) {
 298 #endif
 299                 // Set an environment variable so we can find our pixbuf modules.
 300                 Glib::setenv ("GDK_PIXBUF_MODULE_FILE", Glib::filename_from_utf8(gdk_pixbuf_loaders_file), true);
 301
 302                 if (0 == fixup_config_file (gdk_pixbuf_loaders_file))
 303                         cerr << _("ERROR: processing error for 'gdk-pixbuf.loaders' file") << endl;
 304         } else {
 305                 cerr << _("ERROR: Malformed module folder (gdk-pixbuf.loaders)") << endl;
 306         }
 307 }
 308
 309 void
 310 fixup_clearlooks_config ()
 311 {
 312 string clearlooks_la_file;
 313
 314 #if defined(DEBUG) || defined(RDC_BUILD)
 315         // Make sure we pick up the debuggable DLLs !!!
 316         clearlooks_la_file = get_module_folder();
 317
 318         if (!clearlooks_la_file.empty()) {
 319                 clearlooks_la_file += "\\";
 320                 clearlooks_la_file += PROGRAM_NAME;
 321                 clearlooks_la_file += CLEARLOOKS_CONF_LOCATION;
 322 #else
 323         if (PBD::find_file_in_search_path (ARDOUR::ardour_config_search_path(), "libclearlooks.la", clearlooks_la_file)) {
 324 #endif
 325                 // Set an environment variable so we can find our clearlooks engine.
 326                 // Note that this requires a modified version of libgtk (gtkthemes.c)
 327                 Glib::setenv ("GTK_THEME_ENGINE_FILE", Glib::filename_from_utf8(clearlooks_la_file).c_str(), true);
 328
 329                 if (0 == fixup_config_file (clearlooks_la_file))
 330                         cerr << _("ERROR: processing error for 'clearlooks.la' file") << endl;
 331         } else {
 332                 cerr << _("ERROR: Malformed module folder (clearlooks.la)") << endl;
 333         }
 334 }
 335
 336 void
 337 fixup_bundle_environment (int argc, char* argv[], const char** localedir)
 338 {
 339         std::string exec_path = argv[0];
 340         std::string dir_path  = Glib::path_get_dirname (exec_path);
 341
 342         // Make sure that our runtime CWD is set to Mixbus's install
 343         // folder, regardless of where the caller's CWD was set to.
 344         g_chdir (dir_path.c_str());
 345
 346         EnvironmentalProtectionAgency::set_global_epa (new EnvironmentalProtectionAgency (true));
 347
 348         // Now set 'dir_path' so we can append some relative paths
 349         dir_path = Glib::path_get_dirname (dir_path);
 350
 351         std::string path;
 352         const  char *cstr;
 353
 354         // First, set up 'ARDOUR_DLL_PATH'
 355         path  = dir_path;
 356         path += "\\lib\\ardour3\\surfaces;";
 357         path += dir_path;
 358         path += "\\lib\\ardour3\\panners;";
 359         path += dir_path;
 360         path += "\\lib\\ardour3\\backends;";
 361         path += dir_path;
 362         path += "\\bin";
 363         Glib::setenv ("ARDOUR_DLL_PATH", path, true);
 364
 365
 366         // Next, set up 'ARDOUR_DATA_PATH'
 367         path  = get_module_folder() + "\\";
 368         path += PROGRAM_NAME;
 369         path += "\\share";
 370         Glib::setenv ("ARDOUR_DATA_PATH", path, true);
 371
 372
 373         // Next, set up 'ARDOUR_CONFIG_PATH'
 374 #ifdef _WIN64
 375         path = user_config_directory() + "\\win64;";
 376 #else
 377         path = user_config_directory() + "\\win32;";
 378 #endif
 379         Glib::setenv ("ARDOUR_CONFIG_PATH", path, true);
 380
 381
 382         // Next, set up 'ARDOUR_PATH'
 383         path  = user_config_directory();
 384         path  = Glib::path_get_dirname (path);
 385         path += G_SEARCHPATH_SEPARATOR;
 386         path += windows_search_path().to_string();
 387         path += "\\icons;";
 388         path += windows_search_path().to_string();
 389         path += "\\pixmaps;";
 390         path += ardour_data_search_path().to_string();  // In fact, adds both the 'data' search
 391         path += G_SEARCHPATH_SEPARATOR;                 // path and our 'config' search path
 392         path += dir_path;
 393         path += "\\etc";
 394         Glib::setenv ("ARDOUR_PATH", path, true);
 395
 396
 397         // Next, set up 'ARDOUR_INSTANT_XML_PATH'
 398         path = user_config_directory();
 399         Glib::setenv ("ARDOUR_INSTANT_XML_PATH", path, true);
 400
 401
 402         // Next, set up 'LADSPA_PATH'
 403         path = ladspa_search_path().to_string();
 404         Glib::setenv ("LADSPA_PATH", path, true);
 405
 406
 407         // Next, set up 'VAMP_PATH'
 408         cstr = getenv ("VAMP_PATH");
 409         if (cstr) {
 410                 path = cstr;
 411                 path += G_SEARCHPATH_SEPARATOR;
 412         } else {
 413                 path = "";
 414         }
 415         path += get_module_folder() + "\\";
 416         path += PROGRAM_NAME;
 417         path += "\\bin\\vamp";
 418         path += G_SEARCHPATH_SEPARATOR;
 419         path += "%ProgramFiles%\\Vamp Plugins";
 420         Glib::setenv ("VAMP_PATH", path, true);
 421
 422
 423         // Next, set up 'ARDOUR_CONTROL_SURFACE_PATH'
 424         cstr = getenv ("ARDOUR_CONTROL_SURFACE_PATH");
 425         if (cstr) {
 426                 path = cstr;
 427                 path += G_SEARCHPATH_SEPARATOR;
 428         } else {
 429                 path = "";
 430         }
 431         path += control_protocol_search_path().to_string();
 432         Glib::setenv ("ARDOUR_CONTROL_SURFACE_PATH", path, true);
 433
 434
 435         // Next, set up 'GTK_LOCALEDIR'
 436         if (ARDOUR::translations_are_enabled ()) {
 437                 path = windows_search_path().to_string();
 438                 path += "\\locale";
 439                 Glib::setenv ("GTK_LOCALEDIR", path, true);
 440         }
 441
 442
 443         // Next, set up 'GTK_PATH'
 444         cstr = getenv ("GTK_PATH");
 445         if (cstr) {
 446                 path = cstr;
 447                 path += G_SEARCHPATH_SEPARATOR;
 448         } else {
 449                 path = "";
 450         }
 451         path += user_config_directory();
 452         path += "\\.gtk-2.0";
 453         Glib::setenv ("GTK_PATH", path, true);
 454
 455
 456         // Unset GTK_RC_FILES so that we only load the RC files that we define
 457         Glib::unsetenv ("GTK_RC_FILES");
 458
 459
 460         // and set a '$HOME' environment variable. This variable changes the value returned
 461         // by 'g_get_home_dir()' so to prevent that function from unexpectedly changing its
 462         // mind, we'll set '$HOME' to whatever 'g_get_home_dir()' is already returning!!
 463         if (NULL == getenv("HOME")) {
 464                 Glib::setenv ("HOME", Glib::locale_from_utf8(g_get_home_dir()), true);
 465         }
 466
 467         fixup_fonts_config();
 468         fixup_pango_config();
 469         fixup_clearlooks_config();
 470         fixup_pixbuf_loaders_config();
 471 }
 472
 473
 474 void load_custom_fonts()
 475 {
 476         std::string ardour_mono_file;
 477
 478         if (!find_file_in_search_path (ardour_data_search_path(), "ArdourMono.ttf", ardour_mono_file)) {
 479                 cerr << _("Cannot find ArdourMono TrueType font") << endl;
 480         }
 481
 482         FcConfig *config = FcInitLoadConfigAndFonts();
 483         FcBool ret = FcConfigAppFontAddFile(config, reinterpret_cast<const FcChar8*>(ardour_mono_file.c_str()));
 484
 485         if (ret == FcFalse) {
 486                 cerr << _("Cannot load ArdourMono TrueType font.") << endl;
 487         }
 488
 489         ret = FcConfigSetCurrent(config);
 490
 491         if (ret == FcFalse) {
 492                 cerr << _("Failed to set fontconfig configuration.") << endl;
 493         }
 494 }