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