Torque3D/Engine/source/core/util/path.h

//-----------------------------------------------------------------------------
// Copyright (c) 2012 GarageGames, LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//-----------------------------------------------------------------------------

#ifndef _PATH_H_
#define _PATH_H_

#ifndef _TORQUE_STRING_H_
#include "core/util/str.h"
#endif

namespace Torque
{

//-----------------------------------------------------------------------------

/// FileSystem filename representation.
/// 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; }

   const String& getFullFileName() const;
   const String& getFullPath() const;
   
   /// Returns the full file path without the volume root.
   String getFullPathWithoutRoot() const;

   /// Returns the root and path.
   String getRootAndPath() const;

   const String& setRoot(const String &s);
   const String& setPath(const String &s);
   const String& setFileName(const String &s);
   const String& setExtension(const String &s);
   
   U32 getDirectoryCount() const;
   String getDirectory(U32) const;
   
   bool isDirectory() const;
   bool isRelative() const;
   bool isAbsolute() const;
   
   /// Appends the argument's path component to the object's
   /// path component. The object's root, filename and
   /// extension are unaffected.
   bool appendPath(const Path &path);

private:
   String   mRoot;
   String   mPath;
   String   mFile;
   String   mExt;
   
   mutable String   mFullFileName;
   mutable String   mFullPath;

   mutable bool  mIsDirtyFileName;
   mutable bool  mIsDirtyPath;
   
   void _split(String name);
   String _join() const;
};

/// Convert file/path name to use platform standard path separator
///@ingroup VolumeSystem
String PathToPlatform(String file);

/// Convert file/path name to use OS standard path separator
///@ingroup VolumeSystem
String PathToOS(String file);

} // Namespace
#endif