X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/886dd7d28e50c003cc88b81b968d487a3c17b0d7..4b4d23c77e1971e8eb2df9bbd7e4ef817e8f447e:/include/wx/filename.h diff --git a/include/wx/filename.h b/include/wx/filename.h index 9cbe521617..ef9a23dd97 100644 --- a/include/wx/filename.h +++ b/include/wx/filename.h @@ -12,12 +12,13 @@ #ifndef _WX_FILENAME_H_ #define _WX_FILENAME_H_ -#if defined(__GNUG__) && !defined(__APPLE__) +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "filename.h" #endif #ifndef WX_PRECOMP #include "wx/string.h" + #include "wx/arrstr.h" #endif /* @@ -38,7 +39,7 @@ #include "wx/filefn.h" #include "wx/datetime.h" -class WXDLLEXPORT_BASE wxFile; +class WXDLLIMPEXP_BASE wxFile; // ---------------------------------------------------------------------------- // constants @@ -51,13 +52,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,7 +72,8 @@ 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? @@ -90,14 +93,14 @@ enum // wxFileName: encapsulates a file path // ---------------------------------------------------------------------------- -class WXDLLEXPORT_BASE wxFileName +class WXDLLIMPEXP_BASE wxFileName { public: // constructors and assignment // the usual stuff wxFileName() { Clear(); } - wxFileName( const wxFileName &filepath ) { Assign(filepath); } + 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 @@ -149,7 +152,7 @@ public: wxPathFormat format = wxPATH_NATIVE) { // empty volume - Assign(_T(""), path, name, ext, format); + Assign(wxEmptyString, path, name, ext, format); } void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE); @@ -166,13 +169,19 @@ 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.IsEmpty() || !m_relative; + } // does the file with this name exists? bool FileExists() const; @@ -243,7 +252,6 @@ public: wxFile *fileTemp = NULL); // directory creation and removal. - // if full is TRUE, will try to make each directory in the path. bool Mkdir( int perm = 0777, int flags = 0); static bool Mkdir( const wxString &dir, int perm = 0777, int flags = 0 ); @@ -266,10 +274,10 @@ 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 @@ -280,6 +288,14 @@ public: { 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 the given platforms format @@ -308,6 +324,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, @@ -318,6 +338,10 @@ 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) { return GetPathSeparators(format)[0u]; } @@ -330,7 +354,7 @@ public: 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(); } // Other accessors void SetExt( const wxString &ext ) { m_ext = ext; } @@ -352,7 +376,8 @@ public: const wxArrayString& GetDirs() const { return m_dirs; } // flags are combination of wxPATH_GET_XXX flags - wxString GetPath(int flags = 0, wxPathFormat format = wxPATH_NATIVE) const; + 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 ); @@ -390,6 +415,11 @@ public: 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); // deprecated methods, don't use any more // -------------------------------------- @@ -402,6 +432,9 @@ public: { return GetPath(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; @@ -416,9 +449,9 @@ 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; };