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 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);
70 bool isLyXFilename(std::string const & filename);
73 bool isSGMLFilename(std::string const & filename);
76 bool isValidLaTeXFilename(std::string const & filename);
78 /** Returns the path of a library data file.
79 Search the file name.ext in the subdirectory dir of
81 -# build_lyxdir (if not empty)
83 The third parameter `ext' is optional.
85 FileName const libFileSearch(std::string const & dir,
86 std::string const & name,
87 std::string const & ext = std::string());
89 /** Same as libFileSearch(), but tries first to find an
90 internationalized version of the file by prepending $LANG_ to the
94 i18nLibFileSearch(std::string const & dir,
95 std::string const & name,
96 std::string const & ext = std::string());
98 /// How to quote a filename
100 /** Quote for the (OS dependant) shell. This is needed for command
101 line arguments of subprocesses. */
103 /** Quote for python. Use this if you want to store a filename in a
104 python script. Example: \code
105 os << "infile = " << quoteName(filename) << '\\n';
106 \endcode This uses double quotes, so that you can also use this
107 to quote filenames as part of a string if the string is quoted
108 with single quotes. */
112 /** Takes a command such as "python $$s/scripts/convertDefault.py file.in file.out"
113 * and replaces "$$s/" with the path to the LyX support directory containing
114 * this script. If the script is not found, "$$s/" is removed. Executing the
115 * command will still fail, but the error message will make some sort of
118 std::string const libScriptSearch(std::string const & command,
119 quote_style style = quote_shell);
121 enum latex_path_extension {
126 enum latex_path_dots {
131 /** @param path a file path in internal_path format. Ie, directories
132 * are indicated by '/', not by '\'.
134 * Manipulates @c path into a form suitable for inclusion in a LaTeX
136 * If @c path contains LaTeX special characters, these are escaped.
137 * Eg, '~' -> '\\string~'
138 * If @c path contains spaces, then the returned path is enclosed in
139 * "-quotes. This last fix will lead to successful compiliation of the
140 * LaTeX file only if a sufficiently modern LaTeX compiler is used.
141 * If @c ext == EXCLUDE_EXTENSION the extension is left outside the quotes.
142 * This is needed for pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4)
143 * (format=pdflatex 2005.4.11) in combination with
144 * pdftex.def 2002/06/19 v0.03k graphics/color for pdftex:
145 * It does not recognize the file extension if it is inside the quotes.
146 * If @c dots == ESCAPE_DOTS dots in the filename are replaced by
147 * "\\lyxdot ". This is needed for the \\includegraphics command if the
148 * automatic format selection is used.
150 std::string const latex_path(std::string const & path,
151 latex_path_extension extension = PROTECT_EXTENSION,
152 latex_path_dots dots = LEAVE_DOTS);
154 /// Substitutes active latex characters with underscores in filename
155 FileName const makeLatexName(FileName const & file);
157 /** Put the name in quotes suitable for the current shell or python,
158 depending on \p style. */
159 std::string const quoteName(std::string const & file, quote_style style = quote_shell);
161 /// Add a filename to a path. Any path from filename is stripped first.
162 std::string const addName(std::string const & path, std::string const & fname);
164 /// Append sub-directory(ies) to path in an intelligent way
165 std::string const addPath(std::string const & path, std::string const & path2);
167 /** Change extension of oldname to extension.
168 If oldname does not have an extension, it is appended.
169 If the extension is empty, any extension is removed from the name.
172 changeExtension(std::string const & oldname, std::string const & extension);
174 /// Remove the extension from \p name
175 std::string const removeExtension(std::string const & name);
177 /** Add the extension \p ext to \p name.
178 Use this instead of changeExtension if you know that \p name is without
179 extension, because changeExtension would wrongly interpret \p name if it
183 addExtension(std::string const & name, std::string const & extension);
185 /// Return the extension of the file (not including the .)
186 std::string const getExtension(std::string const & name);
188 /** \return the name that LyX will give to the unzipped file \p zipped_file
189 if the second argument of unzipFile() is empty.
191 std::string const unzippedFileName(std::string const & zipped_file);
193 /** Unzip \p zipped_file.
194 The unzipped file is named \p unzipped_file if \p unzipped_file is not
195 empty, and unzippedFileName(\p zipped_file) otherwise.
196 Will overwrite an already existing unzipped file without warning.
198 FileName const unzipFile(FileName const & zipped_file,
199 std::string const & unzipped_file = std::string());
201 /// Create absolute path. If impossible, don't do anything
202 std::string const expandPath(std::string const & path);
204 /** Convert relative path into absolute path based on a basepath.
205 If relpath is absolute, just use that.
206 If basepath doesn't exist use CWD.
208 FileName const makeAbsPath(std::string const & RelPath = std::string(),
209 std::string const & BasePath = std::string());
211 /** Creates a nice compact path for displaying. The parameter
212 threshold, if given, specifies the maximal length of the path.
215 makeDisplayPath(std::string const & path, unsigned int threshold = 1000);
217 /** Makes relative path out of absolute path.
218 If it is deeper than basepath,
219 it's easy. If basepath and abspath share something (they are all deeper
220 than some directory), it'll be rendered using ..'s. If they are completely
221 different, then the absolute path will be used as relative path
222 WARNING: the absolute path and base path must really be absolute paths!!!
225 makeRelPath(docstring const & abspath, docstring const & basepath);
227 /// Strip filename from path name
228 std::string const onlyPath(std::string const & fname);
230 /// Strips path from filename
231 std::string const onlyFilename(std::string const & fname);
233 /** Check and Replace Environmentvariables ${NAME} in Path.
234 Replaces all occurences of these, if they are found in the
236 Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
238 std::string const replaceEnvironmentPath(std::string const & path);
240 /** Set \c link to the path \c file points to as a symbolic link.
241 \return true if successful.
243 bool readLink(FileName const & file, FileName & link);
246 * Search a TeX file in all locations the latex compiler would search it,
247 * with the help of kpsewhich.
248 * The current working directory must be set correctly, so that relative
250 * \param fil The filename to search
251 * \param format The file format as used by kpsewhich, e.g. "bib", "bst" etc.
253 FileName const findtexfile(std::string const & fil,
254 std::string const & format);
256 /// remove the autosave-file and give a Message if it can't be done
257 void removeAutosaveFile(std::string const & filename);
259 /// read the BoundingBox entry from a ps/eps/pdf-file
260 std::string const readBB_from_PSFile(FileName const & file);
262 /** \param file1, file2 the two files to be compared. Must have absolute paths.
263 * \returns 1 if \c file1 has a more recent timestamp than \c file2,
264 * 0 if their timestamps are the same,
265 * -1 if \c file2 has a more recent timestamp than \c file1.
266 * If one of the files does not exist, the return value indicates the file
267 * which does exist. Eg, if \c file1 exists but \c file2 does not, return 1.
269 int compare_timestamps(FileName const & file1, FileName const & file2);
271 typedef std::pair<int, std::string> cmd_ret;
273 cmd_ret const runCommand(std::string const & cmd);
276 } // namespace support