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__)
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 // ----------------------------------------------------------------------------
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
));
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
);
142 wxFileOffset
wxSeek(int fd
, wxFileOffset offset
, int origin
);
143 #define wxLSeek wxSeek
144 wxFileOffset
wxTell(int fd
);
146 // always Unicode under WinCE
147 #define wxMkDir _wmkdir
148 #define wxRmDir _wrmdir
149 #define wxStat _wstat
150 #define wxStructStat struct _stat
152 // Microsoft compiler loves underscores, feed them to it
153 #elif defined( __VISUALC__ ) \
154 || ( defined(__MINGW32__) && !defined(__WINE__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
155 || ( defined(__MWERKS__) && defined(__WXMSW__) ) \
156 || ( defined(__DMC__) && defined(__WXMSW__) ) \
157 || ( defined(__WATCOMC__) && defined(__WXMSW__) )
159 // detect compilers which have support for huge files (currently only
160 // Digital Mars doesn't)
162 #include "wx/msw/private.h"
165 #undef wxHAS_HUGE_FILES
166 #if defined(__MINGW32__)
167 #define wxHAS_HUGE_FILES 1
168 #elif defined(__MWERKS__)
169 #define wxHAS_HUGE_FILES 0
170 #elif defined(__DMC__)
171 #define wxHAS_HUGE_FILES 0
172 #elif ((_INTEGRAL_MAX_BITS >= 64) || defined(_LARGE_FILES))
173 #define wxHAS_HUGE_FILES 1
175 #define wxHAS_HUGE_FILES 0
179 #if defined(__BORLANDC__) || defined(__WATCOMC__)
184 typedef wxLongLong_t wxFileOffset
;
185 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
187 typedef off_t wxFileOffset
;
190 #define wxClose _close
192 #if defined(__MWERKS__)
193 #if __MSL__ >= 0x6000
194 #define wxRead(fd, buf, nCount) _read(fd, (void *)buf, nCount)
195 #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)
197 #define wxRead(fd, buf, nCount)\
198 _read(fd, (const char *)buf, nCount)
199 #define wxWrite(fd, buf, nCount)\
200 _write(fd, (const char *)buf, nCount)
203 #if defined(__DMC__) || defined(__WATCOMC__)
204 #define wxRead ::read
205 #define wxWrite ::write
208 #define wxWrite _write
212 #define wxSeek _lseeki64
213 #define wxLseek _lseeki64
214 #define wxTell _telli64
216 #define wxSeek _lseek
217 #define wxLseek _lseek
220 #define wxFsync _commit
221 #if defined(__WATCOMC__)
228 #if wxUSE_UNICODE_MSLU
229 #define wxOpen wxMSLU__wopen
231 #define wxAccess wxMSLU__waccess
232 #define wxMkDir wxMSLU__wmkdir
233 #define wxRmDir wxMSLU__wrmdir
235 #define wxStat wxMSLU__wstati64
237 #define wxStat wxMSLU__wstat
240 #define wxOpen _wopen
241 #define wxAccess _waccess
242 #define wxMkDir _wmkdir
243 #define wxRmDir _wrmdir
245 #define wxStat _wstati64
247 #define wxStat _wstat
250 #else // !wxUSE_UNICODE
256 #define wxAccess _access
257 #define wxMkDir _mkdir
259 #define wxRmDir rmdir
261 #define wxRmDir _rmdir
264 #define wxStat _stati64
270 // types: notice that Watcom is the only compiler to have a wide char
271 // version of struct stat as well as a wide char stat function variant
273 #if wxUSE_UNICODE && defined(__WATCOMC__)
274 #define wxStructStat struct _wstati64
276 #define wxStructStat struct _stati64
279 #if wxUSE_UNICODE && defined(__WATCOMC__)
280 #define wxStructStat struct _wstat
282 #define wxStructStat struct _stat
286 // constants (unless already defined by the user code)
287 #if !defined(__BORLANDC__) && !defined(__WATCOMC__) && !defined(__WXPALMOS__)
289 #define O_RDONLY _O_RDONLY
290 #define O_WRONLY _O_WRONLY
291 #define O_RDWR _O_RDWR
292 #define O_EXCL _O_EXCL
293 #define O_CREAT _O_CREAT
294 #define O_BINARY _O_BINARY
298 #define S_IFMT _S_IFMT
299 #define S_IFDIR _S_IFDIR
300 #define S_IFREG _S_IFREG
304 // It's a private define, undefine it so nobody gets tempted to use it
305 #undef wxHAS_HUGE_FILES
306 #else // Unix platforms using configure
307 typedef off_t wxFileOffset
;
309 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
310 wxCOMPILE_TIME_ASSERT( sizeof(off_t
) == sizeof(wxLongLong_t
),
313 #define wxFileOffsetFmtSpec _T("")
316 #define wxClose close
317 #define wxRead ::read
318 #define wxWrite ::write
319 #define wxLseek lseek
321 #define wxFsync commit
324 #define wxMkDir mkdir
325 #define wxRmDir rmdir
327 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
329 #define wxStructStat struct stat
332 #define wxNEED_WX_UNISTD_H
334 typedef unsigned long mode_t
;
336 WXDLLIMPEXP_BASE
int wxStat( const wxChar
*file_name
, wxStructStat
*buf
);
337 WXDLLIMPEXP_BASE
int wxAccess( const wxChar
*pathname
, int mode
);
338 WXDLLIMPEXP_BASE
int wxOpen( const wxChar
*pathname
, int flags
, mode_t mode
);
342 #define wxAccess access
346 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
348 // VisualAge C++ V4.0 cannot have any external linkage const decs
349 // in headers included by more than one primary source
351 extern const int wxInvalidOffset
;
353 const int wxInvalidOffset
= -1;
356 // ----------------------------------------------------------------------------
358 // ----------------------------------------------------------------------------
359 WXDLLIMPEXP_BASE
bool wxFileExists(const wxString
& filename
);
361 // does the path exist? (may have or not '/' or '\\' at the end)
362 WXDLLIMPEXP_BASE
bool wxPathExists(const wxChar
*pszPathName
);
364 WXDLLIMPEXP_BASE
bool wxIsAbsolutePath(const wxString
& filename
);
367 WXDLLIMPEXP_BASE wxChar
* wxFileNameFromPath(wxChar
*path
);
368 WXDLLIMPEXP_BASE wxString
wxFileNameFromPath(const wxString
& path
);
371 WXDLLIMPEXP_BASE wxString
wxPathOnly(const wxString
& path
);
374 WXDLLIMPEXP_BASE wxString
wxRealPath(const wxString
& path
);
376 WXDLLIMPEXP_BASE
void wxDos2UnixFilename(wxChar
*s
);
378 WXDLLIMPEXP_BASE
void wxUnix2DosFilename(wxChar
*s
);
380 // Strip the extension, in situ
381 WXDLLIMPEXP_BASE
void wxStripExtension(wxChar
*buffer
);
382 WXDLLIMPEXP_BASE
void wxStripExtension(wxString
& buffer
);
384 // Get a temporary filename
385 WXDLLIMPEXP_BASE wxChar
* wxGetTempFileName(const wxString
& prefix
, wxChar
*buf
= (wxChar
*) NULL
);
386 WXDLLIMPEXP_BASE
bool wxGetTempFileName(const wxString
& prefix
, wxString
& buf
);
388 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
389 WXDLLIMPEXP_BASE wxChar
* wxExpandPath(wxChar
*dest
, const wxChar
*path
);
390 WXDLLIMPEXP_BASE
bool wxExpandPath(wxString
& dest
, const wxChar
*path
);
392 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
393 // and make (if under the home tree) relative to home
394 // [caller must copy-- volatile]
395 WXDLLIMPEXP_BASE wxChar
* wxContractPath(const wxString
& filename
,
396 const wxString
& envname
= wxEmptyString
,
397 const wxString
& user
= wxEmptyString
);
399 // Destructive removal of /./ and /../ stuff
400 WXDLLIMPEXP_BASE wxChar
* wxRealPath(wxChar
*path
);
402 // Allocate a copy of the full absolute path
403 WXDLLIMPEXP_BASE wxChar
* wxCopyAbsolutePath(const wxString
& path
);
405 // Get first file name matching given wild card.
406 // Flags are reserved for future use.
409 WXDLLIMPEXP_BASE wxString
wxFindFirstFile(const wxChar
*spec
, int flags
= wxFILE
);
410 WXDLLIMPEXP_BASE wxString
wxFindNextFile();
412 // Does the pattern contain wildcards?
413 WXDLLIMPEXP_BASE
bool wxIsWild(const wxString
& pattern
);
415 // Does the pattern match the text (usually a filename)?
416 // If dot_special is true, doesn't match * against . (eliminating
417 // `hidden' dot files)
418 WXDLLIMPEXP_BASE
bool wxMatchWild(const wxString
& pattern
, const wxString
& text
, bool dot_special
= true);
420 // Concatenate two files to form third
421 WXDLLIMPEXP_BASE
bool wxConcatFiles(const wxString
& file1
, const wxString
& file2
, const wxString
& file3
);
423 // Copy file1 to file2
424 WXDLLIMPEXP_BASE
bool wxCopyFile(const wxString
& file1
, const wxString
& file2
,
425 bool overwrite
= true);
428 WXDLLIMPEXP_BASE
bool wxRemoveFile(const wxString
& file
);
431 WXDLLIMPEXP_BASE
bool wxRenameFile(const wxString
& file1
, const wxString
& file2
);
433 // Get current working directory.
434 // If buf is NULL, allocates space using new, else
436 // IMPORTANT NOTE getcwd is know not to work under some releases
437 // of Win32s 1.3, according to MS release notes!
438 WXDLLIMPEXP_BASE wxChar
* wxGetWorkingDirectory(wxChar
*buf
= (wxChar
*) NULL
, int sz
= 1000);
439 // new and preferred version of wxGetWorkingDirectory
440 // NB: can't have the same name because of overloading ambiguity
441 WXDLLIMPEXP_BASE wxString
wxGetCwd();
443 // Set working directory
444 WXDLLIMPEXP_BASE
bool wxSetWorkingDirectory(const wxString
& d
);
447 WXDLLIMPEXP_BASE
bool wxMkdir(const wxString
& dir
, int perm
= 0777);
449 // Remove directory. Flags reserved for future use.
450 WXDLLIMPEXP_BASE
bool wxRmdir(const wxString
& dir
, int flags
= 0);
452 // compatibility defines, don't use in new code
453 #define wxDirExists wxPathExists
455 // ----------------------------------------------------------------------------
456 // separators in file names
457 // ----------------------------------------------------------------------------
459 // between file name and extension
460 #define wxFILE_SEP_EXT wxT('.')
462 // between drive/volume name and the path
463 #define wxFILE_SEP_DSK wxT(':')
465 // between the path components
466 #define wxFILE_SEP_PATH_DOS wxT('\\')
467 #define wxFILE_SEP_PATH_UNIX wxT('/')
468 #define wxFILE_SEP_PATH_MAC wxT(':')
469 #define wxFILE_SEP_PATH_VMS wxT('.') // VMS also uses '[' and ']'
471 // separator in the path list (as in PATH environment variable)
472 // there is no PATH variable in Classic Mac OS so just use the
473 // semicolon (it must be different from the file name separator)
474 // NB: these are strings and not characters on purpose!
475 #define wxPATH_SEP_DOS wxT(";")
476 #define wxPATH_SEP_UNIX wxT(":")
477 #define wxPATH_SEP_MAC wxT(";")
479 // platform independent versions
480 #if defined(__UNIX__) && !defined(__OS2__)
481 // CYGWIN also uses UNIX settings
482 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
483 #define wxPATH_SEP wxPATH_SEP_UNIX
484 #elif defined(__MAC__)
485 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_MAC
486 #define wxPATH_SEP wxPATH_SEP_MAC
487 #else // Windows and OS/2
488 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS
489 #define wxPATH_SEP wxPATH_SEP_DOS
490 #endif // Unix/Windows
492 // this is useful for wxString::IsSameAs(): to compare two file names use
493 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
494 #if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__)
495 #define wxARE_FILENAMES_CASE_SENSITIVE true
496 #else // Windows, Mac OS and OS/2
497 #define wxARE_FILENAMES_CASE_SENSITIVE false
498 #endif // Unix/Windows
500 // is the char a path separator?
501 inline bool wxIsPathSeparator(wxChar c
)
503 // under DOS/Windows we should understand both Unix and DOS file separators
504 #if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
505 return c
== wxFILE_SEP_PATH
;
507 return c
== wxFILE_SEP_PATH_DOS
|| c
== wxFILE_SEP_PATH_UNIX
;
511 // does the string ends with path separator?
512 WXDLLIMPEXP_BASE
bool wxEndsWithPathSeparator(const wxChar
*pszFileName
);
514 // split the full path into path (including drive for DOS), name and extension
515 // (understands both '/' and '\\')
516 WXDLLIMPEXP_BASE
void wxSplitPath(const wxChar
*pszFileName
,
521 // find a file in a list of directories, returns false if not found
522 WXDLLIMPEXP_BASE
bool wxFindFileInPath(wxString
*pStr
, const wxChar
*pszPath
, const wxChar
*pszFile
);
524 // Get the OS directory if appropriate (such as the Windows directory).
525 // On non-Windows platform, probably just return the empty string.
526 WXDLLIMPEXP_BASE wxString
wxGetOSDirectory();
528 // Get file modification time
529 WXDLLIMPEXP_BASE
time_t wxFileModificationTime(const wxString
& filename
);
531 // Parses the wildCard, returning the number of filters.
532 // Returns 0 if none or if there's a problem,
533 // The arrays will contain an equal number of items found before the error.
534 // wildCard is in the form:
535 // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
536 WXDLLIMPEXP_BASE
int wxParseCommonDialogsFilter(const wxString
& wildCard
, wxArrayString
& descriptions
, wxArrayString
& filters
);
538 // ----------------------------------------------------------------------------
540 // ----------------------------------------------------------------------------
544 // set umask to the given value in ctor and reset it to the old one in dtor
545 class WXDLLIMPEXP_BASE wxUmaskChanger
548 // change the umask to the given one if it is not -1: this allows to write
549 // the same code whether you really want to change umask or not, as is in
550 // wxFileConfig::Flush() for example
551 wxUmaskChanger(int umaskNew
)
553 m_umaskOld
= umaskNew
== -1 ? -1 : (int)umask((mode_t
)umaskNew
);
558 if ( m_umaskOld
!= -1 )
559 umask((mode_t
)m_umaskOld
);
566 // this macro expands to an "anonymous" wxUmaskChanger object under Unix and
568 #define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
572 #define wxCHANGE_UMASK(m)
574 #endif // __UNIX__/!__UNIX__
578 class WXDLLIMPEXP_BASE wxPathList
: public wxStringList
581 // avoid GCC warning about virtual functions w/o virtual dtor
582 virtual ~wxPathList() {}
584 // Adds all paths in environment variable
585 void AddEnvList(const wxString
& envVariable
);
587 void Add(const wxString
& path
);
588 // Find the first full path for which the file exists
589 wxString
FindValidPath(const wxString
& filename
);
590 // Find the first full path for which the file exists; ensure it's an
591 // absolute path that gets returned.
592 wxString
FindAbsoluteValidPath(const wxString
& filename
);
593 // Given full path and filename, add path to list
594 void EnsureFileAccessible(const wxString
& path
);
595 // Returns true if the path is in the list
596 bool Member(const wxString
& path
);
599 // DECLARE_DYNAMIC_CLASS(wxPathList)