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"
20 #include "wx/msw/wince/time.h"
21 #include "wx/msw/private.h"
28 #elif !defined(__MWERKS__)
29 #include <sys/types.h>
33 #include <sys/types.h>
43 #endif // !__WXPALMOS5__
46 // need to check for __OS2__ first since currently both
47 // __OS2__ and __UNIX__ are defined.
49 #include "wx/os2/private.h"
57 #elif defined(__UNIX__)
62 #if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
63 #if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__WXWINCE__) && !defined(__CYGWIN__)
68 #endif // native Win compiler
82 #ifdef __BORLANDC__ // Please someone tell me which version of Borland needs
83 // this (3.1 I believe) and how to test for it.
84 // If this works for Borland 4.0 as well, then no worries.
90 #include <fcntl.h> // O_RDONLY &c
92 #endif // !__WXPALMOS5__
93 // ----------------------------------------------------------------------------
95 // ----------------------------------------------------------------------------
97 #if defined(__VISUALC__) || defined(__DIGITALMARS__)
105 #if !defined(__WXMAC__) || defined(__UNIX__) || defined(__MACH__)
106 #include <sys/types.h>
112 #if (defined(__VISUALC__) && !defined(__WXWINCE__)) || ( defined(__MWERKS__) && defined( __INTEL__) )
113 typedef _off_t off_t
;
114 #elif defined(__SYMANTEC__)
116 #elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__)
118 #elif defined(__WXPALMOS5__)
132 wxFILE_KIND_DISK
, // a file supporting seeking to arbitrary offsets
133 wxFILE_KIND_TERMINAL
, // a tty
134 wxFILE_KIND_PIPE
// a pipe
137 // we redefine these constants here because S_IREAD &c are _not_ standard
138 // however, we do assume that the values correspond to the Unix umask bits
139 enum wxPosixPermissions
141 // standard Posix names for these permission flags:
154 // longer but more readable synonyms for the constants above:
155 wxPOSIX_USER_READ
= wxS_IRUSR
,
156 wxPOSIX_USER_WRITE
= wxS_IWUSR
,
157 wxPOSIX_USER_EXECUTE
= wxS_IXUSR
,
159 wxPOSIX_GROUP_READ
= wxS_IRGRP
,
160 wxPOSIX_GROUP_WRITE
= wxS_IWGRP
,
161 wxPOSIX_GROUP_EXECUTE
= wxS_IXGRP
,
163 wxPOSIX_OTHERS_READ
= wxS_IROTH
,
164 wxPOSIX_OTHERS_WRITE
= wxS_IWOTH
,
165 wxPOSIX_OTHERS_EXECUTE
= wxS_IXOTH
,
167 // default mode for the new files: allow reading/writing them to everybody but
168 // the effective file mode will be set after anding this value with umask and
169 // so won't include wxS_IW{GRP,OTH} for the default 022 umask value
170 wxS_DEFAULT
= (wxPOSIX_USER_READ
| wxPOSIX_USER_WRITE
| \
171 wxPOSIX_GROUP_READ
| wxPOSIX_GROUP_WRITE
| \
172 wxPOSIX_OTHERS_READ
| wxPOSIX_OTHERS_WRITE
),
174 // default mode for the new directories (see wxFileName::Mkdir): allow
175 // reading/writing/executing them to everybody, but just like wxS_DEFAULT
176 // the effective directory mode will be set after anding this value with umask
177 wxS_DIR_DEFAULT
= (wxPOSIX_USER_READ
| wxPOSIX_USER_WRITE
| wxPOSIX_USER_EXECUTE
| \
178 wxPOSIX_GROUP_READ
| wxPOSIX_GROUP_WRITE
| wxPOSIX_GROUP_EXECUTE
| \
179 wxPOSIX_OTHERS_READ
| wxPOSIX_OTHERS_WRITE
| wxPOSIX_OTHERS_EXECUTE
)
182 // ----------------------------------------------------------------------------
183 // declare our versions of low level file functions: some compilers prepend
184 // underscores to the usual names, some also have Unicode versions of them
185 // ----------------------------------------------------------------------------
187 // Wrappers around Win32 api functions like CreateFile, ReadFile and such
188 // Implemented in filefnwce.cpp
189 #if defined( __WXWINCE__)
190 typedef __int64 wxFileOffset
;
191 #define wxFileOffsetFmtSpec wxT("I64")
192 WXDLLIMPEXP_BASE
int wxCRT_Open(const wxChar
*filename
, int oflag
, int WXUNUSED(pmode
));
193 WXDLLIMPEXP_BASE
int wxCRT_Access(const wxChar
*name
, int WXUNUSED(how
));
194 WXDLLIMPEXP_BASE
int wxClose(int fd
);
195 WXDLLIMPEXP_BASE
int wxFsync(int WXUNUSED(fd
));
196 WXDLLIMPEXP_BASE
int wxRead(int fd
, void *buf
, unsigned int count
);
197 WXDLLIMPEXP_BASE
int wxWrite(int fd
, const void *buf
, unsigned int count
);
198 WXDLLIMPEXP_BASE
int wxEof(int fd
);
199 WXDLLIMPEXP_BASE wxFileOffset
wxSeek(int fd
, wxFileOffset offset
, int origin
);
200 #define wxLSeek wxSeek
201 WXDLLIMPEXP_BASE wxFileOffset
wxTell(int fd
);
203 // always Unicode under WinCE
204 #define wxCRT_MkDir _wmkdir
205 #define wxCRT_RmDir _wrmdir
206 #define wxCRT_Stat _wstat
207 #define wxStructStat struct _stat
208 #elif (defined(__WXMSW__) || defined(__OS2__)) && !defined(__WXPALMOS__) && \
210 defined(__VISUALC__) || \
211 defined(__MINGW64__) || \
212 (defined(__MINGW32__) && !defined(__WINE__) && \
213 wxCHECK_W32API_VERSION(0, 5)) || \
214 defined(__MWERKS__) || \
215 defined(__DMC__) || \
216 defined(__WATCOMC__) || \
217 defined(__BORLANDC__) \
220 // temporary defines just used immediately below
221 #undef wxHAS_HUGE_FILES
222 #undef wxHAS_HUGE_STDIO_FILES
224 // detect compilers which have support for huge files
225 #if defined(__VISUALC__)
226 #define wxHAS_HUGE_FILES 1
227 #elif defined(__MINGW32__) || defined(__MINGW64__)
228 #define wxHAS_HUGE_FILES 1
229 #elif defined(_LARGE_FILES)
230 #define wxHAS_HUGE_FILES 1
233 // detect compilers which have support for huge stdio files
234 #if wxCHECK_VISUALC_VERSION(8)
235 #define wxHAS_HUGE_STDIO_FILES
236 #define wxFseek _fseeki64
237 #define wxFtell _ftelli64
238 #elif wxCHECK_MINGW32_VERSION(3, 5) // mingw-runtime version (not gcc)
239 #define wxHAS_HUGE_STDIO_FILES
240 #define wxFseek fseeko64
241 #define wxFtell ftello64
244 // other Windows compilers (DMC, Watcom, Metrowerks and Borland) don't have
245 // huge file support (or at least not all functions needed for it by wx)
250 #ifdef wxHAS_HUGE_FILES
251 typedef wxLongLong_t wxFileOffset
;
252 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
254 typedef off_t wxFileOffset
;
257 // at least Borland 5.5 doesn't like "struct ::stat" so don't use the scope
258 // resolution operator present in wxPOSIX_IDENT for it
260 #define wxPOSIX_STRUCT(s) struct s
262 #define wxPOSIX_STRUCT(s) struct wxPOSIX_IDENT(s)
265 // Notice that Watcom is the only compiler to have a wide char
266 // version of struct stat as well as a wide char stat function variant.
267 // This was dropped since OW 1.4 "for consistency across platforms".
269 // Borland is also special in that it uses _stat with Unicode functions
270 // (for MSVC compatibility?) but stat with ANSI ones
273 #define wxStructStat struct stati64
276 #define wxStructStat struct _stat
278 #define wxStructStat struct stat
281 #else // !__BORLANDC__
282 #ifdef wxHAS_HUGE_FILES
283 #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
284 #define wxStructStat struct _wstati64
286 #define wxStructStat struct _stati64
289 #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
290 #define wxStructStat struct _wstat
292 #define wxStructStat struct _stat
295 #endif // __BORLANDC__/!__BORLANDC__
300 // MSVC and compatible compilers prepend underscores to the POSIX function
301 // names, other compilers don't and even if their later versions usually do
302 // define the versions with underscores for MSVC compatibility, it's better
303 // to avoid using them as they're not present in earlier versions and
304 // always using the native functions spelling is easier than testing for
306 #if defined(__BORLANDC__) || defined(__DMC__) || defined(__WATCOMC__) || defined(__MINGW64__)
307 #define wxPOSIX_IDENT(func) ::func
308 #else // by default assume MSVC-compatible names
309 #define wxPOSIX_IDENT(func) _ ## func
310 #define wxHAS_UNDERSCORES_IN_POSIX_IDENTS
313 // first functions not working with strings, i.e. without ANSI/Unicode
315 #define wxClose wxPOSIX_IDENT(close)
317 #if defined(__MWERKS__)
318 #if __MSL__ >= 0x6000
319 #define wxRead(fd, buf, nCount) _read(fd, (void *)buf, nCount)
320 #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)
322 #define wxRead(fd, buf, nCount)\
323 _read(fd, (const char *)buf, nCount)
324 #define wxWrite(fd, buf, nCount)\
325 _write(fd, (const char *)buf, nCount)
328 #define wxRead wxPOSIX_IDENT(read)
329 #define wxWrite wxPOSIX_IDENT(write)
332 #ifdef wxHAS_HUGE_FILES
334 #define wxSeek wxPOSIX_IDENT(lseeki64)
335 #define wxLseek wxPOSIX_IDENT(lseeki64)
336 #define wxTell wxPOSIX_IDENT(telli64)
338 // unfortunately, mingw-W64 is somewhat inconsistent...
339 #define wxSeek _lseeki64
340 #define wxLseek _lseeki64
341 #define wxTell _telli64
343 #else // !wxHAS_HUGE_FILES
344 #define wxSeek wxPOSIX_IDENT(lseek)
345 #define wxLseek wxPOSIX_IDENT(lseek)
346 #define wxTell wxPOSIX_IDENT(tell)
347 #endif // wxHAS_HUGE_FILES/!wxHAS_HUGE_FILES
350 #if !defined(__BORLANDC__) || (__BORLANDC__ > 0x540)
351 // NB: this one is not POSIX and always has the underscore
352 #define wxFsync _commit
354 // could be already defined by configure (Cygwin)
361 #define wxEof wxPOSIX_IDENT(eof)
363 // then the functions taking strings
365 // first the ANSI versions
366 #define wxCRT_OpenA wxPOSIX_IDENT(open)
367 #define wxCRT_AccessA wxPOSIX_IDENT(access)
368 #define wxCRT_MkDirA wxPOSIX_IDENT(mkdir)
369 #define wxCRT_RmDirA wxPOSIX_IDENT(rmdir)
370 #ifdef wxHAS_HUGE_FILES
371 #define wxCRT_StatA wxPOSIX_IDENT(stati64)
373 // Unfortunately Watcom is not consistent
374 #if defined(__OS2__) && defined(__WATCOMC__)
375 #define wxCRT_StatA _stat
377 #define wxCRT_StatA wxPOSIX_IDENT(stat)
381 // then wide char ones
383 // special workaround for buggy wopen() in bcc 5.5
384 #if defined(__BORLANDC__) && \
385 (__BORLANDC__ >= 0x550 && __BORLANDC__ <= 0x551)
386 WXDLLIMPEXP_BASE
int wxCRT_OpenW(const wxChar
*pathname
,
387 int flags
, mode_t mode
);
389 #define wxCRT_OpenW _wopen
392 #define wxCRT_AccessW _waccess
393 #define wxCRT_MkDirW _wmkdir
394 #define wxCRT_RmDirW _wrmdir
395 #ifdef wxHAS_HUGE_FILES
396 #define wxCRT_StatW _wstati64
398 #define wxCRT_StatW _wstat
400 #endif // wxUSE_UNICODE
403 // finally the default char-type versions
405 #if wxUSE_UNICODE_MSLU || defined(__WX_STRICT_ANSI_GCC__)
406 // implement the missing file functions in Win9x ourselves
407 WXDLLIMPEXP_BASE
int wxMSLU__wopen(const wxChar
*name
,
408 int flags
, int mode
);
409 WXDLLIMPEXP_BASE
int wxMSLU__waccess(const wxChar
*name
,
411 WXDLLIMPEXP_BASE
int wxMSLU__wmkdir(const wxChar
*name
);
412 WXDLLIMPEXP_BASE
int wxMSLU__wrmdir(const wxChar
*name
);
415 wxMSLU__wstat(const wxChar
*name
, wxStructStat
*buffer
);
417 #define wxCRT_Open wxMSLU__wopen
419 #define wxCRT_Access wxMSLU__waccess
420 #define wxCRT_MkDir wxMSLU__wmkdir
421 #define wxCRT_RmDir wxMSLU__wrmdir
422 #define wxCRT_Stat wxMSLU__wstat
423 #else // !wxUSE_UNICODE_MSLU
424 #define wxCRT_Open wxCRT_OpenW
425 #define wxCRT_Access wxCRT_AccessW
426 #define wxCRT_MkDir wxCRT_MkDirW
427 #define wxCRT_RmDir wxCRT_RmDirW
428 #define wxCRT_Stat wxCRT_StatW
429 #endif // wxUSE_UNICODE_MSLU/!wxUSE_UNICODE_MSLU
430 #else // !wxUSE_UNICODE
431 #define wxCRT_Open wxCRT_OpenA
432 #define wxCRT_Access wxCRT_AccessA
433 #define wxCRT_MkDir wxCRT_MkDirA
434 #define wxCRT_RmDir wxCRT_RmDirA
435 #define wxCRT_Stat wxCRT_StatA
436 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
439 // constants (unless already defined by the user code)
440 #ifdef wxHAS_UNDERSCORES_IN_POSIX_IDENTS
442 #define O_RDONLY _O_RDONLY
443 #define O_WRONLY _O_WRONLY
444 #define O_RDWR _O_RDWR
445 #define O_EXCL _O_EXCL
446 #define O_CREAT _O_CREAT
447 #define O_BINARY _O_BINARY
451 #define S_IFMT _S_IFMT
452 #define S_IFDIR _S_IFDIR
453 #define S_IFREG _S_IFREG
455 #endif // wxHAS_UNDERSCORES_IN_POSIX_IDENTS
457 #ifdef wxHAS_HUGE_FILES
458 // wxFile is present and supports large files.
460 #define wxHAS_LARGE_FILES
462 // wxFFile is present and supports large files
463 #if wxUSE_FFILE && defined wxHAS_HUGE_STDIO_FILES
464 #define wxHAS_LARGE_FFILES
468 // private defines, undefine so that nobody gets tempted to use
469 #undef wxHAS_HUGE_FILES
470 #undef wxHAS_HUGE_STDIO_FILES
471 #elif defined (__WXPALMOS__)
472 typedef off_t wxFileOffset
;
474 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
475 wxCOMPILE_TIME_ASSERT( sizeof(off_t
) == sizeof(wxLongLong_t
), BadFileSizeType
);
476 // wxFile is present and supports large files
478 #define wxHAS_LARGE_FILES
480 // wxFFile is present and supports large files
481 #if SIZEOF_LONG == 8 || defined HAVE_FSEEKO
482 #define wxHAS_LARGE_FFILES
485 #define wxFileOffsetFmtSpec wxT("")
487 #define wxClose close
488 #define wxRead ::read
489 #define wxWrite ::write
490 #define wxLseek lseek
492 #define wxFsync fsync
495 #define wxCRT_MkDir mkdir
496 #define wxCRT_RmDir rmdir
498 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
500 #define wxStructStat struct stat
502 #define wxCRT_Open open
503 #define wxCRT_Stat svfs_stat
504 #define wxCRT_Lstat lstat
505 #define wxCRT_Access access
507 #define wxHAS_NATIVE_LSTAT
508 #else // Unix or Windows using unknown compiler, assume POSIX supported
509 typedef off_t wxFileOffset
;
510 #ifdef HAVE_LARGEFILE_SUPPORT
511 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
512 wxCOMPILE_TIME_ASSERT( sizeof(off_t
) == sizeof(wxLongLong_t
),
514 // wxFile is present and supports large files
516 #define wxHAS_LARGE_FILES
518 // wxFFile is present and supports large files
519 #if wxUSE_FFILE && (SIZEOF_LONG == 8 || defined HAVE_FSEEKO)
520 #define wxHAS_LARGE_FFILES
523 #define wxFseek fseeko
524 #define wxFtell ftello
527 #define wxFileOffsetFmtSpec wxT("")
530 #define wxClose close
531 #define wxRead ::read
532 #define wxWrite ::write
533 #define wxLseek lseek
535 #define wxFsync fsync
538 #define wxCRT_MkDir mkdir
539 #define wxCRT_RmDir rmdir
541 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
543 #define wxStructStat struct stat
545 #define wxCRT_Open open
546 #define wxCRT_Stat stat
547 #define wxCRT_Lstat lstat
548 #define wxCRT_Access access
550 #define wxHAS_NATIVE_LSTAT
553 // if the platform doesn't have symlinks, define wxCRT_Lstat to be the same as
554 // wxCRT_Stat to avoid #ifdefs in the code using it
555 #ifndef wxHAS_NATIVE_LSTAT
556 #define wxCRT_Lstat wxCRT_Stat
559 // define wxFseek/wxFtell to large file versions if available (done above) or
560 // to fseek/ftell if not, to save ifdefs in using code
562 #define wxFseek fseek
565 #define wxFtell ftell
568 inline int wxAccess(const wxString
& path
, mode_t mode
)
569 { return wxCRT_Access(path
.fn_str(), mode
); }
570 inline int wxOpen(const wxString
& path
, int flags
, mode_t mode
)
571 { return wxCRT_Open(path
.fn_str(), flags
, mode
); }
573 // FIXME-CE: provide our own implementations of the missing CRT functions
575 inline int wxStat(const wxString
& path
, wxStructStat
*buf
)
576 { return wxCRT_Stat(path
.fn_str(), buf
); }
577 inline int wxLstat(const wxString
& path
, wxStructStat
*buf
)
578 { return wxCRT_Lstat(path
.fn_str(), buf
); }
579 inline int wxRmDir(const wxString
& path
)
580 { return wxCRT_RmDir(path
.fn_str()); }
581 #if defined(__WINDOWS__) || (defined(__OS2__) && defined(__WATCOMC__))
582 inline int wxMkDir(const wxString
& path
, mode_t
WXUNUSED(mode
) = 0)
583 { return wxCRT_MkDir(path
.fn_str()); }
585 inline int wxMkDir(const wxString
& path
, mode_t mode
)
586 { return wxCRT_MkDir(path
.fn_str(), mode
); }
588 #endif // !__WXWINCE__
591 #define wxO_BINARY O_BINARY
596 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
598 // VisualAge C++ V4.0 cannot have any external linkage const decs
599 // in headers included by more than one primary source
601 extern const int wxInvalidOffset
;
603 const int wxInvalidOffset
= -1;
606 // ----------------------------------------------------------------------------
608 // ----------------------------------------------------------------------------
609 WXDLLIMPEXP_BASE
bool wxFileExists(const wxString
& filename
);
611 // does the path exist? (may have or not '/' or '\\' at the end)
612 WXDLLIMPEXP_BASE
bool wxDirExists(const wxString
& pathName
);
614 WXDLLIMPEXP_BASE
bool wxIsAbsolutePath(const wxString
& filename
);
617 WXDLLIMPEXP_BASE wxChar
* wxFileNameFromPath(wxChar
*path
);
618 WXDLLIMPEXP_BASE wxString
wxFileNameFromPath(const wxString
& path
);
621 WXDLLIMPEXP_BASE wxString
wxPathOnly(const wxString
& path
);
623 // all deprecated functions below are deprecated in favour of wxFileName's methods
624 #if WXWIN_COMPATIBILITY_2_8
626 wxDEPRECATED( WXDLLIMPEXP_BASE
void wxDos2UnixFilename(char *s
) );
627 wxDEPRECATED( WXDLLIMPEXP_BASE
void wxDos2UnixFilename(wchar_t *s
) );
629 wxDEPRECATED_BUT_USED_INTERNALLY(
630 WXDLLIMPEXP_BASE
void wxUnix2DosFilename(char *s
) );
631 wxDEPRECATED_BUT_USED_INTERNALLY(
632 WXDLLIMPEXP_BASE
void wxUnix2DosFilename(wchar_t *s
) );
634 // Strip the extension, in situ
635 // Deprecated in favour of wxFileName::StripExtension() but notice that their
636 // behaviour is slightly different, see the manual
637 wxDEPRECATED( WXDLLIMPEXP_BASE
void wxStripExtension(char *buffer
) );
638 wxDEPRECATED( WXDLLIMPEXP_BASE
void wxStripExtension(wchar_t *buffer
) );
639 wxDEPRECATED( WXDLLIMPEXP_BASE
void wxStripExtension(wxString
& buffer
) );
641 // Get a temporary filename
642 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE wxChar
* wxGetTempFileName(const wxString
& prefix
, wxChar
*buf
= NULL
) );
643 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE
bool wxGetTempFileName(const wxString
& prefix
, wxString
& buf
) );
645 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
646 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE
char* wxExpandPath(char *dest
, const wxString
& path
) );
647 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE
wchar_t* wxExpandPath(wchar_t *dest
, const wxString
& path
) );
648 // DEPRECATED: use wxFileName::Normalize(wxPATH_NORM_ENV_VARS)
650 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
651 // and make (if under the home tree) relative to home
652 // [caller must copy-- volatile]
654 WXDLLIMPEXP_BASE wxChar
* wxContractPath(const wxString
& filename
,
655 const wxString
& envname
= wxEmptyString
,
656 const wxString
& user
= wxEmptyString
) );
657 // DEPRECATED: use wxFileName::ReplaceEnvVariable and wxFileName::ReplaceHomeDir
659 // Destructive removal of /./ and /../ stuff
660 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE
char* wxRealPath(char *path
) );
661 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE
wchar_t* wxRealPath(wchar_t *path
) );
662 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE wxString
wxRealPath(const wxString
& path
) );
663 // DEPRECATED: use wxFileName::Normalize instead
665 // Allocate a copy of the full absolute path
666 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar
* wxCopyAbsolutePath(const wxString
& path
) );
667 // DEPRECATED: use wxFileName::MakeAbsolute instead
670 // Get first file name matching given wild card.
671 // Flags are reserved for future use.
674 WXDLLIMPEXP_BASE wxString
wxFindFirstFile(const wxString
& spec
, int flags
= wxFILE
);
675 WXDLLIMPEXP_BASE wxString
wxFindNextFile();
677 // Does the pattern contain wildcards?
678 WXDLLIMPEXP_BASE
bool wxIsWild(const wxString
& pattern
);
680 // Does the pattern match the text (usually a filename)?
681 // If dot_special is true, doesn't match * against . (eliminating
682 // `hidden' dot files)
683 WXDLLIMPEXP_BASE
bool wxMatchWild(const wxString
& pattern
, const wxString
& text
, bool dot_special
= true);
685 // Concatenate two files to form third
686 WXDLLIMPEXP_BASE
bool wxConcatFiles(const wxString
& file1
, const wxString
& file2
, const wxString
& file3
);
688 // Copy file1 to file2
689 WXDLLIMPEXP_BASE
bool wxCopyFile(const wxString
& file1
, const wxString
& file2
,
690 bool overwrite
= true);
693 WXDLLIMPEXP_BASE
bool wxRemoveFile(const wxString
& file
);
696 WXDLLIMPEXP_BASE
bool wxRenameFile(const wxString
& file1
, const wxString
& file2
, bool overwrite
= true);
698 // Get current working directory.
699 #if WXWIN_COMPATIBILITY_2_6
700 // If buf is NULL, allocates space using new, else
702 // IMPORTANT NOTE getcwd is know not to work under some releases
703 // of Win32s 1.3, according to MS release notes!
704 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar
* wxGetWorkingDirectory(wxChar
*buf
= NULL
, int sz
= 1000) );
705 // new and preferred version of wxGetWorkingDirectory
706 // NB: can't have the same name because of overloading ambiguity
707 #endif // WXWIN_COMPATIBILITY_2_6
708 WXDLLIMPEXP_BASE wxString
wxGetCwd();
710 // Set working directory
711 WXDLLIMPEXP_BASE
bool wxSetWorkingDirectory(const wxString
& d
);
714 WXDLLIMPEXP_BASE
bool wxMkdir(const wxString
& dir
, int perm
= wxS_DIR_DEFAULT
);
716 // Remove directory. Flags reserved for future use.
717 WXDLLIMPEXP_BASE
bool wxRmdir(const wxString
& dir
, int flags
= 0);
719 // Return the type of an open file
720 WXDLLIMPEXP_BASE wxFileKind
wxGetFileKind(int fd
);
721 WXDLLIMPEXP_BASE wxFileKind
wxGetFileKind(FILE *fp
);
723 #if WXWIN_COMPATIBILITY_2_6
724 // compatibility defines, don't use in new code
725 wxDEPRECATED( inline bool wxPathExists(const wxChar
*pszPathName
) );
726 inline bool wxPathExists(const wxChar
*pszPathName
)
728 return wxDirExists(pszPathName
);
730 #endif //WXWIN_COMPATIBILITY_2_6
732 // permissions; these functions work both on files and directories:
733 WXDLLIMPEXP_BASE
bool wxIsWritable(const wxString
&path
);
734 WXDLLIMPEXP_BASE
bool wxIsReadable(const wxString
&path
);
735 WXDLLIMPEXP_BASE
bool wxIsExecutable(const wxString
&path
);
737 // ----------------------------------------------------------------------------
738 // separators in file names
739 // ----------------------------------------------------------------------------
741 // between file name and extension
742 #define wxFILE_SEP_EXT wxT('.')
744 // between drive/volume name and the path
745 #define wxFILE_SEP_DSK wxT(':')
747 // between the path components
748 #define wxFILE_SEP_PATH_DOS wxT('\\')
749 #define wxFILE_SEP_PATH_UNIX wxT('/')
750 #define wxFILE_SEP_PATH_MAC wxT(':')
751 #define wxFILE_SEP_PATH_VMS wxT('.') // VMS also uses '[' and ']'
753 // separator in the path list (as in PATH environment variable)
754 // there is no PATH variable in Classic Mac OS so just use the
755 // semicolon (it must be different from the file name separator)
756 // NB: these are strings and not characters on purpose!
757 #define wxPATH_SEP_DOS wxT(";")
758 #define wxPATH_SEP_UNIX wxT(":")
759 #define wxPATH_SEP_MAC wxT(";")
761 // platform independent versions
762 #if defined(__UNIX__) && !defined(__OS2__)
763 // CYGWIN also uses UNIX settings
764 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
765 #define wxPATH_SEP wxPATH_SEP_UNIX
766 #elif defined(__WXPALMOS__)
767 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
768 #define wxPATH_SEP wxPATH_SEP_UNIX
769 #elif defined(__MAC__)
770 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_MAC
771 #define wxPATH_SEP wxPATH_SEP_MAC
772 #else // Windows and OS/2
773 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS
774 #define wxPATH_SEP wxPATH_SEP_DOS
775 #endif // Unix/Windows
777 // this is useful for wxString::IsSameAs(): to compare two file names use
778 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
779 #if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__)
780 #define wxARE_FILENAMES_CASE_SENSITIVE true
781 #else // Windows, Mac OS and OS/2
782 #define wxARE_FILENAMES_CASE_SENSITIVE false
783 #endif // Unix/Windows
785 // is the char a path separator?
786 inline bool wxIsPathSeparator(wxChar c
)
788 // under DOS/Windows we should understand both Unix and DOS file separators
789 #if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
790 return c
== wxFILE_SEP_PATH
;
792 return c
== wxFILE_SEP_PATH_DOS
|| c
== wxFILE_SEP_PATH_UNIX
;
796 // does the string ends with path separator?
797 WXDLLIMPEXP_BASE
bool wxEndsWithPathSeparator(const wxString
& filename
);
799 #if WXWIN_COMPATIBILITY_2_8
800 // split the full path into path (including drive for DOS), name and extension
801 // (understands both '/' and '\\')
802 // Deprecated in favour of wxFileName::SplitPath
803 wxDEPRECATED( WXDLLIMPEXP_BASE
void wxSplitPath(const wxString
& fileName
,
806 wxString
*pstrExt
) );
809 // find a file in a list of directories, returns false if not found
810 WXDLLIMPEXP_BASE
bool wxFindFileInPath(wxString
*pStr
, const wxString
& szPath
, const wxString
& szFile
);
812 // Get the OS directory if appropriate (such as the Windows directory).
813 // On non-Windows platform, probably just return the empty string.
814 WXDLLIMPEXP_BASE wxString
wxGetOSDirectory();
818 // Get file modification time
819 WXDLLIMPEXP_BASE
time_t wxFileModificationTime(const wxString
& filename
);
821 #endif // wxUSE_DATETIME
823 // Parses the wildCard, returning the number of filters.
824 // Returns 0 if none or if there's a problem,
825 // The arrays will contain an equal number of items found before the error.
826 // wildCard is in the form:
827 // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
828 WXDLLIMPEXP_BASE
int wxParseCommonDialogsFilter(const wxString
& wildCard
, wxArrayString
& descriptions
, wxArrayString
& filters
);
830 // ----------------------------------------------------------------------------
832 // ----------------------------------------------------------------------------
836 // set umask to the given value in ctor and reset it to the old one in dtor
837 class WXDLLIMPEXP_BASE wxUmaskChanger
840 // change the umask to the given one if it is not -1: this allows to write
841 // the same code whether you really want to change umask or not, as is in
842 // wxFileConfig::Flush() for example
843 wxUmaskChanger(int umaskNew
)
845 m_umaskOld
= umaskNew
== -1 ? -1 : (int)umask((mode_t
)umaskNew
);
850 if ( m_umaskOld
!= -1 )
851 umask((mode_t
)m_umaskOld
);
858 // this macro expands to an "anonymous" wxUmaskChanger object under Unix and
860 #define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
864 #define wxCHANGE_UMASK(m)
866 #endif // __UNIX__/!__UNIX__
870 class WXDLLIMPEXP_BASE wxPathList
: public wxArrayString
874 wxPathList(const wxArrayString
&arr
)
877 // Adds all paths in environment variable
878 void AddEnvList(const wxString
& envVariable
);
880 // Adds given path to this list
881 bool Add(const wxString
& path
);
882 void Add(const wxArrayString
&paths
);
884 // Find the first full path for which the file exists
885 wxString
FindValidPath(const wxString
& filename
) const;
887 // Find the first full path for which the file exists; ensure it's an
888 // absolute path that gets returned.
889 wxString
FindAbsoluteValidPath(const wxString
& filename
) const;
891 // Given full path and filename, add path to list
892 bool EnsureFileAccessible(const wxString
& path
);
894 #if WXWIN_COMPATIBILITY_2_6
895 // Returns true if the path is in the list
896 wxDEPRECATED( bool Member(const wxString
& path
) const );
900 #endif // _WX_FILEFN_H_