]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/filefn.h
compilation fix for recent commit
[wxWidgets.git] / include / wx / filefn.h
... / ...
CommitLineData
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//
49extern const off_t wxInvalidOffset;
50#else
51const off_t wxInvalidOffset = (off_t)-1;
52#endif
53
54enum wxSeekMode
55{
56 wxFromStart,
57 wxFromCurrent,
58 wxFromEnd
59};
60
61WXDLLEXPORT_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// ----------------------------------------------------------------------------
146WXDLLEXPORT bool wxFileExists(const wxString& filename);
147#define FileExists wxFileExists
148
149// does the path exist? (may have or not '/' or '\\' at the end)
150WXDLLEXPORT bool wxPathExists(const wxChar *pszPathName);
151
152#define wxDirExists wxPathExists
153#define DirExists wxDirExists
154
155WXDLLEXPORT bool wxIsAbsolutePath(const wxString& filename);
156#define IsAbsolutePath wxIsAbsolutePath
157
158// Get filename
159WXDLLEXPORT wxChar* wxFileNameFromPath(wxChar *path);
160WXDLLEXPORT wxString wxFileNameFromPath(const wxString& path);
161#define FileNameFromPath wxFileNameFromPath
162
163// Get directory
164WXDLLEXPORT wxString wxPathOnly(const wxString& path);
165#define PathOnly wxPathOnly
166
167// wxString version
168WXDLLEXPORT wxString wxRealPath(const wxString& path);
169
170WXDLLEXPORT void wxDos2UnixFilename(wxChar *s);
171#define Dos2UnixFilename wxDos2UnixFilename
172
173WXDLLEXPORT void wxUnix2DosFilename(wxChar *s);
174#define Unix2DosFilename wxUnix2DosFilename
175
176#ifdef __WXMAC__
177WXDLLEXPORT wxString wxMacFSSpec2MacFilename( const FSSpec *spec ) ;
178WXDLLEXPORT void wxMacFilename2FSSpec( const char *path , FSSpec *spec ) ;
179# ifndef __DARWIN__
180// Mac file names are POSIX (Unix style) under Darwin, so these are not needed
181WXDLLEXPORT wxString wxMacFSSpec2UnixFilename( const FSSpec *spec ) ;
182WXDLLEXPORT void wxUnixFilename2FSSpec( const char *path , FSSpec *spec ) ;
183WXDLLEXPORT wxString wxMac2UnixFilename( const char *s) ;
184WXDLLEXPORT wxString wxUnix2MacFilename( const char *s);
185# endif
186#endif
187
188// Strip the extension, in situ
189WXDLLEXPORT void wxStripExtension(wxChar *buffer);
190WXDLLEXPORT void wxStripExtension(wxString& buffer);
191
192// Get a temporary filename
193WXDLLEXPORT wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
194WXDLLEXPORT bool wxGetTempFileName(const wxString& prefix, wxString& buf);
195
196// Expand file name (~/ and ${OPENWINHOME}/ stuff)
197WXDLLEXPORT wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
198WXDLLEXPORT bool wxExpandPath(wxString& dest, const wxChar *path);
199
200// Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
201// and make (if under the home tree) relative to home
202// [caller must copy-- volatile]
203WXDLLEXPORT wxChar* wxContractPath(const wxString& filename,
204 const wxString& envname = wxEmptyString,
205 const wxString& user = wxEmptyString);
206
207// Destructive removal of /./ and /../ stuff
208WXDLLEXPORT wxChar* wxRealPath(wxChar *path);
209
210// Allocate a copy of the full absolute path
211WXDLLEXPORT wxChar* wxCopyAbsolutePath(const wxString& path);
212
213// Get first file name matching given wild card.
214// Flags are reserved for future use.
215#define wxFILE 1
216#define wxDIR 2
217WXDLLEXPORT wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
218WXDLLEXPORT wxString wxFindNextFile();
219
220// Does the pattern contain wildcards?
221WXDLLEXPORT bool wxIsWild(const wxString& pattern);
222
223// Does the pattern match the text (usually a filename)?
224// If dot_special is TRUE, doesn't match * against . (eliminating
225// `hidden' dot files)
226WXDLLEXPORT bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = TRUE);
227
228// Concatenate two files to form third
229WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
230
231// Copy file1 to file2
232WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2,
233 bool overwrite = TRUE);
234
235// Remove file
236WXDLLEXPORT bool wxRemoveFile(const wxString& file);
237
238// Rename file
239WXDLLEXPORT bool wxRenameFile(const wxString& file1, const wxString& file2);
240
241// Get current working directory.
242// If buf is NULL, allocates space using new, else
243// copies into buf.
244// IMPORTANT NOTE getcwd is know not to work under some releases
245// of Win32s 1.3, according to MS release notes!
246WXDLLEXPORT wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000);
247// new and preferred version of wxGetWorkingDirectory
248// NB: can't have the same name because of overloading ambiguity
249WXDLLEXPORT wxString wxGetCwd();
250
251// Set working directory
252WXDLLEXPORT bool wxSetWorkingDirectory(const wxString& d);
253
254// Make directory
255WXDLLEXPORT bool wxMkdir(const wxString& dir, int perm = 0777);
256
257// Remove directory. Flags reserved for future use.
258WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0);
259
260// ----------------------------------------------------------------------------
261// separators in file names
262// ----------------------------------------------------------------------------
263
264// between file name and extension
265#define wxFILE_SEP_EXT wxT('.')
266
267// between drive/volume name and the path
268#define wxFILE_SEP_DSK wxT(':')
269
270// between the path components
271#define wxFILE_SEP_PATH_DOS wxT('\\')
272#define wxFILE_SEP_PATH_UNIX wxT('/')
273#define wxFILE_SEP_PATH_MAC wxT(':')
274#define wxFILE_SEP_PATH_VMS wxT('.') // VMS also uses '[' and ']'
275
276// separator in the path list (as in PATH environment variable)
277// there is no PATH variable in Classic Mac OS so just use the
278// semicolon (it must be different from the file name separator)
279// NB: these are strings and not characters on purpose!
280#define wxPATH_SEP_DOS wxT(";")
281#define wxPATH_SEP_UNIX wxT(":")
282#define wxPATH_SEP_MAC wxT(";")
283
284// platform independent versions
285#if defined(__UNIX__)
286 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX
287 #define wxPATH_SEP wxPATH_SEP_UNIX
288#elif defined(__MAC__)
289 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_MAC
290 #define wxPATH_SEP wxPATH_SEP_MAC
291#else // Windows and OS/2
292 #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS
293 #define wxPATH_SEP wxPATH_SEP_DOS
294#endif // Unix/Windows
295
296// this is useful for wxString::IsSameAs(): to compare two file names use
297// filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
298#if defined(__UNIX__) && !defined(__DARWIN__)
299 #define wxARE_FILENAMES_CASE_SENSITIVE TRUE
300#else // Windows, Mac OS and OS/2
301 #define wxARE_FILENAMES_CASE_SENSITIVE FALSE
302#endif // Unix/Windows
303
304// is the char a path separator?
305inline bool wxIsPathSeparator(wxChar c)
306 { return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX; }
307
308// does the string ends with path separator?
309WXDLLEXPORT bool wxEndsWithPathSeparator(const wxChar *pszFileName);
310
311// split the full path into path (including drive for DOS), name and extension
312// (understands both '/' and '\\')
313WXDLLEXPORT void wxSplitPath(const wxChar *pszFileName,
314 wxString *pstrPath,
315 wxString *pstrName,
316 wxString *pstrExt);
317
318// find a file in a list of directories, returns false if not found
319WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile);
320
321// Get the OS directory if appropriate (such as the Windows directory).
322// On non-Windows platform, probably just return the empty string.
323WXDLLEXPORT wxString wxGetOSDirectory();
324
325// Get file modification time
326WXDLLEXPORT time_t wxFileModificationTime(const wxString& filename);
327
328// ----------------------------------------------------------------------------
329// classes
330// ----------------------------------------------------------------------------
331
332// Path searching
333class WXDLLEXPORT wxPathList : public wxStringList
334{
335public:
336 // Adds all paths in environment variable
337 void AddEnvList(const wxString& envVariable);
338
339 void Add(const wxString& path);
340 // Avoid compiler warning
341 wxNode *Add(const wxChar *s) { return wxStringList::Add(s); }
342 // Find the first full path for which the file exists
343 wxString FindValidPath(const wxString& filename);
344 // Find the first full path for which the file exists; ensure it's an
345 // absolute path that gets returned.
346 wxString FindAbsoluteValidPath(const wxString& filename);
347 // Given full path and filename, add path to list
348 void EnsureFileAccessible(const wxString& path);
349 // Returns TRUE if the path is in the list
350 bool Member(const wxString& path);
351
352private:
353 DECLARE_DYNAMIC_CLASS(wxPathList)
354};
355
356#endif
357 // _WX_FILEFN_H_