]> git.saurik.com Git - wxWidgets.git/blob - include/wx/filefn.h
Script updates
[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 #include "wx/msw/private.h"
177
178 #undef wxHAS_HUGE_FILES
179 #if defined(__MINGW32__)
180 #define wxHAS_HUGE_FILES 1
181 #elif defined(__MWERKS__)
182 #define wxHAS_HUGE_FILES 0
183 #elif defined(__DMC__)
184 #define wxHAS_HUGE_FILES 0
185 #elif ((_INTEGRAL_MAX_BITS >= 64) || defined(_LARGE_FILES))
186 #define wxHAS_HUGE_FILES 1
187 #else
188 #define wxHAS_HUGE_FILES 0
189 #endif
190
191 // functions
192 #if defined(__BORLANDC__) || defined(__WATCOMC__)
193 #define _tell tell
194 #endif
195
196 #if wxHAS_HUGE_FILES
197 typedef wxLongLong_t wxFileOffset;
198 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
199 #else
200 typedef off_t wxFileOffset;
201 #define wxFileOffsetFmtSpec _("")
202 #endif
203
204 #define wxClose _close
205
206 #if defined(__MWERKS__)
207 #if __MSL__ >= 0x6000
208 #define wxRead(fd, buf, nCount) _read(fd, (void *)buf, nCount)
209 #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)
210 #else
211 #define wxRead(fd, buf, nCount)\
212 _read(fd, (const char *)buf, nCount)
213 #define wxWrite(fd, buf, nCount)\
214 _write(fd, (const char *)buf, nCount)
215 #endif
216 #else
217 #if defined(__DMC__) || defined(__WATCOMC__)
218 #define wxRead ::read
219 #define wxWrite ::write
220 #else
221 #define wxRead _read
222 #define wxWrite _write
223 #endif
224 #endif
225 #if wxHAS_HUGE_FILES
226 #define wxSeek _lseeki64
227 #define wxLseek _lseeki64
228 #define wxTell _telli64
229 #else
230 #define wxSeek _lseek
231 #define wxLseek _lseek
232 #define wxTell _tell
233 #endif
234 #define wxFsync _commit
235 #if defined(__WATCOMC__)
236 #define wxEof ::eof
237 #else
238 #define wxEof _eof
239 #endif
240
241 #if wxUSE_UNICODE
242 #if wxUSE_UNICODE_MSLU
243 #define wxOpen wxMSLU__wopen
244
245 #define wxAccess wxMSLU__waccess
246 #define wxMkDir wxMSLU__wmkdir
247 #define wxRmDir wxMSLU__wrmdir
248 #if wxHAS_HUGE_FILES
249 #define wxStat wxMSLU__wstati64
250 #else
251 #define wxStat wxMSLU__wstat
252 #endif
253 #else
254 #define wxOpen _wopen
255 #define wxAccess _waccess
256 #define wxMkDir _wmkdir
257 #define wxRmDir _wrmdir
258 #if wxHAS_HUGE_FILES
259 #define wxStat _wstati64
260 #else
261 #define wxStat _wstat
262 #endif
263 #endif
264 #else // !wxUSE_UNICODE
265 #ifdef __BORLANDC__
266 #define wxOpen open
267 #else
268 #define wxOpen _open
269 #endif
270 #define wxAccess _access
271 #define wxMkDir _mkdir
272 #ifdef __WATCOMC__
273 #define wxRmDir rmdir
274 #else
275 #define wxRmDir _rmdir
276 #endif
277 #if wxHAS_HUGE_FILES
278 #define wxStat _stati64
279 #else
280 #define wxStat _stat
281 #endif
282 #endif
283
284 // types: notice that Watcom is the only compiler to have a wide char
285 // version of struct stat as well as a wide char stat function variant
286 #if wxHAS_HUGE_FILES
287 #if wxUSE_UNICODE && defined(__WATCOMC__)
288 #define wxStructStat struct _wstati64
289 #else
290 #define wxStructStat struct _stati64
291 #endif
292 #else
293 #if wxUSE_UNICODE && defined(__WATCOMC__)
294 #define wxStructStat struct _wstat
295 #else
296 #define wxStructStat struct _stat
297 #endif
298 #endif
299
300 // constants (unless already defined by the user code)
301 #if !defined(__BORLANDC__) && !defined(__WATCOMC__)
302 #ifndef O_RDONLY
303 #define O_RDONLY _O_RDONLY
304 #define O_WRONLY _O_WRONLY
305 #define O_RDWR _O_RDWR
306 #define O_EXCL _O_EXCL
307 #define O_CREAT _O_CREAT
308 #define O_BINARY _O_BINARY
309 #endif
310
311 #ifndef S_IFMT
312 #define S_IFMT _S_IFMT
313 #define S_IFDIR _S_IFDIR
314 #define S_IFREG _S_IFREG
315 #endif
316 #endif
317
318 // It's a private define, undefine it so nobody gets tempted to use it
319 #undef wxHAS_HUGE_FILES
320 #else // Unix platforms using configure
321 typedef off_t wxFileOffset;
322 #ifdef _LARGE_FILES
323 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
324 #else
325 #define wxFileOffsetFmtSpec _T("")
326 #endif
327 // functions
328 #define wxClose close
329 #define wxRead ::read
330 #define wxWrite ::write
331 #define wxLseek lseek
332 #define wxSeek lseek
333 #define wxFsync commit
334 #define wxEof eof
335
336 #define wxMkDir mkdir
337 #define wxRmDir rmdir
338
339 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
340
341 #define wxStructStat struct stat
342
343 #if wxUSE_UNICODE
344 #define wxNEED_WX_UNISTD_H
345 #if defined(__DMC__)
346 typedef unsigned long mode_t;
347 #endif
348 WXDLLIMPEXP_BASE int wxStat( const wxChar *file_name, wxStructStat *buf );
349 WXDLLIMPEXP_BASE int wxAccess( const wxChar *pathname, int mode );
350 WXDLLIMPEXP_BASE int wxOpen( const wxChar *pathname, int flags, mode_t mode );
351 #else
352 #define wxOpen open
353 #define wxStat stat
354 #define wxAccess access
355 #endif
356 #endif // platforms
357
358 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
359 //
360 // VisualAge C++ V4.0 cannot have any external linkage const decs
361 // in headers included by more than one primary source
362 //
363 extern const wxFileOffset wxInvalidOffset;
364 #else
365 const wxFileOffset wxInvalidOffset = (wxFileOffset)-1;
366 #endif
367
368 // ----------------------------------------------------------------------------
369 // functions
370 // ----------------------------------------------------------------------------
371 WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);
372
373 // does the path exist? (may have or not '/' or '\\' at the end)
374 WXDLLIMPEXP_BASE bool wxPathExists(const wxChar *pszPathName);
375
376 WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);
377
378 // Get filename
379 WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path);
380 WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path);
381
382 // Get directory
383 WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path);
384
385 // wxString version
386 WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path);
387
388 WXDLLIMPEXP_BASE void wxDos2UnixFilename(wxChar *s);
389
390 WXDLLIMPEXP_BASE void wxUnix2DosFilename(wxChar *s);
391
392 // Strip the extension, in situ
393 WXDLLIMPEXP_BASE void wxStripExtension(wxChar *buffer);
394 WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer);
395
396 // Get a temporary filename
397 WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
398 WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf);
399
400 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
401 WXDLLIMPEXP_BASE wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
402 WXDLLIMPEXP_BASE bool wxExpandPath(wxString& dest, const wxChar *path);
403
404 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
405 // and make (if under the home tree) relative to home
406 // [caller must copy-- volatile]
407 WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename,
408 const wxString& envname = wxEmptyString,
409 const wxString& user = wxEmptyString);
410
411 // Destructive removal of /./ and /../ stuff
412 WXDLLIMPEXP_BASE wxChar* wxRealPath(wxChar *path);
413
414 // Allocate a copy of the full absolute path
415 WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path);
416
417 // Get first file name matching given wild card.
418 // Flags are reserved for future use.
419 #define wxFILE 1
420 #define wxDIR 2
421 WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
422 WXDLLIMPEXP_BASE wxString wxFindNextFile();
423
424 // Does the pattern contain wildcards?
425 WXDLLIMPEXP_BASE bool wxIsWild(const wxString& pattern);
426
427 // Does the pattern match the text (usually a filename)?
428 // If dot_special is true, doesn't match * against . (eliminating
429 // `hidden' dot files)
430 WXDLLIMPEXP_BASE bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = true);
431
432 // Concatenate two files to form third
433 WXDLLIMPEXP_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
434
435 // Copy file1 to file2
436 WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
437 bool overwrite = true);
438
439 // Remove file
440 WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
441
442 // Rename file
443 WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2);
444
445 // Get current working directory.
446 // If buf is NULL, allocates space using new, else
447 // copies into buf.
448 // IMPORTANT NOTE getcwd is know not to work under some releases
449 // of Win32s 1.3, according to MS release notes!
450 WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000);
451 // new and preferred version of wxGetWorkingDirectory
452 // NB: can't have the same name because of overloading ambiguity
453 WXDLLIMPEXP_BASE wxString wxGetCwd();
454
455 // Set working directory
456 WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d);
457
458 // Make directory
459 WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = 0777);
460
461 // Remove directory. Flags reserved for future use.
462 WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
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?
513 inline 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?
524 WXDLLIMPEXP_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 '\\')
528 WXDLLIMPEXP_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
534 WXDLLIMPEXP_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.
538 WXDLLIMPEXP_BASE wxString wxGetOSDirectory();
539
540 // Get file modification time
541 WXDLLIMPEXP_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"
548 WXDLLIMPEXP_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
557 class WXDLLIMPEXP_BASE wxUmaskChanger
558 {
559 public:
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
574 private:
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
590 class WXDLLIMPEXP_BASE wxPathList : public wxStringList
591 {
592 public:
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
610 private:
611 // DECLARE_DYNAMIC_CLASS(wxPathList)
612 };
613
614 #endif
615 // _WX_FILEFN_H_