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
22 /// remove directory and all contents, returns true on success
23 bool destroyDir(std::string const & tmpdir);
25 /// Creates the per buffer temporary directory
26 std::string const createBufferTmpDir();
28 /// Creates directory. Returns true on success
29 bool createDirectory(std::string const & name, int permissions);
31 /** Creates the global LyX temp dir.
32 \p deflt can be an existing directory name. In this case a new directory
33 inside \p deflt is created. If \p deflt does not exist yet, \p deflt is
34 created and used as the temporary directory.
35 \return the tmp dir name or string() if something went wrong.
37 std::string const createLyXTmpDir(std::string const & deflt);
39 /** Find file by searching several directories.
40 Uses a string of paths separated by ";"s to find a file to open.
41 Can't cope with pathnames with a ';' in them. Returns full path to file.
42 If path entry begins with $$LyX/, use system_lyxdir.
43 If path entry begins with $$User/, use user_lyxdir.
44 Example: "$$User/doc;$$LyX/doc".
46 std::string const FileOpenSearch(std::string const & path, std::string const & name,
47 std::string const & ext = std::string());
49 /** Returns the real name of file name in directory path, with optional
51 The file is searched in the given path (unless it is an absolute
52 file name), first directly, and then with extension .ext (if given).
54 std::string const FileSearch(std::string const & path, std::string const & name,
55 std::string const & ext = std::string());
57 /// Returns a vector of all files in directory dir having extension ext.
58 std::vector<std::string> const DirList(std::string const & dir,
59 std::string const & ext = std::string());
61 /** Is directory read only?
66 bool IsDirWriteable (std::string const & path);
68 /** Is a file readable ?
69 Returns true if the file `path' is readable.
71 bool IsFileReadable (std::string const & path);
74 bool IsLyXFilename(std::string const & filename);
77 bool IsSGMLFilename(std::string const & filename);
79 /** Returns the path of a library data file.
80 Search the file name.ext in the subdirectory dir of
83 \item build_lyxdir (if not empty)
86 The third parameter `ext' is optional.
88 std::string const LibFileSearch(std::string const & dir, std::string const & name,
89 std::string const & ext = std::string());
91 /** Same as LibFileSearch(), but tries first to find an
92 internationalized version of the file by prepending $LANG_ to the
96 i18nLibFileSearch(std::string const & dir, std::string const & name,
97 std::string const & ext = std::string());
99 /** Takes a command such as "sh $$s/scripts/convertDefault.sh file.in file.out"
100 * and replaces "$$s/" with the path to the LyX support directory containing
101 * this script. If the script is not found, "$$s/" is removed. Executing the
102 * command will still fail, but the error message will make some sort of
105 std::string const LibScriptSearch(std::string const & command);
107 /** @param path a file path in internal_path format. Ie, directories
108 * are indicated by '/', not by '\'.
110 * Manipulates @c path into a form suitable for inclusion in a LaTeX
112 * If @c path contains LaTeX special characters, these are escaped.
113 * Eg, '~' -> '\string~'
114 * If @c path contains spaces, then the returned path is enclosed in
115 * "-quotes. This last fix will lead to successful compiliation of the
116 * LaTeX file only if a sufficiently modern LaTeX compiler is used.
118 std::string const latex_path(std::string const & path);
120 /// Substitutes active latex characters with underscores in filename
121 std::string const MakeLatexName(std::string const & file);
123 /// Put the name in quotes suitable for the current shell
124 std::string const QuoteName(std::string const & file);
126 /// Add a filename to a path. Any path from filename is stripped first.
127 std::string const AddName(std::string const & path, std::string const & fname);
129 /// Append sub-directory(ies) to path in an intelligent way
130 std::string const AddPath(std::string const & path, std::string const & path2);
132 /** Change extension of oldname to extension.
133 If oldname does not have an extension, it is appended.
134 If the extension is empty, any extension is removed from the name.
137 ChangeExtension(std::string const & oldname, std::string const & extension);
139 /// Return the extension of the file (not including the .)
140 std::string const GetExtension(std::string const & name);
142 /** Guess the file format name (as in Format::name()) from contents.
143 Normally you don't want to use this directly, but rather
144 Formats::getFormatFromFile().
146 std::string const getFormatFromContents(std::string const & name);
148 /// check for zipped file
149 bool zippedFile(std::string const & name);
151 /** \return the name that LyX will give to the unzipped file \p zipped_file
152 if the second argument of unzipFile() is empty.
154 std::string const unzippedFileName(std::string const & zipped_file);
156 /** Unzip \p zipped_file.
157 The unzipped file is named \p unzipped_file if \p unzipped_file is not
158 empty, and unzippedFileName(\p zipped_file) otherwise.
159 Will overwrite an already existing unzipped file without warning.
161 std::string const unzipFile(std::string const & zipped_file,
162 std::string const & unzipped_file = std::string());
164 /// Returns true is path is absolute
165 bool AbsolutePath(std::string const & path);
167 /// Create absolute path. If impossible, don't do anything
168 std::string const ExpandPath(std::string const & path);
170 /** Convert relative path into absolute path based on a basepath.
171 If relpath is absolute, just use that.
172 If basepath doesn't exist use CWD.
174 std::string const MakeAbsPath(std::string const & RelPath = std::string(),
175 std::string const & BasePath = std::string());
177 /** Creates a nice compact path for displaying. The parameter
178 threshold, if given, specifies the maximal length of the path.
181 MakeDisplayPath(std::string const & path, unsigned int threshold = 1000);
183 /** Makes relative path out of absolute path.
184 If it is deeper than basepath,
185 it's easy. If basepath and abspath share something (they are all deeper
186 than some directory), it'll be rendered using ..'s. If they are completely
187 different, then the absolute path will be used as relative path
188 WARNING: the absolute path and base path must really be absolute paths!!!
191 MakeRelPath(std::string const & abspath, std::string const & basepath);
193 /// Strip filename from path name
194 std::string const OnlyPath(std::string const & fname);
196 /** Normalize a path. Constracts path/../path
197 * Also converts paths like /foo//bar ==> /foo/bar
199 std::string const NormalizePath(std::string const & path);
201 /// Strips path from filename
202 std::string const OnlyFilename(std::string const & fname);
204 /// Get the contents of a file as a huge std::string
205 std::string const GetFileContents(std::string const & fname);
207 /** Check and Replace Environmentvariables ${NAME} in Path.
208 Replaces all occurences of these, if they are found in the
210 Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
212 std::string const ReplaceEnvironmentPath(std::string const & path);
214 /* Set \c link to the path \c file points to as a symbolic link.
215 If \c resolve is true, then \c link is an absolute path
216 Returns true if successful */
217 bool LyXReadLink(std::string const & file, std::string & link, bool resolve = false);
219 /// Uses kpsewhich to find tex files
220 std::string const findtexfile(std::string const & fil, std::string const & format);
222 /// remove the autosave-file and give a Message if it can't be done
223 void removeAutosaveFile(std::string const & filename);
225 /// read the BoundingBox entry from a ps/eps/pdf-file
226 std::string const readBB_from_PSFile(std::string const & file);
228 /** \param file1, file2 the two files to be compared. Must have absolute paths.
229 * \returns 1 if \c file1 has a more recent timestamp than \c file2,
230 * 0 if their timestamps are the same,
231 * -1 if \c file2 has a more recent timestamp than \c file1.
232 * If one of the files does not exist, the return value indicates the file
233 * which does exist. Eg, if \c file1 exists but \c file2 does not, return 1.
235 int compare_timestamps(std::string const & file1, std::string const & file2);
237 typedef std::pair<int, std::string> cmd_ret;
239 cmd_ret const RunCommand(std::string const & cmd);
241 } // namespace support