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