#ifndef FILENAME_H
#define FILENAME_H
-#include "strfwd.h"
+#include "support/strfwd.h"
#include <ctime>
-#include <string>
-#include <vector>
namespace lyx {
namespace support {
+/// Defined in "FileNameList.h".
+class FileNameList;
/**
* Class for storing file names.
/// copy constructor.
FileName(FileName const &);
+ /// constructor with base name and suffix.
+ FileName(FileName const & fn, std::string const & suffix);
+
///
FileName & operator=(FileName const &);
- virtual ~FileName() {}
+ virtual ~FileName();
/** Set a new filename.
* \param filename the file in question. Must have an absolute path.
* Encoding is always UTF-8.
*/
virtual void set(std::string const & filename);
+ virtual void set(FileName const & fn, std::string const & suffix);
virtual void erase();
/// Is this filename empty?
bool empty() const;
+ /// Is the filename absolute?
+ bool isAbsolute() const;
+
/// get the absolute file name in UTF-8 encoding
std::string absFilename() const;
/**
bool isFileEmpty() const;
/// returns time of last write access
std::time_t lastModified() const;
+ /// generates a checksum of a file
+ virtual unsigned long checksum() const;
/// return true when file is readable but not writabel
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)
bool isDirWritable() const;
+ /// \return list other files in the directory having optional extension 'ext'.
+ FileNameList dirList(std::string const & ext) const;
/// copy a file
/// \return true when file/directory is writable (write test file)
- /// \param overwrite: set to true if we should erase the \c target
- /// file if it exists,
- bool copyTo(FileName const & target, bool overwrite = false) const;
+ /// \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;
/// remove pointed file.
- /// \retrun true on success.
+ /// \return true on success.
bool removeFile() const;
- /// remove directory and all contents, returns true on success
- bool destroyDirectory() const;
- /// Creates directory. Returns true on success
- bool createDirectory(int permissions) const;
+ /// rename pointed file.
+ /// \return false if the operation fails or if the \param target file
+ /// already exists.
+ /// \return true on success.
+ bool renameTo(FileName const & target) const;
- /// \return list files in a directory having optional extension ext..
- std::vector<FileName> dirList(
- std::string const & ext = std::string());
+ /// move pointed file to \param target.
+ /// \return true on success.
+ bool moveTo(FileName const & target) const;
- /// Get the contents of a file as a huge std::string
- std::string fileContents() const;
+ /// change mode of pointed file.
+ /// This methods does nothing and return true on platforms that does not
+ /// support this.
+ /// \return true on success.
+ bool changePermission(unsigned long int mode) const;
+
+ /// remove pointed directory and all contents.
+ /// \return true on success.
+ bool destroyDirectory() const;
+ /// Creates pointed directory.
+ /// \return true on success.
+ bool createDirectory(int permissions) const;
+ /// Creates pointed path.
+ /// \return true on success.
+ bool createPath() const;
+
+ /// Get the contents of a file as a huge docstring.
+ /// \param encoding defines the encoding of the file contents.
+ /// Only four encodings are supported:
+ /// "UTF-8", "ascii", "latin1" and "local8bit" which uses the
+ /// current system locale.
+ docstring fileContents(std::string const & encoding) const;
+
+ /// Change extension.
/**
- * Get a FileName from \p name in the encoding used by the file system.
- * Only use this for filenames you got directly from the file system,
- * e.g. from reading a directory.
- * \p name must have an absolute path.
- */
+ * If oldname does not have an extension, it is appended.
+ * If the extension is empty, any extension is removed from the name.
+ */
+ 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
bool isZippedFile() const;
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 = std::string());
+ /// (securely) create a temporary file with the given mask.
+ /// \p mask must be in filesystem encoding, if it contains a
+ /// relative path, the template file will be created in the global
+ /// temporary directory as given by 'package().temp_dir()'.
+ static FileName tempName(std::string const & mask = empty_string());
+ static FileName tempName(FileName const & temp_dir,
+ std::string const & mask);
+
+ /// get the current working directory
+ static FileName getcwd();
+
+ static FileName tempPath();
/// filename without path
std::string onlyFileName() const;
+ /// filename without path and without extension
+ std::string onlyFileNameWithoutExt() const;
/// path without file name
FileName onlyPath() const;
/// used for display in the Gui
docstring displayName(int threshold = 1000) const;
+ /// change to a directory, return success
+ bool chdir() const;
+
+ /// \param buffer_path if empty, uses `pwd`
+ docstring const relPath(std::string const & path) const;
+
+ docstring const absoluteFilePath() const;
+
private:
- friend class DocFileName;
///
struct Private;
Private * const d;
* \param buffer_path if \c filename has a relative path, generate
* the absolute path using this.
*/
- void set(std::string const & filename, std::string const & buffer_path);
+ 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 const relFilename(std::string const & buffer_path = std::string()) const;
+ std::string relFilename(std::string const & buffer_path = empty_string()) const;
/// \param buf_path if empty, uses `pwd`
- std::string const outputFilename(std::string const & buf_path = std::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
* Only the mangled file name is returned. It is not prepended
* with @c dir.
*/
- std::string const
- mangledFilename(std::string const & dir = std::string()) const;
+ std::string
+ 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 const unzippedFilename() const;
+ std::string unzippedFilename() const;
private:
bool save_abs_path_;
bool operator==(DocFileName const &, DocFileName const &);
bool operator!=(DocFileName const &, DocFileName const &);
-
} // namespace support
} // namespace lyx
projects / lyx.git / blobdiff