]> git.mxchange.org Git - simgear.git/blobdiff - simgear/misc/sg_path.cxx
Ganael Laplanche: fix include dependencies for FreeBSD support
[simgear.git] / simgear / misc / sg_path.cxx
index d171c073b70024a7f9ed3ef25f1da4e66949ffea..d51c93afdf74c791746a33883a878db061a1c2a4 100644 (file)
@@ -3,7 +3,7 @@
 //
 // Written by Curtis L. Olson, started April 1999.
 //
-// Copyright (C) 1999  Curtis L. Olson - curt@flightgear.org
+// Copyright (C) 1999  Curtis L. Olson - http://www.flightgear.org/~curt
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Library General Public
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 // Library General Public License for more details.
 //
-// You should have received a copy of the GNU Library General Public
-// License along with this library; if not, write to the
-// Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-// Boston, MA  02111-1307, USA.
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
 
+#include <simgear/compiler.h>
+
 #include <simgear_config.h>
+#include <simgear/debug/logstream.hxx>
 #include <stdio.h>
+#include <sys/stat.h>
+#include <errno.h>
 
+#ifdef _WIN32
+#  include <direct.h>
+#endif
 #include "sg_path.hxx"
 
+#include <boost/algorithm/string/case_conv.hpp>
+
+using std::string;
+
+/**
+ * define directory path separators
+ */
 
-// If Unix, replace all ":" with "/".  If MacOS, replace all "/" with
-// ":" it should go without saying that neither of these characters
-// should be used in file or directory names.  In windoze, allow the
-// second character to be a ":" for things like c:\foo\bar
+static const char sgDirPathSep = '/';
+static const char sgDirPathSepBad = '\\';
 
+#ifdef _WIN32
+static const char sgSearchPathSep = ';';
+#else
+static const char sgSearchPathSep = ':';
+#endif
+
+
+// For windows, replace "\" by "/".
 void
 SGPath::fix()
 {
-    for ( string::size_type i = 0; i < path.size(); ++i ) {
-#if defined( WIN32 )
-       // for windoze, don't replace the ":" for the second character
-       if ( i == 1 ) {
-           continue;
-       }
-#endif
-       if ( path[i] == SG_BAD_PATH_SEP ) {
-           path[i] = SG_PATH_SEP;
-       }
+    string::size_type sz = path.size();
+    for ( string::size_type i = 0; i < sz; ++i ) {
+        if ( path[i] == sgDirPathSepBad ) {
+            path[i] = sgDirPathSep;
+        }
+    }
+    // drop trailing "/"
+    while ((sz>1)&&(path[sz-1]==sgDirPathSep))
+    {
+        path.resize(--sz);
     }
 }
 
 
 // default constructor
 SGPath::SGPath()
-    : path("")
+    : path(""),
+    _cached(false),
+    _cacheEnabled(true)
 {
 }
 
 
 // create a path based on "path"
 SGPath::SGPath( const std::string& p )
-    : path(p)
+    : path(p),
+    _cached(false),
+    _cacheEnabled(true)
+{
+    fix();
+}
+
+// create a path based on "path" and a "subpath"
+SGPath::SGPath( const SGPath& p, const std::string& r )
+    : path(p.path),
+    _cached(false),
+    _cacheEnabled(p._cacheEnabled)
 {
+    append(r);
     fix();
 }
 
+SGPath::SGPath(const SGPath& p) :
+  path(p.path),
+  _cached(p._cached),
+  _cacheEnabled(p._cacheEnabled),
+  _exists(p._exists),
+  _isDir(p._isDir),
+  _isFile(p._isFile),
+  _modTime(p._modTime)
+{
+}
+
+SGPath& SGPath::operator=(const SGPath& p)
+{
+  path = p.path;
+  _cached = p._cached;
+  _cacheEnabled = p._cacheEnabled;
+  _exists = p._exists;
+  _isDir = p._isDir;
+  _isFile = p._isFile;
+  _modTime = p._modTime;
+  return *this;
+}
 
 // destructor
 SGPath::~SGPath() {
@@ -75,20 +131,31 @@ SGPath::~SGPath() {
 void SGPath::set( const string& p ) {
     path = p;
     fix();
+    _cached = false;
 }
 
+void SGPath::set_cached(bool cached)
+{
+    _cacheEnabled = cached;
+}
 
 // append another piece to the existing path
 void SGPath::append( const string& p ) {
     if ( path.size() == 0 ) {
-       path = p;
+        path = p;
     } else {
-       if ( p[0] != SG_PATH_SEP ) {
-           path += SG_PATH_SEP;
-       }
-       path += p;
+    if ( p[0] != sgDirPathSep ) {
+        path += sgDirPathSep;
+    }
+        path += p;
     }
     fix();
+    _cached = false;
+}
+
+//add a new path component to the existing path string
+void SGPath::add( const string& p ) {
+    append( sgSearchPathSep+p );
 }
 
 
@@ -96,35 +163,341 @@ void SGPath::append( const string& p ) {
 // path separator
 void SGPath::concat( const string& p ) {
     if ( path.size() == 0 ) {
-       path = p;
+        path = p;
     } else {
-       path += p;
+        path += p;
     }
     fix();
+    _cached = false;
 }
 
 
+// Get the file part of the path (everything after the last path sep)
+string SGPath::file() const
+{
+    string::size_type index = path.rfind(sgDirPathSep);
+    if (index != string::npos) {
+        return path.substr(index + 1);
+    } else {
+        return path;
+    }
+}
+  
+
 // get the directory part of the path.
-string SGPath::dir() {
-    int index = path.rfind(SG_PATH_SEP);
+string SGPath::dir() const {
+    int index = path.rfind(sgDirPathSep);
     if (index >= 0) {
-       return path.substr(0, index);
+        return path.substr(0, index);
+    } else {
+        return "";
+    }
+}
+
+// get the base part of the path (everything but the extension.)
+string SGPath::base() const
+{
+    string::size_type index = path.rfind(".");
+    string::size_type lastSep = path.rfind(sgDirPathSep);
+    
+// tolerate dots inside directory names
+    if ((lastSep != string::npos) && (index < lastSep)) {
+        return path;
+    }
+    
+    if (index != string::npos) {
+        return path.substr(0, index);
+    } else {
+        return path;
+    }
+}
+
+string SGPath::file_base() const
+{
+    string::size_type index = path.rfind(sgDirPathSep);
+    if (index == string::npos) {
+        index = 0; // no separator in the name
     } else {
-       return "";
+        ++index; // skip past the separator
+    }
+    
+    string::size_type firstDot = path.find(".", index);
+    if (firstDot == string::npos) {
+        return path.substr(index); // no extensions
+    }
+    
+    return path.substr(index, firstDot - index);
+}
+
+// get the extension (everything after the final ".")
+// but make sure no "/" follows the "." character (otherwise it
+// is has to be a directory name containing a ".").
+string SGPath::extension() const {
+    int index = path.rfind(".");
+    if ((index >= 0)  && (path.find("/", index) == string::npos)) {
+        return path.substr(index + 1);
+    } else {
+        return "";
+    }
+}
+
+string SGPath::lower_extension() const {
+    return boost::to_lower_copy(extension());
+}
+
+string SGPath::complete_lower_extension() const
+{
+    string::size_type index = path.rfind(sgDirPathSep);
+    if (index == string::npos) {
+        index = 0; // no separator in the name
+    } else {
+        ++index; // skip past the separator
+    }
+    
+    string::size_type firstDot = path.find(".", index);
+    if ((firstDot != string::npos)  && (path.find(sgDirPathSep, firstDot) == string::npos)) {
+        return boost::to_lower_copy(path.substr(firstDot + 1));
+    } else {
+        return "";
+    }
+}
+
+void SGPath::validate() const
+{
+  if (_cached && _cacheEnabled) {
+    return;
+  }
+  
+#ifdef _WIN32
+  struct _stat buf ;
+
+  bool remove_trailing = false;
+  if ( path.length() > 1 && path[path.length()-1] == '/' )
+      remove_trailing=true;
+  if (_stat (path.substr(0,remove_trailing?path.length()-1:path.length()).c_str(), &buf ) < 0) {
+    _exists = false;
+  } else {
+    _exists = true;
+    _isFile = ((S_IFREG & buf.st_mode ) !=0);
+    _isDir = ((S_IFDIR & buf.st_mode ) !=0);
+    _modTime = buf.st_mtime;
+  }
+
+#else
+  struct stat buf ;
+
+  if (stat(path.c_str(), &buf ) < 0) {
+    _exists = false;
+  } else {
+    _exists = true;
+    _isFile = ((S_ISREG(buf.st_mode )) != 0);
+    _isDir = ((S_ISDIR(buf.st_mode )) != 0);
+    _modTime = buf.st_mtime;
+  }
+  
+#endif
+  _cached = true;
+}
+
+bool SGPath::exists() const
+{
+  validate();
+  return _exists;
+}
+
+bool SGPath::isDir() const
+{
+  validate();
+  return _exists && _isDir;
+}
+
+bool SGPath::isFile() const
+{
+  validate();
+  return _exists && _isFile;
+}
+
+#ifdef _WIN32
+#  define sgMkDir(d,m)       _mkdir(d)
+#else
+#  define sgMkDir(d,m)       mkdir(d,m)
+#endif
+
+
+int SGPath::create_dir( mode_t mode ) {
+    string_list dirlist = sgPathSplit(dir());
+    if ( dirlist.empty() )
+        return -1;
+    string path = dirlist[0];
+    string_list path_elements = sgPathBranchSplit(path);
+    bool absolute = !path.empty() && path[0] == sgDirPathSep;
+
+    unsigned int i = 1;
+    SGPath dir = absolute ? string( 1, sgDirPathSep ) : "";
+    dir.concat( path_elements[0] );
+#ifdef _WIN32
+    if ( dir.str().find(':') != string::npos && path_elements.size() >= 2 ) {
+        dir.append( path_elements[1] );
+        i = 2;
+    }
+#endif
+    struct stat info;
+    int r;
+    for(; ( r = stat( dir.c_str(), &info ) ) == 0 && i < path_elements.size(); i++) {
+        dir.append(path_elements[i]);
+    }
+    if ( r == 0 ) {
+        return 0; // Directory already exists
+    }
+    if ( sgMkDir( dir.c_str(), mode) ) {
+        SG_LOG( SG_IO, SG_ALERT, "Error creating directory: " + dir.str() );
+        return -2;
+    }
+    for(; i < path_elements.size(); i++) {
+        dir.append(path_elements[i]);
+        if ( sgMkDir( dir.c_str(), mode) ) {
+            SG_LOG( SG_IO, SG_ALERT, "Error creating directory: " + dir.str() );
+            return -2;
+        }
+    }
+
+    return 0;
+}
+
+string_list sgPathBranchSplit( const string &dirpath ) {
+    string_list path_elements;
+    string element, path = dirpath;
+    while ( path.size() ) {
+        size_t p = path.find( sgDirPathSep );
+        if ( p != string::npos ) {
+            element = path.substr( 0, p );
+            path.erase( 0, p + 1 );
+        } else {
+            element = path;
+            path = "";
+        }
+        if ( element.size() )
+            path_elements.push_back( element );
+    }
+    return path_elements;
+}
+
+
+string_list sgPathSplit( const string &search_path ) {
+    string tmp = search_path;
+    string_list result;
+    result.clear();
+
+    bool done = false;
+
+    while ( !done ) {
+        int index = tmp.find(sgSearchPathSep);
+        if (index >= 0) {
+            result.push_back( tmp.substr(0, index) );
+            tmp = tmp.substr( index + 1 );
+        } else {
+            if ( !tmp.empty() )
+                result.push_back( tmp );
+            done = true;
+        }
+    }
+
+    return result;
+}
+
+bool SGPath::isAbsolute() const
+{
+  if (path.empty()) {
+    return false;
+  }
+  
+#ifdef _WIN32
+  // detect '[A-Za-z]:/'
+  if (path.size() > 2) {
+    if (isalpha(path[0]) && (path[1] == ':') && (path[2] == sgDirPathSep)) {
+      return true;
     }
+  }
+#endif
+  
+  return (path[0] == sgDirPathSep);
 }
 
-string SGPath::filename() {
-    int index = path.rfind(SG_PATH_SEP);
-    if (index < 0) index = 0;
-    return path.substr(index);
+bool SGPath::isNull() const
+{
+  return path.empty() || (path == "");
+}
+
+std::string SGPath::str_native() const
+{
+#ifdef _WIN32
+    std::string s = str();
+    std::string::size_type pos;
+    std::string nativeSeparator;
+    nativeSeparator = sgDirPathSepBad;
+
+    while( (pos=s.find( sgDirPathSep )) != std::string::npos ) {
+        s.replace( pos, 1, nativeSeparator );
+    }
+    return s;
+#else
+    return str();
+#endif
 }
 
-bool SGPath::exists() const {
-    FILE* fp = fopen( path.c_str(), "r");
-    if (fp == 0) {
-       return false;
+bool SGPath::remove()
+{
+    int err = ::unlink(c_str());
+    if (err) {
+        SG_LOG(SG_IO, SG_WARN,  "file remove failed: (" << str() << ") " << strerror(errno));
     }
-    fclose(fp);
+    return (err == 0);
+}
+
+time_t SGPath::modTime() const
+{
+    validate();
+    return _modTime;
+}
+
+bool SGPath::operator==(const SGPath& other) const
+{
+    return (path == other.path);
+}
+
+bool SGPath::operator!=(const SGPath& other) const
+{
+    return (path != other.path);
+}
+
+bool SGPath::rename(const SGPath& newName)
+{
+    if (::rename(c_str(), newName.c_str()) != 0) {
+        SG_LOG(SG_IO, SG_WARN, "renamed failed: from " << str() << " to " << newName.str()
+            << " reason: " << strerror(errno));
+        return false;
+    }
+    
+    path = newName.path;
+    _cached = false;
     return true;
 }
+
+std::string SGPath::realpath() const
+{
+#ifdef _WIN32
+    // Not implemented for Windows yet. Return original path instead.
+    return path;
+#else
+    char* buf = ::realpath(path.c_str(), NULL);
+    if (!buf)
+    {
+        SG_LOG(SG_IO, SG_ALERT, "ERROR: The path '" << path << "' does not exist in the file system.");
+        return path;
+    }
+    std::string p(buf);
+    free(buf);
+    return p;
+#endif
+}
+