X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4d4edca33b67e61aeb28a8961ce2088c58631b16..b04237742c51e022af8ca8fe8933437734f392a3:/include/wx/filename.h diff --git a/include/wx/filename.h b/include/wx/filename.h index 95cbb18de5..7a7593c6d6 100644 --- a/include/wx/filename.h +++ b/include/wx/filename.h @@ -12,15 +12,6 @@ #ifndef _WX_FILENAME_H_ #define _WX_FILENAME_H_ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma interface "filename.h" -#endif - -#ifndef WX_PRECOMP - #include "wx/string.h" - #include "wx/arrstr.h" -#endif - /* TODO: @@ -28,19 +19,29 @@ 2. more file operations: a) chmod() b) [acm]time() - get and set - c) file size - d) file permissions with readable accessors for most common bits - such as IsReadable() &c - e) rename()? + c) rename()? 3. SameFileAs() function to compare inodes under Unix */ -// ridiculously enough, this will replace DirExists with wxDirExists etc +#include "wx/arrstr.h" #include "wx/filefn.h" #include "wx/datetime.h" +#include "wx/intl.h" +#include "wx/longlong.h" +#include "wx/file.h" #if wxUSE_FILE -class WXDLLIMPEXP_BASE wxFile; +class WXDLLIMPEXP_FWD_BASE wxFile; +#endif + +#if wxUSE_FFILE +class WXDLLIMPEXP_FWD_BASE wxFFile; +#endif + +// this symbol is defined for the platforms where file systems use volumes in +// paths +#if defined(__WXMSW__) || defined(__DOS__) || defined(__OS2__) + #define wxHAS_FILESYSTEM_VOLUMES #endif // ---------------------------------------------------------------------------- @@ -81,16 +82,31 @@ enum wxPathNormalize // what exactly should GetPath() return? enum { + wxPATH_NO_SEPARATOR = 0x0000, // for symmetry with wxPATH_GET_SEPARATOR wxPATH_GET_VOLUME = 0x0001, // include the volume if applicable wxPATH_GET_SEPARATOR = 0x0002 // terminate the path with the separator }; -// MkDir flags +// Mkdir flags enum { wxPATH_MKDIR_FULL = 0x0001 // create directories recursively }; +// Rmdir flags +enum +{ + wxPATH_RMDIR_FULL = 0x0001, // delete with subdirectories if empty + wxPATH_RMDIR_RECURSIVE = 0x0002 // delete all recursively (dangerous!) +}; + +#if wxUSE_LONGLONG +// error code of wxFileName::GetSize() +extern WXDLLIMPEXP_DATA_BASE(const wxULongLong) wxInvalidSize; +#endif // wxUSE_LONGLONG + + + // ---------------------------------------------------------------------------- // wxFileName: encapsulates a file path // ---------------------------------------------------------------------------- @@ -166,7 +182,7 @@ public: // assorted assignment operators wxFileName& operator=(const wxFileName& filename) - { Assign(filename); return *this; } + { if (this != &filename) Assign(filename); return *this; } wxFileName& operator=(const wxString& filename) { Assign(filename); return *this; } @@ -186,7 +202,7 @@ public: bool IsOk() const { // we're fine if we have the path or the name or if we're a root dir - return m_dirs.size() != 0 || !m_name.IsEmpty() || !m_relative || + return m_dirs.size() != 0 || !m_name.empty() || !m_relative || !m_ext.empty() || m_hasExt; } @@ -198,7 +214,28 @@ public: bool DirExists() const; static bool DirExists( const wxString &dir ); - // VZ: also need: IsDirWritable(), IsFileExecutable() &c (TODO) + // checks on most common flags for files/directories; + // more platform-specific features (like e.g. Unix permissions) are not + // available in wxFileName + + bool IsDirWritable() const { return wxIsWritable(GetPath()); } + static bool IsDirWritable(const wxString &path) { return wxDirExists(path) && wxIsWritable(path); } + + bool IsDirReadable() const { return wxIsReadable(GetPath()); } + static bool IsDirReadable(const wxString &path) { return wxDirExists(path) && wxIsReadable(path); } + + // NOTE: IsDirExecutable() is not present because the meaning of "executable" + // directory is very platform-dependent and also not so useful + + bool IsFileWritable() const { return wxIsWritable(GetFullPath()); } + static bool IsFileWritable(const wxString &path) { return wxFileExists(path) && wxIsWritable(path); } + + bool IsFileReadable() const { return wxIsReadable(GetFullPath()); } + static bool IsFileReadable(const wxString &path) { return wxFileExists(path) && wxIsReadable(path); } + + bool IsFileExecutable() const { return wxIsExecutable(GetFullPath()); } + static bool IsFileExecutable(const wxString &path) { return wxFileExists(path) && wxIsExecutable(path); } + // time functions #if wxUSE_DATETIME @@ -226,7 +263,7 @@ public: } #endif // wxUSE_DATETIME -#ifdef __WXMAC__ +#if defined( __WXOSX_MAC__ ) && wxOSX_USE_CARBON bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ; bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) ; // gets the 'common' type and creator for a certain extension @@ -251,21 +288,40 @@ public: void AssignHomeDir(); static wxString GetHomeDir(); + // get the system temporary directory + static wxString GetTempDir(); + +#if wxUSE_FILE || wxUSE_FFILE + // get a temp file name starting with the specified prefix + void AssignTempFileName(const wxString& prefix); + static wxString CreateTempFileName(const wxString& prefix); +#endif // wxUSE_FILE + #if wxUSE_FILE // get a temp file name starting with the specified prefix and open the // file passed to us using this name for writing (atomically if // possible) - void AssignTempFileName(const wxString& prefix, wxFile *fileTemp = NULL); + void AssignTempFileName(const wxString& prefix, wxFile *fileTemp); static wxString CreateTempFileName(const wxString& prefix, - wxFile *fileTemp = NULL); + wxFile *fileTemp); #endif // wxUSE_FILE +#if wxUSE_FFILE + // get a temp file name starting with the specified prefix and open the + // file passed to us using this name for writing (atomically if + // possible) + void AssignTempFileName(const wxString& prefix, wxFFile *fileTemp); + static wxString CreateTempFileName(const wxString& prefix, + wxFFile *fileTemp); +#endif // wxUSE_FFILE + // directory creation and removal. - bool Mkdir( int perm = 0777, int flags = 0); - static bool Mkdir( const wxString &dir, int perm = 0777, int flags = 0 ); + bool Mkdir(int perm = wxS_DIR_DEFAULT, int flags = 0); + static bool Mkdir(const wxString &dir, int perm = wxS_DIR_DEFAULT, + int flags = 0); - bool Rmdir(); - static bool Rmdir( const wxString &dir ); + bool Rmdir(int flags = 0); + static bool Rmdir(const wxString &dir, int flags = 0); // operations on the path @@ -305,6 +361,25 @@ public: wxString* arguments = NULL); #endif +#ifndef __WXWINCE__ + // if the path contains the value of the environment variable named envname + // then this function replaces it with the string obtained from + // wxString::Format(replacementFmtString, value_of_envname_variable) + // + // Example: + // wxFileName fn("/usr/openwin/lib/someFile"); + // fn.ReplaceEnvVariable("OPENWINHOME"); + // // now fn.GetFullPath() == "$OPENWINHOME/lib/someFile" + bool ReplaceEnvVariable(const wxString& envname, + const wxString& replacementFmtString = "$%s", + wxPathFormat format = wxPATH_NATIVE); +#endif + + // replaces, if present in the path, the home directory for the given user + // (see wxGetHomeDir) with a tilde + bool ReplaceHomeDir(wxPathFormat format = wxPATH_NATIVE); + + // Comparison // compares with the rules of the given platforms format @@ -352,7 +427,7 @@ public: static wxString GetPathTerminators(wxPathFormat format = wxPATH_NATIVE); // get the canonical path separator for this format - static wxChar GetPathSeparator(wxPathFormat format = wxPATH_NATIVE) + static wxUniChar GetPathSeparator(wxPathFormat format = wxPATH_NATIVE) { return GetPathSeparators(format)[0u]; } // is the char a path separator for this format? @@ -367,8 +442,9 @@ public: void RemoveLastDir() { RemoveDir(GetDirCount() - 1); } // Other accessors - void SetExt( const wxString &ext ) { m_ext = ext; m_hasExt = true; } - void SetNoExt() { m_ext = wxEmptyString; m_hasExt = false; } + void SetExt( const wxString &ext ) { m_ext = ext; m_hasExt = !m_ext.empty(); } + void ClearExt() { m_ext = wxEmptyString; m_hasExt = false; } + void SetEmptyExt() { m_ext = wxT(""); m_hasExt = true; } wxString GetExt() const { return m_ext; } bool HasExt() const { return m_hasExt; } @@ -443,6 +519,27 @@ public: wxString *path, wxPathFormat format = wxPATH_NATIVE); +#ifdef wxHAS_FILESYSTEM_VOLUMES + // return the string representing a file system volume, or drive + static wxString GetVolumeString(char drive, int flags = wxPATH_GET_SEPARATOR); +#endif // wxHAS_FILESYSTEM_VOLUMES + + // File size + +#if wxUSE_LONGLONG + // returns the size of the given filename + wxULongLong GetSize() const; + static wxULongLong GetSize(const wxString &file); + + // returns the size in a human readable form + wxString GetHumanReadableSize(const wxString &nullsize = wxGetTranslation(_T("Not available")), + int precision = 1) const; + static wxString GetHumanReadableSize(const wxULongLong &sz, + const wxString &nullsize = wxGetTranslation(_T("Not available")), + int precision = 1); +#endif // wxUSE_LONGLONG + + // deprecated methods, don't use any more // -------------------------------------- @@ -451,7 +548,7 @@ public: { return GetPath(withSep ? wxPATH_GET_SEPARATOR : 0, format); } #endif wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const - { return GetPath(wxPATH_GET_SEPARATOR, format); } + { return GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR, format); } private: // check whether this dir is valid for Append/Prepend/InsertDir()