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.
24 * Class for storing file names.
25 * The file name may be empty. If it is not empty it is an absolute path.
26 * The file may or may not exist.
30 /// Constructor for empty filenames
32 /** Constructor for nonempty filenames.
33 * explicit because we don't want implicit conversion of relative
34 * paths in function arguments (e.g. of unlink).
35 * \param abs_filename the file in question. Must have an absolute path.
36 * Encoding is always UTF-8.
38 explicit FileName(std::string const & abs_filename);
39 virtual ~FileName() {}
40 /** Set a new filename.
41 * \param filename the file in question. Must have an absolute path.
42 * Encoding is always UTF-8.
44 virtual void set(std::string const & filename);
46 /// Is this filename empty?
47 bool empty() const { return name_.empty(); }
48 /// get the absolute file name in UTF-8 encoding
49 std::string const absFilename() const { return name_; }
51 * Get the file name in the encoding used by the file system.
52 * Only use this for accessing the file, e.g. with an fstream.
54 std::string const toFilesystemEncoding() const;
56 /// returns true if the file exists
58 /// returns time of last write access
59 std::time_t lastModified() const;
60 /// return true when file is readable but not writabel
61 bool isReadOnly() const;
64 * Get a FileName from \p name in the encoding used by the file system.
65 * Only use this for filenames you got directly from the file system,
66 * e.g. from reading a directory.
67 * \p name must have an absolute path.
69 static FileName const fromFilesystemEncoding(std::string const & name);
71 /// The absolute file name.
72 /// The encoding is currently unspecified, anything else than ASCII
73 /// may or may not work.
78 bool operator==(FileName const &, FileName const &);
79 bool operator!=(FileName const &, FileName const &);
80 bool operator<(FileName const &, FileName const &);
81 bool operator>(FileName const &, FileName const &);
82 std::ostream & operator<<(std::ostream &, FileName const &);
86 * Class for storing file names that appear in documents (e. g. child
87 * documents, included figures etc).
88 * The file name must not denote a file in our temporary directory, but a
89 * file that the user chose.
91 class DocFileName : public FileName {
94 /** \param abs_filename the file in question. Must have an absolute path.
95 * \param save_abs_path how is the file to be output to file?
97 DocFileName(std::string const & abs_filename, bool save_abs_path = true);
98 DocFileName(FileName const & abs_filename, bool save_abs_path = true);
100 /** \param filename the file in question. May have either a relative
101 * or an absolute path.
102 * \param buffer_path if \c filename has a relative path, generate
103 * the absolute path using this.
105 void set(std::string const & filename, std::string const & buffer_path);
109 bool saveAbsPath() const { return save_abs_path_; }
110 /// \param buffer_path if empty, uses `pwd`
111 std::string const relFilename(std::string const & buffer_path = std::string()) const;
112 /// \param buf_path if empty, uses `pwd`
113 std::string const outputFilename(std::string const & buf_path = std::string()) const;
115 /** @returns a mangled representation of the absolute file name
116 * suitable for use in the temp dir when, for example, converting
117 * an image file to another format.
119 * @param dir the directory that will contain this file with
120 * its mangled name. This information is used by the mangling
121 * algorithm when determining the maximum allowable length of
124 * An example of a mangled name:
125 * C:/foo bar/baz.eps -> 0C__foo_bar_baz.eps
127 * It is guaranteed that
128 * - two different filenames have different mangled names
129 * - two FileName instances with the same filename have identical
132 * Only the mangled file name is returned. It is not prepended
136 mangledFilename(std::string const & dir = std::string()) const;
138 /// \return true if the file is compressed.
139 bool isZipped() const;
140 /// \return the absolute file name without its .gz, .z, .Z extension
141 std::string const unzippedFilename() const;
145 /// Cache for isZipped() because zippedFile() is expensive
146 mutable bool zipped_;
147 /// Is zipped_ valid?
148 mutable bool zipped_valid_;
152 bool operator==(DocFileName const &, DocFileName const &);
153 bool operator!=(DocFileName const &, DocFileName const &);
156 } // namespace support