#include "debug.h"
#include "gettext.h"
-#include "support/FileInfo.h"
+#include "support/environment.h"
#include "support/filetools.h"
#include "support/lstrings.h"
+#include "support/ExceptionMessage.h"
#include "support/os.h"
-#include <boost/assert.hpp>
+#if defined (USE_WINDOWS_PACKAGING)
+# include "support/os_win32.h"
+#endif
+
+#include <boost/filesystem/operations.hpp>
#include <boost/tuple/tuple.hpp>
#include <list>
#error USE_FOO_PACKAGING must be defined for FOO = WINDOWS, MACOSX or POSIX.
#endif
-#if defined (USE_WINDOWS_PACKAGING)
-# include <windows.h>
-# include <shlobj.h> // SHGetFolderPath
-
- // Needed for MinGW:
-# ifndef SHGFP_TYPE_CURRENT
-# define SHGFP_TYPE_CURRENT 0
-# endif
-
-#elif defined (USE_MACOSX_PACKAGING)
+#if defined (USE_MACOSX_PACKAGING)
# include <CoreServices/CoreServices.h> // FSFindFolder, FSRefMakePath
#endif
using std::string;
+namespace fs = boost::filesystem;
namespace lyx {
namespace support {
void init_package(string const & command_line_arg0,
string const & command_line_system_support_dir,
- string const & command_line_user_support_dir)
+ string const & command_line_user_support_dir,
+ exe_build_dir_to_top_build_dir top_build_dir_location)
{
// Can do so only once.
if (initialised_)
package_ = Package(command_line_arg0,
command_line_system_support_dir,
- command_line_user_support_dir);
+ command_line_user_support_dir,
+ top_build_dir_location);
initialised_ = true;
}
Package const & package()
{
- BOOST_ASSERT(initialised_);
+ // Commented out because package().locale_dir() can be called
+ // from the message translation code in messages.C before
+ // init_package() is called. Lars is on the case...
+ // BOOST_ASSERT(initialised_);
return package_;
}
string const abs_path_from_binary_name(string const & exe);
-std::pair<string, string> const get_build_dirs(string const & abs_binary);
+std::pair<string, string> const
+get_build_dirs(string const & abs_binary,
+ exe_build_dir_to_top_build_dir top_build_dir_location);
string const get_document_dir(string const & home_dir);
string const get_locale_dir(string const & system_support_dir);
string const get_system_support_dir(string const & abs_binary,
- string const & command_line_system_support_dir);
+ string const & command_line_system_support_dir);
string const get_temp_dir();
get_user_support_dir(string const & default_user_support_dir,
string const & command_line_user_support_dir);
+
+string const & with_version_suffix();
+
} // namespace anon
Package::Package(string const & command_line_arg0,
string const & command_line_system_support_dir,
- string const & command_line_user_support_dir)
+ string const & command_line_user_support_dir,
+ exe_build_dir_to_top_build_dir top_build_dir_location)
: explicit_user_support_dir_(false)
{
home_dir_ = get_home_dir();
- temp_dir_ = get_temp_dir();
+ system_temp_dir_ = get_temp_dir();
+ temp_dir_ = system_temp_dir_;
document_dir_ = get_document_dir(home_dir_);
string const abs_binary = abs_path_from_binary_name(command_line_arg0);
- binary_dir_ = OnlyPath(abs_binary);
+ binary_dir_ = onlyPath(abs_binary);
// Is LyX being run in-place from the build tree?
boost::tie(build_support_dir_, system_support_dir_) =
- get_build_dirs(abs_binary);
+ get_build_dirs(abs_binary, top_build_dir_location);
if (build_support_dir_.empty())
system_support_dir_ =
get_user_support_dir(default_user_support_dir,
command_line_user_support_dir);
+ string const configure_script = addName(system_support(), "configure.py");
+ configure_command_ = os::python() + ' ' + quoteName(configure_script)
+ + with_version_suffix();
+
lyxerr[Debug::INIT]
<< "<package>\n"
<< "\tbinary_dir " << binary_dir() << '\n'
<< "\tdocument_dir " << document_dir() << '\n'
<< "\ttemp_dir " << temp_dir() << '\n'
<< "\thome_dir " << home_dir() << '\n'
- << "<\\package>\n" << std::endl;
+ << "</package>\n" << std::endl;
}
// configuration-time.
string const top_srcdir()
{
- static string const dir("%TOP_SRCDIR%");
+ static string const dir("@TOP_SRCDIR@");
return dir;
}
string const hardcoded_localedir()
{
- return string("%LOCALEDIR%");
+ return string("@LOCALEDIR@");
}
string const hardcoded_system_support_dir()
{
- return string("%LYX_DIR%");
+ return string("@LYX_DIR@");
+}
+
+
+string const & with_version_suffix()
+{
+ static string const program_suffix("@PROGRAM_SUFFIX@");
+ static string const
+ with_version_suffix(" --with-version-suffix=@PROGRAM_SUFFIX@");
+ return program_suffix.empty() ? program_suffix : with_version_suffix;
}
} // namespace anon
string const & Package::top_srcdir() const
{
- static string const dir("%TOP_SRCDIR%");
+ static string const dir("@TOP_SRCDIR@");
return dir;
}
string const relative_system_support_dir();
-#if defined (USE_WINDOWS_PACKAGING)
-// Given a folder ID, returns the folder name (in unix-style format).
-// Eg CSIDL_PERSONAL -> "C:/Documents and Settings/USERNAME/My Documents"
-string const win32_folder_path(int folder_id)
+std::string const
+get_build_support_dir(std::string const & binary_dir,
+ exe_build_dir_to_top_build_dir top_build_dir_location)
{
- char folder_path[PATH_MAX + 1];
- if (SUCCEEDED(SHGetFolderPath(0, folder_id, 0,
- SHGFP_TYPE_CURRENT, folder_path)))
- return os::internal_path(folder_path);
- return string();
+ string indirection;
+ switch (top_build_dir_location) {
+ case top_build_dir_is_one_level_up:
+ indirection = "../lib";
+ break;
+ case top_build_dir_is_two_levels_up:
+ indirection = "../../lib";
+ break;
+ }
+
+ return normalizePath(addPath(binary_dir, indirection));
}
-#endif
-std::pair<string, string> const get_build_dirs(string const & abs_binary)
+std::pair<string, string> const
+get_build_dirs(string const & abs_binary,
+ exe_build_dir_to_top_build_dir top_build_dir_location)
{
string const check_text = "Checking whether LyX is run in place...";
- // We're looking for "lyxrc.defaults" in a directory
+ // We're looking for "Makefile" in a directory
// binary_dir/../lib
// We're also looking for "chkconfig.ltx" in a directory
- // binary_dir/top_srcdir()/lib
+ // top_srcdir()/lib
// If both are found, then we're running LyX in-place.
// Note that the name of the lyx binary may be a symbolic link.
string binary = abs_binary;
while (true) {
// Try and find "lyxrc.defaults".
- string const binary_dir = OnlyPath(binary);
+ string const binary_dir = onlyPath(binary);
string const build_support_dir =
- NormalizePath(AddPath(binary_dir, "../lib"));
+ get_build_support_dir(binary_dir, top_build_dir_location);
- if (!FileSearch(build_support_dir, "lyxrc.defaults").empty()) {
+ if (!fileSearch(build_support_dir, "Makefile").empty()) {
// Try and find "chkconfig.ltx".
string const system_support_dir =
- MakeAbsPath(AddPath(top_srcdir(), "lib"),
- AddPath(binary_dir, "support"));
+ addPath(top_srcdir(), "lib");
- if (!FileSearch(system_support_dir, "chkconfig.ltx").empty()) {
+ if (!fileSearch(system_support_dir, "chkconfig.ltx").empty()) {
lyxerr[Debug::INIT] << check_text << " yes"
<< std::endl;
return std::make_pair(build_support_dir, system_support_dir);
// Check whether binary is a symbolic link.
// If so, resolve it and repeat the exercise.
- FileInfo const file(binary, true);
- if (!file.isOK() || !file.isLink())
+ if (!fs::symbolic_link_exists(FileName(binary).toFilesystemEncoding()))
break;
string link;
- if (LyXReadLink(binary, link, true)) {
+ if (readLink(binary, link, true)) {
binary = link;
} else {
// Unable to resolve the link.
{
#if defined (USE_WINDOWS_PACKAGING)
(void)home_dir; // Silence warning about unused variable.
- return win32_folder_path(CSIDL_PERSONAL);
+ os::GetFolderPath win32_folder_path;
+ return win32_folder_path(os::GetFolderPath::PERSONAL);
#else // Posix-like.
return home_dir;
#endif
string const get_home_dir()
{
#if defined (USE_WINDOWS_PACKAGING)
- string const home_dir = GetEnv("USERPROFILE");
+ string const home_dir = getEnv("USERPROFILE");
#else // Posix-like.
- string const home_dir = GetEnv("HOME");
+ string const home_dir = getEnv("HOME");
#endif
return os::internal_path(home_dir);
string const get_locale_dir(string const & system_support_dir)
{
// 1. Use the "LYX_LOCALEDIR" environment variable.
- string path = extract_env_var_dir("LYX_LOCALEDIR");
- if (!path.empty() && check_env_var_dir(path, "LYX_LOCALEDIR"))
- return path;
+ string const path_env = extract_env_var_dir("LYX_LOCALEDIR");
+ if (!path_env.empty() && check_env_var_dir(path_env, "LYX_LOCALEDIR"))
+ return path_env;
// 2. Search for system_support_dir / <relative locale dir>
// The <relative locale dir> is OS-dependent. (On Unix, it will
// be "../locale/".)
- path = NormalizePath(AddPath(system_support_dir, relative_locale_dir()));
+ FileName path(normalizePath(addPath(system_support_dir, relative_locale_dir())));
- FileInfo fi(path);
- if (fi.isOK() && fi.isDir())
- return path;
+ if (fs::exists(path.toFilesystemEncoding()) &&
+ fs::is_directory(path.toFilesystemEncoding()))
+ return path.absFilename();
// 3. Fall back to the hard-coded LOCALEDIR.
- path = hardcoded_localedir();
- FileInfo fi2(path);
- if (fi2.isOK() && fi2.isDir())
- return path;
+ path = FileName(hardcoded_localedir());
+ if (fs::exists(path.toFilesystemEncoding()) &&
+ fs::is_directory(path.toFilesystemEncoding()))
+ return path.absFilename();
return string();
}
{
#if defined (USE_WINDOWS_PACKAGING)
// Typical example: C:/TEMP/.
- char path[PATH_MAX + 1];
- GetTempPath(PATH_MAX, path);
+ char path[MAX_PATH];
+ GetTempPath(MAX_PATH, path);
return os::internal_path(path);
#else // Posix-like.
return "/tmp";
}
-// If we use a 'lazy' lyxerr in the hope of setting the locale before
-// printing any messages, then we should ensure that it is flushed first.
-void bail_out()
-{
-#ifndef CXX_GLOBAL_CSTD
- using std::exit;
-#endif
- exit(1);
-}
-
-
// Extracts the absolute path from the foo of "-sysdir foo" or "-userdir foo"
string const abs_path_from_command_line(string const & command_line)
{
return string();
string const path = os::internal_path(command_line);
- return os::is_absolute_path(path) ? path : MakeAbsPath(path);
+ return os::is_absolute_path(path) ? path : makeAbsPath(path).absFilename();
}
// Does the grunt work for abs_path_from_binary_name()
string const get_binary_path(string const & exe)
{
+#if defined (USE_WINDOWS_PACKAGING)
+ // The executable may have been invoked either with or
+ // without the .exe extension.
+ // Ensure that it is present.
+ string const as_internal_path = os::internal_path(exe);
+ string const exe_path = suffixIs(as_internal_path, ".exe") ?
+ as_internal_path : as_internal_path + ".exe";
+#else
string const exe_path = os::internal_path(exe);
+#endif
if (os::is_absolute_path(exe_path))
return exe_path;
// Two possibilities present themselves.
// 1. The binary is relative to the CWD.
- string const abs_exe_path = MakeAbsPath(exe_path);
- if (FileInfo(abs_exe_path, true).isOK())
+ string const abs_exe_path = makeAbsPath(exe_path).absFilename();
+ if (fs::exists(FileName(abs_exe_path).toFilesystemEncoding()))
return abs_exe_path;
// 2. exe must be the name of the binary only and it
// can be found on the PATH.
- string const exe_name = OnlyFilename(exe_path);
+ string const exe_name = onlyFilename(exe_path);
if (exe_name != exe_path)
return string();
std::vector<string>::const_iterator it = path.begin();
std::vector<string>::const_iterator const end = path.end();
for (; it != end; ++it) {
- if (!os::is_absolute_path(*it))
- // Someone is playing silly buggers.
- continue;
+ // This will do nothing if *it is already absolute.
+ string const exe_dir = makeAbsPath(*it).absFilename();
- string const exe_path = AddName(*it, exe_name);
- if (FileInfo(exe_path, true).isOK())
+ string const exe_path = addName(exe_dir, exe_name);
+ if (fs::exists(FileName(exe_path).toFilesystemEncoding()))
return exe_path;
}
{
string const abs_binary = get_binary_path(exe);
if (abs_binary.empty()) {
- lyxerr << bformat(_("Unable to determine the path to the "
- "LyX binary from the command line %1%"),
- exe)
- << std::endl;
- bail_out();
+ // FIXME UNICODE
+ throw ExceptionMessage(ErrorException,
+ _("LyX binary not found"),
+ bformat(_("Unable to determine the path to the LyX binary from the command line %1$s"),
+ lyx::from_utf8(exe)));
}
return abs_binary;
}
return path;
}
- // 2. Use the "LYX_DIR_13x" environment variable.
- path = extract_env_var_dir("LYX_DIR_13x");
+ // 2. Use the "LYX_DIR_15x" environment variable.
+ path = extract_env_var_dir("LYX_DIR_15x");
if (!path.empty()) {
searched_dirs.push_back(path);
- if (check_env_var_dir(path, chkconfig_ltx, "LYX_DIR_13x"))
+ if (check_env_var_dir(path, chkconfig_ltx, "LYX_DIR_15x"))
return path;
}
string binary = abs_binary;
while (true) {
// Try and find "chkconfig.ltx".
- string const binary_dir = OnlyPath(binary);
+ string const binary_dir = onlyPath(binary);
string const lyxdir =
- NormalizePath(AddPath(binary_dir, relative_lyxdir));
+ normalizePath(addPath(binary_dir, relative_lyxdir));
searched_dirs.push_back(lyxdir);
- if (!FileSearch(lyxdir, chkconfig_ltx).empty()) {
+ if (!fileSearch(lyxdir, chkconfig_ltx).empty()) {
// Success! "chkconfig.ltx" has been found.
return lyxdir;
}
// Check whether binary is a symbolic link.
// If so, resolve it and repeat the exercise.
- FileInfo const file(binary, true);
- if (!file.isOK() || !file.isLink())
+ if (!fs::symbolic_link_exists(FileName(binary).toFilesystemEncoding()))
break;
string link;
- if (LyXReadLink(binary, link, true)) {
+ if (readLink(binary, link, true)) {
binary = link;
} else {
// Unable to resolve the link.
}
// 4. Repeat the exercise on the directory itself.
- string binary_dir = OnlyPath(abs_binary);
+ string binary_dir = onlyPath(abs_binary);
while (true) {
// This time test whether the directory is a symbolic link
// *before* looking for "chkconfig.ltx".
// (We've looked relative to the original already.)
- FileInfo const file(binary_dir, true);
- if (!file.isOK() || !file.isLink())
+ if (!fs::symbolic_link_exists(FileName(binary).toFilesystemEncoding()))
break;
string link;
- if (LyXReadLink(binary_dir, link, true)) {
+ if (readLink(binary_dir, link, true)) {
binary_dir = link;
} else {
// Unable to resolve the link.
// Try and find "chkconfig.ltx".
string const lyxdir =
- NormalizePath(AddPath(binary_dir, relative_lyxdir));
+ normalizePath(addPath(binary_dir, relative_lyxdir));
searched_dirs.push_back(lyxdir);
- if (!FileSearch(lyxdir, chkconfig_ltx).empty()) {
+ if (!fileSearch(lyxdir, chkconfig_ltx).empty()) {
// Success! "chkconfig.ltx" has been found.
return lyxdir;
}
// 5. In desparation, try the hard-coded system support dir.
path = hardcoded_system_support_dir();
- if (!FileSearch(path, chkconfig_ltx).empty())
+ if (!fileSearch(path, chkconfig_ltx).empty())
return path;
// Everything has failed :-(
searched_dirs_str += *it;
}
- lyxerr << bformat(_("Unable to determine the system directory "
- "having searched\n"
- "\t%1%\n"
- "Try the '-sysdir' command line parameter or "
- "set the environment variable LYX_DIR_13x to "
- "the LyX system directory containing the file "
- "`chkconfig.ltx'."),
- searched_dirs_str)
- << std::endl;
-
- bail_out();
+ // FIXME UNICODE
+ throw ExceptionMessage(ErrorException, _("No system directory"),
+ bformat(_("Unable to determine the system directory "
+ "having searched\n"
+ "\t%1$s\n"
+ "Use the '-sysdir' command line parameter or "
+ "set the environment variable LYX_DIR_15x to "
+ "the LyX system directory containing the file "
+ "`chkconfig.ltx'."),
+ lyx::from_utf8(searched_dirs_str)));
+
// Keep the compiler happy.
return string();
}
if (!path.empty())
return std::make_pair(path, explicit_userdir);
- // 2. Use the LYX_USERDIR_13x environment variable.
- path = extract_env_var_dir("LYX_USERDIR_13x");
+ // 2. Use the LYX_USERDIR_15x environment variable.
+ path = extract_env_var_dir("LYX_USERDIR_15x");
if (!path.empty())
return std::make_pair(path, explicit_userdir);
}
-// $HOME/.lyx on all platforms but Win32 where it will be something like
-// "C:/Documents and Settings/USERNAME/Application Data/lyx"
+// $HOME/.lyx on POSIX but on Win32 it will be something like
+// "C:/Documents and Settings/USERNAME/Application Data/LyX"
string const get_default_user_support_dir(string const & home_dir)
{
#if defined (USE_WINDOWS_PACKAGING)
(void)home_dir; // Silence warning about unused variable.
- return AddPath(win32_folder_path(CSIDL_APPDATA), PACKAGE);
+ os::GetFolderPath win32_folder_path;
+ return addPath(win32_folder_path(os::GetFolderPath::APPDATA), PACKAGE);
#elif defined (USE_MACOSX_PACKAGING)
(void)home_dir; // Silence warning about unused variable.
if (error_code != 0)
return string();
- char store[PATH_MAX + 1];
+ char store[PATH_MAX + 1];
OSStatus const status_code =
FSRefMakePath(&fsref,
- reinterpret_cast<UInt8*>(store), PATH_MAX);
+ reinterpret_cast<UInt8*>(store), PATH_MAX);
if (status_code != 0)
return string();
- return AddPath(reinterpret_cast<char const *>(store), PACKAGE);
+ return addPath(reinterpret_cast<char const *>(store), PACKAGE);
#else // USE_POSIX_PACKAGING
- return AddPath(home_dir, string(".") + PACKAGE);
+ return addPath(home_dir, string(".") + PACKAGE);
#endif
}
string const & file,
string const & command_line_switch)
{
- string const abs_path = FileSearch(dir, file);
+ FileName const abs_path = fileSearch(dir, file);
if (abs_path.empty()) {
- lyxerr << bformat(_("Invalid %1% switch.\n"
- "Directory %2% does not contain %3%."),
- command_line_switch, dir, file)
- << std::endl;
+ // FIXME UNICODE
+ throw ExceptionMessage(WarningException, _("File not found"), bformat(
+ _("Invalid %1$s switch.\nDirectory %2$s does not contain %3$s."),
+ lyx::from_utf8(command_line_switch), lyx::from_utf8(dir),
+ lyx::from_utf8(file)));
}
return !abs_path.empty();
// The environment variable @c env_var expands to a (single) file path.
string const extract_env_var_dir(string const & env_var)
{
- string const dir = os::internal_path(GetEnv(env_var));
- return dir.empty() ? dir : MakeAbsPath(dir);
+ string const dir = os::internal_path(getEnv(env_var));
+ return dir.empty() ? dir : makeAbsPath(dir).absFilename();
}
string const & file,
string const & env_var)
{
- string const abs_path = FileSearch(dir, file);
+ FileName const abs_path = fileSearch(dir, file);
if (abs_path.empty()) {
- lyxerr << bformat(_("Invalid %1% environment variable.\n"
- "Directory %2% does not contain %3%."),
- env_var, dir, file)
- << std::endl;
+ // FIXME UNICODE
+ throw ExceptionMessage(WarningException, _("File not found"), bformat(
+ _("Invalid %1$s environment variable.\n"
+ "Directory %2$s does not contain %3$s."),
+ lyx::from_utf8(env_var), lyx::from_utf8(dir),
+ lyx::from_utf8(file)));
}
return !abs_path.empty();
bool check_env_var_dir(string const & dir,
string const & env_var)
{
- FileInfo fi(dir);
- bool const success = (fi.isOK() && fi.isDir());
+ string const encoded(FileName(dir).toFilesystemEncoding());
+ bool const success = (fs::exists(encoded) && fs::is_directory(encoded));
if (!success) {
- lyxerr << bformat(_("Invalid %1% environment variable.\n"
- "%2% is not a directory."),
- env_var, dir)
- << std::endl;
+ // Put this string on a single line so that the gettext
+ // search mechanism in po/Makefile.in.in will register
+ // package.C.in as a file containing strings that need
+ // translation.
+ // FIXME UNICODE
+ docstring const fmt =
+ _("Invalid %1$s environment variable.\n%2$s is not a directory.");
+
+ throw ExceptionMessage(WarningException, _("Directory not found"), bformat(
+ fmt, lyx::from_utf8(env_var), lyx::from_utf8(dir)));
}
return success;
// The locale directory relative to the LyX system directory.
string const relative_locale_dir()
{
+#if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
+ return "locale/";
+#else
return "../locale/";
+#endif
}
string result;
#if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
- result = AddPath("../Resources/", PACKAGE);
+ result = "../Resources/";
#else // Posix-like.
- result = AddPath("../share/", PACKAGE);
+ result = addPath("../share/", PACKAGE);
#endif
return result;
projects / lyx.git / blobdiff