Fix VS2010 lack of fminf

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

diff --git a/simgear/misc/sg_path.hxx b/simgear/misc/sg_path.hxx
index 27b375d9d0ff8fe1e59aac52f8c840bc33f1f99b..3e5c22fe3c016e9739f5a546269355db36681305 100644 (file)
--- a/simgear/misc/sg_path.hxx
+++ b/simgear/misc/sg_path.hxx
@@ -52,8 +52,15 @@ class SGPath {
 
 public:
 
+    struct Permissions
+    {
+      bool read : 1;
+      bool write : 1;
+    };
+    typedef Permissions (*PermissionChecker)(const SGPath&);
+
     /** Default constructor */
-    SGPath();
+    explicit SGPath(PermissionChecker validator = NULL);
 
     /** Copy contructor */
     SGPath(const SGPath& p);
@@ -64,14 +71,16 @@ public:
      * Construct a path based on the starting path provided.
      * @param p initial path
      */
-    SGPath( const std::string& p );
+    SGPath( const std::string& p, PermissionChecker validator = NULL );
 
     /**
      * 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 );
+    SGPath( const SGPath& p,
+            const std::string& r,
+            PermissionChecker validator = NULL );
 
     /** Destructor */
     ~SGPath();
@@ -85,7 +94,10 @@ public:
 
     bool operator==(const SGPath& other) const;
     bool operator!=(const SGPath& other) const;
-    
+
+    void setPermissionChecker(PermissionChecker validator);
+    PermissionChecker getPermissionChecker() const;
+
     /**
      * Set if file information (exists, type, mod-time) is cached or
      * retrieved each time it is queried. Caching is enabled by default
@@ -98,6 +110,13 @@ public:
      * @param p additional path component */
     void append( const std::string& p );
 
+    /**
+     * Get a copy of this path with another piece appended.
+     *
+     * @param p additional path component
+     */
+    SGPath operator/( const std::string& p ) const;
+
     /**
      * Append a new piece to the existing path.  Inserts a search path
      * separator to the existing path and the new patch component.
@@ -111,6 +130,12 @@ public:
      */
     void concat( const std::string& p );
 
+    /**
+     * Returns a string with the absolute pathname that names the same file, whose
+     * resolution does not involve '.', '..', or symbolic links.
+     */
+    std::string realpath() const;
+
     /**
      * Get the file part of the path (everything after the last path sep)
      * @return file string
@@ -124,7 +149,7 @@ public:
     std::string dir() const;
   
     /**
-     * Get the base part of the path (everything but the extension.)
+     * Get the base part of the path (everything but the final extension.)
      * @return the base string
      */
     std::string base() const;
@@ -181,9 +206,23 @@ public:
 
     /**
      * Create the designated directory.
+     *
+     * @param mode Permissions. See:
+     *    http://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation
      * @return 0 on success, or <0 on failure.
      */
-    int create_dir(mode_t mode);
+    int create_dir(mode_t mode = 0755);
+
+    /**
+     * Check if reading file is allowed. Readabilty does not imply the existance
+     * of the file.
+     *
+     * @note By default all files will be marked as readable. No check is made
+     *       if the operating system allows the given file to be read. Derived
+     *       classes may actually implement custom read/write rights.
+     */
+    bool canRead() const;
+    bool canWrite() const;
 
     bool isFile() const;
     bool isDir() const;
@@ -213,22 +252,78 @@ public:
      * modification time of the file
      */
     time_t modTime() const;
+    
+    /**
+     * rename the file / directory we point at, to a new name
+     * this may fail if the new location is on a different volume / share,
+     * or if the destination already exists, or is not writeable
+     */
+    bool rename(const SGPath& newName);
+
+    enum StandardLocation
+    {
+      HOME,
+      DESKTOP,
+      DOWNLOADS,
+      DOCUMENTS,
+      PICTURES
+    };
+
+    static SGPath standardLocation( StandardLocation type,
+                                    const SGPath& def = SGPath() );
+
+    /**
+     * Get a path stored in the environment variable with the given \a name.
+     *
+     * @param name  Name of the environment variable
+     * @param def   Default path to return if the environment variable does not
+     *              exist or is empty.
+     */
+    static SGPath fromEnv(const char* name, const SGPath& def = SGPath());
+
+    /**
+     * Get path to user's home directory
+     */
+    static SGPath home(const SGPath& def = SGPath());
+
+    /**
+     * Get path to the user's desktop directory
+     */
+    static SGPath desktop(const SGPath& def = SGPath());
+
+       /**
+     * Get path to the user's documents directory
+     */
+    static SGPath documents(const SGPath& def = SGPath());
+
 private:
 
     void fix();
 
     void validate() const;
+    void checkAccess() const;
 
     std::string path;
-    
+    PermissionChecker _permission_checker;
+
     mutable bool _cached : 1;
+    mutable bool _rwCached : 1;
     bool _cacheEnabled : 1; ///< cacheing can be disbled if required
+    mutable bool _canRead : 1;
+    mutable bool _canWrite : 1;
     mutable bool _exists : 1;
     mutable bool _isDir : 1;
     mutable bool _isFile : 1;
     mutable time_t _modTime;
 };
 
+/// Output to an ostream
+template<typename char_type, typename traits_type>
+inline
+std::basic_ostream<char_type, traits_type>&
+operator<<(std::basic_ostream<char_type, traits_type>& s, const SGPath& p)
+{ return s << "Path \"" << p.str() << "\""; }
+
 
 /**
  * Split a directory string into a list of it's parent directories.