X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/788722ac5ca55bd3c0d1f9bd2d598f90b3b02071..bc55104d9ab0b0b835644f17a152b4fbbfa8c7b9:/include/wx/filename.h?ds=inline diff --git a/include/wx/filename.h b/include/wx/filename.h index 06696bfdf2..ceb0fc820e 100644 --- a/include/wx/filename.h +++ b/include/wx/filename.h @@ -38,6 +38,8 @@ #include "wx/filefn.h" #include "wx/datetime.h" +class WXDLLEXPORT wxFile; + // ---------------------------------------------------------------------------- // constants // ---------------------------------------------------------------------------- @@ -51,6 +53,7 @@ enum wxPathFormat wxPATH_UNIX, wxPATH_MAC, wxPATH_DOS, + wxPATH_VMS, wxPATH_BEOS = wxPATH_UNIX, wxPATH_WIN = wxPATH_DOS, @@ -95,6 +98,14 @@ public: wxPathFormat format = wxPATH_NATIVE) { Assign(path, name, format); } + // from a volume, directory name, file base name and extension + wxFileName(const wxString& volume, + const wxString& path, + const wxString& name, + const wxString& ext, + wxPathFormat format = wxPATH_NATIVE) + { Assign(volume, path, name, ext, format); } + // from a directory name, file base name and extension wxFileName(const wxString& path, const wxString& name, @@ -104,21 +115,31 @@ public: // the same for delayed initialization - // VZ: wouldn't it be better to call this Create() for consistency with - // all GUI classes? Personally, I like Set() more than Assign() too - void Assign(const wxFileName& filepath); + void Assign(const wxString& fullpath, wxPathFormat format = wxPATH_NATIVE); + + void Assign(const wxString& volume, + const wxString& path, + const wxString& name, + const wxString& ext, + wxPathFormat format = wxPATH_NATIVE); + void Assign(const wxString& path, const wxString& name, wxPathFormat format = wxPATH_NATIVE); + void Assign(const wxString& path, const wxString& name, const wxString& ext, - wxPathFormat format = wxPATH_NATIVE); - void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE) - { Assign(dir, _T(""), format); } + wxPathFormat format = wxPATH_NATIVE) + { + // empty volume + Assign(_T(""), path, name, ext, format); + } + + void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE); // assorted assignment operators @@ -135,7 +156,7 @@ public: static wxFileName FileName(const wxString& file); static wxFileName DirName(const wxString& dir); - // test for existence + // file tests // is the filename valid at all? bool IsOk() const { return !m_dirs.IsEmpty() || !m_name.IsEmpty(); } @@ -148,16 +169,48 @@ public: bool DirExists(); static bool DirExists( const wxString &dir ); - // Well, get modification time with sec resolution - wxDateTime GetModificationTime(); - // VZ: also need: IsDirWritable(), IsFileExecutable() &c (TODO) + // time functions + + // set the file creation and last access/mod times + // (any of the pointers may be NULL) + bool SetTimes(const wxDateTime *dtCreate, + const wxDateTime *dtAccess, + const wxDateTime *dtMod); + + // set the access and modification times to the current moment + bool Touch(); + + // return the last access, last modification and last change times + // (any of the pointers may be NULL) + bool GetTimes(wxDateTime *dtAccess, + wxDateTime *dtMod, + wxDateTime *dtChange) const; + + // convenience wrapper: get just the last mod time of the file + wxDateTime GetModificationTime() const + { + wxDateTime dtMod; + (void)GetTimes(NULL, &dtMod, NULL); + return dtMod; + } + +#ifdef __WXMAC__ + bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ; + bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) ; + // 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 + static void MacRegisterDefaultTypeAndCreator( const wxString& ext , wxUint32 type , wxUint32 creator ) ; + // 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 - void AssignCwd(); - static wxString GetCwd(); + void AssignCwd(const wxString& volume = wxEmptyString); + static wxString GetCwd(const wxString& volume = wxEmptyString); // change the current working directory bool SetCwd(); @@ -167,8 +220,12 @@ public: void AssignHomeDir(); static wxString GetHomeDir(); - // get a temp file name starting with thespecified prefix - void AssignTempFileName( const wxString &prefix ); + // 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); + static wxString CreateTempFileName(const wxString& prefix, + wxFile *fileTemp = NULL); // directory creation and removal. // if full is TRUE, will try to make each directory in the path. @@ -185,10 +242,22 @@ public: // variables will be expanded in it // // this may be done using another (than current) value of cwd - bool Normalize(wxPathNormalize flags = wxPATH_NORM_ALL, + bool Normalize(int flags = wxPATH_NORM_ALL, const wxString& cwd = wxEmptyString, wxPathFormat format = wxPATH_NATIVE); + // get a path path relative to the given base directory, i.e. opposite + // of Normalize + // + // 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 + // anything with it (happens when the file is on a different volume, + // for example) + bool MakeRelativeTo(const wxString& pathBase = _T(""), + wxPathFormat format = wxPATH_NATIVE); + + // Comparison // compares with the rules of this platform @@ -200,10 +269,27 @@ public: bool operator==(const wxString& filename) { return *this == wxFileName(filename); } - // Tests + // are the file names of this type cases sensitive? static bool IsCaseSensitive( wxPathFormat format = wxPATH_NATIVE ); - bool IsRelative( wxPathFormat format = wxPATH_NATIVE ); - bool IsAbsolute( wxPathFormat format = wxPATH_NATIVE ); + + // is this filename absolute? + bool IsAbsolute() const + { return !m_relative; } + + // is this filename relative? + bool IsRelative() const + { return m_relative; } + + // forcibly set the flag + void SetAbsolute() + { m_relative = FALSE; } + void SetRelative() + { m_relative = TRUE; } + + // Information about path format + + // get the string separating the volume from the path for this format + static wxString GetVolumeSeparator(wxPathFormat format = wxPATH_NATIVE); // get the string of path separators for this format static wxString GetPathSeparators(wxPathFormat format = wxPATH_NATIVE); @@ -224,21 +310,27 @@ public: // Other accessors void SetExt( const wxString &ext ) { m_ext = ext; } wxString GetExt() const { return m_ext; } - bool HasExt() const { return !m_ext.IsEmpty(); } + bool HasExt() const { return !m_ext.empty(); } void SetName( const wxString &name ) { m_name = name; } wxString GetName() const { return m_name; } - bool HasName() const { return !m_name.IsEmpty(); } + bool HasName() const { return !m_name.empty(); } + + void SetVolume( const wxString &volume ) { m_volume = volume; } + wxString GetVolume() const { return m_volume; } + bool HasVolume() const { return !m_volume.empty(); } // full name is the file name + extension (but without the path) void SetFullName(const wxString& fullname); wxString GetFullName() const; - const wxArrayString &GetDirs() const { return m_dirs; } + 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; + // 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 @@ -258,8 +350,16 @@ public: // get the canonical path format for this platform static wxPathFormat GetFormat( wxPathFormat format = wxPATH_NATIVE ); - // split a fullpath into path, (base) name and ext (all of the pointers - // can be NULL) + // split a fullpath into the volume, path, (base) name and extension + // (all of the pointers can be NULL) + static void SplitPath(const wxString& fullpath, + wxString *volume, + wxString *path, + wxString *name, + wxString *ext, + wxPathFormat format = wxPATH_NATIVE); + + // compatibility version static void SplitPath(const wxString& fullpath, wxString *path, wxString *name, @@ -267,12 +367,18 @@ public: wxPathFormat format = wxPATH_NATIVE); private: + // the drive/volume/device specification (always empty for Unix) + wxString m_volume; + // the path components of the file wxArrayString m_dirs; // the file name and extension (empty for directories) wxString m_name, m_ext; + + // is the path relative + bool m_relative; }; #endif // _WX_FILENAME_H_