1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: File- and directory-related functions
4 // Author: Julian Smart
8 // Copyright: (c) 1998 Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
16 #include "wx/arrstr.h"
19 #include "wx/msw/wince/time.h"
20 #include "wx/msw/private.h"
27 #elif !defined(__MWERKS__)
28 #include <sys/types.h>
32 #include <sys/types.h>
44 // need to check for __OS2__ first since currently both
45 // __OS2__ and __UNIX__ are defined.
47 #include "wx/os2/private.h"
55 #elif defined(__UNIX__)
60 #if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
61 #if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__SALFORDC__) && !defined(__WXWINCE__) && !defined(__CYGWIN__)
66 #endif // native Win compiler
80 #ifdef __BORLANDC__ // Please someone tell me which version of Borland needs
81 // this (3.1 I believe) and how to test for it.
82 // If this works for Borland 4.0 as well, then no worries.
92 #include <fcntl.h> // O_RDONLY &c
94 // ----------------------------------------------------------------------------
96 // ----------------------------------------------------------------------------
102 #if !defined(__WXMAC__) || defined(__UNIX__) || defined(__MACH__)
103 #include <sys/types.h>
109 #if (defined(__VISUALC__) && !defined(__WXWINCE__)) || ( defined(__MWERKS__) && defined( __INTEL__) )
110 typedef _off_t off_t
;
111 #elif defined(__SYMANTEC__)
113 #elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__)
127 wxFILE_KIND_DISK
, // a file supporting seeking to arbitrary offsets
128 wxFILE_KIND_TERMINAL
, // a tty
129 wxFILE_KIND_PIPE
// a pipe
132 // ----------------------------------------------------------------------------
133 // declare our versions of low level file functions: some compilers prepend
134 // underscores to the usual names, some also have Unicode versions of them
135 // ----------------------------------------------------------------------------
137 // Wrappers around Win32 api functions like CreateFile, ReadFile and such
138 // Implemented in filefnwce.cpp
139 #if defined( __WXWINCE__)
140 typedef __int64 wxFileOffset
;
141 #define wxFileOffsetFmtSpec _("I64")
142 int wxOpen(const wxChar
*filename
, int oflag
, int WXUNUSED(pmode
));
143 int wxAccess(const wxChar
*name
, int WXUNUSED(how
));
145 int wxFsync(int WXUNUSED(fd
));
146 int wxRead(int fd
, void *buf
, unsigned int count
);
147 int wxWrite(int fd
, const void *buf
, unsigned int count
);
149 wxFileOffset
wxSeek(int fd
, wxFileOffset offset
, int origin
);
150 #define wxLSeek wxSeek
151 wxFileOffset
wxTell(int fd
);
153 // always Unicode under WinCE
154 #define wxMkDir _wmkdir
155 #define wxRmDir _wrmdir
156 #define wxStat _wstat
157 #define wxStructStat struct _stat
159 // Microsoft compiler loves underscores, feed them to it
160 #elif defined( __VISUALC__ ) \
161 || ( defined(__MINGW32__) && !defined(__WINE__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
162 || ( defined(__MWERKS__) && defined(__WXMSW__) ) \
163 || ( defined(__DMC__) && defined(__WXMSW__) ) \
164 || ( defined(__WATCOMC__) && defined(__WXMSW__) )
166 // detect compilers which have support for huge files (currently only
167 // Digital Mars doesn't)
169 #include "wx/msw/private.h"
172 #undef wxHAS_HUGE_FILES
173 #if defined(__MINGW32__)
174 #define wxHAS_HUGE_FILES 1
175 #elif defined(__MWERKS__)
176 #define wxHAS_HUGE_FILES 0
177 #elif defined(__DMC__)
178 #define wxHAS_HUGE_FILES 0
179 #elif ((_INTEGRAL_MAX_BITS >= 64) || defined(_LARGE_FILES))
180 #define wxHAS_HUGE_FILES 1
182 #define wxHAS_HUGE_FILES 0
186 #if defined(__BORLANDC__) || defined(__WATCOMC__)
191 typedef wxLongLong_t wxFileOffset
;
192 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
194 typedef off_t wxFileOffset
;
197 #define wxClose _close
199 #if defined(__MWERKS__)
200 #if __MSL__ >= 0x6000
201 #define wxRead(fd, buf, nCount) _read(fd, (void *)buf, nCount)
202 #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)
204 #define wxRead(fd, buf, nCount)\
205 _read(fd, (const char *)buf, nCount)
206 #define wxWrite(fd, buf, nCount)\
207 _write(fd, (const char *)buf, nCount)
210 #if defined(__DMC__) || defined(__WATCOMC__)
211 #define wxRead ::read
212 #define wxWrite ::write
215 #define wxWrite _write
219 #define wxSeek _lseeki64
220 #define wxLseek _lseeki64
221 #define wxTell _telli64
223 #define wxSeek _lseek
224 #define wxLseek _lseek
227 #define wxFsync _commit
228 #if defined(__WATCOMC__)
235 #if wxUSE_UNICODE_MSLU
236 #define wxOpen wxMSLU__wopen
238 #define wxAccess wxMSLU__waccess
239 #define wxMkDir wxMSLU__wmkdir
240 #define wxRmDir wxMSLU__wrmdir
242 #define wxStat wxMSLU__wstati64
244 #define wxStat wxMSLU__wstat
247 #define wxOpen _wopen
248 #define wxAccess _waccess
249 #define wxMkDir _wmkdir
250 #define wxRmDir _wrmdir
252 #define wxStat _wstati64
254 #define wxStat _wstat
257 #else // !wxUSE_UNICODE
263 #define wxAccess _access
264 #define wxMkDir _mkdir
266 #define wxRmDir rmdir
268 #define wxRmDir _rmdir
271 #define wxStat _stati64
277 // Types: Notice that Watcom is the only compiler to have a wide char
278 // version of struct stat as well as a wide char stat function variant.
279 // This was droped since OW 1.4 "for consistency across platforms".
281 #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
282 #define wxStructStat struct _wstati64
284 #define wxStructStat struct _stati64
287 #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
288 #define wxStructStat struct _wstat
290 #define wxStructStat struct _stat
294 // constants (unless already defined by the user code)
295 #if !defined(__BORLANDC__) && !defined(__WATCOMC__) && !defined(__WXPALMOS__)
297 #define O_RDONLY _O_RDONLY
298 #define O_WRONLY _O_WRONLY
299 #define O_RDWR _O_RDWR
300 #define O_EXCL _O_EXCL
301 #define O_CREAT _O_CREAT
302 #define O_BINARY _O_BINARY
306 #define S_IFMT _S_IFMT
307 #define S_IFDIR _S_IFDIR
308 #define S_IFREG _S_IFREG
312 // It's a private define, undefine it so nobody gets tempted to use it
313 #undef wxHAS_HUGE_FILES
314 #else // Unix platforms using configure
315 typedef off_t wxFileOffset
;
317 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
318 wxCOMPILE_TIME_ASSERT( sizeof(off_t
) == sizeof(wxLongLong_t
),
321 #define wxFileOffsetFmtSpec _T("")
324 #define wxClose close
325 #define wxRead ::read
326 #define wxWrite ::write
327 #define wxLseek lseek
329 #define wxFsync fsync
332 #define wxMkDir mkdir
333 #define wxRmDir rmdir
335 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
337 #define wxStructStat struct stat
340 #define wxNEED_WX_UNISTD_H
342 typedef unsigned long mode_t
;
344 WXDLLIMPEXP_BASE
int wxStat( const wxChar
*file_name
, wxStructStat
*buf
);
345 WXDLLIMPEXP_BASE
int wxLstat( 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
);
351 #define wxLstat lstat
352 #define wxAccess access
356 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
358 // VisualAge C++ V4.0 cannot have any external linkage const decs
359 // in headers included by more than one primary source
361 extern const int wxInvalidOffset
;
363 const int wxInvalidOffset
= -1;
366 // ----------------------------------------------------------------------------
368 // ----------------------------------------------------------------------------
369 WXDLLIMPEXP_BASE
bool wxFileExists(const wxString
& filename
);
371 // does the path exist? (may have or not '/' or '\\' at the end)
372 WXDLLIMPEXP_BASE
bool wxDirExists(const wxChar
*pszPathName
);
374 WXDLLIMPEXP_BASE
bool wxIsAbsolutePath(const wxString
& filename
);
377 WXDLLIMPEXP_BASE wxChar
* wxFileNameFromPath(wxChar
*path
);
378 WXDLLIMPEXP_BASE wxString
wxFileNameFromPath(const wxString
& path
);
381 WXDLLIMPEXP_BASE wxString
wxPathOnly(const wxString
& path
);
384 WXDLLIMPEXP_BASE wxString
wxRealPath(const wxString
& path
);
386 WXDLLIMPEXP_BASE
void wxDos2UnixFilename(wxChar
*s
);
388 WXDLLIMPEXP_BASE
void wxUnix2DosFilename(wxChar
*s
);
390 // Strip the extension, in situ
391 WXDLLIMPEXP_BASE
void wxStripExtension(wxChar
*buffer
);
392 WXDLLIMPEXP_BASE
void wxStripExtension(wxString
& buffer
);
394 // Get a temporary filename
395 WXDLLIMPEXP_BASE wxChar
* wxGetTempFileName(const wxString
& prefix
, wxChar
*buf
= (wxChar
*) NULL
);
396 WXDLLIMPEXP_BASE
bool wxGetTempFileName(const wxString
& prefix
, wxString
& buf
);
398 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
399 WXDLLIMPEXP_BASE wxChar
* wxExpandPath(wxChar
*dest
, const wxChar
*path
);
400 WXDLLIMPEXP_BASE
bool wxExpandPath(wxString
& dest
, const wxChar
*path
);
402 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
403 // and make (if under the home tree) relative to home
404 // [caller must copy-- volatile]
405 WXDLLIMPEXP_BASE wxChar
* wxContractPath(const wxString
& filename
,
406 const wxString
& envname
= wxEmptyString
,
407 const wxString
& user
= wxEmptyString
);
409 // Destructive removal of /./ and /../ stuff
410 WXDLLIMPEXP_BASE wxChar
* wxRealPath(wxChar
*path
);
412 // Allocate a copy of the full absolute path
413 WXDLLIMPEXP_BASE wxChar
* wxCopyAbsolutePath(const wxString
& path
);
415 // Get first file name matching given wild card.
416 // Flags are reserved for future use.
419 WXDLLIMPEXP_BASE wxString
wxFindFirstFile(const wxChar
*spec
, int flags
= wxFILE
);
420 WXDLLIMPEXP_BASE wxString
wxFindNextFile();
422 // Does the pattern contain wildcards?
423 WXDLLIMPEXP_BASE
bool wxIsWild(const wxString
& pattern
);
425 // Does the pattern match the text (usually a filename)?
426 // If dot_special is true, doesn't match * against . (eliminating
427 // `hidden' dot files)
428 WXDLLIMPEXP_BASE
bool wxMatchWild(const wxString
& pattern
, const wxString
& text
, bool dot_special
= true);
430 // Concatenate two files to form third
431 WXDLLIMPEXP_BASE
bool wxConcatFiles(const wxString
& file1
, const wxString
& file2
, const wxString
& file3
);
433 // Copy file1 to file2
434 WXDLLIMPEXP_BASE
bool wxCopyFile(const wxString
& file1
, const wxString
& file2
,
435 bool overwrite
= true);
438 WXDLLIMPEXP_BASE
bool wxRemoveFile(const wxString
& file
);
441 WXDLLIMPEXP_BASE
bool wxRenameFile(const wxString
& file1
, const wxString
& file2
, bool overwrite
= true);
443 // Get current working directory.
444 #if WXWIN_COMPATIBILITY_2_6
445 // If buf is NULL, allocates space using new, else
447 // IMPORTANT NOTE getcwd is know not to work under some releases
448 // of Win32s 1.3, according to MS release notes!
449 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar
* wxGetWorkingDirectory(wxChar
*buf
= (wxChar
*) NULL
, int sz
= 1000) );
450 // new and preferred version of wxGetWorkingDirectory
451 // NB: can't have the same name because of overloading ambiguity
452 #endif // WXWIN_COMPATIBILITY_2_6
453 WXDLLIMPEXP_BASE wxString
wxGetCwd();
455 // Set working directory
456 WXDLLIMPEXP_BASE
bool wxSetWorkingDirectory(const wxString
& d
);
459 WXDLLIMPEXP_BASE
bool wxMkdir(const wxString
& dir
, int perm
= 0777);
461 // Remove directory. Flags reserved for future use.
462 WXDLLIMPEXP_BASE
bool wxRmdir(const wxString
& dir
, int flags
= 0);
464 // Return the type of an open file
465 WXDLLIMPEXP_BASE wxFileKind
wxGetFileKind(int fd
);
466 WXDLLIMPEXP_BASE wxFileKind
wxGetFileKind(FILE *fp
);
468 #if WXWIN_COMPATIBILITY_2_6
469 // compatibility defines, don't use in new code
470 wxDEPRECATED( inline bool wxPathExists(const wxChar
*pszPathName
) );
471 inline bool wxPathExists(const wxChar
*pszPathName
)
473 return wxDirExists(pszPathName
);
475 #endif //WXWIN_COMPATIBILITY_2_6
477 // permissions; these functions work both on files and directories:
478 WXDLLIMPEXP_BASE
bool wxIsWritable(const wxString
&path
);
479 WXDLLIMPEXP_BASE
bool wxIsReadable(const wxString
&path
);
480 WXDLLIMPEXP_BASE
bool wxIsExecutable(const wxString
&path
);
482 // ----------------------------------------------------------------------------
483 // separators in file names
484 // ----------------------------------------------------------------------------
486 // between file name and extension
487 #define wxFILE_SEP_EXT wxT('.')
489 // between drive/volume name and the path
490 #define wxFILE_SEP_DSK wxT(':')
492 // between the path components
493 #define wxFILE_SEP_PATH_DOS wxT('\\')
494 #define wxFILE_SEP_PATH_UNIX wxT('/')
495 #define wxFILE_SEP_PATH_MAC wxT(':')
496 #define wxFILE_SEP_PATH_VMS wxT('.') // VMS also uses '[' and ']'
498 // separator in the path list (as in PATH environment variable)
499 // there is no PATH variable in Classic Mac OS so just use the
500 // semicolon (it must be different from the file name separator)
501 // NB: these are strings and not characters on purpose!
502 #define wxPATH_SEP_DOS wxT(";")
503 #define wxPATH_SEP_UNIX wxT(":")
504 #define wxPATH_SEP_MAC wxT(";")
506 // platform independent versions
507 #if defined(__UNIX__) && !defined(__OS2__)
508 // CYGWIN also uses UNIX settings
509 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
510 #define wxPATH_SEP wxPATH_SEP_UNIX
511 #elif defined(__MAC__)
512 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_MAC
513 #define wxPATH_SEP wxPATH_SEP_MAC
514 #else // Windows and OS/2
515 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS
516 #define wxPATH_SEP wxPATH_SEP_DOS
517 #endif // Unix/Windows
519 // this is useful for wxString::IsSameAs(): to compare two file names use
520 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
521 #if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__)
522 #define wxARE_FILENAMES_CASE_SENSITIVE true
523 #else // Windows, Mac OS and OS/2
524 #define wxARE_FILENAMES_CASE_SENSITIVE false
525 #endif // Unix/Windows
527 // is the char a path separator?
528 inline bool wxIsPathSeparator(wxChar c
)
530 // under DOS/Windows we should understand both Unix and DOS file separators
531 #if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
532 return c
== wxFILE_SEP_PATH
;
534 return c
== wxFILE_SEP_PATH_DOS
|| c
== wxFILE_SEP_PATH_UNIX
;
538 // does the string ends with path separator?
539 WXDLLIMPEXP_BASE
bool wxEndsWithPathSeparator(const wxChar
*pszFileName
);
541 // split the full path into path (including drive for DOS), name and extension
542 // (understands both '/' and '\\')
543 WXDLLIMPEXP_BASE
void wxSplitPath(const wxChar
*pszFileName
,
548 // find a file in a list of directories, returns false if not found
549 WXDLLIMPEXP_BASE
bool wxFindFileInPath(wxString
*pStr
, const wxChar
*pszPath
, const wxChar
*pszFile
);
551 // Get the OS directory if appropriate (such as the Windows directory).
552 // On non-Windows platform, probably just return the empty string.
553 WXDLLIMPEXP_BASE wxString
wxGetOSDirectory();
557 // Get file modification time
558 WXDLLIMPEXP_BASE
time_t wxFileModificationTime(const wxString
& filename
);
560 #endif // wxUSE_DATETIME
562 // Parses the wildCard, returning the number of filters.
563 // Returns 0 if none or if there's a problem,
564 // The arrays will contain an equal number of items found before the error.
565 // wildCard is in the form:
566 // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
567 WXDLLIMPEXP_BASE
int wxParseCommonDialogsFilter(const wxString
& wildCard
, wxArrayString
& descriptions
, wxArrayString
& filters
);
569 // ----------------------------------------------------------------------------
571 // ----------------------------------------------------------------------------
575 // set umask to the given value in ctor and reset it to the old one in dtor
576 class WXDLLIMPEXP_BASE wxUmaskChanger
579 // change the umask to the given one if it is not -1: this allows to write
580 // the same code whether you really want to change umask or not, as is in
581 // wxFileConfig::Flush() for example
582 wxUmaskChanger(int umaskNew
)
584 m_umaskOld
= umaskNew
== -1 ?
-1 : (int)umask((mode_t
)umaskNew
);
589 if ( m_umaskOld
!= -1 )
590 umask((mode_t
)m_umaskOld
);
597 // this macro expands to an "anonymous" wxUmaskChanger object under Unix and
599 #define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
603 #define wxCHANGE_UMASK(m)
605 #endif // __UNIX__/!__UNIX__
609 class WXDLLIMPEXP_BASE wxPathList
: public wxArrayString
613 wxPathList(const wxArrayString
&arr
)
616 // Adds all paths in environment variable
617 void AddEnvList(const wxString
& envVariable
);
619 // Adds given path to this list
620 void Add(const wxString
& path
);
621 void Add(const wxArrayString
&paths
);
623 // Find the first full path for which the file exists
624 wxString
FindValidPath(const wxString
& filename
) const;
626 // Find the first full path for which the file exists; ensure it's an
627 // absolute path that gets returned.
628 wxString
FindAbsoluteValidPath(const wxString
& filename
) const;
630 // Given full path and filename, add path to list
631 void EnsureFileAccessible(const wxString
& path
);
633 // Returns true if the path is in the list
634 wxDEPRECATED( bool Member(const wxString
& path
) const );
637 #endif // _WX_FILEFN_H_