/// Is this filename empty?
bool empty() const;
/// Is the filename absolute?
- bool isAbsolute() const;
+ static bool isAbsolute(std::string const & name);
/// get the absolute file name in UTF-8 encoding
std::string absFilename() 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.
docstring const absoluteFilePath() const;
private:
- friend bool operator==(FileName const &, FileName const &);
+ friend bool equivalent(FileName const &, FileName 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.
*/
virtual 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 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_;
};
+/// \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