]>
Commit | Line | Data |
---|---|---|
c801d85f KB |
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 | |
45ea509a | 9 | // Licence: wxWindows license |
c801d85f KB |
10 | ///////////////////////////////////////////////////////////////////////////// |
11 | ||
34138703 JS |
12 | #ifndef _FILEFN_H_ |
13 | #define _FILEFN_H_ | |
c801d85f KB |
14 | |
15 | #ifdef __GNUG__ | |
7af89395 | 16 | #pragma interface "filefn.h" |
c801d85f KB |
17 | #endif |
18 | ||
ed58dbea | 19 | #include "wx/list.h" |
e49f47aa | 20 | |
a47ce4a7 VS |
21 | #include <time.h> |
22 | ||
45ea509a VZ |
23 | // ---------------------------------------------------------------------------- |
24 | // constants | |
25 | // ---------------------------------------------------------------------------- | |
c801d85f | 26 | |
45ea509a | 27 | // define off_t |
03e11df5 | 28 | #if !defined(__WXMAC__) || defined(__UNIX__) |
7af89395 | 29 | #include <sys/types.h> |
17dff81c | 30 | #else |
7af89395 | 31 | typedef long off_t; |
17dff81c | 32 | #endif |
45ea509a | 33 | |
8be97d65 | 34 | #if defined(__VISUALC__) || ( defined(__MWERKS__) && defined( __INTEL__) ) |
3f4a0c5b VZ |
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; | |
8be97d65 SC |
40 | #elif defined(__MWERKS__) && !defined(__INTEL__) |
41 | typedef long off_t; | |
2432b92d JS |
42 | #endif |
43 | ||
66b6b045 DW |
44 | #if defined(__VISAGECPP__) && __IBMCPP__ >= 400 |
45 | // | |
70862fa8 | 46 | // VisualAge C++ V4.0 cannot have any external linkage const decs |
66b6b045 DW |
47 | // in headers included by more than one primary source |
48 | // | |
70862fa8 DW |
49 | extern const off_t wxInvalidOffset; |
50 | #else | |
1678ad78 | 51 | const off_t wxInvalidOffset = (off_t)-1; |
66b6b045 | 52 | #endif |
1678ad78 | 53 | |
7af89395 VZ |
54 | enum wxSeekMode |
55 | { | |
45ea509a VZ |
56 | wxFromStart, |
57 | wxFromCurrent, | |
58 | wxFromEnd | |
7af89395 | 59 | }; |
45ea509a | 60 | |
9d2f3c71 | 61 | WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString; |
cffee23b | 62 | |
f6bcfd97 BP |
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 | |
fbdb357e MB |
69 | #if defined( __VISUALC__ ) \ |
70 | || ( defined(__MINGW32__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \ | |
de85a884 | 71 | || ( defined(__MWERKS__) && defined(__WXMSW__) ) |
f6bcfd97 BP |
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 | |
6de5b599 VS |
83 | #if wxUSE_UNICODE_MSLU |
84 | WXDLLEXPORT int wxOpen(const wxChar *name, int flags, int mode); | |
85 | #else | |
86 | #define wxOpen _wopen | |
87 | #endif | |
f6bcfd97 BP |
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 | ||
45ea509a VZ |
143 | // ---------------------------------------------------------------------------- |
144 | // functions | |
145 | // ---------------------------------------------------------------------------- | |
184b5d99 | 146 | WXDLLEXPORT bool wxFileExists(const wxString& filename); |
c801d85f KB |
147 | #define FileExists wxFileExists |
148 | ||
149 | // does the path exist? (may have or not '/' or '\\' at the end) | |
9d2f3c71 | 150 | WXDLLEXPORT bool wxPathExists(const wxChar *pszPathName); |
c801d85f KB |
151 | |
152 | #define wxDirExists wxPathExists | |
153 | #define DirExists wxDirExists | |
154 | ||
184b5d99 | 155 | WXDLLEXPORT bool wxIsAbsolutePath(const wxString& filename); |
c801d85f KB |
156 | #define IsAbsolutePath wxIsAbsolutePath |
157 | ||
158 | // Get filename | |
9d2f3c71 | 159 | WXDLLEXPORT wxChar* wxFileNameFromPath(wxChar *path); |
184b5d99 | 160 | WXDLLEXPORT wxString wxFileNameFromPath(const wxString& path); |
c801d85f KB |
161 | #define FileNameFromPath wxFileNameFromPath |
162 | ||
163 | // Get directory | |
184b5d99 | 164 | WXDLLEXPORT wxString wxPathOnly(const wxString& path); |
c801d85f KB |
165 | #define PathOnly wxPathOnly |
166 | ||
167 | // wxString version | |
184b5d99 | 168 | WXDLLEXPORT wxString wxRealPath(const wxString& path); |
c801d85f | 169 | |
9d2f3c71 | 170 | WXDLLEXPORT void wxDos2UnixFilename(wxChar *s); |
c801d85f KB |
171 | #define Dos2UnixFilename wxDos2UnixFilename |
172 | ||
9d2f3c71 | 173 | WXDLLEXPORT void wxUnix2DosFilename(wxChar *s); |
c801d85f KB |
174 | #define Unix2DosFilename wxUnix2DosFilename |
175 | ||
176 | // Strip the extension, in situ | |
9d2f3c71 | 177 | WXDLLEXPORT void wxStripExtension(wxChar *buffer); |
184b5d99 | 178 | WXDLLEXPORT void wxStripExtension(wxString& buffer); |
c801d85f | 179 | |
ade35f11 | 180 | // Get a temporary filename |
9d2f3c71 | 181 | WXDLLEXPORT wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL); |
c0ab6adf | 182 | WXDLLEXPORT bool wxGetTempFileName(const wxString& prefix, wxString& buf); |
c801d85f KB |
183 | |
184 | // Expand file name (~/ and ${OPENWINHOME}/ stuff) | |
9d2f3c71 | 185 | WXDLLEXPORT wxChar* wxExpandPath(wxChar *dest, const wxChar *path); |
c0ab6adf | 186 | WXDLLEXPORT bool wxExpandPath(wxString& dest, const wxChar *path); |
c801d85f KB |
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] | |
9d2f3c71 | 191 | WXDLLEXPORT wxChar* wxContractPath(const wxString& filename, |
ade35f11 VZ |
192 | const wxString& envname = wxEmptyString, |
193 | const wxString& user = wxEmptyString); | |
c801d85f KB |
194 | |
195 | // Destructive removal of /./ and /../ stuff | |
9d2f3c71 | 196 | WXDLLEXPORT wxChar* wxRealPath(wxChar *path); |
c801d85f KB |
197 | |
198 | // Allocate a copy of the full absolute path | |
9d2f3c71 | 199 | WXDLLEXPORT wxChar* wxCopyAbsolutePath(const wxString& path); |
c801d85f KB |
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 | |
9d2f3c71 | 205 | WXDLLEXPORT wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE); |
7af89395 | 206 | WXDLLEXPORT wxString wxFindNextFile(); |
c801d85f KB |
207 | |
208 | // Does the pattern contain wildcards? | |
184b5d99 | 209 | WXDLLEXPORT bool wxIsWild(const wxString& pattern); |
c801d85f KB |
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) | |
184b5d99 | 214 | WXDLLEXPORT bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = TRUE); |
c801d85f KB |
215 | |
216 | // Concatenate two files to form third | |
184b5d99 | 217 | WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3); |
c801d85f KB |
218 | |
219 | // Copy file1 to file2 | |
4658c44e VZ |
220 | WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2, |
221 | bool overwrite = TRUE); | |
c801d85f KB |
222 | |
223 | // Remove file | |
184b5d99 | 224 | WXDLLEXPORT bool wxRemoveFile(const wxString& file); |
c801d85f KB |
225 | |
226 | // Rename file | |
184b5d99 | 227 | WXDLLEXPORT bool wxRenameFile(const wxString& file1, const wxString& file2); |
c801d85f KB |
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! | |
9d2f3c71 | 234 | WXDLLEXPORT wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000); |
7af89395 VZ |
235 | // new and preferred version of wxGetWorkingDirectory |
236 | // NB: can't have the same name because of overloading ambiguity | |
237 | WXDLLEXPORT wxString wxGetCwd(); | |
c801d85f KB |
238 | |
239 | // Set working directory | |
184b5d99 | 240 | WXDLLEXPORT bool wxSetWorkingDirectory(const wxString& d); |
c801d85f KB |
241 | |
242 | // Make directory | |
1a33c3ba | 243 | WXDLLEXPORT bool wxMkdir(const wxString& dir, int perm = 0777); |
c801d85f KB |
244 | |
245 | // Remove directory. Flags reserved for future use. | |
184b5d99 | 246 | WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0); |
c801d85f | 247 | |
ff69a290 | 248 | // ---------------------------------------------------------------------------- |
c801d85f | 249 | // separators in file names |
ff69a290 VZ |
250 | // ---------------------------------------------------------------------------- |
251 | ||
252 | // between file name and extension | |
223d09f6 | 253 | #define wxFILE_SEP_EXT wxT('.') |
ff69a290 VZ |
254 | |
255 | // between drive/volume name and the path | |
223d09f6 | 256 | #define wxFILE_SEP_DSK wxT(':') |
ff69a290 VZ |
257 | |
258 | // between the path components | |
223d09f6 KB |
259 | #define wxFILE_SEP_PATH_DOS wxT('\\') |
260 | #define wxFILE_SEP_PATH_UNIX wxT('/') | |
844f90fb | 261 | #define wxFILE_SEP_PATH_MAC wxT(':') |
ff69a290 | 262 | #define wxFILE_SEP_PATH_VMS wxT('.') // VMS also uses '[' and ']' |
c801d85f KB |
263 | |
264 | // separator in the path list (as in PATH environment variable) | |
03e11df5 GD |
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) | |
c801d85f | 267 | // NB: these are strings and not characters on purpose! |
223d09f6 KB |
268 | #define wxPATH_SEP_DOS wxT(";") |
269 | #define wxPATH_SEP_UNIX wxT(":") | |
03e11df5 | 270 | #define wxPATH_SEP_MAC wxT(";") |
c801d85f KB |
271 | |
272 | // platform independent versions | |
3369df87 | 273 | #if defined(__UNIX__) |
7af89395 VZ |
274 | #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX |
275 | #define wxPATH_SEP wxPATH_SEP_UNIX | |
844f90fb | 276 | #elif defined(__MAC__) |
bedaf53e | 277 | #define wxFILE_SEP_PATH wxFILE_SEP_PATH_MAC |
3369df87 | 278 | #define wxPATH_SEP wxPATH_SEP_MAC |
1777b9bb | 279 | #else // Windows and OS/2 |
7af89395 VZ |
280 | #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS |
281 | #define wxPATH_SEP wxPATH_SEP_DOS | |
c801d85f KB |
282 | #endif // Unix/Windows |
283 | ||
92abb45d VZ |
284 | // this is useful for wxString::IsSameAs(): to compare two file names use |
285 | // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE) | |
3369df87 | 286 | #if defined(__UNIX__) && !defined(__DARWIN__) |
92abb45d | 287 | #define wxARE_FILENAMES_CASE_SENSITIVE TRUE |
3369df87 | 288 | #else // Windows, Mac OS and OS/2 |
92abb45d VZ |
289 | #define wxARE_FILENAMES_CASE_SENSITIVE FALSE |
290 | #endif // Unix/Windows | |
291 | ||
c801d85f | 292 | // is the char a path separator? |
9d2f3c71 | 293 | inline bool wxIsPathSeparator(wxChar c) |
903b61cc VZ |
294 | { |
295 | // under DOS/Windows we should understand both Unix and DOS file separators | |
296 | #if defined(__UNIX__) || defined(__MAC__) | |
297 | return c == wxFILE_SEP_PATH; | |
298 | #else | |
299 | return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX; | |
300 | #endif | |
301 | } | |
c801d85f KB |
302 | |
303 | // does the string ends with path separator? | |
9d2f3c71 | 304 | WXDLLEXPORT bool wxEndsWithPathSeparator(const wxChar *pszFileName); |
c801d85f | 305 | |
92abb45d VZ |
306 | // split the full path into path (including drive for DOS), name and extension |
307 | // (understands both '/' and '\\') | |
9d2f3c71 | 308 | WXDLLEXPORT void wxSplitPath(const wxChar *pszFileName, |
92abb45d VZ |
309 | wxString *pstrPath, |
310 | wxString *pstrName, | |
311 | wxString *pstrExt); | |
312 | ||
c801d85f | 313 | // find a file in a list of directories, returns false if not found |
9d2f3c71 | 314 | WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile); |
c801d85f | 315 | |
631f1bfe JS |
316 | // Get the OS directory if appropriate (such as the Windows directory). |
317 | // On non-Windows platform, probably just return the empty string. | |
318 | WXDLLEXPORT wxString wxGetOSDirectory(); | |
319 | ||
a47ce4a7 VS |
320 | // Get file modification time |
321 | WXDLLEXPORT time_t wxFileModificationTime(const wxString& filename); | |
322 | ||
45ea509a VZ |
323 | // ---------------------------------------------------------------------------- |
324 | // classes | |
325 | // ---------------------------------------------------------------------------- | |
326 | ||
c801d85f | 327 | // Path searching |
a6f6393c | 328 | class WXDLLEXPORT wxPathList : public wxStringList |
c801d85f | 329 | { |
a6f6393c | 330 | public: |
7af89395 VZ |
331 | // Adds all paths in environment variable |
332 | void AddEnvList(const wxString& envVariable); | |
c330a2cf | 333 | |
a6f6393c | 334 | void Add(const wxString& path); |
c330a2cf | 335 | // Avoid compiler warning |
9d2f3c71 | 336 | wxNode *Add(const wxChar *s) { return wxStringList::Add(s); } |
7af89395 VZ |
337 | // Find the first full path for which the file exists |
338 | wxString FindValidPath(const wxString& filename); | |
339 | // Find the first full path for which the file exists; ensure it's an | |
340 | // absolute path that gets returned. | |
341 | wxString FindAbsoluteValidPath(const wxString& filename); | |
342 | // Given full path and filename, add path to list | |
343 | void EnsureFileAccessible(const wxString& path); | |
344 | // Returns TRUE if the path is in the list | |
a6f6393c VZ |
345 | bool Member(const wxString& path); |
346 | ||
347 | private: | |
348 | DECLARE_DYNAMIC_CLASS(wxPathList) | |
c801d85f KB |
349 | }; |
350 | ||
351 | #endif | |
34138703 | 352 | // _WX_FILEFN_H_ |