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