#ifndef FILENAME_H
#define FILENAME_H
-#include "support/std_string.h"
+#include <string>
namespace lyx {
namespace support {
+/**
+ * Class for storing file names.
+ * The file name may be empty. If it is not empty it is an absolute path.
+ * The file may or may not exist.
+ */
class FileName {
public:
+ /// Constructor for empty filenames
FileName();
- /** \param filename the file in question. Must have an absolute path.
+ /** Constructor for nonempty filenames.
+ * explicit because we don't want implicit conversion of relative
+ * paths in function arguments (e.g. of unlink).
+ * \param abs_filename the file in question. Must have an absolute path.
+ */
+ explicit FileName(std::string const & abs_filename);
+ virtual ~FileName();
+ virtual void set(std::string const & filename);
+ virtual void erase();
+ /// Is this filename empty?
+ bool empty() const { return name_.empty(); }
+ /// get the absolute file name
+ std::string const absFilename() const { return name_; }
+ /**
+ * Get the file name in the encoding used by the file system.
+ * Only use this for accessing the file, e.g. with an fstream.
+ */
+ std::string const toFilesystemEncoding() const;
+protected:
+ /// The absolute file name.
+ /// The encoding is currently unspecified, anything else than ASCII
+ /// may or may not work.
+ std::string name_;
+};
+
+
+bool operator==(FileName const &, FileName const &);
+bool operator!=(FileName const &, FileName const &);
+bool operator<(FileName const &, FileName const &);
+bool operator>(FileName const &, FileName const &);
+std::ostream & operator<<(std::ostream &, FileName const &);
+
+
+/**
+ * Class for storing file names that appear in documents (e. g. child
+ * documents, included figures etc).
+ * The file name must not denote a file in our temporary directory, but a
+ * file that the user chose.
+ */
+class DocFileName : public FileName {
+public:
+ DocFileName();
+ /** \param abs_filename the file in question. Must have an absolute path.
* \param save_abs_path how is the file to be output to file?
*/
- FileName(string const & abs_filename, bool save_abs_path = true);
+ DocFileName(std::string const & abs_filename, bool save_abs_path = true);
/** \param filename the file in question. May have either a relative
* or an absolute path.
* \param buffer_path if \c filename has a relative path, generate
* the absolute path using this.
*/
- void set(string const & filename, string const & buffer_path);
+ void set(std::string const & filename, std::string const & buffer_path);
void erase();
- bool empty() const { return name_.empty(); }
bool saveAbsPath() const { return save_abs_path_; }
- string const absFilename() const { return name_; }
/// \param buffer_path if empty, uses `pwd`
- string const relFilename(string const & buffer_path = string()) const;
+ std::string const relFilename(std::string const & buffer_path = std::string()) const;
/// \param buf_path if empty, uses `pwd`
- string const outputFilename(string const & buf_path = string()) const;
- /** \return a mangled version of the absolute file name,
+ std::string const outputFilename(std::string const & buf_path = std::string()) const;
+
+ /** @returns a mangled representation of the absolute file name
* suitable for use in the temp dir when, for example, converting
* an image file to another format.
+ *
+ * @param dir the directory that will contain this file with
+ * its mangled name. This information is used by the mangling
+ * algorithm when determining the maximum allowable length of
+ * the mangled name.
+ *
+ * An example of a mangled name:
+ * C:/foo bar/baz.eps -> 0C__foo_bar_baz.eps
+ *
+ * It is guaranteed that
+ * - two different filenames have different mangled names
+ * - two FileName instances with the same filename have identical
+ * mangled names.
+ *
+ * Only the mangled file name is returned. It is not prepended
+ * with @c dir.
*/
- string const mangledFilename() const;
+ std::string const
+ mangledFilename(std::string const & dir = std::string()) const;
/// \return true if the file is compressed.
bool isZipped() const;
/// \return the absolute file name without its .gz, .z, .Z extension
- string const unzippedFilename() const;
+ std::string const unzippedFilename() const;
private:
- string name_;
bool save_abs_path_;
+ /// Cache for isZipped() because zippedFile() is expensive
+ mutable bool zipped_;
+ /// Is zipped_ valid?
+ mutable bool zipped_valid_;
};
-bool operator==(FileName const &, FileName const &);
-bool operator!=(FileName const &, FileName const &);
+bool operator==(DocFileName const &, DocFileName const &);
+bool operator!=(DocFileName const &, DocFileName const &);
} // namespace support