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