X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ca3e85cfa8bec43f148eb1db520ab125947bf1e7..81051829457fc8fd271d16601d74218f345f9e6b:/include/wx/filefn.h?ds=sidebyside diff --git a/include/wx/filefn.h b/include/wx/filefn.h index 4189de1bf1..c47f40a2ca 100644 --- a/include/wx/filefn.h +++ b/include/wx/filefn.h @@ -95,6 +95,10 @@ // constants // ---------------------------------------------------------------------------- +#if defined(__VISUALC__) || defined(__DIGITALMARS__) + typedef int mode_t; +#endif + #ifdef __WXWINCE__ typedef long off_t; #else @@ -139,62 +143,82 @@ enum wxFileKind #if defined( __WXWINCE__) typedef __int64 wxFileOffset; #define wxFileOffsetFmtSpec _("I64") - int wxOpen(const wxChar *filename, int oflag, int WXUNUSED(pmode)); - int wxAccess(const wxChar *name, int WXUNUSED(how)); - int wxClose(int fd); - int wxFsync(int WXUNUSED(fd)); - int wxRead(int fd, void *buf, unsigned int count); - int wxWrite(int fd, const void *buf, unsigned int count); - int wxEof(int fd); - wxFileOffset wxSeek(int fd, wxFileOffset offset, int origin); + WXDLLIMPEXP_BASE int wxCRT_Open(const wxChar *filename, int oflag, int WXUNUSED(pmode)); + WXDLLIMPEXP_BASE int wxCRT_Access(const wxChar *name, int WXUNUSED(how)); + WXDLLIMPEXP_BASE int wxClose(int fd); + WXDLLIMPEXP_BASE int wxFsync(int WXUNUSED(fd)); + WXDLLIMPEXP_BASE int wxRead(int fd, void *buf, unsigned int count); + WXDLLIMPEXP_BASE int wxWrite(int fd, const void *buf, unsigned int count); + WXDLLIMPEXP_BASE int wxEof(int fd); + WXDLLIMPEXP_BASE wxFileOffset wxSeek(int fd, wxFileOffset offset, int origin); #define wxLSeek wxSeek - wxFileOffset wxTell(int fd); + WXDLLIMPEXP_BASE wxFileOffset wxTell(int fd); // always Unicode under WinCE - #define wxMkDir _wmkdir - #define wxRmDir _wrmdir - #define wxStat _wstat + #define wxCRT_MkDir _wmkdir + #define wxCRT_RmDir _wrmdir + #define wxCRT_Stat _wstat #define wxStructStat struct _stat - -// Microsoft compiler loves underscores, feed them to it -#elif defined( __VISUALC__ ) \ - || ( defined(__MINGW32__) && !defined(__WINE__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \ - || ( defined(__MWERKS__) && defined(__WXMSW__) ) \ - || ( defined(__DMC__) && defined(__WXMSW__) ) \ - || ( defined(__WATCOMC__) && defined(__WXMSW__) ) - - // detect compilers which have support for huge files (currently only - // Digital Mars doesn't) - #ifndef __WXPALMOS__ - #include "wx/msw/private.h" - #endif +#elif defined(__WXMSW__) && !defined(__WXPALMOS__) && \ + ( \ + defined(__VISUALC__) || \ + (defined(__MINGW32__) && !defined(__WINE__) && \ + wxCHECK_W32API_VERSION(0, 5)) || \ + defined(__MWERKS__) || \ + defined(__DMC__) || \ + defined(__WATCOMC__) || \ + defined(__BORLANDC__) \ + ) #undef wxHAS_HUGE_FILES - #if defined(__MINGW32__) + + // detect compilers which have support for huge files + #if defined(__VISUALC__) #define wxHAS_HUGE_FILES 1 - #elif defined(__MWERKS__) - #define wxHAS_HUGE_FILES 0 - #elif defined(__DMC__) - #define wxHAS_HUGE_FILES 0 - #elif ((_INTEGRAL_MAX_BITS >= 64) || defined(_LARGE_FILES)) + #elif defined(__MINGW32__) + #define wxHAS_HUGE_FILES 1 + #elif defined(_LARGE_FILES) #define wxHAS_HUGE_FILES 1 - #else - #define wxHAS_HUGE_FILES 0 #endif - // functions - #if defined(__BORLANDC__) || defined(__WATCOMC__) - #define _tell tell - #endif + // other Windows compilers (DMC, Watcom, Metrowerks and Borland) don't have + // huge file support (or at least not all functions needed for it by wx) + // currently - #if wxHAS_HUGE_FILES + #ifdef wxHAS_HUGE_FILES typedef wxLongLong_t wxFileOffset; #define wxFileOffsetFmtSpec wxLongLongFmtSpec #else typedef off_t wxFileOffset; #endif - #define wxClose _close + + // functions + + // MSVC and compatible compilers prepend underscores to the POSIX function + // names, other compilers don't and even if their later versions usually do + // define the versions with underscores for MSVC compatibility, it's better + // to avoid using them as they're not present in earlier versions and + // always using the native functions spelling is easier than testing for + // the versions + #if defined(__BORLANDC__) || defined(__DMC__) || defined(__WATCOMC__) + #define wxPOSIX_IDENT(func) ::func + #else // by default assume MSVC-compatible names + #define wxPOSIX_IDENT(func) _ ## func + #define wxHAS_UNDERSCORES_IN_POSIX_IDENTS + #endif + + // at least Borland 5.5 doesn't like "struct ::stat" so don't use the scope + // resolution operator present in wxPOSIX_IDENT for it + #ifdef __BORLANDC__ + #define wxPOSIX_STRUCT(s) struct s + #else + #define wxPOSIX_STRUCT(s) struct wxPOSIX_IDENT(s) + #endif + + // first functions not working with strings, i.e. without ANSI/Unicode + // complications + #define wxClose wxPOSIX_IDENT(close) #if defined(__MWERKS__) #if __MSL__ >= 0x6000 @@ -206,78 +230,110 @@ enum wxFileKind #define wxWrite(fd, buf, nCount)\ _write(fd, (const char *)buf, nCount) #endif - #else - #if defined(__DMC__) || defined(__WATCOMC__) - #define wxRead ::read - #define wxWrite ::write - #else - #define wxRead _read - #define wxWrite _write - #endif + #else // __MWERKS__ + #define wxRead wxPOSIX_IDENT(read) + #define wxWrite wxPOSIX_IDENT(write) #endif - #if wxHAS_HUGE_FILES - #define wxSeek _lseeki64 - #define wxLseek _lseeki64 - #define wxTell _telli64 - #else - #define wxSeek _lseek - #define wxLseek _lseek - #define wxTell _tell - #endif - #define wxFsync _commit - #if defined(__WATCOMC__) - #define wxEof ::eof - #else - #define wxEof _eof + + #ifdef wxHAS_HUGE_FILES + #define wxSeek wxPOSIX_IDENT(lseeki64) + #define wxLseek wxPOSIX_IDENT(lseeki64) + #define wxTell wxPOSIX_IDENT(telli64) + #else // !wxHAS_HUGE_FILES + #define wxSeek wxPOSIX_IDENT(lseek) + #define wxLseek wxPOSIX_IDENT(lseek) + #define wxTell wxPOSIX_IDENT(tell) + #endif // wxHAS_HUGE_FILES/!wxHAS_HUGE_FILES + + #ifndef __WATCOMC__ + #if !defined(__BORLANDC__) || (__BORLANDC__ > 0x540) + // NB: this one is not POSIX and always has the underscore + #define wxFsync _commit + + #define HAVE_FSYNC + #endif // BORLANDC #endif + #define wxEof wxPOSIX_IDENT(eof) + + // then the functions taking strings #if wxUSE_UNICODE #if wxUSE_UNICODE_MSLU - #define wxOpen wxMSLU__wopen - - #define wxAccess wxMSLU__waccess - #define wxMkDir wxMSLU__wmkdir - #define wxRmDir wxMSLU__wrmdir - #if wxHAS_HUGE_FILES - #define wxStat wxMSLU__wstati64 + // implement the missing file functions in Win9x ourselves + #if defined( __VISUALC__ ) \ + || ( defined(__MINGW32__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \ + || ( defined(__MWERKS__) && defined(__WXMSW__) ) \ + || ( defined(__BORLANDC__) && (__BORLANDC__ > 0x460) ) \ + || defined(__DMC__) + + WXDLLIMPEXP_BASE int wxMSLU__wopen(const wxChar *name, + int flags, int mode); + WXDLLIMPEXP_BASE int wxMSLU__waccess(const wxChar *name, + int mode); + WXDLLIMPEXP_BASE int wxMSLU__wmkdir(const wxChar *name); + WXDLLIMPEXP_BASE int wxMSLU__wrmdir(const wxChar *name); + + WXDLLIMPEXP_BASE int + wxMSLU__wstat(const wxChar *name, wxPOSIX_STRUCT(stat) *buffer); + WXDLLIMPEXP_BASE int + wxMSLU__wstati64(const wxChar *name, + wxPOSIX_STRUCT(stati64) *buffer); + #endif // Windows compilers with MSLU support + + #define wxCRT_Open wxMSLU__wopen + + #define wxCRT_Access wxMSLU__waccess + #define wxCRT_MkDir wxMSLU__wmkdir + #define wxCRT_RmDir wxMSLU__wrmdir + #ifdef wxHAS_HUGE_FILES + #define wxCRT_Stat wxMSLU__wstati64 #else - #define wxStat wxMSLU__wstat + #define wxCRT_Stat wxMSLU__wstat #endif - #else - #define wxOpen _wopen - #define wxAccess _waccess - #define wxMkDir _wmkdir - #define wxRmDir _wrmdir - #if wxHAS_HUGE_FILES - #define wxStat _wstati64 + #else // !wxUSE_UNICODE_MSLU + #ifdef __BORLANDC__ + #if __BORLANDC__ >= 0x550 && __BORLANDC__ <= 0x551 + WXDLLIMPEXP_BASE int wxCRT_Open(const wxChar *pathname, + int flags, mode_t mode); + #else + #define wxCRT_Open _wopen + #endif + #define wxCRT_Access _waccess + #define wxCRT_MkDir _wmkdir + #define wxCRT_RmDir _wrmdir + #ifdef wxHAS_HUGE_FILES + #define wxCRT_Stat _wstati64 + #else + #define wxCRT_Stat _wstat + #endif #else - #define wxStat _wstat + #define wxCRT_Open _wopen + #define wxCRT_Access _waccess + #define wxCRT_MkDir _wmkdir + #define wxCRT_RmDir _wrmdir + #ifdef wxHAS_HUGE_FILES + #define wxCRT_Stat _wstati64 + #else + #define wxCRT_Stat _wstat + #endif #endif - #endif + #endif // wxUSE_UNICODE_MSLU/!wxUSE_UNICODE_MSLU #else // !wxUSE_UNICODE - #ifdef __BORLANDC__ - #define wxOpen open - #else - #define wxOpen _open - #endif - #define wxAccess _access - #define wxMkDir _mkdir - #ifdef __WATCOMC__ - #define wxRmDir rmdir - #else - #define wxRmDir _rmdir - #endif - #if wxHAS_HUGE_FILES - #define wxStat _stati64 + #define wxCRT_Open wxPOSIX_IDENT(open) + #define wxCRT_Access wxPOSIX_IDENT(access) + #define wxCRT_MkDir wxPOSIX_IDENT(mkdir) + #define wxCRT_RmDir wxPOSIX_IDENT(rmdir) + #ifdef wxHAS_HUGE_FILES + #define wxCRT_Stat wxPOSIX_IDENT(stati64) #else - #define wxStat _stat + #define wxCRT_Stat wxPOSIX_IDENT(stat) #endif - #endif + #endif // wxUSE_UNICODE/!wxUSE_UNICODE // 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 + #ifdef wxHAS_HUGE_FILES #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4) #define wxStructStat struct _wstati64 #else @@ -292,7 +348,7 @@ enum wxFileKind #endif // constants (unless already defined by the user code) - #if !defined(__BORLANDC__) && !defined(__WATCOMC__) && !defined(__WXPALMOS__) + #ifdef wxHAS_UNDERSCORES_IN_POSIX_IDENTS #ifndef O_RDONLY #define O_RDONLY _O_RDONLY #define O_WRONLY _O_WRONLY @@ -307,16 +363,33 @@ enum wxFileKind #define S_IFDIR _S_IFDIR #define S_IFREG _S_IFREG #endif + #endif // wxHAS_UNDERSCORES_IN_POSIX_IDENTS + + #ifdef wxHAS_HUGE_FILES + // wxFile is present and supports large files. Currently wxFFile + // doesn't have large file support with any Windows compiler (even + // Win64 ones). + #if wxUSE_FILE + #define wxHAS_LARGE_FILES + #endif #endif - // It's a private define, undefine it so nobody gets tempted to use it + // it's a private define, undefine it so that nobody gets tempted to use it #undef wxHAS_HUGE_FILES -#else // Unix platforms using configure +#else // Unix or Windows using unknown compiler, assume POSIX supported typedef off_t wxFileOffset; #ifdef _LARGE_FILES #define wxFileOffsetFmtSpec wxLongLongFmtSpec wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t), BadFileSizeType ); + // wxFile is present and supports large files + #ifdef wxUSE_FILE + #define wxHAS_LARGE_FILES + #endif + // wxFFile is present and supports large files + #if SIZEOF_LONG == 8 || defined HAVE_FSEEKO + #define wxHAS_LARGE_FFILES + #endif #else #define wxFileOffsetFmtSpec _T("") #endif @@ -329,28 +402,55 @@ enum wxFileKind #define wxFsync fsync #define wxEof eof - #define wxMkDir mkdir - #define wxRmDir rmdir + #define wxCRT_MkDir mkdir + #define wxCRT_RmDir rmdir #define wxTell(fd) lseek(fd, 0, SEEK_CUR) #define wxStructStat struct stat - #if wxUSE_UNICODE - #define wxNEED_WX_UNISTD_H - #if defined(__DMC__) - typedef unsigned long mode_t; - #endif - WXDLLIMPEXP_BASE int wxStat( const wxChar *file_name, wxStructStat *buf ); - WXDLLIMPEXP_BASE int wxAccess( const wxChar *pathname, int mode ); - WXDLLIMPEXP_BASE int wxOpen( const wxChar *pathname, int flags, mode_t mode ); - #else - #define wxOpen open - #define wxStat stat - #define wxAccess access - #endif + #define wxCRT_Open open + #define wxCRT_Stat stat + #define wxCRT_Lstat lstat + #define wxCRT_Access access + + #define wxHAS_NATIVE_LSTAT #endif // platforms +// if the platform doesn't have symlinks, define wxCRT_Lstat to be the same as +// wxCRT_Stat to avoid #ifdefs in the code using it +#ifndef wxHAS_NATIVE_LSTAT + #define wxCRT_Lstat wxCRT_Stat +#endif + +inline int wxAccess(const wxString& path, mode_t mode) + { return wxCRT_Access(path.fn_str(), mode); } +inline int wxOpen(const wxString& path, int flags, mode_t mode) + { return wxCRT_Open(path.fn_str(), flags, mode); } + +// FIXME-CE: provide our own implementations of the missing CRT functions +#ifndef __WXWINCE__ +inline int wxStat(const wxString& path, wxStructStat *buf) + { return wxCRT_Stat(path.fn_str(), buf); } +inline int wxLstat(const wxString& path, wxStructStat *buf) + { return wxCRT_Lstat(path.fn_str(), buf); } +inline int wxRmDir(const wxString& path) + { return wxCRT_RmDir(path.fn_str()); } +#ifdef __WINDOWS__ +inline int wxMkDir(const wxString& path, mode_t WXUNUSED(mode) = 0) + { return wxCRT_MkDir(path.fn_str()); } +#else +inline int wxMkDir(const wxString& path, mode_t mode) + { return wxCRT_MkDir(path.fn_str(), mode); } +#endif +#endif // !__WXWINCE__ + +#ifdef O_BINARY + #define wxO_BINARY O_BINARY +#else + #define wxO_BINARY 0 +#endif + #if defined(__VISAGECPP__) && __IBMCPP__ >= 400 // // VisualAge C++ V4.0 cannot have any external linkage const decs @@ -367,7 +467,7 @@ const int wxInvalidOffset = -1; WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename); // does the path exist? (may have or not '/' or '\\' at the end) -WXDLLIMPEXP_BASE bool wxDirExists(const wxChar *pszPathName); +WXDLLIMPEXP_BASE bool wxDirExists(const wxString& pathName); WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename); @@ -378,15 +478,15 @@ WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path); // Get directory WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path); -// wxString version -WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path); +WXDLLIMPEXP_BASE void wxDos2UnixFilename(char *s); +WXDLLIMPEXP_BASE void wxDos2UnixFilename(wchar_t *s); -WXDLLIMPEXP_BASE void wxDos2UnixFilename(wxChar *s); - -WXDLLIMPEXP_BASE void wxUnix2DosFilename(wxChar *s); +WXDLLIMPEXP_BASE void wxUnix2DosFilename(char *s); +WXDLLIMPEXP_BASE void wxUnix2DosFilename(wchar_t *s); // Strip the extension, in situ -WXDLLIMPEXP_BASE void wxStripExtension(wxChar *buffer); +WXDLLIMPEXP_BASE void wxStripExtension(char *buffer); +WXDLLIMPEXP_BASE void wxStripExtension(wchar_t *buffer); WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer); // Get a temporary filename @@ -394,8 +494,9 @@ WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf); // Expand file name (~/ and ${OPENWINHOME}/ stuff) -WXDLLIMPEXP_BASE wxChar* wxExpandPath(wxChar *dest, const wxChar *path); -WXDLLIMPEXP_BASE bool wxExpandPath(wxString& dest, const wxChar *path); +WXDLLIMPEXP_BASE char* wxExpandPath(char *dest, const wxString& path); +WXDLLIMPEXP_BASE wchar_t* wxExpandPath(wchar_t *dest, const wxString& path); +// FIXME-UTF8: add some wxString version // Contract w.r.t environment ( -> ${OPENWINHOME}/lib) // and make (if under the home tree) relative to home @@ -405,7 +506,10 @@ WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename, const wxString& user = wxEmptyString); // Destructive removal of /./ and /../ stuff -WXDLLIMPEXP_BASE wxChar* wxRealPath(wxChar *path); +// FIXME-UTF8: deprecate these two (and similar) +WXDLLIMPEXP_BASE char* wxRealPath(char *path); +WXDLLIMPEXP_BASE wchar_t* wxRealPath(wchar_t *path); +WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path); // Allocate a copy of the full absolute path WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path); @@ -414,7 +518,7 @@ WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path); // Flags are reserved for future use. #define wxFILE 1 #define wxDIR 2 -WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE); +WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxString& spec, int flags = wxFILE); WXDLLIMPEXP_BASE wxString wxFindNextFile(); // Does the pattern contain wildcards? @@ -436,7 +540,7 @@ 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 @@ -472,6 +576,11 @@ inline bool wxPathExists(const wxChar *pszPathName) } #endif //WXWIN_COMPATIBILITY_2_6 +// permissions; these functions work both on files and directories: +WXDLLIMPEXP_BASE bool wxIsWritable(const wxString &path); +WXDLLIMPEXP_BASE bool wxIsReadable(const wxString &path); +WXDLLIMPEXP_BASE bool wxIsExecutable(const wxString &path); + // ---------------------------------------------------------------------------- // separators in file names // ---------------------------------------------------------------------------- @@ -529,25 +638,29 @@ inline bool wxIsPathSeparator(wxChar c) } // does the string ends with path separator? -WXDLLIMPEXP_BASE bool wxEndsWithPathSeparator(const wxChar *pszFileName); +WXDLLIMPEXP_BASE bool wxEndsWithPathSeparator(const wxString& filename); // split the full path into path (including drive for DOS), name and extension // (understands both '/' and '\\') -WXDLLIMPEXP_BASE void wxSplitPath(const wxChar *pszFileName, +WXDLLIMPEXP_BASE void wxSplitPath(const wxString& fileName, wxString *pstrPath, wxString *pstrName, wxString *pstrExt); // find a file in a list of directories, returns false if not found -WXDLLIMPEXP_BASE bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile); +WXDLLIMPEXP_BASE bool wxFindFileInPath(wxString *pStr, const wxString& szPath, const wxString& szFile); // Get the OS directory if appropriate (such as the Windows directory). // 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. @@ -595,29 +708,34 @@ private: // 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); - void Add(const wxString& path); + // Adds given path to this list + bool 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); + bool EnsureFileAccessible(const wxString& path); -private: - // DECLARE_DYNAMIC_CLASS(wxPathList) +#if WXWIN_COMPATIBILITY_2_6 + // Returns true if the path is in the list + wxDEPRECATED( bool Member(const wxString& path) const ); +#endif }; -#endif - // _WX_FILEFN_H_ +#endif // _WX_FILEFN_H_