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"
16 #include "support/FileName.h"
25 /// Creates the per buffer temporary directory
26 std::string const createBufferTmpDir();
28 /** Creates the global LyX temp dir.
29 \p deflt can be an existing directory name. In this case a new directory
30 inside \p deflt is created. If \p deflt does not exist yet, \p deflt is
31 created and used as the temporary directory.
32 \return the tmp dir name or string() if something went wrong.
34 FileName const createLyXTmpDir(FileName const & deflt);
37 // FIXME unused. Should this be deleted or resurrected?
38 /** Find file by searching several directories.
39 Uses a string of paths separated by ";"s to find a file to open.
40 Can't cope with pathnames with a ';' in them. Returns full path to file.
41 If path entry begins with $$LyX/, use system_lyxdir.
42 If path entry begins with $$User/, use user_lyxdir.
43 Example: "$$User/doc;$$LyX/doc".
45 FileName const fileOpenSearch(std::string const & path,
46 std::string const & name,
47 std::string const & ext = std::string());
50 /// How to search files
52 // The file must exist (return an empty file name otherwise)
54 /// Only do file name expansion, return the complete name even if
55 /// the file does not exist
59 /** Returns the real name of file name in directory path, with optional
61 The file is searched in the given path (unless it is an absolute
62 file name), first directly, and then with extension .ext (if given).
64 FileName const fileSearch(std::string const & path,
65 std::string const & name,
66 std::string const & ext = std::string(),
67 search_mode mode = standard_mode);
69 /// Returns a vector of all files in directory dir having extension ext.
70 std::vector<FileName> const dirList(FileName const & dir,
71 std::string const & ext = std::string());
74 bool isLyXFilename(std::string const & filename);
77 bool isSGMLFilename(std::string const & filename);
80 bool isValidLaTeXFilename(std::string const & filename);
82 /** Returns the path of a library data file.
83 Search the file name.ext in the subdirectory dir of
85 -# build_lyxdir (if not empty)
87 The third parameter `ext' is optional.
89 FileName const libFileSearch(std::string const & dir,
90 std::string const & name,
91 std::string const & ext = std::string());
93 /** Same as libFileSearch(), but tries first to find an
94 internationalized version of the file by prepending $LANG_ to the
98 i18nLibFileSearch(std::string const & dir,
99 std::string const & name,
100 std::string const & ext = std::string());
102 /// How to quote a filename
104 /** Quote for the (OS dependant) shell. This is needed for command
105 line arguments of subprocesses. */
107 /** Quote for python. Use this if you want to store a filename in a
108 python script. Example: \code
109 os << "infile = " << quoteName(filename) << '\\n';
110 \endcode This uses double quotes, so that you can also use this
111 to quote filenames as part of a string if the string is quoted
112 with single quotes. */
116 /** Takes a command such as "python $$s/scripts/convertDefault.py file.in file.out"
117 * and replaces "$$s/" with the path to the LyX support directory containing
118 * this script. If the script is not found, "$$s/" is removed. Executing the
119 * command will still fail, but the error message will make some sort of
122 std::string const libScriptSearch(std::string const & command,
123 quote_style style = quote_shell);
125 enum latex_path_extension {
130 enum latex_path_dots {
135 /** @param path a file path in internal_path format. Ie, directories
136 * are indicated by '/', not by '\'.
138 * Manipulates @c path into a form suitable for inclusion in a LaTeX
140 * If @c path contains LaTeX special characters, these are escaped.
141 * Eg, '~' -> '\\string~'
142 * If @c path contains spaces, then the returned path is enclosed in
143 * "-quotes. This last fix will lead to successful compiliation of the
144 * LaTeX file only if a sufficiently modern LaTeX compiler is used.
145 * If @c ext == EXCLUDE_EXTENSION the extension is left outside the quotes.
146 * This is needed for pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4)
147 * (format=pdflatex 2005.4.11) in combination with
148 * pdftex.def 2002/06/19 v0.03k graphics/color for pdftex:
149 * It does not recognize the file extension if it is inside the quotes.
150 * If @c dots == ESCAPE_DOTS dots in the filename are replaced by
151 * "\\lyxdot ". This is needed for the \\includegraphics command if the
152 * automatic format selection is used.
154 std::string const latex_path(std::string const & path,
155 latex_path_extension extension = PROTECT_EXTENSION,
156 latex_path_dots dots = LEAVE_DOTS);
158 /// Substitutes active latex characters with underscores in filename
159 std::string const makeLatexName(std::string const & file);
161 /** Put the name in quotes suitable for the current shell or python,
162 depending on \p style. */
163 std::string const quoteName(std::string const & file, quote_style style = quote_shell);
165 /// Add a filename to a path. Any path from filename is stripped first.
166 std::string const addName(std::string const & path, std::string const & fname);
168 /// Append sub-directory(ies) to path in an intelligent way
169 std::string const addPath(std::string const & path, std::string const & path2);
171 /** Change extension of oldname to extension.
172 If oldname does not have an extension, it is appended.
173 If the extension is empty, any extension is removed from the name.
176 changeExtension(std::string const & oldname, std::string const & extension);
178 /// Remove the extension from \p name
179 std::string const removeExtension(std::string const & name);
181 /** Add the extension \p ext to \p name.
182 Use this instead of changeExtension if you know that \p name is without
183 extension, because changeExtension would wrongly interpret \p name if it
187 addExtension(std::string const & name, std::string const & extension);
189 /// Return the extension of the file (not including the .)
190 std::string const getExtension(std::string const & name);
192 /** \return the name that LyX will give to the unzipped file \p zipped_file
193 if the second argument of unzipFile() is empty.
195 std::string const unzippedFileName(std::string const & zipped_file);
197 /** Unzip \p zipped_file.
198 The unzipped file is named \p unzipped_file if \p unzipped_file is not
199 empty, and unzippedFileName(\p zipped_file) otherwise.
200 Will overwrite an already existing unzipped file without warning.
202 FileName const unzipFile(FileName const & zipped_file,
203 std::string const & unzipped_file = std::string());
205 /// Returns true is path is absolute
206 bool absolutePath(std::string const & path);
208 /// Create absolute path. If impossible, don't do anything
209 std::string const expandPath(std::string const & path);
211 /** Convert relative path into absolute path based on a basepath.
212 If relpath is absolute, just use that.
213 If basepath doesn't exist use CWD.
215 FileName const makeAbsPath(std::string const & RelPath = std::string(),
216 std::string const & BasePath = std::string());
218 /** Creates a nice compact path for displaying. The parameter
219 threshold, if given, specifies the maximal length of the path.
222 makeDisplayPath(std::string const & path, unsigned int threshold = 1000);
224 /** Makes relative path out of absolute path.
225 If it is deeper than basepath,
226 it's easy. If basepath and abspath share something (they are all deeper
227 than some directory), it'll be rendered using ..'s. If they are completely
228 different, then the absolute path will be used as relative path
229 WARNING: the absolute path and base path must really be absolute paths!!!
232 makeRelPath(docstring const & abspath, docstring const & basepath);
234 /// Strip filename from path name
235 std::string const onlyPath(std::string const & fname);
237 /** Normalize a path. Constracts path/../path
238 * Also converts paths like /foo//bar ==> /foo/bar
240 std::string const normalizePath(std::string const & path);
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);
252 /** Set \c link to the path \c file points to as a symbolic link.
253 \return true if successful.
255 bool readLink(FileName const & file, FileName & link);
258 * Search a TeX file in all locations the latex compiler would search it,
259 * with the help of kpsewhich.
260 * The current working directory must be set correctly, so that relative
262 * \param fil The filename to search
263 * \param format The file format as used by kpsewhich, e.g. "bib", "bst" etc.
265 FileName const findtexfile(std::string const & fil,
266 std::string const & format);
268 /// remove the autosave-file and give a Message if it can't be done
269 void removeAutosaveFile(std::string const & filename);
271 /// read the BoundingBox entry from a ps/eps/pdf-file
272 std::string const readBB_from_PSFile(FileName const & file);
274 /** \param file1, file2 the two files to be compared. Must have absolute paths.
275 * \returns 1 if \c file1 has a more recent timestamp than \c file2,
276 * 0 if their timestamps are the same,
277 * -1 if \c file2 has a more recent timestamp than \c file1.
278 * If one of the files does not exist, the return value indicates the file
279 * which does exist. Eg, if \c file1 exists but \c file2 does not, return 1.
281 int compare_timestamps(FileName const & file1, FileName const & file2);
283 typedef std::pair<int, std::string> cmd_ret;
285 cmd_ret const runCommand(std::string const & cmd);
287 } // namespace support
290 /// The following functions are implemented in minizip/zipunzip.cpp, and are not in
291 /// the lyx::support namespace
293 /// zip several files to a zipfile. In-zip filenames are also specified
294 bool zipFiles(std::string const & zipfile, std::vector<std::pair<std::string, std::string> > const & files);
296 /// Unzip a zip file to a directory
297 bool unzipToDir(std::string const & zipfile, std::string const & path);