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