X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/371a5b4e62eb415107e045588f614fa49e866e78..72fcdc75707ff37c8226638a581d5a263d899b3e:/include/wx/filefn.h diff --git a/include/wx/filefn.h b/include/wx/filefn.h index 567a8d050d..ed79380973 100644 --- a/include/wx/filefn.h +++ b/include/wx/filefn.h @@ -12,16 +12,86 @@ #ifndef _FILEFN_H_ #define _FILEFN_H_ -#if defined(__GNUG__) && !defined(__APPLE__) +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "filefn.h" #endif #include "wx/list.h" +#include "wx/arrstr.h" -#ifndef __WXWINCE__ -#include +#ifdef __WXWINCE__ + #include "wx/msw/wince/time.h" + #include "wx/msw/private.h" +#else + #include +#endif + +#ifdef __WXWINCE__ +// Nothing +#elif !defined(__MWERKS__) + #include + #include +#else + #ifdef __MACH__ + #include + #include + #include + #include + #else + #include + #include + #include + #endif +#endif + +#ifdef __OS2__ +// need to check for __OS2__ first since currently both +// __OS2__ and __UNIX__ are defined. + #include + #include "wx/os2/private.h" + #include + #ifdef __EMX__ + #include + #endif +#elif defined(__UNIX__) + #include + #include +#endif + +#if defined(__WINDOWS__) && !defined(__WXMICROWIN__) +#if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__SALFORDC__) && !defined(__WXWINCE__) + #include + #include + #include +#endif // __WINDOWS__ +#endif // native Win compiler + +#if defined(__DOS__) + #ifdef __WATCOMC__ + #include + #include + #include + #endif + #ifdef __DJGPP__ + #include + #include + #endif +#endif + +#ifdef __BORLANDC__ // Please someone tell me which version of Borland needs + // this (3.1 I believe) and how to test for it. + // If this works for Borland 4.0 as well, then no worries. + #include +#endif + +#ifdef __SALFORDC__ + #include + #include #endif +#ifndef __WXWINCE__ + #include // O_RDONLY &c +#endif // ---------------------------------------------------------------------------- // constants // ---------------------------------------------------------------------------- @@ -29,26 +99,22 @@ #ifdef __WXWINCE__ typedef long off_t; #else - -// define off_t -#if !defined(__WXMAC__) || defined(__UNIX__) - #include -#else - typedef long off_t; + // define off_t + #if !defined(__WXMAC__) || defined(__UNIX__) || defined(__MACH__) + #include + #else + typedef long off_t; + #endif #endif #if defined(__VISUALC__) || ( defined(__MWERKS__) && defined( __INTEL__) ) typedef _off_t off_t; -#elif defined(__BORLANDC__) && defined(__WIN16__) - typedef long off_t; -#elif defined(__SC__) +#elif defined(__SYMANTEC__) typedef long off_t; -#elif defined(__MWERKS__) && !defined(__INTEL__) +#elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__) typedef long off_t; #endif -#endif - #if defined(__VISAGECPP__) && __IBMCPP__ >= 400 // // VisualAge C++ V4.0 cannot have any external linkage const decs @@ -66,71 +132,200 @@ enum wxSeekMode wxFromEnd }; -WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString; - // ---------------------------------------------------------------------------- // declare our versions of low level file functions: some compilers prepend // underscores to the usual names, some also have Unicode versions of them // ---------------------------------------------------------------------------- +// Wrappers around Win32 api functions like CreateFile, ReadFile and such +// Implemented in filefnwce.cpp +#if defined( __WINCE__) + 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); + #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 + #define wxStructStat struct _stat + // Microsoft compiler loves underscores, feed them to it -#if defined( __VISUALC__ ) \ +#elif defined( __VISUALC__ ) \ || ( defined(__MINGW32__) && !defined(__WINE__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \ - || ( defined(__MWERKS__) && defined(__WXMSW__) ) + || ( defined(__MWERKS__) && defined(__WXMSW__) ) \ + || ( defined(__DMC__) && defined(__WXMSW__) ) \ + || ( defined(__WATCOMC__) && defined(__WXMSW__) ) + + // Not all of the Win32 compilers do have huge file support, for example + // the Digitalmars compiler does not have huge file size support + #include "wx/msw/private.h" + + #undef __HUGEFILES_SUPPORTED + #if _INTEGRAL_MAX_BITS >= 64 && !defined(__DMC__) + #define __HUGEFILES_SUPPORTED 1 + #else + #define __HUGEFILES_SUPPORTED 0 + #endif + // functions + #if defined(__BORLANDC__) || defined(__WATCOMC__) + #define _tell tell + #endif + + #if __HUGEFILES_SUPPORTED + typedef wxLongLong_t wxFileOffset; + #define wxFileOffsetFmtSpec wxLongLongFmtSpec + #else + typedef off_t wxFileOffset; + #define wxFileOffsetFmtSpec _("") + #endif + #define wxClose _close - #define wxRead _read - #define wxWrite _write - #define wxLseek _lseek + + #if defined(__MWERKS__) + #if __MSL__ >= 0x6000 + #define wxRead _read(fd, (void *)buf, nCount) + #define wxWrite _write(fd, (void *)buf, nCount) + #else + #define wxRead _read(fd, (const char *)buf, nCount) + #define wxWrite _write(fd, (const char *)buf, nCount) + #endif + #else + #ifdef __DMC__ + #define wxRead ::read + #define wxWrite ::write + #else + #define wxRead _read + #define wxWrite _write + #endif + #endif + #if __HUGEFILES_SUPPORTED + #define wxSeek _lseeki64 + #define wxLseek _lseeki64 + #define wxTell _telli64 + #else + #define wxSeek _lseek + #define wxLseek _lseek + #define wxTell _tell + #endif #define wxFsync _commit #define wxEof _eof - #define wxTell _tell - #if wxUSE_UNICODE #if wxUSE_UNICODE_MSLU #define wxOpen wxMSLU__wopen + #define wxAccess wxMSLU__waccess #define wxMkDir wxMSLU__wmkdir #define wxRmDir wxMSLU__wrmdir - #define wxStat wxMSLU__wstat + #if __HUGEFILES_SUPPORTED + #define wxStat wxMSLU__wstati64 + #else + #define wxStat wxMSLU__wstat + #endif #else #define wxOpen _wopen #define wxAccess _waccess #define wxMkDir _wmkdir #define wxRmDir _wrmdir - #define wxStat _wstat + #if __HUGEFILES_SUPPORTED + #define wxStat _wstati64 + #else + #define wxStat _wstat + #endif #endif #else // !wxUSE_UNICODE - #define wxOpen _open + #ifdef __BORLANDC__ + #define wxOpen open + #else + #define wxOpen _open + #endif #define wxAccess _access #define wxMkDir _mkdir - #define wxRmDir _rmdir - #define wxStat _stat + #ifdef __WATCOMC__ + #define wxRmDir rmdir + #else + #define wxRmDir _rmdir + #endif + #if __HUGEFILES_SUPPORTED + #define wxStat _stati64 + #else + #define wxStat _stat + #endif #endif - // types - #define wxStructStat struct _stat + // 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__) + #define wxStructStat struct _wstati64 + #else + #define wxStructStat struct _stati64 + #endif + #else + #if wxUSE_UNICODE && defined(__WATCOMC__) + #define wxStructStat struct _wstat + #else + #define wxStructStat struct _stat + #endif + #endif // constants (unless already defined by the user code) - #ifndef O_RDONLY + #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__) #define S_IFMT _S_IFMT #define S_IFDIR _S_IFDIR #define S_IFREG _S_IFREG #endif // O_RDONLY + + // It's a private define, undefine it so nobody gets tempted to use it + #undef __HUGEFILES_SUPPORTED #else + typedef off_t wxFileOffset; + #ifdef _LARGE_FILES + #define wxFileOffsetFmtSpec wxLongLongFmtSpec + #else + #define wxFileOffsetFmtSpec _T("") + #endif // functions #define wxClose close - #define wxRead read - #define wxWrite write + #define wxRead ::read + #define wxWrite ::write #define wxLseek lseek + #define wxSeek lseek #define wxFsync commit #define wxEof eof @@ -140,129 +335,122 @@ WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString; #define wxTell(fd) lseek(fd, 0, SEEK_CUR) #define wxStructStat struct stat - -#if wxUSE_UNICODE -# define wxNEED_WX_UNISTD_H -WXDLLEXPORT int wxStat( const wxChar *file_name, wxStructStat *buf ); -WXDLLEXPORT int wxAccess( const wxChar *pathname, int mode ); -WXDLLEXPORT int wxOpen( const wxChar *pathname, int flags, mode_t mode ); -#else - #define wxOpen open - #define wxStat stat - #define wxAccess access -#endif + + #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 #endif // VC++ // ---------------------------------------------------------------------------- // functions // ---------------------------------------------------------------------------- -WXDLLEXPORT bool wxFileExists(const wxString& filename); +WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename); // does the path exist? (may have or not '/' or '\\' at the end) -WXDLLEXPORT bool wxPathExists(const wxChar *pszPathName); +WXDLLIMPEXP_BASE bool wxPathExists(const wxChar *pszPathName); -WXDLLEXPORT bool wxIsAbsolutePath(const wxString& filename); +WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename); // Get filename -WXDLLEXPORT wxChar* wxFileNameFromPath(wxChar *path); -WXDLLEXPORT wxString wxFileNameFromPath(const wxString& path); +WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path); +WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path); // Get directory -WXDLLEXPORT wxString wxPathOnly(const wxString& path); +WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path); // wxString version -WXDLLEXPORT wxString wxRealPath(const wxString& path); +WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path); -WXDLLEXPORT void wxDos2UnixFilename(wxChar *s); +WXDLLIMPEXP_BASE void wxDos2UnixFilename(wxChar *s); -WXDLLEXPORT void wxUnix2DosFilename(wxChar *s); +WXDLLIMPEXP_BASE void wxUnix2DosFilename(wxChar *s); // Strip the extension, in situ -WXDLLEXPORT void wxStripExtension(wxChar *buffer); -WXDLLEXPORT void wxStripExtension(wxString& buffer); +WXDLLIMPEXP_BASE void wxStripExtension(wxChar *buffer); +WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer); // Get a temporary filename -WXDLLEXPORT wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL); -WXDLLEXPORT bool wxGetTempFileName(const wxString& prefix, wxString& buf); +WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL); +WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf); // Expand file name (~/ and ${OPENWINHOME}/ stuff) -WXDLLEXPORT wxChar* wxExpandPath(wxChar *dest, const wxChar *path); -WXDLLEXPORT bool wxExpandPath(wxString& dest, const wxChar *path); +WXDLLIMPEXP_BASE wxChar* wxExpandPath(wxChar *dest, const wxChar *path); +WXDLLIMPEXP_BASE bool wxExpandPath(wxString& dest, const wxChar *path); // Contract w.r.t environment ( -> ${OPENWINHOME}/lib) // and make (if under the home tree) relative to home // [caller must copy-- volatile] -WXDLLEXPORT wxChar* wxContractPath(const wxString& filename, +WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename, const wxString& envname = wxEmptyString, const wxString& user = wxEmptyString); // Destructive removal of /./ and /../ stuff -WXDLLEXPORT wxChar* wxRealPath(wxChar *path); +WXDLLIMPEXP_BASE wxChar* wxRealPath(wxChar *path); // Allocate a copy of the full absolute path -WXDLLEXPORT wxChar* wxCopyAbsolutePath(const wxString& path); +WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path); // Get first file name matching given wild card. // Flags are reserved for future use. #define wxFILE 1 #define wxDIR 2 -WXDLLEXPORT wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE); -WXDLLEXPORT wxString wxFindNextFile(); +WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE); +WXDLLIMPEXP_BASE wxString wxFindNextFile(); // Does the pattern contain wildcards? -WXDLLEXPORT bool wxIsWild(const wxString& pattern); +WXDLLIMPEXP_BASE bool wxIsWild(const wxString& pattern); // Does the pattern match the text (usually a filename)? -// If dot_special is TRUE, doesn't match * against . (eliminating +// If dot_special is true, doesn't match * against . (eliminating // `hidden' dot files) -WXDLLEXPORT bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = TRUE); +WXDLLIMPEXP_BASE bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = true); // Concatenate two files to form third -WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3); +WXDLLIMPEXP_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3); // Copy file1 to file2 -WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2, - bool overwrite = TRUE); +WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2, + bool overwrite = true); // Remove file -WXDLLEXPORT bool wxRemoveFile(const wxString& file); +WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file); // Rename file -WXDLLEXPORT bool wxRenameFile(const wxString& file1, const wxString& file2); +WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2); // Get current working directory. // 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! -WXDLLEXPORT wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000); +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 -WXDLLEXPORT wxString wxGetCwd(); +WXDLLIMPEXP_BASE wxString wxGetCwd(); // Set working directory -WXDLLEXPORT bool wxSetWorkingDirectory(const wxString& d); +WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d); // Make directory -WXDLLEXPORT bool wxMkdir(const wxString& dir, int perm = 0777); +WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = 0777); // Remove directory. Flags reserved for future use. -WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0); +WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0); // compatibility defines, don't use in new code #define wxDirExists wxPathExists -#if WXWIN_COMPATIBILITY_2 - #define FileExists wxFileExists - #define DirExists wxDirExists - #define IsAbsolutePath wxIsAbsolutePath - #define FileNameFromPath wxFileNameFromPath - #define PathOnly wxPathOnly - #define Dos2UnixFilename wxDos2UnixFilename - #define Unix2DosFilename wxUnix2DosFilename -#endif - // ---------------------------------------------------------------------------- // separators in file names // ---------------------------------------------------------------------------- @@ -288,15 +476,13 @@ WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0); #define wxPATH_SEP_MAC wxT(";") // platform independent versions -#if defined(__UNIX__) && !defined(__CYGWIN__) +#if defined(__UNIX__) && !defined(__OS2__) + // CYGWIN also uses UNIX settings #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX #define wxPATH_SEP wxPATH_SEP_UNIX #elif defined(__MAC__) #define wxFILE_SEP_PATH wxFILE_SEP_PATH_MAC #define wxPATH_SEP wxPATH_SEP_MAC -#elif defined(__CYGWIN__) // Cygwin - #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS - #define wxPATH_SEP wxPATH_SEP_UNIX #else // Windows and OS/2 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS #define wxPATH_SEP wxPATH_SEP_DOS @@ -304,17 +490,17 @@ WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0); // this is useful for wxString::IsSameAs(): to compare two file names use // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE) -#if defined(__UNIX__) && !defined(__DARWIN__) - #define wxARE_FILENAMES_CASE_SENSITIVE TRUE +#if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__) + #define wxARE_FILENAMES_CASE_SENSITIVE true #else // Windows, Mac OS and OS/2 - #define wxARE_FILENAMES_CASE_SENSITIVE FALSE + #define wxARE_FILENAMES_CASE_SENSITIVE false #endif // Unix/Windows // is the char a path separator? inline bool wxIsPathSeparator(wxChar c) { // under DOS/Windows we should understand both Unix and DOS file separators -#if defined(__UNIX__) || defined(__MAC__) +#if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__) return c == wxFILE_SEP_PATH; #else return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX; @@ -322,39 +508,47 @@ inline bool wxIsPathSeparator(wxChar c) } // does the string ends with path separator? -WXDLLEXPORT bool wxEndsWithPathSeparator(const wxChar *pszFileName); +WXDLLIMPEXP_BASE bool wxEndsWithPathSeparator(const wxChar *pszFileName); // split the full path into path (including drive for DOS), name and extension // (understands both '/' and '\\') -WXDLLEXPORT void wxSplitPath(const wxChar *pszFileName, +WXDLLIMPEXP_BASE void wxSplitPath(const wxChar *pszFileName, wxString *pstrPath, wxString *pstrName, wxString *pstrExt); // find a file in a list of directories, returns false if not found -WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile); +WXDLLIMPEXP_BASE bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile); // Get the OS directory if appropriate (such as the Windows directory). // On non-Windows platform, probably just return the empty string. -WXDLLEXPORT wxString wxGetOSDirectory(); +WXDLLIMPEXP_BASE wxString wxGetOSDirectory(); // Get file modification time -WXDLLEXPORT time_t wxFileModificationTime(const wxString& filename); +WXDLLIMPEXP_BASE time_t wxFileModificationTime(const wxString& filename); + +// 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. +// wildCard is in the form: +// "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png" +WXDLLIMPEXP_BASE int wxParseCommonDialogsFilter(const wxString& wildCard, wxArrayString& descriptions, wxArrayString& filters); // ---------------------------------------------------------------------------- // classes // ---------------------------------------------------------------------------- // Path searching -class WXDLLEXPORT wxPathList : public wxStringList +class WXDLLIMPEXP_BASE wxPathList : public wxStringList { public: + // avoid GCC warning about virtual functions w/o virtual dtor + virtual ~wxPathList() {} + // Adds all paths in environment variable void AddEnvList(const wxString& envVariable); void Add(const wxString& path); - // Avoid compiler warning - wxNode *Add(const wxChar *s) { return wxStringList::Add(s); } // Find the first full path for which the file exists wxString FindValidPath(const wxString& filename); // Find the first full path for which the file exists; ensure it's an @@ -362,11 +556,11 @@ public: wxString FindAbsoluteValidPath(const wxString& filename); // Given full path and filename, add path to list void EnsureFileAccessible(const wxString& path); - // Returns TRUE if the path is in the list + // Returns true if the path is in the list bool Member(const wxString& path); private: - DECLARE_DYNAMIC_CLASS(wxPathList) + // DECLARE_DYNAMIC_CLASS(wxPathList) }; #endif