///////////////////////////////////////////////////////////////////////////// // Name: wx/filefn.h // Purpose: File- and directory-related functions // Author: Julian Smart // Modified by: // Created: 29/01/98 // RCS-ID: $Id$ // Copyright: (c) 1998 Julian Smart // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _FILEFN_H_ #define _FILEFN_H_ #include "wx/list.h" #include "wx/arrstr.h" #ifndef __WXPALMOS5__ #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 #endif // !__WXPALMOS5__ #ifdef __OS2__ // need to check for __OS2__ first since currently both // __OS2__ and __UNIX__ are defined. #include #include "wx/os2/private.h" #ifdef __WATCOMC__ #include #endif #include #ifdef __EMX__ #include #endif #elif defined(__UNIX__) #include #include #endif #if defined(__WINDOWS__) && !defined(__WXMICROWIN__) #if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__WXWINCE__) && !defined(__CYGWIN__) #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 #ifndef __WXPALMOS5__ #ifndef __WXWINCE__ #include // O_RDONLY &c #endif #endif // !__WXPALMOS5__ // ---------------------------------------------------------------------------- // constants // ---------------------------------------------------------------------------- #if defined(__VISUALC__) || defined(__DIGITALMARS__) typedef int mode_t; #endif #ifdef __WXWINCE__ typedef long off_t; #else // define off_t #if !defined(__WXMAC__) || defined(__UNIX__) || defined(__MACH__) #include #else typedef long off_t; #endif #endif #if (defined(__VISUALC__) && !defined(__WXWINCE__)) || ( defined(__MWERKS__) && defined( __INTEL__) ) typedef _off_t off_t; #elif defined(__SYMANTEC__) typedef long off_t; #elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__) typedef long off_t; #elif defined(__WXPALMOS5__) typedef long off_t; #endif enum wxSeekMode { wxFromStart, wxFromCurrent, 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 // ---------------------------------------------------------------------------- // Wrappers around Win32 api functions like CreateFile, ReadFile and such // Implemented in filefnwce.cpp #if defined( __WXWINCE__) typedef __int64 wxFileOffset; #define wxFileOffsetFmtSpec _("I64") 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 WXDLLIMPEXP_BASE wxFileOffset wxTell(int fd); // always Unicode under WinCE #define wxCRT_MkDir _wmkdir #define wxCRT_RmDir _wrmdir #define wxCRT_Stat _wstat #define wxStructStat struct _stat #elif (defined(__WXMSW__) || defined(__OS2__)) && !defined(__WXPALMOS__) && \ ( \ defined(__VISUALC__) || \ defined(__MINGW64__) || \ (defined(__MINGW32__) && !defined(__WINE__) && \ wxCHECK_W32API_VERSION(0, 5)) || \ defined(__MWERKS__) || \ defined(__DMC__) || \ defined(__WATCOMC__) || \ defined(__BORLANDC__) \ ) #undef wxHAS_HUGE_FILES // detect compilers which have support for huge files #if defined(__VISUALC__) #define wxHAS_HUGE_FILES 1 #elif defined(__MINGW32__) || defined(__MINGW64__) #define wxHAS_HUGE_FILES 1 #elif defined(_LARGE_FILES) #define wxHAS_HUGE_FILES 1 #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 // types #ifdef wxHAS_HUGE_FILES typedef wxLongLong_t wxFileOffset; #define wxFileOffsetFmtSpec wxLongLongFmtSpec #else typedef off_t wxFileOffset; #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 // 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 dropped since OW 1.4 "for consistency across platforms". // // Borland is also special in that it uses _stat with Unicode functions // (for MSVC compatibility?) but stat with ANSI ones #ifdef __BORLANDC__ #if wxHAS_HUGE_FILES #define wxStructStat struct stati64 #else #if wxUSE_UNICODE #define wxStructStat struct _stat #else #define wxStructStat struct stat #endif #endif #else // !__BORLANDC__ #ifdef 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 && wxONLY_WATCOM_EARLIER_THAN(1,4) #define wxStructStat struct _wstat #else #define wxStructStat struct _stat #endif #endif #endif // __BORLANDC__/!__BORLANDC__ // 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__) || defined(__MINGW64__) #define wxPOSIX_IDENT(func) ::func #else // by default assume MSVC-compatible names #define wxPOSIX_IDENT(func) _ ## func #define wxHAS_UNDERSCORES_IN_POSIX_IDENTS #endif // first functions not working with strings, i.e. without ANSI/Unicode // complications #define wxClose wxPOSIX_IDENT(close) #if defined(__MWERKS__) #if __MSL__ >= 0x6000 #define wxRead(fd, buf, nCount) _read(fd, (void *)buf, nCount) #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount) #else #define wxRead(fd, buf, nCount)\ _read(fd, (const char *)buf, nCount) #define wxWrite(fd, buf, nCount)\ _write(fd, (const char *)buf, nCount) #endif #else // __MWERKS__ #define wxRead wxPOSIX_IDENT(read) #define wxWrite wxPOSIX_IDENT(write) #endif #ifdef wxHAS_HUGE_FILES #ifndef __MINGW64__ #define wxSeek wxPOSIX_IDENT(lseeki64) #define wxLseek wxPOSIX_IDENT(lseeki64) #define wxTell wxPOSIX_IDENT(telli64) #else // unfortunately, mingw-W64 is somewhat inconsistent... #define wxSeek _lseeki64 #define wxLseek _lseeki64 #define wxTell _telli64 #endif #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 // could be already defined by configure (Cygwin) #ifndef HAVE_FSYNC #define HAVE_FSYNC #endif #endif // BORLANDC #endif #define wxEof wxPOSIX_IDENT(eof) // then the functions taking strings #if wxUSE_UNICODE #if wxUSE_UNICODE_MSLU // 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); #ifdef wxHAS_HUGE_FILES WXDLLIMPEXP_BASE int wxMSLU__wstati64(const wxChar *name, wxStructStat *buffer); #else // !wxHAS_HUGE_FILES WXDLLIMPEXP_BASE int wxMSLU__wstat(const wxChar *name, wxStructStat *buffer); #endif // wxHAS_HUGE_FILES/!wxHAS_HUGE_FILES #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 wxCRT_Stat wxMSLU__wstat #endif #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 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 // wxUSE_UNICODE_MSLU/!wxUSE_UNICODE_MSLU #else // !wxUSE_UNICODE #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 // Unfortunately Watcom is not consistent, so:- #if defined(__OS2__) && defined(__WATCOMC__) #define wxCRT_Stat _stat #else #define wxCRT_Stat wxPOSIX_IDENT(stat) #endif #endif #endif // wxUSE_UNICODE/!wxUSE_UNICODE // constants (unless already defined by the user code) #ifdef wxHAS_UNDERSCORES_IN_POSIX_IDENTS #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 #ifndef S_IFMT #define S_IFMT _S_IFMT #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 that nobody gets tempted to use it #undef wxHAS_HUGE_FILES #elif defined (__WXPALMOS__) 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 #define wxClose close #define wxRead ::read #define wxWrite ::write #define wxLseek lseek #define wxSeek lseek #define wxFsync fsync #define wxEof eof #define wxCRT_MkDir mkdir #define wxCRT_RmDir rmdir #define wxTell(fd) lseek(fd, 0, SEEK_CUR) #define wxStructStat struct stat #define wxCRT_Open open #define wxCRT_Stat svfs_stat #define wxCRT_Lstat lstat #define wxCRT_Access access #define wxHAS_NATIVE_LSTAT #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 // functions #define wxClose close #define wxRead ::read #define wxWrite ::write #define wxLseek lseek #define wxSeek lseek #define wxFsync fsync #define wxEof eof #define wxCRT_MkDir mkdir #define wxCRT_RmDir rmdir #define wxTell(fd) lseek(fd, 0, SEEK_CUR) #define wxStructStat struct stat #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()); } #if defined(__WINDOWS__) || (defined(__OS2__) && defined(__WATCOMC__)) 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 // in headers included by more than one primary source // extern const int wxInvalidOffset; #else const int wxInvalidOffset = -1; #endif // ---------------------------------------------------------------------------- // functions // ---------------------------------------------------------------------------- WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename); // does the path exist? (may have or not '/' or '\\' at the end) WXDLLIMPEXP_BASE bool wxDirExists(const wxString& pathName); WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename); // Get filename WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path); WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path); // Get directory WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path); // all deprecated functions below are deprecated in favour of wxFileName's methods #if WXWIN_COMPATIBILITY_2_8 wxDEPRECATED( WXDLLIMPEXP_BASE void wxDos2UnixFilename(char *s) ); wxDEPRECATED( WXDLLIMPEXP_BASE void wxDos2UnixFilename(wchar_t *s) ); wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE void wxUnix2DosFilename(char *s) ); wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE void wxUnix2DosFilename(wchar_t *s) ); // Strip the extension, in situ // Deprecated in favour of wxFileName::StripExtension() but notice that their // behaviour is slightly different, see the manual wxDEPRECATED( WXDLLIMPEXP_BASE void wxStripExtension(char *buffer) ); wxDEPRECATED( WXDLLIMPEXP_BASE void wxStripExtension(wchar_t *buffer) ); wxDEPRECATED( WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer) ); // Get a temporary filename wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = NULL) ); wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf) ); // Expand file name (~/ and ${OPENWINHOME}/ stuff) wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE char* wxExpandPath(char *dest, const wxString& path) ); wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE wchar_t* wxExpandPath(wchar_t *dest, const wxString& path) ); // DEPRECATED: use wxFileName::Normalize(wxPATH_NORM_ENV_VARS) // Contract w.r.t environment ( -> ${OPENWINHOME}/lib) // and make (if under the home tree) relative to home // [caller must copy-- volatile] wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename, const wxString& envname = wxEmptyString, const wxString& user = wxEmptyString) ); // DEPRECATED: use wxFileName::ReplaceEnvVariable and wxFileName::ReplaceHomeDir // Destructive removal of /./ and /../ stuff wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE char* wxRealPath(char *path) ); wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE wchar_t* wxRealPath(wchar_t *path) ); wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path) ); // DEPRECATED: use wxFileName::Normalize instead // Allocate a copy of the full absolute path wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path) ); // DEPRECATED: use wxFileName::MakeAbsolute instead #endif // Get first file name matching given wild card. // Flags are reserved for future use. #define wxFILE 1 #define wxDIR 2 WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxString& spec, int flags = wxFILE); WXDLLIMPEXP_BASE wxString wxFindNextFile(); // Does the pattern contain wildcards? 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 // `hidden' dot files) WXDLLIMPEXP_BASE bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = true); // Concatenate two files to form third WXDLLIMPEXP_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3); // Copy file1 to file2 WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2, bool overwrite = true); // Remove file WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file); // Rename file 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! wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = 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 WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d); // Make directory 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 wxDEPRECATED( inline bool wxPathExists(const wxChar *pszPathName) ); inline bool wxPathExists(const wxChar *pszPathName) { return wxDirExists(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 // ---------------------------------------------------------------------------- // between file name and extension #define wxFILE_SEP_EXT wxT('.') // between drive/volume name and the path #define wxFILE_SEP_DSK wxT(':') // between the path components #define wxFILE_SEP_PATH_DOS wxT('\\') #define wxFILE_SEP_PATH_UNIX wxT('/') #define wxFILE_SEP_PATH_MAC wxT(':') #define wxFILE_SEP_PATH_VMS wxT('.') // VMS also uses '[' and ']' // separator in the path list (as in PATH environment variable) // there is no PATH variable in Classic Mac OS so just use the // semicolon (it must be different from the file name separator) // NB: these are strings and not characters on purpose! #define wxPATH_SEP_DOS wxT(";") #define wxPATH_SEP_UNIX wxT(":") #define wxPATH_SEP_MAC wxT(";") // platform independent versions #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(__WXPALMOS__) #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 #else // Windows and OS/2 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS #define wxPATH_SEP wxPATH_SEP_DOS #endif // Unix/Windows // this is useful for wxString::IsSameAs(): to compare two file names use // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE) #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 #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(__OS2__) )|| defined(__MAC__) return c == wxFILE_SEP_PATH; #else return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX; #endif } // does the string ends with path separator? WXDLLIMPEXP_BASE bool wxEndsWithPathSeparator(const wxString& filename); #if WXWIN_COMPATIBILITY_2_8 // split the full path into path (including drive for DOS), name and extension // (understands both '/' and '\\') wxDEPRECATED( WXDLLIMPEXP_BASE void wxSplitPath(const wxString& fileName, wxString *pstrPath, wxString *pstrName, wxString *pstrExt) ); #endif // find a file in a list of directories, returns false if not found 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. // 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 // ---------------------------------------------------------------------------- #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 wxArrayString { public: wxPathList() {} wxPathList(const wxArrayString &arr) { Add(arr); } // Adds all paths in environment variable void AddEnvList(const wxString& envVariable); // 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) 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) const; // Given full path and filename, add path to list bool EnsureFileAccessible(const wxString& path); #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_