lyx_mirror/src/support/filetools.cpp

929 lines
25 KiB
C++
Raw Normal View History

/**
Rename files in src/support, step one. src/support/package.h src/support/Package.h Package src/support/package.C.in src/support/Package.C.in Package src/support/path.h src/support/Path.h Path src/support/fs_extras.h src/support/fs_extras.h NOCLASSES src/support/RandomAccessList.h src/support/RandomAccessList.h RandomAccessList src/support/lyxmanip.h src/support/lyxmanip.h NOCLASSES src/support/rename.C src/support/rename.cpp NOCLASSES src/support/abort.C src/support/abort.cpp NOCLASSES src/support/lyxlib.h src/support/lyxlib.h NOCLASSES src/support/ExceptionMessage.h src/support/ExceptionMessage.h ExceptionMessage src/support/copy.C src/support/copy.cpp NOCLASSES src/support/limited_stack.h src/support/limited_stack.h limited_stack src/support/filefilterlist.C src/support/FileFilterList.cpp ['FileFilterList', 'Filter'] src/support/cow_ptr.h src/support/cow_ptr.h cow_ptr src/support/os_unix.C src/support/os_unix.cpp NOCLASSES src/support/socktools.h src/support/socktools.h NOCLASSES src/support/forkedcontr.h src/support/ForkedcallsController.h ForkedcallsController src/support/os.h src/support/os.h NOCLASSES src/support/FileMonitor.h src/support/FileMonitor.h FileMonitor src/support/copied_ptr.h src/support/copied_ptr.h copied_ptr src/support/translator.h src/support/Translator.h Translator src/support/filetools.C src/support/filetools.cpp NOCLASSES src/support/unlink.C src/support/unlink.cpp NOCLASSES src/support/os_win32.C src/support/os_win32.cpp GetFolderPath src/support/lstrings.C src/support/lstrings.cpp NOCLASSES src/support/qstring_helpers.C src/support/qstring_helpers.cpp NOCLASSES src/support/getcwd.C src/support/getcwd.cpp NOCLASSES src/support/systemcall.C src/support/Systemcall.cpp Systemcall src/support/lyxalgo.h src/support/lyxalgo.h NOCLASSES src/support/filefilterlist.h src/support/FileFilterList.h ['FileFilterList', 'Filter'] src/support/unicode.C src/support/unicode.cpp IconvProcessor src/support/userinfo.C src/support/userinfo.cpp NOCLASSES src/support/lyxtime.C src/support/lyxtime.cpp NOCLASSES src/support/kill.C src/support/kill.cpp NOCLASSES src/support/docstring.C src/support/docstring.cpp to_local8bit_failure src/support/os_cygwin.C src/support/os_cygwin.cpp NOCLASSES src/support/lyxsum.C src/support/lyxsum.cpp NOCLASSES src/support/environment.C src/support/environment.cpp NOCLASSES src/support/filetools.h src/support/filetools.h NOCLASSES src/support/textutils.C src/support/textutils.cpp NOCLASSES src/support/mkdir.C src/support/mkdir.cpp NOCLASSES src/support/forkedcall.C src/support/Forkedcall.cpp ['ForkedProcess', 'Forkedcall'] src/support/tempname.C src/support/tempname.cpp NOCLASSES src/support/os_win32.h src/support/os_win32.h GetFolderPath src/support/types.h src/support/types.h NOCLASSES src/support/lstrings.h src/support/lstrings.h NOCLASSES src/support/forkedcallqueue.C src/support/ForkedCallQueue.cpp ForkedCallQueue src/support/qstring_helpers.h src/support/qstring_helpers.h NOCLASSES src/support/convert.C src/support/convert.cpp NOCLASSES src/support/filename.C src/support/FileName.cpp ['FileName', 'DocFileName'] src/support/tests/convert.C src/support/tests/convert.cpp NOCLASSES src/support/tests/filetools.C src/support/tests/filetools.cpp NOCLASSES src/support/tests/lstrings.C src/support/tests/lstrings.cpp NOCLASSES src/support/tests/boost.C src/support/tests/boost.cpp NOCLASSES src/support/docstream.C src/support/docstream.cpp ['iconv_codecvt_facet_exception', 'idocfstream', 'odocfstream'] src/support/std_istream.h src/support/std_istream.h NOCLASSES src/support/systemcall.h src/support/Systemcall.h Systemcall src/support/chdir.C src/support/chdir.cpp NOCLASSES src/support/std_ostream.h src/support/std_ostream.h NOCLASSES src/support/unicode.h src/support/unicode.h IconvProcessor src/support/path.C src/support/Path.cpp Path src/support/fs_extras.C src/support/fs_extras.cpp NOCLASSES src/support/userinfo.h src/support/userinfo.h NOCLASSES src/support/lyxtime.h src/support/lyxtime.h NOCLASSES src/support/docstring.h src/support/docstring.h to_local8bit_failure src/support/debugstream.h src/support/debugstream.h basic_debugstream src/support/environment.h src/support/environment.h NOCLASSES src/support/textutils.h src/support/textutils.h NOCLASSES src/support/forkedcall.h src/support/Forkedcall.h ['ForkedProcess', 'Forkedcall'] src/support/socktools.C src/support/socktools.cpp NOCLASSES src/support/forkedcallqueue.h src/support/ForkedCallQueue.h ForkedCallQueue src/support/forkedcontr.C src/support/ForkedcallsController.cpp ForkedcallsController src/support/os.C src/support/os.cpp NOCLASSES src/support/convert.h src/support/convert.h NOCLASSES src/support/filename.h src/support/FileName.h ['FileName', 'DocFileName'] src/support/docstream.h src/support/docstream.h ['iconv_codecvt_facet_exception', 'idocfstream', 'odocfstream'] src/support/FileMonitor.C src/support/FileMonitor.cpp FileMonitor git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@18024 a592a061-630c-0410-9148-cb99ea01b6c8
2007-04-26 05:12:52 +00:00
* \file filetools.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* parts Copyright 1985, 1990, 1993 Free Software Foundation, Inc.
*
* \author Ivan Schreter
* \author Dirk Niggemann
* \author Asger Alstrup
* \author Lars Gullik Bj<EFBFBD>nnes
* \author Jean-Marc Lasgouttes
* \author Angus Leeming
* \author John Levon
* \author Herbert Vo<EFBFBD>
*
* Full author contact details are available in file CREDITS.
*
* General path-mangling functions
*/
#include <config.h>
#include "support/filetools.h"
#include "support/convert.h"
#include "support/debug.h"
#include "support/environment.h"
#include "support/gettext.h"
#include "support/lstrings.h"
#include "support/os.h"
Rename files in src/support, step one. src/support/package.h src/support/Package.h Package src/support/package.C.in src/support/Package.C.in Package src/support/path.h src/support/Path.h Path src/support/fs_extras.h src/support/fs_extras.h NOCLASSES src/support/RandomAccessList.h src/support/RandomAccessList.h RandomAccessList src/support/lyxmanip.h src/support/lyxmanip.h NOCLASSES src/support/rename.C src/support/rename.cpp NOCLASSES src/support/abort.C src/support/abort.cpp NOCLASSES src/support/lyxlib.h src/support/lyxlib.h NOCLASSES src/support/ExceptionMessage.h src/support/ExceptionMessage.h ExceptionMessage src/support/copy.C src/support/copy.cpp NOCLASSES src/support/limited_stack.h src/support/limited_stack.h limited_stack src/support/filefilterlist.C src/support/FileFilterList.cpp ['FileFilterList', 'Filter'] src/support/cow_ptr.h src/support/cow_ptr.h cow_ptr src/support/os_unix.C src/support/os_unix.cpp NOCLASSES src/support/socktools.h src/support/socktools.h NOCLASSES src/support/forkedcontr.h src/support/ForkedcallsController.h ForkedcallsController src/support/os.h src/support/os.h NOCLASSES src/support/FileMonitor.h src/support/FileMonitor.h FileMonitor src/support/copied_ptr.h src/support/copied_ptr.h copied_ptr src/support/translator.h src/support/Translator.h Translator src/support/filetools.C src/support/filetools.cpp NOCLASSES src/support/unlink.C src/support/unlink.cpp NOCLASSES src/support/os_win32.C src/support/os_win32.cpp GetFolderPath src/support/lstrings.C src/support/lstrings.cpp NOCLASSES src/support/qstring_helpers.C src/support/qstring_helpers.cpp NOCLASSES src/support/getcwd.C src/support/getcwd.cpp NOCLASSES src/support/systemcall.C src/support/Systemcall.cpp Systemcall src/support/lyxalgo.h src/support/lyxalgo.h NOCLASSES src/support/filefilterlist.h src/support/FileFilterList.h ['FileFilterList', 'Filter'] src/support/unicode.C src/support/unicode.cpp IconvProcessor src/support/userinfo.C src/support/userinfo.cpp NOCLASSES src/support/lyxtime.C src/support/lyxtime.cpp NOCLASSES src/support/kill.C src/support/kill.cpp NOCLASSES src/support/docstring.C src/support/docstring.cpp to_local8bit_failure src/support/os_cygwin.C src/support/os_cygwin.cpp NOCLASSES src/support/lyxsum.C src/support/lyxsum.cpp NOCLASSES src/support/environment.C src/support/environment.cpp NOCLASSES src/support/filetools.h src/support/filetools.h NOCLASSES src/support/textutils.C src/support/textutils.cpp NOCLASSES src/support/mkdir.C src/support/mkdir.cpp NOCLASSES src/support/forkedcall.C src/support/Forkedcall.cpp ['ForkedProcess', 'Forkedcall'] src/support/tempname.C src/support/tempname.cpp NOCLASSES src/support/os_win32.h src/support/os_win32.h GetFolderPath src/support/types.h src/support/types.h NOCLASSES src/support/lstrings.h src/support/lstrings.h NOCLASSES src/support/forkedcallqueue.C src/support/ForkedCallQueue.cpp ForkedCallQueue src/support/qstring_helpers.h src/support/qstring_helpers.h NOCLASSES src/support/convert.C src/support/convert.cpp NOCLASSES src/support/filename.C src/support/FileName.cpp ['FileName', 'DocFileName'] src/support/tests/convert.C src/support/tests/convert.cpp NOCLASSES src/support/tests/filetools.C src/support/tests/filetools.cpp NOCLASSES src/support/tests/lstrings.C src/support/tests/lstrings.cpp NOCLASSES src/support/tests/boost.C src/support/tests/boost.cpp NOCLASSES src/support/docstream.C src/support/docstream.cpp ['iconv_codecvt_facet_exception', 'idocfstream', 'odocfstream'] src/support/std_istream.h src/support/std_istream.h NOCLASSES src/support/systemcall.h src/support/Systemcall.h Systemcall src/support/chdir.C src/support/chdir.cpp NOCLASSES src/support/std_ostream.h src/support/std_ostream.h NOCLASSES src/support/unicode.h src/support/unicode.h IconvProcessor src/support/path.C src/support/Path.cpp Path src/support/fs_extras.C src/support/fs_extras.cpp NOCLASSES src/support/userinfo.h src/support/userinfo.h NOCLASSES src/support/lyxtime.h src/support/lyxtime.h NOCLASSES src/support/docstring.h src/support/docstring.h to_local8bit_failure src/support/debugstream.h src/support/debugstream.h basic_debugstream src/support/environment.h src/support/environment.h NOCLASSES src/support/textutils.h src/support/textutils.h NOCLASSES src/support/forkedcall.h src/support/Forkedcall.h ['ForkedProcess', 'Forkedcall'] src/support/socktools.C src/support/socktools.cpp NOCLASSES src/support/forkedcallqueue.h src/support/ForkedCallQueue.h ForkedCallQueue src/support/forkedcontr.C src/support/ForkedcallsController.cpp ForkedcallsController src/support/os.C src/support/os.cpp NOCLASSES src/support/convert.h src/support/convert.h NOCLASSES src/support/filename.h src/support/FileName.h ['FileName', 'DocFileName'] src/support/docstream.h src/support/docstream.h ['iconv_codecvt_facet_exception', 'idocfstream', 'odocfstream'] src/support/FileMonitor.C src/support/FileMonitor.cpp FileMonitor git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@18024 a592a061-630c-0410-9148-cb99ea01b6c8
2007-04-26 05:12:52 +00:00
#include "support/Package.h"
#include "support/Path.h"
#include "support/Systemcall.h"
#include "support/qstring_helpers.h"
#include <QDir>
#include "support/lassert.h"
#include <boost/regex.hpp>
#include <fcntl.h>
#include <cerrno>
#include <cstdlib>
#include <cstdio>
#include <utility>
#include <fstream>
#include <sstream>
using namespace std;
namespace lyx {
namespace support {
bool isLyXFilename(string const & filename)
{
return suffixIs(ascii_lowercase(filename), ".lyx");
}
bool isSGMLFilename(string const & filename)
{
return suffixIs(ascii_lowercase(filename), ".sgml");
}
bool isValidLaTeXFilename(string const & filename)
{
string const invalid_chars("#$%{}()[]\"^");
return filename.find_first_of(invalid_chars) == string::npos;
}
string const latex_path(string const & original_path,
latex_path_extension extension,
latex_path_dots dots)
{
// On cygwin, we may need windows or posix style paths.
string path = os::latex_path(original_path);
path = subst(path, "~", "\\string~");
if (path.find(' ') != string::npos) {
// We can't use '"' because " is sometimes active (e.g. if
// babel is loaded with the "german" option)
if (extension == EXCLUDE_EXTENSION) {
// ChangeExtension calls os::internal_path internally
// so don't use it to remove the extension.
string const ext = getExtension(path);
string const base = ext.empty() ?
path :
path.substr(0, path.length() - ext.length() - 1);
// ChangeExtension calls os::internal_path internally
// so don't use it to re-add the extension.
path = "\\string\"" + base + "\\string\"." + ext;
} else {
path = "\\string\"" + path + "\\string\"";
}
}
return dots == ESCAPE_DOTS ? subst(path, ".", "\\lyxdot ") : path;
}
// Substitutes spaces with underscores in filename (and path)
FileName const makeLatexName(FileName const & file)
{
string name = file.onlyFileName();
string const path = file.onlyPath().absFilename() + "/";
// ok so we scan through the string twice, but who cares.
// FIXME: in Unicode time this will break for sure! There is
// a non-latin world out there...
string const keep = "abcdefghijklmnopqrstuvwxyz"
"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
"@!'()*+,-./0123456789:;<=>?[]`|";
string::size_type pos = 0;
while ((pos = name.find_first_not_of(keep, pos)) != string::npos)
name[pos++] = '_';
FileName latex_name(path + name);
latex_name.changeExtension(".tex");
return latex_name;
}
string const quoteName(string const & name, quote_style style)
{
switch(style) {
case quote_shell:
// This does not work for filenames containing " (windows)
// or ' (all other OSes). This can't be changed easily, since
// we would need to adapt the command line parser in
// Forkedcall::generateChild. Therefore we don't pass user
// filenames to child processes if possible. We store them in
// a python script instead, where we don't have these
// limitations.
return (os::shell() == os::UNIX) ?
'\'' + name + '\'':
'"' + name + '"';
case quote_python:
return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
+ "\"";
}
// shut up stupid compiler
return string();
}
#if 0
// Uses a string of paths separated by ";"s to find a file to open.
// Can't cope with pathnames with a ';' in them. Returns full path to file.
// If path entry begins with $$LyX/, use system_lyxdir
// If path entry begins with $$User/, use user_lyxdir
// Example: "$$User/doc;$$LyX/doc"
FileName const fileOpenSearch(string const & path, string const & name,
string const & ext)
{
FileName real_file;
string path_element;
bool notfound = true;
string tmppath = split(path, path_element, ';');
while (notfound && !path_element.empty()) {
path_element = os::internal_path(path_element);
if (!suffixIs(path_element, '/'))
path_element += '/';
path_element = subst(path_element, "$$LyX",
package().system_support().absFilename());
path_element = subst(path_element, "$$User",
package().user_support().absFilename());
real_file = fileSearch(path_element, name, ext);
if (real_file.empty()) {
do {
tmppath = split(tmppath, path_element, ';');
} while (!tmppath.empty() && path_element.empty());
} else {
notfound = false;
}
}
return real_file;
}
#endif
// Returns the real name of file name in directory path, with optional
// extension ext.
FileName const fileSearch(string const & path, string const & name,
string const & ext, search_mode mode)
{
// if `name' is an absolute path, we ignore the setting of `path'
// Expand Environmentvariables in 'name'
string const tmpname = replaceEnvironmentPath(name);
FileName fullname(makeAbsPath(tmpname, path));
// search first without extension, then with it.
if (fullname.isReadableFile())
return fullname;
if (ext.empty())
// We are done.
return mode == may_not_exist ? fullname : FileName();
// Only add the extension if it is not already the extension of
// fullname.
if (getExtension(fullname.absFilename()) != ext)
fullname = FileName(addExtension(fullname.absFilename(), ext));
if (fullname.isReadableFile() || mode == may_not_exist)
return fullname;
return FileName();
}
// Search the file name.ext in the subdirectory dir of
// 1) user_lyxdir
// 2) build_lyxdir (if not empty)
// 3) system_lyxdir
FileName const libFileSearch(string const & dir, string const & name,
string const & ext)
{
FileName fullname = fileSearch(addPath(package().user_support().absFilename(), dir),
name, ext);
if (!fullname.empty())
return fullname;
if (!package().build_support().empty())
fullname = fileSearch(addPath(package().build_support().absFilename(), dir),
name, ext);
if (!fullname.empty())
return fullname;
return fileSearch(addPath(package().system_support().absFilename(), dir), name, ext);
}
FileName const i18nLibFileSearch(string const & dir, string const & name,
string const & ext)
{
/* The highest priority value is the `LANGUAGE' environment
variable. But we don't use the value if the currently
selected locale is the C locale. This is a GNU extension.
Otherwise, w use a trick to guess what support/gettext.has done:
each po file is able to tell us its name. (JMarc)
*/
string lang = to_ascii(_("[[Replace with the code of your language]]"));
string const language = getEnv("LANGUAGE");
if (!lang.empty() && !language.empty())
lang = language;
string l;
lang = split(lang, l, ':');
while (!l.empty()) {
FileName tmp;
// First try with the full name
tmp = libFileSearch(addPath(dir, l), name, ext);
if (!tmp.empty())
return tmp;
// Then the name without country code
string const shortl = token(l, '_', 0);
if (shortl != l) {
tmp = libFileSearch(addPath(dir, shortl), name, ext);
if (!tmp.empty())
return tmp;
}
#if 1
// For compatibility, to be removed later (JMarc)
tmp = libFileSearch(dir, token(l, '_', 0) + '_' + name,
ext);
if (!tmp.empty()) {
lyxerr << "i18nLibFileSearch: File `" << tmp
<< "' has been found by the old method" <<endl;
return tmp;
}
#endif
lang = split(lang, l, ':');
}
return libFileSearch(dir, name, ext);
}
string const libScriptSearch(string const & command_in, quote_style style)
{
static string const token_scriptpath = "$$s/";
string command = command_in;
// Find the starting position of "$$s/"
string::size_type const pos1 = command.find(token_scriptpath);
if (pos1 == string::npos)
return command;
// Find the end of the "$$s/some_subdir/some_script" word within
// command. Assumes that the script name does not contain spaces.
string::size_type const start_script = pos1 + 4;
string::size_type const pos2 = command.find(' ', start_script);
string::size_type const size_script = pos2 == string::npos?
(command.size() - start_script) : pos2 - start_script;
// Does this script file exist?
string const script =
libFileSearch(".", command.substr(start_script, size_script)).absFilename();
if (script.empty()) {
// Replace "$$s/" with ""
command.erase(pos1, 4);
} else {
// Replace "$$s/foo/some_script" with "<path to>/some_script".
string::size_type const size_replace = size_script + 4;
command.replace(pos1, size_replace, quoteName(script, style));
}
return command;
}
static FileName createTmpDir(FileName const & tempdir, string const & mask)
{
LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
<< "createTmpDir: mask=`" << mask << '\'');
string const tmp_dir = tempdir.absFilename() + "/" + mask;
FileName const tmpfl = FileName::tempName(tmp_dir);
if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
LYXERR0("LyX could not create the temporary directory '" << tmp_dir
<< "'");
return FileName();
}
return tmpfl;
}
FileName const createLyXTmpDir(FileName const & deflt)
{
if (deflt.empty() || deflt == package().system_temp_dir())
return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
if (deflt.createDirectory(0777))
return deflt;
if (deflt.isDirWritable()) {
// deflt could not be created because it
// did exist already, so let's create our own
// dir inside deflt.
return createTmpDir(deflt, "lyx_tmpdir");
} else {
// some other error occured.
return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
}
}
// Strip filename from path name
string const onlyPath(string const & filename)
{
// If empty filename, return empty
if (filename.empty())
return filename;
// Find last / or start of filename
size_t j = filename.rfind('/');
return j == string::npos ? "./" : filename.substr(0, j + 1);
}
// Convert relative path into absolute path based on a basepath.
// If relpath is absolute, just use that.
// If basepath is empty, use CWD as base.
// Note that basePath can be a relative path, in the sense that it may
// not begin with "/" (e.g.), but it should NOT contain such constructs
// as "/../".
// FIXME It might be nice if the code didn't simply assume that.
FileName const makeAbsPath(string const & relPath, string const & basePath)
{
FileName relative_path(relPath);
// checks for already absolute path
if (relative_path.isAbsolute())
return relative_path;
// Copies given paths
string tempRel = os::internal_path(relPath);
// Since TempRel is NOT absolute, we can safely replace "//" with "/"
tempRel = subst(tempRel, "//", "/");
string tempBase;
FileName base_path(basePath);
if (base_path.isAbsolute())
tempBase = basePath;
else
tempBase = addPath(FileName::getcwd().absFilename(), basePath);
// Handle /./ at the end of the path
while (suffixIs(tempBase, "/./"))
tempBase.erase(tempBase.length() - 2);
// processes relative path
string rTemp = tempRel;
string temp;
// Check for a leading "~"
// Split by first /
rTemp = split(rTemp, temp, '/');
if (temp == "~") {
tempBase = package().home_dir().absFilename();
tempRel = rTemp;
}
rTemp = tempRel;
while (!rTemp.empty()) {
// Split by next /
rTemp = split(rTemp, temp, '/');
if (temp == ".") continue;
if (temp == "..") {
// Remove one level of TempBase
if (tempBase.length() <= 1) {
//this is supposed to be an absolute path, so...
tempBase = "/";
continue;
}
//erase a trailing slash if there is one
if (suffixIs(tempBase, "/"))
tempBase.erase(tempBase.length() - 1, string::npos);
string::size_type i = tempBase.length() - 1;
while (i > 0 && tempBase[i] != '/')
--i;
if (i > 0)
tempBase.erase(i, string::npos);
else
tempBase = '/';
} else if (temp.empty() && !rTemp.empty()) {
tempBase = os::current_root() + rTemp;
rTemp.erase();
} else {
// Add this piece to TempBase
if (!suffixIs(tempBase, '/'))
tempBase += '/';
tempBase += temp;
}
}
// returns absolute path
return FileName(tempBase);
}
// Correctly append filename to the pathname.
// If pathname is '.', then don't use pathname.
// Chops any path of filename.
string const addName(string const & path, string const & fname)
{
string const basename = onlyFilename(fname);
string buf;
if (path != "." && path != "./" && !path.empty()) {
buf = os::internal_path(path);
if (!suffixIs(path, '/'))
buf += '/';
}
return buf + basename;
}
// Strips path from filename
string const onlyFilename(string const & fname)
{
if (fname.empty())
return fname;
string::size_type j = fname.rfind('/');
if (j == string::npos) // no '/' in fname
return fname;
// Strip to basename
return fname.substr(j + 1);
}
// Create absolute path. If impossible, don't do anything
// Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
string const expandPath(string const & path)
{
// checks for already absolute path
string rTemp = replaceEnvironmentPath(path);
FileName abs_path(rTemp);
if (abs_path.isAbsolute())
return rTemp;
string temp;
string const copy = rTemp;
// Split by next /
rTemp = split(rTemp, temp, '/');
if (temp == ".")
return FileName::getcwd().absFilename() + '/' + rTemp;
if (temp == "~")
return package().home_dir().absFilename() + '/' + rTemp;
if (temp == "..")
return makeAbsPath(copy).absFilename();
// Don't know how to handle this
return copy;
}
// Search the string for ${VAR} and $VAR and replace VAR using getenv.
string const replaceEnvironmentPath(string const & path)
{
// ${VAR} is defined as
// $\{[A-Za-z_][A-Za-z_0-9]*\}
static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
// $VAR is defined as:
// $\{[A-Za-z_][A-Za-z_0-9]*\}
static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
static boost::regex envvar_br_re("(.*)" + envvar_br + "(.*)");
static boost::regex envvar_re("(.*)" + envvar + "(.*)");
boost::smatch what;
string result = path;
while (1) {
regex_match(result, what, envvar_br_re);
if (!what[0].matched) {
regex_match(result, what, envvar_re);
if (!what[0].matched)
break;
}
result = what.str(1) + getEnv(what.str(2)) + what.str(3);
}
return result;
}
// Make relative path out of two absolute paths
docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
// Makes relative path out of absolute path. If it is deeper than basepath,
// it's easy. If basepath and abspath share something (they are all deeper
// than some directory), it'll be rendered using ..'s. If they are completely
// different, then the absolute path will be used as relative path.
{
docstring::size_type const abslen = abspath.length();
docstring::size_type const baselen = basepath.length();
docstring::size_type i = os::common_path(abspath, basepath);
if (i == 0) {
// actually no match - cannot make it relative
return abspath;
}
// Count how many dirs there are in basepath above match
// and append as many '..''s into relpath
docstring buf;
docstring::size_type j = i;
while (j < baselen) {
if (basepath[j] == '/') {
if (j + 1 == baselen)
break;
buf += "../";
}
++j;
}
// Append relative stuff from common directory to abspath
if (abspath[i] == '/')
++i;
for (; i < abslen; ++i)
buf += abspath[i];
// Remove trailing /
if (suffixIs(buf, '/'))
buf.erase(buf.length() - 1);
// Substitute empty with .
if (buf.empty())
buf = '.';
return buf;
}
// Append sub-directory(ies) to a path in an intelligent way
string const addPath(string const & path, string const & path_2)
{
string buf;
string const path2 = os::internal_path(path_2);
if (!path.empty() && path != "." && path != "./") {
buf = os::internal_path(path);
if (path[path.length() - 1] != '/')
buf += '/';
}
if (!path2.empty()) {
string::size_type const p2start = path2.find_first_not_of('/');
string::size_type const p2end = path2.find_last_not_of('/');
string const tmp = path2.substr(p2start, p2end - p2start + 1);
buf += tmp + '/';
}
return buf;
}
string const changeExtension(string const & oldname, string const & extension)
{
string::size_type const last_slash = oldname.rfind('/');
string::size_type last_dot = oldname.rfind('.');
if (last_dot < last_slash && last_slash != string::npos)
last_dot = string::npos;
string ext;
// Make sure the extension starts with a dot
if (!extension.empty() && extension[0] != '.')
ext= '.' + extension;
else
ext = extension;
return os::internal_path(oldname.substr(0, last_dot) + ext);
}
string const removeExtension(string const & name)
{
return changeExtension(name, string());
}
string const addExtension(string const & name, string const & extension)
{
if (!extension.empty() && extension[0] != '.')
return name + '.' + extension;
return name + extension;
}
/// Return the extension of the file (not including the .)
string const getExtension(string const & name)
{
string::size_type const last_slash = name.rfind('/');
string::size_type const last_dot = name.rfind('.');
if (last_dot != string::npos &&
(last_slash == string::npos || last_dot > last_slash))
return name.substr(last_dot + 1,
name.length() - (last_dot + 1));
else
return string();
}
string const unzippedFileName(string const & zipped_file)
{
string const ext = getExtension(zipped_file);
if (ext == "gz" || ext == "z" || ext == "Z")
return changeExtension(zipped_file, string());
return onlyPath(zipped_file) + "unzipped_" + onlyFilename(zipped_file);
}
FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
{
FileName const tempfile = FileName(unzipped_file.empty() ?
unzippedFileName(zipped_file.toFilesystemEncoding()) :
unzipped_file);
// Run gunzip
string const command = "gunzip -c " +
zipped_file.toFilesystemEncoding() + " > " +
tempfile.toFilesystemEncoding();
Systemcall one;
one.startscript(Systemcall::Wait, command);
// test that command was executed successfully (anon)
// yes, please do. (Lgb)
return tempfile;
}
docstring const makeDisplayPath(string const & path, unsigned int threshold)
{
string str = path;
// If file is from LyXDir, display it as if it were relative.
string const system = package().system_support().absFilename();
if (prefixIs(str, system) && str != system)
return from_utf8("[" + str.erase(0, system.length()) + "]");
// replace /home/blah with ~/
string const home = package().home_dir().absFilename();
if (!home.empty() && prefixIs(str, home))
str = subst(str, home, "~");
if (str.length() <= threshold)
return from_utf8(os::external_path(str));
string const prefix = ".../";
string temp;
while (str.length() > threshold)
str = split(str, temp, '/');
// Did we shorten everything away?
if (str.empty()) {
// Yes, filename itself is too long.
// Pick the start and the end of the filename.
str = onlyFilename(path);
string const head = str.substr(0, threshold / 2 - 3);
string::size_type len = str.length();
string const tail =
str.substr(len - threshold / 2 - 2, len - 1);
str = head + "..." + tail;
}
return from_utf8(os::external_path(prefix + str));
}
bool readLink(FileName const & file, FileName & link)
{
#ifdef HAVE_READLINK
char linkbuffer[512];
// Should be PATH_MAX but that needs autconf support
string const encoded = file.toFilesystemEncoding();
int const nRead = ::readlink(encoded.c_str(),
linkbuffer, sizeof(linkbuffer) - 1);
if (nRead <= 0)
return false;
linkbuffer[nRead] = '\0'; // terminator
link = makeAbsPath(linkbuffer, onlyPath(file.absFilename()));
return true;
#else
return false;
#endif
}
cmd_ret const runCommand(string const & cmd)
{
// FIXME: replace all calls to RunCommand with ForkedCall
// (if the output is not needed) or the code in ISpell.cpp
// (if the output is needed).
// One question is if we should use popen or
// create our own popen based on fork, exec, pipe
// of course the best would be to have a
// pstream (process stream), with the
// variants ipstream, opstream
#if defined (HAVE_POPEN)
FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
#elif defined (HAVE__POPEN)
FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
#else
#error No popen() function.
#endif
// (Claus Hentschel) Check if popen was succesful ;-)
if (!inf) {
lyxerr << "RunCommand:: could not start child process" << endl;
return make_pair(-1, string());
}
string ret;
int c = fgetc(inf);
while (c != EOF) {
ret += static_cast<char>(c);
c = fgetc(inf);
}
#if defined (HAVE_PCLOSE)
int const pret = pclose(inf);
#elif defined (HAVE__PCLOSE)
int const pret = _pclose(inf);
#else
#error No pclose() function.
#endif
if (pret == -1)
perror("RunCommand:: could not terminate child process");
return make_pair(pret, ret);
}
FileName const findtexfile(string const & fil, string const & /*format*/)
{
/* There is no problem to extend this function too use other
methods to look for files. It could be setup to look
in environment paths and also if wanted as a last resort
to a recursive find. One of the easier extensions would
perhaps be to use the LyX file lookup methods. But! I am
going to implement this until I see some demand for it.
Lgb
*/
// If the file can be found directly, we just return a
// absolute path version of it.
FileName const absfile(makeAbsPath(fil));
if (absfile.exists())
return absfile;
// Now we try to find it using kpsewhich.
// It seems from the kpsewhich manual page that it is safe to use
// kpsewhich without --format: "When the --format option is not
// given, the search path used when looking for a file is inferred
// from the name given, by looking for a known extension. If no
// known extension is found, the search path for TeX source files
// is used."
// However, we want to take advantage of the format sine almost all
// the different formats has environment variables that can be used
// to controll which paths to search. f.ex. bib looks in
// BIBINPUTS and TEXBIB. Small list follows:
// bib - BIBINPUTS, TEXBIB
// bst - BSTINPUTS
// graphic/figure - TEXPICTS, TEXINPUTS
// ist - TEXINDEXSTYLE, INDEXSTYLE
// pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
// tex - TEXINPUTS
// tfm - TFMFONTS, TEXFONTS
// This means that to use kpsewhich in the best possible way we
// should help it by setting additional path in the approp. envir.var.
string const kpsecmd = "kpsewhich " + fil;
cmd_ret const c = runCommand(kpsecmd);
LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
<< "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
if (c.first != -1)
return FileName(rtrim(to_utf8(from_filesystem8bit(c.second)), "\n\r"));
else
return FileName();
}
void removeAutosaveFile(string const & filename)
{
string a = onlyPath(filename);
a += '#';
a += onlyFilename(filename);
a += '#';
FileName const autosave(a);
if (autosave.exists())
autosave.removeFile();
}
void readBB_lyxerrMessage(FileName const & file, bool & zipped,
string const & message)
{
LYXERR(Debug::GRAPHICS, "[readBB_from_PSFile] " << message);
// FIXME: Why is this func deleting a file? (Lgb)
if (zipped)
file.removeFile();
}
string const readBB_from_PSFile(FileName const & file)
{
// in a (e)ps-file it's an entry like %%BoundingBox:23 45 321 345
// It seems that every command in the header has an own line,
// getline() should work for all files.
// On the other hand some plot programs write the bb at the
// end of the file. Than we have in the header:
// %%BoundingBox: (atend)
// In this case we must check the end.
bool zipped = file.isZippedFile();
FileName const file_ = zipped ? unzipFile(file) : file;
string const format = file_.guessFormatFromContents();
if (format != "eps" && format != "ps") {
readBB_lyxerrMessage(file_, zipped,"no(e)ps-format");
return string();
}
static boost::regex bbox_re(
"^%%BoundingBox:\\s*([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)");
ifstream is(file_.toFilesystemEncoding().c_str());
while (is) {
string s;
getline(is,s);
boost::smatch what;
if (regex_match(s, what, bbox_re)) {
// Our callers expect the tokens in the string
// separated by single spaces.
// FIXME: change return type from string to something
// sensible
ostringstream os;
os << what.str(1) << ' ' << what.str(2) << ' '
<< what.str(3) << ' ' << what.str(4);
string const bb = os.str();
readBB_lyxerrMessage(file_, zipped, bb);
return bb;
}
}
readBB_lyxerrMessage(file_, zipped, "no bb found");
return string();
}
int compare_timestamps(FileName const & file1, FileName const & file2)
{
// If the original is newer than the copy, then copy the original
// to the new directory.
int cmp = 0;
if (file1.exists() && file2.exists()) {
double const tmp = difftime(file1.lastModified(), file2.lastModified());
if (tmp != 0)
cmp = tmp > 0 ? 1 : -1;
} else if (file1.exists()) {
cmp = 1;
} else if (file2.exists()) {
cmp = -1;
}
return cmp;
}
} //namespace support
} // namespace lyx