Replace LString.h with support/std_string.h,

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

diff --git a/src/support/filename.h b/src/support/filename.h
index 8f406755a2b7d8282250b7ab3b62fa8531b435aa..8e6585761dbece51348377b9de2d8d88fb7ad1c4 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,13 +6,13 @@
  *
  * \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 "support/std_string.h"
 
 
 namespace lyx {
@@ -22,11 +22,15 @@ namespace support {
 class FileName {
 public:
        FileName();
+       /** \param filename the file in question. Must have an absolute path.
+        *  \param save_abs_path how is the file to be output to file?
+        */
+       FileName(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);
 
@@ -35,8 +39,20 @@ public:
 
        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`
+       string const relFilename(string const & buffer_path = string()) const;
+       /// \param buf_path if empty, uses `pwd`
+       string const outputFilename(string const & buf_path = string()) const;
+       /** \return a mangled version of the absolute file name,
+        *  suitable for use in the temp dir when, for example, converting
+        *  an image file to another format.
+        */
+       string const mangledFilename() const;
+
+       /// \return true if the file is compressed.
+       bool isZipped() const;
+       /// \return the absolute file name without its .gz, .z, .Z extension
+       string const unzippedFilename() const;
 
 private:
        string name_;