X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/115148f733f8237ee5cf7e6c86b56f84c2759e2c..da75a14e72a6455df1f580afd694070c4467449e:/include/wx/filefn.h diff --git a/include/wx/filefn.h b/include/wx/filefn.h index 53bf74d084..d38c8ac285 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 @@ -107,7 +106,7 @@ #endif #endif -#if defined(__VISUALC__) || ( defined(__MWERKS__) && defined( __INTEL__) ) +#if (defined(__VISUALC__) && !defined(__WXWINCE__)) || ( defined(__MWERKS__) && defined( __INTEL__) ) typedef _off_t off_t; #elif defined(__SYMANTEC__) typedef long off_t; @@ -115,16 +114,6 @@ typedef long off_t; #endif -#if defined(__VISAGECPP__) && __IBMCPP__ >= 400 -// -// VisualAge C++ V4.0 cannot have any external linkage const decs -// in headers included by more than one primary source -// -extern const off_t wxInvalidOffset; -#else -const off_t wxInvalidOffset = (off_t)-1; -#endif - enum wxSeekMode { wxFromStart, @@ -132,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 @@ -139,7 +136,7 @@ enum wxSeekMode // Wrappers around Win32 api functions like CreateFile, ReadFile and such // Implemented in filefnwce.cpp -#if defined( __WINCE__) +#if defined( __WXWINCE__) typedef __int64 wxFileOffset; #define wxFileOffsetFmtSpec _("I64") int wxOpen(const wxChar *filename, int oflag, int WXUNUSED(pmode)); @@ -153,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 @@ -183,17 +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 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 @@ -201,26 +187,27 @@ 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 #if defined(__MWERKS__) #if __MSL__ >= 0x6000 - #define wxRead _read(fd, (void *)buf, nCount) - #define wxWrite _write(fd, (void *)buf, nCount) + #define wxRead(fd, buf, nCount) _read(fd, (void *)buf, nCount) + #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount) #else - #define wxRead _read(fd, (const char *)buf, nCount) - #define wxWrite _write(fd, (const char *)buf, nCount) + #define wxRead(fd, buf, nCount)\ + _read(fd, (const char *)buf, nCount) + #define wxWrite(fd, buf, nCount)\ + _write(fd, (const char *)buf, nCount) #endif #else - #ifdef __DMC__ + #if defined(__DMC__) || defined(__WATCOMC__) #define wxRead ::read #define wxWrite ::write #else @@ -228,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 @@ -238,7 +225,11 @@ enum wxSeekMode #define wxTell _tell #endif #define wxFsync _commit - #define wxEof _eof + #if defined(__WATCOMC__) + #define wxEof ::eof + #else + #define wxEof _eof + #endif #if wxUSE_UNICODE #if wxUSE_UNICODE_MSLU @@ -247,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 @@ -257,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 @@ -276,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 @@ -300,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 -#else + #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 @@ -330,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 @@ -353,8 +349,17 @@ enum wxSeekMode #define wxStat stat #define wxAccess access #endif +#endif // platforms -#endif // VC++ +#if defined(__VISAGECPP__) && __IBMCPP__ >= 400 +// +// VisualAge C++ V4.0 cannot have any external linkage const decs +// in headers included by more than one primary source +// +extern const int wxInvalidOffset; +#else +const int wxInvalidOffset = -1; +#endif // ---------------------------------------------------------------------------- // functions @@ -362,7 +367,7 @@ enum wxSeekMode 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); @@ -434,13 +439,15 @@ WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file); WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2); // 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 @@ -452,8 +459,19 @@ 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); + // compatibility defines, don't use in new code -#define wxDirExists wxPathExists +// consider removal droping 2.4 compatibility +// #if WXWIN_COMPATIBILITY_2_4 +wxDEPRECATED( inline bool wxPathExists(const wxChar *pszPathName) ); +inline bool wxPathExists(const wxChar *pszPathName) +{ + return wxDirExists(pszPathName); +} +// #endif //WXWIN_COMPATIBILITY_2_4 // ---------------------------------------------------------------------------- // separators in file names @@ -542,6 +560,41 @@ 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 {