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