projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Rename wxGetFileType to wxGetFileKind
[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 enum wxFileKind
126 {
127 wxFILE_KIND_UNKNOWN,
128 wxFILE_KIND_DISK, // a file supporting seeking to arbitrary offsets
129 wxFILE_KIND_TERMINAL, // a tty
130 wxFILE_KIND_PIPE // a pipe
131 };
132
133 // ----------------------------------------------------------------------------
134 // declare our versions of low level file functions: some compilers prepend
135 // underscores to the usual names, some also have Unicode versions of them
136 // ----------------------------------------------------------------------------
137
138 // Wrappers around Win32 api functions like CreateFile, ReadFile and such
139 // Implemented in filefnwce.cpp
140 #if defined( __WXWINCE__)
141 typedef __int64 wxFileOffset;
142 #define wxFileOffsetFmtSpec _("I64")
143 int wxOpen(const wxChar *filename, int oflag, int WXUNUSED(pmode));
144 int wxAccess(const wxChar *name, int WXUNUSED(how));
145 int wxClose(int fd);
146 int wxFsync(int WXUNUSED(fd));
147 int wxRead(int fd, void *buf, unsigned int count);
148 int wxWrite(int fd, const void *buf, unsigned int count);
149 int wxEof(int fd);
150 wxFileOffset wxSeek(int fd, wxFileOffset offset, int origin);
151 inline HANDLE wxGetOSFHandle(int fd) { return (HANDLE)fd; }
152 #define wxLSeek wxSeek
153 wxFileOffset wxTell(int fd);
154
155 // always Unicode under WinCE
156 #define wxMkDir _wmkdir
157 #define wxRmDir _wrmdir
158 #define wxStat _wstat
159 #define wxStructStat struct _stat
160
161 // Microsoft compiler loves underscores, feed them to it
162 #elif defined( __VISUALC__ ) \
163 || ( defined(__MINGW32__) && !defined(__WINE__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
164 || ( defined(__MWERKS__) && defined(__WXMSW__) ) \
165 || ( defined(__DMC__) && defined(__WXMSW__) ) \
166 || ( defined(__WATCOMC__) && defined(__WXMSW__) )
167
168 // detect compilers which have support for huge files (currently only
169 // Digital Mars doesn't)
170 #ifndef __WXPALMOS__
171 #include "wx/msw/private.h"
172 #endif
173
174 #undef wxHAS_HUGE_FILES
175 #if defined(__MINGW32__)
176 #define wxHAS_HUGE_FILES 1
177 #elif defined(__MWERKS__)
178 #define wxHAS_HUGE_FILES 0
179 #elif defined(__DMC__)
180 #define wxHAS_HUGE_FILES 0
181 #elif ((_INTEGRAL_MAX_BITS >= 64) || defined(_LARGE_FILES))
182 #define wxHAS_HUGE_FILES 1
183 #else
184 #define wxHAS_HUGE_FILES 0
185 #endif
186
187 // functions
188 #if defined(__BORLANDC__) || defined(__WATCOMC__)
189 #define _tell tell
190 #endif
191
192 #if wxHAS_HUGE_FILES
193 typedef wxLongLong_t wxFileOffset;
194 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
195 #else
196 typedef off_t wxFileOffset;
197 #endif
198
199 #define wxClose _close
200
201 #if defined(__MWERKS__)
202 #if __MSL__ >= 0x6000
203 #define wxRead(fd, buf, nCount) _read(fd, (void *)buf, nCount)
204 #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)
205 #else
206 #define wxRead(fd, buf, nCount)\
207 _read(fd, (const char *)buf, nCount)
208 #define wxWrite(fd, buf, nCount)\
209 _write(fd, (const char *)buf, nCount)
210 #endif
211 #else
212 #if defined(__DMC__) || defined(__WATCOMC__)
213 #define wxRead ::read
214 #define wxWrite ::write
215 #else
216 #define wxRead _read
217 #define wxWrite _write
218 #endif
219 #endif
220 #if wxHAS_HUGE_FILES
221 #define wxSeek _lseeki64
222 #define wxLseek _lseeki64
223 #define wxTell _telli64
224 #else
225 #define wxSeek _lseek
226 #define wxLseek _lseek
227 #define wxTell _tell
228 #endif
229 #define wxFsync _commit
230 #if defined(__WATCOMC__)
231 #define wxEof ::eof
232 #else
233 #define wxEof _eof
234 #endif
235
236 #if wxUSE_UNICODE
237 #if wxUSE_UNICODE_MSLU
238 #define wxOpen wxMSLU__wopen
239
240 #define wxAccess wxMSLU__waccess
241 #define wxMkDir wxMSLU__wmkdir
242 #define wxRmDir wxMSLU__wrmdir
243 #if wxHAS_HUGE_FILES
244 #define wxStat wxMSLU__wstati64
245 #else
246 #define wxStat wxMSLU__wstat
247 #endif
248 #else
249 #define wxOpen _wopen
250 #define wxAccess _waccess
251 #define wxMkDir _wmkdir
252 #define wxRmDir _wrmdir
253 #if wxHAS_HUGE_FILES
254 #define wxStat _wstati64
255 #else
256 #define wxStat _wstat
257 #endif
258 #endif
259 #else // !wxUSE_UNICODE
260 #ifdef __BORLANDC__
261 #define wxOpen open
262 #else
263 #define wxOpen _open
264 #endif
265 #define wxAccess _access
266 #define wxMkDir _mkdir
267 #ifdef __WATCOMC__
268 #define wxRmDir rmdir
269 #else
270 #define wxRmDir _rmdir
271 #endif
272 #if wxHAS_HUGE_FILES
273 #define wxStat _stati64
274 #else
275 #define wxStat _stat
276 #endif
277 #endif
278
279 // types: notice that Watcom is the only compiler to have a wide char
280 // version of struct stat as well as a wide char stat function variant
281 #if wxHAS_HUGE_FILES
282 #if wxUSE_UNICODE && defined(__WATCOMC__)
283 #define wxStructStat struct _wstati64
284 #else
285 #define wxStructStat struct _stati64
286 #endif
287 #else
288 #if wxUSE_UNICODE && defined(__WATCOMC__)
289 #define wxStructStat struct _wstat
290 #else
291 #define wxStructStat struct _stat
292 #endif
293 #endif
294
295 // constants (unless already defined by the user code)
296 #if !defined(__BORLANDC__) && !defined(__WATCOMC__) && !defined(__WXPALMOS__)
297 #ifndef O_RDONLY
298 #define O_RDONLY _O_RDONLY
299 #define O_WRONLY _O_WRONLY
300 #define O_RDWR _O_RDWR
301 #define O_EXCL _O_EXCL
302 #define O_CREAT _O_CREAT
303 #define O_BINARY _O_BINARY
304 #endif
305
306 #ifndef S_IFMT
307 #define S_IFMT _S_IFMT
308 #define S_IFDIR _S_IFDIR
309 #define S_IFREG _S_IFREG
310 #endif
311 #endif
312
313 // It's a private define, undefine it so nobody gets tempted to use it
314 #undef wxHAS_HUGE_FILES
315 #else // Unix platforms using configure
316 typedef off_t wxFileOffset;
317 #ifdef _LARGE_FILES
318 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
319 wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t),
320 BadFileSizeType );
321 #else
322 #define wxFileOffsetFmtSpec _T("")
323 #endif
324 // functions
325 #define wxClose close
326 #define wxRead ::read
327 #define wxWrite ::write
328 #define wxLseek lseek
329 #define wxSeek lseek
330 #define wxFsync commit
331 #define wxEof eof
332
333 #define wxMkDir mkdir
334 #define wxRmDir rmdir
335
336 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
337
338 #define wxStructStat struct stat
339
340 #if wxUSE_UNICODE
341 #define wxNEED_WX_UNISTD_H
342 #if defined(__DMC__)
343 typedef unsigned long mode_t;
344 #endif
345 WXDLLIMPEXP_BASE int wxStat( const wxChar *file_name, wxStructStat *buf );
346 WXDLLIMPEXP_BASE int wxAccess( const wxChar *pathname, int mode );
347 WXDLLIMPEXP_BASE int wxOpen( const wxChar *pathname, int flags, mode_t mode );
348 #else
349 #define wxOpen open
350 #define wxStat stat
351 #define wxAccess access
352 #endif
353 #endif // platforms
354
355 #if defined __WXMSW__ && !defined __WXWINCE__
356 // get the HANDLE associated with a file descriptor
357 inline HANDLE wxGetOSFHandle(int fd) { return (HANDLE)_get_osfhandle(fd); }
358 #endif
359
360 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
361 //
362 // VisualAge C++ V4.0 cannot have any external linkage const decs
363 // in headers included by more than one primary source
364 //
365 extern const int wxInvalidOffset;
366 #else
367 const int wxInvalidOffset = -1;
368 #endif
369
370 // ----------------------------------------------------------------------------
371 // functions
372 // ----------------------------------------------------------------------------
373 WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);
374
375 // does the path exist? (may have or not '/' or '\\' at the end)
376 WXDLLIMPEXP_BASE bool wxPathExists(const wxChar *pszPathName);
377
378 WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);
379
380 // Get filename
381 WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path);
382 WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path);
383
384 // Get directory
385 WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path);
386
387 // wxString version
388 WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path);
389
390 WXDLLIMPEXP_BASE void wxDos2UnixFilename(wxChar *s);
391
392 WXDLLIMPEXP_BASE void wxUnix2DosFilename(wxChar *s);
393
394 // Strip the extension, in situ
395 WXDLLIMPEXP_BASE void wxStripExtension(wxChar *buffer);
396 WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer);
397
398 // Get a temporary filename
399 WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
400 WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf);
401
402 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
403 WXDLLIMPEXP_BASE wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
404 WXDLLIMPEXP_BASE bool wxExpandPath(wxString& dest, const wxChar *path);
405
406 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
407 // and make (if under the home tree) relative to home
408 // [caller must copy-- volatile]
409 WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename,
410 const wxString& envname = wxEmptyString,
411 const wxString& user = wxEmptyString);
412
413 // Destructive removal of /./ and /../ stuff
414 WXDLLIMPEXP_BASE wxChar* wxRealPath(wxChar *path);
415
416 // Allocate a copy of the full absolute path
417 WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path);
418
419 // Get first file name matching given wild card.
420 // Flags are reserved for future use.
421 #define wxFILE 1
422 #define wxDIR 2
423 WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
424 WXDLLIMPEXP_BASE wxString wxFindNextFile();
425
426 // Does the pattern contain wildcards?
427 WXDLLIMPEXP_BASE bool wxIsWild(const wxString& pattern);
428
429 // Does the pattern match the text (usually a filename)?
430 // If dot_special is true, doesn't match * against . (eliminating
431 // `hidden' dot files)
432 WXDLLIMPEXP_BASE bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = true);
433
434 // Concatenate two files to form third
435 WXDLLIMPEXP_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
436
437 // Copy file1 to file2
438 WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
439 bool overwrite = true);
440
441 // Remove file
442 WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
443
444 // Rename file
445 WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2);
446
447 // Get current working directory.
448 // If buf is NULL, allocates space using new, else
449 // copies into buf.
450 // IMPORTANT NOTE getcwd is know not to work under some releases
451 // of Win32s 1.3, according to MS release notes!
452 WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000);
453 // new and preferred version of wxGetWorkingDirectory
454 // NB: can't have the same name because of overloading ambiguity
455 WXDLLIMPEXP_BASE wxString wxGetCwd();
456
457 // Set working directory
458 WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d);
459
460 // Make directory
461 WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = 0777);
462
463 // Remove directory. Flags reserved for future use.
464 WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
465
466 // Return the type of an open file
467 WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(int fd);
468 inline wxFileKind wxGetFileKind (FILE *fp) { return wxGetFileKind(fileno(fp)); }
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_
wxWidgets (Impactor)