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