Remove-on-destroy option for simgear::Dir, to help with cleaning up temporary directo...

[simgear.git] / simgear / misc / sg_path.hxx

diff --git a/simgear/misc/sg_path.hxx b/simgear/misc/sg_path.hxx
index 41b7d744b49552c2f89bacfb04c5c2482184a2d6..27b375d9d0ff8fe1e59aac52f8c840bc33f1f99b 100644 (file)
--- a/simgear/misc/sg_path.hxx
+++ b/simgear/misc/sg_path.hxx
@@ -32,6 +32,7 @@
 
 #include <simgear/compiler.h>
 #include <string>
+#include <ctime>
 
 #include <simgear/math/sg_types.hxx>
 
@@ -49,15 +50,12 @@
 
 class SGPath {
 
-private:
-
-    std::string path;
-
 public:
 
     /** Default constructor */
     SGPath();
 
+    /** Copy contructor */
     SGPath(const SGPath& p);
     
     SGPath& operator=(const SGPath& p);
@@ -68,6 +66,13 @@ public:
      */
     SGPath( const std::string& p );
 
+    /**
+     * Construct a path based on the starting path provided and a relative subpath
+     * @param p initial path
+     * @param r relative subpath
+     */
+    SGPath( const SGPath& p, const std::string& r );
+
     /** Destructor */
     ~SGPath();
 
@@ -78,6 +83,15 @@ public:
     void set( const std::string& p );
     SGPath& operator= ( const char* p ) { this->set(p); return *this; }
 
+    bool operator==(const SGPath& other) const;
+    bool operator!=(const SGPath& other) const;
+    
+    /**
+     * Set if file information (exists, type, mod-time) is cached or
+     * retrieved each time it is queried. Caching is enabled by default
+     */
+    void set_cached(bool cached);
+    
     /**
      * Append another piece to the existing path.  Inserts a path
      * separator between the existing component and the new component.
@@ -115,12 +129,33 @@ public:
      */
     std::string base() const;
 
+    /**
+     * Get the base part of the filename (everything before the first '.')
+     * @return the base filename
+     */
+    std::string file_base() const;
+
     /**
      * Get the extension part of the path (everything after the final ".")
      * @return the extension string
      */
     std::string extension() const;
-
+    
+    /**
+     * Get the extension part of the path (everything after the final ".")
+     * converted to lowercase
+     * @return the extension string
+     */
+    std::string lower_extension() const;
+    
+    /**
+     * Get the complete extension part of the path (everything after the first ".")
+     * this might look like 'tar.gz' or 'txt.Z', or might be identical to 'extension' above
+     * the extension is converted to lowercase.
+     * @return the extension string
+     */
+    std::string complete_lower_extension() const;
+    
     /**
      * Get the path string
      * @return path string
@@ -131,7 +166,12 @@ public:
      * Get the path string
      * @return path in "C" string (ptr to char array) form.
      */
-    const char* c_str() { return path.c_str(); }
+    const char* c_str() const { return path.c_str(); }
+
+    /**
+     * Get the path string in OS native form
+     */
+    std::string str_native() const;
 
     /**
      * Determine if file exists by attempting to fopen it.
@@ -147,16 +187,46 @@ public:
 
     bool isFile() const;
     bool isDir() const;
+    
+    /**
+     * Opposite sense to isAbsolute
+     */
+    bool isRelative() const { return !isAbsolute(); }
+    
+    /**
+     * Is this an absolute path?
+     * I.e starts with a directory seperator, or a single character + colon
+     */
+    bool isAbsolute() const;
+    
+    /**
+     * check for default constructed path
+     */
+    bool isNull() const;
+    
+    /**
+     * delete the file, if possible
+     */
+    bool remove();
+    
+    /**
+     * modification time of the file
+     */
+    time_t modTime() const;
 private:
 
     void fix();
 
     void validate() const;
 
-    mutable bool _cached;
-    mutable bool _exists;
-    mutable bool _isDir;
-    mutable bool _isFile;
+    std::string path;
+    
+    mutable bool _cached : 1;
+    bool _cacheEnabled : 1; ///< cacheing can be disbled if required
+    mutable bool _exists : 1;
+    mutable bool _isDir : 1;
+    mutable bool _isFile : 1;
+    mutable time_t _modTime;
 };