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