X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6d067eb66aaac61b12322559fb966c7e84ebbaa7..ac55e0a1a8c344626a94bc055e018630ed77b004:/include/wx/filefn.h?ds=sidebyside diff --git a/include/wx/filefn.h b/include/wx/filefn.h index 24c64f8f79..5839b81095 100644 --- a/include/wx/filefn.h +++ b/include/wx/filefn.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: filefn.h +// Name: wx/filefn.h // Purpose: File- and directory-related functions // Author: Julian Smart // Modified by: @@ -12,10 +12,6 @@ #ifndef _FILEFN_H_ #define _FILEFN_H_ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma interface "filefn.h" -#endif - #include "wx/list.h" #include "wx/arrstr.h" @@ -49,6 +45,9 @@ // __OS2__ and __UNIX__ are defined. #include #include "wx/os2/private.h" + #ifdef __WATCOMC__ + #include + #endif #include #ifdef __EMX__ #include @@ -59,7 +58,7 @@ #endif #if defined(__WINDOWS__) && !defined(__WXMICROWIN__) -#if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__SALFORDC__) && !defined(__WXWINCE__) +#if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__SALFORDC__) && !defined(__WXWINCE__) && !defined(__CYGWIN__) #include #include #include @@ -122,6 +121,14 @@ enum wxSeekMode wxFromEnd }; +enum wxFileKind +{ + wxFILE_KIND_UNKNOWN, + wxFILE_KIND_DISK, // a file supporting seeking to arbitrary offsets + wxFILE_KIND_TERMINAL, // a tty + wxFILE_KIND_PIPE // a pipe +}; + // ---------------------------------------------------------------------------- // declare our versions of low level file functions: some compilers prepend // underscores to the usual names, some also have Unicode versions of them @@ -143,25 +150,10 @@ enum wxSeekMode #define wxLSeek wxSeek wxFileOffset wxTell(int fd); - #if wxUSE_UNICODE - #if wxUSE_UNICODE_MSLU - #define wxMkDir wxMSLU__wmkdir - #define wxRmDir wxMSLU__wrmdir - #define wxStat wxMSLU__wstat - #else - #define wxMkDir _wmkdir - #define wxRmDir _wrmdir - #define wxStat _wstat - #endif - #else // !wxUSE_UNICODE - #define wxMkDir _mkdir - #ifdef __WATCOMC__ - #define wxRmDir rmdir - #else - #define wxRmDir _rmdir - #endif - #define wxStat _stat - #endif + // always Unicode under WinCE + #define wxMkDir _wmkdir + #define wxRmDir _wrmdir + #define wxStat _wstat #define wxStructStat struct _stat // Microsoft compiler loves underscores, feed them to it @@ -173,19 +165,21 @@ enum wxSeekMode // detect compilers which have support for huge files (currently only // Digital Mars doesn't) + #ifndef __WXPALMOS__ #include "wx/msw/private.h" + #endif - #undef __HUGEFILES_SUPPORTED + #undef wxHAS_HUGE_FILES #if defined(__MINGW32__) - #define __HUGEFILES_SUPPORTED 1 + #define wxHAS_HUGE_FILES 1 #elif defined(__MWERKS__) - #define __HUGEFILES_SUPPORTED 0 + #define wxHAS_HUGE_FILES 0 #elif defined(__DMC__) - #define __HUGEFILES_SUPPORTED 0 + #define wxHAS_HUGE_FILES 0 #elif ((_INTEGRAL_MAX_BITS >= 64) || defined(_LARGE_FILES)) - #define __HUGEFILES_SUPPORTED 1 + #define wxHAS_HUGE_FILES 1 #else - #define __HUGEFILES_SUPPORTED 0 + #define wxHAS_HUGE_FILES 0 #endif // functions @@ -193,12 +187,11 @@ enum wxSeekMode #define _tell tell #endif - #if __HUGEFILES_SUPPORTED + #if wxHAS_HUGE_FILES typedef wxLongLong_t wxFileOffset; #define wxFileOffsetFmtSpec wxLongLongFmtSpec #else typedef off_t wxFileOffset; - #define wxFileOffsetFmtSpec _("") #endif #define wxClose _close @@ -222,7 +215,7 @@ enum wxSeekMode #define wxWrite _write #endif #endif - #if __HUGEFILES_SUPPORTED + #if wxHAS_HUGE_FILES #define wxSeek _lseeki64 #define wxLseek _lseeki64 #define wxTell _telli64 @@ -245,7 +238,7 @@ enum wxSeekMode #define wxAccess wxMSLU__waccess #define wxMkDir wxMSLU__wmkdir #define wxRmDir wxMSLU__wrmdir - #if __HUGEFILES_SUPPORTED + #if wxHAS_HUGE_FILES #define wxStat wxMSLU__wstati64 #else #define wxStat wxMSLU__wstat @@ -255,7 +248,7 @@ enum wxSeekMode #define wxAccess _waccess #define wxMkDir _wmkdir #define wxRmDir _wrmdir - #if __HUGEFILES_SUPPORTED + #if wxHAS_HUGE_FILES #define wxStat _wstati64 #else #define wxStat _wstat @@ -274,23 +267,24 @@ enum wxSeekMode #else #define wxRmDir _rmdir #endif - #if __HUGEFILES_SUPPORTED + #if wxHAS_HUGE_FILES #define wxStat _stati64 #else #define wxStat _stat #endif #endif - // types: notice that Watcom is the only compiler to have a wide char - // version of struct stat as well as a wide char stat function variant - #if __HUGEFILES_SUPPORTED - #if wxUSE_UNICODE && defined(__WATCOMC__) + // Types: Notice that Watcom is the only compiler to have a wide char + // version of struct stat as well as a wide char stat function variant. + // This was droped since OW 1.4 "for consistency across platforms". + #if wxHAS_HUGE_FILES + #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4) #define wxStructStat struct _wstati64 #else #define wxStructStat struct _stati64 #endif #else - #if wxUSE_UNICODE && defined(__WATCOMC__) + #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4) #define wxStructStat struct _wstat #else #define wxStructStat struct _stat @@ -298,27 +292,31 @@ enum wxSeekMode #endif // constants (unless already defined by the user code) - #if !defined(O_RDONLY) && !defined(__BORLANDC__) && !defined(__WATCOMC__) - #define O_RDONLY _O_RDONLY - #define O_WRONLY _O_WRONLY - #define O_RDWR _O_RDWR - #define O_EXCL _O_EXCL - #define O_CREAT _O_CREAT - #define O_BINARY _O_BINARY - #endif + #if !defined(__BORLANDC__) && !defined(__WATCOMC__) && !defined(__WXPALMOS__) + #ifndef O_RDONLY + #define O_RDONLY _O_RDONLY + #define O_WRONLY _O_WRONLY + #define O_RDWR _O_RDWR + #define O_EXCL _O_EXCL + #define O_CREAT _O_CREAT + #define O_BINARY _O_BINARY + #endif - #if !defined(__BORLANDC__) && !defined(__WATCOMC__) - #define S_IFMT _S_IFMT - #define S_IFDIR _S_IFDIR - #define S_IFREG _S_IFREG - #endif // O_RDONLY + #ifndef S_IFMT + #define S_IFMT _S_IFMT + #define S_IFDIR _S_IFDIR + #define S_IFREG _S_IFREG + #endif + #endif // It's a private define, undefine it so nobody gets tempted to use it - #undef __HUGEFILES_SUPPORTED + #undef wxHAS_HUGE_FILES #else // Unix platforms using configure typedef off_t wxFileOffset; #ifdef _LARGE_FILES #define wxFileOffsetFmtSpec wxLongLongFmtSpec + wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t), + BadFileSizeType ); #else #define wxFileOffsetFmtSpec _T("") #endif @@ -328,7 +326,7 @@ enum wxSeekMode #define wxWrite ::write #define wxLseek lseek #define wxSeek lseek - #define wxFsync commit + #define wxFsync fsync #define wxEof eof #define wxMkDir mkdir @@ -358,9 +356,9 @@ enum wxSeekMode // VisualAge C++ V4.0 cannot have any external linkage const decs // in headers included by more than one primary source // -extern const wxFileOffset wxInvalidOffset; +extern const int wxInvalidOffset; #else -const wxFileOffset wxInvalidOffset = (wxFileOffset)-1; +const int wxInvalidOffset = -1; #endif // ---------------------------------------------------------------------------- @@ -369,7 +367,7 @@ const wxFileOffset wxInvalidOffset = (wxFileOffset)-1; WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename); // does the path exist? (may have or not '/' or '\\' at the end) -WXDLLIMPEXP_BASE bool wxPathExists(const wxChar *pszPathName); +WXDLLIMPEXP_BASE bool wxDirExists(const wxChar *pszPathName); WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename); @@ -438,16 +436,18 @@ WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2, WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file); // Rename file -WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2); +WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2, bool overwrite = true); // Get current working directory. +#if WXWIN_COMPATIBILITY_2_6 // If buf is NULL, allocates space using new, else // copies into buf. // IMPORTANT NOTE getcwd is know not to work under some releases // of Win32s 1.3, according to MS release notes! -WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000); +wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000) ); // new and preferred version of wxGetWorkingDirectory // NB: can't have the same name because of overloading ambiguity +#endif // WXWIN_COMPATIBILITY_2_6 WXDLLIMPEXP_BASE wxString wxGetCwd(); // Set working directory @@ -459,8 +459,18 @@ WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = 0777); // Remove directory. Flags reserved for future use. WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0); +// Return the type of an open file +WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(int fd); +WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(FILE *fp); + +#if WXWIN_COMPATIBILITY_2_6 // compatibility defines, don't use in new code -#define wxDirExists wxPathExists +wxDEPRECATED( inline bool wxPathExists(const wxChar *pszPathName) ); +inline bool wxPathExists(const wxChar *pszPathName) +{ + return wxDirExists(pszPathName); +} +#endif //WXWIN_COMPATIBILITY_2_6 // ---------------------------------------------------------------------------- // separators in file names @@ -535,9 +545,13 @@ WXDLLIMPEXP_BASE bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, co // On non-Windows platform, probably just return the empty string. WXDLLIMPEXP_BASE wxString wxGetOSDirectory(); +#if wxUSE_DATETIME + // Get file modification time WXDLLIMPEXP_BASE time_t wxFileModificationTime(const wxString& filename); +#endif // wxUSE_DATETIME + // Parses the wildCard, returning the number of filters. // Returns 0 if none or if there's a problem, // The arrays will contain an equal number of items found before the error. @@ -549,30 +563,68 @@ WXDLLIMPEXP_BASE int wxParseCommonDialogsFilter(const wxString& wildCard, wxArra // classes // ---------------------------------------------------------------------------- +#ifdef __UNIX__ + +// set umask to the given value in ctor and reset it to the old one in dtor +class WXDLLIMPEXP_BASE wxUmaskChanger +{ +public: + // change the umask to the given one if it is not -1: this allows to write + // the same code whether you really want to change umask or not, as is in + // wxFileConfig::Flush() for example + wxUmaskChanger(int umaskNew) + { + m_umaskOld = umaskNew == -1 ? -1 : (int)umask((mode_t)umaskNew); + } + + ~wxUmaskChanger() + { + if ( m_umaskOld != -1 ) + umask((mode_t)m_umaskOld); + } + +private: + int m_umaskOld; +}; + +// this macro expands to an "anonymous" wxUmaskChanger object under Unix and +// nothing elsewhere +#define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m) + +#else // !__UNIX__ + +#define wxCHANGE_UMASK(m) + +#endif // __UNIX__/!__UNIX__ + + // Path searching -class WXDLLIMPEXP_BASE wxPathList : public wxStringList +class WXDLLIMPEXP_BASE wxPathList : public wxArrayString { public: - // avoid GCC warning about virtual functions w/o virtual dtor - virtual ~wxPathList() {} + wxPathList() {} + wxPathList(const wxArrayString &arr) + { Add(arr); } // Adds all paths in environment variable void AddEnvList(const wxString& envVariable); + // Adds given path to this list void Add(const wxString& path); + void Add(const wxArrayString &paths); + // Find the first full path for which the file exists - wxString FindValidPath(const wxString& filename); + wxString FindValidPath(const wxString& filename) const; + // Find the first full path for which the file exists; ensure it's an // absolute path that gets returned. - wxString FindAbsoluteValidPath(const wxString& filename); + wxString FindAbsoluteValidPath(const wxString& filename) const; + // Given full path and filename, add path to list void EnsureFileAccessible(const wxString& path); - // Returns true if the path is in the list - bool Member(const wxString& path); -private: - // DECLARE_DYNAMIC_CLASS(wxPathList) + // Returns true if the path is in the list + wxDEPRECATED( bool Member(const wxString& path) const ); }; -#endif - // _WX_FILEFN_H_ +#endif // _WX_FILEFN_H_