1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: File- and directory-related functions
4 // Author: Julian Smart
8 // Copyright: (c) 1998 Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16 #pragma interface "filefn.h"
20 #include "wx/arrstr.h"
23 #include "wx/msw/wince/time.h"
24 #include "wx/msw/private.h"
31 #elif !defined(__MWERKS__)
32 #include <sys/types.h>
36 #include <sys/types.h>
48 // need to check for __OS2__ first since currently both
49 // __OS2__ and __UNIX__ are defined.
51 #include "wx/os2/private.h"
56 #elif defined(__UNIX__)
61 #if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
62 #if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__SALFORDC__) && !defined(__WXWINCE__)
67 #endif // native Win compiler
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.
93 #include <fcntl.h> // O_RDONLY &c
95 // ----------------------------------------------------------------------------
97 // ----------------------------------------------------------------------------
103 #if !defined(__WXMAC__) || defined(__UNIX__) || defined(__MACH__)
104 #include <sys/types.h>
110 #if (defined(__VISUALC__) && !defined(__WXWINCE__)) || ( defined(__MWERKS__) && defined( __INTEL__) )
111 typedef _off_t off_t
;
112 #elif defined(__SYMANTEC__)
114 #elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__)
128 wxFILE_KIND_DISK
, // a file supporting seeking to arbitrary offsets
129 wxFILE_KIND_TERMINAL
, // a tty
130 wxFILE_KIND_PIPE
// a pipe
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 // ----------------------------------------------------------------------------
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
));
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
);
150 wxFileOffset
wxSeek(int fd
, wxFileOffset offset
, int origin
);
151 #define wxLSeek wxSeek
152 wxFileOffset
wxTell(int fd
);
154 // always Unicode under WinCE
155 #define wxMkDir _wmkdir
156 #define wxRmDir _wrmdir
157 #define wxStat _wstat
158 #define wxStructStat struct _stat
160 // Microsoft compiler loves underscores, feed them to it
161 #elif defined( __VISUALC__ ) \
162 || ( defined(__MINGW32__) && !defined(__WINE__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
163 || ( defined(__MWERKS__) && defined(__WXMSW__) ) \
164 || ( defined(__DMC__) && defined(__WXMSW__) ) \
165 || ( defined(__WATCOMC__) && defined(__WXMSW__) )
167 // detect compilers which have support for huge files (currently only
168 // Digital Mars doesn't)
170 #include "wx/msw/private.h"
173 #undef wxHAS_HUGE_FILES
174 #if defined(__MINGW32__)
175 #define wxHAS_HUGE_FILES 1
176 #elif defined(__MWERKS__)
177 #define wxHAS_HUGE_FILES 0
178 #elif defined(__DMC__)
179 #define wxHAS_HUGE_FILES 0
180 #elif ((_INTEGRAL_MAX_BITS >= 64) || defined(_LARGE_FILES))
181 #define wxHAS_HUGE_FILES 1
183 #define wxHAS_HUGE_FILES 0
187 #if defined(__BORLANDC__) || defined(__WATCOMC__)
192 typedef wxLongLong_t wxFileOffset
;
193 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
195 typedef off_t wxFileOffset
;
198 #define wxClose _close
200 #if defined(__MWERKS__)
201 #if __MSL__ >= 0x6000
202 #define wxRead(fd, buf, nCount) _read(fd, (void *)buf, nCount)
203 #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)
205 #define wxRead(fd, buf, nCount)\
206 _read(fd, (const char *)buf, nCount)
207 #define wxWrite(fd, buf, nCount)\
208 _write(fd, (const char *)buf, nCount)
211 #if defined(__DMC__) || defined(__WATCOMC__)
212 #define wxRead ::read
213 #define wxWrite ::write
216 #define wxWrite _write
220 #define wxSeek _lseeki64
221 #define wxLseek _lseeki64
222 #define wxTell _telli64
224 #define wxSeek _lseek
225 #define wxLseek _lseek
228 #define wxFsync _commit
229 #if defined(__WATCOMC__)
236 #if wxUSE_UNICODE_MSLU
237 #define wxOpen wxMSLU__wopen
239 #define wxAccess wxMSLU__waccess
240 #define wxMkDir wxMSLU__wmkdir
241 #define wxRmDir wxMSLU__wrmdir
243 #define wxStat wxMSLU__wstati64
245 #define wxStat wxMSLU__wstat
248 #define wxOpen _wopen
249 #define wxAccess _waccess
250 #define wxMkDir _wmkdir
251 #define wxRmDir _wrmdir
253 #define wxStat _wstati64
255 #define wxStat _wstat
258 #else // !wxUSE_UNICODE
264 #define wxAccess _access
265 #define wxMkDir _mkdir
267 #define wxRmDir rmdir
269 #define wxRmDir _rmdir
272 #define wxStat _stati64
278 // types: notice that Watcom is the only compiler to have a wide char
279 // version of struct stat as well as a wide char stat function variant
281 #if wxUSE_UNICODE && defined(__WATCOMC__)
282 #define wxStructStat struct _wstati64
284 #define wxStructStat struct _stati64
287 #if wxUSE_UNICODE && defined(__WATCOMC__)
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 commit
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 wxAccess( const wxChar
*pathname
, int mode
);
346 WXDLLIMPEXP_BASE
int wxOpen( const wxChar
*pathname
, int flags
, mode_t mode
);
350 #define wxAccess access
354 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
356 // VisualAge C++ V4.0 cannot have any external linkage const decs
357 // in headers included by more than one primary source
359 extern const int wxInvalidOffset
;
361 const int wxInvalidOffset
= -1;
364 // ----------------------------------------------------------------------------
366 // ----------------------------------------------------------------------------
367 WXDLLIMPEXP_BASE
bool wxFileExists(const wxString
& filename
);
369 // does the path exist? (may have or not '/' or '\\' at the end)
370 WXDLLIMPEXP_BASE
bool wxDirExists(const wxChar
*pszPathName
);
372 WXDLLIMPEXP_BASE
bool wxIsAbsolutePath(const wxString
& filename
);
375 WXDLLIMPEXP_BASE wxChar
* wxFileNameFromPath(wxChar
*path
);
376 WXDLLIMPEXP_BASE wxString
wxFileNameFromPath(const wxString
& path
);
379 WXDLLIMPEXP_BASE wxString
wxPathOnly(const wxString
& path
);
382 WXDLLIMPEXP_BASE wxString
wxRealPath(const wxString
& path
);
384 WXDLLIMPEXP_BASE
void wxDos2UnixFilename(wxChar
*s
);
386 WXDLLIMPEXP_BASE
void wxUnix2DosFilename(wxChar
*s
);
388 // Strip the extension, in situ
389 WXDLLIMPEXP_BASE
void wxStripExtension(wxChar
*buffer
);
390 WXDLLIMPEXP_BASE
void wxStripExtension(wxString
& buffer
);
392 // Get a temporary filename
393 WXDLLIMPEXP_BASE wxChar
* wxGetTempFileName(const wxString
& prefix
, wxChar
*buf
= (wxChar
*) NULL
);
394 WXDLLIMPEXP_BASE
bool wxGetTempFileName(const wxString
& prefix
, wxString
& buf
);
396 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
397 WXDLLIMPEXP_BASE wxChar
* wxExpandPath(wxChar
*dest
, const wxChar
*path
);
398 WXDLLIMPEXP_BASE
bool wxExpandPath(wxString
& dest
, const wxChar
*path
);
400 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
401 // and make (if under the home tree) relative to home
402 // [caller must copy-- volatile]
403 WXDLLIMPEXP_BASE wxChar
* wxContractPath(const wxString
& filename
,
404 const wxString
& envname
= wxEmptyString
,
405 const wxString
& user
= wxEmptyString
);
407 // Destructive removal of /./ and /../ stuff
408 WXDLLIMPEXP_BASE wxChar
* wxRealPath(wxChar
*path
);
410 // Allocate a copy of the full absolute path
411 WXDLLIMPEXP_BASE wxChar
* wxCopyAbsolutePath(const wxString
& path
);
413 // Get first file name matching given wild card.
414 // Flags are reserved for future use.
417 WXDLLIMPEXP_BASE wxString
wxFindFirstFile(const wxChar
*spec
, int flags
= wxFILE
);
418 WXDLLIMPEXP_BASE wxString
wxFindNextFile();
420 // Does the pattern contain wildcards?
421 WXDLLIMPEXP_BASE
bool wxIsWild(const wxString
& pattern
);
423 // Does the pattern match the text (usually a filename)?
424 // If dot_special is true, doesn't match * against . (eliminating
425 // `hidden' dot files)
426 WXDLLIMPEXP_BASE
bool wxMatchWild(const wxString
& pattern
, const wxString
& text
, bool dot_special
= true);
428 // Concatenate two files to form third
429 WXDLLIMPEXP_BASE
bool wxConcatFiles(const wxString
& file1
, const wxString
& file2
, const wxString
& file3
);
431 // Copy file1 to file2
432 WXDLLIMPEXP_BASE
bool wxCopyFile(const wxString
& file1
, const wxString
& file2
,
433 bool overwrite
= true);
436 WXDLLIMPEXP_BASE
bool wxRemoveFile(const wxString
& file
);
439 WXDLLIMPEXP_BASE
bool wxRenameFile(const wxString
& file1
, const wxString
& file2
);
441 // Get current working directory.
442 // If buf is NULL, allocates space using new, else
444 // IMPORTANT NOTE getcwd is know not to work under some releases
445 // of Win32s 1.3, according to MS release notes!
446 WXDLLIMPEXP_BASE wxChar
* wxGetWorkingDirectory(wxChar
*buf
= (wxChar
*) NULL
, int sz
= 1000);
447 // new and preferred version of wxGetWorkingDirectory
448 // NB: can't have the same name because of overloading ambiguity
449 WXDLLIMPEXP_BASE wxString
wxGetCwd();
451 // Set working directory
452 WXDLLIMPEXP_BASE
bool wxSetWorkingDirectory(const wxString
& d
);
455 WXDLLIMPEXP_BASE
bool wxMkdir(const wxString
& dir
, int perm
= 0777);
457 // Remove directory. Flags reserved for future use.
458 WXDLLIMPEXP_BASE
bool wxRmdir(const wxString
& dir
, int flags
= 0);
460 // Return the type of an open file
461 WXDLLIMPEXP_BASE wxFileKind
wxGetFileKind(int fd
);
462 WXDLLIMPEXP_BASE wxFileKind
wxGetFileKind(FILE *fp
);
464 // compatibility defines, don't use in new code
465 // consider removal droping 2.4 compatibility
466 // #if WXWIN_COMPATIBILITY_2_4
467 wxDEPRECATED( inline bool wxPathExists(const wxChar
*pszPathName
) );
468 inline bool wxPathExists(const wxChar
*pszPathName
)
470 return wxDirExists(pszPathName
);
472 // #endif //WXWIN_COMPATIBILITY_2_4
474 // ----------------------------------------------------------------------------
475 // separators in file names
476 // ----------------------------------------------------------------------------
478 // between file name and extension
479 #define wxFILE_SEP_EXT wxT('.')
481 // between drive/volume name and the path
482 #define wxFILE_SEP_DSK wxT(':')
484 // between the path components
485 #define wxFILE_SEP_PATH_DOS wxT('\\')
486 #define wxFILE_SEP_PATH_UNIX wxT('/')
487 #define wxFILE_SEP_PATH_MAC wxT(':')
488 #define wxFILE_SEP_PATH_VMS wxT('.') // VMS also uses '[' and ']'
490 // separator in the path list (as in PATH environment variable)
491 // there is no PATH variable in Classic Mac OS so just use the
492 // semicolon (it must be different from the file name separator)
493 // NB: these are strings and not characters on purpose!
494 #define wxPATH_SEP_DOS wxT(";")
495 #define wxPATH_SEP_UNIX wxT(":")
496 #define wxPATH_SEP_MAC wxT(";")
498 // platform independent versions
499 #if defined(__UNIX__) && !defined(__OS2__)
500 // CYGWIN also uses UNIX settings
501 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
502 #define wxPATH_SEP wxPATH_SEP_UNIX
503 #elif defined(__MAC__)
504 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_MAC
505 #define wxPATH_SEP wxPATH_SEP_MAC
506 #else // Windows and OS/2
507 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS
508 #define wxPATH_SEP wxPATH_SEP_DOS
509 #endif // Unix/Windows
511 // this is useful for wxString::IsSameAs(): to compare two file names use
512 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
513 #if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__)
514 #define wxARE_FILENAMES_CASE_SENSITIVE true
515 #else // Windows, Mac OS and OS/2
516 #define wxARE_FILENAMES_CASE_SENSITIVE false
517 #endif // Unix/Windows
519 // is the char a path separator?
520 inline bool wxIsPathSeparator(wxChar c
)
522 // under DOS/Windows we should understand both Unix and DOS file separators
523 #if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
524 return c
== wxFILE_SEP_PATH
;
526 return c
== wxFILE_SEP_PATH_DOS
|| c
== wxFILE_SEP_PATH_UNIX
;
530 // does the string ends with path separator?
531 WXDLLIMPEXP_BASE
bool wxEndsWithPathSeparator(const wxChar
*pszFileName
);
533 // split the full path into path (including drive for DOS), name and extension
534 // (understands both '/' and '\\')
535 WXDLLIMPEXP_BASE
void wxSplitPath(const wxChar
*pszFileName
,
540 // find a file in a list of directories, returns false if not found
541 WXDLLIMPEXP_BASE
bool wxFindFileInPath(wxString
*pStr
, const wxChar
*pszPath
, const wxChar
*pszFile
);
543 // Get the OS directory if appropriate (such as the Windows directory).
544 // On non-Windows platform, probably just return the empty string.
545 WXDLLIMPEXP_BASE wxString
wxGetOSDirectory();
547 // Get file modification time
548 WXDLLIMPEXP_BASE
time_t wxFileModificationTime(const wxString
& filename
);
550 // Parses the wildCard, returning the number of filters.
551 // Returns 0 if none or if there's a problem,
552 // The arrays will contain an equal number of items found before the error.
553 // wildCard is in the form:
554 // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
555 WXDLLIMPEXP_BASE
int wxParseCommonDialogsFilter(const wxString
& wildCard
, wxArrayString
& descriptions
, wxArrayString
& filters
);
557 // ----------------------------------------------------------------------------
559 // ----------------------------------------------------------------------------
563 // set umask to the given value in ctor and reset it to the old one in dtor
564 class WXDLLIMPEXP_BASE wxUmaskChanger
567 // change the umask to the given one if it is not -1: this allows to write
568 // the same code whether you really want to change umask or not, as is in
569 // wxFileConfig::Flush() for example
570 wxUmaskChanger(int umaskNew
)
572 m_umaskOld
= umaskNew
== -1 ? -1 : (int)umask((mode_t
)umaskNew
);
577 if ( m_umaskOld
!= -1 )
578 umask((mode_t
)m_umaskOld
);
585 // this macro expands to an "anonymous" wxUmaskChanger object under Unix and
587 #define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
591 #define wxCHANGE_UMASK(m)
593 #endif // __UNIX__/!__UNIX__
597 class WXDLLIMPEXP_BASE wxPathList
: public wxStringList
600 // avoid GCC warning about virtual functions w/o virtual dtor
601 virtual ~wxPathList() {}
603 // Adds all paths in environment variable
604 void AddEnvList(const wxString
& envVariable
);
606 void Add(const wxString
& path
);
607 // Find the first full path for which the file exists
608 wxString
FindValidPath(const wxString
& filename
);
609 // Find the first full path for which the file exists; ensure it's an
610 // absolute path that gets returned.
611 wxString
FindAbsoluteValidPath(const wxString
& filename
);
612 // Given full path and filename, add path to list
613 void EnsureFileAccessible(const wxString
& path
);
614 // Returns true if the path is in the list
615 bool Member(const wxString
& path
);
618 // DECLARE_DYNAMIC_CLASS(wxPathList)