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