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
56 /** Returns the real name of file name in directory path, with optional
58 The file is searched in the given path (unless it is an absolute
59 file name), first directly, and then with extension .ext (if given).
61 FileName const fileSearch(std::string const & path,
62 std::string const & name,
63 std::string const & ext = std::string(),
64 search_mode mode = must_exist);
67 bool isLyXFileName(std::string const & filename);
70 bool isSGMLFileName(std::string const & filename);
72 /// check for characters in filenames not allowed by LaTeX
73 bool isValidLaTeXFileName(std::string const & filename);
75 /** check for characters in filenames that might lead to
76 problems when manually compiling the LaTeX export of LyX
77 and opening the result with some older DVI-viewers
79 bool isValidDVIFileName(std::string const & filename);
81 /// check whether the file has binary contents
82 bool isBinaryFile(FileName const & filename);
84 /** Returns the path of a library data file.
85 Search the file name.ext in the subdirectory dir of
87 -# build_lyxdir (if not empty)
89 The third parameter `ext' is optional.
91 FileName const libFileSearch(std::string const & dir,
92 std::string const & name,
93 std::string const & ext = std::string());
95 /** Same as libFileSearch(), but tries first to find an
96 internationalized version of the file by prepending $LANG_ to the
100 i18nLibFileSearch(std::string const & dir,
101 std::string const & name,
102 std::string const & ext = std::string());
104 /** Same as libFileSearch(), but tries first to find a preferred
105 version of the file by appending the icon set name to the dir
108 imageLibFileSearch(std::string & dir, std::string const & name,
109 std::string const & ext = std::string());
111 /// How to quote a filename
113 /** Quote for the (OS dependant) shell. This is needed for command
114 line arguments of subprocesses. */
116 /** Quote for python. Use this if you want to store a filename in a
117 python script. Example: \code
118 os << "infile = " << quoteName(filename) << '\\n';
119 \endcode This uses double quotes, so that you can also use this
120 to quote filenames as part of a string if the string is quoted
121 with single quotes. */
125 /** Takes a command such as "python $$s/scripts/convertDefault.py file.in file.out"
126 * and replaces "$$s/" with the path to the LyX support directory containing
127 * this script. If the script is not found, "$$s/" is removed. Executing the
128 * command will still fail, but the error message will make some sort of
131 std::string const commandPrep(std::string const & command);
133 enum latex_path_extension {
138 enum latex_path_dots {
143 /** @param path a file path in internal_path format. Ie, directories
144 * are indicated by '/', not by '\'.
146 * Manipulates @c path into a form suitable for inclusion in a LaTeX
148 * If @c path contains LaTeX special characters, these are escaped.
149 * Eg, '~' -> '\\string~'
150 * If @c path contains spaces, then the returned path is enclosed in
151 * "-quotes. This last fix will lead to successful compiliation of the
152 * LaTeX file only if a sufficiently modern LaTeX compiler is used.
153 * If @c ext == EXCLUDE_EXTENSION the extension is left outside the quotes.
154 * This is needed for pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4)
155 * (format=pdflatex 2005.4.11) in combination with
156 * pdftex.def 2002/06/19 v0.03k graphics/color for pdftex:
157 * It does not recognize the file extension if it is inside the quotes.
158 * If @c dots == ESCAPE_DOTS dots in the filename are replaced by
159 * "\\lyxdot ". This is needed for the \\includegraphics command if the
160 * automatic format selection is used.
162 std::string const latex_path(std::string const & path,
163 latex_path_extension extension = PROTECT_EXTENSION,
164 latex_path_dots dots = LEAVE_DOTS);
166 /// Substitutes active latex characters with underscores in filename
167 FileName const makeLatexName(FileName const & file);
169 /** Put the name in quotes suitable for the current shell or python,
170 depending on \p style. */
171 std::string const quoteName(std::string const & file, quote_style style = quote_shell);
173 /// Add a filename to a path. Any path from filename is stripped first.
174 std::string const addName(std::string const & path, std::string const & fname);
176 /// Append sub-directory(ies) to path in an intelligent way
177 std::string const addPath(std::string const & path, std::string const & path2);
179 /** Change extension of oldname to extension.
180 If oldname does not have an extension, it is appended.
181 If the extension is empty, any extension is removed from the name.
184 changeExtension(std::string const & oldname, std::string const & extension);
186 /// Remove the extension from \p name
187 std::string const removeExtension(std::string const & name);
189 /** Add the extension \p ext to \p name.
190 Use this instead of changeExtension if you know that \p name is without
191 extension, because changeExtension would wrongly interpret \p name if it
195 addExtension(std::string const & name, std::string const & extension);
197 /// Return the extension of the file (not including the .)
198 std::string const getExtension(std::string const & name);
200 /** \return the name that LyX will give to the unzipped file \p zipped_file
201 if the second argument of unzipFile() is empty.
203 std::string const unzippedFileName(std::string const & zipped_file);
205 /** Unzip \p zipped_file.
206 The unzipped file is named \p unzipped_file if \p unzipped_file is not
207 empty, and unzippedFileName(\p zipped_file) otherwise.
208 Will overwrite an already existing unzipped file without warning.
210 FileName const unzipFile(FileName const & zipped_file,
211 std::string const & unzipped_file = std::string());
213 /// Create absolute path. If impossible, don't do anything
214 std::string const expandPath(std::string const & path);
216 /** Convert relative path into absolute path based on a basepath.
217 If relpath is absolute, just use that.
218 If basepath doesn't exist use CWD.
220 FileName const makeAbsPath(std::string const & RelPath = std::string(),
221 std::string const & BasePath = std::string());
223 /** Creates a nice compact path for displaying. The parameter
224 threshold, if given, specifies the maximal length of the path.
227 makeDisplayPath(std::string const & path, unsigned int threshold = 1000);
229 /** Makes relative path out of absolute path.
230 If it is deeper than basepath,
231 it's easy. If basepath and abspath share something (they are all deeper
232 than some directory), it'll be rendered using ..'s. If they are completely
233 different, then the absolute path will be used as relative path
234 WARNING: the absolute path and base path must really be absolute paths!!!
237 makeRelPath(docstring const & abspath, docstring const & basepath);
239 /// Strip filename from path name
240 std::string const onlyPath(std::string const & fname);
242 /// Strips path from filename
243 std::string const onlyFileName(std::string const & fname);
245 /** Check and Replace Environmentvariables ${NAME} in Path.
246 Replaces all occurences of these, if they are found in the
248 Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
250 std::string const replaceEnvironmentPath(std::string const & path);
253 Return a string to be used as a prefix to a command for setting the
254 environment of the TeX engine with respect to the path \p path.
256 std::string latexEnvCmdPrefix(std::string const & path);
258 /** Replace all references to a current directory (a lonely '.' or
259 the prefix "./") in \c pathlist with \c path. Also prefixes
260 all non-absolute paths with \c path.
262 std::string const replaceCurdirPath(std::string const & path, std::string const & pathlist);
264 /** Set \c link to the path \c file points to as a symbolic link.
265 \return true if successful.
267 bool readLink(FileName const & file, FileName & link);
270 * Search a TeX file in all locations the latex compiler would search it,
271 * with the help of kpsewhich.
272 * The current working directory must be set correctly, so that relative
274 * \param fil The filename to search
275 * \param format The file format as used by kpsewhich, e.g. "bib", "bst" etc.
277 FileName const findtexfile(std::string const & fil,
278 std::string const & format);
280 /** \param file1, file2 the two files to be compared. Must have absolute paths.
281 * \returns 1 if \c file1 has a more recent timestamp than \c file2,
282 * 0 if their timestamps are the same,
283 * -1 if \c file2 has a more recent timestamp than \c file1.
284 * If one of the files does not exist, the return value indicates the file
285 * which does exist. Eg, if \c file1 exists but \c file2 does not, return 1.
287 int compare_timestamps(FileName const & file1, FileName const & file2);
289 /// \param lfuns: true if we're converting lfuns, false if prefs
290 bool prefs2prefs(FileName const & filename, FileName const & tempfile,
293 typedef std::pair<int, std::string> cmd_ret;
295 cmd_ret const runCommand(std::string const & cmd);
297 int fileLock(const char * lock_file);
298 void fileUnlock(int fd, const char * lock_file);
300 } // namespace support