]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/filefn.h
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
wxCoordRound() -> wxRound()
[wxWidgets.git] / include / wx / filefn.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/filefn.h
3// Purpose: File- and directory-related functions
4// Author: Julian Smart
5// Modified by:
6// Created: 29/01/98
7// RCS-ID: $Id$
8// Copyright: (c) 1998 Julian Smart
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _FILEFN_H_
13#define _FILEFN_H_
14
15#include "wx/list.h"
16#include "wx/arrstr.h"
17
18#ifdef __WXWINCE__
19 #include "wx/msw/wince/time.h"
20 #include "wx/msw/private.h"
21#else
22 #include <time.h>
23#endif
24
25#ifdef __WXWINCE__
26// Nothing
27#elif !defined(__MWERKS__)
28 #include <sys/types.h>
29 #include <sys/stat.h>
30#else
31 #ifdef __MACH__
32 #include <sys/types.h>
33 #include <utime.h>
34 #include <sys/stat.h>
35 #include <unistd.h>
36 #else
37 #include <stat.h>
38 #include <unistd.h>
39 #include <unix.h>
40 #endif
41#endif
42
43#ifdef __OS2__
44// need to check for __OS2__ first since currently both
45// __OS2__ and __UNIX__ are defined.
46 #include <process.h>
47 #include "wx/os2/private.h"
48 #ifdef __WATCOMC__
49 #include <direct.h>
50 #endif
51 #include <io.h>
52 #ifdef __EMX__
53 #include <unistd.h>
54 #endif
55#elif defined(__UNIX__)
56 #include <unistd.h>
57 #include <dirent.h>
58#endif
59
60#if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
61#if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__SALFORDC__) && !defined(__WXWINCE__) && !defined(__CYGWIN__)
62 #include <direct.h>
63 #include <dos.h>
64 #include <io.h>
65#endif // __WINDOWS__
66#endif // native Win compiler
67
68#if defined(__DOS__)
69 #ifdef __WATCOMC__
70 #include <direct.h>
71 #include <dos.h>
72 #include <io.h>
73 #endif
74 #ifdef __DJGPP__
75 #include <io.h>
76 #include <unistd.h>
77 #endif
78#endif
79
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.
83 #include <dir.h>
84#endif
85
86#ifdef __SALFORDC__
87 #include <dir.h>
88 #include <unix.h>
89#endif
90
91#ifndef __WXWINCE__
92 #include <fcntl.h> // O_RDONLY &c
93#endif
94// ----------------------------------------------------------------------------
95// constants
96// ----------------------------------------------------------------------------
97
98#ifdef __WXWINCE__
99 typedef long off_t;
100#else
101 // define off_t
102 #if !defined(__WXMAC__) || defined(__UNIX__) || defined(__MACH__)
103 #include <sys/types.h>
104 #else
105 typedef long off_t;
106 #endif
107#endif
108
109#if (defined(__VISUALC__) && !defined(__WXWINCE__)) || ( defined(__MWERKS__) && defined( __INTEL__) )
110 typedef _off_t off_t;
111#elif defined(__SYMANTEC__)
112 typedef long off_t;
113#elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__)
114 typedef long off_t;
115#endif
116
117enum wxSeekMode
118{
119 wxFromStart,
120 wxFromCurrent,
121 wxFromEnd
122};
123
124enum wxFileKind
125{
126 wxFILE_KIND_UNKNOWN,
127 wxFILE_KIND_DISK, // a file supporting seeking to arbitrary offsets
128 wxFILE_KIND_TERMINAL, // a tty
129 wxFILE_KIND_PIPE // a pipe
130};
131
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// ----------------------------------------------------------------------------
136
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));
144 int wxClose(int fd);
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);
148 int wxEof(int fd);
149 wxFileOffset wxSeek(int fd, wxFileOffset offset, int origin);
150 #define wxLSeek wxSeek
151 wxFileOffset wxTell(int fd);
152
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__) && \
159 ( \
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__) \
167 )
168
169 #undef wxHAS_HUGE_FILES
170
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
178 #endif
179
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)
182 // currently
183
184 #ifdef wxHAS_HUGE_FILES
185 typedef wxLongLong_t wxFileOffset;
186 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
187 #else
188 typedef off_t wxFileOffset;
189 #endif
190
191
192 // functions
193
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
199 // the versions
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
205 #endif
206
207
208 // first functions not working with strings, i.e. without ANSI/Unicode
209 // complications
210 #define wxClose wxPOSIX_IDENT(close)
211
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)
216 #else
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)
221 #endif
222 #else // __MWERKS__
223 #define wxRead wxPOSIX_IDENT(read)
224 #define wxWrite wxPOSIX_IDENT(write)
225 #endif
226
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
236
237 #ifndef __WATCOMC__
238 // NB: this one is not POSIX and always has the underscore
239 #define wxFsync _commit
240
241 #define HAVE_FSYNC
242 #endif
243
244 #define wxEof wxPOSIX_IDENT(eof)
245
246 // then the functions taking strings
247 #if wxUSE_UNICODE
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) ) \
254 || defined(__DMC__)
255
256 WXDLLIMPEXP_BASE int wxMSLU__wopen(const wxChar *name,
257 int flags, int mode);
258 WXDLLIMPEXP_BASE int wxMSLU__waccess(const wxChar *name,
259 int mode);
260 WXDLLIMPEXP_BASE int wxMSLU__wmkdir(const wxChar *name);
261 WXDLLIMPEXP_BASE int wxMSLU__wrmdir(const wxChar *name);
262
263 WXDLLIMPEXP_BASE int
264 wxMSLU__wstat(const wxChar *name,
265 struct wxPOSIX_IDENT(stat) *buffer);
266 WXDLLIMPEXP_BASE int
267 wxMSLU__wstati64(const wxChar *name,
268 struct wxPOSIX_IDENT(stati64) *buffer);
269 #endif // Windows compilers with MSLU support
270
271 #define wxOpen wxMSLU__wopen
272
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
278 #else
279 #define wxStat wxMSLU__wstat
280 #endif
281 #else // !wxUSE_UNICODE_MSLU
282 #ifdef __BORLANDC__
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
289 #else
290 #define wxStat _wstat
291 #endif
292 #else
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
299 #else
300 #define wxStat _wstat
301 #endif
302 #endif
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)
311 #else
312 #define wxStat wxPOSIX_IDENT(stat)
313 #endif
314 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
315
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
322 #else
323 #define wxStructStat struct _stati64
324 #endif
325 #else
326 #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
327 #define wxStructStat struct _wstat
328 #else
329 #define wxStructStat struct _stat
330 #endif
331 #endif
332
333 // constants (unless already defined by the user code)
334 #ifdef wxHAS_UNDERSCORES_IN_POSIX_IDENTS
335 #ifndef O_RDONLY
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
342 #endif
343
344 #ifndef S_IFMT
345 #define S_IFMT _S_IFMT
346 #define S_IFDIR _S_IFDIR
347 #define S_IFREG _S_IFREG
348 #endif
349 #endif // wxHAS_UNDERSCORES_IN_POSIX_IDENTS
350
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
354 // Win64 ones).
355 #if wxUSE_FILE
356 #define wxHAS_LARGE_FILES
357 #endif
358 #endif
359
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;
364 #ifdef _LARGE_FILES
365 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
366 wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t),
367 BadFileSizeType );
368 // wxFile is present and supports large files
369 #ifdef wxUSE_FILE
370 #define wxHAS_LARGE_FILES
371 #endif
372 // wxFFile is present and supports large files
373 #if SIZEOF_LONG == 8 || defined HAVE_FSEEKO
374 #define wxHAS_LARGE_FFILES
375 #endif
376 #else
377 #define wxFileOffsetFmtSpec _T("")
378 #endif
379 // functions
380 #define wxClose close
381 #define wxRead ::read
382 #define wxWrite ::write
383 #define wxLseek lseek
384 #define wxSeek lseek
385 #define wxFsync fsync
386 #define wxEof eof
387
388 #define wxMkDir mkdir
389 #define wxRmDir rmdir
390
391 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
392
393 #define wxStructStat struct stat
394
395 #if wxUSE_UNICODE
396 #define wxNEED_WX_UNISTD_H
397 #if defined(__DMC__)
398 typedef unsigned long mode_t;
399 #endif
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 );
404 #else
405 #define wxOpen open
406 #define wxStat stat
407 #define wxLstat lstat
408 #define wxAccess access
409 #endif
410
411 #define wxHAS_NATIVE_LSTAT
412#endif // platforms
413
414#ifdef O_BINARY
415 #define wxO_BINARY O_BINARY
416#else
417 #define wxO_BINARY 0
418#endif
419
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
424#endif
425
426#if defined(__VISAGECPP__) && __IBMCPP__ >= 400
427//
428// VisualAge C++ V4.0 cannot have any external linkage const decs
429// in headers included by more than one primary source
430//
431extern const int wxInvalidOffset;
432#else
433const int wxInvalidOffset = -1;
434#endif
435
436// ----------------------------------------------------------------------------
437// functions
438// ----------------------------------------------------------------------------
439WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);
440
441// does the path exist? (may have or not '/' or '\\' at the end)
442WXDLLIMPEXP_BASE bool wxDirExists(const wxChar *pszPathName);
443
444WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);
445
446// Get filename
447WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path);
448WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path);
449
450// Get directory
451WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path);
452
453// wxString version
454WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path);
455
456WXDLLIMPEXP_BASE void wxDos2UnixFilename(wxChar *s);
457
458WXDLLIMPEXP_BASE void wxUnix2DosFilename(wxChar *s);
459
460// Strip the extension, in situ
461WXDLLIMPEXP_BASE void wxStripExtension(wxChar *buffer);
462WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer);
463
464// Get a temporary filename
465WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
466WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf);
467
468// Expand file name (~/ and ${OPENWINHOME}/ stuff)
469WXDLLIMPEXP_BASE wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
470WXDLLIMPEXP_BASE bool wxExpandPath(wxString& dest, const wxChar *path);
471
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]
475WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename,
476 const wxString& envname = wxEmptyString,
477 const wxString& user = wxEmptyString);
478
479// Destructive removal of /./ and /../ stuff
480WXDLLIMPEXP_BASE wxChar* wxRealPath(wxChar *path);
481
482// Allocate a copy of the full absolute path
483WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path);
484
485// Get first file name matching given wild card.
486// Flags are reserved for future use.
487#define wxFILE 1
488#define wxDIR 2
489WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
490WXDLLIMPEXP_BASE wxString wxFindNextFile();
491
492// Does the pattern contain wildcards?
493WXDLLIMPEXP_BASE bool wxIsWild(const wxString& pattern);
494
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)
498WXDLLIMPEXP_BASE bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = true);
499
500// Concatenate two files to form third
501WXDLLIMPEXP_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
502
503// Copy file1 to file2
504WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
505 bool overwrite = true);
506
507// Remove file
508WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
509
510// Rename file
511WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2, bool overwrite = true);
512
513// Get current working directory.
514#if WXWIN_COMPATIBILITY_2_6
515// If buf is NULL, allocates space using new, else
516// copies into buf.
517// IMPORTANT NOTE getcwd is know not to work under some releases
518// of Win32s 1.3, according to MS release notes!
519wxDEPRECATED( 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
523WXDLLIMPEXP_BASE wxString wxGetCwd();
524
525// Set working directory
526WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d);
527
528// Make directory
529WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = 0777);
530
531// Remove directory. Flags reserved for future use.
532WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
533
534// Return the type of an open file
535WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(int fd);
536WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(FILE *fp);
537
538#if WXWIN_COMPATIBILITY_2_6
539// compatibility defines, don't use in new code
540wxDEPRECATED( inline bool wxPathExists(const wxChar *pszPathName) );
541inline bool wxPathExists(const wxChar *pszPathName)
542{
543 return wxDirExists(pszPathName);
544}
545#endif //WXWIN_COMPATIBILITY_2_6
546
547// permissions; these functions work both on files and directories:
548WXDLLIMPEXP_BASE bool wxIsWritable(const wxString &path);
549WXDLLIMPEXP_BASE bool wxIsReadable(const wxString &path);
550WXDLLIMPEXP_BASE bool wxIsExecutable(const wxString &path);
551
552// ----------------------------------------------------------------------------
553// separators in file names
554// ----------------------------------------------------------------------------
555
556// between file name and extension
557#define wxFILE_SEP_EXT wxT('.')
558
559// between drive/volume name and the path
560#define wxFILE_SEP_DSK wxT(':')
561
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 ']'
567
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(";")
575
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
588
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
596
597// is the char a path separator?
598inline bool wxIsPathSeparator(wxChar c)
599{
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;
603#else
604 return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX;
605#endif
606}
607
608// does the string ends with path separator?
609WXDLLIMPEXP_BASE bool wxEndsWithPathSeparator(const wxChar *pszFileName);
610
611// split the full path into path (including drive for DOS), name and extension
612// (understands both '/' and '\\')
613WXDLLIMPEXP_BASE void wxSplitPath(const wxChar *pszFileName,
614 wxString *pstrPath,
615 wxString *pstrName,
616 wxString *pstrExt);
617
618// find a file in a list of directories, returns false if not found
619WXDLLIMPEXP_BASE bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile);
620
621// Get the OS directory if appropriate (such as the Windows directory).
622// On non-Windows platform, probably just return the empty string.
623WXDLLIMPEXP_BASE wxString wxGetOSDirectory();
624
625#if wxUSE_DATETIME
626
627// Get file modification time
628WXDLLIMPEXP_BASE time_t wxFileModificationTime(const wxString& filename);
629
630#endif // wxUSE_DATETIME
631
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"
637WXDLLIMPEXP_BASE int wxParseCommonDialogsFilter(const wxString& wildCard, wxArrayString& descriptions, wxArrayString& filters);
638
639// ----------------------------------------------------------------------------
640// classes
641// ----------------------------------------------------------------------------
642
643#ifdef __UNIX__
644
645// set umask to the given value in ctor and reset it to the old one in dtor
646class WXDLLIMPEXP_BASE wxUmaskChanger
647{
648public:
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)
653 {
654 m_umaskOld = umaskNew == -1 ? -1 : (int)umask((mode_t)umaskNew);
655 }
656
657 ~wxUmaskChanger()
658 {
659 if ( m_umaskOld != -1 )
660 umask((mode_t)m_umaskOld);
661 }
662
663private:
664 int m_umaskOld;
665};
666
667// this macro expands to an "anonymous" wxUmaskChanger object under Unix and
668// nothing elsewhere
669#define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
670
671#else // !__UNIX__
672
673#define wxCHANGE_UMASK(m)
674
675#endif // __UNIX__/!__UNIX__
676
677
678// Path searching
679class WXDLLIMPEXP_BASE wxPathList : public wxArrayString
680{
681public:
682 wxPathList() {}
683 wxPathList(const wxArrayString &arr)
684 { Add(arr); }
685
686 // Adds all paths in environment variable
687 void AddEnvList(const wxString& envVariable);
688
689 // Adds given path to this list
690 bool Add(const wxString& path);
691 void Add(const wxArrayString &paths);
692
693 // Find the first full path for which the file exists
694 wxString FindValidPath(const wxString& filename) const;
695
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;
699
700 // Given full path and filename, add path to list
701 bool EnsureFileAccessible(const wxString& path);
702
703#if WXWIN_COMPATIBILITY_2_6
704 // Returns true if the path is in the list
705 wxDEPRECATED( bool Member(const wxString& path) const );
706#endif
707};
708
709#endif // _WX_FILEFN_H_
wxWidgets (Impactor)