]> 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
corrected comment: wxSingleInstance is not for Win32 only since about 10 years
[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#ifndef __WXPALMOS5__
19#ifdef __WXWINCE__
20 #include "wx/msw/wince/time.h"
21 #include "wx/msw/private.h"
22#else
23 #include <time.h>
24#endif
25
26#ifdef __WXWINCE__
27// Nothing
28#elif !defined(__MWERKS__)
29 #include <sys/types.h>
30 #include <sys/stat.h>
31#else
32 #ifdef __MACH__
33 #include <sys/types.h>
34 #include <utime.h>
35 #include <sys/stat.h>
36 #include <unistd.h>
37 #else
38 #include <stat.h>
39 #include <unistd.h>
40 #include <unix.h>
41 #endif
42#endif
43#endif // !__WXPALMOS5__
44
45#ifdef __OS2__
46// need to check for __OS2__ first since currently both
47// __OS2__ and __UNIX__ are defined.
48 #include <process.h>
49 #include "wx/os2/private.h"
50 #ifdef __WATCOMC__
51 #include <direct.h>
52 #endif
53 #include <io.h>
54 #ifdef __EMX__
55 #include <unistd.h>
56 #endif
57#elif defined(__UNIX__)
58 #include <unistd.h>
59 #include <dirent.h>
60#endif
61
62#if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
63#if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__WXWINCE__) && !defined(__CYGWIN__)
64 #include <direct.h>
65 #include <dos.h>
66 #include <io.h>
67#endif // __WINDOWS__
68#endif // native Win compiler
69
70#if defined(__DOS__)
71 #ifdef __WATCOMC__
72 #include <direct.h>
73 #include <dos.h>
74 #include <io.h>
75 #endif
76 #ifdef __DJGPP__
77 #include <io.h>
78 #include <unistd.h>
79 #endif
80#endif
81
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.
85 #include <dir.h>
86#endif
87
88#ifndef __WXPALMOS5__
89#ifndef __WXWINCE__
90 #include <fcntl.h> // O_RDONLY &c
91#endif
92#endif // !__WXPALMOS5__
93// ----------------------------------------------------------------------------
94// constants
95// ----------------------------------------------------------------------------
96
97#if defined(__VISUALC__) || defined(__DIGITALMARS__)
98 typedef int mode_t;
99#endif
100
101#ifdef __WXWINCE__
102 typedef long off_t;
103#else
104 // define off_t
105 #if !defined(__WXMAC__) || defined(__UNIX__) || defined(__MACH__)
106 #include <sys/types.h>
107 #else
108 typedef long off_t;
109 #endif
110#endif
111
112#if (defined(__VISUALC__) && !defined(__WXWINCE__)) || ( defined(__MWERKS__) && defined( __INTEL__) )
113 typedef _off_t off_t;
114#elif defined(__SYMANTEC__)
115 typedef long off_t;
116#elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__)
117 typedef long off_t;
118#elif defined(__WXPALMOS5__)
119 typedef long off_t;
120#endif
121
122enum wxSeekMode
123{
124 wxFromStart,
125 wxFromCurrent,
126 wxFromEnd
127};
128
129enum wxFileKind
130{
131 wxFILE_KIND_UNKNOWN,
132 wxFILE_KIND_DISK, // a file supporting seeking to arbitrary offsets
133 wxFILE_KIND_TERMINAL, // a tty
134 wxFILE_KIND_PIPE // a pipe
135};
136
137// ----------------------------------------------------------------------------
138// declare our versions of low level file functions: some compilers prepend
139// underscores to the usual names, some also have Unicode versions of them
140// ----------------------------------------------------------------------------
141
142// Wrappers around Win32 api functions like CreateFile, ReadFile and such
143// Implemented in filefnwce.cpp
144#if defined( __WXWINCE__)
145 typedef __int64 wxFileOffset;
146 #define wxFileOffsetFmtSpec _("I64")
147 WXDLLIMPEXP_BASE int wxCRT_Open(const wxChar *filename, int oflag, int WXUNUSED(pmode));
148 WXDLLIMPEXP_BASE int wxCRT_Access(const wxChar *name, int WXUNUSED(how));
149 WXDLLIMPEXP_BASE int wxClose(int fd);
150 WXDLLIMPEXP_BASE int wxFsync(int WXUNUSED(fd));
151 WXDLLIMPEXP_BASE int wxRead(int fd, void *buf, unsigned int count);
152 WXDLLIMPEXP_BASE int wxWrite(int fd, const void *buf, unsigned int count);
153 WXDLLIMPEXP_BASE int wxEof(int fd);
154 WXDLLIMPEXP_BASE wxFileOffset wxSeek(int fd, wxFileOffset offset, int origin);
155 #define wxLSeek wxSeek
156 WXDLLIMPEXP_BASE wxFileOffset wxTell(int fd);
157
158 // always Unicode under WinCE
159 #define wxCRT_MkDir _wmkdir
160 #define wxCRT_RmDir _wrmdir
161 #define wxCRT_Stat _wstat
162 #define wxStructStat struct _stat
163#elif (defined(__WXMSW__) || defined(__OS2__)) && !defined(__WXPALMOS__) && \
164 ( \
165 defined(__VISUALC__) || \
166 (defined(__MINGW32__) && !defined(__WINE__) && \
167 wxCHECK_W32API_VERSION(0, 5)) || \
168 defined(__MWERKS__) || \
169 defined(__DMC__) || \
170 defined(__WATCOMC__) || \
171 defined(__BORLANDC__) \
172 )
173
174 #undef wxHAS_HUGE_FILES
175
176 // detect compilers which have support for huge files
177 #if defined(__VISUALC__)
178 #define wxHAS_HUGE_FILES 1
179 #elif defined(__MINGW32__)
180 #define wxHAS_HUGE_FILES 1
181 #elif defined(_LARGE_FILES)
182 #define wxHAS_HUGE_FILES 1
183 #endif
184
185 // other Windows compilers (DMC, Watcom, Metrowerks and Borland) don't have
186 // huge file support (or at least not all functions needed for it by wx)
187 // currently
188
189 #ifdef wxHAS_HUGE_FILES
190 typedef wxLongLong_t wxFileOffset;
191 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
192 #else
193 typedef off_t wxFileOffset;
194 #endif
195
196
197 // functions
198
199 // MSVC and compatible compilers prepend underscores to the POSIX function
200 // names, other compilers don't and even if their later versions usually do
201 // define the versions with underscores for MSVC compatibility, it's better
202 // to avoid using them as they're not present in earlier versions and
203 // always using the native functions spelling is easier than testing for
204 // the versions
205 #if defined(__BORLANDC__) || defined(__DMC__) || defined(__WATCOMC__)
206 #define wxPOSIX_IDENT(func) ::func
207 #else // by default assume MSVC-compatible names
208 #define wxPOSIX_IDENT(func) _ ## func
209 #define wxHAS_UNDERSCORES_IN_POSIX_IDENTS
210 #endif
211
212 // at least Borland 5.5 doesn't like "struct ::stat" so don't use the scope
213 // resolution operator present in wxPOSIX_IDENT for it
214 #ifdef __BORLANDC__
215 #define wxPOSIX_STRUCT(s) struct s
216 #else
217 #define wxPOSIX_STRUCT(s) struct wxPOSIX_IDENT(s)
218 #endif
219
220 // first functions not working with strings, i.e. without ANSI/Unicode
221 // complications
222 #define wxClose wxPOSIX_IDENT(close)
223
224 #if defined(__MWERKS__)
225 #if __MSL__ >= 0x6000
226 #define wxRead(fd, buf, nCount) _read(fd, (void *)buf, nCount)
227 #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)
228 #else
229 #define wxRead(fd, buf, nCount)\
230 _read(fd, (const char *)buf, nCount)
231 #define wxWrite(fd, buf, nCount)\
232 _write(fd, (const char *)buf, nCount)
233 #endif
234 #else // __MWERKS__
235 #define wxRead wxPOSIX_IDENT(read)
236 #define wxWrite wxPOSIX_IDENT(write)
237 #endif
238
239 #ifdef wxHAS_HUGE_FILES
240 #define wxSeek wxPOSIX_IDENT(lseeki64)
241 #define wxLseek wxPOSIX_IDENT(lseeki64)
242 #define wxTell wxPOSIX_IDENT(telli64)
243 #else // !wxHAS_HUGE_FILES
244 #define wxSeek wxPOSIX_IDENT(lseek)
245 #define wxLseek wxPOSIX_IDENT(lseek)
246 #define wxTell wxPOSIX_IDENT(tell)
247 #endif // wxHAS_HUGE_FILES/!wxHAS_HUGE_FILES
248
249 #ifndef __WATCOMC__
250 #if !defined(__BORLANDC__) || (__BORLANDC__ > 0x540)
251 // NB: this one is not POSIX and always has the underscore
252 #define wxFsync _commit
253
254 #define HAVE_FSYNC
255 #endif // BORLANDC
256 #endif
257
258 #define wxEof wxPOSIX_IDENT(eof)
259
260 // then the functions taking strings
261 #if wxUSE_UNICODE
262 #if wxUSE_UNICODE_MSLU
263 // implement the missing file functions in Win9x ourselves
264 #if defined( __VISUALC__ ) \
265 || ( defined(__MINGW32__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
266 || ( defined(__MWERKS__) && defined(__WXMSW__) ) \
267 || ( defined(__BORLANDC__) && (__BORLANDC__ > 0x460) ) \
268 || defined(__DMC__)
269
270 WXDLLIMPEXP_BASE int wxMSLU__wopen(const wxChar *name,
271 int flags, int mode);
272 WXDLLIMPEXP_BASE int wxMSLU__waccess(const wxChar *name,
273 int mode);
274 WXDLLIMPEXP_BASE int wxMSLU__wmkdir(const wxChar *name);
275 WXDLLIMPEXP_BASE int wxMSLU__wrmdir(const wxChar *name);
276
277 WXDLLIMPEXP_BASE int
278 wxMSLU__wstat(const wxChar *name, wxPOSIX_STRUCT(stat) *buffer);
279 WXDLLIMPEXP_BASE int
280 wxMSLU__wstati64(const wxChar *name,
281 wxPOSIX_STRUCT(stati64) *buffer);
282 #endif // Windows compilers with MSLU support
283
284 #define wxCRT_Open wxMSLU__wopen
285
286 #define wxCRT_Access wxMSLU__waccess
287 #define wxCRT_MkDir wxMSLU__wmkdir
288 #define wxCRT_RmDir wxMSLU__wrmdir
289 #ifdef wxHAS_HUGE_FILES
290 #define wxCRT_Stat wxMSLU__wstati64
291 #else
292 #define wxCRT_Stat wxMSLU__wstat
293 #endif
294 #else // !wxUSE_UNICODE_MSLU
295 #ifdef __BORLANDC__
296 #if __BORLANDC__ >= 0x550 && __BORLANDC__ <= 0x551
297 WXDLLIMPEXP_BASE int wxCRT_Open(const wxChar *pathname,
298 int flags, mode_t mode);
299 #else
300 #define wxCRT_Open _wopen
301 #endif
302 #define wxCRT_Access _waccess
303 #define wxCRT_MkDir _wmkdir
304 #define wxCRT_RmDir _wrmdir
305 #ifdef wxHAS_HUGE_FILES
306 #define wxCRT_Stat _wstati64
307 #else
308 #define wxCRT_Stat _wstat
309 #endif
310 #else
311 #define wxCRT_Open _wopen
312 #define wxCRT_Access _waccess
313 #define wxCRT_MkDir _wmkdir
314 #define wxCRT_RmDir _wrmdir
315 #ifdef wxHAS_HUGE_FILES
316 #define wxCRT_Stat _wstati64
317 #else
318 #define wxCRT_Stat _wstat
319 #endif
320 #endif
321 #endif // wxUSE_UNICODE_MSLU/!wxUSE_UNICODE_MSLU
322 #else // !wxUSE_UNICODE
323 #define wxCRT_Open wxPOSIX_IDENT(open)
324 #define wxCRT_Access wxPOSIX_IDENT(access)
325 #define wxCRT_MkDir wxPOSIX_IDENT(mkdir)
326 #define wxCRT_RmDir wxPOSIX_IDENT(rmdir)
327 #ifdef wxHAS_HUGE_FILES
328 #define wxCRT_Stat wxPOSIX_IDENT(stati64)
329 #else
330 // Unfortunately Watcom is not consistent, so:-
331 #if defined(__OS2__) && defined(__WATCOMC__)
332 #define wxCRT_Stat _stat
333 #else
334 #define wxCRT_Stat wxPOSIX_IDENT(stat)
335 #endif
336 #endif
337 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
338
339 // Types: Notice that Watcom is the only compiler to have a wide char
340 // version of struct stat as well as a wide char stat function variant.
341 // This was droped since OW 1.4 "for consistency across platforms".
342 #ifdef wxHAS_HUGE_FILES
343 #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
344 #define wxStructStat struct _wstati64
345 #else
346 #define wxStructStat struct _stati64
347 #endif
348 #else
349 #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
350 #define wxStructStat struct _wstat
351 #else
352 #define wxStructStat struct _stat
353 #endif
354 #endif
355
356 // constants (unless already defined by the user code)
357 #ifdef wxHAS_UNDERSCORES_IN_POSIX_IDENTS
358 #ifndef O_RDONLY
359 #define O_RDONLY _O_RDONLY
360 #define O_WRONLY _O_WRONLY
361 #define O_RDWR _O_RDWR
362 #define O_EXCL _O_EXCL
363 #define O_CREAT _O_CREAT
364 #define O_BINARY _O_BINARY
365 #endif
366
367 #ifndef S_IFMT
368 #define S_IFMT _S_IFMT
369 #define S_IFDIR _S_IFDIR
370 #define S_IFREG _S_IFREG
371 #endif
372 #endif // wxHAS_UNDERSCORES_IN_POSIX_IDENTS
373
374 #ifdef wxHAS_HUGE_FILES
375 // wxFile is present and supports large files. Currently wxFFile
376 // doesn't have large file support with any Windows compiler (even
377 // Win64 ones).
378 #if wxUSE_FILE
379 #define wxHAS_LARGE_FILES
380 #endif
381 #endif
382
383 // it's a private define, undefine it so that nobody gets tempted to use it
384 #undef wxHAS_HUGE_FILES
385#else // Unix or Windows using unknown compiler, assume POSIX supported
386 typedef off_t wxFileOffset;
387 #ifdef _LARGE_FILES
388 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
389 wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t),
390 BadFileSizeType );
391 // wxFile is present and supports large files
392 #ifdef wxUSE_FILE
393 #define wxHAS_LARGE_FILES
394 #endif
395 // wxFFile is present and supports large files
396 #if SIZEOF_LONG == 8 || defined HAVE_FSEEKO
397 #define wxHAS_LARGE_FFILES
398 #endif
399 #else
400 #define wxFileOffsetFmtSpec _T("")
401 #endif
402 // functions
403 #define wxClose close
404 #define wxRead ::read
405 #define wxWrite ::write
406 #define wxLseek lseek
407 #define wxSeek lseek
408 #define wxFsync fsync
409 #define wxEof eof
410
411 #define wxCRT_MkDir mkdir
412 #define wxCRT_RmDir rmdir
413
414 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
415
416 #define wxStructStat struct stat
417
418 #define wxCRT_Open open
419 #define wxCRT_Stat stat
420 #define wxCRT_Lstat lstat
421 #define wxCRT_Access access
422
423 #define wxHAS_NATIVE_LSTAT
424#endif // platforms
425
426// if the platform doesn't have symlinks, define wxCRT_Lstat to be the same as
427// wxCRT_Stat to avoid #ifdefs in the code using it
428#ifndef wxHAS_NATIVE_LSTAT
429 #define wxCRT_Lstat wxCRT_Stat
430#endif
431
432inline int wxAccess(const wxString& path, mode_t mode)
433 { return wxCRT_Access(path.fn_str(), mode); }
434inline int wxOpen(const wxString& path, int flags, mode_t mode)
435 { return wxCRT_Open(path.fn_str(), flags, mode); }
436
437// FIXME-CE: provide our own implementations of the missing CRT functions
438#ifndef __WXWINCE__
439inline int wxStat(const wxString& path, wxStructStat *buf)
440 { return wxCRT_Stat(path.fn_str(), buf); }
441inline int wxLstat(const wxString& path, wxStructStat *buf)
442 { return wxCRT_Lstat(path.fn_str(), buf); }
443inline int wxRmDir(const wxString& path)
444 { return wxCRT_RmDir(path.fn_str()); }
445#if defined(__WINDOWS__) || (defined(__OS2__) && defined(__WATCOMC__))
446inline int wxMkDir(const wxString& path, mode_t WXUNUSED(mode) = 0)
447 { return wxCRT_MkDir(path.fn_str()); }
448#else
449inline int wxMkDir(const wxString& path, mode_t mode)
450 { return wxCRT_MkDir(path.fn_str(), mode); }
451#endif
452#endif // !__WXWINCE__
453
454#ifdef O_BINARY
455 #define wxO_BINARY O_BINARY
456#else
457 #define wxO_BINARY 0
458#endif
459
460#if defined(__VISAGECPP__) && __IBMCPP__ >= 400
461//
462// VisualAge C++ V4.0 cannot have any external linkage const decs
463// in headers included by more than one primary source
464//
465extern const int wxInvalidOffset;
466#else
467const int wxInvalidOffset = -1;
468#endif
469
470// ----------------------------------------------------------------------------
471// functions
472// ----------------------------------------------------------------------------
473WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);
474
475// does the path exist? (may have or not '/' or '\\' at the end)
476WXDLLIMPEXP_BASE bool wxDirExists(const wxString& pathName);
477
478WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);
479
480// Get filename
481WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path);
482WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path);
483
484// Get directory
485WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path);
486
487WXDLLIMPEXP_BASE void wxDos2UnixFilename(char *s);
488WXDLLIMPEXP_BASE void wxDos2UnixFilename(wchar_t *s);
489
490WXDLLIMPEXP_BASE void wxUnix2DosFilename(char *s);
491WXDLLIMPEXP_BASE void wxUnix2DosFilename(wchar_t *s);
492
493// Strip the extension, in situ
494WXDLLIMPEXP_BASE void wxStripExtension(char *buffer);
495WXDLLIMPEXP_BASE void wxStripExtension(wchar_t *buffer);
496WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer);
497
498// Get a temporary filename
499WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
500WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf);
501
502// Expand file name (~/ and ${OPENWINHOME}/ stuff)
503WXDLLIMPEXP_BASE char* wxExpandPath(char *dest, const wxString& path);
504WXDLLIMPEXP_BASE wchar_t* wxExpandPath(wchar_t *dest, const wxString& path);
505// FIXME-UTF8: add some wxString version
506
507// Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
508// and make (if under the home tree) relative to home
509// [caller must copy-- volatile]
510WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename,
511 const wxString& envname = wxEmptyString,
512 const wxString& user = wxEmptyString);
513
514// Destructive removal of /./ and /../ stuff
515// FIXME-UTF8: deprecate these two (and similar)
516WXDLLIMPEXP_BASE char* wxRealPath(char *path);
517WXDLLIMPEXP_BASE wchar_t* wxRealPath(wchar_t *path);
518WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path);
519
520// Allocate a copy of the full absolute path
521WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path);
522
523// Get first file name matching given wild card.
524// Flags are reserved for future use.
525#define wxFILE 1
526#define wxDIR 2
527WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxString& spec, int flags = wxFILE);
528WXDLLIMPEXP_BASE wxString wxFindNextFile();
529
530// Does the pattern contain wildcards?
531WXDLLIMPEXP_BASE bool wxIsWild(const wxString& pattern);
532
533// Does the pattern match the text (usually a filename)?
534// If dot_special is true, doesn't match * against . (eliminating
535// `hidden' dot files)
536WXDLLIMPEXP_BASE bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = true);
537
538// Concatenate two files to form third
539WXDLLIMPEXP_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
540
541// Copy file1 to file2
542WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
543 bool overwrite = true);
544
545// Remove file
546WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
547
548// Rename file
549WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2, bool overwrite = true);
550
551// Get current working directory.
552#if WXWIN_COMPATIBILITY_2_6
553// If buf is NULL, allocates space using new, else
554// copies into buf.
555// IMPORTANT NOTE getcwd is know not to work under some releases
556// of Win32s 1.3, according to MS release notes!
557wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000) );
558// new and preferred version of wxGetWorkingDirectory
559// NB: can't have the same name because of overloading ambiguity
560#endif // WXWIN_COMPATIBILITY_2_6
561WXDLLIMPEXP_BASE wxString wxGetCwd();
562
563// Set working directory
564WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d);
565
566// Make directory
567WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = 0777);
568
569// Remove directory. Flags reserved for future use.
570WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
571
572// Return the type of an open file
573WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(int fd);
574WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(FILE *fp);
575
576#if WXWIN_COMPATIBILITY_2_6
577// compatibility defines, don't use in new code
578wxDEPRECATED( inline bool wxPathExists(const wxChar *pszPathName) );
579inline bool wxPathExists(const wxChar *pszPathName)
580{
581 return wxDirExists(pszPathName);
582}
583#endif //WXWIN_COMPATIBILITY_2_6
584
585// permissions; these functions work both on files and directories:
586WXDLLIMPEXP_BASE bool wxIsWritable(const wxString &path);
587WXDLLIMPEXP_BASE bool wxIsReadable(const wxString &path);
588WXDLLIMPEXP_BASE bool wxIsExecutable(const wxString &path);
589
590// ----------------------------------------------------------------------------
591// separators in file names
592// ----------------------------------------------------------------------------
593
594// between file name and extension
595#define wxFILE_SEP_EXT wxT('.')
596
597// between drive/volume name and the path
598#define wxFILE_SEP_DSK wxT(':')
599
600// between the path components
601#define wxFILE_SEP_PATH_DOS wxT('\\')
602#define wxFILE_SEP_PATH_UNIX wxT('/')
603#define wxFILE_SEP_PATH_MAC wxT(':')
604#define wxFILE_SEP_PATH_VMS wxT('.') // VMS also uses '[' and ']'
605
606// separator in the path list (as in PATH environment variable)
607// there is no PATH variable in Classic Mac OS so just use the
608// semicolon (it must be different from the file name separator)
609// NB: these are strings and not characters on purpose!
610#define wxPATH_SEP_DOS wxT(";")
611#define wxPATH_SEP_UNIX wxT(":")
612#define wxPATH_SEP_MAC wxT(";")
613
614// platform independent versions
615#if defined(__UNIX__) && !defined(__OS2__)
616 // CYGWIN also uses UNIX settings
617 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
618 #define wxPATH_SEP wxPATH_SEP_UNIX
619#elif defined(__WXPALMOS__)
620 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
621 #define wxPATH_SEP wxPATH_SEP_UNIX
622#elif defined(__MAC__)
623 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_MAC
624 #define wxPATH_SEP wxPATH_SEP_MAC
625#else // Windows and OS/2
626 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS
627 #define wxPATH_SEP wxPATH_SEP_DOS
628#endif // Unix/Windows
629
630// this is useful for wxString::IsSameAs(): to compare two file names use
631// filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
632#if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__)
633 #define wxARE_FILENAMES_CASE_SENSITIVE true
634#else // Windows, Mac OS and OS/2
635 #define wxARE_FILENAMES_CASE_SENSITIVE false
636#endif // Unix/Windows
637
638// is the char a path separator?
639inline bool wxIsPathSeparator(wxChar c)
640{
641 // under DOS/Windows we should understand both Unix and DOS file separators
642#if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
643 return c == wxFILE_SEP_PATH;
644#else
645 return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX;
646#endif
647}
648
649// does the string ends with path separator?
650WXDLLIMPEXP_BASE bool wxEndsWithPathSeparator(const wxString& filename);
651
652// split the full path into path (including drive for DOS), name and extension
653// (understands both '/' and '\\')
654WXDLLIMPEXP_BASE void wxSplitPath(const wxString& fileName,
655 wxString *pstrPath,
656 wxString *pstrName,
657 wxString *pstrExt);
658
659// find a file in a list of directories, returns false if not found
660WXDLLIMPEXP_BASE bool wxFindFileInPath(wxString *pStr, const wxString& szPath, const wxString& szFile);
661
662// Get the OS directory if appropriate (such as the Windows directory).
663// On non-Windows platform, probably just return the empty string.
664WXDLLIMPEXP_BASE wxString wxGetOSDirectory();
665
666#if wxUSE_DATETIME
667
668// Get file modification time
669WXDLLIMPEXP_BASE time_t wxFileModificationTime(const wxString& filename);
670
671#endif // wxUSE_DATETIME
672
673// Parses the wildCard, returning the number of filters.
674// Returns 0 if none or if there's a problem,
675// The arrays will contain an equal number of items found before the error.
676// wildCard is in the form:
677// "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
678WXDLLIMPEXP_BASE int wxParseCommonDialogsFilter(const wxString& wildCard, wxArrayString& descriptions, wxArrayString& filters);
679
680// ----------------------------------------------------------------------------
681// classes
682// ----------------------------------------------------------------------------
683
684#ifdef __UNIX__
685
686// set umask to the given value in ctor and reset it to the old one in dtor
687class WXDLLIMPEXP_BASE wxUmaskChanger
688{
689public:
690 // change the umask to the given one if it is not -1: this allows to write
691 // the same code whether you really want to change umask or not, as is in
692 // wxFileConfig::Flush() for example
693 wxUmaskChanger(int umaskNew)
694 {
695 m_umaskOld = umaskNew == -1 ? -1 : (int)umask((mode_t)umaskNew);
696 }
697
698 ~wxUmaskChanger()
699 {
700 if ( m_umaskOld != -1 )
701 umask((mode_t)m_umaskOld);
702 }
703
704private:
705 int m_umaskOld;
706};
707
708// this macro expands to an "anonymous" wxUmaskChanger object under Unix and
709// nothing elsewhere
710#define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
711
712#else // !__UNIX__
713
714#define wxCHANGE_UMASK(m)
715
716#endif // __UNIX__/!__UNIX__
717
718
719// Path searching
720class WXDLLIMPEXP_BASE wxPathList : public wxArrayString
721{
722public:
723 wxPathList() {}
724 wxPathList(const wxArrayString &arr)
725 { Add(arr); }
726
727 // Adds all paths in environment variable
728 void AddEnvList(const wxString& envVariable);
729
730 // Adds given path to this list
731 bool Add(const wxString& path);
732 void Add(const wxArrayString &paths);
733
734 // Find the first full path for which the file exists
735 wxString FindValidPath(const wxString& filename) const;
736
737 // Find the first full path for which the file exists; ensure it's an
738 // absolute path that gets returned.
739 wxString FindAbsoluteValidPath(const wxString& filename) const;
740
741 // Given full path and filename, add path to list
742 bool EnsureFileAccessible(const wxString& path);
743
744#if WXWIN_COMPATIBILITY_2_6
745 // Returns true if the path is in the list
746 wxDEPRECATED( bool Member(const wxString& path) const );
747#endif
748};
749
750#endif // _WX_FILEFN_H_
wxWidgets (Impactor)