]> git.saurik.com Git - wxWidgets.git/blame - include/wx/filefn.h
change superflous elif to else
[wxWidgets.git] / include / wx / filefn.h
CommitLineData
c801d85f
KB
1/////////////////////////////////////////////////////////////////////////////
2// Name: 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
65571936 9// Licence: wxWindows licence
c801d85f
KB
10/////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _FILEFN_H_
13#define _FILEFN_H_
c801d85f 14
12028905 15#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
7af89395 16 #pragma interface "filefn.h"
c801d85f
KB
17#endif
18
ed58dbea 19#include "wx/list.h"
b76069e2 20#include "wx/arrstr.h"
e49f47aa 21
6294ac2e
VZ
22#ifdef __WXWINCE__
23 #include "wx/msw/wince/time.h"
24 #include "wx/msw/private.h"
25#else
26 #include <time.h>
0e0126c2 27#endif
a47ce4a7 28
6294ac2e
VZ
29#ifdef __WXWINCE__
30// Nothing
31#elif !defined(__MWERKS__)
32 #include <sys/types.h>
33 #include <sys/stat.h>
34#else
35 #ifdef __MACH__
36 #include <sys/types.h>
37 #include <utime.h>
38 #include <sys/stat.h>
39 #include <unistd.h>
40 #else
41 #include <stat.h>
42 #include <unistd.h>
43 #include <unix.h>
44 #endif
45#endif
46
47#ifdef __OS2__
48// need to check for __OS2__ first since currently both
49// __OS2__ and __UNIX__ are defined.
50 #include <process.h>
51 #include "wx/os2/private.h"
52 #include <io.h>
53 #ifdef __EMX__
54 #include <unistd.h>
55 #endif
56#elif defined(__UNIX__)
57 #include <unistd.h>
58 #include <dirent.h>
59#endif
60
61#if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
62#if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__SALFORDC__) && !defined(__WXWINCE__)
63 #include <direct.h>
64 #include <dos.h>
65 #include <io.h>
66#endif // __WINDOWS__
67#endif // native Win compiler
68
69#if defined(__DOS__)
70 #ifdef __WATCOMC__
71 #include <direct.h>
72 #include <dos.h>
73 #include <io.h>
74 #endif
75 #ifdef __DJGPP__
76 #include <io.h>
77 #include <unistd.h>
78 #endif
79#endif
80
81#ifdef __BORLANDC__ // Please someone tell me which version of Borland needs
82 // this (3.1 I believe) and how to test for it.
83 // If this works for Borland 4.0 as well, then no worries.
84 #include <dir.h>
85#endif
86
87#ifdef __SALFORDC__
88 #include <dir.h>
89 #include <unix.h>
90#endif
91
92#ifndef __WXWINCE__
93 #include <fcntl.h> // O_RDONLY &c
94#endif
45ea509a
VZ
95// ----------------------------------------------------------------------------
96// constants
97// ----------------------------------------------------------------------------
c801d85f 98
0e0126c2
RR
99#ifdef __WXWINCE__
100 typedef long off_t;
101#else
6294ac2e
VZ
102 // define off_t
103 #if !defined(__WXMAC__) || defined(__UNIX__) || defined(__MACH__)
104 #include <sys/types.h>
105 #else
106 typedef long off_t;
107 #endif
17dff81c 108#endif
45ea509a 109
65df77ec 110#if (defined(__VISUALC__) && !defined(__WXWINCE__)) || ( defined(__MWERKS__) && defined( __INTEL__) )
3f4a0c5b 111 typedef _off_t off_t;
2bdf7154 112#elif defined(__SYMANTEC__)
3f4a0c5b 113 typedef long off_t;
2d2ed20f 114#elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__)
8be97d65 115 typedef long off_t;
2432b92d
JS
116#endif
117
7af89395
VZ
118enum wxSeekMode
119{
45ea509a
VZ
120 wxFromStart,
121 wxFromCurrent,
122 wxFromEnd
7af89395 123};
45ea509a 124
0912690b 125enum wxFileKind
3c70014d 126{
0912690b
MW
127 wxFILE_KIND_UNKNOWN,
128 wxFILE_KIND_DISK, // a file supporting seeking to arbitrary offsets
129 wxFILE_KIND_TERMINAL, // a tty
130 wxFILE_KIND_PIPE // a pipe
3c70014d
MW
131};
132
f6bcfd97
BP
133// ----------------------------------------------------------------------------
134// declare our versions of low level file functions: some compilers prepend
135// underscores to the usual names, some also have Unicode versions of them
136// ----------------------------------------------------------------------------
137
6294ac2e
VZ
138// Wrappers around Win32 api functions like CreateFile, ReadFile and such
139// Implemented in filefnwce.cpp
08c63240 140#if defined( __WXWINCE__)
6294ac2e
VZ
141 typedef __int64 wxFileOffset;
142 #define wxFileOffsetFmtSpec _("I64")
143 int wxOpen(const wxChar *filename, int oflag, int WXUNUSED(pmode));
144 int wxAccess(const wxChar *name, int WXUNUSED(how));
145 int wxClose(int fd);
146 int wxFsync(int WXUNUSED(fd));
147 int wxRead(int fd, void *buf, unsigned int count);
148 int wxWrite(int fd, const void *buf, unsigned int count);
149 int wxEof(int fd);
150 wxFileOffset wxSeek(int fd, wxFileOffset offset, int origin);
3c70014d 151 inline HANDLE wxGetOSFHandle(int fd) { return (HANDLE)fd; }
6294ac2e
VZ
152 #define wxLSeek wxSeek
153 wxFileOffset wxTell(int fd);
c34db1be
RR
154
155 // always Unicode under WinCE
156 #define wxMkDir _wmkdir
157 #define wxRmDir _wrmdir
158 #define wxStat _wstat
6294ac2e
VZ
159 #define wxStructStat struct _stat
160
f6bcfd97 161// Microsoft compiler loves underscores, feed them to it
6294ac2e 162#elif defined( __VISUALC__ ) \
5283098e 163 || ( defined(__MINGW32__) && !defined(__WINE__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
18da7cf2 164 || ( defined(__MWERKS__) && defined(__WXMSW__) ) \
ba1e9d6c 165 || ( defined(__DMC__) && defined(__WXMSW__) ) \
18da7cf2 166 || ( defined(__WATCOMC__) && defined(__WXMSW__) )
6294ac2e 167
115148f7
VZ
168 // detect compilers which have support for huge files (currently only
169 // Digital Mars doesn't)
4055ed82 170 #ifndef __WXPALMOS__
4004775e 171 #include "wx/msw/private.h"
ffecfa5a 172 #endif
4004775e 173
4ae9be50 174 #undef wxHAS_HUGE_FILES
115148f7 175 #if defined(__MINGW32__)
4ae9be50 176 #define wxHAS_HUGE_FILES 1
6d067eb6 177 #elif defined(__MWERKS__)
4ae9be50 178 #define wxHAS_HUGE_FILES 0
115148f7 179 #elif defined(__DMC__)
4ae9be50 180 #define wxHAS_HUGE_FILES 0
115148f7 181 #elif ((_INTEGRAL_MAX_BITS >= 64) || defined(_LARGE_FILES))
4ae9be50 182 #define wxHAS_HUGE_FILES 1
6294ac2e 183 #else
4ae9be50 184 #define wxHAS_HUGE_FILES 0
6294ac2e
VZ
185 #endif
186
f6bcfd97 187 // functions
6294ac2e
VZ
188 #if defined(__BORLANDC__) || defined(__WATCOMC__)
189 #define _tell tell
190 #endif
191
4ae9be50 192 #if wxHAS_HUGE_FILES
6294ac2e
VZ
193 typedef wxLongLong_t wxFileOffset;
194 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
195 #else
4004775e 196 typedef off_t wxFileOffset;
6294ac2e
VZ
197 #endif
198
f6bcfd97 199 #define wxClose _close
6294ac2e
VZ
200
201 #if defined(__MWERKS__)
202 #if __MSL__ >= 0x6000
6d067eb6
VZ
203 #define wxRead(fd, buf, nCount) _read(fd, (void *)buf, nCount)
204 #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)
6294ac2e 205 #else
6d067eb6
VZ
206 #define wxRead(fd, buf, nCount)\
207 _read(fd, (const char *)buf, nCount)
208 #define wxWrite(fd, buf, nCount)\
209 _write(fd, (const char *)buf, nCount)
6294ac2e
VZ
210 #endif
211 #else
30984dea 212 #if defined(__DMC__) || defined(__WATCOMC__)
6294ac2e
VZ
213 #define wxRead ::read
214 #define wxWrite ::write
215 #else
216 #define wxRead _read
217 #define wxWrite _write
218 #endif
219 #endif
4ae9be50 220 #if wxHAS_HUGE_FILES
6294ac2e
VZ
221 #define wxSeek _lseeki64
222 #define wxLseek _lseeki64
223 #define wxTell _telli64
224 #else
225 #define wxSeek _lseek
226 #define wxLseek _lseek
227 #define wxTell _tell
228 #endif
f6bcfd97 229 #define wxFsync _commit
1239ac2e
WS
230 #if defined(__WATCOMC__)
231 #define wxEof ::eof
232 #else
233 #define wxEof _eof
234 #endif
f6bcfd97 235
f6bcfd97 236 #if wxUSE_UNICODE
6de5b599 237 #if wxUSE_UNICODE_MSLU
3e6477f4 238 #define wxOpen wxMSLU__wopen
a62848fd 239
3d5231db
VS
240 #define wxAccess wxMSLU__waccess
241 #define wxMkDir wxMSLU__wmkdir
242 #define wxRmDir wxMSLU__wrmdir
4ae9be50 243 #if wxHAS_HUGE_FILES
6294ac2e
VZ
244 #define wxStat wxMSLU__wstati64
245 #else
246 #define wxStat wxMSLU__wstat
247 #endif
6de5b599
VS
248 #else
249 #define wxOpen _wopen
3d5231db
VS
250 #define wxAccess _waccess
251 #define wxMkDir _wmkdir
252 #define wxRmDir _wrmdir
4ae9be50 253 #if wxHAS_HUGE_FILES
6294ac2e
VZ
254 #define wxStat _wstati64
255 #else
256 #define wxStat _wstat
257 #endif
6de5b599 258 #endif
f6bcfd97 259 #else // !wxUSE_UNICODE
6294ac2e
VZ
260 #ifdef __BORLANDC__
261 #define wxOpen open
262 #else
263 #define wxOpen _open
264 #endif
f6bcfd97 265 #define wxAccess _access
f6bcfd97 266 #define wxMkDir _mkdir
6294ac2e
VZ
267 #ifdef __WATCOMC__
268 #define wxRmDir rmdir
269 #else
270 #define wxRmDir _rmdir
271 #endif
4ae9be50 272 #if wxHAS_HUGE_FILES
6294ac2e
VZ
273 #define wxStat _stati64
274 #else
275 #define wxStat _stat
276 #endif
f6bcfd97
BP
277 #endif
278
e302e0c1
VZ
279 // types: notice that Watcom is the only compiler to have a wide char
280 // version of struct stat as well as a wide char stat function variant
4ae9be50 281 #if wxHAS_HUGE_FILES
e302e0c1 282 #if wxUSE_UNICODE && defined(__WATCOMC__)
6294ac2e
VZ
283 #define wxStructStat struct _wstati64
284 #else
285 #define wxStructStat struct _stati64
286 #endif
287 #else
e302e0c1 288 #if wxUSE_UNICODE && defined(__WATCOMC__)
6294ac2e
VZ
289 #define wxStructStat struct _wstat
290 #else
291 #define wxStructStat struct _stat
292 #endif
293 #endif
f6bcfd97
BP
294
295 // constants (unless already defined by the user code)
4055ed82 296 #if !defined(__BORLANDC__) && !defined(__WATCOMC__) && !defined(__WXPALMOS__)
eb84314b
VZ
297 #ifndef O_RDONLY
298 #define O_RDONLY _O_RDONLY
299 #define O_WRONLY _O_WRONLY
300 #define O_RDWR _O_RDWR
301 #define O_EXCL _O_EXCL
302 #define O_CREAT _O_CREAT
303 #define O_BINARY _O_BINARY
304 #endif
305
306 #ifndef S_IFMT
307 #define S_IFMT _S_IFMT
308 #define S_IFDIR _S_IFDIR
309 #define S_IFREG _S_IFREG
310 #endif
311 #endif
6294ac2e
VZ
312
313 // It's a private define, undefine it so nobody gets tempted to use it
4ae9be50 314 #undef wxHAS_HUGE_FILES
06e66bd0 315#else // Unix platforms using configure
6294ac2e
VZ
316 typedef off_t wxFileOffset;
317 #ifdef _LARGE_FILES
318 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
bd3cea7d
VZ
319 wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t),
320 BadFileSizeType );
6294ac2e
VZ
321 #else
322 #define wxFileOffsetFmtSpec _T("")
323 #endif
f6bcfd97 324 // functions
f6bcfd97 325 #define wxClose close
6294ac2e
VZ
326 #define wxRead ::read
327 #define wxWrite ::write
f6bcfd97 328 #define wxLseek lseek
6294ac2e 329 #define wxSeek lseek
f6bcfd97 330 #define wxFsync commit
f6bcfd97
BP
331 #define wxEof eof
332
333 #define wxMkDir mkdir
334 #define wxRmDir rmdir
335
336 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
337
f6bcfd97 338 #define wxStructStat struct stat
a62848fd 339
6294ac2e
VZ
340 #if wxUSE_UNICODE
341 #define wxNEED_WX_UNISTD_H
342 #if defined(__DMC__)
343 typedef unsigned long mode_t;
344 #endif
345 WXDLLIMPEXP_BASE int wxStat( const wxChar *file_name, wxStructStat *buf );
346 WXDLLIMPEXP_BASE int wxAccess( const wxChar *pathname, int mode );
347 WXDLLIMPEXP_BASE int wxOpen( const wxChar *pathname, int flags, mode_t mode );
348 #else
349 #define wxOpen open
350 #define wxStat stat
351 #define wxAccess access
352 #endif
06e66bd0 353#endif // platforms
f6bcfd97 354
b444ce11 355#if defined(__WXMSW__) && !defined(__WXWINCE__)
3c70014d 356 // get the HANDLE associated with a file descriptor
7722d490
DS
357# ifdef __CYGWIN__
358# include "wx/msw/private.h" // for HANDLE
359# include <io.h> // for get_osfhandle()
360 inline HANDLE wxGetOSFHandle(int fd) { return (HANDLE) get_osfhandle(fd); }
361# else
5c702259
WS
362# ifdef __BORLANDC__
363# include "wx/msw/private.h" // for HANDLE
364# endif
7722d490
DS
365 inline HANDLE wxGetOSFHandle(int fd) { return (HANDLE) _get_osfhandle(fd); }
366# endif
3c70014d
MW
367#endif
368
06e66bd0
VZ
369#if defined(__VISAGECPP__) && __IBMCPP__ >= 400
370//
371// VisualAge C++ V4.0 cannot have any external linkage const decs
372// in headers included by more than one primary source
373//
30984dea 374extern const int wxInvalidOffset;
06e66bd0 375#else
30984dea 376const int wxInvalidOffset = -1;
06e66bd0 377#endif
f6bcfd97 378
45ea509a
VZ
379// ----------------------------------------------------------------------------
380// functions
381// ----------------------------------------------------------------------------
bddd7a8d 382WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);
c801d85f
KB
383
384// does the path exist? (may have or not '/' or '\\' at the end)
bddd7a8d 385WXDLLIMPEXP_BASE bool wxPathExists(const wxChar *pszPathName);
c801d85f 386
bddd7a8d 387WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);
c801d85f
KB
388
389// Get filename
bddd7a8d
VZ
390WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path);
391WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path);
c801d85f
KB
392
393// Get directory
bddd7a8d 394WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path);
c801d85f
KB
395
396// wxString version
bddd7a8d 397WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path);
c801d85f 398
bddd7a8d 399WXDLLIMPEXP_BASE void wxDos2UnixFilename(wxChar *s);
c801d85f 400
bddd7a8d 401WXDLLIMPEXP_BASE void wxUnix2DosFilename(wxChar *s);
c801d85f
KB
402
403// Strip the extension, in situ
bddd7a8d
VZ
404WXDLLIMPEXP_BASE void wxStripExtension(wxChar *buffer);
405WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer);
c801d85f 406
ade35f11 407// Get a temporary filename
bddd7a8d
VZ
408WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
409WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf);
c801d85f
KB
410
411// Expand file name (~/ and ${OPENWINHOME}/ stuff)
bddd7a8d
VZ
412WXDLLIMPEXP_BASE wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
413WXDLLIMPEXP_BASE bool wxExpandPath(wxString& dest, const wxChar *path);
c801d85f
KB
414
415// Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
416// and make (if under the home tree) relative to home
417// [caller must copy-- volatile]
bddd7a8d 418WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename,
ade35f11
VZ
419 const wxString& envname = wxEmptyString,
420 const wxString& user = wxEmptyString);
c801d85f
KB
421
422// Destructive removal of /./ and /../ stuff
bddd7a8d 423WXDLLIMPEXP_BASE wxChar* wxRealPath(wxChar *path);
c801d85f
KB
424
425// Allocate a copy of the full absolute path
bddd7a8d 426WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path);
c801d85f
KB
427
428// Get first file name matching given wild card.
429// Flags are reserved for future use.
430#define wxFILE 1
431#define wxDIR 2
bddd7a8d
VZ
432WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
433WXDLLIMPEXP_BASE wxString wxFindNextFile();
c801d85f
KB
434
435// Does the pattern contain wildcards?
bddd7a8d 436WXDLLIMPEXP_BASE bool wxIsWild(const wxString& pattern);
c801d85f
KB
437
438// Does the pattern match the text (usually a filename)?
a62848fd 439// If dot_special is true, doesn't match * against . (eliminating
c801d85f 440// `hidden' dot files)
a62848fd 441WXDLLIMPEXP_BASE bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = true);
c801d85f
KB
442
443// Concatenate two files to form third
bddd7a8d 444WXDLLIMPEXP_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
c801d85f
KB
445
446// Copy file1 to file2
bddd7a8d 447WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
a62848fd 448 bool overwrite = true);
c801d85f
KB
449
450// Remove file
bddd7a8d 451WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
c801d85f
KB
452
453// Rename file
bddd7a8d 454WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2);
c801d85f
KB
455
456// Get current working directory.
457// If buf is NULL, allocates space using new, else
458// copies into buf.
459// IMPORTANT NOTE getcwd is know not to work under some releases
460// of Win32s 1.3, according to MS release notes!
bddd7a8d 461WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000);
7af89395
VZ
462// new and preferred version of wxGetWorkingDirectory
463// NB: can't have the same name because of overloading ambiguity
bddd7a8d 464WXDLLIMPEXP_BASE wxString wxGetCwd();
c801d85f
KB
465
466// Set working directory
bddd7a8d 467WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d);
c801d85f
KB
468
469// Make directory
bddd7a8d 470WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = 0777);
c801d85f
KB
471
472// Remove directory. Flags reserved for future use.
bddd7a8d 473WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
c801d85f 474
3c70014d 475// Return the type of an open file
0912690b
MW
476WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(int fd);
477inline wxFileKind wxGetFileKind (FILE *fp) { return wxGetFileKind(fileno(fp)); }
3c70014d 478
2b5f62a0
VZ
479// compatibility defines, don't use in new code
480#define wxDirExists wxPathExists
481
ff69a290 482// ----------------------------------------------------------------------------
c801d85f 483// separators in file names
ff69a290
VZ
484// ----------------------------------------------------------------------------
485
486// between file name and extension
223d09f6 487#define wxFILE_SEP_EXT wxT('.')
ff69a290
VZ
488
489// between drive/volume name and the path
223d09f6 490#define wxFILE_SEP_DSK wxT(':')
ff69a290
VZ
491
492// between the path components
223d09f6
KB
493#define wxFILE_SEP_PATH_DOS wxT('\\')
494#define wxFILE_SEP_PATH_UNIX wxT('/')
844f90fb 495#define wxFILE_SEP_PATH_MAC wxT(':')
ff69a290 496#define wxFILE_SEP_PATH_VMS wxT('.') // VMS also uses '[' and ']'
c801d85f
KB
497
498// separator in the path list (as in PATH environment variable)
03e11df5
GD
499// there is no PATH variable in Classic Mac OS so just use the
500// semicolon (it must be different from the file name separator)
c801d85f 501// NB: these are strings and not characters on purpose!
223d09f6
KB
502#define wxPATH_SEP_DOS wxT(";")
503#define wxPATH_SEP_UNIX wxT(":")
03e11df5 504#define wxPATH_SEP_MAC wxT(";")
c801d85f
KB
505
506// platform independent versions
77a80672
VZ
507#if defined(__UNIX__) && !defined(__OS2__)
508 // CYGWIN also uses UNIX settings
7af89395
VZ
509 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
510 #define wxPATH_SEP wxPATH_SEP_UNIX
844f90fb 511#elif defined(__MAC__)
bedaf53e 512 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_MAC
3369df87 513 #define wxPATH_SEP wxPATH_SEP_MAC
1777b9bb 514#else // Windows and OS/2
7af89395
VZ
515 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS
516 #define wxPATH_SEP wxPATH_SEP_DOS
c801d85f
KB
517#endif // Unix/Windows
518
92abb45d
VZ
519// this is useful for wxString::IsSameAs(): to compare two file names use
520// filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
28e5e577 521#if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__)
a62848fd 522 #define wxARE_FILENAMES_CASE_SENSITIVE true
3369df87 523#else // Windows, Mac OS and OS/2
a62848fd 524 #define wxARE_FILENAMES_CASE_SENSITIVE false
92abb45d
VZ
525#endif // Unix/Windows
526
c801d85f 527// is the char a path separator?
9d2f3c71 528inline bool wxIsPathSeparator(wxChar c)
903b61cc
VZ
529{
530 // under DOS/Windows we should understand both Unix and DOS file separators
a62848fd 531#if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
903b61cc
VZ
532 return c == wxFILE_SEP_PATH;
533#else
534 return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX;
535#endif
536}
c801d85f
KB
537
538// does the string ends with path separator?
bddd7a8d 539WXDLLIMPEXP_BASE bool wxEndsWithPathSeparator(const wxChar *pszFileName);
c801d85f 540
92abb45d
VZ
541// split the full path into path (including drive for DOS), name and extension
542// (understands both '/' and '\\')
bddd7a8d 543WXDLLIMPEXP_BASE void wxSplitPath(const wxChar *pszFileName,
92abb45d
VZ
544 wxString *pstrPath,
545 wxString *pstrName,
546 wxString *pstrExt);
547
c801d85f 548// find a file in a list of directories, returns false if not found
bddd7a8d 549WXDLLIMPEXP_BASE bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile);
c801d85f 550
631f1bfe
JS
551// Get the OS directory if appropriate (such as the Windows directory).
552// On non-Windows platform, probably just return the empty string.
bddd7a8d 553WXDLLIMPEXP_BASE wxString wxGetOSDirectory();
631f1bfe 554
a47ce4a7 555// Get file modification time
bddd7a8d 556WXDLLIMPEXP_BASE time_t wxFileModificationTime(const wxString& filename);
a47ce4a7 557
9e152a55
WS
558// Parses the wildCard, returning the number of filters.
559// Returns 0 if none or if there's a problem,
560// The arrays will contain an equal number of items found before the error.
561// wildCard is in the form:
562// "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
daf32463 563WXDLLIMPEXP_BASE int wxParseCommonDialogsFilter(const wxString& wildCard, wxArrayString& descriptions, wxArrayString& filters);
9e152a55 564
45ea509a
VZ
565// ----------------------------------------------------------------------------
566// classes
567// ----------------------------------------------------------------------------
568
8482e4bd
VZ
569#ifdef __UNIX__
570
571// set umask to the given value in ctor and reset it to the old one in dtor
572class WXDLLIMPEXP_BASE wxUmaskChanger
573{
574public:
575 // change the umask to the given one if it is not -1: this allows to write
576 // the same code whether you really want to change umask or not, as is in
577 // wxFileConfig::Flush() for example
578 wxUmaskChanger(int umaskNew)
579 {
835fab50 580 m_umaskOld = umaskNew == -1 ? -1 : (int)umask((mode_t)umaskNew);
8482e4bd
VZ
581 }
582
583 ~wxUmaskChanger()
584 {
585 if ( m_umaskOld != -1 )
586 umask((mode_t)m_umaskOld);
587 }
588
589private:
590 int m_umaskOld;
591};
592
593// this macro expands to an "anonymous" wxUmaskChanger object under Unix and
594// nothing elsewhere
595#define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
596
597#else // !__UNIX__
598
599#define wxCHANGE_UMASK(m)
600
601#endif // __UNIX__/!__UNIX__
602
603
c801d85f 604// Path searching
bddd7a8d 605class WXDLLIMPEXP_BASE wxPathList : public wxStringList
c801d85f 606{
a6f6393c 607public:
df5168c4
MB
608 // avoid GCC warning about virtual functions w/o virtual dtor
609 virtual ~wxPathList() {}
610
7af89395
VZ
611 // Adds all paths in environment variable
612 void AddEnvList(const wxString& envVariable);
c330a2cf 613
a6f6393c 614 void Add(const wxString& path);
7af89395
VZ
615 // Find the first full path for which the file exists
616 wxString FindValidPath(const wxString& filename);
617 // Find the first full path for which the file exists; ensure it's an
618 // absolute path that gets returned.
619 wxString FindAbsoluteValidPath(const wxString& filename);
620 // Given full path and filename, add path to list
621 void EnsureFileAccessible(const wxString& path);
a62848fd 622 // Returns true if the path is in the list
a6f6393c
VZ
623 bool Member(const wxString& path);
624
625private:
df5168c4 626 // DECLARE_DYNAMIC_CLASS(wxPathList)
c801d85f
KB
627};
628
629#endif
34138703 630 // _WX_FILEFN_H_