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 &);
47 FileName & operator=(FileName const &);
50 /** Set a new filename.
51 * \param filename the file in question. Must have an absolute path.
52 * Encoding is always UTF-8.
54 virtual void set(std::string const & filename);
56 /// Is this filename empty?
58 /// get the absolute file name in UTF-8 encoding
59 std::string absFilename() const;
61 * Get the file name in the encoding used by the file system.
62 * Only use this for accessing the file, e.g. with an fstream.
64 std::string toFilesystemEncoding() const;
66 /// returns true if the file exists
68 /// \return true if this object points to a symbolic link.
69 bool isSymLink() const;
70 /// \return true if the file is empty.
71 bool isFileEmpty() const;
72 /// returns time of last write access
73 std::time_t lastModified() const;
74 /// generates a checksum of a file
75 unsigned long checksum() const;
76 /// return true when file is readable but not writabel
77 bool isReadOnly() const;
78 /// return true when it names a directory
79 bool isDirectory() const;
80 /// return true when file/directory is readable
81 bool isReadableDirectory() const;
82 /// return true when it is a file and readable
83 bool isReadableFile() const;
84 /// return true when file/directory is writable
85 bool isWritable() const;
86 /// return true when file/directory is writable (write test file)
87 bool isDirWritable() const;
88 /// \return list other files in the directory having optional extension 'ext'.
89 FileNameList dirList(std::string const & ext) const;
92 /// \return true when file/directory is writable (write test file)
93 /// \param overwrite: set to true if we should erase the \c target
94 /// file if it exists,
95 bool copyTo(FileName const & target, bool overwrite = false) const;
97 /// remove pointed file.
98 /// \return true on success.
99 bool removeFile() const;
101 /// rename pointed file.
102 /// \return true on success.
103 bool renameTo(FileName const & target) const;
105 /// change mode of pointed file.
106 /// This methods does nothing and return true on platforms that does not
108 /// \return true on success.
109 bool changePermission(unsigned long int mode) const;
111 /// remove pointed directory and all contents.
112 /// \return true on success.
113 bool destroyDirectory() const;
114 /// Creates pointed directory.
115 /// \return true on success.
116 bool createDirectory(int permissions) const;
118 /// Get the contents of a file as a huge docstring.
119 /// \param encoding defines the encoding of the file contents.
120 /// Only four encodings are supported:
121 /// "UTF-8", "ascii", "latin1" and "local8bit" which uses the
122 /// current system locale.
123 docstring fileContents(std::string const & encoding) const;
125 /// Change extension.
127 * If oldname does not have an extension, it is appended.
128 * If the extension is empty, any extension is removed from the name.
130 void changeExtension(std::string const & extension);
132 /** Guess the file format name (as in Format::name()) from contents.
133 Normally you don't want to use this directly, but rather
134 Formats::getFormatFromFile().
136 std::string guessFormatFromContents() const;
138 /// check for zipped file
139 bool isZippedFile() const;
141 static FileName fromFilesystemEncoding(std::string const & name);
142 /// (securely) create a temporary file in the given dir with the given mask
143 /// \p mask must be in filesystem encoding
144 static FileName tempName(FileName const & dir = FileName(),
145 std::string const & mask = empty_string());
147 /// filename without path
148 std::string onlyFileName() const;
149 /// path without file name
150 FileName onlyPath() const;
151 /// used for display in the Gui
152 docstring displayName(int threshold = 1000) const;
154 /// change to a directory, return success
157 /// \param buffer_path if empty, uses `pwd`
158 docstring const relPath(std::string const & path) const;
160 docstring const absoluteFilePath() const;
169 bool operator==(FileName const &, FileName const &);
170 bool operator!=(FileName const &, FileName const &);
171 bool operator<(FileName const &, FileName const &);
172 bool operator>(FileName const &, FileName const &);
173 std::ostream & operator<<(std::ostream &, FileName const &);
177 * Class for storing file names that appear in documents (e. g. child
178 * documents, included figures etc).
179 * The file name must not denote a file in our temporary directory, but a
180 * file that the user chose.
182 class DocFileName : public FileName {
185 /** \param abs_filename the file in question. Must have an absolute path.
186 * \param save_abs_path how is the file to be output to file?
188 DocFileName(std::string const & abs_filename, bool save_abs_path = true);
189 DocFileName(FileName const & abs_filename, bool save_abs_path = true);
191 /** \param filename the file in question. May have either a relative
192 * or an absolute path.
193 * \param buffer_path if \c filename has a relative path, generate
194 * the absolute path using this.
196 void set(std::string const & filename, std::string const & buffer_path);
200 bool saveAbsPath() const { return save_abs_path_; }
201 /// \param buffer_path if empty, uses `pwd`
202 std::string relFilename(std::string const & buffer_path = empty_string()) const;
203 /// \param buf_path if empty, uses `pwd`
204 std::string outputFilename(std::string const & buf_path = empty_string()) const;
206 /** @returns a mangled representation of the absolute file name
207 * suitable for use in the temp dir when, for example, converting
208 * an image file to another format.
210 * @param dir the directory that will contain this file with
211 * its mangled name. This information is used by the mangling
212 * algorithm when determining the maximum allowable length of
215 * An example of a mangled name:
216 * C:/foo bar/baz.eps -> 0C__foo_bar_baz.eps
218 * It is guaranteed that
219 * - two different filenames have different mangled names
220 * - two FileName instances with the same filename have identical
223 * Only the mangled file name is returned. It is not prepended
227 mangledFilename(std::string const & dir = empty_string()) const;
229 /// \return true if the file is compressed.
230 bool isZipped() const;
231 /// \return the absolute file name without its .gz, .z, .Z extension
232 std::string unzippedFilename() const;
236 /// Cache for isZipped() because zippedFile() is expensive
237 mutable bool zipped_;
238 /// Is zipped_ valid?
239 mutable bool zipped_valid_;
243 bool operator==(DocFileName const &, DocFileName const &);
244 bool operator!=(DocFileName const &, DocFileName const &);
246 } // namespace support