changed Remove/InsertDir() parameter type to size_t from int; added RemoveLastDir()
[wxWidgets.git] / include / wx / filename.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/filename.h
3 // Purpose: wxFileName - encapsulates a file path
4 // Author: Robert Roebling, Vadim Zeitlin
5 // Modified by:
6 // Created: 28.12.00
7 // RCS-ID: $Id$
8 // Copyright: (c) 2000 Robert Roebling
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_FILENAME_H_
13 #define _WX_FILENAME_H_
14
15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16 #pragma interface "filename.h"
17 #endif
18
19 #ifndef WX_PRECOMP
20 #include "wx/string.h"
21 #include "wx/arrstr.h"
22 #endif
23
24 /*
25 TODO:
26
27 1. support for drives under Windows
28 2. more file operations:
29 a) chmod()
30 b) [acm]time() - get and set
31 c) file size
32 d) file permissions with readable accessors for most common bits
33 such as IsReadable() &c
34 e) rename()?
35 3. SameFileAs() function to compare inodes under Unix
36 */
37
38 // ridiculously enough, this will replace DirExists with wxDirExists etc
39 #include "wx/filefn.h"
40 #include "wx/datetime.h"
41
42 class WXDLLIMPEXP_BASE wxFile;
43
44 // ----------------------------------------------------------------------------
45 // constants
46 // ----------------------------------------------------------------------------
47
48 // the various values for the path format: this mainly affects the path
49 // separator but also whether or not the path has the drive part (as under
50 // Windows)
51 enum wxPathFormat
52 {
53 wxPATH_NATIVE = 0, // the path format for the current platform
54 wxPATH_UNIX,
55 wxPATH_BEOS = wxPATH_UNIX,
56 wxPATH_MAC,
57 wxPATH_DOS,
58 wxPATH_WIN = wxPATH_DOS,
59 wxPATH_OS2 = wxPATH_DOS,
60 wxPATH_VMS,
61
62 wxPATH_MAX // Not a valid value for specifying path format
63 };
64
65 // the kind of normalization to do with the file name: these values can be
66 // or'd together to perform several operations at once
67 enum wxPathNormalize
68 {
69 wxPATH_NORM_ENV_VARS = 0x0001, // replace env vars with their values
70 wxPATH_NORM_DOTS = 0x0002, // squeeze all .. and . and prepend cwd
71 wxPATH_NORM_TILDE = 0x0004, // Unix only: replace ~ and ~user
72 wxPATH_NORM_CASE = 0x0008, // if case insensitive => tolower
73 wxPATH_NORM_ABSOLUTE = 0x0010, // make the path absolute
74 wxPATH_NORM_LONG = 0x0020, // make the path the long form
75 wxPATH_NORM_SHORTCUT = 0x0040, // resolve the shortcut, if it is a shortcut
76 wxPATH_NORM_ALL = 0x00ff & ~wxPATH_NORM_CASE
77 };
78
79 // what exactly should GetPath() return?
80 enum
81 {
82 wxPATH_GET_VOLUME = 0x0001, // include the volume if applicable
83 wxPATH_GET_SEPARATOR = 0x0002 // terminate the path with the separator
84 };
85
86 // MkDir flags
87 enum
88 {
89 wxPATH_MKDIR_FULL = 0x0001 // create directories recursively
90 };
91
92 // ----------------------------------------------------------------------------
93 // wxFileName: encapsulates a file path
94 // ----------------------------------------------------------------------------
95
96 class WXDLLIMPEXP_BASE wxFileName
97 {
98 public:
99 // constructors and assignment
100
101 // the usual stuff
102 wxFileName() { Clear(); }
103 wxFileName(const wxFileName& filepath) { Assign(filepath); }
104
105 // from a full filename: if it terminates with a '/', a directory path
106 // is contructed (the name will be empty), otherwise a file name and
107 // extension are extracted from it
108 wxFileName( const wxString& fullpath, wxPathFormat format = wxPATH_NATIVE )
109 { Assign( fullpath, format ); }
110
111 // from a directory name and a file name
112 wxFileName(const wxString& path,
113 const wxString& name,
114 wxPathFormat format = wxPATH_NATIVE)
115 { Assign(path, name, format); }
116
117 // from a volume, directory name, file base name and extension
118 wxFileName(const wxString& volume,
119 const wxString& path,
120 const wxString& name,
121 const wxString& ext,
122 wxPathFormat format = wxPATH_NATIVE)
123 { Assign(volume, path, name, ext, format); }
124
125 // from a directory name, file base name and extension
126 wxFileName(const wxString& path,
127 const wxString& name,
128 const wxString& ext,
129 wxPathFormat format = wxPATH_NATIVE)
130 { Assign(path, name, ext, format); }
131
132 // the same for delayed initialization
133
134 void Assign(const wxFileName& filepath);
135
136 void Assign(const wxString& fullpath,
137 wxPathFormat format = wxPATH_NATIVE);
138
139 void Assign(const wxString& volume,
140 const wxString& path,
141 const wxString& name,
142 const wxString& ext,
143 wxPathFormat format = wxPATH_NATIVE);
144
145 void Assign(const wxString& path,
146 const wxString& name,
147 wxPathFormat format = wxPATH_NATIVE);
148
149 void Assign(const wxString& path,
150 const wxString& name,
151 const wxString& ext,
152 wxPathFormat format = wxPATH_NATIVE);
153
154 void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE);
155
156 // assorted assignment operators
157
158 wxFileName& operator=(const wxFileName& filename)
159 { Assign(filename); return *this; }
160
161 wxFileName& operator=(const wxString& filename)
162 { Assign(filename); return *this; }
163
164 // reset all components to default, uninitialized state
165 void Clear();
166
167 // static pseudo constructors
168 static wxFileName FileName(const wxString& file,
169 wxPathFormat format = wxPATH_NATIVE);
170 static wxFileName DirName(const wxString& dir,
171 wxPathFormat format = wxPATH_NATIVE);
172
173 // file tests
174
175 // is the filename valid at all?
176 bool IsOk() const
177 {
178 // we're fine if we have the path or the name or if we're a root dir
179 return m_dirs.size() != 0 || !m_name.IsEmpty() || !m_relative;
180 }
181
182 // does the file with this name exists?
183 bool FileExists() const;
184 static bool FileExists( const wxString &file );
185
186 // does the directory with this name exists?
187 bool DirExists() const;
188 static bool DirExists( const wxString &dir );
189
190 // VZ: also need: IsDirWritable(), IsFileExecutable() &c (TODO)
191
192 // time functions
193 #if wxUSE_DATETIME
194 // set the file last access/mod and creation times
195 // (any of the pointers may be NULL)
196 bool SetTimes(const wxDateTime *dtAccess,
197 const wxDateTime *dtMod,
198 const wxDateTime *dtCreate);
199
200 // set the access and modification times to the current moment
201 bool Touch();
202
203 // return the last access, last modification and create times
204 // (any of the pointers may be NULL)
205 bool GetTimes(wxDateTime *dtAccess,
206 wxDateTime *dtMod,
207 wxDateTime *dtCreate) const;
208
209 // convenience wrapper: get just the last mod time of the file
210 wxDateTime GetModificationTime() const
211 {
212 wxDateTime dtMod;
213 (void)GetTimes(NULL, &dtMod, NULL);
214 return dtMod;
215 }
216 #endif // wxUSE_DATETIME
217
218 #ifdef __WXMAC__
219 bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ;
220 bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) ;
221 // gets the 'common' type and creator for a certain extension
222 static bool MacFindDefaultTypeAndCreator( const wxString& ext , wxUint32 *type , wxUint32 *creator ) ;
223 // registers application defined extensions and their default type and creator
224 static void MacRegisterDefaultTypeAndCreator( const wxString& ext , wxUint32 type , wxUint32 creator ) ;
225 // looks up the appropriate type and creator from the registration and then sets
226 bool MacSetDefaultTypeAndCreator() ;
227 #endif
228
229 // various file/dir operations
230
231 // retrieve the value of the current working directory
232 void AssignCwd(const wxString& volume = wxEmptyString);
233 static wxString GetCwd(const wxString& volume = wxEmptyString);
234
235 // change the current working directory
236 bool SetCwd();
237 static bool SetCwd( const wxString &cwd );
238
239 // get the value of user home (Unix only mainly)
240 void AssignHomeDir();
241 static wxString GetHomeDir();
242
243 // get a temp file name starting with the specified prefix and open the
244 // file passed to us using this name for writing (atomically if
245 // possible)
246 void AssignTempFileName(const wxString& prefix, wxFile *fileTemp = NULL);
247 static wxString CreateTempFileName(const wxString& prefix,
248 wxFile *fileTemp = NULL);
249
250 // directory creation and removal.
251 bool Mkdir( int perm = 0777, int flags = 0);
252 static bool Mkdir( const wxString &dir, int perm = 0777, int flags = 0 );
253
254 bool Rmdir();
255 static bool Rmdir( const wxString &dir );
256
257 // operations on the path
258
259 // normalize the path: with the default flags value, the path will be
260 // made absolute, without any ".." and "." and all environment
261 // variables will be expanded in it
262 //
263 // this may be done using another (than current) value of cwd
264 bool Normalize(int flags = wxPATH_NORM_ALL,
265 const wxString& cwd = wxEmptyString,
266 wxPathFormat format = wxPATH_NATIVE);
267
268 // get a path path relative to the given base directory, i.e. opposite
269 // of Normalize
270 //
271 // pass an empty string to get a path relative to the working directory
272 //
273 // returns true if the file name was modified, false if we failed to do
274 // anything with it (happens when the file is on a different volume,
275 // for example)
276 bool MakeRelativeTo(const wxString& pathBase = wxEmptyString,
277 wxPathFormat format = wxPATH_NATIVE);
278
279 // make the path absolute
280 //
281 // this may be done using another (than current) value of cwd
282 bool MakeAbsolute(const wxString& cwd = wxEmptyString,
283 wxPathFormat format = wxPATH_NATIVE)
284 { return Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_ABSOLUTE |
285 wxPATH_NORM_TILDE, cwd, format); }
286
287 #if defined(__WIN32__) && !defined(__WXWINCE__) && wxUSE_OLE
288 // if the path is a shortcut, return the target and optionally,
289 // the arguments
290 bool GetShortcutTarget(const wxString& shortcutPath,
291 wxString& targetFilename,
292 wxString* arguments = NULL);
293 #endif
294
295 // Comparison
296
297 // compares with the rules of the given platforms format
298 bool SameAs(const wxFileName& filepath,
299 wxPathFormat format = wxPATH_NATIVE) const;
300
301 // compare with another filename object
302 bool operator==(const wxFileName& filename) const
303 { return SameAs(filename); }
304 bool operator!=(const wxFileName& filename) const
305 { return !SameAs(filename); }
306
307 // compare with a filename string interpreted as a native file name
308 bool operator==(const wxString& filename) const
309 { return SameAs(wxFileName(filename)); }
310 bool operator!=(const wxString& filename) const
311 { return !SameAs(wxFileName(filename)); }
312
313 // are the file names of this type cases sensitive?
314 static bool IsCaseSensitive( wxPathFormat format = wxPATH_NATIVE );
315
316 // is this filename absolute?
317 bool IsAbsolute(wxPathFormat format = wxPATH_NATIVE) const;
318
319 // is this filename relative?
320 bool IsRelative(wxPathFormat format = wxPATH_NATIVE) const
321 { return !IsAbsolute(format); }
322
323 // Returns the characters that aren't allowed in filenames
324 // on the specified platform.
325 static wxString GetForbiddenChars(wxPathFormat format = wxPATH_NATIVE);
326
327 // Information about path format
328
329 // get the string separating the volume from the path for this format,
330 // return an empty string if this format doesn't support the notion of
331 // volumes at all
332 static wxString GetVolumeSeparator(wxPathFormat format = wxPATH_NATIVE);
333
334 // get the string of path separators for this format
335 static wxString GetPathSeparators(wxPathFormat format = wxPATH_NATIVE);
336
337 // get the string of path terminators, i.e. characters which terminate the
338 // path
339 static wxString GetPathTerminators(wxPathFormat format = wxPATH_NATIVE);
340
341 // get the canonical path separator for this format
342 static wxChar GetPathSeparator(wxPathFormat format = wxPATH_NATIVE)
343 { return GetPathSeparators(format)[0u]; }
344
345 // is the char a path separator for this format?
346 static bool IsPathSeparator(wxChar ch, wxPathFormat format = wxPATH_NATIVE);
347
348 // Dir accessors
349 size_t GetDirCount() const { return m_dirs.size(); }
350 void AppendDir(const wxString& dir);
351 void PrependDir(const wxString& dir);
352 void InsertDir(size_t before, const wxString& dir);
353 void RemoveDir(size_t pos);
354 void RemoveLastDir() { RemoveDir(GetDirCount() - 1); }
355
356 // Other accessors
357 void SetExt( const wxString &ext ) { m_ext = ext; }
358 wxString GetExt() const { return m_ext; }
359 bool HasExt() const { return !m_ext.empty(); }
360
361 void SetName( const wxString &name ) { m_name = name; }
362 wxString GetName() const { return m_name; }
363 bool HasName() const { return !m_name.empty(); }
364
365 void SetVolume( const wxString &volume ) { m_volume = volume; }
366 wxString GetVolume() const { return m_volume; }
367 bool HasVolume() const { return !m_volume.empty(); }
368
369 // full name is the file name + extension (but without the path)
370 void SetFullName(const wxString& fullname);
371 wxString GetFullName() const;
372
373 const wxArrayString& GetDirs() const { return m_dirs; }
374
375 // flags are combination of wxPATH_GET_XXX flags
376 wxString GetPath(int flags = wxPATH_GET_VOLUME,
377 wxPathFormat format = wxPATH_NATIVE) const;
378
379 // Replace current path with this one
380 void SetPath( const wxString &path, wxPathFormat format = wxPATH_NATIVE );
381
382 // Construct full path with name and ext
383 wxString GetFullPath( wxPathFormat format = wxPATH_NATIVE ) const;
384
385 // Return the short form of the path (returns identity on non-Windows platforms)
386 wxString GetShortPath() const;
387
388 // Return the long form of the path (returns identity on non-Windows platforms)
389 wxString GetLongPath() const;
390
391 // Is this a file or directory (not necessarily an existing one)
392 bool IsDir() const { return m_name.empty() && m_ext.empty(); }
393
394 // various helpers
395
396 // get the canonical path format for this platform
397 static wxPathFormat GetFormat( wxPathFormat format = wxPATH_NATIVE );
398
399 // split a fullpath into the volume, path, (base) name and extension
400 // (all of the pointers can be NULL)
401 static void SplitPath(const wxString& fullpath,
402 wxString *volume,
403 wxString *path,
404 wxString *name,
405 wxString *ext,
406 wxPathFormat format = wxPATH_NATIVE);
407
408 // compatibility version
409 static void SplitPath(const wxString& fullpath,
410 wxString *path,
411 wxString *name,
412 wxString *ext,
413 wxPathFormat format = wxPATH_NATIVE);
414
415 // split a path into volume and pure path part
416 static void SplitVolume(const wxString& fullpathWithVolume,
417 wxString *volume,
418 wxString *path,
419 wxPathFormat format = wxPATH_NATIVE);
420
421 // deprecated methods, don't use any more
422 // --------------------------------------
423
424 #ifndef __DIGITALMARS__
425 wxString GetPath( bool withSep, wxPathFormat format = wxPATH_NATIVE ) const
426 { return GetPath(withSep ? wxPATH_GET_SEPARATOR : 0, format); }
427 #endif
428 wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const
429 { return GetPath(wxPATH_GET_SEPARATOR, format); }
430
431 private:
432 // check whether this dir is valid for Append/Prepend/InsertDir()
433 static bool IsValidDirComponent(const wxString& dir);
434
435 // the drive/volume/device specification (always empty for Unix)
436 wxString m_volume;
437
438 // the path components of the file
439 wxArrayString m_dirs;
440
441 // the file name and extension (empty for directories)
442 wxString m_name,
443 m_ext;
444
445 // when m_dirs is empty it may mean either that we have no path at all or
446 // that our path is '/', i.e. the root directory
447 //
448 // we use m_relative to distinguish between these two cases, it will be
449 // true in the former and false in the latter
450 //
451 // NB: the path is not absolute just because m_relative is false, it still
452 // needs the drive (i.e. volume) in some formats (Windows)
453 bool m_relative;
454 };
455
456 #endif // _WX_FILENAME_H_
457