X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2db991f4576e7b08e4aa877c6350cca9656a60cc..e879caa6a3a94a6a02a93d9555b1a44e959a1ff3:/include/wx/filename.h diff --git a/include/wx/filename.h b/include/wx/filename.h index 9768a87395..7eff2e8783 100644 --- a/include/wx/filename.h +++ b/include/wx/filename.h @@ -6,20 +6,12 @@ // Created: 28.12.00 // RCS-ID: $Id$ // Copyright: (c) 2000 Robert Roebling -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_FILENAME_H_ #define _WX_FILENAME_H_ -#ifdef __GNUG__ - #pragma interface "filename.h" -#endif - -#ifndef WX_PRECOMP - #include "wx/string.h" -#endif - /* TODO: @@ -27,18 +19,23 @@ 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" + +#if wxUSE_FILE +class WXDLLIMPEXP_FWD_BASE wxFile; +#endif -class WXDLLEXPORT wxFile; +#if wxUSE_FFILE +class WXDLLIMPEXP_FWD_BASE wxFFile; +#endif // ---------------------------------------------------------------------------- // constants @@ -51,13 +48,14 @@ enum wxPathFormat { wxPATH_NATIVE = 0, // the path format for the current platform wxPATH_UNIX, + wxPATH_BEOS = wxPATH_UNIX, wxPATH_MAC, wxPATH_DOS, + wxPATH_WIN = wxPATH_DOS, + wxPATH_OS2 = wxPATH_DOS, wxPATH_VMS, - wxPATH_BEOS = wxPATH_UNIX, - wxPATH_WIN = wxPATH_DOS, - wxPATH_OS2 = wxPATH_DOS + wxPATH_MAX // Not a valid value for specifying path format }; // the kind of normalization to do with the file name: these values can be @@ -70,21 +68,42 @@ enum wxPathNormalize wxPATH_NORM_CASE = 0x0008, // if case insensitive => tolower wxPATH_NORM_ABSOLUTE = 0x0010, // make the path absolute wxPATH_NORM_LONG = 0x0020, // make the path the long form - wxPATH_NORM_ALL = 0x003f + wxPATH_NORM_SHORTCUT = 0x0040, // resolve the shortcut, if it is a shortcut + wxPATH_NORM_ALL = 0x00ff & ~wxPATH_NORM_CASE +}; + +// what exactly should GetPath() return? +enum +{ + wxPATH_GET_VOLUME = 0x0001, // include the volume if applicable + wxPATH_GET_SEPARATOR = 0x0002 // terminate the path with the separator +}; + +// MkDir flags +enum +{ + wxPATH_MKDIR_FULL = 0x0001 // create directories recursively }; +#if wxUSE_LONGLONG +// error code of wxFileName::GetSize() +extern wxULongLong wxInvalidSize; +#endif // wxUSE_LONGLONG + + + // ---------------------------------------------------------------------------- // wxFileName: encapsulates a file path // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxFileName +class WXDLLIMPEXP_BASE wxFileName { public: // constructors and assignment // the usual stuff - wxFileName() { } - wxFileName( const wxFileName &filepath ) { Assign(filepath); } + wxFileName() { Clear(); } + wxFileName(const wxFileName& filepath) { Assign(filepath); } // from a full filename: if it terminates with a '/', a directory path // is contructed (the name will be empty), otherwise a file name and @@ -124,8 +143,16 @@ public: const wxString& path, const wxString& name, const wxString& ext, + bool hasExt, wxPathFormat format = wxPATH_NATIVE); + void Assign(const wxString& volume, + const wxString& path, + const wxString& name, + const wxString& ext, + wxPathFormat format = wxPATH_NATIVE) + { Assign(volume, path, name, ext, !ext.empty(), format); } + void Assign(const wxString& path, const wxString& name, wxPathFormat format = wxPATH_NATIVE); @@ -133,11 +160,7 @@ public: void Assign(const wxString& path, const wxString& name, const wxString& ext, - wxPathFormat format = wxPATH_NATIVE) - { - // empty volume - Assign(_T(""), path, name, ext, format); - } + wxPathFormat format = wxPATH_NATIVE); void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE); @@ -153,26 +176,54 @@ public: void Clear(); // static pseudo constructors - static wxFileName FileName(const wxString& file); - static wxFileName DirName(const wxString& dir); + static wxFileName FileName(const wxString& file, + wxPathFormat format = wxPATH_NATIVE); + static wxFileName DirName(const wxString& dir, + wxPathFormat format = wxPATH_NATIVE); // file tests // is the filename valid at all? - bool IsOk() const { return !m_dirs.IsEmpty() || !m_name.IsEmpty(); } + 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.empty() || !m_relative || + !m_ext.empty() || m_hasExt; + } // does the file with this name exists? - bool FileExists(); + bool FileExists() const; static bool FileExists( const wxString &file ); // does the directory with this name exists? - bool DirExists(); + 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 + // time functions +#if wxUSE_DATETIME // set the file last access/mod and creation times // (any of the pointers may be NULL) bool SetTimes(const wxDateTime *dtAccess, @@ -195,6 +246,7 @@ public: (void)GetTimes(NULL, &dtMod, NULL); return dtMod; } +#endif // wxUSE_DATETIME #ifdef __WXMAC__ bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ; @@ -206,6 +258,7 @@ public: // looks up the appropriate type and creator from the registration and then sets bool MacSetDefaultTypeAndCreator() ; #endif + // various file/dir operations // retrieve the value of the current working directory @@ -220,17 +273,36 @@ 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); + static wxString CreateTempFileName(const wxString& prefix, + 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, wxFile *fileTemp = NULL); + void AssignTempFileName(const wxString& prefix, wxFFile *fileTemp); static wxString CreateTempFileName(const wxString& prefix, - wxFile *fileTemp = NULL); + wxFFile *fileTemp); +#endif // wxUSE_FFILE // directory creation and removal. - // if full is TRUE, will try to make each directory in the path. - bool Mkdir( int perm = 0777, bool full = FALSE); - static bool Mkdir( const wxString &dir, int perm = 0777, bool full = FALSE ); + bool Mkdir( int perm = 0777, int flags = 0); + static bool Mkdir( const wxString &dir, int perm = 0777, int flags = 0 ); bool Rmdir(); static bool Rmdir( const wxString &dir ); @@ -251,23 +323,45 @@ public: // // pass an empty string to get a path relative to the working directory // - // returns TRUE if the file name was modified, FALSE if we failed to do + // returns true if the file name was modified, false if we failed to do // anything with it (happens when the file is on a different volume, // for example) - bool MakeRelativeTo(const wxString& pathBase = _T(""), + bool MakeRelativeTo(const wxString& pathBase = wxEmptyString, wxPathFormat format = wxPATH_NATIVE); + // make the path absolute + // + // this may be done using another (than current) value of cwd + bool MakeAbsolute(const wxString& cwd = wxEmptyString, + wxPathFormat format = wxPATH_NATIVE) + { return Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_ABSOLUTE | + wxPATH_NORM_TILDE, cwd, format); } + +#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); +#endif // Comparison - // compares with the rules of this platform - bool SameAs(const wxFileName &filepath, - wxPathFormat format = wxPATH_NATIVE); + // compares with the rules of the given platforms format + bool SameAs(const wxFileName& filepath, + wxPathFormat format = wxPATH_NATIVE) const; - // uses the current platform settings - bool operator==(const wxFileName& filename) { return SameAs(filename); } - bool operator==(const wxString& filename) - { return *this == wxFileName(filename); } + // compare with another filename object + bool operator==(const wxFileName& filename) const + { return SameAs(filename); } + bool operator!=(const wxFileName& filename) const + { return !SameAs(filename); } + + // compare with a filename string interpreted as a native file name + bool operator==(const wxString& filename) const + { return SameAs(wxFileName(filename)); } + bool operator!=(const wxString& filename) const + { return !SameAs(wxFileName(filename)); } // are the file names of this type cases sensitive? static bool IsCaseSensitive( wxPathFormat format = wxPATH_NATIVE ); @@ -279,6 +373,10 @@ public: bool IsRelative(wxPathFormat format = wxPATH_NATIVE) const { return !IsAbsolute(format); } + // Returns the characters that aren't allowed in filenames + // on the specified platform. + static wxString GetForbiddenChars(wxPathFormat format = wxPATH_NATIVE); + // Information about path format // get the string separating the volume from the path for this format, @@ -289,24 +387,31 @@ public: // get the string of path separators for this format static wxString GetPathSeparators(wxPathFormat format = wxPATH_NATIVE); + // get the string of path terminators, i.e. characters which terminate the + // path + 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? static bool IsPathSeparator(wxChar ch, wxPathFormat format = wxPATH_NATIVE); // Dir accessors - void AppendDir( const wxString &dir ); - void PrependDir( const wxString &dir ); - void InsertDir( int before, const wxString &dir ); - void RemoveDir( int pos ); - size_t GetDirCount() const { return m_dirs.GetCount(); } + size_t GetDirCount() const { return m_dirs.size(); } + void AppendDir(const wxString& dir); + void PrependDir(const wxString& dir); + void 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; } + 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_ext.empty(); } + bool HasExt() const { return m_hasExt; } void SetName( const wxString &name ) { m_name = name; } wxString GetName() const { return m_name; } @@ -322,16 +427,13 @@ public: const wxArrayString& GetDirs() const { return m_dirs; } - // Construct path only - possibly with the trailing separator - wxString GetPath( bool add_separator = FALSE, - wxPathFormat format = wxPATH_NATIVE ) const; + // flags are combination of wxPATH_GET_XXX flags + wxString GetPath(int flags = wxPATH_GET_VOLUME, + wxPathFormat format = wxPATH_NATIVE) const; + // Replace current path with this one void SetPath( const wxString &path, wxPathFormat format = wxPATH_NATIVE ); - // more readable synonym - wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const - { return GetPath(TRUE /* add separator */, format); } - // Construct full path with name and ext wxString GetFullPath( wxPathFormat format = wxPATH_NATIVE ) const; @@ -356,16 +458,62 @@ public: wxString *path, wxString *name, wxString *ext, + bool *hasExt = NULL, wxPathFormat format = wxPATH_NATIVE); - // compatibility version + static void SplitPath(const wxString& fullpath, + wxString *volume, + wxString *path, + wxString *name, + wxString *ext, + wxPathFormat format) + { + SplitPath(fullpath, volume, path, name, ext, NULL, format); + } + + // compatibility version: volume is part of path static void SplitPath(const wxString& fullpath, wxString *path, wxString *name, wxString *ext, wxPathFormat format = wxPATH_NATIVE); + // split a path into volume and pure path part + static void SplitVolume(const wxString& fullpathWithVolume, + wxString *volume, + wxString *path, + wxPathFormat format = wxPATH_NATIVE); + + // Filesize + +#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 + // -------------------------------------- + +#ifndef __DIGITALMARS__ + wxString GetPath( bool withSep, wxPathFormat format = wxPATH_NATIVE ) const + { return GetPath(withSep ? wxPATH_GET_SEPARATOR : 0, format); } +#endif + wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const + { return GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR, format); } + private: + // check whether this dir is valid for Append/Prepend/InsertDir() + static bool IsValidDirComponent(const wxString& dir); + // the drive/volume/device specification (always empty for Unix) wxString m_volume; @@ -380,11 +528,18 @@ private: // that our path is '/', i.e. the root directory // // we use m_relative to distinguish between these two cases, it will be - // TRUE in the former and FALSE in the latter + // true in the former and false in the latter // - // NB: the path is not absolute just because m_relative is FALSE, it still + // NB: the path is not absolute just because m_relative is false, it still // needs the drive (i.e. volume) in some formats (Windows) bool m_relative; + + // when m_ext is empty, it may be because we don't have any extension or + // because we have an empty extension + // + // 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; }; #endif // _WX_FILENAME_H_