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(__APPLE__)
16 #pragma interface "filefn.h"
25 // ----------------------------------------------------------------------------
27 // ----------------------------------------------------------------------------
34 #if !defined(__WXMAC__) || defined(__UNIX__) || defined(__MACH__)
35 #include <sys/types.h>
40 #if defined(__VISUALC__) || ( defined(__MWERKS__) && defined( __INTEL__) )
42 #elif defined(__BORLANDC__) && defined(__WIN16__)
44 #elif defined(__SYMANTEC__)
46 #elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__)
52 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
54 // VisualAge C++ V4.0 cannot have any external linkage const decs
55 // in headers included by more than one primary source
57 extern const off_t wxInvalidOffset
;
59 const off_t wxInvalidOffset
= (off_t
)-1;
69 // ----------------------------------------------------------------------------
70 // declare our versions of low level file functions: some compilers prepend
71 // underscores to the usual names, some also have Unicode versions of them
72 // ----------------------------------------------------------------------------
74 // Microsoft compiler loves underscores, feed them to it
75 #if defined( __VISUALC__ ) \
76 || ( defined(__MINGW32__) && !defined(__WINE__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
77 || ( defined(__MWERKS__) && defined(__WXMSW__) )
82 #define wxClose _close
84 #define wxWrite _write
85 #define wxLseek _lseek
86 #define wxFsync _commit
92 #if wxUSE_UNICODE_MSLU
93 #define wxOpen wxMSLU__wopen
95 #define wxAccess wxMSLU__waccess
96 #define wxMkDir wxMSLU__wmkdir
97 #define wxRmDir wxMSLU__wrmdir
98 #define wxStat wxMSLU__wstat
100 #define wxOpen _wopen
101 #define wxAccess _waccess
102 #define wxMkDir _wmkdir
103 #define wxRmDir _wrmdir
104 #define wxStat _wstat
106 #else // !wxUSE_UNICODE
112 #define wxAccess _access
113 #define wxMkDir _mkdir
114 #define wxRmDir _rmdir
119 #define wxStructStat struct _stat
121 // constants (unless already defined by the user code)
122 #if !defined(O_RDONLY) && !defined(__BORLANDC__)
123 #define O_RDONLY _O_RDONLY
124 #define O_WRONLY _O_WRONLY
125 #define O_RDWR _O_RDWR
126 #define O_EXCL _O_EXCL
127 #define O_CREAT _O_CREAT
128 #define O_BINARY _O_BINARY
132 #define S_IFMT _S_IFMT
133 #define S_IFDIR _S_IFDIR
134 #define S_IFREG _S_IFREG
138 #define wxClose close
140 #define wxWrite write
141 #define wxLseek lseek
142 #define wxFsync commit
145 #define wxMkDir mkdir
146 #define wxRmDir rmdir
148 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
150 #define wxStructStat struct stat
153 # define wxNEED_WX_UNISTD_H
154 #if defined(__MWERKS__) && defined(macintosh)
155 #include <sys/stat.h>
157 WXDLLEXPORT_BASE
int wxStat( const wxChar
*file_name
, wxStructStat
*buf
);
158 WXDLLEXPORT_BASE
int wxAccess( const wxChar
*pathname
, int mode
);
159 WXDLLEXPORT_BASE
int wxOpen( const wxChar
*pathname
, int flags
, mode_t mode
);
163 #define wxAccess access
168 // ----------------------------------------------------------------------------
170 // ----------------------------------------------------------------------------
171 WXDLLEXPORT_BASE
bool wxFileExists(const wxString
& filename
);
173 // does the path exist? (may have or not '/' or '\\' at the end)
174 WXDLLEXPORT_BASE
bool wxPathExists(const wxChar
*pszPathName
);
176 WXDLLEXPORT_BASE
bool wxIsAbsolutePath(const wxString
& filename
);
179 WXDLLEXPORT_BASE wxChar
* wxFileNameFromPath(wxChar
*path
);
180 WXDLLEXPORT_BASE wxString
wxFileNameFromPath(const wxString
& path
);
183 WXDLLEXPORT_BASE wxString
wxPathOnly(const wxString
& path
);
186 WXDLLEXPORT_BASE wxString
wxRealPath(const wxString
& path
);
188 WXDLLEXPORT_BASE
void wxDos2UnixFilename(wxChar
*s
);
190 WXDLLEXPORT_BASE
void wxUnix2DosFilename(wxChar
*s
);
192 // Strip the extension, in situ
193 WXDLLEXPORT_BASE
void wxStripExtension(wxChar
*buffer
);
194 WXDLLEXPORT_BASE
void wxStripExtension(wxString
& buffer
);
196 // Get a temporary filename
197 WXDLLEXPORT_BASE wxChar
* wxGetTempFileName(const wxString
& prefix
, wxChar
*buf
= (wxChar
*) NULL
);
198 WXDLLEXPORT_BASE
bool wxGetTempFileName(const wxString
& prefix
, wxString
& buf
);
200 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
201 WXDLLEXPORT_BASE wxChar
* wxExpandPath(wxChar
*dest
, const wxChar
*path
);
202 WXDLLEXPORT_BASE
bool wxExpandPath(wxString
& dest
, const wxChar
*path
);
204 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
205 // and make (if under the home tree) relative to home
206 // [caller must copy-- volatile]
207 WXDLLEXPORT_BASE wxChar
* wxContractPath(const wxString
& filename
,
208 const wxString
& envname
= wxEmptyString
,
209 const wxString
& user
= wxEmptyString
);
211 // Destructive removal of /./ and /../ stuff
212 WXDLLEXPORT_BASE wxChar
* wxRealPath(wxChar
*path
);
214 // Allocate a copy of the full absolute path
215 WXDLLEXPORT_BASE wxChar
* wxCopyAbsolutePath(const wxString
& path
);
217 // Get first file name matching given wild card.
218 // Flags are reserved for future use.
221 WXDLLEXPORT_BASE wxString
wxFindFirstFile(const wxChar
*spec
, int flags
= wxFILE
);
222 WXDLLEXPORT_BASE wxString
wxFindNextFile();
224 // Does the pattern contain wildcards?
225 WXDLLEXPORT_BASE
bool wxIsWild(const wxString
& pattern
);
227 // Does the pattern match the text (usually a filename)?
228 // If dot_special is TRUE, doesn't match * against . (eliminating
229 // `hidden' dot files)
230 WXDLLEXPORT_BASE
bool wxMatchWild(const wxString
& pattern
, const wxString
& text
, bool dot_special
= TRUE
);
232 // Concatenate two files to form third
233 WXDLLEXPORT_BASE
bool wxConcatFiles(const wxString
& file1
, const wxString
& file2
, const wxString
& file3
);
235 // Copy file1 to file2
236 WXDLLEXPORT_BASE
bool wxCopyFile(const wxString
& file1
, const wxString
& file2
,
237 bool overwrite
= TRUE
);
240 WXDLLEXPORT_BASE
bool wxRemoveFile(const wxString
& file
);
243 WXDLLEXPORT_BASE
bool wxRenameFile(const wxString
& file1
, const wxString
& file2
);
245 // Get current working directory.
246 // If buf is NULL, allocates space using new, else
248 // IMPORTANT NOTE getcwd is know not to work under some releases
249 // of Win32s 1.3, according to MS release notes!
250 WXDLLEXPORT_BASE wxChar
* wxGetWorkingDirectory(wxChar
*buf
= (wxChar
*) NULL
, int sz
= 1000);
251 // new and preferred version of wxGetWorkingDirectory
252 // NB: can't have the same name because of overloading ambiguity
253 WXDLLEXPORT_BASE wxString
wxGetCwd();
255 // Set working directory
256 WXDLLEXPORT_BASE
bool wxSetWorkingDirectory(const wxString
& d
);
259 WXDLLEXPORT_BASE
bool wxMkdir(const wxString
& dir
, int perm
= 0777);
261 // Remove directory. Flags reserved for future use.
262 WXDLLEXPORT_BASE
bool wxRmdir(const wxString
& dir
, int flags
= 0);
264 // compatibility defines, don't use in new code
265 #define wxDirExists wxPathExists
267 #if WXWIN_COMPATIBILITY_2
268 #define FileExists wxFileExists
269 #define DirExists wxDirExists
270 #define IsAbsolutePath wxIsAbsolutePath
271 #define FileNameFromPath wxFileNameFromPath
272 #define PathOnly wxPathOnly
273 #define Dos2UnixFilename wxDos2UnixFilename
274 #define Unix2DosFilename wxUnix2DosFilename
277 // ----------------------------------------------------------------------------
278 // separators in file names
279 // ----------------------------------------------------------------------------
281 // between file name and extension
282 #define wxFILE_SEP_EXT wxT('.')
284 // between drive/volume name and the path
285 #define wxFILE_SEP_DSK wxT(':')
287 // between the path components
288 #define wxFILE_SEP_PATH_DOS wxT('\\')
289 #define wxFILE_SEP_PATH_UNIX wxT('/')
290 #define wxFILE_SEP_PATH_MAC wxT(':')
291 #define wxFILE_SEP_PATH_VMS wxT('.') // VMS also uses '[' and ']'
293 // separator in the path list (as in PATH environment variable)
294 // there is no PATH variable in Classic Mac OS so just use the
295 // semicolon (it must be different from the file name separator)
296 // NB: these are strings and not characters on purpose!
297 #define wxPATH_SEP_DOS wxT(";")
298 #define wxPATH_SEP_UNIX wxT(":")
299 #define wxPATH_SEP_MAC wxT(";")
301 // platform independent versions
302 #if defined(__UNIX__) && !defined(__CYGWIN__)
303 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
304 #define wxPATH_SEP wxPATH_SEP_UNIX
305 #elif defined(__MAC__)
306 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_MAC
307 #define wxPATH_SEP wxPATH_SEP_MAC
308 #elif defined(__CYGWIN__) // Cygwin
309 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS
310 #define wxPATH_SEP wxPATH_SEP_UNIX
311 #else // Windows and OS/2
312 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS
313 #define wxPATH_SEP wxPATH_SEP_DOS
314 #endif // Unix/Windows
316 // this is useful for wxString::IsSameAs(): to compare two file names use
317 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
318 #if defined(__UNIX__) && !defined(__DARWIN__)
319 #define wxARE_FILENAMES_CASE_SENSITIVE TRUE
320 #else // Windows, Mac OS and OS/2
321 #define wxARE_FILENAMES_CASE_SENSITIVE FALSE
322 #endif // Unix/Windows
324 // is the char a path separator?
325 inline bool wxIsPathSeparator(wxChar c
)
327 // under DOS/Windows we should understand both Unix and DOS file separators
328 #if defined(__UNIX__) || defined(__MAC__)
329 return c
== wxFILE_SEP_PATH
;
331 return c
== wxFILE_SEP_PATH_DOS
|| c
== wxFILE_SEP_PATH_UNIX
;
335 // does the string ends with path separator?
336 WXDLLEXPORT_BASE
bool wxEndsWithPathSeparator(const wxChar
*pszFileName
);
338 // split the full path into path (including drive for DOS), name and extension
339 // (understands both '/' and '\\')
340 WXDLLEXPORT_BASE
void wxSplitPath(const wxChar
*pszFileName
,
345 // find a file in a list of directories, returns false if not found
346 WXDLLEXPORT_BASE
bool wxFindFileInPath(wxString
*pStr
, const wxChar
*pszPath
, const wxChar
*pszFile
);
348 // Get the OS directory if appropriate (such as the Windows directory).
349 // On non-Windows platform, probably just return the empty string.
350 WXDLLEXPORT_BASE wxString
wxGetOSDirectory();
352 // Get file modification time
353 WXDLLEXPORT_BASE
time_t wxFileModificationTime(const wxString
& filename
);
355 // ----------------------------------------------------------------------------
357 // ----------------------------------------------------------------------------
360 class WXDLLEXPORT_BASE wxPathList
: public wxStringList
363 // Adds all paths in environment variable
364 void AddEnvList(const wxString
& envVariable
);
366 void Add(const wxString
& path
);
367 // Avoid compiler warning
368 wxNode
*Add(const wxChar
*s
) { return wxStringList::Add(s
); }
369 // Find the first full path for which the file exists
370 wxString
FindValidPath(const wxString
& filename
);
371 // Find the first full path for which the file exists; ensure it's an
372 // absolute path that gets returned.
373 wxString
FindAbsoluteValidPath(const wxString
& filename
);
374 // Given full path and filename, add path to list
375 void EnsureFileAccessible(const wxString
& path
);
376 // Returns TRUE if the path is in the list
377 bool Member(const wxString
& path
);
380 DECLARE_DYNAMIC_CLASS(wxPathList
)