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         return FileName();
 367 }
 368
 369
 370 // Specification of temp_dir_ may be reset by LyXRC,
 371 // but the default is fixed for a given OS.
 372 FileName const get_temp_dir()
 373 {
 374 #if defined (USE_WINDOWS_PACKAGING)
 375         // Typical example: C:/TEMP/.
 376         char path[MAX_PATH];
 377         GetTempPath(MAX_PATH, path);
 378         return FileName(to_utf8(from_local8bit(path)));
 379 #else // Posix-like.
 380         return FileName("/tmp");
 381 #endif
 382 }
 383
 384
 385 // Extracts the absolute path from the foo of "-sysdir foo" or "-userdir foo"
 386 FileName const abs_path_from_command_line(string const & command_line)
 387 {
 388         if (command_line.empty())
 389                 return FileName();
 390
 391         string const str_path = fix_dir_name(command_line);
 392         FileName path(str_path);
 393         return path.isAbsolute() ? path : makeAbsPath(str_path);
 394 }
 395
 396
 397 // Does the grunt work for abs_path_from_binary_name()
 398 FileName const get_binary_path(string const & exe)
 399 {
 400 #if defined (USE_WINDOWS_PACKAGING)
 401         // The executable may have been invoked either with or
 402         // without the .exe extension.
 403         // Ensure that it is present.
 404         string const as_internal_path = os::internal_path(exe);
 405         string const exe_path = suffixIs(as_internal_path, ".exe") ?
 406                 as_internal_path : as_internal_path + ".exe";
 407 #else
 408         string const exe_path = os::internal_path(exe);
 409 #endif
 410         FileName exepath(exe_path);
 411         if (exepath.isAbsolute())
 412                 return exepath;
 413
 414         // Two possibilities present themselves.
 415         // 1. The binary is relative to the CWD.
 416         FileName const abs_exe_path = makeAbsPath(exe_path);
 417         if (abs_exe_path.exists())
 418                 return abs_exe_path;
 419
 420         // 2. exe must be the name of the binary only and it
 421         // can be found on the PATH.
 422         string const exe_name = onlyFilename(exe_path);
 423         if (exe_name != exe_path)
 424                 return FileName();
 425
 426         vector<string> const path = getEnvPath("PATH");
 427         vector<string>::const_iterator it = path.begin();
 428         vector<string>::const_iterator const end = path.end();
 429         for (; it != end; ++it) {
 430                 // This will do nothing if *it is already absolute.
 431                 string const exe_dir = makeAbsPath(*it).absFilename();
 432
 433                 FileName const exe_path(addName(exe_dir, exe_name));
 434                 if (exe_path.exists())
 435                         return exe_path;
 436         }
 437
 438         // Didn't find anything.
 439         return FileName();
 440 }
 441
 442
 443 // Extracts the absolute path to the binary name received as argv[0].
 444 FileName const abs_path_from_binary_name(string const & exe)
 445 {
 446         FileName const abs_binary = get_binary_path(exe);
 447         if (abs_binary.empty()) {
 448                 // FIXME UNICODE
 449                 throw ExceptionMessage(ErrorException,
 450                         _("LyX binary not found"),
 451                         bformat(_("Unable to determine the path to the LyX binary from the command line %1$s"),
 452                                 from_utf8(exe)));
 453         }
 454         return abs_binary;
 455 }
 456
 457
 458 // A plethora of directories is searched to ascertain the system
 459 // lyxdir which is defined as the first directory to contain
 460 // "chkconfig.ltx".
 461 FileName const
 462 get_system_support_dir(FileName const & abs_binary,
 463                   string const & command_line_system_support_dir)
 464 {
 465         string const chkconfig_ltx = "chkconfig.ltx";
 466
 467         // searched_dirs is used for diagnostic purposes only in the case
 468         // that "chkconfig.ltx" is not found.
 469         list<FileName> searched_dirs;
 470
 471         // 1. Use the -sysdir command line parameter.
 472         FileName path = abs_path_from_command_line(command_line_system_support_dir);
 473         if (!path.empty()) {
 474                 searched_dirs.push_back(path);
 475                 if (check_command_line_dir(path.absFilename(), chkconfig_ltx, "-sysdir"))
 476                         return path;
 477         }
 478
 479         // 2. Use the "LYX_DIR_15x" environment variable.
 480         path = extract_env_var_dir("LYX_DIR_15x");
 481         if (!path.empty()) {
 482                 searched_dirs.push_back(path);
 483                 if (check_env_var_dir(path, chkconfig_ltx, "LYX_DIR_15x"))
 484                         return path;
 485         }
 486
 487         // 3. Search relative to the lyx binary.
 488         // We're looking for "chkconfig.ltx" in a directory
 489         //   OnlyPath(abs_binary) / <relative dir> / PACKAGE /
 490         // PACKAGE is hardcoded in config.h. Eg "lyx" or "lyx-1.3.6cvs".
 491         // <relative dir> is OS-dependent; on Unix, it will be "../share/".
 492         string const relative_lyxdir = relative_system_support_dir();
 493
 494         // One subtlety to be aware of. The name of the lyx binary may be
 495         // a symbolic link. If that is the case, then we follow the links too.
 496         FileName binary = abs_binary;
 497         while (true) {
 498                 // Try and find "chkconfig.ltx".
 499                 string const binary_dir = onlyPath(binary.absFilename());
 500
 501                 FileName const lyxdir(addPath(binary_dir, relative_lyxdir));
 502                 searched_dirs.push_back(lyxdir);
 503
 504                 if (!fileSearch(lyxdir.absFilename(), chkconfig_ltx).empty()) {
 505                         // Success! "chkconfig.ltx" has been found.
 506                         return lyxdir;
 507                 }
 508
 509                 // Check whether binary is a symbolic link.
 510                 // If so, resolve it and repeat the exercise.
 511                 if (!binary.isSymLink())
 512                         break;
 513
 514                 FileName link;
 515                 if (readLink(binary, link)) {
 516                         binary = link;
 517                 } else {
 518                         // Unable to resolve the link.
 519                         break;
 520                 }
 521         }
 522
 523         // 4. Repeat the exercise on the directory itself.
 524         FileName binary_dir(onlyPath(abs_binary.absFilename()));
 525         while (true) {
 526                 // This time test whether the directory is a symbolic link
 527                 // *before* looking for "chkconfig.ltx".
 528                 // (We've looked relative to the original already.)
 529                 if (!binary.isSymLink())
 530                         break;
 531
 532                 FileName link;
 533                 if (readLink(binary_dir, link)) {
 534                         binary_dir = link;
 535                 } else {
 536                         // Unable to resolve the link.
 537                         break;
 538                 }
 539
 540                 // Try and find "chkconfig.ltx".
 541                 FileName const lyxdir(addPath(binary_dir.absFilename(),
 542                         relative_lyxdir));
 543                 searched_dirs.push_back(lyxdir);
 544
 545                 if (!fileSearch(lyxdir.absFilename(), chkconfig_ltx).empty()) {
 546                         // Success! "chkconfig.ltx" has been found.
 547                         return lyxdir;
 548                 }
 549         }
 550
 551         // 5. In desparation, try the hard-coded system support dir.
 552         path = hardcoded_system_support_dir();
 553         if (!fileSearch(path.absFilename(), chkconfig_ltx).empty())
 554                 return path;
 555
 556         // Everything has failed :-(
 557         // So inform the user and exit.
 558         string searched_dirs_str;
 559         typedef list<FileName>::const_iterator iterator;
 560         iterator const begin = searched_dirs.begin();
 561         iterator const end = searched_dirs.end();
 562         for (iterator it = begin; it != end; ++it) {
 563                 if (it != begin)
 564                         searched_dirs_str += "\n\t";
 565                 searched_dirs_str += it->absFilename();
 566         }
 567
 568         // FIXME UNICODE
 569         throw ExceptionMessage(ErrorException, _("No system directory"),
 570                 bformat(_("Unable to determine the system directory "
 571                                          "having searched\n"
 572                                          "\t%1$s\n"
 573                                          "Use the '-sysdir' command line parameter or "
 574                                          "set the environment variable LYX_DIR_15x to "
 575                                          "the LyX system directory containing the file "
 576                                          "`chkconfig.ltx'."),
 577                           from_utf8(searched_dirs_str)));
 578
 579         // Keep the compiler happy.
 580         return FileName();
 581 }
 582
 583
 584 // Returns the absolute path to the user lyxdir, together with a flag
 585 // indicating whether this directory was specified explicitly (as -userdir
 586 // or through an environment variable) or whether it was deduced.
 587 bool userSupportDir(FileName const & default_user_support_dir,
 588         string const & command_line_user_support_dir, FileName & result)
 589 {
 590         // 1. Use the -userdir command line parameter.
 591         result = abs_path_from_command_line(command_line_user_support_dir);
 592         if (!result.empty())
 593                 return true;
 594
 595         // 2. Use the LYX_USERDIR_15x environment variable.
 596         result = extract_env_var_dir("LYX_USERDIR_15x");
 597         if (!result.empty())
 598                 return true;
 599
 600         // 3. Use the OS-dependent default_user_support_dir
 601         result = default_user_support_dir;
 602         return false;
 603 }
 604
 605
 606 // $HOME/.lyx on POSIX but on Win32 it will be something like
 607 // "C:/Documents and Settings/USERNAME/Application Data/LyX"
 608 FileName const get_default_user_support_dir(FileName const & home_dir)
 609 {
 610 #if defined (USE_WINDOWS_PACKAGING)
 611         (void)home_dir; // Silence warning about unused variable.
 612
 613         os::GetFolderPath win32_folder_path;
 614         return FileName(addPath(win32_folder_path(os::GetFolderPath::APPDATA), PACKAGE));
 615
 616 #elif defined (USE_MACOSX_PACKAGING)
 617         (void)home_dir; // Silence warning about unused variable.
 618
 619         FSRef fsref;
 620         OSErr const error_code =
 621                 FSFindFolder(kUserDomain, kApplicationSupportFolderType,
 622                              kDontCreateFolder, &fsref);
 623         if (error_code != 0)
 624                 return FileName();
 625
 626         // FSRefMakePath returns the result in utf8
 627         char store[PATH_MAX + 1];
 628         OSStatus const status_code =
 629                 FSRefMakePath(&fsref,
 630                               reinterpret_cast<UInt8*>(store), PATH_MAX);
 631         if (status_code != 0)
 632                 return FileName();
 633
 634         return FileName(addPath(reinterpret_cast<char const *>(store), PACKAGE));
 635
 636 #else // USE_POSIX_PACKAGING
 637         return FileName(addPath(home_dir.absFilename(), string(".") + PACKAGE));
 638 #endif
 639 }
 640
 641
 642 // Check that directory @c dir contains @c file.
 643 // Else emit an error message about an invalid @c command_line_switch.
 644 bool check_command_line_dir(string const & dir,
 645                             string const & file,
 646                             string const & command_line_switch)
 647 {
 648         FileName const abs_path = fileSearch(dir, file);
 649         if (abs_path.empty()) {
 650                 // FIXME UNICODE
 651                 throw ExceptionMessage(ErrorException, _("File not found"), bformat(
 652                         _("Invalid %1$s switch.\nDirectory %2$s does not contain %3$s."),
 653                         from_utf8(command_line_switch), from_utf8(dir),
 654                         from_utf8(file)));
 655         }
 656
 657         return !abs_path.empty();
 658 }
 659
 660
 661 // The environment variable @c env_var expands to a (single) file path.
 662 FileName const extract_env_var_dir(string const & env_var)
 663 {
 664         string const dir = fix_dir_name(getEnv(env_var));
 665         return dir.empty() ? FileName() : makeAbsPath(dir);
 666 }
 667
 668
 669 // Check that directory @c dir contains @c file.
 670 // Else emit a warning about an invalid @c env_var.
 671 bool check_env_var_dir(FileName const & dir,
 672                        string const & file,
 673                        string const & env_var)
 674 {
 675         FileName const abs_path = fileSearch(dir.absFilename(), file);
 676         if (abs_path.empty()) {
 677                 // FIXME UNICODE
 678                 throw ExceptionMessage(WarningException, _("File not found"), bformat(
 679                         _("Invalid %1$s environment variable.\n"
 680                                 "Directory %2$s does not contain %3$s."),
 681                         from_utf8(env_var), from_utf8(dir.absFilename()),
 682                         from_utf8(file)));
 683         }
 684
 685         return !abs_path.empty();
 686 }
 687
 688
 689 // Check that directory @c dir is indeed a directory.
 690 // Else emit a warning about an invalid @c env_var.
 691 bool check_env_var_dir(FileName const & dir,
 692                        string const & env_var)
 693 {
 694         bool const success = dir.exists() && dir.isDirectory();
 695
 696         if (!success) {
 697                 // Put this string on a single line so that the gettext
 698                 // search mechanism in po/Makefile.in.in will register
 699                 // Package.cpp.in as a file containing strings that need
 700                 // translation.
 701                 // FIXME UNICODE
 702                 docstring const fmt =
 703                         _("Invalid %1$s environment variable.\n%2$s is not a directory.");
 704
 705                 throw ExceptionMessage(WarningException, _("Directory not found"), bformat(
 706                         fmt, from_utf8(env_var), from_utf8(dir.absFilename())));
 707         }
 708
 709         return success;
 710 }
 711
 712
 713 // The locale directory relative to the LyX system directory.
 714 string const relative_locale_dir()
 715 {
 716 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
 717         return "locale/";
 718 #else
 719         return "../locale/";
 720 #endif
 721 }
 722
 723
 724 // The system lyxdir is relative to the directory containing the LyX binary.
 725 string const relative_system_support_dir()
 726 {
 727         string result;
 728
 729 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
 730         result = "../Resources/";
 731 #else // Posix-like.
 732         result = addPath("../share/", PACKAGE);
 733 #endif
 734
 735         return result;
 736 }
 737
 738 } // namespace anon
 739
 740 } // namespace support
 741 } // namespace lyx