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