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/strfwd.h"
23 /// Defined in "FileNameList.h".
27 * Class for storing file names.
28 * The file name may be empty. If it is not empty it is an absolute path.
29 * The file may or may not exist.
33 /// Constructor for empty filenames
35 /** Constructor for nonempty filenames.
36 * explicit because we don't want implicit conversion of relative
37 * paths in function arguments (e.g. of unlink).
38 * \param abs_filename the file in question. Must have an absolute path.
39 * Encoding is always UTF-8.
41 explicit FileName(std::string const & abs_filename);
44 FileName(FileName const &);
46 /// constructor with base name and suffix.
47 FileName(FileName const & fn, std::string const & suffix);
50 FileName & operator=(FileName const &);
53 /** Set a new filename.
54 * \param filename the file in question. Must have an absolute path.
55 * Encoding is always UTF-8.
57 virtual void set(std::string const & filename);
58 virtual void set(FileName const & fn, std::string const & suffix);
60 /// Is this filename empty?
62 /// Is the filename absolute?
63 bool isAbsolute() const;
65 /// get the absolute file name in UTF-8 encoding
66 std::string absFilename() const;
68 * Get the file name in the encoding used by the file system.
69 * Only use this for accessing the file, e.g. with an fstream.
71 std::string toFilesystemEncoding() const;
73 /// returns true if the file exists
75 /// \return true if this object points to a symbolic link.
76 bool isSymLink() const;
77 /// \return true if the file is empty.
78 bool isFileEmpty() const;
79 /// returns time of last write access
80 std::time_t lastModified() const;
81 /// generates a checksum of a file
82 virtual unsigned long checksum() const;
83 /// return true when file is readable but not writabel
84 bool isReadOnly() const;
85 /// return true when it names a directory
86 bool isDirectory() const;
87 /// return true when directory is readable
88 bool isReadableDirectory() const;
89 /// return true when it is a file and readable
90 virtual bool isReadableFile() const;
91 /// return true when file/directory is writable
92 bool isWritable() const;
93 /// return true when file/directory is writable (write test file)
94 bool isDirWritable() const;
95 /// \return list other files in the directory having optional extension 'ext'.
96 FileNameList dirList(std::string const & ext) const;
99 /// \return true when file/directory is writable (write test file)
100 /// \warning This methods has different semantics when system level
101 /// copy command, it will overwrite the \c target file if it exists,
102 bool copyTo(FileName const & target) const;
104 /// remove pointed file.
105 /// \return true on success.
106 bool removeFile() const;
108 /// rename pointed file.
109 /// \return false if the operation fails or if the \param target file
111 /// \return true on success.
112 bool renameTo(FileName const & target) const;
114 /// move pointed file to \param target.
115 /// \return true on success.
116 bool moveTo(FileName const & target) const;
118 /// change mode of pointed file.
119 /// This methods does nothing and return true on platforms that does not
121 /// \return true on success.
122 bool changePermission(unsigned long int mode) const;
124 /// remove pointed directory and all contents.
125 /// \return true on success.
126 bool destroyDirectory() const;
127 /// Creates pointed directory.
128 /// \return true on success.
129 bool createDirectory(int permissions) const;
130 /// Creates pointed path.
131 /// \return true on success.
132 bool createPath() const;
134 /// Get the contents of a file as a huge docstring.
135 /// \param encoding defines the encoding of the file contents.
136 /// Only four encodings are supported:
137 /// "UTF-8", "ascii", "latin1" and "local8bit" which uses the
138 /// current system locale.
139 docstring fileContents(std::string const & encoding) const;
141 /// Change extension.
143 * If oldname does not have an extension, it is appended.
144 * If the extension is empty, any extension is removed from the name.
146 void changeExtension(std::string const & extension);
148 /** Guess the file format name (as in Format::name()) from contents.
149 Normally you don't want to use this directly, but rather
150 Formats::getFormatFromFile().
152 std::string guessFormatFromContents() const;
154 /// check for zipped file
155 bool isZippedFile() const;
157 static FileName fromFilesystemEncoding(std::string const & name);
158 /// (securely) create a temporary file with the given mask.
159 /// \p mask must be in filesystem encoding, if it contains a
160 /// relative path, the template file will be created in the global
161 /// temporary directory as given by 'package().temp_dir()'.
162 static FileName tempName(std::string const & mask = empty_string());
163 static FileName tempName(FileName const & temp_dir,
164 std::string const & mask);
166 /// get the current working directory
167 static FileName getcwd();
169 static FileName tempPath();
171 /// filename without path
172 std::string onlyFileName() const;
173 /// filename without path and without extension
174 std::string onlyFileNameWithoutExt() const;
175 /// only extension after the last dot.
176 std::string extension() const;
177 /// path without file name
178 FileName onlyPath() const;
179 /// used for display in the Gui
180 docstring displayName(int threshold = 1000) const;
182 /// change to a directory, return success
185 /// \param buffer_path if empty, uses `pwd`
186 docstring const relPath(std::string const & path) const;
188 docstring const absoluteFilePath() const;
191 friend bool operator==(FileName const &, FileName const &);
198 bool operator==(FileName const &, FileName const &);
199 bool operator!=(FileName const &, FileName const &);
200 bool operator<(FileName const &, FileName const &);
201 bool operator>(FileName const &, FileName const &);
202 std::ostream & operator<<(std::ostream &, FileName const &);
206 * Class for storing file names that appear in documents (e. g. child
207 * documents, included figures etc).
208 * The file name must not denote a file in our temporary directory, but a
209 * file that the user chose.
211 class DocFileName : public FileName {
214 /** \param abs_filename the file in question. Must have an absolute path.
215 * \param save_abs_path how is the file to be output to file?
217 DocFileName(std::string const & abs_filename, bool save_abs_path = true);
218 DocFileName(FileName const & abs_filename, bool save_abs_path = true);
220 /** \param filename the file in question. May have either a relative
221 * or an absolute path.
222 * \param buffer_path if \c filename has a relative path, generate
223 * the absolute path using this.
225 virtual void set(std::string const & filename, std::string const & buffer_path);
229 bool saveAbsPath() const { return save_abs_path_; }
230 /// \param buffer_path if empty, uses `pwd`
231 std::string relFilename(std::string const & buffer_path = empty_string()) const;
232 /// \param buf_path if empty, uses `pwd`
233 std::string outputFilename(std::string const & buf_path = empty_string()) const;
235 /** @returns a mangled representation of the absolute file name
236 * suitable for use in the temp dir when, for example, converting
237 * an image file to another format.
239 * @param dir the directory that will contain this file with
240 * its mangled name. This information is used by the mangling
241 * algorithm when determining the maximum allowable length of
244 * An example of a mangled name:
245 * C:/foo bar/baz.eps -> 0C__foo_bar_baz.eps
247 * It is guaranteed that
248 * - two different filenames have different mangled names
249 * - two FileName instances with the same filename have identical
252 * Only the mangled file name is returned. It is not prepended
256 mangledFilename(std::string const & dir = empty_string()) const;
258 /// \return true if the file is compressed.
259 bool isZipped() const;
260 /// \return the absolute file name without its .gz, .z, .Z extension
261 std::string unzippedFilename() const;
265 /// Cache for isZipped() because zippedFile() is expensive
266 mutable bool zipped_;
267 /// Is zipped_ valid?
268 mutable bool zipped_valid_;
272 bool operator==(DocFileName const &, DocFileName const &);
273 bool operator!=(DocFileName const &, DocFileName const &);
275 } // namespace support