CMake: fix merged build, seems GCC could not handle the namespaces correctly

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

diff --git a/src/support/FileName.h b/src/support/FileName.h
index bee3a844f1bd062becf720812e0e5bda7ecaf597..3d64ad091f5e40d41b74895936e4aef2c9b61595 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,14 +55,21 @@ 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;
+       static bool isAbsolute(std::string const & name);
 
        /// get the absolute file name in UTF-8 encoding
        std::string absFilename() const;
+
+       /** returns an absolute pathname (whose resolution does not involve
+         * '.', '..', or symbolic links) in UTF-8 encoding
+         */
+       std::string realPath() const;
+
        /**
         * Get the file name in the encoding used by the file system.
         * Only use this for accessing the file, e.g. with an fstream.
@@ -68,6 +78,8 @@ public:
 
        /// 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.
@@ -75,15 +87,15 @@ public:
        /// returns time of last write access
        std::time_t lastModified() const;
        /// generates a checksum of a file
-       unsigned long checksum() const;
-       /// return true when file is readable but not writabel
+       virtual unsigned long checksum() const;
+       /// return true when file is readable but not writable
        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)
@@ -156,12 +168,23 @@ public:
        /// 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;
+       /// only extension after the last dot.
+       std::string extension() const;
+       /** checks if the file has the given extension
+               on Windows and Mac it compares case insensitive */
+       bool hasExtension(const std::string & ext);
        /// path without file name
        FileName onlyPath() const;
        /// used for display in the Gui
@@ -176,16 +199,25 @@ public:
        docstring const absoluteFilePath() const;
 
 private:
+       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 &);
 
 
@@ -199,7 +231,7 @@ class DocFileName : public FileName {
 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);
@@ -209,10 +241,10 @@ 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();
-
+       ///
        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;
@@ -248,6 +280,8 @@ public:
        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_;
@@ -256,7 +290,10 @@ private:
 };
 
 
+/// \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