1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: File- and directory-related functions
4 // Author: Julian Smart
8 // Copyright: (c) 1998 Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
16 #include "wx/arrstr.h"
19 #include "wx/msw/wince/time.h"
20 #include "wx/msw/private.h"
27 #elif !defined(__MWERKS__)
28 #include <sys/types.h>
32 #include <sys/types.h>
44 // need to check for __OS2__ first since currently both
45 // __OS2__ and __UNIX__ are defined.
47 #include "wx/os2/private.h"
55 #elif defined(__UNIX__)
60 #if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
61 #if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__SALFORDC__) && !defined(__WXWINCE__) && !defined(__CYGWIN__)
66 #endif // native Win compiler
80 #ifdef __BORLANDC__ // Please someone tell me which version of Borland needs
81 // this (3.1 I believe) and how to test for it.
82 // If this works for Borland 4.0 as well, then no worries.
92 #include <fcntl.h> // O_RDONLY &c
94 // ----------------------------------------------------------------------------
96 // ----------------------------------------------------------------------------
102 #if !defined(__WXMAC__) || defined(__UNIX__) || defined(__MACH__)
103 #include <sys/types.h>
109 #if (defined(__VISUALC__) && !defined(__WXWINCE__)) || ( defined(__MWERKS__) && defined( __INTEL__) )
110 typedef _off_t off_t
;
111 #elif defined(__SYMANTEC__)
113 #elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__)
127 wxFILE_KIND_DISK
, // a file supporting seeking to arbitrary offsets
128 wxFILE_KIND_TERMINAL
, // a tty
129 wxFILE_KIND_PIPE
// a pipe
132 // ----------------------------------------------------------------------------
133 // declare our versions of low level file functions: some compilers prepend
134 // underscores to the usual names, some also have Unicode versions of them
135 // ----------------------------------------------------------------------------
137 // Wrappers around Win32 api functions like CreateFile, ReadFile and such
138 // Implemented in filefnwce.cpp
139 #if defined( __WXWINCE__)
140 typedef __int64 wxFileOffset
;
141 #define wxFileOffsetFmtSpec _("I64")
142 int wxOpen(const wxChar
*filename
, int oflag
, int WXUNUSED(pmode
));
143 int wxAccess(const wxChar
*name
, int WXUNUSED(how
));
145 int wxFsync(int WXUNUSED(fd
));
146 int wxRead(int fd
, void *buf
, unsigned int count
);
147 int wxWrite(int fd
, const void *buf
, unsigned int count
);
149 wxFileOffset
wxSeek(int fd
, wxFileOffset offset
, int origin
);
150 #define wxLSeek wxSeek
151 wxFileOffset
wxTell(int fd
);
153 // always Unicode under WinCE
154 #define wxMkDir _wmkdir
155 #define wxRmDir _wrmdir
156 #define wxStat _wstat
157 #define wxStructStat struct _stat
158 #elif defined(__WXMSW__) && !defined(__WXPALMOS__) && \
160 defined(__VISUALC__) || \
161 (defined(__MINGW32__) && !defined(__WINE__) && \
162 wxCHECK_W32API_VERSION(0, 5)) || \
163 defined(__MWERKS__) || \
164 defined(__DMC__) || \
165 defined(__WATCOMC__) || \
166 defined(__BORLANDC__) \
169 #undef wxHAS_HUGE_FILES
171 // detect compilers which have support for huge files
172 #if defined(__VISUALC__)
173 #define wxHAS_HUGE_FILES 1
174 #elif defined(__MINGW32__)
175 #define wxHAS_HUGE_FILES 1
176 #elif defined(_LARGE_FILES)
177 #define wxHAS_HUGE_FILES 1
180 // other Windows compilers (DMC, Watcom, Metrowerks and Borland) don't have
181 // huge file support (or at least not all functions needed for it by wx)
184 #ifdef wxHAS_HUGE_FILES
185 typedef wxLongLong_t wxFileOffset
;
186 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
188 typedef off_t wxFileOffset
;
194 // MSVC and compatible compilers prepend underscores to the POSIX function
195 // names, other compilers don't and even if their later versions usually do
196 // define the versions with underscores for MSVC compatibility, it's better
197 // to avoid using them as they're not present in earlier versions and
198 // always using the native functions spelling is easier than testing for
200 #if defined(__BORLANDC__) || defined(__DMC__) || defined(__WATCOMC__)
201 #define wxPOSIX_IDENT(func) ::func
202 #else // by default assume MSVC-compatible names
203 #define wxPOSIX_IDENT(func) _ ## func
204 #define wxHAS_UNDERSCORES_IN_POSIX_IDENTS
208 // first functions not working with strings, i.e. without ANSI/Unicode
210 #define wxClose wxPOSIX_IDENT(close)
212 #if defined(__MWERKS__)
213 #if __MSL__ >= 0x6000
214 #define wxRead(fd, buf, nCount) _read(fd, (void *)buf, nCount)
215 #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)
217 #define wxRead(fd, buf, nCount)\
218 _read(fd, (const char *)buf, nCount)
219 #define wxWrite(fd, buf, nCount)\
220 _write(fd, (const char *)buf, nCount)
223 #define wxRead wxPOSIX_IDENT(read)
224 #define wxWrite wxPOSIX_IDENT(write)
227 #ifdef wxHAS_HUGE_FILES
228 #define wxSeek wxPOSIX_IDENT(lseeki64)
229 #define wxLseek wxPOSIX_IDENT(lseeki64)
230 #define wxTell wxPOSIX_IDENT(telli64)
231 #else // !wxHAS_HUGE_FILES
232 #define wxSeek wxPOSIX_IDENT(lseek)
233 #define wxLseek wxPOSIX_IDENT(lseek)
234 #define wxTell wxPOSIX_IDENT(tell)
235 #endif // wxHAS_HUGE_FILES/!wxHAS_HUGE_FILES
238 // NB: this one is not POSIX and always has the underscore
239 #define wxFsync _commit
244 #define wxEof wxPOSIX_IDENT(eof)
246 // then the functions taking strings
248 #if wxUSE_UNICODE_MSLU
249 // implement the missing file functions in Win9x ourselves
250 #if defined( __VISUALC__ ) \
251 || ( defined(__MINGW32__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
252 || ( defined(__MWERKS__) && defined(__WXMSW__) ) \
253 || ( defined(__BORLANDC__) && (__BORLANDC__ > 0x460) ) \
256 WXDLLIMPEXP_BASE
int wxMSLU__wopen(const wxChar
*name
,
257 int flags
, int mode
);
258 WXDLLIMPEXP_BASE
int wxMSLU__waccess(const wxChar
*name
,
260 WXDLLIMPEXP_BASE
int wxMSLU__wmkdir(const wxChar
*name
);
261 WXDLLIMPEXP_BASE
int wxMSLU__wrmdir(const wxChar
*name
);
264 wxMSLU__wstat(const wxChar
*name
,
265 struct wxPOSIX_IDENT(stat
) *buffer
);
267 wxMSLU__wstati64(const wxChar
*name
,
268 struct wxPOSIX_IDENT(stati64
) *buffer
);
269 #endif // Windows compilers with MSLU support
271 #define wxOpen wxMSLU__wopen
273 #define wxAccess wxMSLU__waccess
274 #define wxMkDir wxMSLU__wmkdir
275 #define wxRmDir wxMSLU__wrmdir
276 #ifdef wxHAS_HUGE_FILES
277 #define wxStat wxMSLU__wstati64
279 #define wxStat wxMSLU__wstat
281 #else // !wxUSE_UNICODE_MSLU
283 #define wxOpen _wopen
284 #define wxAccess _waccess
285 #define wxMkDir _mkdir
286 #define wxRmDir _rmdir
287 #ifdef wxHAS_HUGE_FILES
288 #define wxStat _wstati64
290 #define wxStat _wstat
293 #define wxOpen _wopen
294 #define wxAccess _waccess
295 #define wxMkDir _wmkdir
296 #define wxRmDir _wrmdir
297 #ifdef wxHAS_HUGE_FILES
298 #define wxStat _wstati64
300 #define wxStat _wstat
303 #endif // wxUSE_UNICODE_MSLU/!wxUSE_UNICODE_MSLU
304 #else // !wxUSE_UNICODE
305 #define wxOpen wxPOSIX_IDENT(open)
306 #define wxAccess wxPOSIX_IDENT(access)
307 #define wxMkDir wxPOSIX_IDENT(mkdir)
308 #define wxRmDir wxPOSIX_IDENT(rmdir)
309 #ifdef wxHAS_HUGE_FILES
310 #define wxStat wxPOSIX_IDENT(stati64)
312 #define wxStat wxPOSIX_IDENT(stat)
314 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
316 // Types: Notice that Watcom is the only compiler to have a wide char
317 // version of struct stat as well as a wide char stat function variant.
318 // This was droped since OW 1.4 "for consistency across platforms".
319 #ifdef wxHAS_HUGE_FILES
320 #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
321 #define wxStructStat struct _wstati64
323 #define wxStructStat struct _stati64
326 #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
327 #define wxStructStat struct _wstat
329 #define wxStructStat struct _stat
333 // constants (unless already defined by the user code)
334 #ifdef wxHAS_UNDERSCORES_IN_POSIX_IDENTS
336 #define O_RDONLY _O_RDONLY
337 #define O_WRONLY _O_WRONLY
338 #define O_RDWR _O_RDWR
339 #define O_EXCL _O_EXCL
340 #define O_CREAT _O_CREAT
341 #define O_BINARY _O_BINARY
345 #define S_IFMT _S_IFMT
346 #define S_IFDIR _S_IFDIR
347 #define S_IFREG _S_IFREG
349 #endif // wxHAS_UNDERSCORES_IN_POSIX_IDENTS
351 #ifdef wxHAS_HUGE_FILES
352 // wxFile is present and supports large files. Currently wxFFile
353 // doesn't have large file support with any Windows compiler (even
356 #define wxHAS_LARGE_FILES
360 // it's a private define, undefine it so that nobody gets tempted to use it
361 #undef wxHAS_HUGE_FILES
362 #else // Unix or Windows using unknown compiler, assume POSIX supported
363 typedef off_t wxFileOffset
;
365 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
366 wxCOMPILE_TIME_ASSERT( sizeof(off_t
) == sizeof(wxLongLong_t
),
368 // wxFile is present and supports large files
370 #define wxHAS_LARGE_FILES
372 // wxFFile is present and supports large files
373 #if SIZEOF_LONG == 8 || defined HAVE_FSEEKO
374 #define wxHAS_LARGE_FFILES
377 #define wxFileOffsetFmtSpec _T("")
380 #define wxClose close
381 #define wxRead ::read
382 #define wxWrite ::write
383 #define wxLseek lseek
385 #define wxFsync fsync
388 #define wxMkDir mkdir
389 #define wxRmDir rmdir
391 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
393 #define wxStructStat struct stat
396 #define wxNEED_WX_UNISTD_H
398 typedef unsigned long mode_t
;
400 WXDLLIMPEXP_BASE
int wxStat( const wxChar
*file_name
, wxStructStat
*buf
);
401 WXDLLIMPEXP_BASE
int wxLstat( const wxChar
*file_name
, wxStructStat
*buf
);
402 WXDLLIMPEXP_BASE
int wxAccess( const wxChar
*pathname
, int mode
);
403 WXDLLIMPEXP_BASE
int wxOpen( const wxChar
*pathname
, int flags
, mode_t mode
);
407 #define wxLstat lstat
408 #define wxAccess access
411 #define wxHAS_NATIVE_LSTAT
415 #define wxO_BINARY O_BINARY
420 // if the platform doesn't have symlinks, define wxLstat to be the same as
421 // wxStat to avoid #ifdefs in the code using it
422 #ifndef wxHAS_NATIVE_LSTAT
423 #define wxLstat wxStat
426 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
428 // VisualAge C++ V4.0 cannot have any external linkage const decs
429 // in headers included by more than one primary source
431 extern const int wxInvalidOffset
;
433 const int wxInvalidOffset
= -1;
436 // ----------------------------------------------------------------------------
438 // ----------------------------------------------------------------------------
439 WXDLLIMPEXP_BASE
bool wxFileExists(const wxString
& filename
);
441 // does the path exist? (may have or not '/' or '\\' at the end)
442 WXDLLIMPEXP_BASE
bool wxDirExists(const wxChar
*pszPathName
);
444 WXDLLIMPEXP_BASE
bool wxIsAbsolutePath(const wxString
& filename
);
447 WXDLLIMPEXP_BASE wxChar
* wxFileNameFromPath(wxChar
*path
);
448 WXDLLIMPEXP_BASE wxString
wxFileNameFromPath(const wxString
& path
);
451 WXDLLIMPEXP_BASE wxString
wxPathOnly(const wxString
& path
);
454 WXDLLIMPEXP_BASE wxString
wxRealPath(const wxString
& path
);
456 WXDLLIMPEXP_BASE
void wxDos2UnixFilename(wxChar
*s
);
458 WXDLLIMPEXP_BASE
void wxUnix2DosFilename(wxChar
*s
);
460 // Strip the extension, in situ
461 WXDLLIMPEXP_BASE
void wxStripExtension(wxChar
*buffer
);
462 WXDLLIMPEXP_BASE
void wxStripExtension(wxString
& buffer
);
464 // Get a temporary filename
465 WXDLLIMPEXP_BASE wxChar
* wxGetTempFileName(const wxString
& prefix
, wxChar
*buf
= (wxChar
*) NULL
);
466 WXDLLIMPEXP_BASE
bool wxGetTempFileName(const wxString
& prefix
, wxString
& buf
);
468 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
469 WXDLLIMPEXP_BASE wxChar
* wxExpandPath(wxChar
*dest
, const wxChar
*path
);
470 WXDLLIMPEXP_BASE
bool wxExpandPath(wxString
& dest
, const wxChar
*path
);
472 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
473 // and make (if under the home tree) relative to home
474 // [caller must copy-- volatile]
475 WXDLLIMPEXP_BASE wxChar
* wxContractPath(const wxString
& filename
,
476 const wxString
& envname
= wxEmptyString
,
477 const wxString
& user
= wxEmptyString
);
479 // Destructive removal of /./ and /../ stuff
480 WXDLLIMPEXP_BASE wxChar
* wxRealPath(wxChar
*path
);
482 // Allocate a copy of the full absolute path
483 WXDLLIMPEXP_BASE wxChar
* wxCopyAbsolutePath(const wxString
& path
);
485 // Get first file name matching given wild card.
486 // Flags are reserved for future use.
489 WXDLLIMPEXP_BASE wxString
wxFindFirstFile(const wxChar
*spec
, int flags
= wxFILE
);
490 WXDLLIMPEXP_BASE wxString
wxFindNextFile();
492 // Does the pattern contain wildcards?
493 WXDLLIMPEXP_BASE
bool wxIsWild(const wxString
& pattern
);
495 // Does the pattern match the text (usually a filename)?
496 // If dot_special is true, doesn't match * against . (eliminating
497 // `hidden' dot files)
498 WXDLLIMPEXP_BASE
bool wxMatchWild(const wxString
& pattern
, const wxString
& text
, bool dot_special
= true);
500 // Concatenate two files to form third
501 WXDLLIMPEXP_BASE
bool wxConcatFiles(const wxString
& file1
, const wxString
& file2
, const wxString
& file3
);
503 // Copy file1 to file2
504 WXDLLIMPEXP_BASE
bool wxCopyFile(const wxString
& file1
, const wxString
& file2
,
505 bool overwrite
= true);
508 WXDLLIMPEXP_BASE
bool wxRemoveFile(const wxString
& file
);
511 WXDLLIMPEXP_BASE
bool wxRenameFile(const wxString
& file1
, const wxString
& file2
, bool overwrite
= true);
513 // Get current working directory.
514 #if WXWIN_COMPATIBILITY_2_6
515 // If buf is NULL, allocates space using new, else
517 // IMPORTANT NOTE getcwd is know not to work under some releases
518 // of Win32s 1.3, according to MS release notes!
519 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar
* wxGetWorkingDirectory(wxChar
*buf
= (wxChar
*) NULL
, int sz
= 1000) );
520 // new and preferred version of wxGetWorkingDirectory
521 // NB: can't have the same name because of overloading ambiguity
522 #endif // WXWIN_COMPATIBILITY_2_6
523 WXDLLIMPEXP_BASE wxString
wxGetCwd();
525 // Set working directory
526 WXDLLIMPEXP_BASE
bool wxSetWorkingDirectory(const wxString
& d
);
529 WXDLLIMPEXP_BASE
bool wxMkdir(const wxString
& dir
, int perm
= 0777);
531 // Remove directory. Flags reserved for future use.
532 WXDLLIMPEXP_BASE
bool wxRmdir(const wxString
& dir
, int flags
= 0);
534 // Return the type of an open file
535 WXDLLIMPEXP_BASE wxFileKind
wxGetFileKind(int fd
);
536 WXDLLIMPEXP_BASE wxFileKind
wxGetFileKind(FILE *fp
);
538 #if WXWIN_COMPATIBILITY_2_6
539 // compatibility defines, don't use in new code
540 wxDEPRECATED( inline bool wxPathExists(const wxChar
*pszPathName
) );
541 inline bool wxPathExists(const wxChar
*pszPathName
)
543 return wxDirExists(pszPathName
);
545 #endif //WXWIN_COMPATIBILITY_2_6
547 // permissions; these functions work both on files and directories:
548 WXDLLIMPEXP_BASE
bool wxIsWritable(const wxString
&path
);
549 WXDLLIMPEXP_BASE
bool wxIsReadable(const wxString
&path
);
550 WXDLLIMPEXP_BASE
bool wxIsExecutable(const wxString
&path
);
552 // ----------------------------------------------------------------------------
553 // separators in file names
554 // ----------------------------------------------------------------------------
556 // between file name and extension
557 #define wxFILE_SEP_EXT wxT('.')
559 // between drive/volume name and the path
560 #define wxFILE_SEP_DSK wxT(':')
562 // between the path components
563 #define wxFILE_SEP_PATH_DOS wxT('\\')
564 #define wxFILE_SEP_PATH_UNIX wxT('/')
565 #define wxFILE_SEP_PATH_MAC wxT(':')
566 #define wxFILE_SEP_PATH_VMS wxT('.') // VMS also uses '[' and ']'
568 // separator in the path list (as in PATH environment variable)
569 // there is no PATH variable in Classic Mac OS so just use the
570 // semicolon (it must be different from the file name separator)
571 // NB: these are strings and not characters on purpose!
572 #define wxPATH_SEP_DOS wxT(";")
573 #define wxPATH_SEP_UNIX wxT(":")
574 #define wxPATH_SEP_MAC wxT(";")
576 // platform independent versions
577 #if defined(__UNIX__) && !defined(__OS2__)
578 // CYGWIN also uses UNIX settings
579 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
580 #define wxPATH_SEP wxPATH_SEP_UNIX
581 #elif defined(__MAC__)
582 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_MAC
583 #define wxPATH_SEP wxPATH_SEP_MAC
584 #else // Windows and OS/2
585 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS
586 #define wxPATH_SEP wxPATH_SEP_DOS
587 #endif // Unix/Windows
589 // this is useful for wxString::IsSameAs(): to compare two file names use
590 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
591 #if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__)
592 #define wxARE_FILENAMES_CASE_SENSITIVE true
593 #else // Windows, Mac OS and OS/2
594 #define wxARE_FILENAMES_CASE_SENSITIVE false
595 #endif // Unix/Windows
597 // is the char a path separator?
598 inline bool wxIsPathSeparator(wxChar c
)
600 // under DOS/Windows we should understand both Unix and DOS file separators
601 #if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
602 return c
== wxFILE_SEP_PATH
;
604 return c
== wxFILE_SEP_PATH_DOS
|| c
== wxFILE_SEP_PATH_UNIX
;
608 // does the string ends with path separator?
609 WXDLLIMPEXP_BASE
bool wxEndsWithPathSeparator(const wxChar
*pszFileName
);
611 // split the full path into path (including drive for DOS), name and extension
612 // (understands both '/' and '\\')
613 WXDLLIMPEXP_BASE
void wxSplitPath(const wxChar
*pszFileName
,
618 // find a file in a list of directories, returns false if not found
619 WXDLLIMPEXP_BASE
bool wxFindFileInPath(wxString
*pStr
, const wxChar
*pszPath
, const wxChar
*pszFile
);
621 // Get the OS directory if appropriate (such as the Windows directory).
622 // On non-Windows platform, probably just return the empty string.
623 WXDLLIMPEXP_BASE wxString
wxGetOSDirectory();
627 // Get file modification time
628 WXDLLIMPEXP_BASE
time_t wxFileModificationTime(const wxString
& filename
);
630 #endif // wxUSE_DATETIME
632 // Parses the wildCard, returning the number of filters.
633 // Returns 0 if none or if there's a problem,
634 // The arrays will contain an equal number of items found before the error.
635 // wildCard is in the form:
636 // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
637 WXDLLIMPEXP_BASE
int wxParseCommonDialogsFilter(const wxString
& wildCard
, wxArrayString
& descriptions
, wxArrayString
& filters
);
639 // ----------------------------------------------------------------------------
641 // ----------------------------------------------------------------------------
645 // set umask to the given value in ctor and reset it to the old one in dtor
646 class WXDLLIMPEXP_BASE wxUmaskChanger
649 // change the umask to the given one if it is not -1: this allows to write
650 // the same code whether you really want to change umask or not, as is in
651 // wxFileConfig::Flush() for example
652 wxUmaskChanger(int umaskNew
)
654 m_umaskOld
= umaskNew
== -1 ? -1 : (int)umask((mode_t
)umaskNew
);
659 if ( m_umaskOld
!= -1 )
660 umask((mode_t
)m_umaskOld
);
667 // this macro expands to an "anonymous" wxUmaskChanger object under Unix and
669 #define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
673 #define wxCHANGE_UMASK(m)
675 #endif // __UNIX__/!__UNIX__
679 class WXDLLIMPEXP_BASE wxPathList
: public wxArrayString
683 wxPathList(const wxArrayString
&arr
)
686 // Adds all paths in environment variable
687 void AddEnvList(const wxString
& envVariable
);
689 // Adds given path to this list
690 bool Add(const wxString
& path
);
691 void Add(const wxArrayString
&paths
);
693 // Find the first full path for which the file exists
694 wxString
FindValidPath(const wxString
& filename
) const;
696 // Find the first full path for which the file exists; ensure it's an
697 // absolute path that gets returned.
698 wxString
FindAbsoluteValidPath(const wxString
& filename
) const;
700 // Given full path and filename, add path to list
701 bool EnsureFileAccessible(const wxString
& path
);
703 #if WXWIN_COMPATIBILITY_2_6
704 // Returns true if the path is in the list
705 wxDEPRECATED( bool Member(const wxString
& path
) const );
709 #endif // _WX_FILEFN_H_