Detect mode_t for safe use of chmod, and for scons/msvc

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

diff --git a/src/support/filename.h b/src/support/filename.h
index 8f406755a2b7d8282250b7ab3b62fa8531b435aa..0d468bd66b8918e92c0536c817792c295bbc63d1 100644 (file)
--- a/src/support/filename.h
+++ b/src/support/filename.h
@@ -1,4 +1,4 @@
-// -*- C++-*-
+// -*- C++ -*-
 /**
  * \file filename.h
  * This file is part of LyX, the document processor.
@@ -6,46 +6,117 @@
  *
  * \author Angus Leeming
  *
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
  */
 
 #ifndef FILENAME_H
 #define FILENAME_H
 
-#include "LString.h"
+#include <string>
 
 
 namespace lyx {
 namespace support {
 
 
+/**
+ * Class for storing file names.
+ * The file name may be empty. If it is not empty it is an absolute path.
+ * The file may or may not exist.
+ */
 class FileName {
-public:
+protected:
+       /// Constructor for empty filenames (only needed for DocFileName)
        FileName();
+public:
+       /** Constructor for nonempty filenames.
+        * \param abs_filename the file in question. Must have an absolute path.
+        */
+       FileName(std::string const & abs_filename);
+       /// Is this filename empty?
+       bool empty() const { return name_.empty(); }
+       /// get the absolute file name
+       std::string const absFilename() const { return name_; }
+protected:
+       /// The absolute file name.
+       /// The encoding is currently unspecified, anything else than ASCII
+       /// may or may not work.
+       std::string name_;
+};
+
+
+bool operator==(FileName const &, FileName const &);
+bool operator!=(FileName const &, FileName const &);
+
+
+/**
+ * Class for storing file names that appear in documents (e. g. child
+ * documents, included figures etc).
+ * The file name must not denote a file in our temporary directory, but a
+ * file that the user chose.
+ */
+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?
+        */
+       DocFileName(std::string const & abs_filename, bool save_abs_path = true);
 
        /** \param filename the file in question. May have either a relative
-           or an absolute path.
-           \param buffer_path if \c filename has a relative path, generate
-           the absolute path using this.
+        *  or an absolute path.
+        *  \param buffer_path if \c filename has a relative path, generate
+        *  the absolute path using this.
         */
-       void set(string const & filename, string const & buffer_path);
+       void set(std::string const & filename, std::string const & buffer_path);
 
        void erase();
-       bool empty() const { return name_.empty(); }
 
        bool saveAbsPath() const { return save_abs_path_; }
-       string const absFilename() const { return name_; }
-       string const relFilename(string const & buffer_path) const;
-       string const outputFilename(string const & buffer_path) const;
+       /// \param buffer_path if empty, uses `pwd`
+       std::string const relFilename(std::string const & buffer_path = std::string()) const;
+       /// \param buf_path if empty, uses `pwd`
+       std::string const outputFilename(std::string const & buf_path = std::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.
+        *
+        *  @param dir the directory that will contain this file with
+        *  its mangled name. This information is used by the mangling
+        *  algorithm when determining the maximum allowable length of
+        *  the mangled name.
+        *
+        *  An example of a mangled name:
+        *  C:/foo bar/baz.eps -> 0C__foo_bar_baz.eps
+        *
+        *  It is guaranteed that
+        *  - two different filenames have different mangled names
+        *  - two FileName instances with the same filename have identical
+        *    mangled names.
+        *
+        *  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;
+
+       /// \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;
 
 private:
-       string name_;
        bool save_abs_path_;
+       /// Cache for isZipped() because zippedFile() is expensive
+       mutable bool zipped_;
+       /// Is zipped_ valid?
+       mutable bool zipped_valid_;
 };
 
 
-bool operator==(FileName const &, FileName const &);
-bool operator!=(FileName const &, FileName const &);
+bool operator==(DocFileName const &, DocFileName const &);
+bool operator!=(DocFileName const &, DocFileName const &);
 
 
 } // namespace support