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