]> 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
remove warnings of intentionally unreachable code
[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 // at least Borland 5.5 doesn't like "struct ::stat" so don't use the scope
208 // resolution operator present in wxPOSIX_IDENT for it
209 #ifdef __BORLANDC__
210 #define wxPOSIX_STRUCT(s) struct s
211 #else
212 #define wxPOSIX_STRUCT(s) struct wxPOSIX_IDENT(s)
213 #endif
214
215 // first functions not working with strings, i.e. without ANSI/Unicode
216 // complications
217 #define wxClose wxPOSIX_IDENT(close)
218
219 #if defined(__MWERKS__)
220 #if __MSL__ >= 0x6000
221 #define wxRead(fd, buf, nCount) _read(fd, (void *)buf, nCount)
222 #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)
223 #else
224 #define wxRead(fd, buf, nCount)\
225 _read(fd, (const char *)buf, nCount)
226 #define wxWrite(fd, buf, nCount)\
227 _write(fd, (const char *)buf, nCount)
228 #endif
229 #else // __MWERKS__
230 #define wxRead wxPOSIX_IDENT(read)
231 #define wxWrite wxPOSIX_IDENT(write)
232 #endif
233
234 #ifdef wxHAS_HUGE_FILES
235 #define wxSeek wxPOSIX_IDENT(lseeki64)
236 #define wxLseek wxPOSIX_IDENT(lseeki64)
237 #define wxTell wxPOSIX_IDENT(telli64)
238 #else // !wxHAS_HUGE_FILES
239 #define wxSeek wxPOSIX_IDENT(lseek)
240 #define wxLseek wxPOSIX_IDENT(lseek)
241 #define wxTell wxPOSIX_IDENT(tell)
242 #endif // wxHAS_HUGE_FILES/!wxHAS_HUGE_FILES
243
244 #ifndef __WATCOMC__
245 #if !defined(__BORLANDC__) || (__BORLANDC__ > 0x540)
246 // NB: this one is not POSIX and always has the underscore
247 #define wxFsync _commit
248
249 #define HAVE_FSYNC
250 #endif // BORLANDC
251 #endif
252
253 #define wxEof wxPOSIX_IDENT(eof)
254
255 // then the functions taking strings
256 #if wxUSE_UNICODE
257 #if wxUSE_UNICODE_MSLU
258 // implement the missing file functions in Win9x ourselves
259 #if defined( __VISUALC__ ) \
260 || ( defined(__MINGW32__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
261 || ( defined(__MWERKS__) && defined(__WXMSW__) ) \
262 || ( defined(__BORLANDC__) && (__BORLANDC__ > 0x460) ) \
263 || defined(__DMC__)
264
265 WXDLLIMPEXP_BASE int wxMSLU__wopen(const wxChar *name,
266 int flags, int mode);
267 WXDLLIMPEXP_BASE int wxMSLU__waccess(const wxChar *name,
268 int mode);
269 WXDLLIMPEXP_BASE int wxMSLU__wmkdir(const wxChar *name);
270 WXDLLIMPEXP_BASE int wxMSLU__wrmdir(const wxChar *name);
271
272 WXDLLIMPEXP_BASE int
273 wxMSLU__wstat(const wxChar *name, wxPOSIX_STRUCT(stat) *buffer);
274 WXDLLIMPEXP_BASE int
275 wxMSLU__wstati64(const wxChar *name,
276 wxPOSIX_STRUCT(stati64) *buffer);
277 #endif // Windows compilers with MSLU support
278
279 #define wxOpen wxMSLU__wopen
280
281 #define wxAccess wxMSLU__waccess
282 #define wxMkDir wxMSLU__wmkdir
283 #define wxRmDir wxMSLU__wrmdir
284 #ifdef wxHAS_HUGE_FILES
285 #define wxStat wxMSLU__wstati64
286 #else
287 #define wxStat wxMSLU__wstat
288 #endif
289 #else // !wxUSE_UNICODE_MSLU
290 #ifdef __BORLANDC__
291 #if __BORLANDC__ >= 0x550 && __BORLANDC__ <= 0x551
292 WXDLLIMPEXP_BASE int wxOpen(const wxChar *pathname,
293 int flags, mode_t mode);
294 #else
295 #define wxOpen _wopen
296 #endif
297 #define wxAccess _waccess
298 #define wxMkDir _wmkdir
299 #define wxRmDir _wrmdir
300 #ifdef wxHAS_HUGE_FILES
301 #define wxStat _wstati64
302 #else
303 #define wxStat _wstat
304 #endif
305 #else
306 #define wxOpen _wopen
307 #define wxAccess _waccess
308 #define wxMkDir _wmkdir
309 #define wxRmDir _wrmdir
310 #ifdef wxHAS_HUGE_FILES
311 #define wxStat _wstati64
312 #else
313 #define wxStat _wstat
314 #endif
315 #endif
316 #endif // wxUSE_UNICODE_MSLU/!wxUSE_UNICODE_MSLU
317 #else // !wxUSE_UNICODE
318 #define wxOpen wxPOSIX_IDENT(open)
319 #define wxAccess wxPOSIX_IDENT(access)
320 #define wxMkDir wxPOSIX_IDENT(mkdir)
321 #define wxRmDir wxPOSIX_IDENT(rmdir)
322 #ifdef wxHAS_HUGE_FILES
323 #define wxStat wxPOSIX_IDENT(stati64)
324 #else
325 #define wxStat wxPOSIX_IDENT(stat)
326 #endif
327 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
328
329 // Types: Notice that Watcom is the only compiler to have a wide char
330 // version of struct stat as well as a wide char stat function variant.
331 // This was droped since OW 1.4 "for consistency across platforms".
332 #ifdef wxHAS_HUGE_FILES
333 #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
334 #define wxStructStat struct _wstati64
335 #else
336 #define wxStructStat struct _stati64
337 #endif
338 #else
339 #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
340 #define wxStructStat struct _wstat
341 #else
342 #define wxStructStat struct _stat
343 #endif
344 #endif
345
346 // constants (unless already defined by the user code)
347 #ifdef wxHAS_UNDERSCORES_IN_POSIX_IDENTS
348 #ifndef O_RDONLY
349 #define O_RDONLY _O_RDONLY
350 #define O_WRONLY _O_WRONLY
351 #define O_RDWR _O_RDWR
352 #define O_EXCL _O_EXCL
353 #define O_CREAT _O_CREAT
354 #define O_BINARY _O_BINARY
355 #endif
356
357 #ifndef S_IFMT
358 #define S_IFMT _S_IFMT
359 #define S_IFDIR _S_IFDIR
360 #define S_IFREG _S_IFREG
361 #endif
362 #endif // wxHAS_UNDERSCORES_IN_POSIX_IDENTS
363
364 #ifdef wxHAS_HUGE_FILES
365 // wxFile is present and supports large files. Currently wxFFile
366 // doesn't have large file support with any Windows compiler (even
367 // Win64 ones).
368 #if wxUSE_FILE
369 #define wxHAS_LARGE_FILES
370 #endif
371 #endif
372
373 // it's a private define, undefine it so that nobody gets tempted to use it
374 #undef wxHAS_HUGE_FILES
375#else // Unix or Windows using unknown compiler, assume POSIX supported
376 typedef off_t wxFileOffset;
377 #ifdef _LARGE_FILES
378 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
379 wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t),
380 BadFileSizeType );
381 // wxFile is present and supports large files
382 #ifdef wxUSE_FILE
383 #define wxHAS_LARGE_FILES
384 #endif
385 // wxFFile is present and supports large files
386 #if SIZEOF_LONG == 8 || defined HAVE_FSEEKO
387 #define wxHAS_LARGE_FFILES
388 #endif
389 #else
390 #define wxFileOffsetFmtSpec _T("")
391 #endif
392 // functions
393 #define wxClose close
394 #define wxRead ::read
395 #define wxWrite ::write
396 #define wxLseek lseek
397 #define wxSeek lseek
398 #define wxFsync fsync
399 #define wxEof eof
400
401 #define wxMkDir mkdir
402 #define wxRmDir rmdir
403
404 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
405
406 #define wxStructStat struct stat
407
408 #if wxUSE_UNICODE
409 #define wxNEED_WX_UNISTD_H
410 #if defined(__DMC__)
411 typedef unsigned long mode_t;
412 #endif
413 WXDLLIMPEXP_BASE int wxStat( const wxChar *file_name, wxStructStat *buf );
414 WXDLLIMPEXP_BASE int wxLstat( const wxChar *file_name, wxStructStat *buf );
415 WXDLLIMPEXP_BASE int wxAccess( const wxChar *pathname, int mode );
416 WXDLLIMPEXP_BASE int wxOpen( const wxChar *pathname, int flags, mode_t mode );
417 #else
418 #define wxOpen open
419 #define wxStat stat
420 #define wxLstat lstat
421 #define wxAccess access
422 #endif
423
424 #define wxHAS_NATIVE_LSTAT
425#endif // platforms
426
427#ifdef O_BINARY
428 #define wxO_BINARY O_BINARY
429#else
430 #define wxO_BINARY 0
431#endif
432
433// if the platform doesn't have symlinks, define wxLstat to be the same as
434// wxStat to avoid #ifdefs in the code using it
435#ifndef wxHAS_NATIVE_LSTAT
436 #define wxLstat wxStat
437#endif
438
439#if defined(__VISAGECPP__) && __IBMCPP__ >= 400
440//
441// VisualAge C++ V4.0 cannot have any external linkage const decs
442// in headers included by more than one primary source
443//
444extern const int wxInvalidOffset;
445#else
446const int wxInvalidOffset = -1;
447#endif
448
449// ----------------------------------------------------------------------------
450// functions
451// ----------------------------------------------------------------------------
452WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);
453
454// does the path exist? (may have or not '/' or '\\' at the end)
455WXDLLIMPEXP_BASE bool wxDirExists(const wxString& pathName);
456
457WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);
458
459// Get filename
460WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path);
461WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path);
462
463// Get directory
464WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path);
465
466// wxString version
467WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path);
468
469WXDLLIMPEXP_BASE void wxDos2UnixFilename(wxChar *s);
470
471WXDLLIMPEXP_BASE void wxUnix2DosFilename(wxChar *s);
472
473// Strip the extension, in situ
474WXDLLIMPEXP_BASE void wxStripExtension(wxChar *buffer);
475WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer);
476
477// Get a temporary filename
478WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
479WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf);
480
481// Expand file name (~/ and ${OPENWINHOME}/ stuff)
482WXDLLIMPEXP_BASE wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
483WXDLLIMPEXP_BASE bool wxExpandPath(wxString& dest, const wxChar *path);
484
485// Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
486// and make (if under the home tree) relative to home
487// [caller must copy-- volatile]
488WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename,
489 const wxString& envname = wxEmptyString,
490 const wxString& user = wxEmptyString);
491
492// Destructive removal of /./ and /../ stuff
493WXDLLIMPEXP_BASE wxChar* wxRealPath(wxChar *path);
494
495// Allocate a copy of the full absolute path
496WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path);
497
498// Get first file name matching given wild card.
499// Flags are reserved for future use.
500#define wxFILE 1
501#define wxDIR 2
502WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
503WXDLLIMPEXP_BASE wxString wxFindNextFile();
504
505// Does the pattern contain wildcards?
506WXDLLIMPEXP_BASE bool wxIsWild(const wxString& pattern);
507
508// Does the pattern match the text (usually a filename)?
509// If dot_special is true, doesn't match * against . (eliminating
510// `hidden' dot files)
511WXDLLIMPEXP_BASE bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = true);
512
513// Concatenate two files to form third
514WXDLLIMPEXP_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
515
516// Copy file1 to file2
517WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
518 bool overwrite = true);
519
520// Remove file
521WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
522
523// Rename file
524WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2, bool overwrite = true);
525
526// Get current working directory.
527#if WXWIN_COMPATIBILITY_2_6
528// If buf is NULL, allocates space using new, else
529// copies into buf.
530// IMPORTANT NOTE getcwd is know not to work under some releases
531// of Win32s 1.3, according to MS release notes!
532wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000) );
533// new and preferred version of wxGetWorkingDirectory
534// NB: can't have the same name because of overloading ambiguity
535#endif // WXWIN_COMPATIBILITY_2_6
536WXDLLIMPEXP_BASE wxString wxGetCwd();
537
538// Set working directory
539WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d);
540
541// Make directory
542WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = 0777);
543
544// Remove directory. Flags reserved for future use.
545WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
546
547// Return the type of an open file
548WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(int fd);
549WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(FILE *fp);
550
551#if WXWIN_COMPATIBILITY_2_6
552// compatibility defines, don't use in new code
553wxDEPRECATED( inline bool wxPathExists(const wxChar *pszPathName) );
554inline bool wxPathExists(const wxChar *pszPathName)
555{
556 return wxDirExists(pszPathName);
557}
558#endif //WXWIN_COMPATIBILITY_2_6
559
560// permissions; these functions work both on files and directories:
561WXDLLIMPEXP_BASE bool wxIsWritable(const wxString &path);
562WXDLLIMPEXP_BASE bool wxIsReadable(const wxString &path);
563WXDLLIMPEXP_BASE bool wxIsExecutable(const wxString &path);
564
565// ----------------------------------------------------------------------------
566// separators in file names
567// ----------------------------------------------------------------------------
568
569// between file name and extension
570#define wxFILE_SEP_EXT wxT('.')
571
572// between drive/volume name and the path
573#define wxFILE_SEP_DSK wxT(':')
574
575// between the path components
576#define wxFILE_SEP_PATH_DOS wxT('\\')
577#define wxFILE_SEP_PATH_UNIX wxT('/')
578#define wxFILE_SEP_PATH_MAC wxT(':')
579#define wxFILE_SEP_PATH_VMS wxT('.') // VMS also uses '[' and ']'
580
581// separator in the path list (as in PATH environment variable)
582// there is no PATH variable in Classic Mac OS so just use the
583// semicolon (it must be different from the file name separator)
584// NB: these are strings and not characters on purpose!
585#define wxPATH_SEP_DOS wxT(";")
586#define wxPATH_SEP_UNIX wxT(":")
587#define wxPATH_SEP_MAC wxT(";")
588
589// platform independent versions
590#if defined(__UNIX__) && !defined(__OS2__)
591 // CYGWIN also uses UNIX settings
592 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
593 #define wxPATH_SEP wxPATH_SEP_UNIX
594#elif defined(__MAC__)
595 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_MAC
596 #define wxPATH_SEP wxPATH_SEP_MAC
597#else // Windows and OS/2
598 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS
599 #define wxPATH_SEP wxPATH_SEP_DOS
600#endif // Unix/Windows
601
602// this is useful for wxString::IsSameAs(): to compare two file names use
603// filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
604#if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__)
605 #define wxARE_FILENAMES_CASE_SENSITIVE true
606#else // Windows, Mac OS and OS/2
607 #define wxARE_FILENAMES_CASE_SENSITIVE false
608#endif // Unix/Windows
609
610// is the char a path separator?
611inline bool wxIsPathSeparator(wxChar c)
612{
613 // under DOS/Windows we should understand both Unix and DOS file separators
614#if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
615 return c == wxFILE_SEP_PATH;
616#else
617 return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX;
618#endif
619}
620
621// does the string ends with path separator?
622WXDLLIMPEXP_BASE bool wxEndsWithPathSeparator(const wxChar *pszFileName);
623
624// split the full path into path (including drive for DOS), name and extension
625// (understands both '/' and '\\')
626WXDLLIMPEXP_BASE void wxSplitPath(const wxChar *pszFileName,
627 wxString *pstrPath,
628 wxString *pstrName,
629 wxString *pstrExt);
630
631// find a file in a list of directories, returns false if not found
632WXDLLIMPEXP_BASE bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile);
633
634// Get the OS directory if appropriate (such as the Windows directory).
635// On non-Windows platform, probably just return the empty string.
636WXDLLIMPEXP_BASE wxString wxGetOSDirectory();
637
638#if wxUSE_DATETIME
639
640// Get file modification time
641WXDLLIMPEXP_BASE time_t wxFileModificationTime(const wxString& filename);
642
643#endif // wxUSE_DATETIME
644
645// Parses the wildCard, returning the number of filters.
646// Returns 0 if none or if there's a problem,
647// The arrays will contain an equal number of items found before the error.
648// wildCard is in the form:
649// "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
650WXDLLIMPEXP_BASE int wxParseCommonDialogsFilter(const wxString& wildCard, wxArrayString& descriptions, wxArrayString& filters);
651
652// ----------------------------------------------------------------------------
653// classes
654// ----------------------------------------------------------------------------
655
656#ifdef __UNIX__
657
658// set umask to the given value in ctor and reset it to the old one in dtor
659class WXDLLIMPEXP_BASE wxUmaskChanger
660{
661public:
662 // change the umask to the given one if it is not -1: this allows to write
663 // the same code whether you really want to change umask or not, as is in
664 // wxFileConfig::Flush() for example
665 wxUmaskChanger(int umaskNew)
666 {
667 m_umaskOld = umaskNew == -1 ? -1 : (int)umask((mode_t)umaskNew);
668 }
669
670 ~wxUmaskChanger()
671 {
672 if ( m_umaskOld != -1 )
673 umask((mode_t)m_umaskOld);
674 }
675
676private:
677 int m_umaskOld;
678};
679
680// this macro expands to an "anonymous" wxUmaskChanger object under Unix and
681// nothing elsewhere
682#define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
683
684#else // !__UNIX__
685
686#define wxCHANGE_UMASK(m)
687
688#endif // __UNIX__/!__UNIX__
689
690
691// Path searching
692class WXDLLIMPEXP_BASE wxPathList : public wxArrayString
693{
694public:
695 wxPathList() {}
696 wxPathList(const wxArrayString &arr)
697 { Add(arr); }
698
699 // Adds all paths in environment variable
700 void AddEnvList(const wxString& envVariable);
701
702 // Adds given path to this list
703 bool Add(const wxString& path);
704 void Add(const wxArrayString &paths);
705
706 // Find the first full path for which the file exists
707 wxString FindValidPath(const wxString& filename) const;
708
709 // Find the first full path for which the file exists; ensure it's an
710 // absolute path that gets returned.
711 wxString FindAbsoluteValidPath(const wxString& filename) const;
712
713 // Given full path and filename, add path to list
714 bool EnsureFileAccessible(const wxString& path);
715
716#if WXWIN_COMPATIBILITY_2_6
717 // Returns true if the path is in the list
718 wxDEPRECATED( bool Member(const wxString& path) const );
719#endif
720};
721
722#endif // _WX_FILEFN_H_
wxWidgets (Impactor)