]>
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 |
17dff81c | 28 | #ifndef __WXMAC__ |
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 | // | |
67b81440 | 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 | // | |
67b81440 | 49 | static const off_t wxInvalidOffset = (off_t)-1; |
66b6b045 | 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 | |
45ea509a VZ |
63 | // ---------------------------------------------------------------------------- |
64 | // functions | |
65 | // ---------------------------------------------------------------------------- | |
184b5d99 | 66 | WXDLLEXPORT bool wxFileExists(const wxString& filename); |
c801d85f KB |
67 | #define FileExists wxFileExists |
68 | ||
69 | // does the path exist? (may have or not '/' or '\\' at the end) | |
9d2f3c71 | 70 | WXDLLEXPORT bool wxPathExists(const wxChar *pszPathName); |
c801d85f KB |
71 | |
72 | #define wxDirExists wxPathExists | |
73 | #define DirExists wxDirExists | |
74 | ||
184b5d99 | 75 | WXDLLEXPORT bool wxIsAbsolutePath(const wxString& filename); |
c801d85f KB |
76 | #define IsAbsolutePath wxIsAbsolutePath |
77 | ||
78 | // Get filename | |
9d2f3c71 | 79 | WXDLLEXPORT wxChar* wxFileNameFromPath(wxChar *path); |
184b5d99 | 80 | WXDLLEXPORT wxString wxFileNameFromPath(const wxString& path); |
c801d85f KB |
81 | #define FileNameFromPath wxFileNameFromPath |
82 | ||
83 | // Get directory | |
184b5d99 | 84 | WXDLLEXPORT wxString wxPathOnly(const wxString& path); |
c801d85f KB |
85 | #define PathOnly wxPathOnly |
86 | ||
87 | // wxString version | |
184b5d99 | 88 | WXDLLEXPORT wxString wxRealPath(const wxString& path); |
c801d85f | 89 | |
9d2f3c71 | 90 | WXDLLEXPORT void wxDos2UnixFilename(wxChar *s); |
c801d85f KB |
91 | #define Dos2UnixFilename wxDos2UnixFilename |
92 | ||
9d2f3c71 | 93 | WXDLLEXPORT void wxUnix2DosFilename(wxChar *s); |
c801d85f KB |
94 | #define Unix2DosFilename wxUnix2DosFilename |
95 | ||
17dff81c | 96 | #ifdef __WXMAC__ |
e7549107 SC |
97 | WXDLLEXPORT wxString wxMacFSSpec2MacFilename( const FSSpec *spec ) ; |
98 | WXDLLEXPORT wxString wxMacFSSpec2UnixFilename( const FSSpec *spec ) ; | |
99 | WXDLLEXPORT void wxUnixFilename2FSSpec( const char *path , FSSpec *spec ) ; | |
100 | WXDLLEXPORT void wxMacFilename2FSSpec( const char *path , FSSpec *spec ) ; | |
101 | WXDLLEXPORT wxString wxMac2UnixFilename( const char *s) ; | |
102 | WXDLLEXPORT wxString wxUnix2MacFilename( const char *s); | |
17dff81c | 103 | #endif |
7af89395 | 104 | |
c801d85f | 105 | // Strip the extension, in situ |
9d2f3c71 | 106 | WXDLLEXPORT void wxStripExtension(wxChar *buffer); |
184b5d99 | 107 | WXDLLEXPORT void wxStripExtension(wxString& buffer); |
c801d85f KB |
108 | |
109 | // Get a temporary filename, opening and closing the file. | |
9d2f3c71 | 110 | WXDLLEXPORT wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL); |
c0ab6adf | 111 | WXDLLEXPORT bool wxGetTempFileName(const wxString& prefix, wxString& buf); |
c801d85f KB |
112 | |
113 | // Expand file name (~/ and ${OPENWINHOME}/ stuff) | |
9d2f3c71 | 114 | WXDLLEXPORT wxChar* wxExpandPath(wxChar *dest, const wxChar *path); |
c0ab6adf | 115 | WXDLLEXPORT bool wxExpandPath(wxString& dest, const wxChar *path); |
c801d85f KB |
116 | |
117 | // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib) | |
118 | // and make (if under the home tree) relative to home | |
119 | // [caller must copy-- volatile] | |
9d2f3c71 OK |
120 | WXDLLEXPORT wxChar* wxContractPath(const wxString& filename, |
121 | const wxString& envname = wxEmptyString, | |
122 | const wxString& user = wxEmptyString); | |
c801d85f KB |
123 | |
124 | // Destructive removal of /./ and /../ stuff | |
9d2f3c71 | 125 | WXDLLEXPORT wxChar* wxRealPath(wxChar *path); |
c801d85f KB |
126 | |
127 | // Allocate a copy of the full absolute path | |
9d2f3c71 | 128 | WXDLLEXPORT wxChar* wxCopyAbsolutePath(const wxString& path); |
c801d85f KB |
129 | |
130 | // Get first file name matching given wild card. | |
131 | // Flags are reserved for future use. | |
132 | #define wxFILE 1 | |
133 | #define wxDIR 2 | |
9d2f3c71 | 134 | WXDLLEXPORT wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE); |
7af89395 | 135 | WXDLLEXPORT wxString wxFindNextFile(); |
c801d85f KB |
136 | |
137 | // Does the pattern contain wildcards? | |
184b5d99 | 138 | WXDLLEXPORT bool wxIsWild(const wxString& pattern); |
c801d85f KB |
139 | |
140 | // Does the pattern match the text (usually a filename)? | |
141 | // If dot_special is TRUE, doesn't match * against . (eliminating | |
142 | // `hidden' dot files) | |
184b5d99 | 143 | WXDLLEXPORT bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special = TRUE); |
c801d85f KB |
144 | |
145 | // Concatenate two files to form third | |
184b5d99 | 146 | WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3); |
c801d85f KB |
147 | |
148 | // Copy file1 to file2 | |
184b5d99 | 149 | WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2); |
c801d85f KB |
150 | |
151 | // Remove file | |
184b5d99 | 152 | WXDLLEXPORT bool wxRemoveFile(const wxString& file); |
c801d85f KB |
153 | |
154 | // Rename file | |
184b5d99 | 155 | WXDLLEXPORT bool wxRenameFile(const wxString& file1, const wxString& file2); |
c801d85f KB |
156 | |
157 | // Get current working directory. | |
158 | // If buf is NULL, allocates space using new, else | |
159 | // copies into buf. | |
160 | // IMPORTANT NOTE getcwd is know not to work under some releases | |
161 | // of Win32s 1.3, according to MS release notes! | |
9d2f3c71 | 162 | WXDLLEXPORT wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000); |
7af89395 VZ |
163 | // new and preferred version of wxGetWorkingDirectory |
164 | // NB: can't have the same name because of overloading ambiguity | |
165 | WXDLLEXPORT wxString wxGetCwd(); | |
c801d85f KB |
166 | |
167 | // Set working directory | |
184b5d99 | 168 | WXDLLEXPORT bool wxSetWorkingDirectory(const wxString& d); |
c801d85f KB |
169 | |
170 | // Make directory | |
1a33c3ba | 171 | WXDLLEXPORT bool wxMkdir(const wxString& dir, int perm = 0777); |
c801d85f KB |
172 | |
173 | // Remove directory. Flags reserved for future use. | |
184b5d99 | 174 | WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0); |
c801d85f KB |
175 | |
176 | // separators in file names | |
223d09f6 KB |
177 | #define wxFILE_SEP_EXT wxT('.') |
178 | #define wxFILE_SEP_DSK wxT(':') | |
179 | #define wxFILE_SEP_PATH_DOS wxT('\\') | |
180 | #define wxFILE_SEP_PATH_UNIX wxT('/') | |
c801d85f KB |
181 | |
182 | // separator in the path list (as in PATH environment variable) | |
183 | // NB: these are strings and not characters on purpose! | |
223d09f6 KB |
184 | #define wxPATH_SEP_DOS wxT(";") |
185 | #define wxPATH_SEP_UNIX wxT(":") | |
c801d85f KB |
186 | |
187 | // platform independent versions | |
188 | #ifdef __UNIX__ | |
7af89395 VZ |
189 | #define wxFILE_SEP_PATH wxFILE_SEP_PATH_UNIX |
190 | #define wxPATH_SEP wxPATH_SEP_UNIX | |
1777b9bb | 191 | #else // Windows and OS/2 |
7af89395 VZ |
192 | #define wxFILE_SEP_PATH wxFILE_SEP_PATH_DOS |
193 | #define wxPATH_SEP wxPATH_SEP_DOS | |
c801d85f KB |
194 | #endif // Unix/Windows |
195 | ||
92abb45d VZ |
196 | // this is useful for wxString::IsSameAs(): to compare two file names use |
197 | // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE) | |
198 | #ifdef __UNIX__ | |
199 | #define wxARE_FILENAMES_CASE_SENSITIVE TRUE | |
1777b9bb | 200 | #else // Windows and OS/2 |
92abb45d VZ |
201 | #define wxARE_FILENAMES_CASE_SENSITIVE FALSE |
202 | #endif // Unix/Windows | |
203 | ||
c801d85f | 204 | // is the char a path separator? |
9d2f3c71 | 205 | inline bool wxIsPathSeparator(wxChar c) |
7af89395 | 206 | { return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX; } |
c801d85f KB |
207 | |
208 | // does the string ends with path separator? | |
9d2f3c71 | 209 | WXDLLEXPORT bool wxEndsWithPathSeparator(const wxChar *pszFileName); |
c801d85f | 210 | |
92abb45d VZ |
211 | // split the full path into path (including drive for DOS), name and extension |
212 | // (understands both '/' and '\\') | |
9d2f3c71 | 213 | WXDLLEXPORT void wxSplitPath(const wxChar *pszFileName, |
92abb45d VZ |
214 | wxString *pstrPath, |
215 | wxString *pstrName, | |
216 | wxString *pstrExt); | |
217 | ||
c801d85f | 218 | // find a file in a list of directories, returns false if not found |
9d2f3c71 | 219 | WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile); |
c801d85f | 220 | |
631f1bfe JS |
221 | // Get the OS directory if appropriate (such as the Windows directory). |
222 | // On non-Windows platform, probably just return the empty string. | |
223 | WXDLLEXPORT wxString wxGetOSDirectory(); | |
224 | ||
a47ce4a7 VS |
225 | // Get file modification time |
226 | WXDLLEXPORT time_t wxFileModificationTime(const wxString& filename); | |
227 | ||
45ea509a VZ |
228 | // ---------------------------------------------------------------------------- |
229 | // classes | |
230 | // ---------------------------------------------------------------------------- | |
231 | ||
c801d85f | 232 | // Path searching |
a6f6393c | 233 | class WXDLLEXPORT wxPathList : public wxStringList |
c801d85f | 234 | { |
a6f6393c | 235 | public: |
7af89395 VZ |
236 | // Adds all paths in environment variable |
237 | void AddEnvList(const wxString& envVariable); | |
c330a2cf | 238 | |
a6f6393c | 239 | void Add(const wxString& path); |
c330a2cf | 240 | // Avoid compiler warning |
9d2f3c71 | 241 | wxNode *Add(const wxChar *s) { return wxStringList::Add(s); } |
7af89395 VZ |
242 | // Find the first full path for which the file exists |
243 | wxString FindValidPath(const wxString& filename); | |
244 | // Find the first full path for which the file exists; ensure it's an | |
245 | // absolute path that gets returned. | |
246 | wxString FindAbsoluteValidPath(const wxString& filename); | |
247 | // Given full path and filename, add path to list | |
248 | void EnsureFileAccessible(const wxString& path); | |
249 | // Returns TRUE if the path is in the list | |
a6f6393c VZ |
250 | bool Member(const wxString& path); |
251 | ||
252 | private: | |
253 | DECLARE_DYNAMIC_CLASS(wxPathList) | |
c801d85f KB |
254 | }; |
255 | ||
256 | #endif | |
34138703 | 257 | // _WX_FILEFN_H_ |