2 /* lyx-filetool.h : tools functions for file/path handling
3 this file is part of LyX, the High Level Word Processor
4 Copyright 1995-2001, Matthias Ettrich and the LyX Team
19 string const CreateBufferTmpDir (string const & pathfor = string());
21 /// Creates directory. Returns true on succes.
22 bool createDirectory(string const & name, int permissions);
25 string const CreateLyXTmpDir (string const & deflt);
28 int DestroyBufferTmpDir (string const & tmpdir);
31 int DestroyLyXTmpDir (string const & tmpdir);
33 /** Find file by searching several directories.
34 Uses a string of paths separated by ";"s to find a file to open.
35 Can't cope with pathnames with a ';' in them. Returns full path to file.
36 If path entry begins with $$LyX/, use system_lyxdir.
37 If path entry begins with $$User/, use user_lyxdir.
38 Example: "$$User/doc;$$LyX/doc".
40 string const FileOpenSearch (string const & path, string const & name,
41 string const & ext = string());
43 /** Returns the real name of file name in directory path, with optional
45 The file is searched in the given path (unless it is an absolute
46 file name), first directly, and then with extension .ext (if given).
48 string const FileSearch(string const & path, string const & name,
49 string const & ext = string());
51 /// Returns a vector of all files in directory dir having extension ext.
52 std::vector<string> const DirList(string const & dir,
53 string const & ext = string());
55 /** Is directory read only?
59 -1: error- couldn't find out, or unsure
61 int IsDirWriteable (string const & path);
63 /** Is a file readable ?
64 Returns true if the file `path' is readable.
66 bool IsFileReadable (string const & path);
68 /** Is file read only?
72 -1: error (doesn't exist, no access, anything else)
74 int IsFileWriteable (string const & path);
77 bool IsLyXFilename(string const & filename);
80 bool IsSGMLFilename(string const & filename);
82 /** Returns the path of a library data file.
83 Search the file name.ext in the subdirectory dir of
86 \item build_lyxdir (if not empty)
89 The third parameter `ext' is optional.
91 string const LibFileSearch(string const & dir, string const & name,
92 string const & ext = string());
94 /** Same as LibFileSearch(), but tries first to find an
95 internationalized version of the file by prepending $LANG_ to the
99 i18nLibFileSearch(string const & dir, string const & name,
100 string const & ext = string());
103 string const GetEnv(string const & envname);
105 /// A helper function.
106 string const GetEnvPath(string const & name);
109 bool PutEnv(string const & envstr);
112 bool PutEnvPath(string const & envstr);
114 /// Substitutes active latex characters with underscores in filename
115 string const MakeLatexName(string const & file);
117 /// Put the name in quotes suitable for the current shell
118 string const QuoteName(string const & file);
120 /// Is a filename/path absolute?
121 bool AbsolutePath(string const & path);
123 /// Add a filename to a path. Any path from filename is stripped first.
124 string const AddName(string const & path, string const & fname);
126 /// Append sub-directory(ies) to path in an intelligent way
127 string const AddPath(string const & path, string const & path2);
129 /** Change extension of oldname to extension.
130 If oldname does not have an extension, it is appended.
131 If the extension is empty, any extension is removed from the name.
134 ChangeExtension(string const & oldname, string const & extension);
136 /// Return the extension of the file (not including the .)
137 string const GetExtension(string const & name);
139 /// Create absolute path. If impossible, don't do anything
140 string const ExpandPath(string const & path);
142 /** Convert relative path into absolute path based on a basepath.
143 If relpath is absolute, just use that.
144 If basepath doesn't exist use CWD.
146 string const MakeAbsPath(string const & RelPath = string(),
147 string const & BasePath = string());
149 /** Creates a nice compact path for displaying. The parameter
150 threshold, if given, specifies the maximal length of the path.
153 MakeDisplayPath(string const & path,
154 unsigned int threshold = 1000);
156 /** Makes relative path out of absolute path.
157 If it is deeper than basepath,
158 it's easy. If basepath and abspath share something (they are all deeper
159 than some directory), it'll be rendered using ..'s. If they are completely
160 different, then the absolute path will be used as relative path
161 WARNING: the absolute path and base path must really be absolute paths!!!
164 MakeRelPath(string const & abspath, string const & basepath);
166 /// Strip filename from path name
167 string const OnlyPath(string const & fname);
169 /// Normalize a path. Constracts path/../path
170 string const NormalizePath(string const & path);
172 /// Strips path from filename
173 string const OnlyFilename(string const & fname);
175 /// Get the contents of a file as a huge string
176 string const GetFileContents(string const & fname);
178 /** Check and Replace Environmentvariables ${NAME} in Path.
179 Replaces all occurences of these, if they are found in the
181 Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
183 string const ReplaceEnvironmentPath(string const & path);
185 /* Set Link to the path file points to as a symbolic link.
186 Returns true if successful */
187 bool LyXReadLink(string const & file, string & Link);
189 /// Uses kpsewhich to find tex files
190 string const findtexfile(string const & fil, string const & format);
192 /// remove the autosave-file and give a Message if it can't be done
193 void removeAutosaveFile(string const & filename);