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 inline HANDLE
wxGetOSFHandle(int fd
) { return (HANDLE
)fd
; }
152 #define wxLSeek wxSeek
153 wxFileOffset
wxTell(int fd
);
155 // always Unicode under WinCE
156 #define wxMkDir _wmkdir
157 #define wxRmDir _wrmdir
158 #define wxStat _wstat
159 #define wxStructStat struct _stat
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__) )
168 // detect compilers which have support for huge files (currently only
169 // Digital Mars doesn't)
171 #include "wx/msw/private.h"
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
184 #define wxHAS_HUGE_FILES 0
188 #if defined(__BORLANDC__) || defined(__WATCOMC__)
193 typedef wxLongLong_t wxFileOffset
;
194 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
196 typedef off_t wxFileOffset
;
199 #define wxClose _close
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)
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)
212 #if defined(__DMC__) || defined(__WATCOMC__)
213 #define wxRead ::read
214 #define wxWrite ::write
217 #define wxWrite _write
221 #define wxSeek _lseeki64
222 #define wxLseek _lseeki64
223 #define wxTell _telli64
225 #define wxSeek _lseek
226 #define wxLseek _lseek
229 #define wxFsync _commit
230 #if defined(__WATCOMC__)
237 #if wxUSE_UNICODE_MSLU
238 #define wxOpen wxMSLU__wopen
240 #define wxAccess wxMSLU__waccess
241 #define wxMkDir wxMSLU__wmkdir
242 #define wxRmDir wxMSLU__wrmdir
244 #define wxStat wxMSLU__wstati64
246 #define wxStat wxMSLU__wstat
249 #define wxOpen _wopen
250 #define wxAccess _waccess
251 #define wxMkDir _wmkdir
252 #define wxRmDir _wrmdir
254 #define wxStat _wstati64
256 #define wxStat _wstat
259 #else // !wxUSE_UNICODE
265 #define wxAccess _access
266 #define wxMkDir _mkdir
268 #define wxRmDir rmdir
270 #define wxRmDir _rmdir
273 #define wxStat _stati64
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
282 #if wxUSE_UNICODE && defined(__WATCOMC__)
283 #define wxStructStat struct _wstati64
285 #define wxStructStat struct _stati64
288 #if wxUSE_UNICODE && defined(__WATCOMC__)
289 #define wxStructStat struct _wstat
291 #define wxStructStat struct _stat
295 // constants (unless already defined by the user code)
296 #if !defined(__BORLANDC__) && !defined(__WATCOMC__) && !defined(__WXPALMOS__)
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
307 #define S_IFMT _S_IFMT
308 #define S_IFDIR _S_IFDIR
309 #define S_IFREG _S_IFREG
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
;
318 #define wxFileOffsetFmtSpec wxLongLongFmtSpec
319 wxCOMPILE_TIME_ASSERT( sizeof(off_t
) == sizeof(wxLongLong_t
),
322 #define wxFileOffsetFmtSpec _T("")
325 #define wxClose close
326 #define wxRead ::read
327 #define wxWrite ::write
328 #define wxLseek lseek
330 #define wxFsync commit
333 #define wxMkDir mkdir
334 #define wxRmDir rmdir
336 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
338 #define wxStructStat struct stat
341 #define wxNEED_WX_UNISTD_H
343 typedef unsigned long mode_t
;
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
);
351 #define wxAccess access
355 #if defined(__WXMSW__) && !defined(__WXWINCE__)
356 // get the HANDLE associated with a file descriptor
358 # include "wx/msw/private.h" // for HANDLE
359 # include <io.h> // for get_osfhandle()
360 inline HANDLE
wxGetOSFHandle(int fd
) { return (HANDLE
) get_osfhandle(fd
); }
363 # include "wx/msw/private.h" // for HANDLE
365 inline HANDLE
wxGetOSFHandle(int fd
) { return (HANDLE
) _get_osfhandle(fd
); }
369 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
371 // VisualAge C++ V4.0 cannot have any external linkage const decs
372 // in headers included by more than one primary source
374 extern const int wxInvalidOffset
;
376 const int wxInvalidOffset
= -1;
379 // ----------------------------------------------------------------------------
381 // ----------------------------------------------------------------------------
382 WXDLLIMPEXP_BASE
bool wxFileExists(const wxString
& filename
);
384 // does the path exist? (may have or not '/' or '\\' at the end)
385 WXDLLIMPEXP_BASE
bool wxPathExists(const wxChar
*pszPathName
);
387 WXDLLIMPEXP_BASE
bool wxIsAbsolutePath(const wxString
& filename
);
390 WXDLLIMPEXP_BASE wxChar
* wxFileNameFromPath(wxChar
*path
);
391 WXDLLIMPEXP_BASE wxString
wxFileNameFromPath(const wxString
& path
);
394 WXDLLIMPEXP_BASE wxString
wxPathOnly(const wxString
& path
);
397 WXDLLIMPEXP_BASE wxString
wxRealPath(const wxString
& path
);
399 WXDLLIMPEXP_BASE
void wxDos2UnixFilename(wxChar
*s
);
401 WXDLLIMPEXP_BASE
void wxUnix2DosFilename(wxChar
*s
);
403 // Strip the extension, in situ
404 WXDLLIMPEXP_BASE
void wxStripExtension(wxChar
*buffer
);
405 WXDLLIMPEXP_BASE
void wxStripExtension(wxString
& buffer
);
407 // Get a temporary filename
408 WXDLLIMPEXP_BASE wxChar
* wxGetTempFileName(const wxString
& prefix
, wxChar
*buf
= (wxChar
*) NULL
);
409 WXDLLIMPEXP_BASE
bool wxGetTempFileName(const wxString
& prefix
, wxString
& buf
);
411 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
412 WXDLLIMPEXP_BASE wxChar
* wxExpandPath(wxChar
*dest
, const wxChar
*path
);
413 WXDLLIMPEXP_BASE
bool wxExpandPath(wxString
& dest
, const wxChar
*path
);
415 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
416 // and make (if under the home tree) relative to home
417 // [caller must copy-- volatile]
418 WXDLLIMPEXP_BASE wxChar
* wxContractPath(const wxString
& filename
,
419 const wxString
& envname
= wxEmptyString
,
420 const wxString
& user
= wxEmptyString
);
422 // Destructive removal of /./ and /../ stuff
423 WXDLLIMPEXP_BASE wxChar
* wxRealPath(wxChar
*path
);
425 // Allocate a copy of the full absolute path
426 WXDLLIMPEXP_BASE wxChar
* wxCopyAbsolutePath(const wxString
& path
);
428 // Get first file name matching given wild card.
429 // Flags are reserved for future use.
432 WXDLLIMPEXP_BASE wxString
wxFindFirstFile(const wxChar
*spec
, int flags
= wxFILE
);
433 WXDLLIMPEXP_BASE wxString
wxFindNextFile();
435 // Does the pattern contain wildcards?
436 WXDLLIMPEXP_BASE
bool wxIsWild(const wxString
& pattern
);
438 // Does the pattern match the text (usually a filename)?
439 // If dot_special is true, doesn't match * against . (eliminating
440 // `hidden' dot files)
441 WXDLLIMPEXP_BASE
bool wxMatchWild(const wxString
& pattern
, const wxString
& text
, bool dot_special
= true);
443 // Concatenate two files to form third
444 WXDLLIMPEXP_BASE
bool wxConcatFiles(const wxString
& file1
, const wxString
& file2
, const wxString
& file3
);
446 // Copy file1 to file2
447 WXDLLIMPEXP_BASE
bool wxCopyFile(const wxString
& file1
, const wxString
& file2
,
448 bool overwrite
= true);
451 WXDLLIMPEXP_BASE
bool wxRemoveFile(const wxString
& file
);
454 WXDLLIMPEXP_BASE
bool wxRenameFile(const wxString
& file1
, const wxString
& file2
);
456 // Get current working directory.
457 // If buf is NULL, allocates space using new, else
459 // IMPORTANT NOTE getcwd is know not to work under some releases
460 // of Win32s 1.3, according to MS release notes!
461 WXDLLIMPEXP_BASE wxChar
* wxGetWorkingDirectory(wxChar
*buf
= (wxChar
*) NULL
, int sz
= 1000);
462 // new and preferred version of wxGetWorkingDirectory
463 // NB: can't have the same name because of overloading ambiguity
464 WXDLLIMPEXP_BASE wxString
wxGetCwd();
466 // Set working directory
467 WXDLLIMPEXP_BASE
bool wxSetWorkingDirectory(const wxString
& d
);
470 WXDLLIMPEXP_BASE
bool wxMkdir(const wxString
& dir
, int perm
= 0777);
472 // Remove directory. Flags reserved for future use.
473 WXDLLIMPEXP_BASE
bool wxRmdir(const wxString
& dir
, int flags
= 0);
475 // Return the type of an open file
476 WXDLLIMPEXP_BASE wxFileKind
wxGetFileKind(int fd
);
477 inline wxFileKind
wxGetFileKind (FILE *fp
) { return wxGetFileKind(fileno(fp
)); }
479 // compatibility defines, don't use in new code
480 #define wxDirExists wxPathExists
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();
555 // Get file modification time
556 WXDLLIMPEXP_BASE
time_t wxFileModificationTime(const wxString
& filename
);
558 // Parses the wildCard, returning the number of filters.
559 // Returns 0 if none or if there's a problem,
560 // The arrays will contain an equal number of items found before the error.
561 // wildCard is in the form:
562 // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
563 WXDLLIMPEXP_BASE
int wxParseCommonDialogsFilter(const wxString
& wildCard
, wxArrayString
& descriptions
, wxArrayString
& filters
);
565 // ----------------------------------------------------------------------------
567 // ----------------------------------------------------------------------------
571 // set umask to the given value in ctor and reset it to the old one in dtor
572 class WXDLLIMPEXP_BASE wxUmaskChanger
575 // change the umask to the given one if it is not -1: this allows to write
576 // the same code whether you really want to change umask or not, as is in
577 // wxFileConfig::Flush() for example
578 wxUmaskChanger(int umaskNew
)
580 m_umaskOld
= umaskNew
== -1 ? -1 : (int)umask((mode_t
)umaskNew
);
585 if ( m_umaskOld
!= -1 )
586 umask((mode_t
)m_umaskOld
);
593 // this macro expands to an "anonymous" wxUmaskChanger object under Unix and
595 #define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
599 #define wxCHANGE_UMASK(m)
601 #endif // __UNIX__/!__UNIX__
605 class WXDLLIMPEXP_BASE wxPathList
: public wxStringList
608 // avoid GCC warning about virtual functions w/o virtual dtor
609 virtual ~wxPathList() {}
611 // Adds all paths in environment variable
612 void AddEnvList(const wxString
& envVariable
);
614 void Add(const wxString
& path
);
615 // Find the first full path for which the file exists
616 wxString
FindValidPath(const wxString
& filename
);
617 // Find the first full path for which the file exists; ensure it's an
618 // absolute path that gets returned.
619 wxString
FindAbsoluteValidPath(const wxString
& filename
);
620 // Given full path and filename, add path to list
621 void EnsureFileAccessible(const wxString
& path
);
622 // Returns true if the path is in the list
623 bool Member(const wxString
& path
);
626 // DECLARE_DYNAMIC_CLASS(wxPathList)