4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
9 * Full author contact details are available in file CREDITS.
12 #ifndef LYX_FILETOOL_H
13 #define LYX_FILETOOL_H
15 #include "support/docstring.h"
25 /** Creates the global LyX temp dir.
26 \p deflt can be an existing directory name. In this case a new directory
27 inside \p deflt is created. If \p deflt does not exist yet, \p deflt is
28 created and used as the temporary directory.
29 \return the tmp dir name or string() if something went wrong.
31 FileName const createLyXTmpDir(FileName const & deflt);
34 // FIXME unused. Should this be deleted or resurrected?
35 /** Find file by searching several directories.
36 Uses a string of paths separated by ";"s to find a file to open.
37 Can't cope with pathnames with a ';' in them. Returns full path to file.
38 If path entry begins with $$LyX/, use system_lyxdir.
39 If path entry begins with $$User/, use user_lyxdir.
40 Example: "$$User/doc;$$LyX/doc".
42 FileName const fileOpenSearch(std::string const & path,
43 std::string const & name,
44 std::string const & ext = std::string());
47 /// How to search files
49 /// The file must exist (return an empty file name otherwise)
51 /// Only do file name expansion, return the complete name even if
52 /// the file does not exist
54 /// The (image) file may be present with hi-dpi resolution -
55 /// the lookup checks for a file named "image" + "@2x" + ".ext" first.
56 /// If found it will return e.g. "image@2x.png" instead of "image.png".
57 /// Otherwise it will work as must_exist.
61 /** Returns the real name of file name in directory path, with optional
63 The file is searched in the given path (unless it is an absolute
64 file name), first directly, and then with extension .ext (if given).
66 FileName const fileSearch(std::string const & path,
67 std::string const & name,
68 std::string const & ext = std::string(),
69 search_mode mode = must_exist);
72 bool isLyXFileName(std::string const & filename);
75 bool isSGMLFileName(std::string const & filename);
77 /// check for characters in filenames not allowed by LaTeX
78 bool isValidLaTeXFileName(std::string const & filename);
80 /** check for characters in filenames that might lead to
81 problems when manually compiling the LaTeX export of LyX
82 and opening the result with some older DVI-viewers
84 bool isValidDVIFileName(std::string const & filename);
86 /// check whether the file has binary contents
87 bool isBinaryFile(FileName const & filename);
89 /** Returns the path of a library data file.
90 Search the file name.ext in the subdirectory dir of
92 -# build_lyxdir (if not empty)
94 The third parameter `ext' is optional.
96 FileName const libFileSearch(std::string const & dir,
97 std::string const & name,
98 std::string const & ext = std::string(),
99 search_mode mode = must_exist);
101 /** Same as libFileSearch(), but tries first to find an
102 internationalized version of the file by prepending $LANG_ to the
106 i18nLibFileSearch(std::string const & dir,
107 std::string const & name,
108 std::string const & ext = std::string());
110 /** Same as libFileSearch(), but tries first to find a preferred
111 version of the file by appending the icon set name to the dir
114 imageLibFileSearch(std::string & dir, std::string const & name,
115 std::string const & ext = std::string(),
116 search_mode mode = must_exist);
118 /// How to quote a filename
120 /** Quote for the (OS dependant) shell. This is needed for command
121 line arguments of subprocesses. */
123 /** Quote for python. Use this if you want to store a filename in a
124 python script. Example: \code
125 os << "infile = " << quoteName(filename) << '\\n';
126 \endcode This uses double quotes, so that you can also use this
127 to quote filenames as part of a string if the string is quoted
128 with single quotes. */
132 /** Takes a command such as "python $$s/scripts/convertDefault.py file.in file.out"
133 * and replaces "$$s/" with the path to the LyX support directory containing
134 * this script. If the script is not found, "$$s/" is removed. Executing the
135 * command will still fail, but the error message will make some sort of
138 std::string const commandPrep(std::string const & command);
140 enum latex_path_extension {
145 enum latex_path_dots {
150 /** @param path a file path in internal_path format. Ie, directories
151 * are indicated by '/', not by '\'.
153 * Manipulates @c path into a form suitable for inclusion in a LaTeX
155 * If @c path contains LaTeX special characters, these are escaped.
156 * Eg, '~' -> '\\string~'
157 * If @c path contains spaces, then the returned path is enclosed in
158 * "-quotes. This last fix will lead to successful compiliation of the
159 * LaTeX file only if a sufficiently modern LaTeX compiler is used.
160 * If @c ext == EXCLUDE_EXTENSION the extension is left outside the quotes.
161 * This is needed for pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4)
162 * (format=pdflatex 2005.4.11) in combination with
163 * pdftex.def 2002/06/19 v0.03k graphics/color for pdftex:
164 * It does not recognize the file extension if it is inside the quotes.
165 * If @c dots == ESCAPE_DOTS dots in the filename are replaced by
166 * "\\lyxdot ". This is needed for the \\includegraphics command if the
167 * automatic format selection is used.
169 std::string const latex_path(std::string const & path,
170 latex_path_extension extension = PROTECT_EXTENSION,
171 latex_path_dots dots = LEAVE_DOTS);
173 /// Substitutes active latex characters with underscores in filename
174 FileName const makeLatexName(FileName const & file);
176 /** Put the name in quotes suitable for the current shell or python,
177 depending on \p style. */
178 std::string const quoteName(std::string const & file, quote_style style = quote_shell);
180 /// Add a filename to a path. Any path from filename is stripped first.
181 std::string const addName(std::string const & path, std::string const & fname);
183 /// Append sub-directory(ies) to path in an intelligent way
184 std::string const addPath(std::string const & path, std::string const & path2);
186 /** Change extension of oldname to extension.
187 If oldname does not have an extension, it is appended.
188 If the extension is empty, any extension is removed from the name.
191 changeExtension(std::string const & oldname, std::string const & extension);
193 /// Remove the extension from \p name
194 std::string const removeExtension(std::string const & name);
196 /** Add the extension \p ext to \p name.
197 Use this instead of changeExtension if you know that \p name is without
198 extension, because changeExtension would wrongly interpret \p name if it
202 addExtension(std::string const & name, std::string const & extension);
204 /// Return the extension of the file (not including the .)
205 std::string const getExtension(std::string const & name);
207 /** \return the name that LyX will give to the unzipped file \p zipped_file
208 if the second argument of unzipFile() is empty.
210 std::string const unzippedFileName(std::string const & zipped_file);
212 /** Unzip \p zipped_file.
213 The unzipped file is named \p unzipped_file if \p unzipped_file is not
214 empty, and unzippedFileName(\p zipped_file) otherwise.
215 Will overwrite an already existing unzipped file without warning.
217 FileName const unzipFile(FileName const & zipped_file,
218 std::string const & unzipped_file = std::string());
220 /// Create absolute path. If impossible, don't do anything
221 std::string const expandPath(std::string const & path);
223 /** Convert relative path into absolute path based on a basepath.
224 If relpath is absolute, just use that.
225 If basepath doesn't exist use CWD.
227 FileName const makeAbsPath(std::string const & RelPath = std::string(),
228 std::string const & BasePath = std::string());
230 /** Creates a nice compact path for displaying. The parameter
231 threshold, if given, specifies the maximal length of the path.
234 makeDisplayPath(std::string const & path, unsigned int threshold = 1000);
236 /** Makes relative path out of absolute path.
237 If it is deeper than basepath,
238 it's easy. If basepath and abspath share something (they are all deeper
239 than some directory), it'll be rendered using ..'s. If they are completely
240 different, then the absolute path will be used as relative path
241 WARNING: the absolute path and base path must really be absolute paths!!!
244 makeRelPath(docstring const & abspath, docstring const & basepath);
246 /// Strip filename from path name
247 std::string const onlyPath(std::string const & fname);
249 /// Strips path from filename
250 std::string const onlyFileName(std::string const & fname);
252 /** Check and Replace Environmentvariables ${NAME} in Path.
253 Replaces all occurences of these, if they are found in the
255 Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
257 std::string const replaceEnvironmentPath(std::string const & path);
260 Return a string to be used as a prefix to a command for setting the
261 environment of the TeX engine with respect to the path \p path.
263 std::string latexEnvCmdPrefix(std::string const & path);
265 /** Replace all references to a current directory (a lonely '.' or
266 the prefix "./") in \c pathlist with \c path. Also prefixes
267 all non-absolute paths with \c path.
269 std::string const replaceCurdirPath(std::string const & path, std::string const & pathlist);
271 /** Set \c link to the path \c file points to as a symbolic link.
272 \return true if successful.
274 bool readLink(FileName const & file, FileName & link);
277 * Search a TeX file in all locations the latex compiler would search it,
278 * with the help of kpsewhich.
279 * The current working directory must be set correctly, so that relative
281 * \param fil The filename to search
282 * \param format The file format as used by kpsewhich, e.g. "bib", "bst" etc.
284 FileName const findtexfile(std::string const & fil,
285 std::string const & format);
287 /** \param file1, file2 the two files to be compared. Must have absolute paths.
288 * \returns 1 if \c file1 has a more recent timestamp than \c file2,
289 * 0 if their timestamps are the same,
290 * -1 if \c file2 has a more recent timestamp than \c file1.
291 * If one of the files does not exist, the return value indicates the file
292 * which does exist. Eg, if \c file1 exists but \c file2 does not, return 1.
294 int compare_timestamps(FileName const & file1, FileName const & file2);
296 /// \param lfuns: true if we're converting lfuns, false if prefs
297 bool prefs2prefs(FileName const & filename, FileName const & tempfile,
300 typedef std::pair<int, std::string> cmd_ret;
302 cmd_ret const runCommand(std::string const & cmd);
304 int fileLock(const char * lock_file);
305 void fileUnlock(int fd, const char * lock_file);
307 } // namespace support