src/support/Package.cpp

   1 // -*- C++ -*-
   2 /**
   3  * \file package.cpp
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "support/Package.h"
  15
  16 #include "support/debug.h"
  17 #include "support/environment.h"
  18 #include "support/ExceptionMessage.h"
  19 #include "support/filetools.h"
  20 #include "support/gettext.h"
  21 #include "support/lstrings.h"
  22 #include "support/os.h"
  23
  24 #if defined (USE_WINDOWS_PACKAGING)
  25 # include "support/os_win32.h"
  26 #endif
  27
  28
  29 #include <list>
  30
  31 #if !defined (USE_WINDOWS_PACKAGING) && \
  32     !defined (USE_MACOSX_PACKAGING) && \
  33     !defined (USE_POSIX_PACKAGING)
  34 #error USE_FOO_PACKAGING must be defined for FOO = WINDOWS, MACOSX or POSIX.
  35 #endif
  36
  37 #if defined (USE_MACOSX_PACKAGING)
  38 # include <CoreServices/CoreServices.h> // FSFindFolder, FSRefMakePath
  39 #endif
  40
  41 using namespace std;
  42
  43 namespace lyx {
  44 namespace support {
  45
  46 namespace {
  47
  48 Package package_;
  49 bool initialised_ = false;
  50
  51 } // namespace anon
  52
  53
  54 void init_package(string const & command_line_arg0,
  55                   string const & command_line_system_support_dir,
  56                   string const & command_line_user_support_dir,
  57                   exe_build_dir_to_top_build_dir top_build_dir_location)
  58 {
  59         // Can do so only once.
  60         if (initialised_)
  61                 return;
  62
  63         package_ = Package(command_line_arg0,
  64                            command_line_system_support_dir,
  65                            command_line_user_support_dir,
  66                            top_build_dir_location);
  67         initialised_ = true;
  68 }
  69
  70
  71 Package const & package()
  72 {
  73         // Commented out because package().locale_dir() can be called
  74         // from the message translation code in Messages.cpp before
  75         // init_package() is called. Lars is on the case...
  76         // LASSERT(initialised_, /**/);
  77         return package_;
  78 }
  79
  80
  81 namespace {
  82
  83 FileName const abs_path_from_binary_name(string const & exe);
  84
  85 void buildDirs(FileName const & abs_binary,
  86         exe_build_dir_to_top_build_dir top_build_dir_location,
  87         FileName &, FileName &);
  88
  89 FileName const get_document_dir(FileName const & home_dir);
  90
  91 FileName const get_home_dir();
  92
  93 FileName const get_locale_dir(FileName const & system_support_dir);
  94
  95 FileName const get_system_support_dir(FileName const & abs_binary,
  96                                     string const & command_line_system_support_dir);
  97
  98 FileName const get_temp_dir();
  99
 100 FileName const get_default_user_support_dir(FileName const & home_dir);
 101
 102 bool userSupportDir(FileName const & default_user_support_dir,
 103                      string const & command_line_user_support_dir, FileName & result);
 104
 105
 106 string const & with_version_suffix();
 107
 108 } // namespace anon
 109
 110
 111 Package::Package(string const & command_line_arg0,
 112                  string const & command_line_system_support_dir,
 113                  string const & command_line_user_support_dir,
 114                  exe_build_dir_to_top_build_dir top_build_dir_location)
 115         : explicit_user_support_dir_(false)
 116 {
 117         home_dir_ = get_home_dir();
 118         system_temp_dir_ = get_temp_dir();
 119         temp_dir_ = system_temp_dir_;
 120         document_dir_ = get_document_dir(home_dir_);
 121
 122         FileName const abs_binary = abs_path_from_binary_name(command_line_arg0);
 123         string const bdir = onlyPath(abs_binary.absFilename());
 124         // We may be using libtools
 125         if (suffixIs(bdir, ".libs/"))
 126                 binary_dir_ = FileName(addPath(bdir, "../"));
 127         else
 128                 binary_dir_ = FileName(bdir);
 129
 130         // Is LyX being run in-place from the build tree?
 131         buildDirs(abs_binary, top_build_dir_location,
 132                 build_support_dir_, system_support_dir_);
 133
 134         if (build_support_dir_.empty())
 135                 system_support_dir_ =
 136                         get_system_support_dir(abs_binary,
 137                                                command_line_system_support_dir);
 138
 139         locale_dir_ = get_locale_dir(system_support_dir_);
 140
 141         FileName const default_user_support_dir =
 142                 get_default_user_support_dir(home_dir_);
 143
 144         explicit_user_support_dir_ = userSupportDir(default_user_support_dir,
 145                                      command_line_user_support_dir, user_support_dir_);
 146
 147         FileName const configure_script(addName(system_support().absFilename(), "configure.py"));
 148         configure_command_ = os::python() + ' ' +
 149                         quoteName(configure_script.toFilesystemEncoding()) +
 150                         with_version_suffix();
 151
 152         LYXERR(Debug::INIT, "<package>\n"
 153                 << "\tbinary_dir " << binary_dir().absFilename() << '\n'
 154                 << "\tsystem_support " << system_support().absFilename() << '\n'
 155                 << "\tbuild_support " << build_support().absFilename() << '\n'
 156                 << "\tuser_support " << user_support().absFilename() << '\n'
 157                 << "\tlocale_dir " << locale_dir().absFilename() << '\n'
 158                 << "\tdocument_dir " << document_dir().absFilename() << '\n'
 159                 << "\ttemp_dir " << temp_dir().absFilename() << '\n'
 160                 << "\thome_dir " << home_dir().absFilename() << '\n'
 161                 << "</package>\n");
 162 }
 163
 164
 165 void Package::set_temp_dir(FileName const & temp_dir) const
 166 {
 167         if (temp_dir.empty())
 168                 temp_dir_ = system_temp_dir_;
 169         else
 170                 temp_dir_ = temp_dir;
 171 }
 172
 173
 174 namespace {
 175
 176 // These next functions contain the stuff that is substituted at
 177 // configuration-time.
 178 FileName const hardcoded_localedir()
 179 {
 180         // FIXME UNICODE
 181         // The build system needs to make sure that this is in utf8 encoding.
 182         return FileName(LYX_ABS_INSTALLED_LOCALEDIR);
 183 }
 184
 185
 186 FileName const hardcoded_system_support_dir()
 187 {
 188         // FIXME UNICODE
 189         // The build system needs to make sure that this is in utf8 encoding.
 190         return FileName(LYX_ABS_INSTALLED_DATADIR);
 191 }
 192
 193
 194 string const & with_version_suffix()
 195 {
 196         static string const program_suffix = PROGRAM_SUFFIX;
 197         static string const with_version_suffix =
 198                 " --with-version-suffix=" PROGRAM_SUFFIX;
 199         return program_suffix.empty() ? program_suffix : with_version_suffix;
 200 }
 201
 202 } // namespace anon
 203
 204
 205 FileName const & Package::top_srcdir()
 206 {
 207         // FIXME UNICODE
 208         // The build system needs to make sure that this is in utf8 encoding.
 209         static FileName const dir(LYX_ABS_TOP_SRCDIR);
 210         return dir;
 211 }
 212
 213
 214 namespace {
 215
 216 bool check_command_line_dir(string const & dir,
 217                             string const & file,
 218                             string const & command_line_switch);
 219
 220 FileName const extract_env_var_dir(string const & env_var);
 221
 222 bool check_env_var_dir(FileName const & dir,
 223                        string const & env_var);
 224
 225 bool check_env_var_dir(FileName const & dir,
 226                        string const & file,
 227                        string const & env_var);
 228
 229 string const relative_locale_dir();
 230
 231 string const relative_system_support_dir();
 232
 233
 234 /**
 235  * Convert \p name to internal path and strip a trailing slash, since it
 236  * comes from user input (commandline or environment).
 237  * \p name is encoded in utf8.
 238  */
 239 string const fix_dir_name(string const & name)
 240 {
 241         return rtrim(os::internal_path(name), "/");
 242 }
 243
 244
 245 FileName buildSupportDir(string const & binary_dir,
 246                       exe_build_dir_to_top_build_dir top_build_dir_location)
 247 {
 248         string indirection;
 249         switch (top_build_dir_location) {
 250         case top_build_dir_is_one_level_up:
 251                 indirection = "../lib";
 252                 break;
 253         case top_build_dir_is_two_levels_up:
 254                 indirection = "../../lib";
 255                 break;
 256         }
 257         return FileName(addPath(binary_dir, indirection));
 258 }
 259
 260
 261 void buildDirs(FileName const & abs_binary,
 262   exe_build_dir_to_top_build_dir top_build_dir_location,
 263         FileName & build_support_dir, FileName & system_support_dir)
 264 {
 265         string const check_text = "Checking whether LyX is run in place...";
 266
 267         // We're looking for "Makefile" in a directory
 268         //   binary_dir/../lib
 269         // We're also looking for "chkconfig.ltx" in a directory
 270         //   top_srcdir()/lib
 271         // If both are found, then we're running LyX in-place.
 272
 273         // Note that the name of the lyx binary may be a symbolic link.
 274         // If that is the case, then we follow the links too.
 275         FileName binary = abs_binary;
 276         while (true) {
 277                 // Try and find "lyxrc.defaults".
 278                 string binary_dir = onlyPath(binary.absFilename());
 279                 // We may be using libtools with static linking.
 280                 if (suffixIs(binary_dir, ".libs/"))
 281                         binary_dir = addPath(binary_dir, "../");
 282                 build_support_dir = buildSupportDir(binary_dir, top_build_dir_location);
 283                 if (!fileSearch(build_support_dir.absFilename(), "Makefile").empty()) {
 284                         // Try and find "chkconfig.ltx".
 285                         system_support_dir =
 286                                 FileName(addPath(Package::top_srcdir().absFilename(), "lib"));
 287
 288                         if (!fileSearch(system_support_dir.absFilename(), "chkconfig.ltx").empty()) {
 289                                 LYXERR(Debug::INIT, check_text << " yes");
 290                                 return;
 291                         }
 292                 }
 293
 294                 // Check whether binary is a symbolic link.
 295                 // If so, resolve it and repeat the exercise.
 296                 if (!binary.isSymLink())
 297                         break;
 298
 299                 FileName link;
 300                 if (readLink(binary, link)) {
 301                         binary = link;
 302                 } else {
 303                         // Unable to resolve the link.
 304                         break;
 305                 }
 306         }
 307
 308         LYXERR(Debug::INIT, check_text << " no");
 309         system_support_dir = FileName();
 310         build_support_dir = FileName();
 311 }
 312
 313
 314 // Specification of document_dir_ may be reset by LyXRC,
 315 // but the default is fixed for a given OS.
 316 FileName const get_document_dir(FileName const & home_dir)
 317 {
 318 #if defined (USE_WINDOWS_PACKAGING)
 319         (void)home_dir; // Silence warning about unused variable.
 320         os::GetFolderPath win32_folder_path;
 321         return FileName(win32_folder_path(os::GetFolderPath::PERSONAL));
 322 #else // Posix-like.
 323         return home_dir;
 324 #endif
 325 }
 326
 327
 328 // The specification of home_dir_ is fixed for a given OS.
 329 // A typical example on Windows: "C:/Documents and Settings/USERNAME"
 330 // and on a Posix-like machine: "/home/USERNAME".
 331 FileName const get_home_dir()
 332 {
 333 #if defined (USE_WINDOWS_PACKAGING)
 334         string const home_dir = getEnv("USERPROFILE");
 335 #else // Posix-like.
 336         string const home_dir = getEnv("HOME");
 337 #endif
 338
 339         return FileName(fix_dir_name(home_dir));
 340 }
 341
 342
 343 // Several sources are probed to ascertain the locale directory.
 344 // The only requirement is that the result is indeed a directory.
 345 FileName const get_locale_dir(FileName const & system_support_dir)
 346 {
 347         // 1. Use the "LYX_LOCALEDIR" environment variable.
 348         FileName const path_env = extract_env_var_dir("LYX_LOCALEDIR");
 349         if (!path_env.empty() && check_env_var_dir(path_env, "LYX_LOCALEDIR"))
 350                 return path_env;
 351
 352         // 2. Search for system_support_dir / <relative locale dir>
 353         // The <relative locale dir> is OS-dependent. (On Unix, it will
 354         // be "../locale/".)
 355         FileName path(addPath(system_support_dir.absFilename(),
 356                 relative_locale_dir()));
 357
 358         if (path.exists() && path.isDirectory())
 359                 return path;
 360
 361         // 3. Fall back to the hard-coded LOCALEDIR.
 362         path = hardcoded_localedir();
 363         if (path.exists() && path.isDirectory())
 364                 return path;
 365
 366         // 4. Search for source tree "po/" in case LyX was launched with
 367         // '-sysdir' argument.
 368         path.set(addPath(system_support_dir.absFilename(), "../po"));
 369         if (path.exists() && path.isDirectory())
 370                 return path;
 371
 372         return FileName();
 373 }
 374
 375
 376 // Specification of temp_dir_ may be reset by LyXRC,
 377 // but the default is fixed for a given OS.
 378 FileName const get_temp_dir()
 379 {
 380 #if defined (USE_WINDOWS_PACKAGING)
 381         // Typical example: C:/TEMP/.
 382         char path[MAX_PATH];
 383         GetTempPath(MAX_PATH, path);
 384         return FileName(to_utf8(from_local8bit(path)));
 385 #else // Posix-like.
 386         return FileName("/tmp");
 387 #endif
 388 }
 389
 390
 391 // Extracts the absolute path from the foo of "-sysdir foo" or "-userdir foo"
 392 FileName const abs_path_from_command_line(string const & command_line)
 393 {
 394         if (command_line.empty())
 395                 return FileName();
 396
 397         string const str_path = fix_dir_name(command_line);
 398         FileName path(str_path);
 399         return path.isAbsolute() ? path : makeAbsPath(str_path);
 400 }
 401
 402
 403 // Does the grunt work for abs_path_from_binary_name()
 404 FileName const get_binary_path(string const & exe)
 405 {
 406 #if defined (USE_WINDOWS_PACKAGING)
 407         // The executable may have been invoked either with or
 408         // without the .exe extension.
 409         // Ensure that it is present.
 410         string const as_internal_path = os::internal_path(exe);
 411         string const exe_path = suffixIs(as_internal_path, ".exe") ?
 412                 as_internal_path : as_internal_path + ".exe";
 413 #else
 414         string const exe_path = os::internal_path(exe);
 415 #endif
 416         FileName exepath(exe_path);
 417         if (exepath.isAbsolute())
 418                 return exepath;
 419
 420         // Two possibilities present themselves.
 421         // 1. The binary is relative to the CWD.
 422         FileName const abs_exe_path = makeAbsPath(exe_path);
 423         if (abs_exe_path.exists())
 424                 return abs_exe_path;
 425
 426         // 2. exe must be the name of the binary only and it
 427         // can be found on the PATH.
 428         string const exe_name = onlyFilename(exe_path);
 429         if (exe_name != exe_path)
 430                 return FileName();
 431
 432         vector<string> const path = getEnvPath("PATH");
 433         vector<string>::const_iterator it = path.begin();
 434         vector<string>::const_iterator const end = path.end();
 435         for (; it != end; ++it) {
 436                 // This will do nothing if *it is already absolute.
 437                 string const exe_dir = makeAbsPath(*it).absFilename();
 438
 439                 FileName const exe_path(addName(exe_dir, exe_name));
 440                 if (exe_path.exists())
 441                         return exe_path;
 442         }
 443
 444         // Didn't find anything.
 445         return FileName();
 446 }
 447
 448
 449 // Extracts the absolute path to the binary name received as argv[0].
 450 FileName const abs_path_from_binary_name(string const & exe)
 451 {
 452         FileName const abs_binary = get_binary_path(exe);
 453         if (abs_binary.empty()) {
 454                 // FIXME UNICODE
 455                 throw ExceptionMessage(ErrorException,
 456                         _("LyX binary not found"),
 457                         bformat(_("Unable to determine the path to the LyX binary from the command line %1$s"),
 458                                 from_utf8(exe)));
 459         }
 460         return abs_binary;
 461 }
 462
 463
 464 // A plethora of directories is searched to ascertain the system
 465 // lyxdir which is defined as the first directory to contain
 466 // "chkconfig.ltx".
 467 FileName const
 468 get_system_support_dir(FileName const & abs_binary,
 469                   string const & command_line_system_support_dir)
 470 {
 471         string const chkconfig_ltx = "chkconfig.ltx";
 472
 473         // searched_dirs is used for diagnostic purposes only in the case
 474         // that "chkconfig.ltx" is not found.
 475         list<FileName> searched_dirs;
 476
 477         // 1. Use the -sysdir command line parameter.
 478         FileName path = abs_path_from_command_line(command_line_system_support_dir);
 479         if (!path.empty()) {
 480                 searched_dirs.push_back(path);
 481                 if (check_command_line_dir(path.absFilename(), chkconfig_ltx, "-sysdir"))
 482                         return path;
 483         }
 484
 485         // 2. Use the "LYX_DIR_15x" environment variable.
 486         path = extract_env_var_dir("LYX_DIR_15x");
 487         if (!path.empty()) {
 488                 searched_dirs.push_back(path);
 489                 if (check_env_var_dir(path, chkconfig_ltx, "LYX_DIR_15x"))
 490                         return path;
 491         }
 492
 493         // 3. Search relative to the lyx binary.
 494         // We're looking for "chkconfig.ltx" in a directory
 495         //   OnlyPath(abs_binary) / <relative dir> / PACKAGE /
 496         // PACKAGE is hardcoded in config.h. Eg "lyx" or "lyx-1.3.6cvs".
 497         // <relative dir> is OS-dependent; on Unix, it will be "../share/".
 498         string const relative_lyxdir = relative_system_support_dir();
 499
 500         // One subtlety to be aware of. The name of the lyx binary may be
 501         // a symbolic link. If that is the case, then we follow the links too.
 502         FileName binary = abs_binary;
 503         while (true) {
 504                 // Try and find "chkconfig.ltx".
 505                 string const binary_dir = onlyPath(binary.absFilename());
 506
 507                 FileName const lyxdir(addPath(binary_dir, relative_lyxdir));
 508                 searched_dirs.push_back(lyxdir);
 509
 510                 if (!fileSearch(lyxdir.absFilename(), chkconfig_ltx).empty()) {
 511                         // Success! "chkconfig.ltx" has been found.
 512                         return lyxdir;
 513                 }
 514
 515                 // Check whether binary is a symbolic link.
 516                 // If so, resolve it and repeat the exercise.
 517                 if (!binary.isSymLink())
 518                         break;
 519
 520                 FileName link;
 521                 if (readLink(binary, link)) {
 522                         binary = link;
 523                 } else {
 524                         // Unable to resolve the link.
 525                         break;
 526                 }
 527         }
 528
 529         // 4. Repeat the exercise on the directory itself.
 530         FileName binary_dir(onlyPath(abs_binary.absFilename()));
 531         while (true) {
 532                 // This time test whether the directory is a symbolic link
 533                 // *before* looking for "chkconfig.ltx".
 534                 // (We've looked relative to the original already.)
 535                 if (!binary.isSymLink())
 536                         break;
 537
 538                 FileName link;
 539                 if (readLink(binary_dir, link)) {
 540                         binary_dir = link;
 541                 } else {
 542                         // Unable to resolve the link.
 543                         break;
 544                 }
 545
 546                 // Try and find "chkconfig.ltx".
 547                 FileName const lyxdir(addPath(binary_dir.absFilename(),
 548                         relative_lyxdir));
 549                 searched_dirs.push_back(lyxdir);
 550
 551                 if (!fileSearch(lyxdir.absFilename(), chkconfig_ltx).empty()) {
 552                         // Success! "chkconfig.ltx" has been found.
 553                         return lyxdir;
 554                 }
 555         }
 556
 557         // 5. In desparation, try the hard-coded system support dir.
 558         path = hardcoded_system_support_dir();
 559         if (!fileSearch(path.absFilename(), chkconfig_ltx).empty())
 560                 return path;
 561
 562         // Everything has failed :-(
 563         // So inform the user and exit.
 564         string searched_dirs_str;
 565         typedef list<FileName>::const_iterator iterator;
 566         iterator const begin = searched_dirs.begin();
 567         iterator const end = searched_dirs.end();
 568         for (iterator it = begin; it != end; ++it) {
 569                 if (it != begin)
 570                         searched_dirs_str += "\n\t";
 571                 searched_dirs_str += it->absFilename();
 572         }
 573
 574         // FIXME UNICODE
 575         throw ExceptionMessage(ErrorException, _("No system directory"),
 576                 bformat(_("Unable to determine the system directory "
 577                                          "having searched\n"
 578                                          "\t%1$s\n"
 579                                          "Use the '-sysdir' command line parameter or "
 580                                          "set the environment variable LYX_DIR_15x to "
 581                                          "the LyX system directory containing the file "
 582                                          "`chkconfig.ltx'."),
 583                           from_utf8(searched_dirs_str)));
 584
 585         // Keep the compiler happy.
 586         return FileName();
 587 }
 588
 589
 590 // Returns the absolute path to the user lyxdir, together with a flag
 591 // indicating whether this directory was specified explicitly (as -userdir
 592 // or through an environment variable) or whether it was deduced.
 593 bool userSupportDir(FileName const & default_user_support_dir,
 594         string const & command_line_user_support_dir, FileName & result)
 595 {
 596         // 1. Use the -userdir command line parameter.
 597         result = abs_path_from_command_line(command_line_user_support_dir);
 598         if (!result.empty())
 599                 return true;
 600
 601         // 2. Use the LYX_USERDIR_15x environment variable.
 602         result = extract_env_var_dir("LYX_USERDIR_15x");
 603         if (!result.empty())
 604                 return true;
 605
 606         // 3. Use the OS-dependent default_user_support_dir
 607         result = default_user_support_dir;
 608         return false;
 609 }
 610
 611
 612 // $HOME/.lyx on POSIX but on Win32 it will be something like
 613 // "C:/Documents and Settings/USERNAME/Application Data/LyX"
 614 FileName const get_default_user_support_dir(FileName const & home_dir)
 615 {
 616 #if defined (USE_WINDOWS_PACKAGING)
 617         (void)home_dir; // Silence warning about unused variable.
 618
 619         os::GetFolderPath win32_folder_path;
 620         return FileName(addPath(win32_folder_path(os::GetFolderPath::APPDATA), PACKAGE));
 621
 622 #elif defined (USE_MACOSX_PACKAGING)
 623         (void)home_dir; // Silence warning about unused variable.
 624
 625         FSRef fsref;
 626         OSErr const error_code =
 627                 FSFindFolder(kUserDomain, kApplicationSupportFolderType,
 628                              kDontCreateFolder, &fsref);
 629         if (error_code != 0)
 630                 return FileName();
 631
 632         // FSRefMakePath returns the result in utf8
 633         char store[PATH_MAX + 1];
 634         OSStatus const status_code =
 635                 FSRefMakePath(&fsref,
 636                               reinterpret_cast<UInt8*>(store), PATH_MAX);
 637         if (status_code != 0)
 638                 return FileName();
 639
 640         return FileName(addPath(reinterpret_cast<char const *>(store), PACKAGE));
 641
 642 #else // USE_POSIX_PACKAGING
 643         return FileName(addPath(home_dir.absFilename(), string(".") + PACKAGE));
 644 #endif
 645 }
 646
 647
 648 // Check that directory @c dir contains @c file.
 649 // Else emit an error message about an invalid @c command_line_switch.
 650 bool check_command_line_dir(string const & dir,
 651                             string const & file,
 652                             string const & command_line_switch)
 653 {
 654         FileName const abs_path = fileSearch(dir, file);
 655         if (abs_path.empty()) {
 656                 // FIXME UNICODE
 657                 throw ExceptionMessage(ErrorException, _("File not found"), bformat(
 658                         _("Invalid %1$s switch.\nDirectory %2$s does not contain %3$s."),
 659                         from_utf8(command_line_switch), from_utf8(dir),
 660                         from_utf8(file)));
 661         }
 662
 663         return !abs_path.empty();
 664 }
 665
 666
 667 // The environment variable @c env_var expands to a (single) file path.
 668 FileName const extract_env_var_dir(string const & env_var)
 669 {
 670         string const dir = fix_dir_name(getEnv(env_var));
 671         return dir.empty() ? FileName() : makeAbsPath(dir);
 672 }
 673
 674
 675 // Check that directory @c dir contains @c file.
 676 // Else emit a warning about an invalid @c env_var.
 677 bool check_env_var_dir(FileName const & dir,
 678                        string const & file,
 679                        string const & env_var)
 680 {
 681         FileName const abs_path = fileSearch(dir.absFilename(), file);
 682         if (abs_path.empty()) {
 683                 // FIXME UNICODE
 684                 throw ExceptionMessage(WarningException, _("File not found"), bformat(
 685                         _("Invalid %1$s environment variable.\n"
 686                                 "Directory %2$s does not contain %3$s."),
 687                         from_utf8(env_var), from_utf8(dir.absFilename()),
 688                         from_utf8(file)));
 689         }
 690
 691         return !abs_path.empty();
 692 }
 693
 694
 695 // Check that directory @c dir is indeed a directory.
 696 // Else emit a warning about an invalid @c env_var.
 697 bool check_env_var_dir(FileName const & dir,
 698                        string const & env_var)
 699 {
 700         bool const success = dir.exists() && dir.isDirectory();
 701
 702         if (!success) {
 703                 // Put this string on a single line so that the gettext
 704                 // search mechanism in po/Makefile.in.in will register
 705                 // Package.cpp.in as a file containing strings that need
 706                 // translation.
 707                 // FIXME UNICODE
 708                 docstring const fmt =
 709                         _("Invalid %1$s environment variable.\n%2$s is not a directory.");
 710
 711                 throw ExceptionMessage(WarningException, _("Directory not found"), bformat(
 712                         fmt, from_utf8(env_var), from_utf8(dir.absFilename())));
 713         }
 714
 715         return success;
 716 }
 717
 718
 719 // The locale directory relative to the LyX system directory.
 720 string const relative_locale_dir()
 721 {
 722 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
 723         return "locale/";
 724 #else
 725         return "../locale/";
 726 #endif
 727 }
 728
 729
 730 // The system lyxdir is relative to the directory containing the LyX binary.
 731 string const relative_system_support_dir()
 732 {
 733         string result;
 734
 735 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
 736         result = "../Resources/";
 737 #else // Posix-like.
 738         result = addPath("../share/", PACKAGE);
 739 #endif
 740
 741         return result;
 742 }
 743
 744 } // namespace anon
 745
 746 } // namespace support
 747 } // namespace lyx