X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/89391a4ea111fcd1129d870e70fc0efc6e946fe9..fe94d0d06a2305845f0cb0c0b8fc0edbde2e2b68:/include/wx/filename.h?ds=sidebyside diff --git a/include/wx/filename.h b/include/wx/filename.h index c5edc822c4..e3d1df925d 100644 --- a/include/wx/filename.h +++ b/include/wx/filename.h @@ -4,7 +4,6 @@ // Author: Robert Roebling, Vadim Zeitlin // Modified by: // Created: 28.12.00 -// RCS-ID: $Id$ // Copyright: (c) 2000 Robert Roebling // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -12,17 +11,6 @@ #ifndef _WX_FILENAME_H_ #define _WX_FILENAME_H_ -/* - TODO: - - 1. support for drives under Windows - 2. more file operations: - a) chmod() - b) [acm]time() - get and set - c) rename()? - 3. SameFileAs() function to compare inodes under Unix - */ - #include "wx/arrstr.h" #include "wx/filefn.h" #include "wx/datetime.h" @@ -40,7 +28,7 @@ class WXDLLIMPEXP_FWD_BASE wxFFile; // this symbol is defined for the platforms where file systems use volumes in // paths -#if defined(__WXMSW__) || defined(__DOS__) || defined(__OS2__) +#if defined(__WINDOWS__) || defined(__DOS__) || defined(__OS2__) #define wxHAS_FILESYSTEM_VOLUMES #endif @@ -65,12 +53,20 @@ enum wxPathFormat wxPATH_MAX // Not a valid value for specifying path format }; +// different conventions that may be used with GetHumanReadableSize() +enum wxSizeConvention +{ + wxSIZE_CONV_TRADITIONAL, // 1024 bytes = 1 KB + wxSIZE_CONV_IEC, // 1024 bytes = 1 KiB + wxSIZE_CONV_SI // 1000 bytes = 1 KB +}; + // the kind of normalization to do with the file name: these values can be // or'd together to perform several operations at once enum wxPathNormalize { wxPATH_NORM_ENV_VARS = 0x0001, // replace env vars with their values - wxPATH_NORM_DOTS = 0x0002, // squeeze all .. and . and prepend cwd + wxPATH_NORM_DOTS = 0x0002, // squeeze all .. and . wxPATH_NORM_TILDE = 0x0004, // Unix only: replace ~ and ~user wxPATH_NORM_CASE = 0x0008, // if case insensitive => tolower wxPATH_NORM_ABSOLUTE = 0x0010, // make the path absolute @@ -100,6 +96,22 @@ enum wxPATH_RMDIR_RECURSIVE = 0x0002 // delete all recursively (dangerous!) }; +// FileExists flags +enum +{ + wxFILE_EXISTS_REGULAR = 0x0001, // check for existence of a regular file + wxFILE_EXISTS_DIR = 0x0002, // check for existence of a directory + wxFILE_EXISTS_SYMLINK = 0x1004, // check for existence of a symbolic link; + // also sets wxFILE_EXISTS_NO_FOLLOW as + // it would never be satisfied otherwise + wxFILE_EXISTS_DEVICE = 0x0008, // check for existence of a device + wxFILE_EXISTS_FIFO = 0x0016, // check for existence of a FIFO + wxFILE_EXISTS_SOCKET = 0x0032, // check for existence of a socket + // gap for future types + wxFILE_EXISTS_NO_FOLLOW = 0x1000, // don't dereference a contained symlink + wxFILE_EXISTS_ANY = 0x1FFF // check for existence of anything +}; + #if wxUSE_LONGLONG // error code of wxFileName::GetSize() extern WXDLLIMPEXP_DATA_BASE(const wxULongLong) wxInvalidSize; @@ -124,13 +136,13 @@ public: // is contructed (the name will be empty), otherwise a file name and // extension are extracted from it wxFileName( const wxString& fullpath, wxPathFormat format = wxPATH_NATIVE ) - { Assign( fullpath, format ); } + { Assign( fullpath, format ); m_dontFollowLinks = false; } // from a directory name and a file name wxFileName(const wxString& path, const wxString& name, wxPathFormat format = wxPATH_NATIVE) - { Assign(path, name, format); } + { Assign(path, name, format); m_dontFollowLinks = false; } // from a volume, directory name, file base name and extension wxFileName(const wxString& volume, @@ -138,14 +150,14 @@ public: const wxString& name, const wxString& ext, wxPathFormat format = wxPATH_NATIVE) - { Assign(volume, path, name, ext, format); } + { Assign(volume, path, name, ext, format); m_dontFollowLinks = false; } // from a directory name, file base name and extension wxFileName(const wxString& path, const wxString& name, const wxString& ext, wxPathFormat format = wxPATH_NATIVE) - { Assign(path, name, ext, format); } + { Assign(path, name, ext, format); m_dontFollowLinks = false; } // the same for delayed initialization @@ -206,14 +218,20 @@ public: !m_ext.empty() || m_hasExt; } - // does the file with this name exists? + // does the file with this name exist? bool FileExists() const; static bool FileExists( const wxString &file ); - // does the directory with this name exists? + // does the directory with this name exist? bool DirExists() const; static bool DirExists( const wxString &dir ); + // does anything at all with this name (i.e. file, directory or some + // other file system object such as a device, socket, ...) exist? + bool Exists(int flags = wxFILE_EXISTS_ANY) const; + static bool Exists(const wxString& path, int flags = wxFILE_EXISTS_ANY); + + // checks on most common flags for files/directories; // more platform-specific features (like e.g. Unix permissions) are not // available in wxFileName @@ -236,6 +254,10 @@ public: bool IsFileExecutable() const { return wxIsExecutable(GetFullPath()); } static bool IsFileExecutable(const wxString &path) { return wxFileExists(path) && wxIsExecutable(path); } + // set the file permissions to a combination of wxPosixPermissions enum + // values + bool SetPermissions(int permissions); + // time functions #if wxUSE_DATETIME @@ -243,10 +265,10 @@ public: // (any of the pointers may be NULL) bool SetTimes(const wxDateTime *dtAccess, const wxDateTime *dtMod, - const wxDateTime *dtCreate); + const wxDateTime *dtCreate) const; // set the access and modification times to the current moment - bool Touch(); + bool Touch() const; // return the last access, last modification and create times // (any of the pointers may be NULL) @@ -265,7 +287,7 @@ public: #if defined( __WXOSX_MAC__ ) && wxOSX_USE_CARBON bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ; - bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) ; + bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) const; // gets the 'common' type and creator for a certain extension static bool MacFindDefaultTypeAndCreator( const wxString& ext , wxUint32 *type , wxUint32 *creator ) ; // registers application defined extensions and their default type and creator @@ -281,7 +303,7 @@ public: static wxString GetCwd(const wxString& volume = wxEmptyString); // change the current working directory - bool SetCwd(); + bool SetCwd() const; static bool SetCwd( const wxString &cwd ); // get the value of user home (Unix only mainly) @@ -353,12 +375,32 @@ public: { return Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_ABSOLUTE | wxPATH_NORM_TILDE, cwd, format); } + + // If the path is a symbolic link (Unix-only), indicate that all + // filesystem operations on this path should be performed on the link + // itself and not on the file it points to, as is the case by default. + // + // No effect if this is not a symbolic link. + void DontFollowLink() + { + m_dontFollowLinks = true; + } + + // If the path is a symbolic link (Unix-only), returns whether various + // file operations should act on the link itself, or on its target. + // + // This does not test if the path is really a symlink or not. + bool ShouldFollowLink() const + { + return !m_dontFollowLinks; + } + #if defined(__WIN32__) && !defined(__WXWINCE__) && wxUSE_OLE // if the path is a shortcut, return the target and optionally, // the arguments bool GetShortcutTarget(const wxString& shortcutPath, wxString& targetFilename, - wxString* arguments = NULL); + wxString* arguments = NULL) const; #endif #ifndef __WXWINCE__ @@ -433,18 +475,23 @@ public: // is the char a path separator for this format? static bool IsPathSeparator(wxChar ch, wxPathFormat format = wxPATH_NATIVE); + // is this is a DOS path which beings with a windows unique volume name + // ('\\?\Volume{guid}\')? + static bool IsMSWUniqueVolumeNamePath(const wxString& path, + wxPathFormat format = wxPATH_NATIVE); + // Dir accessors size_t GetDirCount() const { return m_dirs.size(); } - void AppendDir(const wxString& dir); + bool AppendDir(const wxString& dir); void PrependDir(const wxString& dir); - void InsertDir(size_t before, const wxString& dir); + bool InsertDir(size_t before, const wxString& dir); void RemoveDir(size_t pos); void RemoveLastDir() { RemoveDir(GetDirCount() - 1); } // Other accessors 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; } + void ClearExt() { m_ext.clear(); m_hasExt = false; } + void SetEmptyExt() { m_ext.clear(); m_hasExt = true; } wxString GetExt() const { return m_ext; } bool HasExt() const { return m_hasExt; } @@ -535,11 +582,15 @@ public: 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); + wxString + GetHumanReadableSize(const wxString& nullsize = _("Not available"), + int precision = 1, + wxSizeConvention conv = wxSIZE_CONV_TRADITIONAL) const; + static wxString + GetHumanReadableSize(const wxULongLong& sz, + const wxString& nullsize = _("Not available"), + int precision = 1, + wxSizeConvention conv = wxSIZE_CONV_TRADITIONAL); #endif // wxUSE_LONGLONG @@ -583,6 +634,11 @@ private: // the difference is important as file with name "foo" and without // extension has full name "foo" while with empty extension it is "foo." bool m_hasExt; + + // by default, symlinks are dereferenced but this flag can be set with + // DontFollowLink() to change this and make different operations work on + // this file path itself instead of the target of the symlink + bool m_dontFollowLinks; }; #endif // _WX_FILENAME_H_