1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxFileName - encapsulates a file path
4 // Author: Robert Roebling, Vadim Zeitlin
8 // Copyright: (c) 2000 Robert Roebling
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_FILENAME_H_
13 #define _WX_FILENAME_H_
15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16 #pragma interface "filename.h"
20 #include "wx/string.h"
21 #include "wx/arrstr.h"
27 1. support for drives under Windows
28 2. more file operations:
30 b) [acm]time() - get and set
32 d) file permissions with readable accessors for most common bits
33 such as IsReadable() &c
35 3. SameFileAs() function to compare inodes under Unix
38 // ridiculously enough, this will replace DirExists with wxDirExists etc
39 #include "wx/filefn.h"
40 #include "wx/datetime.h"
43 class WXDLLIMPEXP_BASE wxFile
;
46 // ----------------------------------------------------------------------------
48 // ----------------------------------------------------------------------------
50 // the various values for the path format: this mainly affects the path
51 // separator but also whether or not the path has the drive part (as under
55 wxPATH_NATIVE
= 0, // the path format for the current platform
57 wxPATH_BEOS
= wxPATH_UNIX
,
60 wxPATH_WIN
= wxPATH_DOS
,
61 wxPATH_OS2
= wxPATH_DOS
,
64 wxPATH_MAX
// Not a valid value for specifying path format
67 // the kind of normalization to do with the file name: these values can be
68 // or'd together to perform several operations at once
71 wxPATH_NORM_ENV_VARS
= 0x0001, // replace env vars with their values
72 wxPATH_NORM_DOTS
= 0x0002, // squeeze all .. and . and prepend cwd
73 wxPATH_NORM_TILDE
= 0x0004, // Unix only: replace ~ and ~user
74 wxPATH_NORM_CASE
= 0x0008, // if case insensitive => tolower
75 wxPATH_NORM_ABSOLUTE
= 0x0010, // make the path absolute
76 wxPATH_NORM_LONG
= 0x0020, // make the path the long form
77 wxPATH_NORM_SHORTCUT
= 0x0040, // resolve the shortcut, if it is a shortcut
78 wxPATH_NORM_ALL
= 0x00ff & ~wxPATH_NORM_CASE
81 // what exactly should GetPath() return?
84 wxPATH_GET_VOLUME
= 0x0001, // include the volume if applicable
85 wxPATH_GET_SEPARATOR
= 0x0002 // terminate the path with the separator
91 wxPATH_MKDIR_FULL
= 0x0001 // create directories recursively
94 // ----------------------------------------------------------------------------
95 // wxFileName: encapsulates a file path
96 // ----------------------------------------------------------------------------
98 class WXDLLIMPEXP_BASE wxFileName
101 // constructors and assignment
104 wxFileName() { Clear(); }
105 wxFileName(const wxFileName
& filepath
) { Assign(filepath
); }
107 // from a full filename: if it terminates with a '/', a directory path
108 // is contructed (the name will be empty), otherwise a file name and
109 // extension are extracted from it
110 wxFileName( const wxString
& fullpath
, wxPathFormat format
= wxPATH_NATIVE
)
111 { Assign( fullpath
, format
); }
113 // from a directory name and a file name
114 wxFileName(const wxString
& path
,
115 const wxString
& name
,
116 wxPathFormat format
= wxPATH_NATIVE
)
117 { Assign(path
, name
, format
); }
119 // from a volume, directory name, file base name and extension
120 wxFileName(const wxString
& volume
,
121 const wxString
& path
,
122 const wxString
& name
,
124 wxPathFormat format
= wxPATH_NATIVE
)
125 { Assign(volume
, path
, name
, ext
, format
); }
127 // from a directory name, file base name and extension
128 wxFileName(const wxString
& path
,
129 const wxString
& name
,
131 wxPathFormat format
= wxPATH_NATIVE
)
132 { Assign(path
, name
, ext
, format
); }
134 // the same for delayed initialization
136 void Assign(const wxFileName
& filepath
);
138 void Assign(const wxString
& fullpath
,
139 wxPathFormat format
= wxPATH_NATIVE
);
141 void Assign(const wxString
& volume
,
142 const wxString
& path
,
143 const wxString
& name
,
145 wxPathFormat format
= wxPATH_NATIVE
);
147 void Assign(const wxString
& path
,
148 const wxString
& name
,
149 wxPathFormat format
= wxPATH_NATIVE
);
151 void Assign(const wxString
& path
,
152 const wxString
& name
,
154 wxPathFormat format
= wxPATH_NATIVE
);
156 void AssignDir(const wxString
& dir
, wxPathFormat format
= wxPATH_NATIVE
);
158 // assorted assignment operators
160 wxFileName
& operator=(const wxFileName
& filename
)
161 { Assign(filename
); return *this; }
163 wxFileName
& operator=(const wxString
& filename
)
164 { Assign(filename
); return *this; }
166 // reset all components to default, uninitialized state
169 // static pseudo constructors
170 static wxFileName
FileName(const wxString
& file
,
171 wxPathFormat format
= wxPATH_NATIVE
);
172 static wxFileName
DirName(const wxString
& dir
,
173 wxPathFormat format
= wxPATH_NATIVE
);
177 // is the filename valid at all?
180 // we're fine if we have the path or the name or if we're a root dir
181 return m_dirs
.size() != 0 || !m_name
.IsEmpty() || !m_relative
;
184 // does the file with this name exists?
185 bool FileExists() const;
186 static bool FileExists( const wxString
&file
);
188 // does the directory with this name exists?
189 bool DirExists() const;
190 static bool DirExists( const wxString
&dir
);
192 // VZ: also need: IsDirWritable(), IsFileExecutable() &c (TODO)
196 // set the file last access/mod and creation times
197 // (any of the pointers may be NULL)
198 bool SetTimes(const wxDateTime
*dtAccess
,
199 const wxDateTime
*dtMod
,
200 const wxDateTime
*dtCreate
);
202 // set the access and modification times to the current moment
205 // return the last access, last modification and create times
206 // (any of the pointers may be NULL)
207 bool GetTimes(wxDateTime
*dtAccess
,
209 wxDateTime
*dtCreate
) const;
211 // convenience wrapper: get just the last mod time of the file
212 wxDateTime
GetModificationTime() const
215 (void)GetTimes(NULL
, &dtMod
, NULL
);
218 #endif // wxUSE_DATETIME
221 bool MacSetTypeAndCreator( wxUint32 type
, wxUint32 creator
) ;
222 bool MacGetTypeAndCreator( wxUint32
*type
, wxUint32
*creator
) ;
223 // gets the 'common' type and creator for a certain extension
224 static bool MacFindDefaultTypeAndCreator( const wxString
& ext
, wxUint32
*type
, wxUint32
*creator
) ;
225 // registers application defined extensions and their default type and creator
226 static void MacRegisterDefaultTypeAndCreator( const wxString
& ext
, wxUint32 type
, wxUint32 creator
) ;
227 // looks up the appropriate type and creator from the registration and then sets
228 bool MacSetDefaultTypeAndCreator() ;
231 // various file/dir operations
233 // retrieve the value of the current working directory
234 void AssignCwd(const wxString
& volume
= wxEmptyString
);
235 static wxString
GetCwd(const wxString
& volume
= wxEmptyString
);
237 // change the current working directory
239 static bool SetCwd( const wxString
&cwd
);
241 // get the value of user home (Unix only mainly)
242 void AssignHomeDir();
243 static wxString
GetHomeDir();
246 // get a temp file name starting with the specified prefix and open the
247 // file passed to us using this name for writing (atomically if
249 void AssignTempFileName(const wxString
& prefix
, wxFile
*fileTemp
= NULL
);
250 static wxString
CreateTempFileName(const wxString
& prefix
,
251 wxFile
*fileTemp
= NULL
);
254 // directory creation and removal.
255 bool Mkdir( int perm
= 0777, int flags
= 0);
256 static bool Mkdir( const wxString
&dir
, int perm
= 0777, int flags
= 0 );
259 static bool Rmdir( const wxString
&dir
);
261 // operations on the path
263 // normalize the path: with the default flags value, the path will be
264 // made absolute, without any ".." and "." and all environment
265 // variables will be expanded in it
267 // this may be done using another (than current) value of cwd
268 bool Normalize(int flags
= wxPATH_NORM_ALL
,
269 const wxString
& cwd
= wxEmptyString
,
270 wxPathFormat format
= wxPATH_NATIVE
);
272 // get a path path relative to the given base directory, i.e. opposite
275 // pass an empty string to get a path relative to the working directory
277 // returns true if the file name was modified, false if we failed to do
278 // anything with it (happens when the file is on a different volume,
280 bool MakeRelativeTo(const wxString
& pathBase
= wxEmptyString
,
281 wxPathFormat format
= wxPATH_NATIVE
);
283 // make the path absolute
285 // this may be done using another (than current) value of cwd
286 bool MakeAbsolute(const wxString
& cwd
= wxEmptyString
,
287 wxPathFormat format
= wxPATH_NATIVE
)
288 { return Normalize(wxPATH_NORM_DOTS
| wxPATH_NORM_ABSOLUTE
|
289 wxPATH_NORM_TILDE
, cwd
, format
); }
291 #if defined(__WIN32__) && !defined(__WXWINCE__) && wxUSE_OLE
292 // if the path is a shortcut, return the target and optionally,
294 bool GetShortcutTarget(const wxString
& shortcutPath
,
295 wxString
& targetFilename
,
296 wxString
* arguments
= NULL
);
301 // compares with the rules of the given platforms format
302 bool SameAs(const wxFileName
& filepath
,
303 wxPathFormat format
= wxPATH_NATIVE
) const;
305 // compare with another filename object
306 bool operator==(const wxFileName
& filename
) const
307 { return SameAs(filename
); }
308 bool operator!=(const wxFileName
& filename
) const
309 { return !SameAs(filename
); }
311 // compare with a filename string interpreted as a native file name
312 bool operator==(const wxString
& filename
) const
313 { return SameAs(wxFileName(filename
)); }
314 bool operator!=(const wxString
& filename
) const
315 { return !SameAs(wxFileName(filename
)); }
317 // are the file names of this type cases sensitive?
318 static bool IsCaseSensitive( wxPathFormat format
= wxPATH_NATIVE
);
320 // is this filename absolute?
321 bool IsAbsolute(wxPathFormat format
= wxPATH_NATIVE
) const;
323 // is this filename relative?
324 bool IsRelative(wxPathFormat format
= wxPATH_NATIVE
) const
325 { return !IsAbsolute(format
); }
327 // Returns the characters that aren't allowed in filenames
328 // on the specified platform.
329 static wxString
GetForbiddenChars(wxPathFormat format
= wxPATH_NATIVE
);
331 // Information about path format
333 // get the string separating the volume from the path for this format,
334 // return an empty string if this format doesn't support the notion of
336 static wxString
GetVolumeSeparator(wxPathFormat format
= wxPATH_NATIVE
);
338 // get the string of path separators for this format
339 static wxString
GetPathSeparators(wxPathFormat format
= wxPATH_NATIVE
);
341 // get the string of path terminators, i.e. characters which terminate the
343 static wxString
GetPathTerminators(wxPathFormat format
= wxPATH_NATIVE
);
345 // get the canonical path separator for this format
346 static wxChar
GetPathSeparator(wxPathFormat format
= wxPATH_NATIVE
)
347 { return GetPathSeparators(format
)[0u]; }
349 // is the char a path separator for this format?
350 static bool IsPathSeparator(wxChar ch
, wxPathFormat format
= wxPATH_NATIVE
);
353 size_t GetDirCount() const { return m_dirs
.size(); }
354 void AppendDir(const wxString
& dir
);
355 void PrependDir(const wxString
& dir
);
356 void InsertDir(size_t before
, const wxString
& dir
);
357 void RemoveDir(size_t pos
);
358 void RemoveLastDir() { RemoveDir(GetDirCount() - 1); }
361 void SetExt( const wxString
&ext
) { m_ext
= ext
; }
362 wxString
GetExt() const { return m_ext
; }
363 bool HasExt() const { return !m_ext
.empty(); }
365 void SetName( const wxString
&name
) { m_name
= name
; }
366 wxString
GetName() const { return m_name
; }
367 bool HasName() const { return !m_name
.empty(); }
369 void SetVolume( const wxString
&volume
) { m_volume
= volume
; }
370 wxString
GetVolume() const { return m_volume
; }
371 bool HasVolume() const { return !m_volume
.empty(); }
373 // full name is the file name + extension (but without the path)
374 void SetFullName(const wxString
& fullname
);
375 wxString
GetFullName() const;
377 const wxArrayString
& GetDirs() const { return m_dirs
; }
379 // flags are combination of wxPATH_GET_XXX flags
380 wxString
GetPath(int flags
= wxPATH_GET_VOLUME
,
381 wxPathFormat format
= wxPATH_NATIVE
) const;
383 // Replace current path with this one
384 void SetPath( const wxString
&path
, wxPathFormat format
= wxPATH_NATIVE
);
386 // Construct full path with name and ext
387 wxString
GetFullPath( wxPathFormat format
= wxPATH_NATIVE
) const;
389 // Return the short form of the path (returns identity on non-Windows platforms)
390 wxString
GetShortPath() const;
392 // Return the long form of the path (returns identity on non-Windows platforms)
393 wxString
GetLongPath() const;
395 // Is this a file or directory (not necessarily an existing one)
396 bool IsDir() const { return m_name
.empty() && m_ext
.empty(); }
400 // get the canonical path format for this platform
401 static wxPathFormat
GetFormat( wxPathFormat format
= wxPATH_NATIVE
);
403 // split a fullpath into the volume, path, (base) name and extension
404 // (all of the pointers can be NULL)
405 static void SplitPath(const wxString
& fullpath
,
410 wxPathFormat format
= wxPATH_NATIVE
);
412 // compatibility version
413 static void SplitPath(const wxString
& fullpath
,
417 wxPathFormat format
= wxPATH_NATIVE
);
419 // split a path into volume and pure path part
420 static void SplitVolume(const wxString
& fullpathWithVolume
,
423 wxPathFormat format
= wxPATH_NATIVE
);
425 // deprecated methods, don't use any more
426 // --------------------------------------
428 #ifndef __DIGITALMARS__
429 wxString
GetPath( bool withSep
, wxPathFormat format
= wxPATH_NATIVE
) const
430 { return GetPath(withSep ? wxPATH_GET_SEPARATOR
: 0, format
); }
432 wxString
GetPathWithSep(wxPathFormat format
= wxPATH_NATIVE
) const
433 { return GetPath(wxPATH_GET_SEPARATOR
, format
); }
436 // check whether this dir is valid for Append/Prepend/InsertDir()
437 static bool IsValidDirComponent(const wxString
& dir
);
439 // the drive/volume/device specification (always empty for Unix)
442 // the path components of the file
443 wxArrayString m_dirs
;
445 // the file name and extension (empty for directories)
449 // when m_dirs is empty it may mean either that we have no path at all or
450 // that our path is '/', i.e. the root directory
452 // we use m_relative to distinguish between these two cases, it will be
453 // true in the former and false in the latter
455 // NB: the path is not absolute just because m_relative is false, it still
456 // needs the drive (i.e. volume) in some formats (Windows)
460 #endif // _WX_FILENAME_H_