]> git.saurik.com Git - wxWidgets.git/blob - include/wx/filefn.h
implementation of HotKey, see #12354
[wxWidgets.git] / include / wx / filefn.h
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
122 enum wxSeekMode
123 {
124 wxFromStart,
125 wxFromCurrent,
126 wxFromEnd
127 };
128
129 enum 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 // we redefine these constants here because S_IREAD &c are _not_ standard
138 // however, we do assume that the values correspond to the Unix umask bits
139 enum wxPosixPermissions
140 {
141 // standard Posix names for these permission flags:
142 wxS_IRUSR = 00400,
143 wxS_IWUSR = 00200,
144 wxS_IXUSR = 00100,
145
146 wxS_IRGRP = 00040,
147 wxS_IWGRP = 00020,
148 wxS_IXGRP = 00010,
149
150 wxS_IROTH = 00004,
151 wxS_IWOTH = 00002,
152 wxS_IXOTH = 00001,
153
154 // longer but more readable synonyms for the constants above:
155 wxPOSIX_USER_READ = wxS_IRUSR,
156 wxPOSIX_USER_WRITE = wxS_IWUSR,
157 wxPOSIX_USER_EXECUTE = wxS_IXUSR,
158
159 wxPOSIX_GROUP_READ = wxS_IRGRP,
160 wxPOSIX_GROUP_WRITE = wxS_IWGRP,
161 wxPOSIX_GROUP_EXECUTE = wxS_IXGRP,
162
163 wxPOSIX_OTHERS_READ = wxS_IROTH,
164 wxPOSIX_OTHERS_WRITE = wxS_IWOTH,
165 wxPOSIX_OTHERS_EXECUTE = wxS_IXOTH,
166
167 // default mode for the new files: allow reading/writing them to everybody but
168 // the effective file mode will be set after anding this value with umask and
169 // so won't include wxS_IW{GRP,OTH} for the default 022 umask value
170 wxS_DEFAULT = (wxPOSIX_USER_READ | wxPOSIX_USER_WRITE | \
171 wxPOSIX_GROUP_READ | wxPOSIX_GROUP_WRITE | \
172 wxPOSIX_OTHERS_READ | wxPOSIX_OTHERS_WRITE),
173
174 // default mode for the new directories (see wxFileName::Mkdir): allow
175 // reading/writing/executing them to everybody, but just like wxS_DEFAULT
176 // the effective directory mode will be set after anding this value with umask
177 wxS_DIR_DEFAULT = (wxPOSIX_USER_READ | wxPOSIX_USER_WRITE | wxPOSIX_USER_EXECUTE | \
178 wxPOSIX_GROUP_READ | wxPOSIX_GROUP_WRITE | wxPOSIX_GROUP_EXECUTE | \
179 wxPOSIX_OTHERS_READ | wxPOSIX_OTHERS_WRITE | wxPOSIX_OTHERS_EXECUTE)
180 };
181
182 // ----------------------------------------------------------------------------
183 // declare our versions of low level file functions: some compilers prepend
184 // underscores to the usual names, some also have Unicode versions of them
185 // ----------------------------------------------------------------------------
186
187 // Wrappers around Win32 api functions like CreateFile, ReadFile and such
188 // Implemented in filefnwce.cpp
189 #if defined( __WXWINCE__)
190 typedef __int64 wxFileOffset;
191 #define wxFileOffsetFmtSpec wxT("I64")
192 WXDLLIMPEXP_BASE int wxCRT_Open(const wxChar *filename, int oflag, int WXUNUSED(pmode));
193 WXDLLIMPEXP_BASE int wxCRT_Access(const wxChar *name, int WXUNUSED(how));
194 WXDLLIMPEXP_BASE int wxClose(int fd);
195 WXDLLIMPEXP_BASE int wxFsync(int WXUNUSED(fd));
196 WXDLLIMPEXP_BASE int wxRead(int fd, void *buf, unsigned int count);
197 WXDLLIMPEXP_BASE int wxWrite(int fd, const void *buf, unsigned int count);
198 WXDLLIMPEXP_BASE int wxEof(int fd);
199 WXDLLIMPEXP_BASE wxFileOffset wxSeek(int fd, wxFileOffset offset, int origin);
200 #define wxLSeek wxSeek
201 WXDLLIMPEXP_BASE wxFileOffset wxTell(int fd);
202
203 // always Unicode under WinCE
204 #define wxCRT_MkDir _wmkdir
205 #define wxCRT_RmDir _wrmdir
206 #define wxCRT_Stat _wstat
207 #define wxStructStat struct _stat
208 #elif (defined(__WXMSW__) || defined(__OS2__)) && !defined(__WXPALMOS__) && \
209 ( \
210 defined(__VISUALC__) || \
211 defined(__MINGW64__) || \
212 (defined(__MINGW32__) && !defined(__WINE__) && \
213 wxCHECK_W32API_VERSION(0, 5)) || \
214 defined(__MWERKS__) || \
215 defined(__DMC__) || \
216 defined(__WATCOMC__) || \
217 defined(__BORLANDC__) \
218 )
219
220 // temporary defines just used immediately below
221 #undef wxHAS_HUGE_FILES
222 #undef wxHAS_HUGE_STDIO_FILES
223
224 // detect compilers which have support for huge files
225 #if defined(__VISUALC__)
226 #define wxHAS_HUGE_FILES 1
227 #elif defined(__MINGW32__) || defined(__MINGW64__)
228 #define wxHAS_HUGE_FILES 1
229 #elif defined(_LARGE_FILES)
230 #define wxHAS_HUGE_FILES 1
231 #endif
232
233 // detect compilers which have support for huge stdio files
234 #if wxCHECK_VISUALC_VERSION(8)
235 #define wxHAS_HUGE_STDIO_FILES
236 #define wxFseek _fseeki64
237 #define wxFtell _ftelli64
238 #elif wxCHECK_MINGW32_VERSION(3, 5) // mingw-runtime version (not gcc)
239 #define wxHAS_HUGE_STDIO_FILES
240 #define wxFseek fseeko64
241 #define wxFtell ftello64
242 #endif
243
244 // other Windows compilers (DMC, Watcom, Metrowerks and Borland) don't have
245 // huge file support (or at least not all functions needed for it by wx)
246 // currently
247
248 // types
249
250 #ifdef wxHAS_HUGE_FILES
251 typedef wxLongLong_t wxFileOffset;
252 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
253 #else
254 typedef off_t wxFileOffset;
255 #endif
256
257 // at least Borland 5.5 doesn't like "struct ::stat" so don't use the scope
258 // resolution operator present in wxPOSIX_IDENT for it
259 #ifdef __BORLANDC__
260 #define wxPOSIX_STRUCT(s) struct s
261 #else
262 #define wxPOSIX_STRUCT(s) struct wxPOSIX_IDENT(s)
263 #endif
264
265 // Notice that Watcom is the only compiler to have a wide char
266 // version of struct stat as well as a wide char stat function variant.
267 // This was dropped since OW 1.4 "for consistency across platforms".
268 //
269 // Borland is also special in that it uses _stat with Unicode functions
270 // (for MSVC compatibility?) but stat with ANSI ones
271 #ifdef __BORLANDC__
272 #if wxHAS_HUGE_FILES
273 #define wxStructStat struct stati64
274 #else
275 #if wxUSE_UNICODE
276 #define wxStructStat struct _stat
277 #else
278 #define wxStructStat struct stat
279 #endif
280 #endif
281 #else // !__BORLANDC__
282 #ifdef wxHAS_HUGE_FILES
283 #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
284 #define wxStructStat struct _wstati64
285 #else
286 #define wxStructStat struct _stati64
287 #endif
288 #else
289 #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
290 #define wxStructStat struct _wstat
291 #else
292 #define wxStructStat struct _stat
293 #endif
294 #endif
295 #endif // __BORLANDC__/!__BORLANDC__
296
297
298 // functions
299
300 // MSVC and compatible compilers prepend underscores to the POSIX function
301 // names, other compilers don't and even if their later versions usually do
302 // define the versions with underscores for MSVC compatibility, it's better
303 // to avoid using them as they're not present in earlier versions and
304 // always using the native functions spelling is easier than testing for
305 // the versions
306 #if defined(__BORLANDC__) || defined(__DMC__) || defined(__WATCOMC__) || defined(__MINGW64__)
307 #define wxPOSIX_IDENT(func) ::func
308 #else // by default assume MSVC-compatible names
309 #define wxPOSIX_IDENT(func) _ ## func
310 #define wxHAS_UNDERSCORES_IN_POSIX_IDENTS
311 #endif
312
313 // first functions not working with strings, i.e. without ANSI/Unicode
314 // complications
315 #define wxClose wxPOSIX_IDENT(close)
316
317 #if defined(__MWERKS__)
318 #if __MSL__ >= 0x6000
319 #define wxRead(fd, buf, nCount) _read(fd, (void *)buf, nCount)
320 #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)
321 #else
322 #define wxRead(fd, buf, nCount)\
323 _read(fd, (const char *)buf, nCount)
324 #define wxWrite(fd, buf, nCount)\
325 _write(fd, (const char *)buf, nCount)
326 #endif
327 #else // __MWERKS__
328 #define wxRead wxPOSIX_IDENT(read)
329 #define wxWrite wxPOSIX_IDENT(write)
330 #endif
331
332 #ifdef wxHAS_HUGE_FILES
333 #ifndef __MINGW64__
334 #define wxSeek wxPOSIX_IDENT(lseeki64)
335 #define wxLseek wxPOSIX_IDENT(lseeki64)
336 #define wxTell wxPOSIX_IDENT(telli64)
337 #else
338 // unfortunately, mingw-W64 is somewhat inconsistent...
339 #define wxSeek _lseeki64
340 #define wxLseek _lseeki64
341 #define wxTell _telli64
342 #endif
343 #else // !wxHAS_HUGE_FILES
344 #define wxSeek wxPOSIX_IDENT(lseek)
345 #define wxLseek wxPOSIX_IDENT(lseek)
346 #define wxTell wxPOSIX_IDENT(tell)
347 #endif // wxHAS_HUGE_FILES/!wxHAS_HUGE_FILES
348
349 #ifndef __WATCOMC__
350 #if !defined(__BORLANDC__) || (__BORLANDC__ > 0x540)
351 // NB: this one is not POSIX and always has the underscore
352 #define wxFsync _commit
353
354 // could be already defined by configure (Cygwin)
355 #ifndef HAVE_FSYNC
356 #define HAVE_FSYNC
357 #endif
358 #endif // BORLANDC
359 #endif
360
361 #define wxEof wxPOSIX_IDENT(eof)
362
363 // then the functions taking strings
364
365 // first the ANSI versions
366 #define wxCRT_OpenA wxPOSIX_IDENT(open)
367 #define wxCRT_AccessA wxPOSIX_IDENT(access)
368 #define wxCRT_MkDirA wxPOSIX_IDENT(mkdir)
369 #define wxCRT_RmDirA wxPOSIX_IDENT(rmdir)
370 #ifdef wxHAS_HUGE_FILES
371 #define wxCRT_StatA wxPOSIX_IDENT(stati64)
372 #else
373 // Unfortunately Watcom is not consistent
374 #if defined(__OS2__) && defined(__WATCOMC__)
375 #define wxCRT_StatA _stat
376 #else
377 #define wxCRT_StatA wxPOSIX_IDENT(stat)
378 #endif
379 #endif
380
381 // then wide char ones
382 #if wxUSE_UNICODE
383 // special workaround for buggy wopen() in bcc 5.5
384 #if defined(__BORLANDC__) && \
385 (__BORLANDC__ >= 0x550 && __BORLANDC__ <= 0x551)
386 WXDLLIMPEXP_BASE int wxCRT_OpenW(const wxChar *pathname,
387 int flags, mode_t mode);
388 #else
389 #define wxCRT_OpenW _wopen
390 #endif
391
392 #define wxCRT_AccessW _waccess
393 #define wxCRT_MkDirW _wmkdir
394 #define wxCRT_RmDirW _wrmdir
395 #ifdef wxHAS_HUGE_FILES
396 #define wxCRT_StatW _wstati64
397 #else
398 #define wxCRT_StatW _wstat
399 #endif
400 #endif // wxUSE_UNICODE
401
402
403 // finally the default char-type versions
404 #if wxUSE_UNICODE
405 #if wxUSE_UNICODE_MSLU || defined(__WX_STRICT_ANSI_GCC__)
406 // implement the missing file functions in Win9x ourselves
407 WXDLLIMPEXP_BASE int wxMSLU__wopen(const wxChar *name,
408 int flags, int mode);
409 WXDLLIMPEXP_BASE int wxMSLU__waccess(const wxChar *name,
410 int mode);
411 WXDLLIMPEXP_BASE int wxMSLU__wmkdir(const wxChar *name);
412 WXDLLIMPEXP_BASE int wxMSLU__wrmdir(const wxChar *name);
413
414 WXDLLIMPEXP_BASE int
415 wxMSLU__wstat(const wxChar *name, wxStructStat *buffer);
416
417 #define wxCRT_Open wxMSLU__wopen
418
419 #define wxCRT_Access wxMSLU__waccess
420 #define wxCRT_MkDir wxMSLU__wmkdir
421 #define wxCRT_RmDir wxMSLU__wrmdir
422 #define wxCRT_Stat wxMSLU__wstat
423 #else // !wxUSE_UNICODE_MSLU
424 #define wxCRT_Open wxCRT_OpenW
425 #define wxCRT_Access wxCRT_AccessW
426 #define wxCRT_MkDir wxCRT_MkDirW
427 #define wxCRT_RmDir wxCRT_RmDirW
428 #define wxCRT_Stat wxCRT_StatW
429 #endif // wxUSE_UNICODE_MSLU/!wxUSE_UNICODE_MSLU
430 #else // !wxUSE_UNICODE
431 #define wxCRT_Open wxCRT_OpenA
432 #define wxCRT_Access wxCRT_AccessA
433 #define wxCRT_MkDir wxCRT_MkDirA
434 #define wxCRT_RmDir wxCRT_RmDirA
435 #define wxCRT_Stat wxCRT_StatA
436 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
437
438
439 // constants (unless already defined by the user code)
440 #ifdef wxHAS_UNDERSCORES_IN_POSIX_IDENTS
441 #ifndef O_RDONLY
442 #define O_RDONLY _O_RDONLY
443 #define O_WRONLY _O_WRONLY
444 #define O_RDWR _O_RDWR
445 #define O_EXCL _O_EXCL
446 #define O_CREAT _O_CREAT
447 #define O_BINARY _O_BINARY
448 #endif
449
450 #ifndef S_IFMT
451 #define S_IFMT _S_IFMT
452 #define S_IFDIR _S_IFDIR
453 #define S_IFREG _S_IFREG
454 #endif
455 #endif // wxHAS_UNDERSCORES_IN_POSIX_IDENTS
456
457 #ifdef wxHAS_HUGE_FILES
458 // wxFile is present and supports large files.
459 #if wxUSE_FILE
460 #define wxHAS_LARGE_FILES
461 #endif
462 // wxFFile is present and supports large files
463 #if wxUSE_FFILE && defined wxHAS_HUGE_STDIO_FILES
464 #define wxHAS_LARGE_FFILES
465 #endif
466 #endif
467
468 // private defines, undefine so that nobody gets tempted to use
469 #undef wxHAS_HUGE_FILES
470 #undef wxHAS_HUGE_STDIO_FILES
471 #elif defined (__WXPALMOS__)
472 typedef off_t wxFileOffset;
473 #ifdef _LARGE_FILES
474 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
475 wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t), BadFileSizeType );
476 // wxFile is present and supports large files
477 #ifdef wxUSE_FILE
478 #define wxHAS_LARGE_FILES
479 #endif
480 // wxFFile is present and supports large files
481 #if SIZEOF_LONG == 8 || defined HAVE_FSEEKO
482 #define wxHAS_LARGE_FFILES
483 #endif
484 #else
485 #define wxFileOffsetFmtSpec wxT("")
486 #endif
487 #define wxClose close
488 #define wxRead ::read
489 #define wxWrite ::write
490 #define wxLseek lseek
491 #define wxSeek lseek
492 #define wxFsync fsync
493 #define wxEof eof
494
495 #define wxCRT_MkDir mkdir
496 #define wxCRT_RmDir rmdir
497
498 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
499
500 #define wxStructStat struct stat
501
502 #define wxCRT_Open open
503 #define wxCRT_Stat svfs_stat
504 #define wxCRT_Lstat lstat
505 #define wxCRT_Access access
506
507 #define wxHAS_NATIVE_LSTAT
508 #else // Unix or Windows using unknown compiler, assume POSIX supported
509 typedef off_t wxFileOffset;
510 #ifdef HAVE_LARGEFILE_SUPPORT
511 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
512 wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t),
513 BadFileSizeType );
514 // wxFile is present and supports large files
515 #if wxUSE_FILE
516 #define wxHAS_LARGE_FILES
517 #endif
518 // wxFFile is present and supports large files
519 #if wxUSE_FFILE && (SIZEOF_LONG == 8 || defined HAVE_FSEEKO)
520 #define wxHAS_LARGE_FFILES
521 #endif
522 #ifdef HAVE_FSEEKO
523 #define wxFseek fseeko
524 #define wxFtell ftello
525 #endif
526 #else
527 #define wxFileOffsetFmtSpec wxT("")
528 #endif
529 // functions
530 #define wxClose close
531 #define wxRead ::read
532 #define wxWrite ::write
533 #define wxLseek lseek
534 #define wxSeek lseek
535 #define wxFsync fsync
536 #define wxEof eof
537
538 #define wxCRT_MkDir mkdir
539 #define wxCRT_RmDir rmdir
540
541 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
542
543 #define wxStructStat struct stat
544
545 #define wxCRT_Open open
546 #define wxCRT_Stat stat
547 #define wxCRT_Lstat lstat
548 #define wxCRT_Access access
549
550 #define wxHAS_NATIVE_LSTAT
551 #endif // platforms
552
553 // if the platform doesn't have symlinks, define wxCRT_Lstat to be the same as
554 // wxCRT_Stat to avoid #ifdefs in the code using it
555 #ifndef wxHAS_NATIVE_LSTAT
556 #define wxCRT_Lstat wxCRT_Stat
557 #endif
558
559 // define wxFseek/wxFtell to large file versions if available (done above) or
560 // to fseek/ftell if not, to save ifdefs in using code
561 #ifndef wxFseek
562 #define wxFseek fseek
563 #endif
564 #ifndef wxFtell
565 #define wxFtell ftell
566 #endif
567
568 inline int wxAccess(const wxString& path, mode_t mode)
569 { return wxCRT_Access(path.fn_str(), mode); }
570 inline int wxOpen(const wxString& path, int flags, mode_t mode)
571 { return wxCRT_Open(path.fn_str(), flags, mode); }
572
573 // FIXME-CE: provide our own implementations of the missing CRT functions
574 #ifndef __WXWINCE__
575 inline int wxStat(const wxString& path, wxStructStat *buf)
576 { return wxCRT_Stat(path.fn_str(), buf); }
577 inline int wxLstat(const wxString& path, wxStructStat *buf)
578 { return wxCRT_Lstat(path.fn_str(), buf); }
579 inline int wxRmDir(const wxString& path)
580 { return wxCRT_RmDir(path.fn_str()); }
581 #if (defined(__WINDOWS__) && !defined(__CYGWIN__)) \
582 || (defined(__OS2__) && defined(__WATCOMC__))
583 inline int wxMkDir(const wxString& path, mode_t WXUNUSED(mode) = 0)
584 { return wxCRT_MkDir(path.fn_str()); }
585 #else
586 inline int wxMkDir(const wxString& path, mode_t mode)
587 { return wxCRT_MkDir(path.fn_str(), mode); }
588 #endif
589 #endif // !__WXWINCE__
590
591 #ifdef O_BINARY
592 #define wxO_BINARY O_BINARY
593 #else
594 #define wxO_BINARY 0
595 #endif
596
597 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
598 //
599 // VisualAge C++ V4.0 cannot have any external linkage const decs
600 // in headers included by more than one primary source
601 //
602 extern const int wxInvalidOffset;
603 #else
604 const int wxInvalidOffset = -1;
605 #endif
606
607 // ----------------------------------------------------------------------------
608 // functions
609 // ----------------------------------------------------------------------------
610 WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);
611
612 // does the path exist? (may have or not '/' or '\\' at the end)
613 WXDLLIMPEXP_BASE bool wxDirExists(const wxString& pathName);
614
615 WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);
616
617 // Get filename
618 WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path);
619 WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path);
620
621 // Get directory
622 WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path);
623
624 // all deprecated functions below are deprecated in favour of wxFileName's methods
625 #if WXWIN_COMPATIBILITY_2_8
626
627 wxDEPRECATED( WXDLLIMPEXP_BASE void wxDos2UnixFilename(char *s) );
628 wxDEPRECATED( WXDLLIMPEXP_BASE void wxDos2UnixFilename(wchar_t *s) );
629
630 wxDEPRECATED_BUT_USED_INTERNALLY(
631 WXDLLIMPEXP_BASE void wxUnix2DosFilename(char *s) );
632 wxDEPRECATED_BUT_USED_INTERNALLY(
633 WXDLLIMPEXP_BASE void wxUnix2DosFilename(wchar_t *s) );
634
635 // Strip the extension, in situ
636 // Deprecated in favour of wxFileName::StripExtension() but notice that their
637 // behaviour is slightly different, see the manual
638 wxDEPRECATED( WXDLLIMPEXP_BASE void wxStripExtension(char *buffer) );
639 wxDEPRECATED( WXDLLIMPEXP_BASE void wxStripExtension(wchar_t *buffer) );
640 wxDEPRECATED( WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer) );
641
642 // Get a temporary filename
643 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = NULL) );
644 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf) );
645
646 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
647 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE char* wxExpandPath(char *dest, const wxString& path) );
648 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE wchar_t* wxExpandPath(wchar_t *dest, const wxString& path) );
649 // DEPRECATED: use wxFileName::Normalize(wxPATH_NORM_ENV_VARS)
650
651 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
652 // and make (if under the home tree) relative to home
653 // [caller must copy-- volatile]
654 wxDEPRECATED(
655 WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename,
656 const wxString& envname = wxEmptyString,
657 const wxString& user = wxEmptyString) );
658 // DEPRECATED: use wxFileName::ReplaceEnvVariable and wxFileName::ReplaceHomeDir
659
660 // Destructive removal of /./ and /../ stuff
661 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE char* wxRealPath(char *path) );
662 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE wchar_t* wxRealPath(wchar_t *path) );
663 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path) );
664 // DEPRECATED: use wxFileName::Normalize instead
665
666 // Allocate a copy of the full absolute path
667 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path) );
668 // DEPRECATED: use wxFileName::MakeAbsolute instead
669 #endif
670
671 // Get first file name matching given wild card.
672 // Flags are reserved for future use.
673 #define wxFILE 1
674 #define wxDIR 2
675 WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxString& spec, int flags = wxFILE);
676 WXDLLIMPEXP_BASE wxString wxFindNextFile();
677
678 // Does the pattern contain wildcards?
679 WXDLLIMPEXP_BASE bool wxIsWild(const wxString& pattern);
680
681 // Does the pattern match the text (usually a filename)?
682 // If dot_special is true, doesn't match * against . (eliminating
683 // `hidden' dot files)
684 WXDLLIMPEXP_BASE bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = true);
685
686 // Concatenate two files to form third
687 WXDLLIMPEXP_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
688
689 // Copy file1 to file2
690 WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
691 bool overwrite = true);
692
693 // Remove file
694 WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
695
696 // Rename file
697 WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2, bool overwrite = true);
698
699 // Get current working directory.
700 #if WXWIN_COMPATIBILITY_2_6
701 // If buf is NULL, allocates space using new, else
702 // copies into buf.
703 // IMPORTANT NOTE getcwd is know not to work under some releases
704 // of Win32s 1.3, according to MS release notes!
705 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = NULL, int sz = 1000) );
706 // new and preferred version of wxGetWorkingDirectory
707 // NB: can't have the same name because of overloading ambiguity
708 #endif // WXWIN_COMPATIBILITY_2_6
709 WXDLLIMPEXP_BASE wxString wxGetCwd();
710
711 // Set working directory
712 WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d);
713
714 // Make directory
715 WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = wxS_DIR_DEFAULT);
716
717 // Remove directory. Flags reserved for future use.
718 WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
719
720 // Return the type of an open file
721 WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(int fd);
722 WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(FILE *fp);
723
724 #if WXWIN_COMPATIBILITY_2_6
725 // compatibility defines, don't use in new code
726 wxDEPRECATED( inline bool wxPathExists(const wxChar *pszPathName) );
727 inline bool wxPathExists(const wxChar *pszPathName)
728 {
729 return wxDirExists(pszPathName);
730 }
731 #endif //WXWIN_COMPATIBILITY_2_6
732
733 // permissions; these functions work both on files and directories:
734 WXDLLIMPEXP_BASE bool wxIsWritable(const wxString &path);
735 WXDLLIMPEXP_BASE bool wxIsReadable(const wxString &path);
736 WXDLLIMPEXP_BASE bool wxIsExecutable(const wxString &path);
737
738 // ----------------------------------------------------------------------------
739 // separators in file names
740 // ----------------------------------------------------------------------------
741
742 // between file name and extension
743 #define wxFILE_SEP_EXT wxT('.')
744
745 // between drive/volume name and the path
746 #define wxFILE_SEP_DSK wxT(':')
747
748 // between the path components
749 #define wxFILE_SEP_PATH_DOS wxT('\\')
750 #define wxFILE_SEP_PATH_UNIX wxT('/')
751 #define wxFILE_SEP_PATH_MAC wxT(':')
752 #define wxFILE_SEP_PATH_VMS wxT('.') // VMS also uses '[' and ']'
753
754 // separator in the path list (as in PATH environment variable)
755 // there is no PATH variable in Classic Mac OS so just use the
756 // semicolon (it must be different from the file name separator)
757 // NB: these are strings and not characters on purpose!
758 #define wxPATH_SEP_DOS wxT(";")
759 #define wxPATH_SEP_UNIX wxT(":")
760 #define wxPATH_SEP_MAC wxT(";")
761
762 // platform independent versions
763 #if defined(__UNIX__) && !defined(__OS2__)
764 // CYGWIN also uses UNIX settings
765 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
766 #define wxPATH_SEP wxPATH_SEP_UNIX
767 #elif defined(__WXPALMOS__)
768 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
769 #define wxPATH_SEP wxPATH_SEP_UNIX
770 #elif defined(__MAC__)
771 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_MAC
772 #define wxPATH_SEP wxPATH_SEP_MAC
773 #else // Windows and OS/2
774 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS
775 #define wxPATH_SEP wxPATH_SEP_DOS
776 #endif // Unix/Windows
777
778 // this is useful for wxString::IsSameAs(): to compare two file names use
779 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
780 #if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__)
781 #define wxARE_FILENAMES_CASE_SENSITIVE true
782 #else // Windows, Mac OS and OS/2
783 #define wxARE_FILENAMES_CASE_SENSITIVE false
784 #endif // Unix/Windows
785
786 // is the char a path separator?
787 inline bool wxIsPathSeparator(wxChar c)
788 {
789 // under DOS/Windows we should understand both Unix and DOS file separators
790 #if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
791 return c == wxFILE_SEP_PATH;
792 #else
793 return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX;
794 #endif
795 }
796
797 // does the string ends with path separator?
798 WXDLLIMPEXP_BASE bool wxEndsWithPathSeparator(const wxString& filename);
799
800 #if WXWIN_COMPATIBILITY_2_8
801 // split the full path into path (including drive for DOS), name and extension
802 // (understands both '/' and '\\')
803 // Deprecated in favour of wxFileName::SplitPath
804 wxDEPRECATED( WXDLLIMPEXP_BASE void wxSplitPath(const wxString& fileName,
805 wxString *pstrPath,
806 wxString *pstrName,
807 wxString *pstrExt) );
808 #endif
809
810 // find a file in a list of directories, returns false if not found
811 WXDLLIMPEXP_BASE bool wxFindFileInPath(wxString *pStr, const wxString& szPath, const wxString& szFile);
812
813 // Get the OS directory if appropriate (such as the Windows directory).
814 // On non-Windows platform, probably just return the empty string.
815 WXDLLIMPEXP_BASE wxString wxGetOSDirectory();
816
817 #if wxUSE_DATETIME
818
819 // Get file modification time
820 WXDLLIMPEXP_BASE time_t wxFileModificationTime(const wxString& filename);
821
822 #endif // wxUSE_DATETIME
823
824 // Parses the wildCard, returning the number of filters.
825 // Returns 0 if none or if there's a problem,
826 // The arrays will contain an equal number of items found before the error.
827 // wildCard is in the form:
828 // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
829 WXDLLIMPEXP_BASE int wxParseCommonDialogsFilter(const wxString& wildCard, wxArrayString& descriptions, wxArrayString& filters);
830
831 // ----------------------------------------------------------------------------
832 // classes
833 // ----------------------------------------------------------------------------
834
835 #ifdef __UNIX__
836
837 // set umask to the given value in ctor and reset it to the old one in dtor
838 class WXDLLIMPEXP_BASE wxUmaskChanger
839 {
840 public:
841 // change the umask to the given one if it is not -1: this allows to write
842 // the same code whether you really want to change umask or not, as is in
843 // wxFileConfig::Flush() for example
844 wxUmaskChanger(int umaskNew)
845 {
846 m_umaskOld = umaskNew == -1 ? -1 : (int)umask((mode_t)umaskNew);
847 }
848
849 ~wxUmaskChanger()
850 {
851 if ( m_umaskOld != -1 )
852 umask((mode_t)m_umaskOld);
853 }
854
855 private:
856 int m_umaskOld;
857 };
858
859 // this macro expands to an "anonymous" wxUmaskChanger object under Unix and
860 // nothing elsewhere
861 #define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
862
863 #else // !__UNIX__
864
865 #define wxCHANGE_UMASK(m)
866
867 #endif // __UNIX__/!__UNIX__
868
869
870 // Path searching
871 class WXDLLIMPEXP_BASE wxPathList : public wxArrayString
872 {
873 public:
874 wxPathList() {}
875 wxPathList(const wxArrayString &arr)
876 { Add(arr); }
877
878 // Adds all paths in environment variable
879 void AddEnvList(const wxString& envVariable);
880
881 // Adds given path to this list
882 bool Add(const wxString& path);
883 void Add(const wxArrayString &paths);
884
885 // Find the first full path for which the file exists
886 wxString FindValidPath(const wxString& filename) const;
887
888 // Find the first full path for which the file exists; ensure it's an
889 // absolute path that gets returned.
890 wxString FindAbsoluteValidPath(const wxString& filename) const;
891
892 // Given full path and filename, add path to list
893 bool EnsureFileAccessible(const wxString& path);
894
895 #if WXWIN_COMPATIBILITY_2_6
896 // Returns true if the path is in the list
897 wxDEPRECATED( bool Member(const wxString& path) const );
898 #endif
899 };
900
901 #endif // _WX_FILEFN_H_