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 false if the operation fails or if the \param target file
104 /// \return true on success.
105 bool renameTo(FileName const & target) const;
107 /// move pointed file to \param target.
108 /// \return true on success.
109 bool moveTo(FileName const & target) const;
111 /// change mode of pointed file.
112 /// This methods does nothing and return true on platforms that does not
114 /// \return true on success.
115 bool changePermission(unsigned long int mode) const;
117 /// remove pointed directory and all contents.
118 /// \return true on success.
119 bool destroyDirectory() const;
120 /// Creates pointed directory.
121 /// \return true on success.
122 bool createDirectory(int permissions) const;
124 /// Get the contents of a file as a huge docstring.
125 /// \param encoding defines the encoding of the file contents.
126 /// Only four encodings are supported:
127 /// "UTF-8", "ascii", "latin1" and "local8bit" which uses the
128 /// current system locale.
129 docstring fileContents(std::string const & encoding) const;
131 /// Change extension.
133 * If oldname does not have an extension, it is appended.
134 * If the extension is empty, any extension is removed from the name.
136 void changeExtension(std::string const & extension);
138 /** Guess the file format name (as in Format::name()) from contents.
139 Normally you don't want to use this directly, but rather
140 Formats::getFormatFromFile().
142 std::string guessFormatFromContents() const;
144 /// check for zipped file
145 bool isZippedFile() const;
147 static FileName fromFilesystemEncoding(std::string const & name);
148 /// (securely) create a temporary file in the given dir with the given mask
149 /// \p mask must be in filesystem encoding
150 static FileName tempName(FileName const & dir = FileName(),
151 std::string const & mask = empty_string());
153 /// filename without path
154 std::string onlyFileName() const;
155 /// path without file name
156 FileName onlyPath() const;
157 /// used for display in the Gui
158 docstring displayName(int threshold = 1000) const;
160 /// change to a directory, return success
163 /// \param buffer_path if empty, uses `pwd`
164 docstring const relPath(std::string const & path) const;
166 docstring const absoluteFilePath() const;
175 bool operator==(FileName const &, FileName const &);
176 bool operator!=(FileName const &, FileName const &);
177 bool operator<(FileName const &, FileName const &);
178 bool operator>(FileName const &, FileName const &);
179 std::ostream & operator<<(std::ostream &, FileName const &);
183 * Class for storing file names that appear in documents (e. g. child
184 * documents, included figures etc).
185 * The file name must not denote a file in our temporary directory, but a
186 * file that the user chose.
188 class DocFileName : public FileName {
191 /** \param abs_filename the file in question. Must have an absolute path.
192 * \param save_abs_path how is the file to be output to file?
194 DocFileName(std::string const & abs_filename, bool save_abs_path = true);
195 DocFileName(FileName const & abs_filename, bool save_abs_path = true);
197 /** \param filename the file in question. May have either a relative
198 * or an absolute path.
199 * \param buffer_path if \c filename has a relative path, generate
200 * the absolute path using this.
202 void set(std::string const & filename, std::string const & buffer_path);
206 bool saveAbsPath() const { return save_abs_path_; }
207 /// \param buffer_path if empty, uses `pwd`
208 std::string relFilename(std::string const & buffer_path = empty_string()) const;
209 /// \param buf_path if empty, uses `pwd`
210 std::string outputFilename(std::string const & buf_path = empty_string()) const;
212 /** @returns a mangled representation of the absolute file name
213 * suitable for use in the temp dir when, for example, converting
214 * an image file to another format.
216 * @param dir the directory that will contain this file with
217 * its mangled name. This information is used by the mangling
218 * algorithm when determining the maximum allowable length of
221 * An example of a mangled name:
222 * C:/foo bar/baz.eps -> 0C__foo_bar_baz.eps
224 * It is guaranteed that
225 * - two different filenames have different mangled names
226 * - two FileName instances with the same filename have identical
229 * Only the mangled file name is returned. It is not prepended
233 mangledFilename(std::string const & dir = empty_string()) const;
235 /// \return true if the file is compressed.
236 bool isZipped() const;
237 /// \return the absolute file name without its .gz, .z, .Z extension
238 std::string unzippedFilename() const;
242 /// Cache for isZipped() because zippedFile() is expensive
243 mutable bool zipped_;
244 /// Is zipped_ valid?
245 mutable bool zipped_valid_;
249 bool operator==(DocFileName const &, DocFileName const &);
250 bool operator!=(DocFileName const &, DocFileName const &);
252 } // namespace support