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);
108 std::string const GetEnv(std::string const & envname);
110 /** Return the contents of the environment variable \c name,
111 * split using the OS-dependent token separating elements.
112 * Each element is then passed through os::internal_path to
113 * guarantee that it is in the form of a unix-stype path.
114 * If the environment variable is not set, then returns an empty vector.
116 std::vector<std::string> const getEnvPath(std::string const & name);
118 /** Set the contents of the environment variable \c name
119 * using the paths stored in the \c env vector.
120 * Each element is passed through os::external_path.
122 void setEnvPath(std::string const & name, std::vector<std::string> const & env);
124 /** Prepend a list of paths to that returned by the environment variable.
125 * Identical paths occurring later in the list are removed.
126 * @param name the name of the environment variable.
127 * @prefix the list of paths in OS-native syntax.
128 * Eg "/foo/bar:/usr/bin:/usr/local/bin" on *nix,
129 * "C:\foo\bar;C:\windows" on Windows.
131 void prependEnvPath(std::string const & name, std::string const & prefix);
133 /// Set an environment variable using a string of the form "name=FOO".
134 bool putEnv(std::string const & envstr);
136 /// Substitutes active latex characters with underscores in filename
137 std::string const MakeLatexName(std::string const & file);
139 /// Put the name in quotes suitable for the current shell
140 std::string const QuoteName(std::string const & file);
142 /// Add a filename to a path. Any path from filename is stripped first.
143 std::string const AddName(std::string const & path, std::string const & fname);
145 /// Append sub-directory(ies) to path in an intelligent way
146 std::string const AddPath(std::string const & path, std::string const & path2);
148 /** Change extension of oldname to extension.
149 If oldname does not have an extension, it is appended.
150 If the extension is empty, any extension is removed from the name.
153 ChangeExtension(std::string const & oldname, std::string const & extension);
155 /// Return the extension of the file (not including the .)
156 std::string const GetExtension(std::string const & name);
158 /** Guess the file format name (as in Format::name()) from contents.
159 Normally you don't want to use this directly, but rather
160 Formats::getFormatFromFile().
162 std::string const getFormatFromContents(std::string const & name);
164 /// check for zipped file
165 bool zippedFile(std::string const & name);
167 /** \return the name that LyX will give to the unzipped file \p zipped_file
168 if the second argument of unzipFile() is empty.
170 std::string const unzippedFileName(std::string const & zipped_file);
172 /** Unzip \p zipped_file.
173 The unzipped file is named \p unzipped_file if \p unzipped_file is not
174 empty, and unzippedFileName(\p zipped_file) otherwise.
175 Will overwrite an already existing unzipped file without warning.
177 std::string const unzipFile(std::string const & zipped_file,
178 std::string const & unzipped_file = std::string());
180 /// Returns true is path is absolute
181 bool AbsolutePath(std::string const & path);
183 /// Create absolute path. If impossible, don't do anything
184 std::string const ExpandPath(std::string const & path);
186 /** Convert relative path into absolute path based on a basepath.
187 If relpath is absolute, just use that.
188 If basepath doesn't exist use CWD.
190 std::string const MakeAbsPath(std::string const & RelPath = std::string(),
191 std::string const & BasePath = std::string());
193 /** Creates a nice compact path for displaying. The parameter
194 threshold, if given, specifies the maximal length of the path.
197 MakeDisplayPath(std::string const & path, unsigned int threshold = 1000);
199 /** Makes relative path out of absolute path.
200 If it is deeper than basepath,
201 it's easy. If basepath and abspath share something (they are all deeper
202 than some directory), it'll be rendered using ..'s. If they are completely
203 different, then the absolute path will be used as relative path
204 WARNING: the absolute path and base path must really be absolute paths!!!
207 MakeRelPath(std::string const & abspath, std::string const & basepath);
209 /// Strip filename from path name
210 std::string const OnlyPath(std::string const & fname);
212 /** Normalize a path. Constracts path/../path
213 * Also converts paths like /foo//bar ==> /foo/bar
215 std::string const NormalizePath(std::string const & path);
217 /// Strips path from filename
218 std::string const OnlyFilename(std::string const & fname);
220 /// Get the contents of a file as a huge std::string
221 std::string const GetFileContents(std::string const & fname);
223 /** Check and Replace Environmentvariables ${NAME} in Path.
224 Replaces all occurences of these, if they are found in the
226 Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
228 std::string const ReplaceEnvironmentPath(std::string const & path);
230 /* Set \c link to the path \c file points to as a symbolic link.
231 If \c resolve is true, then \c link is an absolute path
232 Returns true if successful */
233 bool LyXReadLink(std::string const & file, std::string & link, bool resolve = false);
235 /// Uses kpsewhich to find tex files
236 std::string const findtexfile(std::string const & fil, std::string const & format);
238 /// remove the autosave-file and give a Message if it can't be done
239 void removeAutosaveFile(std::string const & filename);
241 /// read the BoundingBox entry from a ps/eps/pdf-file
242 std::string const readBB_from_PSFile(std::string const & file);
244 /** \param file1, file2 the two files to be compared. Must have absolute paths.
245 * \returns 1 if \c file1 has a more recent timestamp than \c file2,
246 * 0 if their timestamps are the same,
247 * -1 if \c file2 has a more recent timestamp than \c file1.
248 * If one of the files does not exist, the return value indicates the file
249 * which does exist. Eg, if \c file1 exists but \c file2 does not, return 1.
251 int compare_timestamps(std::string const & file1, std::string const & file2);
253 typedef std::pair<int, std::string> cmd_ret;
255 cmd_ret const RunCommand(std::string const & cmd);
257 } // namespace support