3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * parts Copyright 1985, 1990, 1993 Free Software Foundation, Inc.
8 * \author Ivan Schreter
9 * \author Dirk Niggemann
10 * \author Asger Alstrup
11 * \author Lars Gullik Bjønnes
12 * \author Jean-Marc Lasgouttes
13 * \author Angus Leeming
17 * Full author contact details are available in file CREDITS.
19 * General path-mangling functions
24 #include "support/convert.h"
25 #include "support/environment.h"
26 #include "support/filetools.h"
27 #include "support/fs_extras.h"
28 #include "support/lstrings.h"
29 #include "support/lyxlib.h"
30 #include "support/os.h"
31 #include "support/Package.h"
32 #include "support/Path.h"
33 #include "support/Systemcall.h"
35 // FIXME Interface violation
39 #include <boost/assert.hpp>
40 #include <boost/filesystem/operations.hpp>
41 #include <boost/regex.hpp>
53 #ifndef CXX_GLOBAL_CSTD
62 using std::ostringstream;
65 namespace fs = boost::filesystem;
70 bool isLyXFilename(string const & filename)
72 return suffixIs(ascii_lowercase(filename), ".lyx");
76 bool isSGMLFilename(string const & filename)
78 return suffixIs(ascii_lowercase(filename), ".sgml");
82 bool isValidLaTeXFilename(string const & filename)
84 string const invalid_chars("#$%{}()[]\"^");
85 if (filename.find_first_of(invalid_chars) != string::npos)
92 string const latex_path(string const & original_path,
93 latex_path_extension extension,
96 // On cygwin, we may need windows or posix style paths.
97 string path = os::latex_path(original_path);
98 path = subst(path, "~", "\\string~");
99 if (path.find(' ') != string::npos) {
100 // We can't use '"' because " is sometimes active (e.g. if
101 // babel is loaded with the "german" option)
102 if (extension == EXCLUDE_EXTENSION) {
103 // ChangeExtension calls os::internal_path internally
104 // so don't use it to remove the extension.
105 string const ext = getExtension(path);
106 string const base = ext.empty() ?
108 path.substr(0, path.length() - ext.length() - 1);
109 // ChangeExtension calls os::internal_path internally
110 // so don't use it to re-add the extension.
111 path = "\\string\"" + base + "\\string\"." + ext;
113 path = "\\string\"" + path + "\\string\"";
117 return dots == ESCAPE_DOTS ? subst(path, ".", "\\lyxdot ") : path;
121 // Substitutes spaces with underscores in filename (and path)
122 string const makeLatexName(string const & file)
124 string name = onlyFilename(file);
125 string const path = onlyPath(file);
127 // ok so we scan through the string twice, but who cares.
128 string const keep = "abcdefghijklmnopqrstuvwxyz"
129 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
130 "@!'()*+,-./0123456789:;<=>?[]`|";
132 string::size_type pos = 0;
133 while ((pos = name.find_first_not_of(keep, pos)) != string::npos)
136 return addName(path, name);
140 string const quoteName(string const & name, quote_style style)
144 // This does not work for filenames containing " (windows)
145 // or ' (all other OSes). This can't be changed easily, since
146 // we would need to adapt the command line parser in
147 // Forkedcall::generateChild. Therefore we don't pass user
148 // filenames to child processes if possible. We store them in
149 // a python script instead, where we don't have these
151 return (os::shell() == os::UNIX) ?
155 return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
158 // shut up stupid compiler
163 bool isFileReadable(FileName const & filename)
165 std::string const path = filename.toFilesystemEncoding();
166 return fs::exists(path) && !fs::is_directory(path) && fs::is_readable(path);
170 //returns true: dir writeable
171 // false: not writeable
172 bool isDirWriteable(FileName const & path)
174 LYXERR(Debug::FILES) << "isDirWriteable: " << path << endl;
176 FileName const tmpfl(tempName(path, "lyxwritetest"));
187 // Uses a string of paths separated by ";"s to find a file to open.
188 // Can't cope with pathnames with a ';' in them. Returns full path to file.
189 // If path entry begins with $$LyX/, use system_lyxdir
190 // If path entry begins with $$User/, use user_lyxdir
191 // Example: "$$User/doc;$$LyX/doc"
192 FileName const fileOpenSearch(string const & path, string const & name,
197 bool notfound = true;
198 string tmppath = split(path, path_element, ';');
200 while (notfound && !path_element.empty()) {
201 path_element = os::internal_path(path_element);
202 if (!suffixIs(path_element, '/'))
204 path_element = subst(path_element, "$$LyX",
205 package().system_support().absFilename());
206 path_element = subst(path_element, "$$User",
207 package().user_support().absFilename());
209 real_file = fileSearch(path_element, name, ext);
211 if (real_file.empty()) {
213 tmppath = split(tmppath, path_element, ';');
214 } while (!tmppath.empty() && path_element.empty());
224 /// Returns a vector of all files in directory dir having extension ext.
225 vector<FileName> const dirList(FileName const & dir, string const & ext)
227 // EXCEPTIONS FIXME. Rewrite needed when we turn on exceptions. (Lgb)
228 vector<FileName> dirlist;
230 string const encoded_dir = dir.toFilesystemEncoding();
231 if (!(fs::exists(encoded_dir) && fs::is_directory(encoded_dir))) {
233 << "Directory \"" << dir
234 << "\" does not exist to DirList." << endl;
239 if (!ext.empty() && ext[0] != '.')
243 fs::directory_iterator dit(encoded_dir);
244 fs::directory_iterator end;
245 for (; dit != end; ++dit) {
246 string const & fil = dit->leaf();
247 if (suffixIs(fil, extension))
248 dirlist.push_back(FileName::fromFilesystemEncoding(
249 encoded_dir + '/' + fil));
255 // Returns the real name of file name in directory path, with optional
257 FileName const fileSearch(string const & path, string const & name,
258 string const & ext, search_mode mode)
260 // if `name' is an absolute path, we ignore the setting of `path'
261 // Expand Environmentvariables in 'name'
262 string const tmpname = replaceEnvironmentPath(name);
263 FileName fullname(makeAbsPath(tmpname, path));
264 // search first without extension, then with it.
265 if (isFileReadable(fullname))
269 return mode == allow_unreadable ? fullname : FileName();
270 // Only add the extension if it is not already the extension of
272 if (getExtension(fullname.absFilename()) != ext)
273 fullname = FileName(addExtension(fullname.absFilename(), ext));
274 if (isFileReadable(fullname) || mode == allow_unreadable)
280 // Search the file name.ext in the subdirectory dir of
282 // 2) build_lyxdir (if not empty)
284 FileName const libFileSearch(string const & dir, string const & name,
287 FileName fullname = fileSearch(addPath(package().user_support().absFilename(), dir),
289 if (!fullname.empty())
292 if (!package().build_support().empty())
293 fullname = fileSearch(addPath(package().build_support().absFilename(), dir),
295 if (!fullname.empty())
298 return fileSearch(addPath(package().system_support().absFilename(), dir), name, ext);
302 FileName const i18nLibFileSearch(string const & dir, string const & name,
305 /* The highest priority value is the `LANGUAGE' environment
306 variable. But we don't use the value if the currently
307 selected locale is the C locale. This is a GNU extension.
309 Otherwise, w use a trick to guess what gettext has done:
310 each po file is able to tell us its name. (JMarc)
313 string lang = to_ascii(_("[[Replace with the code of your language]]"));
314 string const language = getEnv("LANGUAGE");
315 if (!lang.empty() && !language.empty())
319 lang = split(lang, l, ':');
322 // First try with the full name
323 tmp = libFileSearch(addPath(dir, l), name, ext);
327 // Then the name without country code
328 string const shortl = token(l, '_', 0);
330 tmp = libFileSearch(addPath(dir, shortl), name, ext);
336 // For compatibility, to be removed later (JMarc)
337 tmp = libFileSearch(dir, token(l, '_', 0) + '_' + name,
340 lyxerr << "i18nLibFileSearch: File `" << tmp
341 << "' has been found by the old method" <<endl;
345 lang = split(lang, l, ':');
348 return libFileSearch(dir, name, ext);
352 string const libScriptSearch(string const & command_in, quote_style style)
354 static string const token_scriptpath = "$$s/";
356 string command = command_in;
357 // Find the starting position of "$$s/"
358 string::size_type const pos1 = command.find(token_scriptpath);
359 if (pos1 == string::npos)
361 // Find the end of the "$$s/some_subdir/some_script" word within
362 // command. Assumes that the script name does not contain spaces.
363 string::size_type const start_script = pos1 + 4;
364 string::size_type const pos2 = command.find(' ', start_script);
365 string::size_type const size_script = pos2 == string::npos?
366 (command.size() - start_script) : pos2 - start_script;
368 // Does this script file exist?
369 string const script =
370 libFileSearch(".", command.substr(start_script, size_script)).absFilename();
372 if (script.empty()) {
373 // Replace "$$s/" with ""
374 command.erase(pos1, 4);
376 // Replace "$$s/foo/some_script" with "<path to>/some_script".
377 string::size_type const size_replace = size_script + 4;
378 command.replace(pos1, size_replace, quoteName(script, style));
387 FileName const createTmpDir(FileName const & tempdir, string const & mask)
390 << "createTmpDir: tempdir=`" << tempdir << "'\n"
391 << "createTmpDir: mask=`" << mask << '\'' << endl;
393 FileName const tmpfl(tempName(tempdir, mask));
394 // lyx::tempName actually creates a file to make sure that it
395 // stays unique. So we have to delete it before we can create
396 // a dir with the same name. Note also that we are not thread
397 // safe because of the gap between unlink and mkdir. (Lgb)
400 if (tmpfl.empty() || mkdir(tmpfl, 0700)) {
401 lyxerr << "LyX could not create the temporary directory '"
402 << tmpfl << "'" << endl;
412 bool destroyDir(FileName const & tmpdir)
415 return fs::remove_all(tmpdir.toFilesystemEncoding()) > 0;
416 } catch (fs::filesystem_error const & fe){
417 lyxerr << "Could not delete " << tmpdir << ". (" << fe.what() << ")" << std::endl;
423 string const createBufferTmpDir()
426 // We are in our own directory. Why bother to mangle name?
427 // In fact I wrote this code to circumvent a problematic behaviour
428 // (bug?) of EMX mkstemp().
430 package().temp_dir().absFilename() + "/lyx_tmpbuf" +
431 convert<string>(count++);
433 if (mkdir(FileName(tmpfl), 0777)) {
434 lyxerr << "LyX could not create the temporary directory '"
435 << tmpfl << "'" << endl;
442 FileName const createLyXTmpDir(FileName const & deflt)
444 if (!deflt.empty() && deflt.absFilename() != "/tmp") {
445 if (mkdir(deflt, 0777)) {
446 if (isDirWriteable(deflt)) {
447 // deflt could not be created because it
448 // did exist already, so let's create our own
450 return createTmpDir(deflt, "lyx_tmpdir");
452 // some other error occured.
453 return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
458 return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
463 bool createDirectory(FileName const & path, int permission)
465 BOOST_ASSERT(!path.empty());
466 return mkdir(path, permission) == 0;
470 // Strip filename from path name
471 string const onlyPath(string const & filename)
473 // If empty filename, return empty
474 if (filename.empty())
477 // Find last / or start of filename
478 string::size_type j = filename.rfind('/');
479 return j == string::npos ? "./" : filename.substr(0, j + 1);
483 // Convert relative path into absolute path based on a basepath.
484 // If relpath is absolute, just use that.
485 // If basepath is empty, use CWD as base.
486 FileName const makeAbsPath(string const & relPath, string const & basePath)
488 // checks for already absolute path
489 if (os::is_absolute_path(relPath))
490 return FileName(relPath);
492 // Copies given paths
493 string tempRel = os::internal_path(relPath);
494 // Since TempRel is NOT absolute, we can safely replace "//" with "/"
495 tempRel = subst(tempRel, "//", "/");
499 if (os::is_absolute_path(basePath))
502 tempBase = addPath(getcwd().absFilename(), basePath);
504 // Handle /./ at the end of the path
505 while (suffixIs(tempBase, "/./"))
506 tempBase.erase(tempBase.length() - 2);
508 // processes relative path
509 string rTemp = tempRel;
512 while (!rTemp.empty()) {
514 rTemp = split(rTemp, temp, '/');
516 if (temp == ".") continue;
518 // Remove one level of TempBase
519 string::difference_type i = tempBase.length() - 2;
522 while (i > 0 && tempBase[i] != '/')
525 tempBase.erase(i, string::npos);
528 } else if (temp.empty() && !rTemp.empty()) {
529 tempBase = os::current_root() + rTemp;
532 // Add this piece to TempBase
533 if (!suffixIs(tempBase, '/'))
539 // returns absolute path
540 return FileName(os::internal_path(tempBase));
544 // Correctly append filename to the pathname.
545 // If pathname is '.', then don't use pathname.
546 // Chops any path of filename.
547 string const addName(string const & path, string const & fname)
549 string const basename = onlyFilename(fname);
552 if (path != "." && path != "./" && !path.empty()) {
553 buf = os::internal_path(path);
554 if (!suffixIs(path, '/'))
558 return buf + basename;
562 // Strips path from filename
563 string const onlyFilename(string const & fname)
568 string::size_type j = fname.rfind('/');
569 if (j == string::npos) // no '/' in fname
573 return fname.substr(j + 1);
577 /// Returns true is path is absolute
578 bool absolutePath(string const & path)
580 return os::is_absolute_path(path);
584 // Create absolute path. If impossible, don't do anything
585 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
586 string const expandPath(string const & path)
588 // checks for already absolute path
589 string rTemp = replaceEnvironmentPath(path);
590 if (os::is_absolute_path(rTemp))
594 string const copy = rTemp;
597 rTemp = split(rTemp, temp, '/');
600 return getcwd().absFilename() + '/' + rTemp;
603 return package().home_dir().absFilename() + '/' + rTemp;
606 return makeAbsPath(copy).absFilename();
608 // Don't know how to handle this
613 // Normalize a path. Constracts path/../path
614 // Can't handle "../../" or "/../" (Asger)
615 // Also converts paths like /foo//bar ==> /foo/bar
616 string const normalizePath(string const & path)
618 // Normalize paths like /foo//bar ==> /foo/bar
619 static boost::regex regex("/{2,}");
620 string const tmppath = boost::regex_merge(path, regex, "/");
622 fs::path const npath = fs::path(tmppath, fs::no_check).normalize();
624 if (!npath.is_complete())
625 return "./" + npath.string() + '/';
627 return npath.string() + '/';
631 string const getFileContents(FileName const & fname)
633 string const encodedname = fname.toFilesystemEncoding();
634 if (fs::exists(encodedname)) {
635 ifstream ifs(encodedname.c_str());
643 lyxerr << "LyX was not able to read file '" << fname << '\'' << endl;
648 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
649 string const replaceEnvironmentPath(string const & path)
651 // ${VAR} is defined as
652 // $\{[A-Za-z_][A-Za-z_0-9]*\}
653 static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
655 // $VAR is defined as:
656 // $\{[A-Za-z_][A-Za-z_0-9]*\}
657 static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
659 static boost::regex envvar_br_re("(.*)" + envvar_br + "(.*)");
660 static boost::regex envvar_re("(.*)" + envvar + "(.*)");
663 string result = path;
665 regex_match(result, what, envvar_br_re);
666 if (!what[0].matched) {
667 regex_match(result, what, envvar_re);
668 if (!what[0].matched)
671 result = what.str(1) + getEnv(what.str(2)) + what.str(3);
677 // Make relative path out of two absolute paths
678 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
679 // Makes relative path out of absolute path. If it is deeper than basepath,
680 // it's easy. If basepath and abspath share something (they are all deeper
681 // than some directory), it'll be rendered using ..'s. If they are completely
682 // different, then the absolute path will be used as relative path.
684 docstring::size_type const abslen = abspath.length();
685 docstring::size_type const baselen = basepath.length();
687 docstring::size_type i = os::common_path(abspath, basepath);
690 // actually no match - cannot make it relative
694 // Count how many dirs there are in basepath above match
695 // and append as many '..''s into relpath
697 docstring::size_type j = i;
698 while (j < baselen) {
699 if (basepath[j] == '/') {
700 if (j + 1 == baselen)
707 // Append relative stuff from common directory to abspath
708 if (abspath[i] == '/')
710 for (; i < abslen; ++i)
713 if (suffixIs(buf, '/'))
714 buf.erase(buf.length() - 1);
715 // Substitute empty with .
722 // Append sub-directory(ies) to a path in an intelligent way
723 string const addPath(string const & path, string const & path_2)
726 string const path2 = os::internal_path(path_2);
728 if (!path.empty() && path != "." && path != "./") {
729 buf = os::internal_path(path);
730 if (path[path.length() - 1] != '/')
734 if (!path2.empty()) {
735 string::size_type const p2start = path2.find_first_not_of('/');
736 string::size_type const p2end = path2.find_last_not_of('/');
737 string const tmp = path2.substr(p2start, p2end - p2start + 1);
744 string const changeExtension(string const & oldname, string const & extension)
746 string::size_type const last_slash = oldname.rfind('/');
747 string::size_type last_dot = oldname.rfind('.');
748 if (last_dot < last_slash && last_slash != string::npos)
749 last_dot = string::npos;
752 // Make sure the extension starts with a dot
753 if (!extension.empty() && extension[0] != '.')
754 ext= '.' + extension;
758 return os::internal_path(oldname.substr(0, last_dot) + ext);
762 string const removeExtension(string const & name)
764 return changeExtension(name, string());
768 string const addExtension(string const & name, string const & extension)
770 if (!extension.empty() && extension[0] != '.')
771 return name + '.' + extension;
772 return name + extension;
776 /// Return the extension of the file (not including the .)
777 string const getExtension(string const & name)
779 string::size_type const last_slash = name.rfind('/');
780 string::size_type const last_dot = name.rfind('.');
781 if (last_dot != string::npos &&
782 (last_slash == string::npos || last_dot > last_slash))
783 return name.substr(last_dot + 1,
784 name.length() - (last_dot + 1));
790 // the different filetypes and what they contain in one of the first lines
791 // (dots are any characters). (Herbert 20020131)
794 // EPS %!PS-Adobe-3.0 EPSF...
801 // PBM P1... or P4 (B/W)
802 // PGM P2... or P5 (Grayscale)
803 // PPM P3... or P6 (color)
804 // PS %!PS-Adobe-2.0 or 1.0, no "EPSF"!
805 // SGI \001\332... (decimal 474)
807 // TIFF II... or MM...
809 // XPM /* XPM */ sometimes missing (f.ex. tgif-export)
810 // ...static char *...
811 // XWD \000\000\000\151 (0x00006900) decimal 105
813 // GZIP \037\213 http://www.ietf.org/rfc/rfc1952.txt
814 // ZIP PK... http://www.halyava.ru/document/ind_arch.htm
815 // Z \037\235 UNIX compress
817 string const getFormatFromContents(FileName const & filename)
820 if (filename.empty() || !isFileReadable(filename))
823 ifstream ifs(filename.toFilesystemEncoding().c_str());
825 // Couldn't open file...
829 static string const gzipStamp = "\037\213";
832 static string const zipStamp = "PK";
835 static string const compressStamp = "\037\235";
837 // Maximum strings to read
838 int const max_count = 50;
843 bool firstLine = true;
844 while ((count++ < max_count) && format.empty()) {
846 LYXERR(Debug::GRAPHICS)
847 << "filetools(getFormatFromContents)\n"
848 << "\tFile type not recognised before EOF!"
854 string const stamp = str.substr(0, 2);
855 if (firstLine && str.size() >= 2) {
856 // at first we check for a zipped file, because this
857 // information is saved in the first bytes of the file!
858 // also some graphic formats which save the information
859 // in the first line, too.
860 if (prefixIs(str, gzipStamp)) {
863 } else if (stamp == zipStamp) {
866 } else if (stamp == compressStamp) {
870 } else if (stamp == "BM") {
873 } else if (stamp == "\001\332") {
877 // Don't need to use str.at(0), str.at(1) because
878 // we already know that str.size() >= 2
879 } else if (str[0] == 'P') {
895 } else if ((stamp == "II") || (stamp == "MM")) {
898 } else if (prefixIs(str,"%TGIF")) {
901 } else if (prefixIs(str,"#FIG")) {
904 } else if (prefixIs(str,"GIF")) {
907 } else if (str.size() > 3) {
908 int const c = ((str[0] << 24) & (str[1] << 16) &
909 (str[2] << 8) & str[3]);
920 else if (contains(str,"EPSF"))
921 // dummy, if we have wrong file description like
922 // %!PS-Adobe-2.0EPSF"
925 else if (contains(str,"Grace"))
928 else if (contains(str,"JFIF"))
931 else if (contains(str,"%PDF"))
934 else if (contains(str,"PNG"))
937 else if (contains(str,"%!PS-Adobe")) {
940 if (contains(str,"EPSF"))
946 else if (contains(str,"_bits[]"))
949 else if (contains(str,"XPM") || contains(str, "static char *"))
952 else if (contains(str,"BITPIX"))
956 if (!format.empty()) {
957 LYXERR(Debug::GRAPHICS)
958 << "Recognised Fileformat: " << format << endl;
962 LYXERR(Debug::GRAPHICS)
963 << "filetools(getFormatFromContents)\n"
964 << "\tCouldn't find a known format!\n";
969 /// check for zipped file
970 bool zippedFile(FileName const & name)
972 string const type = getFormatFromContents(name);
973 if (contains("gzip zip compress", type) && !type.empty())
979 string const unzippedFileName(string const & zipped_file)
981 string const ext = getExtension(zipped_file);
982 if (ext == "gz" || ext == "z" || ext == "Z")
983 return changeExtension(zipped_file, string());
984 return "unzipped_" + zipped_file;
988 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
990 FileName const tempfile = FileName(unzipped_file.empty() ?
991 unzippedFileName(zipped_file.toFilesystemEncoding()) :
994 string const command = "gunzip -c " +
995 zipped_file.toFilesystemEncoding() + " > " +
996 tempfile.toFilesystemEncoding();
998 one.startscript(Systemcall::Wait, command);
999 // test that command was executed successfully (anon)
1000 // yes, please do. (Lgb)
1005 docstring const makeDisplayPath(string const & path, unsigned int threshold)
1009 // If file is from LyXDir, display it as if it were relative.
1010 string const system = package().system_support().absFilename();
1011 if (prefixIs(str, system) && str != system)
1012 return from_utf8("[" + str.erase(0, system.length()) + "]");
1014 // replace /home/blah with ~/
1015 string const home = package().home_dir().absFilename();
1016 if (!home.empty() && prefixIs(str, home))
1017 str = subst(str, home, "~");
1019 if (str.length() <= threshold)
1020 return from_utf8(os::external_path(str));
1022 string const prefix = ".../";
1025 while (str.length() > threshold)
1026 str = split(str, temp, '/');
1028 // Did we shorten everything away?
1030 // Yes, filename itself is too long.
1031 // Pick the start and the end of the filename.
1032 str = onlyFilename(path);
1033 string const head = str.substr(0, threshold / 2 - 3);
1035 string::size_type len = str.length();
1037 str.substr(len - threshold / 2 - 2, len - 1);
1038 str = head + "..." + tail;
1041 return from_utf8(os::external_path(prefix + str));
1045 bool readLink(FileName const & file, FileName & link)
1047 #ifdef HAVE_READLINK
1048 char linkbuffer[512];
1049 // Should be PATH_MAX but that needs autconf support
1050 string const encoded = file.toFilesystemEncoding();
1051 int const nRead = ::readlink(encoded.c_str(),
1052 linkbuffer, sizeof(linkbuffer) - 1);
1055 linkbuffer[nRead] = '\0'; // terminator
1056 link = makeAbsPath(linkbuffer, onlyPath(file.absFilename()));
1064 cmd_ret const runCommand(string const & cmd)
1066 // FIXME: replace all calls to RunCommand with ForkedCall
1067 // (if the output is not needed) or the code in ISpell.cpp
1068 // (if the output is needed).
1070 // One question is if we should use popen or
1071 // create our own popen based on fork, exec, pipe
1072 // of course the best would be to have a
1073 // pstream (process stream), with the
1074 // variants ipstream, opstream
1076 #if defined (HAVE_POPEN)
1077 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
1078 #elif defined (HAVE__POPEN)
1079 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
1081 #error No popen() function.
1084 // (Claus Hentschel) Check if popen was succesful ;-)
1086 lyxerr << "RunCommand:: could not start child process" << endl;
1087 return make_pair(-1, string());
1093 ret += static_cast<char>(c);
1097 #if defined (HAVE_PCLOSE)
1098 int const pret = pclose(inf);
1099 #elif defined (HAVE__PCLOSE)
1100 int const pret = _pclose(inf);
1102 #error No pclose() function.
1106 perror("RunCommand:: could not terminate child process");
1108 return make_pair(pret, ret);
1112 FileName const findtexfile(string const & fil, string const & /*format*/)
1114 /* There is no problem to extend this function too use other
1115 methods to look for files. It could be setup to look
1116 in environment paths and also if wanted as a last resort
1117 to a recursive find. One of the easier extensions would
1118 perhaps be to use the LyX file lookup methods. But! I am
1119 going to implement this until I see some demand for it.
1123 // If the file can be found directly, we just return a
1124 // absolute path version of it.
1125 FileName const absfile(makeAbsPath(fil));
1126 if (fs::exists(absfile.toFilesystemEncoding()))
1129 // No we try to find it using kpsewhich.
1130 // It seems from the kpsewhich manual page that it is safe to use
1131 // kpsewhich without --format: "When the --format option is not
1132 // given, the search path used when looking for a file is inferred
1133 // from the name given, by looking for a known extension. If no
1134 // known extension is found, the search path for TeX source files
1136 // However, we want to take advantage of the format sine almost all
1137 // the different formats has environment variables that can be used
1138 // to controll which paths to search. f.ex. bib looks in
1139 // BIBINPUTS and TEXBIB. Small list follows:
1140 // bib - BIBINPUTS, TEXBIB
1142 // graphic/figure - TEXPICTS, TEXINPUTS
1143 // ist - TEXINDEXSTYLE, INDEXSTYLE
1144 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
1146 // tfm - TFMFONTS, TEXFONTS
1147 // This means that to use kpsewhich in the best possible way we
1148 // should help it by setting additional path in the approp. envir.var.
1149 string const kpsecmd = "kpsewhich " + fil;
1151 cmd_ret const c = runCommand(kpsecmd);
1153 LYXERR(Debug::LATEX) << "kpse status = " << c.first << '\n'
1154 << "kpse result = `" << rtrim(c.second, "\n\r")
1157 return FileName(os::internal_path(rtrim(to_utf8(from_filesystem8bit(c.second)),
1164 void removeAutosaveFile(string const & filename)
1166 string a = onlyPath(filename);
1168 a += onlyFilename(filename);
1170 FileName const autosave(a);
1171 if (fs::exists(autosave.toFilesystemEncoding()))
1176 void readBB_lyxerrMessage(FileName const & file, bool & zipped,
1177 string const & message)
1179 LYXERR(Debug::GRAPHICS) << "[readBB_from_PSFile] "
1180 << message << std::endl;
1181 // FIXME: Why is this func deleting a file? (Lgb)
1187 string const readBB_from_PSFile(FileName const & file)
1189 // in a (e)ps-file it's an entry like %%BoundingBox:23 45 321 345
1190 // It seems that every command in the header has an own line,
1191 // getline() should work for all files.
1192 // On the other hand some plot programs write the bb at the
1193 // end of the file. Than we have in the header:
1194 // %%BoundingBox: (atend)
1195 // In this case we must check the end.
1196 bool zipped = zippedFile(file);
1197 FileName const file_ = zipped ? unzipFile(file) : file;
1198 string const format = getFormatFromContents(file_);
1200 if (format != "eps" && format != "ps") {
1201 readBB_lyxerrMessage(file_, zipped,"no(e)ps-format");
1205 static boost::regex bbox_re(
1206 "^%%BoundingBox:\\s*([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)");
1207 std::ifstream is(file_.toFilesystemEncoding().c_str());
1212 if (regex_match(s, what, bbox_re)) {
1213 // Our callers expect the tokens in the string
1214 // separated by single spaces.
1215 // FIXME: change return type from string to something
1218 os << what.str(1) << ' ' << what.str(2) << ' '
1219 << what.str(3) << ' ' << what.str(4);
1220 string const bb = os.str();
1221 readBB_lyxerrMessage(file_, zipped, bb);
1225 readBB_lyxerrMessage(file_, zipped, "no bb found");
1230 int compare_timestamps(FileName const & filename1, FileName const & filename2)
1232 // If the original is newer than the copy, then copy the original
1233 // to the new directory.
1235 string const file1 = filename1.toFilesystemEncoding();
1236 string const file2 = filename2.toFilesystemEncoding();
1238 if (fs::exists(file1) && fs::exists(file2)) {
1239 double const tmp = difftime(fs::last_write_time(file1),
1240 fs::last_write_time(file2));
1242 cmp = tmp > 0 ? 1 : -1;
1244 } else if (fs::exists(file1)) {
1246 } else if (fs::exists(file2)) {
1253 } //namespace support