]> git.saurik.com Git - wxWidgets.git/blob - include/wx/filefn.h
A little different fix for how to delay the call to __wxCleanup
[wxWidgets.git] / include / wx / filefn.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: filefn.h
3 // Purpose: File- and directory-related functions
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 29/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) 1998 Julian Smart
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _FILEFN_H_
13 #define _FILEFN_H_
14
15 #ifdef __GNUG__
16 #pragma interface "filefn.h"
17 #endif
18
19 #include "wx/list.h"
20
21 #include <time.h>
22
23 // ----------------------------------------------------------------------------
24 // constants
25 // ----------------------------------------------------------------------------
26
27 // define off_t
28 #if !defined(__WXMAC__) || defined(__UNIX__)
29 #include <sys/types.h>
30 #else
31 typedef long off_t;
32 #endif
33
34 #if defined(__VISUALC__) || ( defined(__MWERKS__) && defined( __INTEL__) )
35 typedef _off_t off_t;
36 #elif defined(__BORLANDC__) && defined(__WIN16__)
37 typedef long off_t;
38 #elif defined(__SC__)
39 typedef long off_t;
40 #elif defined(__MWERKS__) && !defined(__INTEL__)
41 typedef long off_t;
42 #endif
43
44 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
45 //
46 // VisualAge C++ V4.0 cannot have any external linkage const decs
47 // in headers included by more than one primary source
48 //
49 extern const off_t wxInvalidOffset;
50 #else
51 const off_t wxInvalidOffset = (off_t)-1;
52 #endif
53
54 enum wxSeekMode
55 {
56 wxFromStart,
57 wxFromCurrent,
58 wxFromEnd
59 };
60
61 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
62
63 // ----------------------------------------------------------------------------
64 // declare our versions of low level file functions: some compilers prepend
65 // underscores to the usual names, some also have Unicode versions of them
66 // ----------------------------------------------------------------------------
67
68 // Microsoft compiler loves underscores, feed them to it
69 #if defined( __VISUALC__ ) \
70 || ( defined(__MINGW32__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
71 || ( defined(__MWERKS__) && defined(__WXMSW__) )
72 // functions
73 #define wxClose _close
74 #define wxRead _read
75 #define wxWrite _write
76 #define wxLseek _lseek
77 #define wxFsync _commit
78 #define wxEof _eof
79
80 #define wxTell _tell
81
82 #if wxUSE_UNICODE
83 #if wxUSE_UNICODE_MSLU
84 WXDLLEXPORT int wxOpen(const wxChar *name, int flags, int mode);
85 #else
86 #define wxOpen _wopen
87 #endif
88 #define wxAccess _waccess
89
90 #define wxMkDir _wmkdir
91 #define wxRmDir _wrmdir
92
93 #define wxStat _wstat
94 #else // !wxUSE_UNICODE
95 #define wxOpen _open
96 #define wxAccess _access
97
98 #define wxMkDir _mkdir
99 #define wxRmDir _rmdir
100
101 #define wxStat _stat
102 #endif
103
104 // types
105 #define wxStructStat struct _stat
106
107 // constants (unless already defined by the user code)
108 #ifndef O_RDONLY
109 #define O_RDONLY _O_RDONLY
110 #define O_WRONLY _O_WRONLY
111 #define O_RDWR _O_RDWR
112 #define O_EXCL _O_EXCL
113 #define O_CREAT _O_CREAT
114 #define O_BINARY _O_BINARY
115
116 #define S_IFMT _S_IFMT
117 #define S_IFDIR _S_IFDIR
118 #define S_IFREG _S_IFREG
119 #endif // O_RDONLY
120 #else
121 // functions
122 #define wxOpen open
123 #define wxClose close
124 #define wxRead read
125 #define wxWrite write
126 #define wxLseek lseek
127 #define wxFsync commit
128 #define wxAccess access
129 #define wxEof eof
130
131 #define wxMkDir mkdir
132 #define wxRmDir rmdir
133
134 #define wxTell(fd) lseek(fd, 0, SEEK_CUR)
135
136 #define wxStat stat
137
138 // types
139 #define wxStructStat struct stat
140
141 #endif // VC++
142
143 // ----------------------------------------------------------------------------
144 // functions
145 // ----------------------------------------------------------------------------
146 WXDLLEXPORT bool wxFileExists(const wxString& filename);
147 #define FileExists wxFileExists
148
149 // does the path exist? (may have or not '/' or '\\' at the end)
150 WXDLLEXPORT bool wxPathExists(const wxChar *pszPathName);
151
152 #define wxDirExists wxPathExists
153 #define DirExists wxDirExists
154
155 WXDLLEXPORT bool wxIsAbsolutePath(const wxString& filename);
156 #define IsAbsolutePath wxIsAbsolutePath
157
158 // Get filename
159 WXDLLEXPORT wxChar* wxFileNameFromPath(wxChar *path);
160 WXDLLEXPORT wxString wxFileNameFromPath(const wxString& path);
161 #define FileNameFromPath wxFileNameFromPath
162
163 // Get directory
164 WXDLLEXPORT wxString wxPathOnly(const wxString& path);
165 #define PathOnly wxPathOnly
166
167 // wxString version
168 WXDLLEXPORT wxString wxRealPath(const wxString& path);
169
170 WXDLLEXPORT void wxDos2UnixFilename(wxChar *s);
171 #define Dos2UnixFilename wxDos2UnixFilename
172
173 WXDLLEXPORT void wxUnix2DosFilename(wxChar *s);
174 #define Unix2DosFilename wxUnix2DosFilename
175
176 // Strip the extension, in situ
177 WXDLLEXPORT void wxStripExtension(wxChar *buffer);
178 WXDLLEXPORT void wxStripExtension(wxString& buffer);
179
180 // Get a temporary filename
181 WXDLLEXPORT wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
182 WXDLLEXPORT bool wxGetTempFileName(const wxString& prefix, wxString& buf);
183
184 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
185 WXDLLEXPORT wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
186 WXDLLEXPORT bool wxExpandPath(wxString& dest, const wxChar *path);
187
188 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
189 // and make (if under the home tree) relative to home
190 // [caller must copy-- volatile]
191 WXDLLEXPORT wxChar* wxContractPath(const wxString& filename,
192 const wxString& envname = wxEmptyString,
193 const wxString& user = wxEmptyString);
194
195 // Destructive removal of /./ and /../ stuff
196 WXDLLEXPORT wxChar* wxRealPath(wxChar *path);
197
198 // Allocate a copy of the full absolute path
199 WXDLLEXPORT wxChar* wxCopyAbsolutePath(const wxString& path);
200
201 // Get first file name matching given wild card.
202 // Flags are reserved for future use.
203 #define wxFILE 1
204 #define wxDIR 2
205 WXDLLEXPORT wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
206 WXDLLEXPORT wxString wxFindNextFile();
207
208 // Does the pattern contain wildcards?
209 WXDLLEXPORT bool wxIsWild(const wxString& pattern);
210
211 // Does the pattern match the text (usually a filename)?
212 // If dot_special is TRUE, doesn't match * against . (eliminating
213 // `hidden' dot files)
214 WXDLLEXPORT bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = TRUE);
215
216 // Concatenate two files to form third
217 WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
218
219 // Copy file1 to file2
220 WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2,
221 bool overwrite = TRUE);
222
223 // Remove file
224 WXDLLEXPORT bool wxRemoveFile(const wxString& file);
225
226 // Rename file
227 WXDLLEXPORT bool wxRenameFile(const wxString& file1, const wxString& file2);
228
229 // Get current working directory.
230 // If buf is NULL, allocates space using new, else
231 // copies into buf.
232 // IMPORTANT NOTE getcwd is know not to work under some releases
233 // of Win32s 1.3, according to MS release notes!
234 WXDLLEXPORT wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000);
235 // new and preferred version of wxGetWorkingDirectory
236 // NB: can't have the same name because of overloading ambiguity
237 WXDLLEXPORT wxString wxGetCwd();
238
239 // Set working directory
240 WXDLLEXPORT bool wxSetWorkingDirectory(const wxString& d);
241
242 // Make directory
243 WXDLLEXPORT bool wxMkdir(const wxString& dir, int perm = 0777);
244
245 // Remove directory. Flags reserved for future use.
246 WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0);
247
248 // ----------------------------------------------------------------------------
249 // separators in file names
250 // ----------------------------------------------------------------------------
251
252 // between file name and extension
253 #define wxFILE_SEP_EXT wxT('.')
254
255 // between drive/volume name and the path
256 #define wxFILE_SEP_DSK wxT(':')
257
258 // between the path components
259 #define wxFILE_SEP_PATH_DOS wxT('\\')
260 #define wxFILE_SEP_PATH_UNIX wxT('/')
261 #define wxFILE_SEP_PATH_MAC wxT(':')
262 #define wxFILE_SEP_PATH_VMS wxT('.') // VMS also uses '[' and ']'
263
264 // separator in the path list (as in PATH environment variable)
265 // there is no PATH variable in Classic Mac OS so just use the
266 // semicolon (it must be different from the file name separator)
267 // NB: these are strings and not characters on purpose!
268 #define wxPATH_SEP_DOS wxT(";")
269 #define wxPATH_SEP_UNIX wxT(":")
270 #define wxPATH_SEP_MAC wxT(";")
271
272 // platform independent versions
273 #if defined(__UNIX__) && !defined(__CYGWIN__)
274 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
275 #define wxPATH_SEP wxPATH_SEP_UNIX
276 #elif defined(__MAC__)
277 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_MAC
278 #define wxPATH_SEP wxPATH_SEP_MAC
279 #elif defined(__CYGWIN__) // Cygwin
280 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS
281 #define wxPATH_SEP wxPATH_SEP_UNIX
282 #else // Windows and OS/2
283 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS
284 #define wxPATH_SEP wxPATH_SEP_DOS
285 #endif // Unix/Windows
286
287 // this is useful for wxString::IsSameAs(): to compare two file names use
288 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
289 #if defined(__UNIX__) && !defined(__DARWIN__)
290 #define wxARE_FILENAMES_CASE_SENSITIVE TRUE
291 #else // Windows, Mac OS and OS/2
292 #define wxARE_FILENAMES_CASE_SENSITIVE FALSE
293 #endif // Unix/Windows
294
295 // is the char a path separator?
296 inline bool wxIsPathSeparator(wxChar c)
297 {
298 // under DOS/Windows we should understand both Unix and DOS file separators
299 #if defined(__UNIX__) || defined(__MAC__)
300 return c == wxFILE_SEP_PATH;
301 #else
302 return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX;
303 #endif
304 }
305
306 // does the string ends with path separator?
307 WXDLLEXPORT bool wxEndsWithPathSeparator(const wxChar *pszFileName);
308
309 // split the full path into path (including drive for DOS), name and extension
310 // (understands both '/' and '\\')
311 WXDLLEXPORT void wxSplitPath(const wxChar *pszFileName,
312 wxString *pstrPath,
313 wxString *pstrName,
314 wxString *pstrExt);
315
316 // find a file in a list of directories, returns false if not found
317 WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile);
318
319 // Get the OS directory if appropriate (such as the Windows directory).
320 // On non-Windows platform, probably just return the empty string.
321 WXDLLEXPORT wxString wxGetOSDirectory();
322
323 // Get file modification time
324 WXDLLEXPORT time_t wxFileModificationTime(const wxString& filename);
325
326 // ----------------------------------------------------------------------------
327 // classes
328 // ----------------------------------------------------------------------------
329
330 // Path searching
331 class WXDLLEXPORT wxPathList : public wxStringList
332 {
333 public:
334 // Adds all paths in environment variable
335 void AddEnvList(const wxString& envVariable);
336
337 void Add(const wxString& path);
338 // Avoid compiler warning
339 wxNode *Add(const wxChar *s) { return wxStringList::Add(s); }
340 // Find the first full path for which the file exists
341 wxString FindValidPath(const wxString& filename);
342 // Find the first full path for which the file exists; ensure it's an
343 // absolute path that gets returned.
344 wxString FindAbsoluteValidPath(const wxString& filename);
345 // Given full path and filename, add path to list
346 void EnsureFileAccessible(const wxString& path);
347 // Returns TRUE if the path is in the list
348 bool Member(const wxString& path);
349
350 private:
351 DECLARE_DYNAMIC_CLASS(wxPathList)
352 };
353
354 #endif
355 // _WX_FILEFN_H_