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