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