#ifndef FILENAME_H
#define FILENAME_H
+#include "support/os.h"
#include "support/strfwd.h"
#include <ctime>
+#include <set>
namespace lyx {
/// copy constructor.
FileName(FileName const &);
+ /// constructor with base name and suffix.
+ FileName(FileName const & fn, std::string const & suffix);
+
///
FileName & operator=(FileName const &);
* \param filename the file in question. Must have an absolute path.
* Encoding is always UTF-8.
*/
- virtual void set(std::string const & filename);
+ void set(std::string const & filename);
+ void set(FileName const & fn, std::string const & suffix);
virtual void erase();
/// Is this filename empty?
bool empty() const;
+ /// Is the filename absolute?
+ static bool isAbsolute(std::string const & name);
+
/// get the absolute file name in UTF-8 encoding
- std::string absFilename() const;
+ std::string absFileName() const;
+
+ /** returns an absolute pathname (whose resolution does not involve
+ * '.', '..', or symbolic links) in UTF-8 encoding
+ */
+ std::string realPath() const;
+
/**
* Get the file name in the encoding used by the file system.
- * Only use this for accessing the file, e.g. with an fstream.
+ * Only use this for passing file names to external commands.
+ * Warning: On Windows this is not unicode safe and should not
+ * be used for accessing files with an fstream, for example.
*/
std::string toFilesystemEncoding() const;
+ /**
+ * Get the file name in a unicode safe encoding used by the file system.
+ * Only use this for accessing the file with standard I/O functions
+ * non explicitly unicode aware, e.g. with an fstream. This can also
+ * be used for passing file names to external commands, but only if
+ * you are sure that the stem of the name will not be used for
+ * producing derivative files. For example, don't use this for passing
+ * file names to LaTeX, as the stem of the .dvi file will not correspond
+ * to the stem of the .tex file anymore.
+ * Use os::CREATE if the file is to be accessed for writing.
+ */
+ std::string toSafeFilesystemEncoding(os::file_access how = os::EXISTING) const;
+
/// returns true if the file exists
bool exists() const;
+ /// refreshes the file info
+ void refresh() const;
/// \return true if this object points to a symbolic link.
bool isSymLink() const;
/// \return true if the file is empty.
/// returns time of last write access
std::time_t lastModified() const;
/// generates a checksum of a file
- unsigned long checksum() const;
- /// return true when file is readable but not writabel
+ virtual unsigned long checksum() const;
+ /// return true when file is readable but not writable
bool isReadOnly() const;
/// return true when it names a directory
bool isDirectory() const;
- /// return true when file/directory is readable
+ /// return true when directory is readable
bool isReadableDirectory() const;
/// return true when it is a file and readable
- bool isReadableFile() const;
+ virtual bool isReadableFile() const;
/// return true when file/directory is writable
bool isWritable() const;
/// return true when file/directory is writable (write test file)
/// \return true when file/directory is writable (write test file)
/// \warning This methods has different semantics when system level
/// copy command, it will overwrite the \c target file if it exists,
- bool copyTo(FileName const & target) const;
+ /// If \p keepsymlink is true, the copy will be written to the symlink
+ /// target. Otherwise, the symlink will be destroyed.
+ bool copyTo(FileName const & target, bool keepsymlink = false) const;
/// remove pointed file.
/// \return true on success.
bool renameTo(FileName const & target) const;
/// move pointed file to \param target.
+ /// If \p target exists it will be overwritten (if it is a symlink,
+ /// the symlink will be destroyed).
/// \return true on success.
bool moveTo(FileName const & target) const;
+ bool link(FileName const & name) const;
/// change mode of pointed file.
/// This methods does nothing and return true on platforms that does not
*/
void changeExtension(std::string const & extension);
- /** Guess the file format name (as in Format::name()) from contents.
- Normally you don't want to use this directly, but rather
- Formats::getFormatFromFile().
- */
- std::string guessFormatFromContents() const;
+ static FileName fromFilesystemEncoding(std::string const & name);
- /// check for zipped file
- bool isZippedFile() const;
+ /// get the current working directory
+ static FileName getcwd();
- static FileName fromFilesystemEncoding(std::string const & name);
- /// (securely) create a temporary file in the given dir with the given mask
- /// \p mask must be in filesystem encoding
- static FileName tempName(FileName const & dir = FileName(),
- std::string const & mask = empty_string());
+ static FileName tempPath();
/// filename without path
std::string onlyFileName() const;
+ /// filename without path and without extension
+ std::string onlyFileNameWithoutExt() const;
+ /// only extension after the last dot.
+ std::string extension() const;
+ /** checks if the file has the given extension
+ on Windows and Mac it compares case insensitive */
+ bool hasExtension(const std::string & ext);
/// path without file name
FileName onlyPath() const;
+ /// path of parent directory
+ /// returns empty path for root directory
+ FileName parentPath() const;
/// used for display in the Gui
docstring displayName(int threshold = 1000) const;
docstring const absoluteFilePath() const;
private:
+ friend bool equivalent(FileName const &, FileName const &);
+ /// Set for tracking of already visited file names.
+ /// Uses operator==() (which may be case insensitive), and not
+ /// equvalent(), so that symlinks are not resolved.
+ typedef std::set<FileName> FileNameSet;
+ /// Helper for public copyTo() to find circular symlink chains
+ bool copyTo(FileName const &, bool, FileNameSet &) const;
///
struct Private;
Private * const d;
};
+/// \return true if lhs and rhs represent the same file. E.g.,
+/// they might be hardlinks of one another.
+bool equivalent(FileName const & lhs, FileName const & rhs);
+/// \return true if the absolute path names are the same.
bool operator==(FileName const &, FileName const &);
+///
bool operator!=(FileName const &, FileName const &);
+/// Lexically compares the absolute path names.
bool operator<(FileName const &, FileName const &);
+/// Lexically compares the absolute path names.
bool operator>(FileName const &, FileName const &);
+/// Writes the absolute path name to the stream.
std::ostream & operator<<(std::ostream &, FileName const &);
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?
+ * \param save_abs_path how is the filename to be output?
*/
DocFileName(std::string const & abs_filename, bool save_abs_path = true);
DocFileName(FileName const & abs_filename, bool save_abs_path = true);
* the absolute path using this.
*/
void set(std::string const & filename, std::string const & buffer_path);
-
+ ///
void erase();
-
+ ///
bool saveAbsPath() const { return save_abs_path_; }
/// \param buffer_path if empty, uses `pwd`
- std::string relFilename(std::string const & buffer_path = empty_string()) const;
+ std::string relFileName(std::string const & buffer_path = empty_string()) const;
/// \param buf_path if empty, uses `pwd`
- std::string outputFilename(std::string const & buf_path = empty_string()) const;
+ std::string outputFileName(std::string const & buf_path = empty_string()) const;
/** @returns a mangled representation of the absolute file name
* suitable for use in the temp dir when, for example, converting
* with @c dir.
*/
std::string
- mangledFilename(std::string const & dir = empty_string()) const;
+ mangledFileName(std::string const & dir = empty_string()) const;
- /// \return true if the file is compressed.
- bool isZipped() const;
/// \return the absolute file name without its .gz, .z, .Z extension
- std::string unzippedFilename() const;
+ std::string unzippedFileName() const;
private:
+ /// Records whether we should save (or export) the filename as a relative
+ /// or absolute path.
bool save_abs_path_;
- /// Cache for isZipped() because zippedFile() is expensive
- mutable bool zipped_;
- /// Is zipped_ valid?
- mutable bool zipped_valid_;
};
+/// \return true if these have the same absolute path name AND
+/// if save_abs_path_ has the same value in both cases.
bool operator==(DocFileName const &, DocFileName const &);
+///
bool operator!=(DocFileName const &, DocFileName const &);
} // namespace support
projects / lyx.git / blobdiff