* \author John Levon
* \author Herbert Voß
*
- * This file is part of LyX, the document processor.
- * Licence details can be found in the file COPYING.
+ * Full author contact details are available in file CREDITS.
*
* General path-mangling functions
*/
#include <config.h>
-#include "debug.h"
-#include "support/tostr.h"
+#include "support/convert.h"
+#include "support/environment.h"
+#include "support/filetools.h"
+#include "support/fs_extras.h"
+#include "support/lstrings.h"
+#include "support/lyxlib.h"
+#include "support/os.h"
+#include "support/package.h"
+#include "support/path.h"
#include "support/systemcall.h"
-#include "support/LAssert.h"
-#include "filetools.h"
-#include "lstrings.h"
-#include "FileInfo.h"
-#include "path.h"
-#include "path_defines.h"
+// FIXME Interface violation
#include "gettext.h"
-#include "lyxlib.h"
-#include "os.h"
+#include "debug.h"
-#include "support/std_sstream.h"
+#include <boost/assert.hpp>
+#include <boost/filesystem/operations.hpp>
+#include <boost/regex.hpp>
+
+#include <fcntl.h>
-#include <boost/cregex.hpp>
#include <cctype>
+#include <cerrno>
#include <cstdlib>
#include <cstdio>
-#include <fcntl.h>
-#include <cerrno>
#include <utility>
#include <fstream>
-
-
-// Which part of this is still necessary? (JMarc).
-#if HAVE_DIRENT_H
-# include <dirent.h>
-# define NAMLEN(dirent) strlen((dirent)->d_name)
-#else
-# define dirent direct
-# define NAMLEN(dirent) (dirent)->d_namlen
-# if HAVE_SYS_NDIR_H
-# include <sys/ndir.h>
-# endif
-# if HAVE_SYS_DIR_H
-# include <sys/dir.h>
-# endif
-# if HAVE_NDIR_H
-# include <ndir.h>
-# endif
-#endif
+#include <sstream>
#ifndef CXX_GLOBAL_CSTD
using std::fgetc;
using std::endl;
using std::getline;
using std::make_pair;
-
+using std::string;
using std::ifstream;
using std::ostringstream;
using std::vector;
+namespace fs = boost::filesystem;
namespace lyx {
namespace support {
-bool IsLyXFilename(string const & filename)
+bool isLyXFilename(string const & filename)
{
return suffixIs(ascii_lowercase(filename), ".lyx");
}
-bool IsSGMLFilename(string const & filename)
+bool isSGMLFilename(string const & filename)
{
return suffixIs(ascii_lowercase(filename), ".sgml");
}
+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)
-string const MakeLatexName(string const & file)
+string const makeLatexName(string const & file)
{
- string name = OnlyFilename(file);
- string const path = OnlyPath(file);
+ string name = onlyFilename(file);
+ string const path = onlyPath(file);
- for (string::size_type i = 0; i < name.length(); ++i) {
+ for (string::size_type i = 0; i < name.length(); ++i)
name[i] &= 0x7f; // set 8th bit to 0
- };
// ok so we scan through the string twice, but who cares.
- string const keep("abcdefghijklmnopqrstuvwxyz"
+ string const keep = "abcdefghijklmnopqrstuvwxyz"
"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
- "@!\"'()*+,-./0123456789:;<=>?[]`|");
+ "@!\"'()*+,-./0123456789:;<=>?[]`|";
string::size_type pos = 0;
- while ((pos = name.find_first_not_of(keep, pos)) != string::npos) {
+ while ((pos = name.find_first_not_of(keep, pos)) != string::npos)
name[pos++] = '_';
- }
- return AddName(path, name);
-}
-
-// Substitutes spaces with underscores in filename (and path)
-string const QuoteName(string const & name)
-{
- return (os::shell() == os::UNIX) ?
- '\'' + name + '\'':
- '"' + name + '"';
+ return addName(path, name);
}
-// Is a file readable ?
-bool IsFileReadable(string const & path)
+string const quoteName(string const & name, quote_style style)
{
- FileInfo file(path);
- return file.isOK() && file.isRegular() && file.readable();
+ 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();
}
-// Is a file read_only?
-// return 1 read-write
-// 0 read_only
-// -1 error (doesn't exist, no access, anything else)
-int IsFileWriteable(string const & path)
+bool isFileReadable(FileName const & filename)
{
- FileInfo fi(path);
-
- if (fi.access(FileInfo::wperm|FileInfo::rperm)) // read-write
- return 1;
- if (fi.readable()) // read-only
- return 0;
- return -1; // everything else.
+ std::string const path = filename.toFilesystemEncoding();
+ return fs::exists(path) && !fs::is_directory(path) && fs::is_readable(path);
}
//returns true: dir writeable
// false: not writeable
-bool IsDirWriteable(string const & path)
+bool isDirWriteable(string const & path)
{
- lyxerr[Debug::FILES] << "IsDirWriteable: " << path << endl;
+ lyxerr[Debug::FILES] << "isDirWriteable: " << path << endl;
- string const tmpfl(tempName(path, "lyxwritetest"));
+ string const tmpfl = tempName(path, "lyxwritetest");
if (tmpfl.empty())
return false;
- unlink(tmpfl);
+ unlink(FileName(tmpfl));
return true;
}
// If path entry begins with $$LyX/, use system_lyxdir
// If path entry begins with $$User/, use user_lyxdir
// Example: "$$User/doc;$$LyX/doc"
-string const FileOpenSearch(string const & path, string const & name,
+FileName const fileOpenSearch(string const & path, string const & name,
string const & ext)
{
- string real_file;
+ FileName real_file;
string path_element;
bool notfound = true;
string tmppath = split(path, path_element, ';');
while (notfound && !path_element.empty()) {
- path_element = os::slashify_path(path_element);
+ path_element = os::internal_path(path_element);
if (!suffixIs(path_element, '/'))
- path_element+= '/';
- path_element = subst(path_element, "$$LyX", system_lyxdir());
- path_element = subst(path_element, "$$User", user_lyxdir());
+ path_element += '/';
+ path_element = subst(path_element, "$$LyX",
+ package().system_support());
+ path_element = subst(path_element, "$$User",
+ package().user_support());
- real_file = FileSearch(path_element, name, ext);
+ real_file = fileSearch(path_element, name, ext);
if (real_file.empty()) {
do {
notfound = false;
}
}
-#ifdef __EMX__
- if (ext.empty() && notfound) {
- real_file = FileOpenSearch(path, name, "exe");
- if (notfound) real_file = FileOpenSearch(path, name, "cmd");
- }
-#endif
return real_file;
}
/// Returns a vector of all files in directory dir having extension ext.
-vector<string> const DirList(string const & dir, string const & ext)
+vector<string> const dirList(string const & dir, string const & ext)
{
- // This is a non-error checking C/system implementation
- string extension;
- if (!ext.empty() && ext[0] != '.')
- extension += '.';
- extension += ext;
-
+ // EXCEPTIONS FIXME. Rewrite needed when we turn on exceptions. (Lgb)
vector<string> dirlist;
- DIR * dirp = ::opendir(dir.c_str());
- if (!dirp) {
+
+ if (!(fs::exists(dir) && fs::is_directory(dir))) {
lyxerr[Debug::FILES]
<< "Directory \"" << dir
<< "\" does not exist to DirList." << endl;
return dirlist;
}
- dirent * dire;
- while ((dire = ::readdir(dirp))) {
- string const fil = dire->d_name;
+ string extension;
+ if (!ext.empty() && ext[0] != '.')
+ extension += '.';
+ extension += ext;
+
+ fs::directory_iterator dit(dir);
+ fs::directory_iterator end;
+ for (; dit != end; ++dit) {
+ string const & fil = dit->leaf();
if (suffixIs(fil, extension)) {
dirlist.push_back(fil);
}
}
- ::closedir(dirp);
return dirlist;
- /* I would have prefered to take a vector<string>& as parameter so
- that we could avoid the copy of the vector when returning.
- Then we would use:
- dirlist.swap(argvec);
- to avoid the copy. (Lgb)
- */
- /* A C++ implementaion will look like this:
- string extension(ext);
- if (extension[0] != '.') extension.insert(0, 1, '.');
- vector<string> dirlist;
- directory_iterator dit("dir");
- while (dit != directory_iterator()) {
- string fil = dit->filename;
- if (prefixIs(fil, extension)) {
- dirlist.push_back(fil);
- }
- ++dit;
- }
- dirlist.swap(argvec);
- return;
- */
}
// Returns the real name of file name in directory path, with optional
// extension ext.
-string const FileSearch(string const & path, string const & name,
+FileName const fileSearch(string const & path, string const & name,
string const & ext)
{
// if `name' is an absolute path, we ignore the setting of `path'
// Expand Environmentvariables in 'name'
- string const tmpname = ReplaceEnvironmentPath(name);
- string fullname = MakeAbsPath(tmpname, path);
+ string const tmpname = replaceEnvironmentPath(name);
+ FileName fullname(makeAbsPath(tmpname, path));
// search first without extension, then with it.
- if (IsFileReadable(fullname))
+ if (isFileReadable(fullname))
return fullname;
- else if (ext.empty())
- return string();
- else { // Is it not more reasonable to use ChangeExtension()? (SMiyata)
- fullname += '.';
- fullname += ext;
- if (IsFileReadable(fullname))
- return fullname;
- else
- return string();
- }
+ if (ext.empty())
+ return FileName();
+ fullname = FileName(changeExtension(fullname.absFilename(), ext));
+ return isFileReadable(fullname) ? fullname : FileName();
}
// 1) user_lyxdir
// 2) build_lyxdir (if not empty)
// 3) system_lyxdir
-string const LibFileSearch(string const & dir, string const & name,
+FileName const libFileSearch(string const & dir, string const & name,
string const & ext)
{
- string fullname = FileSearch(AddPath(user_lyxdir(), dir), name, ext);
+ FileName fullname = fileSearch(addPath(package().user_support(), dir),
+ name, ext);
if (!fullname.empty())
return fullname;
- if (!build_lyxdir().empty())
- fullname = FileSearch(AddPath(build_lyxdir(), dir), name, ext);
+ if (!package().build_support().empty())
+ fullname = fileSearch(addPath(package().build_support(), dir),
+ name, ext);
if (!fullname.empty())
return fullname;
- return FileSearch(AddPath(system_lyxdir(), dir), name, ext);
+ return fileSearch(addPath(package().system_support(), dir), name, ext);
}
-string const
-i18nLibFileSearch(string const & dir, string const & name,
+FileName const i18nLibFileSearch(string const & dir, string const & name,
string const & ext)
{
- // this comment is from intl/dcigettext.c. We try to mimick this
- // behaviour here.
+ // the following comments are from intl/dcigettext.c. We try
+ // to mimick this behaviour here.
/* 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] We have to proceed with the POSIX methods of
+ looking to `LC_ALL', `LC_xxx', and `LANG'. */
- string const lc_all = GetEnv("LC_ALL");
- string lang = GetEnv("LANGUAGE");
- if (lang.empty() || lc_all == "C") {
- lang = lc_all;
+ string lang = getEnv("LC_ALL");
+ if (lang.empty()) {
+ lang = getEnv("LC_MESSAGES");
if (lang.empty()) {
- lang = GetEnv("LANG");
+ lang = getEnv("LANG");
+ if (lang.empty())
+ lang = "C";
}
}
- lang = token(lang, '_', 0);
+ string const language = getEnv("LANGUAGE");
+ if (lang != "C" && lang != "POSIX" && !language.empty())
+ lang = language;
- if (lang.empty() || lang == "C")
- return LibFileSearch(dir, name, ext);
- else {
- string const tmp = LibFileSearch(dir, lang + '_' + name,
+ string l;
+ lang = split(lang, l, ':');
+ while (!l.empty() && l != "C" && l != "POSIX") {
+ FileName const tmp = libFileSearch(dir,
+ token(l, '_', 0) + '_' + name,
ext);
if (!tmp.empty())
return tmp;
- else
- return LibFileSearch(dir, name, ext);
+ lang = split(lang, l, ':');
}
+
+ return libFileSearch(dir, name, ext);
}
-string const LibScriptSearch(string const & command_in)
+string const libScriptSearch(string const & command_in, quote_style style)
{
- string const token_scriptpath("$$s/");
+ 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_script" word within 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("scripts", command.substr(start_script, size_script));
+ string const script =
+ libFileSearch(".", command.substr(start_script, size_script)).absFilename();
if (script.empty()) {
// Replace "$$s/" with ""
command.erase(pos1, 4);
} else {
- // Replace "$$s/some_script" with "$LYX_SCRIPT_PATH/some_script"
+ // Replace "$$s/foo/some_script" with "<path to>/some_script".
string::size_type const size_replace = size_script + 4;
- command.replace(pos1, size_replace, script);
+ command.replace(pos1, size_replace, quoteName(script, style));
}
return command;
}
-string const GetEnv(string const & envname)
-{
- // f.ex. what about error checking?
- char const * const ch = getenv(envname.c_str());
- string const envstr = !ch ? "" : ch;
- return envstr;
-}
-
-
-string const GetEnvPath(string const & name)
-{
-#ifndef __EMX__
- string const pathlist = subst(GetEnv(name), ':', ';');
-#else
- string const pathlist = os::slashify_path(GetEnv(name));
-#endif
- return rtrim(pathlist, ";");
-}
-
-
namespace {
-int DeleteAllFilesInDir(string const & path)
-{
- // I have decided that we will be using parts from the boost
- // library. Check out http://www.boost.org/
- // For directory access we will then use the directory_iterator.
- // Then the code will be something like:
- // directory_iterator dit(path);
- // directory_iterator dend;
- // if (dit == dend) {
- // return -1;
- // }
- // for (; dit != dend; ++dit) {
- // string filename(*dit);
- // if (filename == "." || filename == "..")
- // continue;
- // string unlinkpath(AddName(path, filename));
- // lyx::unlink(unlinkpath);
- // }
- // return 0;
- DIR * dir = ::opendir(path.c_str());
- if (!dir)
- return -1;
-
- struct dirent * de;
- int return_value = 0;
- while ((de = readdir(dir))) {
- string const temp = de->d_name;
- if (temp == "." || temp == "..")
- continue;
- string const unlinkpath = AddName (path, temp);
-
- lyxerr[Debug::FILES] << "Deleting file: " << unlinkpath
- << endl;
-
- bool deleted = true;
- FileInfo fi(unlinkpath);
- if (fi.isOK() && fi.isDir())
- deleted = (DeleteAllFilesInDir(unlinkpath) == 0);
- deleted &= (unlink(unlinkpath) == 0);
- if (!deleted)
- return_value = -1;
- }
- closedir(dir);
- return return_value;
-}
-
-
-string const CreateTmpDir(string const & tempdir, string const & mask)
+FileName const createTmpDir(FileName const & tempdir, string const & mask)
{
lyxerr[Debug::FILES]
- << "CreateTmpDir: tempdir=`" << tempdir << "'\n"
- << "CreateTmpDir: mask=`" << mask << '\'' << endl;
+ << "createTmpDir: tempdir=`" << tempdir << "'\n"
+ << "createTmpDir: mask=`" << mask << '\'' << endl;
- string const tmpfl(tempName(tempdir, mask));
+ string const tmpfl = tempName(tempdir.absFilename(), mask);
// lyx::tempName actually creates a file to make sure that it
// stays unique. So we have to delete it before we can create
// a dir with the same name. Note also that we are not thread
// safe because of the gap between unlink and mkdir. (Lgb)
- unlink(tmpfl);
+ unlink(FileName(tmpfl));
- if (tmpfl.empty() || mkdir(tmpfl, 0700))
- return string();
+ if (tmpfl.empty() || mkdir(FileName(tmpfl), 0700)) {
+ lyxerr << "LyX could not create the temporary directory '"
+ << tmpfl << "'" << endl;
+ return FileName();
+ }
- return MakeAbsPath(tmpfl);
+ return FileName(tmpfl);
}
} // namespace anon
-int destroyDir(string const & tmpdir)
+bool destroyDir(string const & tmpdir)
{
-#ifdef __EMX__
- Path p(user_lyxdir());
-#endif
- if (DeleteAllFilesInDir(tmpdir))
- return -1;
-
- if (rmdir(tmpdir))
- return -1;
-
- return 0;
+ try {
+ return fs::remove_all(tmpdir) > 0;
+ } catch (fs::filesystem_error const & fe){
+ lyxerr << "Could not delete " << tmpdir << ". (" << fe.what() << ")" << std::endl;
+ return false;
+ }
}
-string const CreateBufferTmpDir(string const & pathfor)
+string const createBufferTmpDir()
{
static int count;
- static string const tmpdir(pathfor.empty() ? os::getTmpDir() : pathfor);
// We are in our own directory. Why bother to mangle name?
- // In fact I wrote this code to circumvent a problematic behaviour (bug?)
- // of EMX mkstemp().
- string const tmpfl = tmpdir + "/lyx_tmpbuf" + tostr(count++);
- if (mkdir(tmpfl, 0777)) {
+ // In fact I wrote this code to circumvent a problematic behaviour
+ // (bug?) of EMX mkstemp().
+ string const tmpfl =
+ package().temp_dir() + "/lyx_tmpbuf" +
+ convert<string>(count++);
+
+ if (mkdir(FileName(tmpfl), 0777)) {
+ lyxerr << "LyX could not create the temporary directory '"
+ << tmpfl << "'" << endl;
return string();
}
return tmpfl;
}
-string const CreateLyXTmpDir(string const & deflt)
+FileName const createLyXTmpDir(FileName const & deflt)
{
- if ((!deflt.empty()) && (deflt != "/tmp")) {
+ if (!deflt.empty() && deflt.absFilename() != "/tmp") {
if (mkdir(deflt, 0777)) {
-#ifdef __EMX__
- Path p(user_lyxdir());
-#endif
- return CreateTmpDir(deflt, "lyx_tmpdir");
+ if (isDirWriteable(deflt.absFilename())) {
+ // 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(FileName("/tmp"), "lyx_tmpdir");
+ }
} else
return deflt;
} else {
-#ifdef __EMX__
- Path p(user_lyxdir());
-#endif
- return CreateTmpDir("/tmp", "lyx_tmpdir");
+ return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
}
}
bool createDirectory(string const & path, int permission)
{
- string temp(rtrim(os::slashify_path(path), "/"));
-
- Assert(!temp.empty());
-
- if (mkdir(temp, permission))
- return false;
-
- return true;
+ string temp = rtrim(os::internal_path(path), "/");
+ BOOST_ASSERT(!temp.empty());
+ return mkdir(FileName(temp), permission) == 0;
}
// Strip filename from path name
-string const OnlyPath(string const & Filename)
+string const onlyPath(string const & filename)
{
// If empty filename, return empty
- if (Filename.empty()) return Filename;
+ if (filename.empty())
+ return filename;
// Find last / or start of filename
- string::size_type j = Filename.rfind('/');
- if (j == string::npos)
- return "./";
- return Filename.substr(0, j + 1);
+ string::size_type 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.
-string const MakeAbsPath(string const & RelPath, string const & BasePath)
+string const makeAbsPath(string const & relPath, string const & basePath)
{
// checks for already absolute path
- if (os::is_absolute_path(RelPath))
- return RelPath;
+ if (os::is_absolute_path(relPath))
+ return relPath;
// Copies given paths
- string TempRel(os::slashify_path(RelPath));
+ string tempRel = os::internal_path(relPath);
// Since TempRel is NOT absolute, we can safely replace "//" with "/"
- TempRel = subst(TempRel, "//", "/");
+ tempRel = subst(tempRel, "//", "/");
- string TempBase;
+ string tempBase;
- if (os::is_absolute_path(BasePath))
- TempBase = BasePath;
+ if (os::is_absolute_path(basePath))
+ tempBase = basePath;
else
- TempBase = AddPath(getcwd(), BasePath);
+ tempBase = addPath(getcwd(), basePath);
// Handle /./ at the end of the path
- while (suffixIs(TempBase, "/./"))
- TempBase.erase(TempBase.length() - 2);
+ while (suffixIs(tempBase, "/./"))
+ tempBase.erase(tempBase.length() - 2);
// processes relative path
- string RTemp(TempRel);
- string Temp;
+ string rTemp = tempRel;
+ string temp;
- while (!RTemp.empty()) {
+ while (!rTemp.empty()) {
// Split by next /
- RTemp = split(RTemp, Temp, '/');
+ rTemp = split(rTemp, temp, '/');
- if (Temp == ".") continue;
- if (Temp == "..") {
+ if (temp == ".") continue;
+ if (temp == "..") {
// Remove one level of TempBase
- string::difference_type i = TempBase.length() - 2;
-#ifndef __EMX__
- if (i < 0) i = 0;
- while (i > 0 && TempBase[i] != '/') --i;
+ string::difference_type i = tempBase.length() - 2;
+ if (i < 0)
+ i = 0;
+ while (i > 0 && tempBase[i] != '/')
+ --i;
if (i > 0)
-#else
- if (i < 2) i = 2;
- while (i > 2 && TempBase[i] != '/') --i;
- if (i > 2)
-#endif
- TempBase.erase(i, string::npos);
+ tempBase.erase(i, string::npos);
else
- TempBase += '/';
- } else if (Temp.empty() && !RTemp.empty()) {
- TempBase = os::current_root() + RTemp;
- RTemp.erase();
+ 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;
+ if (!suffixIs(tempBase, '/'))
+ tempBase += '/';
+ tempBase += temp;
}
}
// returns absolute path
- return os::slashify_path(TempBase);
+ return os::internal_path(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 addName(string const & path, string const & fname)
{
- // Get basename
- string const basename(OnlyFilename(fname));
-
+ string const basename = onlyFilename(fname);
string buf;
if (path != "." && path != "./" && !path.empty()) {
- buf = os::slashify_path(path);
+ buf = os::internal_path(path);
if (!suffixIs(path, '/'))
buf += '/';
}
// Strips path from filename
-string const OnlyFilename(string const & fname)
+string const onlyFilename(string const & fname)
{
if (fname.empty())
return fname;
/// Returns true is path is absolute
-bool AbsolutePath(string const & path)
+bool absolutePath(string const & path)
{
return os::is_absolute_path(path);
}
-
// 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)
+string const expandPath(string const & path)
{
// checks for already absolute path
- string RTemp(ReplaceEnvironmentPath(path));
- if (os::is_absolute_path(RTemp))
- return RTemp;
+ string rTemp = replaceEnvironmentPath(path);
+ if (os::is_absolute_path(rTemp))
+ return rTemp;
- string Temp;
- string const copy(RTemp);
+ string temp;
+ string const copy = rTemp;
// Split by next /
- RTemp = split(RTemp, Temp, '/');
+ rTemp = split(rTemp, temp, '/');
+
+ if (temp == ".")
+ return getcwd() + '/' + rTemp;
+
+ if (temp == "~")
+ return package().home_dir() + '/' + rTemp;
+
+ if (temp == "..")
+ return makeAbsPath(copy);
- if (Temp == ".") {
- return getcwd() + '/' + RTemp;
- }
- if (Temp == "~") {
- return GetEnvPath("HOME") + '/' + RTemp;
- }
- if (Temp == "..") {
- return MakeAbsPath(copy);
- }
// Don't know how to handle this
return copy;
}
-// Normalize a path
-// Constracts path/../path
+// Normalize a path. Constracts path/../path
// Can't handle "../../" or "/../" (Asger)
// Also converts paths like /foo//bar ==> /foo/bar
-string const NormalizePath(string const & path)
+string const normalizePath(string const & path)
{
- string TempBase;
- string RTemp;
- string Temp;
+ // Normalize paths like /foo//bar ==> /foo/bar
+ static boost::regex regex("/{2,}");
+ string const tmppath = boost::regex_merge(path, regex, "/");
- if (os::is_absolute_path(path))
- RTemp = path;
- else
- // Make implicit current directory explicit
- RTemp = "./" +path;
+ fs::path const npath = fs::path(tmppath, fs::no_check).normalize();
- // Normalise paths like /foo//bar ==> /foo/bar
- boost::RegEx regex("/{2,}");
- RTemp = STRCONV(regex.Merge(STRCONV(RTemp), "/"));
+ if (!npath.is_complete())
+ return "./" + npath.string() + '/';
- while (!RTemp.empty()) {
- // Split by next /
- RTemp = split(RTemp, Temp, '/');
-
- if (Temp == ".") {
- TempBase = "./";
- } else if (Temp == "..") {
- // Remove one level of TempBase
- string::difference_type i = TempBase.length() - 2;
- while (i > 0 && TempBase[i] != '/')
- --i;
- if (i >= 0 && TempBase[i] == '/')
- TempBase.erase(i + 1, string::npos);
- else
- TempBase = "../";
- } else {
- TempBase += Temp + '/';
- }
- }
-
- // returns absolute path
- return TempBase;
+ return npath.string() + '/';
}
-string const GetFileContents(string const & fname)
+string const getFileContents(FileName const & fname)
{
- FileInfo finfo(fname);
- if (finfo.exist()) {
- ifstream ifs(fname.c_str());
+ string const encodedname = fname.toFilesystemEncoding();
+ if (fs::exists(encodedname)) {
+ ifstream ifs(encodedname.c_str());
ostringstream ofs;
if (ifs && ofs) {
ofs << ifs.rdbuf();
ifs.close();
- return STRCONV(ofs.str());
+ return ofs.str();
}
}
lyxerr << "LyX was not able to read file '" << fname << '\'' << endl;
}
-//
-// Search ${...} as Variable-Name inside the string and replace it with
-// the denoted environmentvariable
-// Allow Variables according to
-// variable := '$' '{' [A-Za-z_]{[A-Za-z_0-9]*} '}'
-//
-
-string const ReplaceEnvironmentPath(string const & path)
+// Search the string for ${VAR} and $VAR and replace VAR using getenv.
+string const replaceEnvironmentPath(string const & path)
{
- //
- // CompareChar: Environment variables starts with this character
- // PathChar: Next path component start with this character
- // while CompareChar found do:
- // Split String with PathChar
- // Search Environmentvariable
- // if found: Replace Strings
- //
- char const CompareChar = '$';
- char const FirstChar = '{';
- char const EndChar = '}';
- char const UnderscoreChar = '_';
- string EndString; EndString += EndChar;
- string FirstString; FirstString += FirstChar;
- string CompareString; CompareString += CompareChar;
- string const RegExp("*}*"); // Exist EndChar inside a String?
-
-// first: Search for a '$' - Sign.
- //string copy(path);
- string result1; //(copy); // for split-calls
- string result0 = split(path, result1, CompareChar);
- while (!result0.empty()) {
- string copy1(result0); // contains String after $
-
- // Check, if there is an EndChar inside original String.
-
- if (!regexMatch(copy1, RegExp)) {
- // No EndChar inside. So we are finished
- result1 += CompareString + result0;
- result0.erase();
- continue;
- }
-
- string res1;
- string res0 = split(copy1, res1, EndChar);
- // Now res1 holds the environmentvariable
- // First, check, if Contents is ok.
- if (res1.empty()) { // No environmentvariable. Continue Loop.
- result1 += CompareString + FirstString;
- result0 = res0;
- continue;
- }
- // check contents of res1
- char const * res1_contents = res1.c_str();
- if (*res1_contents != FirstChar) {
- // Again No Environmentvariable
- result1 += CompareString;
- result0 = res0;
- }
-
- // Check for variable names
- // Situation ${} is detected as "No Environmentvariable"
- char const * cp1 = res1_contents + 1;
- bool result = isalpha(*cp1) || (*cp1 == UnderscoreChar);
- ++cp1;
- while (*cp1 && result) {
- result = isalnum(*cp1) ||
- (*cp1 == UnderscoreChar);
- ++cp1;
- }
-
- if (!result) {
- // no correct variable name
- result1 += CompareString + res1 + EndString;
- result0 = split(res0, res1, CompareChar);
- result1 += res1;
- continue;
- }
-
- string env(GetEnv(res1_contents + 1));
- if (!env.empty()) {
- // Congratulations. Environmentvariable found
- result1 += env;
- } else {
- result1 += CompareString + res1 + EndString;
+ // ${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;
}
- // Next $-Sign?
- result0 = split(res0, res1, CompareChar);
- result1 += res1;
+ result = what.str(1) + getEnv(what.str(2)) + what.str(3);
}
- return result1;
+ return result;
}
// Make relative path out of two absolute paths
-string const MakeRelPath(string const & abspath, string const & basepath)
+string const makeRelPath(string const & abspath, string 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
// Append sub-directory(ies) to a path in an intelligent way
-string const AddPath(string const & path, string const & path_2)
+string const addPath(string const & path, string const & path_2)
{
string buf;
- string const path2 = os::slashify_path(path_2);
+ string const path2 = os::internal_path(path_2);
if (!path.empty() && path != "." && path != "./") {
- buf = os::slashify_path(path);
+ buf = os::internal_path(path);
if (path[path.length() - 1] != '/')
buf += '/';
}
Strips path off if no_path == true.
If no extension on oldname, just appends.
*/
-string const ChangeExtension(string const & oldname, string const & extension)
+string const changeExtension(string const & oldname, string const & extension)
{
string::size_type const last_slash = oldname.rfind('/');
string::size_type last_dot = oldname.rfind('.');
else
ext = extension;
- return os::slashify_path(oldname.substr(0, last_dot) + ext);
+ return os::internal_path(oldname.substr(0, last_dot) + ext);
+}
+
+
+string const removeExtension(string const & name)
+{
+ return changeExtension(name, string());
}
/// Return the extension of the file (not including the .)
-string const GetExtension(string const & name)
+string const getExtension(string const & name)
{
string::size_type const last_slash = name.rfind('/');
string::size_type const last_dot = name.rfind('.');
return string();
}
+
// the different filetypes and what they contain in one of the first lines
// (dots are any characters). (Herbert 20020131)
// AGR Grace...
// ZIP PK... http://www.halyava.ru/document/ind_arch.htm
// Z \037\235 UNIX compress
-/// return the "extension" which belongs to the contents.
-/// for no knowing contents return the extension. Without
-/// an extension and unknown contents we return "user"
-string const getExtFromContents(string const & filename)
+string const getFormatFromContents(FileName const & filename)
{
// paranoia check
- if (filename.empty() || !IsFileReadable(filename))
+ if (filename.empty() || !isFileReadable(filename))
return string();
-
- ifstream ifs(filename.c_str());
+ ifstream ifs(filename.toFilesystemEncoding().c_str());
if (!ifs)
// Couldn't open file...
return string();
// gnuzip
- string const gzipStamp = "\037\213";
+ static string const gzipStamp = "\037\213";
// PKZIP
- string const zipStamp = "PK";
+ static string const zipStamp = "PK";
// compress
- string const compressStamp = "\037\235";
+ static string const compressStamp = "\037\235";
// Maximum strings to read
int const max_count = 50;
int count = 0;
- string str, format;
+ string str;
+ string format;
bool firstLine = true;
while ((count++ < max_count) && format.empty()) {
if (ifs.eof()) {
lyxerr[Debug::GRAPHICS]
- << "filetools(getExtFromContents)\n"
+ << "filetools(getFormatFromContents)\n"
<< "\tFile type not recognised before EOF!"
<< endl;
break;
}
getline(ifs, str);
- string const stamp = str.substr(0,2);
+ string const stamp = str.substr(0, 2);
if (firstLine && str.size() >= 2) {
// at first we check for a zipped file, because this
// information is saved in the first bytes of the file!
return format;
}
- string const ext(GetExtension(filename));
lyxerr[Debug::GRAPHICS]
- << "filetools(getExtFromContents)\n"
- << "\tCouldn't find a known Type!\n";
- if (!ext.empty()) {
- lyxerr[Debug::GRAPHICS]
- << "\twill take the file extension -> "
- << ext << endl;
- return ext;
- } else {
- lyxerr[Debug::GRAPHICS]
- << "\twill use ext or a \"user\" defined format" << endl;
- return "user";
- }
+ << "filetools(getFormatFromContents)\n"
+ << "\tCouldn't find a known format!\n";
+ return string();
}
/// check for zipped file
-bool zippedFile(string const & name)
+bool zippedFile(FileName const & name)
{
- string const type = getExtFromContents(name);
+ string const type = getFormatFromContents(name);
if (contains("gzip zip compress", type) && !type.empty())
return true;
return false;
string const unzippedFileName(string const & zipped_file)
{
- string const ext = GetExtension(zipped_file);
+ string const ext = getExtension(zipped_file);
if (ext == "gz" || ext == "z" || ext == "Z")
- return ChangeExtension(zipped_file, string());
+ return changeExtension(zipped_file, string());
return "unzipped_" + zipped_file;
}
-string const unzipFile(string const & zipped_file)
+FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
{
- string const tempfile = unzippedFileName(zipped_file);
+ FileName const tempfile = FileName(unzipped_file.empty() ?
+ unzippedFileName(zipped_file.toFilesystemEncoding()) :
+ unzipped_file);
// Run gunzip
- string const command = "gunzip -c " + zipped_file + " > " + tempfile;
+ string const command = "gunzip -c " +
+ zipped_file.toFilesystemEncoding() + " > " +
+ tempfile.toFilesystemEncoding();
Systemcall one;
one.startscript(Systemcall::Wait, command);
// test that command was executed successfully (anon)
}
-string const MakeDisplayPath(string const & path, unsigned int threshold)
+docstring const makeDisplayPath(string const & path, unsigned int threshold)
{
string str = path;
-
- string const home(GetEnvPath("HOME"));
+ string const home = package().home_dir();
// replace /home/blah with ~/
- if (prefixIs(str, home))
+ if (!home.empty() && prefixIs(str, home))
str = subst(str, home, "~");
if (str.length() <= threshold)
- return str;
+ return lyx::from_utf8(os::external_path(str));
string const prefix = ".../";
string temp;
if (str.empty()) {
// Yes, filename itself is too long.
// Pick the start and the end of the filename.
- str = OnlyFilename(path);
+ str = onlyFilename(path);
string const head = str.substr(0, threshold / 2 - 3);
string::size_type len = str.length();
str = head + "..." + tail;
}
- return prefix + str;
+ return lyx::from_utf8(os::external_path(prefix + str));
}
-bool LyXReadLink(string const & file, string & link, bool resolve)
+bool readLink(string const & file, string & link, bool resolve)
{
+#ifdef HAVE_READLINK
char linkbuffer[512];
// Should be PATH_MAX but that needs autconf support
int const nRead = ::readlink(file.c_str(),
return false;
linkbuffer[nRead] = '\0'; // terminator
if (resolve)
- link = MakeAbsPath(linkbuffer, OnlyPath(file));
+ link = makeAbsPath(linkbuffer, onlyPath(file));
else
link = linkbuffer;
return true;
+#else
+ return false;
+#endif
}
-cmd_ret const RunCommand(string const & cmd)
+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.C
+ // (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)
+ if (!inf) {
+ lyxerr << "RunCommand:: could not start child process" << endl;
return make_pair(-1, string());
+ }
string ret;
int c = fgetc(inf);
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);
}
// If the file can be found directly, we just return a
// absolute path version of it.
- if (FileInfo(fil).exist())
- return MakeAbsPath(fil);
+ if (fs::exists(fil))
+ return makeAbsPath(fil);
// No we try to find it using kpsewhich.
// It seems from the kpsewhich manual page that it is safe to use
// should help it by setting additional path in the approp. envir.var.
string const kpsecmd = "kpsewhich " + fil;
- cmd_ret const c = RunCommand(kpsecmd);
+ cmd_ret const c = runCommand(kpsecmd);
lyxerr[Debug::LATEX] << "kpse status = " << c.first << '\n'
<< "kpse result = `" << rtrim(c.second, "\n")
void removeAutosaveFile(string const & filename)
{
- string a = OnlyPath(filename);
+ string a = onlyPath(filename);
a += '#';
- a += OnlyFilename(filename);
+ a += onlyFilename(filename);
a += '#';
- FileInfo const fileinfo(a);
- if (fileinfo.exist())
- unlink(a);
+ FileName const autosave(a);
+ if (fs::exists(autosave.toFilesystemEncoding()))
+ unlink(autosave);
}
-void readBB_lyxerrMessage(string const & file, bool & zipped,
+void readBB_lyxerrMessage(FileName const & file, bool & zipped,
string const & message)
{
lyxerr[Debug::GRAPHICS] << "[readBB_from_PSFile] "
<< message << std::endl;
+#ifdef WITH_WARNINGS
#warning Why is this func deleting a file? (Lgb)
+#endif
if (zipped)
unlink(file);
}
-string const readBB_from_PSFile(string const & file)
+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,
// %%BoundingBox: (atend)
// In this case we must check the end.
bool zipped = zippedFile(file);
- string const file_ = zipped ?
- string(unzipFile(file)) : string(file);
- string const format = getExtFromContents(file_);
+ FileName const file_ = zipped ? unzipFile(file) : file;
+ string const format = getFormatFromContents(file_);
if (format != "eps" && format != "ps") {
readBB_lyxerrMessage(file_, zipped,"no(e)ps-format");
return string();
}
- std::ifstream is(file_.c_str());
+ static boost::regex bbox_re(
+ "^%%BoundingBox:\\s*([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)");
+ std::ifstream is(file_.toFilesystemEncoding().c_str());
while (is) {
string s;
getline(is,s);
- if (contains(s,"%%BoundingBox:") && !contains(s,"atend")) {
- string const bb = ltrim(s.substr(14));
+ 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;
}
}
-int compare_timestamps(string const & file1, string const & file2)
+int compare_timestamps(FileName const & filename1, FileName const & filename2)
{
- Assert(AbsolutePath(file1) && AbsolutePath(file2));
-
// If the original is newer than the copy, then copy the original
// to the new directory.
- FileInfo f1(file1);
- FileInfo f2(file2);
+ string const file1 = filename1.toFilesystemEncoding();
+ string const file2 = filename2.toFilesystemEncoding();
int cmp = 0;
- if (f1.exist() && f2.exist()) {
- double const tmp = difftime(f1.getModificationTime(),
- f2.getModificationTime());
+ if (fs::exists(file1) && fs::exists(file2)) {
+ double const tmp = difftime(fs::last_write_time(file1),
+ fs::last_write_time(file2));
if (tmp != 0)
cmp = tmp > 0 ? 1 : -1;
- } else if (f1.exist()) {
+ } else if (fs::exists(file1)) {
cmp = 1;
- } else if (f2.exist()) {
+ } else if (fs::exists(file2)) {
cmp = -1;
}