Add new FileName::set() method.

[lyx.git] / src / support / FileName.h

diff --git a/src/support/FileName.h b/src/support/FileName.h
index 328602bf34e692aaa968e9def85116ff5ceeb767..af35575286786212c78dd9142a7da367420beb50 100644 (file)
--- a/src/support/FileName.h
+++ b/src/support/FileName.h
@@ -43,6 +43,9 @@ public:
        /// copy constructor.
        FileName(FileName const &);
 
+       /// constructor with base name and suffix.
+       FileName(FileName const & fn, std::string const & suffix);
+
        ///
        FileName & operator=(FileName const &);
 
@@ -52,9 +55,13 @@ public:
         * 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;
        /**
@@ -72,15 +79,15 @@ public:
        /// returns time of last write access
        std::time_t lastModified() const;
        /// generates a checksum of a file
-       unsigned long checksum() const;
+       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)
@@ -90,23 +97,39 @@ public:
        
        /// 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;
 
        /// rename pointed file.
-       /// \retrun true on success.
+       /// \return false if the operation fails or if the \param target file
+       /// already exists.
+       /// \return true on success.
        bool renameTo(FileName const & target) const;
 
+       /// move pointed file to \param target.
+       /// \return true on success.
+       bool moveTo(FileName const & target) 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 directory and all contents, returns true on success
+       /// remove pointed directory and all contents.
+       /// \return true on success.
        bool destroyDirectory() const;
-       /// Creates directory. Returns true on success
+       /// 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.
@@ -132,13 +155,23 @@ public:
        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 = empty_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
@@ -186,7 +219,7 @@ public:
         *  \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();