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"
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 &);
49 virtual ~FileName() {}
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 /// return true when file is readable but not writabel
75 bool isReadOnly() const;
76 /// return true when it names a directory
77 bool isDirectory() const;
78 /// return true when file/directory is readable
79 bool isReadableDirectory() const;
80 /// return true when it is a file and readable
81 bool isReadableFile() const;
82 /// return true when file/directory is writable
83 bool isWritable() const;
84 /// return true when file/directory is writable (write test file)
85 bool isDirWritable() const;
88 /// \return true when file/directory is writable (write test file)
89 /// \param overwrite: set to true if we should erase the \c target
90 /// file if it exists,
91 bool copyTo(FileName const & target, bool overwrite = false) const;
93 /// remove pointed file.
94 /// \retrun true on success.
95 bool removeFile() const;
97 /// remove directory and all contents, returns true on success
98 bool destroyDirectory() const;
99 /// Creates directory. Returns true on success
100 bool createDirectory(int permissions) const;
102 /// \return list files in a directory having optional extension ext..
103 std::vector<FileName> dirList(
104 std::string const & ext = std::string());
106 /// Get the contents of a file as a huge std::string
107 std::string fileContents() const;
109 * Get a FileName from \p name in the encoding used by the file system.
110 * Only use this for filenames you got directly from the file system,
111 * e.g. from reading a directory.
112 * \p name must have an absolute path.
115 /// Change extension.
117 * If oldname does not have an extension, it is appended.
118 * If the extension is empty, any extension is removed from the name.
120 void changeExtension(std::string const & extension);
122 /** Guess the file format name (as in Format::name()) from contents.
123 Normally you don't want to use this directly, but rather
124 Formats::getFormatFromFile().
126 std::string guessFormatFromContents() const;
128 /// check for zipped file
129 bool isZippedFile() const;
131 static FileName fromFilesystemEncoding(std::string const & name);
132 /// (securely) create a temporary file in the given dir with the given mask
133 /// \p mask must be in filesystem encoding
134 static FileName tempName(FileName const & dir = FileName(),
135 std::string const & mask = std::string());
137 /// filename without path
138 std::string onlyFileName() const;
139 /// path without file name
140 FileName onlyPath() const;
141 /// used for display in the Gui
142 docstring displayName(int threshold = 1000) const;
145 friend class DocFileName;
152 bool operator==(FileName const &, FileName const &);
153 bool operator!=(FileName const &, FileName const &);
154 bool operator<(FileName const &, FileName const &);
155 bool operator>(FileName const &, FileName const &);
156 std::ostream & operator<<(std::ostream &, FileName const &);
160 * Class for storing file names that appear in documents (e. g. child
161 * documents, included figures etc).
162 * The file name must not denote a file in our temporary directory, but a
163 * file that the user chose.
165 class DocFileName : public FileName {
168 /** \param abs_filename the file in question. Must have an absolute path.
169 * \param save_abs_path how is the file to be output to file?
171 DocFileName(std::string const & abs_filename, bool save_abs_path = true);
172 DocFileName(FileName const & abs_filename, bool save_abs_path = true);
174 /** \param filename the file in question. May have either a relative
175 * or an absolute path.
176 * \param buffer_path if \c filename has a relative path, generate
177 * the absolute path using this.
179 void set(std::string const & filename, std::string const & buffer_path);
183 bool saveAbsPath() const { return save_abs_path_; }
184 /// \param buffer_path if empty, uses `pwd`
185 std::string const relFilename(std::string const & buffer_path = std::string()) const;
186 /// \param buf_path if empty, uses `pwd`
187 std::string const outputFilename(std::string const & buf_path = std::string()) const;
189 /** @returns a mangled representation of the absolute file name
190 * suitable for use in the temp dir when, for example, converting
191 * an image file to another format.
193 * @param dir the directory that will contain this file with
194 * its mangled name. This information is used by the mangling
195 * algorithm when determining the maximum allowable length of
198 * An example of a mangled name:
199 * C:/foo bar/baz.eps -> 0C__foo_bar_baz.eps
201 * It is guaranteed that
202 * - two different filenames have different mangled names
203 * - two FileName instances with the same filename have identical
206 * Only the mangled file name is returned. It is not prepended
210 mangledFilename(std::string const & dir = std::string()) const;
212 /// \return true if the file is compressed.
213 bool isZipped() const;
214 /// \return the absolute file name without its .gz, .z, .Z extension
215 std::string const unzippedFilename() const;
219 /// Cache for isZipped() because zippedFile() is expensive
220 mutable bool zipped_;
221 /// Is zipped_ valid?
222 mutable bool zipped_valid_;
226 bool operator==(DocFileName const &, DocFileName const &);
227 bool operator!=(DocFileName const &, DocFileName const &);
230 } // namespace support