2 Copyright (C) 2014 John Emmas
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.
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.
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.
20 #include "bundle_env.h"
32 #include <glib/gstdio.h>
34 #include <fontconfig/fontconfig.h>
36 #include "ardour/ardour.h"
37 #include "ardour/search_paths.h"
38 #include "ardour/filesystem_paths.h"
40 #include "pbd/file_utils.h"
45 using namespace ARDOUR;
48 get_windows_drive_volume_letter()
50 static std::string ret;
51 char path[PATH_MAX+1];
52 LPITEMIDLIST pidl = 0;
55 if (S_OK == SHGetSpecialFolderLocation (0, CSIDL_WINDOWS, &pidl))
57 if (SHGetPathFromIDListA (pidl, path)) {
58 path[2] = '\0'; // Gives us just the drive letter and colon
64 // The above should never fail - but just in case...
65 else if (char *env_path = getenv ("windir"))
67 strcpy (path, env_path);
68 path[2] = '\0'; // Gives us just the drive letter and colon
81 // Gives the top-level Ardour installation folder (on Windows)
82 // Typically, this will be somehwere like "C:\Program Files"
84 gchar* pExeRoot = g_win32_get_package_installation_directory_of_module (0);
87 pExeRoot = g_build_filename("C:\\", "Program Files", PROGRAM_NAME, 0);
91 gchar tmp[PATH_MAX+1];
94 strcpy(tmp, pExeRoot);
95 if (0 != (p = strrchr (tmp, G_DIR_SEPARATOR))) {
98 if (0 != (p = g_build_filename(tmp, 0))) {
111 fixup_config_file (Glib::ustring str_file_to_fix)
115 bool conversion_needed = false;
116 bool succeeded = false;
118 fstream file_to_fix (fd = g_fopen(str_file_to_fix.c_str(), "r+b"));
120 if (file_to_fix.is_open()) {
121 vector<std::string> lines;
124 file_to_fix.seekg (0, std::ios::beg);
125 file_to_fix.seekp (0, std::ios::beg);
128 while (!file_to_fix.eof() && file_to_fix.getline (buf, sizeof(buf))) {
131 if (!conversion_needed && (std::string::npos != line.find("$(")))
132 conversion_needed = true;
133 lines.push_back(line);
136 if (conversion_needed) {
138 std::string::size_type token_begin, token_end;
139 vector<string>::iterator i;
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));
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;
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);
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();
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 if (0 == str_to_replace.compare("$(LOCALCACHEDIR)")){
168 // Replace our token with the path to our Ardour cache directory
169 str_replace_with = user_cache_directory();
171 // Replace the first occurrence of our token with the required string
172 i->erase(token_begin, ((token_end+1)-token_begin));
173 i->insert(token_begin, str_replace_with);
175 // Assume that our token represents an environment variable
176 std::string envvar_name = str_to_replace.substr(2, str_to_replace.length()-3);
178 if (const char *envvar_value = getenv(envvar_name.c_str())) {
179 strcpy(buf, envvar_value);
180 if (buf[strlen(buf)-1] == G_DIR_SEPARATOR)
181 buf[strlen(buf)-1] = '\0';
182 str_replace_with = buf;
184 // Replace the first occurrence of our token with the required string
185 i->erase(token_begin, ((token_end+1)-token_begin));
186 i->insert(token_begin, str_replace_with);
189 cerr << _("ERROR: unknown environment variable") << endl;
197 file_to_fix.clear (); // Clear the EOF flag etc
198 file_to_fix.seekg (0, std::ios::beg); // Seek our 'get' ptr to the file start pos
199 // (our 'put' ptr shouldn't have moved yet).
200 chsize(fileno (fd), 0); // Truncate the file, ready for re-writing
202 for (i = lines.begin(); i != lines.end(); ++i) {
204 // Write the converted contents to our file
205 file_to_fix << (*i).c_str() << endl;
222 cerr << _("ERROR: Could not open config file '") << str_file_to_fix << "'" << endl;
229 fixup_fonts_config ()
231 string fonts_conf_file;
234 fonts_conf_file = get_module_folder();
236 if (!fonts_conf_file.empty()) {
237 fonts_conf_file += "\\";
238 fonts_conf_file += PROGRAM_NAME;
239 fonts_conf_file += FONTS_CONF_LOCATION;
241 if (PBD::find_file_in_search_path (ARDOUR::ardour_config_search_path(), "fonts.conf", fonts_conf_file)) {
243 Glib::setenv ("FONTCONFIG_FILE", fonts_conf_file, true);
245 if (0 == fixup_config_file (fonts_conf_file))
246 cerr << _("ERROR: processing error for 'fonts.conf' file") << endl;
248 cerr << _("ERROR: Malformed module folder (fonts.conf)") << endl;
253 fixup_pango_config ()
255 string pango_modules_file;
257 #if defined(DEBUG) || defined(RDC_BUILD)
258 // Make sure we pick up the debuggable DLLs !!!
259 pango_modules_file = get_module_folder();
261 if (!pango_modules_file.empty()) {
262 pango_modules_file += "\\";
263 pango_modules_file += PROGRAM_NAME;
264 pango_modules_file += PANGO_CONF_LOCATION;
266 // JE - handy for non-English locale testing (Greek, in this case)
267 Glib::ustring pango_modules_path = Glib::locale_to_utf8("C:\\Program Files\\Mixbus3\\etc\\��������\\pango.modules");
270 Glib::ustring pango_modules_path = pango_modules_file;
272 pango_modules_path.resize (pango_modules_path.size()-14); // Remove "/pango.modules" from the end
274 if (PBD::find_file_in_search_path (ARDOUR::ardour_config_search_path(), "pango.modules", pango_modules_file)) {
276 Glib::ustring pango_modules_path = pango_modules_file;
277 pango_modules_path.resize (pango_modules_path.size()-14); // Remove "/pango.modules" from the end
279 // Set an environment variable so we can find our pango modules. Note
280 // that this requires a modified version of libpango (pango-utils.c)
281 Glib::setenv ("PANGO_MODULE_PATH", Glib::filename_from_utf8(pango_modules_path), true);
283 if (0 == fixup_config_file (pango_modules_file))
284 cerr << _("ERROR: processing error for 'pango.modules' file") << endl;
286 cerr << _("ERROR: Malformed module folder (pango.modules)") << endl;
291 fixup_pixbuf_loaders_config ()
293 string gdk_pixbuf_loaders_file;
295 #if defined(DEBUG) || defined(RDC_BUILD)
296 // Make sure we pick up the debuggable DLLs !!!
297 gdk_pixbuf_loaders_file = get_module_folder();
299 if (!gdk_pixbuf_loaders_file.empty()) {
300 gdk_pixbuf_loaders_file += "\\";
301 gdk_pixbuf_loaders_file += PROGRAM_NAME;
302 gdk_pixbuf_loaders_file += PIXBUFLOADERS_CONF_LOCATION;
304 if (PBD::find_file_in_search_path (ARDOUR::ardour_config_search_path(), "gdk-pixbuf.loaders", gdk_pixbuf_loaders_file)) {
306 // Set an environment variable so we can find our pixbuf modules.
307 Glib::setenv ("GDK_PIXBUF_MODULE_FILE", Glib::filename_from_utf8(gdk_pixbuf_loaders_file), true);
309 if (0 == fixup_config_file (gdk_pixbuf_loaders_file))
310 cerr << _("ERROR: processing error for 'gdk-pixbuf.loaders' file") << endl;
312 cerr << _("ERROR: Malformed module folder (gdk-pixbuf.loaders)") << endl;
317 fixup_clearlooks_config ()
319 string clearlooks_la_file;
321 #if defined(DEBUG) || defined(RDC_BUILD)
322 // Make sure we pick up the debuggable DLLs !!!
323 clearlooks_la_file = get_module_folder();
325 if (!clearlooks_la_file.empty()) {
326 clearlooks_la_file += "\\";
327 clearlooks_la_file += PROGRAM_NAME;
328 clearlooks_la_file += CLEARLOOKS_CONF_LOCATION;
330 if (PBD::find_file_in_search_path (ARDOUR::ardour_config_search_path(), "libclearlooks.la", clearlooks_la_file)) {
332 // Set an environment variable so we can find our clearlooks engine.
333 // Note that this requires a modified version of libgtk (gtkthemes.c)
334 Glib::setenv ("GTK_THEME_ENGINE_FILE", Glib::filename_from_utf8(clearlooks_la_file).c_str(), true);
336 if (0 == fixup_config_file (clearlooks_la_file))
337 cerr << _("ERROR: processing error for 'clearlooks.la' file") << endl;
339 cerr << _("ERROR: Malformed module folder (clearlooks.la)") << endl;
344 fixup_bundle_environment (int argc, char* argv[], const char** localedir)
346 std::string exec_path = argv[0];
347 std::string dir_path = Glib::path_get_dirname (exec_path);
349 // Make sure that our runtime CWD is set to Mixbus's install
350 // folder, regardless of where the caller's CWD was set to.
351 g_chdir (dir_path.c_str());
353 EnvironmentalProtectionAgency::set_global_epa (new EnvironmentalProtectionAgency (true));
355 // Now set 'dir_path' so we can append some relative paths
356 dir_path = Glib::path_get_dirname (dir_path);
361 // First, set up 'ARDOUR_DLL_PATH'
363 path += "\\lib\\ardour3\\surfaces;";
365 path += "\\lib\\ardour3\\panners;";
367 path += "\\lib\\ardour3\\backends;";
370 Glib::setenv ("ARDOUR_DLL_PATH", path, true);
373 // Next, set up 'ARDOUR_DATA_PATH'
374 path = get_module_folder() + "\\";
375 path += PROGRAM_NAME;
377 Glib::setenv ("ARDOUR_DATA_PATH", path, true);
380 // Next, set up 'ARDOUR_CONFIG_PATH'
382 path = user_config_directory() + "\\win64;";
384 path = user_config_directory() + "\\win32;";
386 Glib::setenv ("ARDOUR_CONFIG_PATH", path, true);
389 // Next, set up 'ARDOUR_PATH'
390 path = user_config_directory();
391 path = Glib::path_get_dirname (path);
392 path += G_SEARCHPATH_SEPARATOR;
393 path += windows_search_path().to_string();
395 path += windows_search_path().to_string();
396 path += "\\pixmaps;";
397 path += ardour_data_search_path().to_string(); // In fact, adds both the 'data' search
398 path += G_SEARCHPATH_SEPARATOR; // path and our 'config' search path
401 Glib::setenv ("ARDOUR_PATH", path, true);
404 // Next, set up 'ARDOUR_INSTANT_XML_PATH'
405 path = user_config_directory();
406 Glib::setenv ("ARDOUR_INSTANT_XML_PATH", path, true);
409 // Next, set up 'LADSPA_PATH'
410 path = ladspa_search_path().to_string();
411 Glib::setenv ("LADSPA_PATH", path, true);
414 // Next, set up 'VAMP_PATH'
415 cstr = getenv ("VAMP_PATH");
418 path += G_SEARCHPATH_SEPARATOR;
422 path += get_module_folder() + "\\";
423 path += PROGRAM_NAME;
424 path += "\\bin\\vamp";
425 path += G_SEARCHPATH_SEPARATOR;
426 path += "%ProgramFiles%\\Vamp Plugins";
427 Glib::setenv ("VAMP_PATH", path, true);
430 // Next, set up 'ARDOUR_CONTROL_SURFACE_PATH'
431 cstr = getenv ("ARDOUR_CONTROL_SURFACE_PATH");
434 path += G_SEARCHPATH_SEPARATOR;
438 path += control_protocol_search_path().to_string();
439 Glib::setenv ("ARDOUR_CONTROL_SURFACE_PATH", path, true);
442 // Next, set up 'GTK_LOCALEDIR'
443 if (ARDOUR::translations_are_enabled ()) {
444 path = windows_search_path().to_string();
446 Glib::setenv ("GTK_LOCALEDIR", path, true);
448 // and return the same path to our caller
449 (*localedir) = strdup (path.c_str());
453 // Next, set up 'GTK_PATH'
454 cstr = getenv ("GTK_PATH");
457 path += G_SEARCHPATH_SEPARATOR;
461 path += user_config_directory();
462 path += "\\.gtk-2.0";
463 Glib::setenv ("GTK_PATH", path, true);
466 // Unset GTK_RC_FILES so that we only load the RC files that we define
467 Glib::unsetenv ("GTK_RC_FILES");
470 // and set a '$HOME' environment variable. This variable changes the value returned
471 // by 'g_get_home_dir()' so to prevent that function from unexpectedly changing its
472 // mind, we'll set '$HOME' to whatever 'g_get_home_dir()' is already returning!!
473 if (NULL == getenv("HOME")) {
474 Glib::setenv ("HOME", Glib::locale_from_utf8(g_get_home_dir()), true);
477 fixup_fonts_config();
478 fixup_pango_config();
479 fixup_clearlooks_config();
480 fixup_pixbuf_loaders_config();
484 void load_custom_fonts()
486 std::string ardour_mono_file;
488 if (!find_file_in_search_path (ardour_data_search_path(), "ArdourMono.ttf", ardour_mono_file)) {
489 cerr << _("Cannot find ArdourMono TrueType font") << endl;
492 FcConfig *config = FcInitLoadConfigAndFonts();
493 FcBool ret = FcConfigAppFontAddFile(config, reinterpret_cast<const FcChar8*>(ardour_mono_file.c_str()));
495 if (ret == FcFalse) {
496 cerr << _("Cannot load ArdourMono TrueType font.") << endl;
499 ret = FcConfigSetCurrent(config);
501 if (ret == FcFalse) {
502 cerr << _("Failed to set fontconfig configuration.") << endl;