Remove non-copyable idioms

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

diff --git a/src/support/FileName.h b/src/support/FileName.h
index bb17de411f20f61a6843900bec2c25ed1b5f97f5..cfa0c653e605854bb2604241eb1cb5b455f1280c 100644 (file)
--- a/src/support/FileName.h
+++ b/src/support/FileName.h
@@ -16,6 +16,7 @@
 #include "support/strfwd.h"
 
 #include <ctime>
+#include <set>
 
 
 namespace lyx {
@@ -55,8 +56,8 @@ public:
         * \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);
+       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;
@@ -64,7 +65,7 @@ public:
        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
@@ -123,7 +124,9 @@ public:
        /// \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.
@@ -136,8 +139,11 @@ public:
        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
@@ -169,23 +175,7 @@ public:
        */
        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;
-
-       /// check for zipped file
-       bool isZippedFile() const;
-
        static FileName fromFilesystemEncoding(std::string const & name);
-       /// (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();
@@ -203,6 +193,9 @@ public:
        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;
 
@@ -216,6 +209,12 @@ public:
 
 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;
@@ -257,15 +256,15 @@ public:
         *  \param buffer_path if \c filename has a relative path, generate
         *  the absolute path using this.
         */
-       virtual void set(std::string const & filename, std::string const & buffer_path);
+       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
@@ -288,21 +287,15 @@ public:
         *  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_;
 };