Class Path

Engine/source/core/util/path.h:38–136

FileSystem filename representation. Filenames has the following form: "root:path/file.ext" @ingroup UtilString

/// Filenames has the following form: "root:path/file.ext"
/// @ingroup UtilString
class Path
{
public:
   enum Separator
   {
#if defined(TORQUE_OS_WIN)
      OsSeparator = '\\'
#else
      OsSeparator = '/'
#endif
   };

   Path()
      :  mIsDirtyFileName( true ),
         mIsDirtyPath( true )
   {
   }

   Path( const char *file )
      :  mIsDirtyFileName( true ),
         mIsDirtyPath( true )
   {
      _split(file);
   }

   Path( const String &file )
      :  mIsDirtyFileName( true ),
         mIsDirtyPath( true )
   {
      _split(file);
   }

   Path& operator = ( const String &file ) { _split(file); mIsDirtyPath = mIsDirtyFileName = true; return *this; }
   operator String() const { return getFullPath(); }

   bool operator == (const Path& path) const { return getFullPath().equal(path.getFullPath()); }
   bool operator != (const Path& path) const { return !(*this == path); }
   bool operator != (const String& path) const { return !(getFullPath().equal(path)); }

   bool isEmpty() const { return getFullPath().isEmpty(); }

   /// Join two path or file name components together.
   static String Join(const String&,String::ValueType,const String&);

   /// Replace all '\' with '/'
   static String CleanSeparators( String path );

   /// Remove "." and ".." relative paths.
   static String CompressPath( String path );

   /// Take two paths and return the relative path between them.
   static Path MakeRelativePath( const Path &makeRelative, const Path &relativeTo, U32 mode = String::NoCase );
   
   const String& getRoot() const { return mRoot; }
   const String& getPath() const { return mPath; }
   const String& getFileName() const { return mFile; }
   const String& getExtension() const { return mExt; }