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