4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
9 * Full author contact details are available in file CREDITS.
15 #include "support/os.h"
16 #include "support/strfwd.h"
24 /// Defined in "FileNameList.h".
28 * Class for storing file names.
29 * The file name may be empty. If it is not empty it is an absolute path.
30 * The file may or may not exist.
34 /// Constructor for empty filenames
36 /** Constructor for nonempty filenames.
37 * explicit because we don't want implicit conversion of relative
38 * paths in function arguments (e.g. of unlink).
39 * \param abs_filename the file in question. Must have an absolute path.
40 * Encoding is always UTF-8.
42 explicit FileName(std::string const & abs_filename);
45 FileName(FileName const &);
47 /// constructor with base name and suffix.
48 FileName(FileName const & fn, std::string const & suffix);
51 FileName & operator=(FileName const &);
54 /** Set a new filename.
55 * \param filename the file in question. Must have an absolute path.
56 * Encoding is always UTF-8.
58 virtual void set(std::string const & filename);
59 virtual void set(FileName const & fn, std::string const & suffix);
61 /// Is this filename empty?
63 /// Is the filename absolute?
64 static bool isAbsolute(std::string const & name);
66 /// get the absolute file name in UTF-8 encoding
67 std::string absFilename() const;
69 /** returns an absolute pathname (whose resolution does not involve
70 * '.', '..', or symbolic links) in UTF-8 encoding
72 std::string realPath() const;
75 * Get the file name in the encoding used by the file system.
76 * Only use this for passing file names to external commands.
77 * Warning: On Windows this is not unicode safe and should not
78 * be used for accessing files with an fstream, for example.
80 std::string toFilesystemEncoding() const;
83 * Get the file name in a unicode safe encoding used by the file system.
84 * Only use this for accessing the file with standard I/O functions
85 * non explicitly unicode aware, e.g. with an fstream. This can also
86 * be used for passing file names to external commands, but only if
87 * you are sure that the stem of the name will not be used for
88 * producing derivative files. For example, don't use this for passing
89 * file names to LaTeX, as the stem of the .dvi file will not correspond
90 * to the stem of the .tex file anymore.
91 * Use os::CREATE if the file is to be accessed for writing.
93 std::string toSafeFilesystemEncoding(os::file_access how = os::EXISTING) const;
95 /// returns true if the file exists
97 /// refreshes the file info
99 /// \return true if this object points to a symbolic link.
100 bool isSymLink() const;
101 /// \return true if the file is empty.
102 bool isFileEmpty() const;
103 /// returns time of last write access
104 std::time_t lastModified() const;
105 /// generates a checksum of a file
106 virtual unsigned long checksum() const;
107 /// return true when file is readable but not writable
108 bool isReadOnly() const;
109 /// return true when it names a directory
110 bool isDirectory() const;
111 /// return true when directory is readable
112 bool isReadableDirectory() const;
113 /// return true when it is a file and readable
114 virtual bool isReadableFile() const;
115 /// return true when file/directory is writable
116 bool isWritable() const;
117 /// return true when file/directory is writable (write test file)
118 bool isDirWritable() const;
119 /// \return list other files in the directory having optional extension 'ext'.
120 FileNameList dirList(std::string const & ext) const;
123 /// \return true when file/directory is writable (write test file)
124 /// \warning This methods has different semantics when system level
125 /// copy command, it will overwrite the \c target file if it exists,
126 bool copyTo(FileName const & target) const;
128 /// remove pointed file.
129 /// \return true on success.
130 bool removeFile() const;
132 /// rename pointed file.
133 /// \return false if the operation fails or if the \param target file
135 /// \return true on success.
136 bool renameTo(FileName const & target) const;
138 /// move pointed file to \param target.
139 /// \return true on success.
140 bool moveTo(FileName const & target) const;
142 /// change mode of pointed file.
143 /// This methods does nothing and return true on platforms that does not
145 /// \return true on success.
146 bool changePermission(unsigned long int mode) const;
148 /// remove pointed directory and all contents.
149 /// \return true on success.
150 bool destroyDirectory() const;
151 /// Creates pointed directory.
152 /// \return true on success.
153 bool createDirectory(int permissions) const;
154 /// Creates pointed path.
155 /// \return true on success.
156 bool createPath() const;
158 /// Get the contents of a file as a huge docstring.
159 /// \param encoding defines the encoding of the file contents.
160 /// Only four encodings are supported:
161 /// "UTF-8", "ascii", "latin1" and "local8bit" which uses the
162 /// current system locale.
163 docstring fileContents(std::string const & encoding) const;
165 /// Change extension.
167 * If oldname does not have an extension, it is appended.
168 * If the extension is empty, any extension is removed from the name.
170 void changeExtension(std::string const & extension);
172 /** Guess the file format name (as in Format::name()) from contents.
173 Normally you don't want to use this directly, but rather
174 Formats::getFormatFromFile().
176 std::string guessFormatFromContents() const;
178 /// check for zipped file
179 bool isZippedFile() const;
181 static FileName fromFilesystemEncoding(std::string const & name);
182 /// (securely) create a temporary file with the given mask.
183 /// \p mask must be in filesystem encoding, if it contains a
184 /// relative path, the template file will be created in the global
185 /// temporary directory as given by 'package().temp_dir()'.
186 static FileName tempName(std::string const & mask = empty_string());
187 static FileName tempName(FileName const & temp_dir,
188 std::string const & mask);
190 /// get the current working directory
191 static FileName getcwd();
193 static FileName tempPath();
195 /// filename without path
196 std::string onlyFileName() const;
197 /// filename without path and without extension
198 std::string onlyFileNameWithoutExt() const;
199 /// only extension after the last dot.
200 std::string extension() const;
201 /** checks if the file has the given extension
202 on Windows and Mac it compares case insensitive */
203 bool hasExtension(const std::string & ext);
204 /// path without file name
205 FileName onlyPath() const;
206 /// used for display in the Gui
207 docstring displayName(int threshold = 1000) const;
209 /// change to a directory, return success
212 /// \param buffer_path if empty, uses `pwd`
213 docstring const relPath(std::string const & path) const;
215 docstring const absoluteFilePath() const;
218 friend bool equivalent(FileName const &, FileName const &);
225 /// \return true if lhs and rhs represent the same file. E.g.,
226 /// they might be hardlinks of one another.
227 bool equivalent(FileName const & lhs, FileName const & rhs);
228 /// \return true if the absolute path names are the same.
229 bool operator==(FileName const &, FileName const &);
231 bool operator!=(FileName const &, FileName const &);
232 /// Lexically compares the absolute path names.
233 bool operator<(FileName const &, FileName const &);
234 /// Lexically compares the absolute path names.
235 bool operator>(FileName const &, FileName const &);
236 /// Writes the absolute path name to the stream.
237 std::ostream & operator<<(std::ostream &, FileName const &);
241 * Class for storing file names that appear in documents (e. g. child
242 * documents, included figures etc).
243 * The file name must not denote a file in our temporary directory, but a
244 * file that the user chose.
246 class DocFileName : public FileName {
249 /** \param abs_filename the file in question. Must have an absolute path.
250 * \param save_abs_path how is the filename to be output?
252 DocFileName(std::string const & abs_filename, bool save_abs_path = true);
253 DocFileName(FileName const & abs_filename, bool save_abs_path = true);
255 /** \param filename the file in question. May have either a relative
256 * or an absolute path.
257 * \param buffer_path if \c filename has a relative path, generate
258 * the absolute path using this.
260 virtual void set(std::string const & filename, std::string const & buffer_path);
264 bool saveAbsPath() const { return save_abs_path_; }
265 /// \param buffer_path if empty, uses `pwd`
266 std::string relFilename(std::string const & buffer_path = empty_string()) const;
267 /// \param buf_path if empty, uses `pwd`
268 std::string outputFilename(std::string const & buf_path = empty_string()) const;
270 /** @returns a mangled representation of the absolute file name
271 * suitable for use in the temp dir when, for example, converting
272 * an image file to another format.
274 * @param dir the directory that will contain this file with
275 * its mangled name. This information is used by the mangling
276 * algorithm when determining the maximum allowable length of
279 * An example of a mangled name:
280 * C:/foo bar/baz.eps -> 0C__foo_bar_baz.eps
282 * It is guaranteed that
283 * - two different filenames have different mangled names
284 * - two FileName instances with the same filename have identical
287 * Only the mangled file name is returned. It is not prepended
291 mangledFilename(std::string const & dir = empty_string()) const;
293 /// \return true if the file is compressed.
294 bool isZipped() const;
295 /// \return the absolute file name without its .gz, .z, .Z extension
296 std::string unzippedFilename() const;
299 /// Records whether we should save (or export) the filename as a relative
300 /// or absolute path.
302 /// Cache for isZipped() because zippedFile() is expensive
303 mutable bool zipped_;
304 /// Is zipped_ valid?
305 mutable bool zipped_valid_;
309 /// \return true if these have the same absolute path name AND
310 /// if save_abs_path_ has the same value in both cases.
311 bool operator==(DocFileName const &, DocFileName const &);
313 bool operator!=(DocFileName const &, DocFileName const &);
315 } // namespace support