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