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 /// remove directory and all contents, returns true on success
26 bool destroyDir(FileName const & tmpdir);
28 /// Creates the per buffer temporary directory
29 std::string const createBufferTmpDir();
31 /// Creates directory. Returns true on success
32 bool createDirectory(FileName const & name, int permissions);
34 /** Creates the global LyX temp dir.
35 \p deflt can be an existing directory name. In this case a new directory
36 inside \p deflt is created. If \p deflt does not exist yet, \p deflt is
37 created and used as the temporary directory.
38 \return the tmp dir name or string() if something went wrong.
40 FileName const createLyXTmpDir(FileName const & deflt);
43 // FIXME unused. Should this be deleted or resurrected?
44 /** Find file by searching several directories.
45 Uses a string of paths separated by ";"s to find a file to open.
46 Can't cope with pathnames with a ';' in them. Returns full path to file.
47 If path entry begins with $$LyX/, use system_lyxdir.
48 If path entry begins with $$User/, use user_lyxdir.
49 Example: "$$User/doc;$$LyX/doc".
51 FileName const fileOpenSearch(std::string const & path,
52 std::string const & name,
53 std::string const & ext = std::string());
56 /// How to search files
58 // The file must exist (return an empty file name otherwise)
60 /// Only do file name expansion, return the complete name even if
61 /// the file does not exist
65 /** Returns the real name of file name in directory path, with optional
67 The file is searched in the given path (unless it is an absolute
68 file name), first directly, and then with extension .ext (if given).
70 FileName const fileSearch(std::string const & path,
71 std::string const & name,
72 std::string const & ext = std::string(),
73 search_mode mode = standard_mode);
75 /// Returns a vector of all files in directory dir having extension ext.
76 std::vector<FileName> const dirList(FileName const & dir,
77 std::string const & ext = std::string());
79 /** Is directory read only?
84 bool isDirWriteable(FileName const & path);
86 /** Is a file readable ?
87 Returns true if the file `path' is readable.
89 bool isFileReadable(FileName const & path);
92 bool isLyXFilename(std::string const & filename);
95 bool isSGMLFilename(std::string const & filename);
97 /** Returns the path of a library data file.
98 Search the file name.ext in the subdirectory dir of
100 -# build_lyxdir (if not empty)
102 The third parameter `ext' is optional.
104 FileName const libFileSearch(std::string const & dir,
105 std::string const & name,
106 std::string const & ext = std::string());
108 /** Same as libFileSearch(), but tries first to find an
109 internationalized version of the file by prepending $LANG_ to the
113 i18nLibFileSearch(std::string const & dir,
114 std::string const & name,
115 std::string const & ext = std::string());
117 /// How to quote a filename
119 /** Quote for the (OS dependant) shell. This is needed for command
120 line arguments of subprocesses. */
122 /** Quote for python. Use this if you want to store a filename in a
123 python script. Example: \code
124 os << "infile = " << quoteName(filename) << '\\n';
125 \endcode This uses double quotes, so that you can also use this
126 to quote filenames as part of a string if the string is quoted
127 with single quotes. */
131 /** Takes a command such as "python $$s/scripts/convertDefault.py file.in file.out"
132 * and replaces "$$s/" with the path to the LyX support directory containing
133 * this script. If the script is not found, "$$s/" is removed. Executing the
134 * command will still fail, but the error message will make some sort of
137 std::string const libScriptSearch(std::string const & command,
138 quote_style style = quote_shell);
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 std::string const makeLatexName(std::string 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 /** Guess the file format name (as in Format::name()) from contents.
208 Normally you don't want to use this directly, but rather
209 Formats::getFormatFromFile().
211 std::string const getFormatFromContents(FileName const & name);
213 /// check for zipped file
214 bool zippedFile(FileName const & name);
216 /** \return the name that LyX will give to the unzipped file \p zipped_file
217 if the second argument of unzipFile() is empty.
219 std::string const unzippedFileName(std::string const & zipped_file);
221 /** Unzip \p zipped_file.
222 The unzipped file is named \p unzipped_file if \p unzipped_file is not
223 empty, and unzippedFileName(\p zipped_file) otherwise.
224 Will overwrite an already existing unzipped file without warning.
226 FileName const unzipFile(FileName const & zipped_file,
227 std::string const & unzipped_file = std::string());
229 /// Returns true is path is absolute
230 bool absolutePath(std::string const & path);
232 /// Create absolute path. If impossible, don't do anything
233 std::string const expandPath(std::string const & path);
235 /** Convert relative path into absolute path based on a basepath.
236 If relpath is absolute, just use that.
237 If basepath doesn't exist use CWD.
239 FileName const makeAbsPath(std::string const & RelPath = std::string(),
240 std::string const & BasePath = std::string());
242 /** Creates a nice compact path for displaying. The parameter
243 threshold, if given, specifies the maximal length of the path.
246 makeDisplayPath(std::string const & path, unsigned int threshold = 1000);
248 /** Makes relative path out of absolute path.
249 If it is deeper than basepath,
250 it's easy. If basepath and abspath share something (they are all deeper
251 than some directory), it'll be rendered using ..'s. If they are completely
252 different, then the absolute path will be used as relative path
253 WARNING: the absolute path and base path must really be absolute paths!!!
256 makeRelPath(docstring const & abspath, docstring const & basepath);
258 /// Strip filename from path name
259 std::string const onlyPath(std::string const & fname);
261 /** Normalize a path. Constracts path/../path
262 * Also converts paths like /foo//bar ==> /foo/bar
264 std::string const normalizePath(std::string const & path);
266 /// Strips path from filename
267 std::string const onlyFilename(std::string const & fname);
269 /// Get the contents of a file as a huge std::string
270 std::string const getFileContents(FileName const & fname);
272 /** Check and Replace Environmentvariables ${NAME} in Path.
273 Replaces all occurences of these, if they are found in the
275 Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
277 std::string const replaceEnvironmentPath(std::string const & path);
279 /** Set \c link to the path \c file points to as a symbolic link.
280 \return true if successful.
282 bool readLink(FileName const & file, FileName & link);
285 * Search a TeX file in all locations the latex compiler would search it,
286 * with the help of kpsewhich.
287 * The current working directory must be set correctly, so that relative
289 * \param fil The filename to search
290 * \param format The file format as used by kpsewhich, e.g. "bib", "bst" etc.
292 FileName const findtexfile(std::string const & fil,
293 std::string const & format);
295 /// remove the autosave-file and give a Message if it can't be done
296 void removeAutosaveFile(std::string const & filename);
298 /// read the BoundingBox entry from a ps/eps/pdf-file
299 std::string const readBB_from_PSFile(FileName const & file);
301 /** \param file1, file2 the two files to be compared. Must have absolute paths.
302 * \returns 1 if \c file1 has a more recent timestamp than \c file2,
303 * 0 if their timestamps are the same,
304 * -1 if \c file2 has a more recent timestamp than \c file1.
305 * If one of the files does not exist, the return value indicates the file
306 * which does exist. Eg, if \c file1 exists but \c file2 does not, return 1.
308 int compare_timestamps(FileName const & file1, FileName const & file2);
310 typedef std::pair<int, std::string> cmd_ret;
312 cmd_ret const runCommand(std::string const & cmd);
314 } // namespace support