Correct comment

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

diff --git a/src/support/FileName.h b/src/support/FileName.h
index 1b37ef262902bc03033db74dfcc4ce387d624292..923962b03a94891b69635542c930d9e8ee37223d 100644 (file)
--- a/src/support/FileName.h
+++ b/src/support/FileName.h
@@ -119,7 +119,7 @@ public:
        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)
        /// \warning This methods has different semantics when system level
@@ -143,12 +143,15 @@ public:
        /// 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
        /// support this.
        /// \return true on success.
        bool changePermission(unsigned long int mode) const;
+       // sets permission based on the file given as an argument
+       bool clonePermissions(FileName const & source);
 
        /// remove pointed directory and all contents.
        /// \return true on success.
@@ -175,15 +178,6 @@ public:
        void changeExtension(std::string const & extension);
 
        static FileName fromFilesystemEncoding(std::string const & name);
-       /// 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()'.
-       /// CAUTION: This method may create race conditions.
-       ///          Do not use, use the TempFile class instead.
-       static FileName tempName(std::string const & mask);
-       static FileName tempName(FileName const & temp_dir,
-               std::string const & mask);
 
        /// get the current working directory
        static FileName getcwd();
@@ -209,17 +203,17 @@ public:
 
        /// 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 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.
+       /// equivalent(), 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;
@@ -273,7 +267,7 @@ public:
        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;
-       
+
        /** @returns a mangled representation of the absolute file name
         *  suitable for use in the temp dir when, for example, converting
         *  an image file to another format.
@@ -297,6 +291,14 @@ public:
        std::string
        mangledFileName(std::string const & dir = empty_string()) const;
 
+       /** Identical to mangledFileName, with the following additions:
+       *
+       * @encrypt_path allows using hash (SHA-256) instead of full path.
+       * @use_counter allows disabling the counter in the filename.
+       */
+       std::string
+       mangledFileName(std::string const & dir, bool use_counter, bool encrypt_path) const;
+
        /// \return the absolute file name without its .gz, .z, .Z extension
        std::string unzippedFileName() const;
 
@@ -307,7 +309,7 @@ private:
 };
 
 
-/// \return true if these have the same absolute path name AND 
+/// \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 &);
 ///