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