1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/filename.cpp
3 // Purpose: wxFileName - encapsulates a file path
4 // Author: Robert Roebling, Vadim Zeitlin
8 // Copyright: (c) 2000 Robert Roebling
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
13 Here are brief descriptions of the filename formats supported by this class:
15 wxPATH_UNIX: standard Unix format, used under Darwin as well, absolute file
17 /dir1/dir2/.../dirN/filename, "." and ".." stand for the
18 current and parent directory respectively, "~" is parsed as the
19 user HOME and "~username" as the HOME of that user
21 wxPATH_DOS: DOS/Windows format, absolute file names have the form:
22 drive:\dir1\dir2\...\dirN\filename.ext where drive is a single
23 letter. "." and ".." as for Unix but no "~".
25 There are also UNC names of the form \\share\fullpath
27 wxPATH_MAC: Mac OS 8/9 and Mac OS X under CodeWarrior 7 format, absolute file
29 volume:dir1:...:dirN:filename
30 and the relative file names are either
31 :dir1:...:dirN:filename
34 (although :filename works as well).
35 Since the volume is just part of the file path, it is not
36 treated like a separate entity as it is done under DOS and
37 VMS, it is just treated as another dir.
39 wxPATH_VMS: VMS native format, absolute file names have the form
40 <device>:[dir1.dir2.dir3]file.txt
42 <device>:[000000.dir1.dir2.dir3]file.txt
44 the <device> is the physical device (i.e. disk). 000000 is the
45 root directory on the device which can be omitted.
47 Note that VMS uses different separators unlike Unix:
48 : always after the device. If the path does not contain : than
49 the default (the device of the current directory) is assumed.
50 [ start of directory specification
51 . separator between directory and subdirectory
52 ] between directory and file
55 // ============================================================================
57 // ============================================================================
59 // ----------------------------------------------------------------------------
61 // ----------------------------------------------------------------------------
63 // For compilers that support precompilation, includes "wx.h".
64 #include "wx/wxprec.h"
72 #include "wx/msw/wrapwin.h" // For GetShort/LongPathName
74 #include "wx/dynarray.h"
81 #include "wx/filename.h"
82 #include "wx/private/filename.h"
83 #include "wx/tokenzr.h"
84 #include "wx/config.h" // for wxExpandEnvVars
85 #include "wx/dynlib.h"
87 #if defined(__WIN32__) && defined(__MINGW32__)
88 #include "wx/msw/gccpriv.h"
92 #include "wx/msw/private.h"
95 #if defined(__WXMAC__)
96 #include "wx/mac/private.h" // includes mac headers
99 // utime() is POSIX so should normally be available on all Unices
101 #include <sys/types.h>
103 #include <sys/stat.h>
113 #include <sys/types.h>
115 #include <sys/stat.h>
126 #include <sys/utime.h>
127 #include <sys/stat.h>
138 #define MAX_PATH _MAX_PATH
142 wxULongLong wxInvalidSize
= (unsigned)-1;
145 // ----------------------------------------------------------------------------
147 // ----------------------------------------------------------------------------
149 // small helper class which opens and closes the file - we use it just to get
150 // a file handle for the given file name to pass it to some Win32 API function
151 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
162 wxFileHandle(const wxString
& filename
, OpenMode mode
)
164 m_hFile
= ::CreateFile
167 mode
== Read
? GENERIC_READ
// access mask
169 FILE_SHARE_READ
| // sharing mode
170 FILE_SHARE_WRITE
, // (allow everything)
171 NULL
, // no secutity attr
172 OPEN_EXISTING
, // creation disposition
174 NULL
// no template file
177 if ( m_hFile
== INVALID_HANDLE_VALUE
)
180 wxLogSysError(_("Failed to open '%s' for reading"),
183 wxLogSysError(_("Failed to open '%s' for writing"),
190 if ( m_hFile
!= INVALID_HANDLE_VALUE
)
192 if ( !::CloseHandle(m_hFile
) )
194 wxLogSysError(_("Failed to close file handle"));
199 // return true only if the file could be opened successfully
200 bool IsOk() const { return m_hFile
!= INVALID_HANDLE_VALUE
; }
203 operator HANDLE() const { return m_hFile
; }
211 // ----------------------------------------------------------------------------
213 // ----------------------------------------------------------------------------
215 #if wxUSE_DATETIME && defined(__WIN32__) && !defined(__WXMICROWIN__)
217 // convert between wxDateTime and FILETIME which is a 64-bit value representing
218 // the number of 100-nanosecond intervals since January 1, 1601.
220 static void ConvertFileTimeToWx(wxDateTime
*dt
, const FILETIME
&ft
)
222 FILETIME ftcopy
= ft
;
224 if ( !::FileTimeToLocalFileTime(&ftcopy
, &ftLocal
) )
226 wxLogLastError(_T("FileTimeToLocalFileTime"));
230 if ( !::FileTimeToSystemTime(&ftLocal
, &st
) )
232 wxLogLastError(_T("FileTimeToSystemTime"));
235 dt
->Set(st
.wDay
, wxDateTime::Month(st
.wMonth
- 1), st
.wYear
,
236 st
.wHour
, st
.wMinute
, st
.wSecond
, st
.wMilliseconds
);
239 static void ConvertWxToFileTime(FILETIME
*ft
, const wxDateTime
& dt
)
242 st
.wDay
= dt
.GetDay();
243 st
.wMonth
= (WORD
)(dt
.GetMonth() + 1);
244 st
.wYear
= (WORD
)dt
.GetYear();
245 st
.wHour
= dt
.GetHour();
246 st
.wMinute
= dt
.GetMinute();
247 st
.wSecond
= dt
.GetSecond();
248 st
.wMilliseconds
= dt
.GetMillisecond();
251 if ( !::SystemTimeToFileTime(&st
, &ftLocal
) )
253 wxLogLastError(_T("SystemTimeToFileTime"));
256 if ( !::LocalFileTimeToFileTime(&ftLocal
, ft
) )
258 wxLogLastError(_T("LocalFileTimeToFileTime"));
262 #endif // wxUSE_DATETIME && __WIN32__
264 // return a string with the volume par
265 static wxString
wxGetVolumeString(const wxString
& volume
, wxPathFormat format
)
269 if ( !volume
.empty() )
271 format
= wxFileName::GetFormat(format
);
273 // Special Windows UNC paths hack, part 2: undo what we did in
274 // SplitPath() and make an UNC path if we have a drive which is not a
275 // single letter (hopefully the network shares can't be one letter only
276 // although I didn't find any authoritative docs on this)
277 if ( format
== wxPATH_DOS
&& volume
.length() > 1 )
279 path
<< wxFILE_SEP_PATH_DOS
<< wxFILE_SEP_PATH_DOS
<< volume
;
281 else if ( format
== wxPATH_DOS
|| format
== wxPATH_VMS
)
283 path
<< volume
<< wxFileName::GetVolumeSeparator(format
);
291 // return true if the format used is the DOS/Windows one and the string looks
293 static bool IsUNCPath(const wxString
& path
, wxPathFormat format
)
295 return format
== wxPATH_DOS
&&
296 path
.length() >= 4 && // "\\a" can't be a UNC path
297 path
[0u] == wxFILE_SEP_PATH_DOS
&&
298 path
[1u] == wxFILE_SEP_PATH_DOS
&&
299 path
[2u] != wxFILE_SEP_PATH_DOS
;
302 // ============================================================================
304 // ============================================================================
306 // ----------------------------------------------------------------------------
307 // wxFileName construction
308 // ----------------------------------------------------------------------------
310 void wxFileName::Assign( const wxFileName
&filepath
)
312 m_volume
= filepath
.GetVolume();
313 m_dirs
= filepath
.GetDirs();
314 m_name
= filepath
.GetName();
315 m_ext
= filepath
.GetExt();
316 m_relative
= filepath
.m_relative
;
317 m_hasExt
= filepath
.m_hasExt
;
320 void wxFileName::Assign(const wxString
& volume
,
321 const wxString
& path
,
322 const wxString
& name
,
327 // we should ignore paths which look like UNC shares because we already
328 // have the volume here and the UNC notation (\\server\path) is only valid
329 // for paths which don't start with a volume, so prevent SetPath() from
330 // recognizing "\\foo\bar" in "c:\\foo\bar" as an UNC path
332 // note also that this is a rather ugly way to do what we want (passing
333 // some kind of flag telling to ignore UNC paths to SetPath() would be
334 // better) but this is the safest thing to do to avoid breaking backwards
335 // compatibility in 2.8
336 if ( IsUNCPath(path
, format
) )
338 // remove one of the 2 leading backslashes to ensure that it's not
339 // recognized as an UNC path by SetPath()
340 wxString
pathNonUNC(path
, 1, wxString::npos
);
341 SetPath(pathNonUNC
, format
);
343 else // no UNC complications
345 SetPath(path
, format
);
355 void wxFileName::SetPath( const wxString
& pathOrig
, wxPathFormat format
)
359 if ( pathOrig
.empty() )
367 format
= GetFormat( format
);
369 // 0) deal with possible volume part first
372 SplitVolume(pathOrig
, &volume
, &path
, format
);
373 if ( !volume
.empty() )
380 // 1) Determine if the path is relative or absolute.
381 wxChar leadingChar
= path
[0u];
386 m_relative
= leadingChar
== wxT(':');
388 // We then remove a leading ":". The reason is in our
389 // storage form for relative paths:
390 // ":dir:file.txt" actually means "./dir/file.txt" in
391 // DOS notation and should get stored as
392 // (relative) (dir) (file.txt)
393 // "::dir:file.txt" actually means "../dir/file.txt"
394 // stored as (relative) (..) (dir) (file.txt)
395 // This is important only for the Mac as an empty dir
396 // actually means <UP>, whereas under DOS, double
397 // slashes can be ignored: "\\\\" is the same as "\\".
403 // TODO: what is the relative path format here?
408 wxFAIL_MSG( _T("Unknown path format") );
409 // !! Fall through !!
412 // the paths of the form "~" or "~username" are absolute
413 m_relative
= leadingChar
!= wxT('/') && leadingChar
!= _T('~');
417 m_relative
= !IsPathSeparator(leadingChar
, format
);
422 // 2) Break up the path into its members. If the original path
423 // was just "/" or "\\", m_dirs will be empty. We know from
424 // the m_relative field, if this means "nothing" or "root dir".
426 wxStringTokenizer
tn( path
, GetPathSeparators(format
) );
428 while ( tn
.HasMoreTokens() )
430 wxString token
= tn
.GetNextToken();
432 // Remove empty token under DOS and Unix, interpret them
436 if (format
== wxPATH_MAC
)
437 m_dirs
.Add( wxT("..") );
447 void wxFileName::Assign(const wxString
& fullpath
,
450 wxString volume
, path
, name
, ext
;
452 SplitPath(fullpath
, &volume
, &path
, &name
, &ext
, &hasExt
, format
);
454 Assign(volume
, path
, name
, ext
, hasExt
, format
);
457 void wxFileName::Assign(const wxString
& fullpathOrig
,
458 const wxString
& fullname
,
461 // always recognize fullpath as directory, even if it doesn't end with a
463 wxString fullpath
= fullpathOrig
;
464 if ( !fullpath
.empty() && !wxEndsWithPathSeparator(fullpath
) )
466 fullpath
+= GetPathSeparator(format
);
469 wxString volume
, path
, name
, ext
;
472 // do some consistency checks in debug mode: the name should be really just
473 // the filename and the path should be really just a path
475 wxString volDummy
, pathDummy
, nameDummy
, extDummy
;
477 SplitPath(fullname
, &volDummy
, &pathDummy
, &name
, &ext
, &hasExt
, format
);
479 wxASSERT_MSG( volDummy
.empty() && pathDummy
.empty(),
480 _T("the file name shouldn't contain the path") );
482 SplitPath(fullpath
, &volume
, &path
, &nameDummy
, &extDummy
, format
);
484 wxASSERT_MSG( nameDummy
.empty() && extDummy
.empty(),
485 _T("the path shouldn't contain file name nor extension") );
487 #else // !__WXDEBUG__
488 SplitPath(fullname
, NULL
/* no volume */, NULL
/* no path */,
489 &name
, &ext
, &hasExt
, format
);
490 SplitPath(fullpath
, &volume
, &path
, NULL
, NULL
, format
);
491 #endif // __WXDEBUG__/!__WXDEBUG__
493 Assign(volume
, path
, name
, ext
, hasExt
, format
);
496 void wxFileName::Assign(const wxString
& pathOrig
,
497 const wxString
& name
,
503 SplitVolume(pathOrig
, &volume
, &path
, format
);
505 Assign(volume
, path
, name
, ext
, format
);
508 void wxFileName::AssignDir(const wxString
& dir
, wxPathFormat format
)
510 Assign(dir
, wxEmptyString
, format
);
513 void wxFileName::Clear()
519 m_ext
= wxEmptyString
;
521 // we don't have any absolute path for now
529 wxFileName
wxFileName::FileName(const wxString
& file
, wxPathFormat format
)
531 return wxFileName(file
, format
);
535 wxFileName
wxFileName::DirName(const wxString
& dir
, wxPathFormat format
)
538 fn
.AssignDir(dir
, format
);
542 // ----------------------------------------------------------------------------
544 // ----------------------------------------------------------------------------
546 bool wxFileName::FileExists() const
548 return wxFileName::FileExists( GetFullPath() );
551 bool wxFileName::FileExists( const wxString
&file
)
553 return ::wxFileExists( file
);
556 bool wxFileName::DirExists() const
558 return wxFileName::DirExists( GetPath() );
561 bool wxFileName::DirExists( const wxString
&dir
)
563 return ::wxDirExists( dir
);
566 // ----------------------------------------------------------------------------
567 // CWD and HOME stuff
568 // ----------------------------------------------------------------------------
570 void wxFileName::AssignCwd(const wxString
& volume
)
572 AssignDir(wxFileName::GetCwd(volume
));
576 wxString
wxFileName::GetCwd(const wxString
& volume
)
578 // if we have the volume, we must get the current directory on this drive
579 // and to do this we have to chdir to this volume - at least under Windows,
580 // I don't know how to get the current drive on another volume elsewhere
583 if ( !volume
.empty() )
586 SetCwd(volume
+ GetVolumeSeparator());
589 wxString cwd
= ::wxGetCwd();
591 if ( !volume
.empty() )
599 bool wxFileName::SetCwd()
601 return wxFileName::SetCwd( GetPath() );
604 bool wxFileName::SetCwd( const wxString
&cwd
)
606 return ::wxSetWorkingDirectory( cwd
);
609 void wxFileName::AssignHomeDir()
611 AssignDir(wxFileName::GetHomeDir());
614 wxString
wxFileName::GetHomeDir()
616 return ::wxGetHomeDir();
620 // ----------------------------------------------------------------------------
621 // CreateTempFileName
622 // ----------------------------------------------------------------------------
624 #if wxUSE_FILE || wxUSE_FFILE
627 #if !defined wx_fdopen && defined HAVE_FDOPEN
628 #define wx_fdopen fdopen
631 // NB: GetTempFileName() under Windows creates the file, so using
632 // O_EXCL there would fail
634 #define wxOPEN_EXCL 0
636 #define wxOPEN_EXCL O_EXCL
640 #ifdef wxOpenOSFHandle
641 #define WX_HAVE_DELETE_ON_CLOSE
642 // On Windows create a file with the FILE_FLAGS_DELETE_ON_CLOSE flags.
644 static int wxOpenWithDeleteOnClose(const wxString
& filename
)
646 DWORD access
= GENERIC_READ
| GENERIC_WRITE
;
648 DWORD disposition
= OPEN_ALWAYS
;
650 DWORD attributes
= FILE_ATTRIBUTE_TEMPORARY
|
651 FILE_FLAG_DELETE_ON_CLOSE
;
653 HANDLE h
= ::CreateFile(filename
, access
, 0, NULL
,
654 disposition
, attributes
, NULL
);
656 return wxOpenOSFHandle(h
, wxO_BINARY
);
658 #endif // wxOpenOSFHandle
661 // Helper to open the file
663 static int wxTempOpen(const wxString
& path
, bool *deleteOnClose
)
665 #ifdef WX_HAVE_DELETE_ON_CLOSE
667 return wxOpenWithDeleteOnClose(path
);
670 *deleteOnClose
= false;
672 return wxOpen(path
, wxO_BINARY
| O_RDWR
| O_CREAT
| wxOPEN_EXCL
, 0600);
677 // Helper to open the file and attach it to the wxFFile
679 static bool wxTempOpen(wxFFile
*file
, const wxString
& path
, bool *deleteOnClose
)
682 *deleteOnClose
= false;
683 return file
->Open(path
, _T("w+b"));
685 int fd
= wxTempOpen(path
, deleteOnClose
);
688 file
->Attach(wx_fdopen(fd
, "w+b"));
689 return file
->IsOpened();
692 #endif // wxUSE_FFILE
696 #define WXFILEARGS(x, y) y
698 #define WXFILEARGS(x, y) x
700 #define WXFILEARGS(x, y) x, y
704 // Implementation of wxFileName::CreateTempFileName().
706 static wxString
wxCreateTempImpl(
707 const wxString
& prefix
,
708 WXFILEARGS(wxFile
*fileTemp
, wxFFile
*ffileTemp
),
709 bool *deleteOnClose
= NULL
)
711 #if wxUSE_FILE && wxUSE_FFILE
712 wxASSERT(fileTemp
== NULL
|| ffileTemp
== NULL
);
714 wxString path
, dir
, name
;
715 bool wantDeleteOnClose
= false;
719 // set the result to false initially
720 wantDeleteOnClose
= *deleteOnClose
;
721 *deleteOnClose
= false;
725 // easier if it alwasys points to something
726 deleteOnClose
= &wantDeleteOnClose
;
729 // use the directory specified by the prefix
730 wxFileName::SplitPath(prefix
, &dir
, &name
, NULL
/* extension */);
734 dir
= wxFileName::GetTempDir();
737 #if defined(__WXWINCE__)
738 path
= dir
+ wxT("\\") + name
;
740 while (wxFileName::FileExists(path
))
742 path
= dir
+ wxT("\\") + name
;
747 #elif defined(__WINDOWS__) && !defined(__WXMICROWIN__)
748 if ( !::GetTempFileName(dir
, name
, 0, wxStringBuffer(path
, MAX_PATH
+ 1)) )
750 wxLogLastError(_T("GetTempFileName"));
758 if ( !wxEndsWithPathSeparator(dir
) &&
759 (name
.empty() || !wxIsPathSeparator(name
[0u])) )
761 path
+= wxFILE_SEP_PATH
;
766 #if defined(HAVE_MKSTEMP)
767 // scratch space for mkstemp()
768 path
+= _T("XXXXXX");
770 // we need to copy the path to the buffer in which mkstemp() can modify it
771 wxCharBuffer
buf(path
.fn_str());
773 // cast is safe because the string length doesn't change
774 int fdTemp
= mkstemp( (char*)(const char*) buf
);
777 // this might be not necessary as mkstemp() on most systems should have
778 // already done it but it doesn't hurt neither...
781 else // mkstemp() succeeded
783 path
= wxConvFile
.cMB2WX( (const char*) buf
);
786 // avoid leaking the fd
789 fileTemp
->Attach(fdTemp
);
798 ffileTemp
->Attach(wx_fdopen(fdTemp
, "r+b"));
800 ffileTemp
->Open(path
, _T("r+b"));
811 #else // !HAVE_MKSTEMP
815 path
+= _T("XXXXXX");
817 wxCharBuffer buf
= wxConvFile
.cWX2MB( path
);
818 if ( !mktemp( (char*)(const char*) buf
) )
824 path
= wxConvFile
.cMB2WX( (const char*) buf
);
826 #else // !HAVE_MKTEMP (includes __DOS__)
827 // generate the unique file name ourselves
828 #if !defined(__DOS__) && !defined(__PALMOS__) && (!defined(__MWERKS__) || defined(__DARWIN__) )
829 path
<< (unsigned int)getpid();
834 static const size_t numTries
= 1000;
835 for ( size_t n
= 0; n
< numTries
; n
++ )
837 // 3 hex digits is enough for numTries == 1000 < 4096
838 pathTry
= path
+ wxString::Format(_T("%.03x"), (unsigned int) n
);
839 if ( !wxFileName::FileExists(pathTry
) )
848 #endif // HAVE_MKTEMP/!HAVE_MKTEMP
850 #endif // HAVE_MKSTEMP/!HAVE_MKSTEMP
852 #endif // Windows/!Windows
856 wxLogSysError(_("Failed to create a temporary file name"));
862 // open the file - of course, there is a race condition here, this is
863 // why we always prefer using mkstemp()...
865 if ( fileTemp
&& !fileTemp
->IsOpened() )
867 *deleteOnClose
= wantDeleteOnClose
;
868 int fd
= wxTempOpen(path
, deleteOnClose
);
870 fileTemp
->Attach(fd
);
877 if ( ffileTemp
&& !ffileTemp
->IsOpened() )
879 *deleteOnClose
= wantDeleteOnClose
;
880 ok
= wxTempOpen(ffileTemp
, path
, deleteOnClose
);
886 // FIXME: If !ok here should we loop and try again with another
887 // file name? That is the standard recourse if open(O_EXCL)
888 // fails, though of course it should be protected against
889 // possible infinite looping too.
891 wxLogError(_("Failed to open temporary file."));
901 static bool wxCreateTempImpl(
902 const wxString
& prefix
,
903 WXFILEARGS(wxFile
*fileTemp
, wxFFile
*ffileTemp
),
906 bool deleteOnClose
= true;
908 *name
= wxCreateTempImpl(prefix
,
909 WXFILEARGS(fileTemp
, ffileTemp
),
912 bool ok
= !name
->empty();
917 else if (ok
&& wxRemoveFile(*name
))
925 static void wxAssignTempImpl(
927 const wxString
& prefix
,
928 WXFILEARGS(wxFile
*fileTemp
, wxFFile
*ffileTemp
))
931 tempname
= wxCreateTempImpl(prefix
, WXFILEARGS(fileTemp
, ffileTemp
));
933 if ( tempname
.empty() )
935 // error, failed to get temp file name
940 fn
->Assign(tempname
);
945 void wxFileName::AssignTempFileName(const wxString
& prefix
)
947 wxAssignTempImpl(this, prefix
, WXFILEARGS(NULL
, NULL
));
951 wxString
wxFileName::CreateTempFileName(const wxString
& prefix
)
953 return wxCreateTempImpl(prefix
, WXFILEARGS(NULL
, NULL
));
956 #endif // wxUSE_FILE || wxUSE_FFILE
961 wxString
wxCreateTempFileName(const wxString
& prefix
,
965 return wxCreateTempImpl(prefix
, WXFILEARGS(fileTemp
, NULL
), deleteOnClose
);
968 bool wxCreateTempFile(const wxString
& prefix
,
972 return wxCreateTempImpl(prefix
, WXFILEARGS(fileTemp
, NULL
), name
);
975 void wxFileName::AssignTempFileName(const wxString
& prefix
, wxFile
*fileTemp
)
977 wxAssignTempImpl(this, prefix
, WXFILEARGS(fileTemp
, NULL
));
982 wxFileName::CreateTempFileName(const wxString
& prefix
, wxFile
*fileTemp
)
984 return wxCreateTempFileName(prefix
, fileTemp
);
992 wxString
wxCreateTempFileName(const wxString
& prefix
,
996 return wxCreateTempImpl(prefix
, WXFILEARGS(NULL
, fileTemp
), deleteOnClose
);
999 bool wxCreateTempFile(const wxString
& prefix
,
1003 return wxCreateTempImpl(prefix
, WXFILEARGS(NULL
, fileTemp
), name
);
1007 void wxFileName::AssignTempFileName(const wxString
& prefix
, wxFFile
*fileTemp
)
1009 wxAssignTempImpl(this, prefix
, WXFILEARGS(NULL
, fileTemp
));
1014 wxFileName::CreateTempFileName(const wxString
& prefix
, wxFFile
*fileTemp
)
1016 return wxCreateTempFileName(prefix
, fileTemp
);
1019 #endif // wxUSE_FFILE
1022 // ----------------------------------------------------------------------------
1023 // directory operations
1024 // ----------------------------------------------------------------------------
1026 wxString
wxFileName::GetTempDir()
1029 dir
= wxGetenv(_T("TMPDIR"));
1032 dir
= wxGetenv(_T("TMP"));
1035 dir
= wxGetenv(_T("TEMP"));
1039 #if defined(__WXWINCE__)
1042 // FIXME. Create \temp dir?
1043 if (DirExists(wxT("\\temp")))
1044 dir
= wxT("\\temp");
1046 #elif defined(__WINDOWS__) && !defined(__WXMICROWIN__)
1050 if ( !::GetTempPath(MAX_PATH
, wxStringBuffer(dir
, MAX_PATH
+ 1)) )
1052 wxLogLastError(_T("GetTempPath"));
1057 // GetTempFileName() fails if we pass it an empty string
1066 #if defined(__DOS__) || defined(__OS2__)
1068 #elif defined(__WXMAC__)
1069 dir
= wxMacFindFolder(short(kOnSystemDisk
), kTemporaryFolderType
, kCreateFolder
);
1079 bool wxFileName::Mkdir( int perm
, int flags
)
1081 return wxFileName::Mkdir(GetPath(), perm
, flags
);
1084 bool wxFileName::Mkdir( const wxString
& dir
, int perm
, int flags
)
1086 if ( flags
& wxPATH_MKDIR_FULL
)
1088 // split the path in components
1089 wxFileName filename
;
1090 filename
.AssignDir(dir
);
1093 if ( filename
.HasVolume())
1095 currPath
<< wxGetVolumeString(filename
.GetVolume(), wxPATH_NATIVE
);
1098 wxArrayString dirs
= filename
.GetDirs();
1099 size_t count
= dirs
.GetCount();
1100 for ( size_t i
= 0; i
< count
; i
++ )
1103 #if defined(__WXMAC__) && !defined(__DARWIN__)
1104 // relative pathnames are exactely the other way round under mac...
1105 !filename
.IsAbsolute()
1107 filename
.IsAbsolute()
1110 currPath
+= wxFILE_SEP_PATH
;
1111 currPath
+= dirs
[i
];
1113 if (!DirExists(currPath
))
1115 if (!wxMkdir(currPath
, perm
))
1117 // no need to try creating further directories
1127 return ::wxMkdir( dir
, perm
);
1130 bool wxFileName::Rmdir()
1132 return wxFileName::Rmdir( GetPath() );
1135 bool wxFileName::Rmdir( const wxString
&dir
)
1137 return ::wxRmdir( dir
);
1140 // ----------------------------------------------------------------------------
1141 // path normalization
1142 // ----------------------------------------------------------------------------
1144 bool wxFileName::Normalize(int flags
,
1145 const wxString
& cwd
,
1146 wxPathFormat format
)
1148 // deal with env vars renaming first as this may seriously change the path
1149 if ( flags
& wxPATH_NORM_ENV_VARS
)
1151 wxString pathOrig
= GetFullPath(format
);
1152 wxString path
= wxExpandEnvVars(pathOrig
);
1153 if ( path
!= pathOrig
)
1160 // the existing path components
1161 wxArrayString dirs
= GetDirs();
1163 // the path to prepend in front to make the path absolute
1166 format
= GetFormat(format
);
1168 // set up the directory to use for making the path absolute later
1169 if ( (flags
& wxPATH_NORM_ABSOLUTE
) && !IsAbsolute(format
) )
1173 curDir
.AssignCwd(GetVolume());
1175 else // cwd provided
1177 curDir
.AssignDir(cwd
);
1181 // handle ~ stuff under Unix only
1182 if ( (format
== wxPATH_UNIX
) && (flags
& wxPATH_NORM_TILDE
) )
1184 if ( !dirs
.IsEmpty() )
1186 wxString dir
= dirs
[0u];
1187 if ( !dir
.empty() && dir
[0u] == _T('~') )
1189 // to make the path absolute use the home directory
1190 curDir
.AssignDir(wxGetUserHome(dir
.c_str() + 1));
1192 // if we are expanding the tilde, then this path
1193 // *should* be already relative (since we checked for
1194 // the tilde only in the first char of the first dir);
1195 // if m_relative==false, it's because it was initialized
1196 // from a string which started with /~; in that case
1197 // we reach this point but then need m_relative=true
1198 // for relative->absolute expansion later
1206 // transform relative path into abs one
1207 if ( curDir
.IsOk() )
1209 // this path may be relative because it doesn't have the volume name
1210 // and still have m_relative=true; in this case we shouldn't modify
1211 // our directory components but just set the current volume
1212 if ( !HasVolume() && curDir
.HasVolume() )
1214 SetVolume(curDir
.GetVolume());
1218 // yes, it was the case - we don't need curDir then
1223 // finally, prepend curDir to the dirs array
1224 wxArrayString dirsNew
= curDir
.GetDirs();
1225 WX_PREPEND_ARRAY(dirs
, dirsNew
);
1227 // if we used e.g. tilde expansion previously and wxGetUserHome didn't
1228 // return for some reason an absolute path, then curDir maybe not be absolute!
1229 if ( curDir
.IsAbsolute(format
) )
1231 // we have prepended an absolute path and thus we are now an absolute
1235 // else if (flags & wxPATH_NORM_ABSOLUTE):
1236 // should we warn the user that we didn't manage to make the path absolute?
1239 // now deal with ".", ".." and the rest
1241 size_t count
= dirs
.GetCount();
1242 for ( size_t n
= 0; n
< count
; n
++ )
1244 wxString dir
= dirs
[n
];
1246 if ( flags
& wxPATH_NORM_DOTS
)
1248 if ( dir
== wxT(".") )
1254 if ( dir
== wxT("..") )
1256 if ( m_dirs
.IsEmpty() )
1258 wxLogError(_("The path '%s' contains too many \"..\"!"),
1259 GetFullPath().c_str());
1263 m_dirs
.RemoveAt(m_dirs
.GetCount() - 1);
1268 if ( (flags
& wxPATH_NORM_CASE
) && !IsCaseSensitive(format
) )
1276 #if defined(__WIN32__) && !defined(__WXWINCE__) && wxUSE_OLE
1277 if ( (flags
& wxPATH_NORM_SHORTCUT
) )
1280 if (GetShortcutTarget(GetFullPath(format
), filename
))
1282 // Repeat this since we may now have a new path
1283 if ( (flags
& wxPATH_NORM_CASE
) && !IsCaseSensitive(format
) )
1285 filename
.MakeLower();
1293 if ( (flags
& wxPATH_NORM_CASE
) && !IsCaseSensitive(format
) )
1295 // VZ: expand env vars here too?
1297 m_volume
.MakeLower();
1302 #if defined(__WIN32__)
1303 if ( (flags
& wxPATH_NORM_LONG
) && (format
== wxPATH_DOS
) )
1305 Assign(GetLongPath());
1312 // ----------------------------------------------------------------------------
1313 // get the shortcut target
1314 // ----------------------------------------------------------------------------
1316 // WinCE (3) doesn't have CLSID_ShellLink, IID_IShellLink definitions.
1317 // The .lnk file is a plain text file so it should be easy to
1318 // make it work. Hint from Google Groups:
1319 // "If you open up a lnk file, you'll see a
1320 // number, followed by a pound sign (#), followed by more text. The
1321 // number is the number of characters that follows the pound sign. The
1322 // characters after the pound sign are the command line (which _can_
1323 // include arguments) to be executed. Any path (e.g. \windows\program
1324 // files\myapp.exe) that includes spaces needs to be enclosed in
1325 // quotation marks."
1327 #if defined(__WIN32__) && !defined(__WXWINCE__) && wxUSE_OLE
1328 // The following lines are necessary under WinCE
1329 // #include "wx/msw/private.h"
1330 // #include <ole2.h>
1332 #if defined(__WXWINCE__)
1333 #include <shlguid.h>
1336 bool wxFileName::GetShortcutTarget(const wxString
& shortcutPath
,
1337 wxString
& targetFilename
,
1338 wxString
* arguments
)
1340 wxString path
, file
, ext
;
1341 wxSplitPath(shortcutPath
, & path
, & file
, & ext
);
1345 bool success
= false;
1347 // Assume it's not a shortcut if it doesn't end with lnk
1348 if (ext
.CmpNoCase(wxT("lnk"))!=0)
1351 // create a ShellLink object
1352 hres
= CoCreateInstance(CLSID_ShellLink
, NULL
, CLSCTX_INPROC_SERVER
,
1353 IID_IShellLink
, (LPVOID
*) &psl
);
1355 if (SUCCEEDED(hres
))
1358 hres
= psl
->QueryInterface( IID_IPersistFile
, (LPVOID
*) &ppf
);
1359 if (SUCCEEDED(hres
))
1361 WCHAR wsz
[MAX_PATH
];
1363 MultiByteToWideChar(CP_ACP
, MB_PRECOMPOSED
, shortcutPath
.mb_str(), -1, wsz
,
1366 hres
= ppf
->Load(wsz
, 0);
1369 if (SUCCEEDED(hres
))
1372 // Wrong prototype in early versions
1373 #if defined(__MINGW32__) && !wxCHECK_W32API_VERSION(2, 2)
1374 psl
->GetPath((CHAR
*) buf
, 2048, NULL
, SLGP_UNCPRIORITY
);
1376 psl
->GetPath(buf
, 2048, NULL
, SLGP_UNCPRIORITY
);
1378 targetFilename
= wxString(buf
);
1379 success
= (shortcutPath
!= targetFilename
);
1381 psl
->GetArguments(buf
, 2048);
1383 if (!args
.empty() && arguments
)
1395 #endif // __WIN32__ && !__WXWINCE__
1398 // ----------------------------------------------------------------------------
1399 // absolute/relative paths
1400 // ----------------------------------------------------------------------------
1402 bool wxFileName::IsAbsolute(wxPathFormat format
) const
1404 // if our path doesn't start with a path separator, it's not an absolute
1409 if ( !GetVolumeSeparator(format
).empty() )
1411 // this format has volumes and an absolute path must have one, it's not
1412 // enough to have the full path to bean absolute file under Windows
1413 if ( GetVolume().empty() )
1420 bool wxFileName::MakeRelativeTo(const wxString
& pathBase
, wxPathFormat format
)
1422 wxFileName fnBase
= wxFileName::DirName(pathBase
, format
);
1424 // get cwd only once - small time saving
1425 wxString cwd
= wxGetCwd();
1426 Normalize(wxPATH_NORM_ALL
& ~wxPATH_NORM_CASE
, cwd
, format
);
1427 fnBase
.Normalize(wxPATH_NORM_ALL
& ~wxPATH_NORM_CASE
, cwd
, format
);
1429 bool withCase
= IsCaseSensitive(format
);
1431 // we can't do anything if the files live on different volumes
1432 if ( !GetVolume().IsSameAs(fnBase
.GetVolume(), withCase
) )
1438 // same drive, so we don't need our volume
1441 // remove common directories starting at the top
1442 while ( !m_dirs
.IsEmpty() && !fnBase
.m_dirs
.IsEmpty() &&
1443 m_dirs
[0u].IsSameAs(fnBase
.m_dirs
[0u], withCase
) )
1446 fnBase
.m_dirs
.RemoveAt(0);
1449 // add as many ".." as needed
1450 size_t count
= fnBase
.m_dirs
.GetCount();
1451 for ( size_t i
= 0; i
< count
; i
++ )
1453 m_dirs
.Insert(wxT(".."), 0u);
1456 if ( format
== wxPATH_UNIX
|| format
== wxPATH_DOS
)
1458 // a directory made relative with respect to itself is '.' under Unix
1459 // and DOS, by definition (but we don't have to insert "./" for the
1461 if ( m_dirs
.IsEmpty() && IsDir() )
1463 m_dirs
.Add(_T('.'));
1473 // ----------------------------------------------------------------------------
1474 // filename kind tests
1475 // ----------------------------------------------------------------------------
1477 bool wxFileName::SameAs(const wxFileName
& filepath
, wxPathFormat format
) const
1479 wxFileName fn1
= *this,
1482 // get cwd only once - small time saving
1483 wxString cwd
= wxGetCwd();
1484 fn1
.Normalize(wxPATH_NORM_ALL
| wxPATH_NORM_CASE
, cwd
, format
);
1485 fn2
.Normalize(wxPATH_NORM_ALL
| wxPATH_NORM_CASE
, cwd
, format
);
1487 if ( fn1
.GetFullPath() == fn2
.GetFullPath() )
1490 // TODO: compare inodes for Unix, this works even when filenames are
1491 // different but files are the same (symlinks) (VZ)
1497 bool wxFileName::IsCaseSensitive( wxPathFormat format
)
1499 // only Unix filenames are truely case-sensitive
1500 return GetFormat(format
) == wxPATH_UNIX
;
1504 wxString
wxFileName::GetForbiddenChars(wxPathFormat format
)
1506 // Inits to forbidden characters that are common to (almost) all platforms.
1507 wxString strForbiddenChars
= wxT("*?");
1509 // If asserts, wxPathFormat has been changed. In case of a new path format
1510 // addition, the following code might have to be updated.
1511 wxCOMPILE_TIME_ASSERT(wxPATH_MAX
== 5, wxPathFormatChanged
);
1512 switch ( GetFormat(format
) )
1515 wxFAIL_MSG( wxT("Unknown path format") );
1516 // !! Fall through !!
1522 // On a Mac even names with * and ? are allowed (Tested with OS
1523 // 9.2.1 and OS X 10.2.5)
1524 strForbiddenChars
= wxEmptyString
;
1528 strForbiddenChars
+= wxT("\\/:\"<>|");
1535 return strForbiddenChars
;
1539 wxString
wxFileName::GetVolumeSeparator(wxPathFormat
WXUNUSED_IN_WINCE(format
))
1542 return wxEmptyString
;
1546 if ( (GetFormat(format
) == wxPATH_DOS
) ||
1547 (GetFormat(format
) == wxPATH_VMS
) )
1549 sepVol
= wxFILE_SEP_DSK
;
1558 wxString
wxFileName::GetPathSeparators(wxPathFormat format
)
1561 switch ( GetFormat(format
) )
1564 // accept both as native APIs do but put the native one first as
1565 // this is the one we use in GetFullPath()
1566 seps
<< wxFILE_SEP_PATH_DOS
<< wxFILE_SEP_PATH_UNIX
;
1570 wxFAIL_MSG( _T("Unknown wxPATH_XXX style") );
1574 seps
= wxFILE_SEP_PATH_UNIX
;
1578 seps
= wxFILE_SEP_PATH_MAC
;
1582 seps
= wxFILE_SEP_PATH_VMS
;
1590 wxString
wxFileName::GetPathTerminators(wxPathFormat format
)
1592 format
= GetFormat(format
);
1594 // under VMS the end of the path is ']', not the path separator used to
1595 // separate the components
1596 return format
== wxPATH_VMS
? wxString(_T(']')) : GetPathSeparators(format
);
1600 bool wxFileName::IsPathSeparator(wxChar ch
, wxPathFormat format
)
1602 // wxString::Find() doesn't work as expected with NUL - it will always find
1603 // it, so test for it separately
1604 return ch
!= _T('\0') && GetPathSeparators(format
).Find(ch
) != wxNOT_FOUND
;
1607 // ----------------------------------------------------------------------------
1608 // path components manipulation
1609 // ----------------------------------------------------------------------------
1611 /* static */ bool wxFileName::IsValidDirComponent(const wxString
& dir
)
1615 wxFAIL_MSG( _T("empty directory passed to wxFileName::InsertDir()") );
1620 const size_t len
= dir
.length();
1621 for ( size_t n
= 0; n
< len
; n
++ )
1623 if ( dir
[n
] == GetVolumeSeparator() || IsPathSeparator(dir
[n
]) )
1625 wxFAIL_MSG( _T("invalid directory component in wxFileName") );
1634 void wxFileName::AppendDir( const wxString
& dir
)
1636 if ( IsValidDirComponent(dir
) )
1640 void wxFileName::PrependDir( const wxString
& dir
)
1645 void wxFileName::InsertDir(size_t before
, const wxString
& dir
)
1647 if ( IsValidDirComponent(dir
) )
1648 m_dirs
.Insert(dir
, before
);
1651 void wxFileName::RemoveDir(size_t pos
)
1653 m_dirs
.RemoveAt(pos
);
1656 // ----------------------------------------------------------------------------
1658 // ----------------------------------------------------------------------------
1660 void wxFileName::SetFullName(const wxString
& fullname
)
1662 SplitPath(fullname
, NULL
/* no volume */, NULL
/* no path */,
1663 &m_name
, &m_ext
, &m_hasExt
);
1666 wxString
wxFileName::GetFullName() const
1668 wxString fullname
= m_name
;
1671 fullname
<< wxFILE_SEP_EXT
<< m_ext
;
1677 wxString
wxFileName::GetPath( int flags
, wxPathFormat format
) const
1679 format
= GetFormat( format
);
1683 // return the volume with the path as well if requested
1684 if ( flags
& wxPATH_GET_VOLUME
)
1686 fullpath
+= wxGetVolumeString(GetVolume(), format
);
1689 // the leading character
1694 fullpath
+= wxFILE_SEP_PATH_MAC
;
1699 fullpath
+= wxFILE_SEP_PATH_DOS
;
1703 wxFAIL_MSG( wxT("Unknown path format") );
1709 // normally the absolute file names start with a slash
1710 // with one exception: the ones like "~/foo.bar" don't
1712 if ( m_dirs
.IsEmpty() || m_dirs
[0u] != _T('~') )
1714 fullpath
+= wxFILE_SEP_PATH_UNIX
;
1720 // no leading character here but use this place to unset
1721 // wxPATH_GET_SEPARATOR flag: under VMS it doesn't make sense
1722 // as, if I understand correctly, there should never be a dot
1723 // before the closing bracket
1724 flags
&= ~wxPATH_GET_SEPARATOR
;
1727 if ( m_dirs
.empty() )
1729 // there is nothing more
1733 // then concatenate all the path components using the path separator
1734 if ( format
== wxPATH_VMS
)
1736 fullpath
+= wxT('[');
1739 const size_t dirCount
= m_dirs
.GetCount();
1740 for ( size_t i
= 0; i
< dirCount
; i
++ )
1745 if ( m_dirs
[i
] == wxT(".") )
1747 // skip appending ':', this shouldn't be done in this
1748 // case as "::" is interpreted as ".." under Unix
1752 // convert back from ".." to nothing
1753 if ( !m_dirs
[i
].IsSameAs(wxT("..")) )
1754 fullpath
+= m_dirs
[i
];
1758 wxFAIL_MSG( wxT("Unexpected path format") );
1759 // still fall through
1763 fullpath
+= m_dirs
[i
];
1767 // TODO: What to do with ".." under VMS
1769 // convert back from ".." to nothing
1770 if ( !m_dirs
[i
].IsSameAs(wxT("..")) )
1771 fullpath
+= m_dirs
[i
];
1775 if ( (flags
& wxPATH_GET_SEPARATOR
) || (i
!= dirCount
- 1) )
1776 fullpath
+= GetPathSeparator(format
);
1779 if ( format
== wxPATH_VMS
)
1781 fullpath
+= wxT(']');
1787 wxString
wxFileName::GetFullPath( wxPathFormat format
) const
1789 // we already have a function to get the path
1790 wxString fullpath
= GetPath(wxPATH_GET_VOLUME
| wxPATH_GET_SEPARATOR
,
1793 // now just add the file name and extension to it
1794 fullpath
+= GetFullName();
1799 // Return the short form of the path (returns identity on non-Windows platforms)
1800 wxString
wxFileName::GetShortPath() const
1802 wxString
path(GetFullPath());
1804 #if defined(__WXMSW__) && defined(__WIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
1805 DWORD sz
= ::GetShortPathName(path
, NULL
, 0);
1809 if ( ::GetShortPathName
1812 wxStringBuffer(pathOut
, sz
),
1824 // Return the long form of the path (returns identity on non-Windows platforms)
1825 wxString
wxFileName::GetLongPath() const
1828 path
= GetFullPath();
1830 #if defined(__WIN32__) && !defined(__WXWINCE__) && !defined(__WXMICROWIN__)
1832 #if wxUSE_DYNAMIC_LOADER
1833 typedef DWORD (WINAPI
*GET_LONG_PATH_NAME
)(const wxChar
*, wxChar
*, DWORD
);
1835 // this is MT-safe as in the worst case we're going to resolve the function
1836 // twice -- but as the result is the same in both threads, it's ok
1837 static GET_LONG_PATH_NAME s_pfnGetLongPathName
= NULL
;
1838 if ( !s_pfnGetLongPathName
)
1840 static bool s_triedToLoad
= false;
1842 if ( !s_triedToLoad
)
1844 s_triedToLoad
= true;
1846 wxDynamicLibrary
dllKernel(_T("kernel32"));
1848 const wxChar
* GetLongPathName
= _T("GetLongPathName")
1853 #endif // Unicode/ANSI
1855 if ( dllKernel
.HasSymbol(GetLongPathName
) )
1857 s_pfnGetLongPathName
= (GET_LONG_PATH_NAME
)
1858 dllKernel
.GetSymbol(GetLongPathName
);
1861 // note that kernel32.dll can be unloaded, it stays in memory
1862 // anyhow as all Win32 programs link to it and so it's safe to call
1863 // GetLongPathName() even after unloading it
1867 if ( s_pfnGetLongPathName
)
1869 DWORD dwSize
= (*s_pfnGetLongPathName
)(path
, NULL
, 0);
1872 if ( (*s_pfnGetLongPathName
)
1875 wxStringBuffer(pathOut
, dwSize
),
1883 #endif // wxUSE_DYNAMIC_LOADER
1885 // The OS didn't support GetLongPathName, or some other error.
1886 // We need to call FindFirstFile on each component in turn.
1888 WIN32_FIND_DATA findFileData
;
1892 pathOut
= GetVolume() +
1893 GetVolumeSeparator(wxPATH_DOS
) +
1894 GetPathSeparator(wxPATH_DOS
);
1896 pathOut
= wxEmptyString
;
1898 wxArrayString dirs
= GetDirs();
1899 dirs
.Add(GetFullName());
1903 size_t count
= dirs
.GetCount();
1904 for ( size_t i
= 0; i
< count
; i
++ )
1906 // We're using pathOut to collect the long-name path, but using a
1907 // temporary for appending the last path component which may be
1909 tmpPath
= pathOut
+ dirs
[i
];
1911 if ( tmpPath
.empty() )
1914 // can't see this being necessary? MF
1915 if ( tmpPath
.Last() == GetVolumeSeparator(wxPATH_DOS
) )
1917 // Can't pass a drive and root dir to FindFirstFile,
1918 // so continue to next dir
1919 tmpPath
+= wxFILE_SEP_PATH
;
1924 hFind
= ::FindFirstFile(tmpPath
, &findFileData
);
1925 if (hFind
== INVALID_HANDLE_VALUE
)
1927 // Error: most likely reason is that path doesn't exist, so
1928 // append any unprocessed parts and return
1929 for ( i
+= 1; i
< count
; i
++ )
1930 tmpPath
+= wxFILE_SEP_PATH
+ dirs
[i
];
1935 pathOut
+= findFileData
.cFileName
;
1936 if ( (i
< (count
-1)) )
1937 pathOut
+= wxFILE_SEP_PATH
;
1943 #endif // Win32/!Win32
1948 wxPathFormat
wxFileName::GetFormat( wxPathFormat format
)
1950 if (format
== wxPATH_NATIVE
)
1952 #if defined(__WXMSW__) || defined(__OS2__) || defined(__DOS__)
1953 format
= wxPATH_DOS
;
1954 #elif defined(__WXMAC__) && !defined(__DARWIN__)
1955 format
= wxPATH_MAC
;
1956 #elif defined(__VMS)
1957 format
= wxPATH_VMS
;
1959 format
= wxPATH_UNIX
;
1965 // ----------------------------------------------------------------------------
1966 // path splitting function
1967 // ----------------------------------------------------------------------------
1971 wxFileName::SplitVolume(const wxString
& fullpathWithVolume
,
1972 wxString
*pstrVolume
,
1974 wxPathFormat format
)
1976 format
= GetFormat(format
);
1978 wxString fullpath
= fullpathWithVolume
;
1980 // special Windows UNC paths hack: transform \\share\path into share:path
1981 if ( IsUNCPath(fullpath
, format
) )
1983 fullpath
.erase(0, 2);
1985 size_t posFirstSlash
=
1986 fullpath
.find_first_of(GetPathTerminators(format
));
1987 if ( posFirstSlash
!= wxString::npos
)
1989 fullpath
[posFirstSlash
] = wxFILE_SEP_DSK
;
1991 // UNC paths are always absolute, right? (FIXME)
1992 fullpath
.insert(posFirstSlash
+ 1, 1, wxFILE_SEP_PATH_DOS
);
1996 // We separate the volume here
1997 if ( format
== wxPATH_DOS
|| format
== wxPATH_VMS
)
1999 wxString sepVol
= GetVolumeSeparator(format
);
2001 size_t posFirstColon
= fullpath
.find_first_of(sepVol
);
2002 if ( posFirstColon
!= wxString::npos
)
2006 *pstrVolume
= fullpath
.Left(posFirstColon
);
2009 // remove the volume name and the separator from the full path
2010 fullpath
.erase(0, posFirstColon
+ sepVol
.length());
2015 *pstrPath
= fullpath
;
2019 void wxFileName::SplitPath(const wxString
& fullpathWithVolume
,
2020 wxString
*pstrVolume
,
2025 wxPathFormat format
)
2027 format
= GetFormat(format
);
2030 SplitVolume(fullpathWithVolume
, pstrVolume
, &fullpath
, format
);
2032 // find the positions of the last dot and last path separator in the path
2033 size_t posLastDot
= fullpath
.find_last_of(wxFILE_SEP_EXT
);
2034 size_t posLastSlash
= fullpath
.find_last_of(GetPathTerminators(format
));
2036 // check whether this dot occurs at the very beginning of a path component
2037 if ( (posLastDot
!= wxString::npos
) &&
2039 IsPathSeparator(fullpath
[posLastDot
- 1]) ||
2040 (format
== wxPATH_VMS
&& fullpath
[posLastDot
- 1] == _T(']'))) )
2042 // dot may be (and commonly -- at least under Unix -- is) the first
2043 // character of the filename, don't treat the entire filename as
2044 // extension in this case
2045 posLastDot
= wxString::npos
;
2048 // if we do have a dot and a slash, check that the dot is in the name part
2049 if ( (posLastDot
!= wxString::npos
) &&
2050 (posLastSlash
!= wxString::npos
) &&
2051 (posLastDot
< posLastSlash
) )
2053 // the dot is part of the path, not the start of the extension
2054 posLastDot
= wxString::npos
;
2057 // now fill in the variables provided by user
2060 if ( posLastSlash
== wxString::npos
)
2067 // take everything up to the path separator but take care to make
2068 // the path equal to something like '/', not empty, for the files
2069 // immediately under root directory
2070 size_t len
= posLastSlash
;
2072 // this rule does not apply to mac since we do not start with colons (sep)
2073 // except for relative paths
2074 if ( !len
&& format
!= wxPATH_MAC
)
2077 *pstrPath
= fullpath
.Left(len
);
2079 // special VMS hack: remove the initial bracket
2080 if ( format
== wxPATH_VMS
)
2082 if ( (*pstrPath
)[0u] == _T('[') )
2083 pstrPath
->erase(0, 1);
2090 // take all characters starting from the one after the last slash and
2091 // up to, but excluding, the last dot
2092 size_t nStart
= posLastSlash
== wxString::npos
? 0 : posLastSlash
+ 1;
2094 if ( posLastDot
== wxString::npos
)
2096 // take all until the end
2097 count
= wxString::npos
;
2099 else if ( posLastSlash
== wxString::npos
)
2103 else // have both dot and slash
2105 count
= posLastDot
- posLastSlash
- 1;
2108 *pstrName
= fullpath
.Mid(nStart
, count
);
2111 // finally deal with the extension here: we have an added complication that
2112 // extension may be empty (but present) as in "foo." where trailing dot
2113 // indicates the empty extension at the end -- and hence we must remember
2114 // that we have it independently of pstrExt
2115 if ( posLastDot
== wxString::npos
)
2125 // take everything after the dot
2127 *pstrExt
= fullpath
.Mid(posLastDot
+ 1);
2134 void wxFileName::SplitPath(const wxString
& fullpath
,
2138 wxPathFormat format
)
2141 SplitPath(fullpath
, &volume
, path
, name
, ext
, format
);
2145 path
->Prepend(wxGetVolumeString(volume
, format
));
2149 // ----------------------------------------------------------------------------
2151 // ----------------------------------------------------------------------------
2155 bool wxFileName::SetTimes(const wxDateTime
*dtAccess
,
2156 const wxDateTime
*dtMod
,
2157 const wxDateTime
*dtCreate
)
2159 #if defined(__WIN32__)
2162 // VZ: please let me know how to do this if you can
2163 wxFAIL_MSG( _T("SetTimes() not implemented for the directories") );
2167 wxFileHandle
fh(GetFullPath(), wxFileHandle::Write
);
2170 FILETIME ftAccess
, ftCreate
, ftWrite
;
2173 ConvertWxToFileTime(&ftCreate
, *dtCreate
);
2175 ConvertWxToFileTime(&ftAccess
, *dtAccess
);
2177 ConvertWxToFileTime(&ftWrite
, *dtMod
);
2179 if ( ::SetFileTime(fh
,
2180 dtCreate
? &ftCreate
: NULL
,
2181 dtAccess
? &ftAccess
: NULL
,
2182 dtMod
? &ftWrite
: NULL
) )
2188 #elif defined(__UNIX_LIKE__) || (defined(__DOS__) && defined(__WATCOMC__))
2189 wxUnusedVar(dtCreate
);
2191 if ( !dtAccess
&& !dtMod
)
2193 // can't modify the creation time anyhow, don't try
2197 // if dtAccess or dtMod is not specified, use the other one (which must be
2198 // non NULL because of the test above) for both times
2200 utm
.actime
= dtAccess
? dtAccess
->GetTicks() : dtMod
->GetTicks();
2201 utm
.modtime
= dtMod
? dtMod
->GetTicks() : dtAccess
->GetTicks();
2202 if ( utime(GetFullPath().fn_str(), &utm
) == 0 )
2206 #else // other platform
2207 wxUnusedVar(dtAccess
);
2209 wxUnusedVar(dtCreate
);
2212 wxLogSysError(_("Failed to modify file times for '%s'"),
2213 GetFullPath().c_str());
2218 bool wxFileName::Touch()
2220 #if defined(__UNIX_LIKE__)
2221 // under Unix touching file is simple: just pass NULL to utime()
2222 if ( utime(GetFullPath().fn_str(), NULL
) == 0 )
2227 wxLogSysError(_("Failed to touch the file '%s'"), GetFullPath().c_str());
2230 #else // other platform
2231 wxDateTime dtNow
= wxDateTime::Now();
2233 return SetTimes(&dtNow
, &dtNow
, NULL
/* don't change create time */);
2237 bool wxFileName::GetTimes(wxDateTime
*dtAccess
,
2239 wxDateTime
*dtCreate
) const
2241 #if defined(__WIN32__)
2242 // we must use different methods for the files and directories under
2243 // Windows as CreateFile(GENERIC_READ) doesn't work for the directories and
2244 // CreateFile(FILE_FLAG_BACKUP_SEMANTICS) works -- but only under NT and
2247 FILETIME ftAccess
, ftCreate
, ftWrite
;
2250 // implemented in msw/dir.cpp
2251 extern bool wxGetDirectoryTimes(const wxString
& dirname
,
2252 FILETIME
*, FILETIME
*, FILETIME
*);
2254 // we should pass the path without the trailing separator to
2255 // wxGetDirectoryTimes()
2256 ok
= wxGetDirectoryTimes(GetPath(wxPATH_GET_VOLUME
),
2257 &ftAccess
, &ftCreate
, &ftWrite
);
2261 wxFileHandle
fh(GetFullPath(), wxFileHandle::Read
);
2264 ok
= ::GetFileTime(fh
,
2265 dtCreate
? &ftCreate
: NULL
,
2266 dtAccess
? &ftAccess
: NULL
,
2267 dtMod
? &ftWrite
: NULL
) != 0;
2278 ConvertFileTimeToWx(dtCreate
, ftCreate
);
2280 ConvertFileTimeToWx(dtAccess
, ftAccess
);
2282 ConvertFileTimeToWx(dtMod
, ftWrite
);
2286 #elif defined(__UNIX_LIKE__) || defined(__WXMAC__) || defined(__OS2__) || (defined(__DOS__) && defined(__WATCOMC__))
2287 // no need to test for IsDir() here
2289 if ( wxStat( GetFullPath().c_str(), &stBuf
) == 0 )
2292 dtAccess
->Set(stBuf
.st_atime
);
2294 dtMod
->Set(stBuf
.st_mtime
);
2296 dtCreate
->Set(stBuf
.st_ctime
);
2300 #else // other platform
2301 wxUnusedVar(dtAccess
);
2303 wxUnusedVar(dtCreate
);
2306 wxLogSysError(_("Failed to retrieve file times for '%s'"),
2307 GetFullPath().c_str());
2312 #endif // wxUSE_DATETIME
2315 // ----------------------------------------------------------------------------
2316 // file size functions
2317 // ----------------------------------------------------------------------------
2320 wxULongLong
wxFileName::GetSize(const wxString
&filename
)
2322 if (!wxFileExists(filename
))
2323 return wxInvalidSize
;
2325 #if defined(__WXPALMOS__)
2327 return wxInvalidSize
;
2328 #elif defined(__WIN32__)
2329 wxFileHandle
f(filename
, wxFileHandle::Read
);
2331 return wxInvalidSize
;
2333 DWORD lpFileSizeHigh
;
2334 DWORD ret
= GetFileSize(f
, &lpFileSizeHigh
);
2335 if ( ret
== INVALID_FILE_SIZE
&& ::GetLastError() != NO_ERROR
)
2336 return wxInvalidSize
;
2338 return wxULongLong(lpFileSizeHigh
, ret
);
2339 #else // ! __WIN32__
2341 #ifndef wxNEED_WX_UNISTD_H
2342 if (wxStat( filename
.fn_str() , &st
) != 0)
2344 if (wxStat( filename
, &st
) != 0)
2346 return wxInvalidSize
;
2347 return wxULongLong(st
.st_size
);
2352 wxString
wxFileName::GetHumanReadableSize(const wxULongLong
&bs
,
2353 const wxString
&nullsize
,
2356 static const double KILOBYTESIZE
= 1024.0;
2357 static const double MEGABYTESIZE
= 1024.0*KILOBYTESIZE
;
2358 static const double GIGABYTESIZE
= 1024.0*MEGABYTESIZE
;
2359 static const double TERABYTESIZE
= 1024.0*GIGABYTESIZE
;
2361 if (bs
== 0 || bs
== wxInvalidSize
)
2364 double bytesize
= bs
.ToDouble();
2365 if (bytesize
< KILOBYTESIZE
)
2366 return wxString::Format(_("%s B"), bs
.ToString().c_str());
2367 if (bytesize
< MEGABYTESIZE
)
2368 return wxString::Format(_("%.*f kB"), precision
, bytesize
/KILOBYTESIZE
);
2369 if (bytesize
< GIGABYTESIZE
)
2370 return wxString::Format(_("%.*f MB"), precision
, bytesize
/MEGABYTESIZE
);
2371 if (bytesize
< TERABYTESIZE
)
2372 return wxString::Format(_("%.*f GB"), precision
, bytesize
/GIGABYTESIZE
);
2374 return wxString::Format(_("%.*f TB"), precision
, bytesize
/TERABYTESIZE
);
2377 wxULongLong
wxFileName::GetSize() const
2379 return GetSize(GetFullPath());
2382 wxString
wxFileName::GetHumanReadableSize(const wxString
&failmsg
, int precision
) const
2384 return GetHumanReadableSize(GetSize(), failmsg
, precision
);
2388 // ----------------------------------------------------------------------------
2389 // Mac-specific functions
2390 // ----------------------------------------------------------------------------
2394 const short kMacExtensionMaxLength
= 16 ;
2395 class MacDefaultExtensionRecord
2398 MacDefaultExtensionRecord()
2401 m_type
= m_creator
= 0 ;
2403 MacDefaultExtensionRecord( const MacDefaultExtensionRecord
& from
)
2405 wxStrcpy( m_ext
, from
.m_ext
) ;
2406 m_type
= from
.m_type
;
2407 m_creator
= from
.m_creator
;
2409 MacDefaultExtensionRecord( const wxChar
* extension
, OSType type
, OSType creator
)
2411 wxStrncpy( m_ext
, extension
, kMacExtensionMaxLength
) ;
2412 m_ext
[kMacExtensionMaxLength
] = 0 ;
2414 m_creator
= creator
;
2416 wxChar m_ext
[kMacExtensionMaxLength
] ;
2421 WX_DECLARE_OBJARRAY(MacDefaultExtensionRecord
, MacDefaultExtensionArray
) ;
2423 bool gMacDefaultExtensionsInited
= false ;
2425 #include "wx/arrimpl.cpp"
2427 WX_DEFINE_EXPORTED_OBJARRAY(MacDefaultExtensionArray
) ;
2429 MacDefaultExtensionArray gMacDefaultExtensions
;
2431 // load the default extensions
2432 MacDefaultExtensionRecord gDefaults
[] =
2434 MacDefaultExtensionRecord( wxT("txt") , 'TEXT' , 'ttxt' ) ,
2435 MacDefaultExtensionRecord( wxT("tif") , 'TIFF' , '****' ) ,
2436 MacDefaultExtensionRecord( wxT("jpg") , 'JPEG' , '****' ) ,
2439 static void MacEnsureDefaultExtensionsLoaded()
2441 if ( !gMacDefaultExtensionsInited
)
2443 // we could load the pc exchange prefs here too
2444 for ( size_t i
= 0 ; i
< WXSIZEOF( gDefaults
) ; ++i
)
2446 gMacDefaultExtensions
.Add( gDefaults
[i
] ) ;
2448 gMacDefaultExtensionsInited
= true ;
2452 bool wxFileName::MacSetTypeAndCreator( wxUint32 type
, wxUint32 creator
)
2455 FSCatalogInfo catInfo
;
2458 if ( wxMacPathToFSRef( GetFullPath() , &fsRef
) == noErr
)
2460 if ( FSGetCatalogInfo (&fsRef
, kFSCatInfoFinderInfo
, &catInfo
, NULL
, NULL
, NULL
) == noErr
)
2462 finfo
= (FileInfo
*)&catInfo
.finderInfo
;
2463 finfo
->fileType
= type
;
2464 finfo
->fileCreator
= creator
;
2465 FSSetCatalogInfo( &fsRef
, kFSCatInfoFinderInfo
, &catInfo
) ;
2472 bool wxFileName::MacGetTypeAndCreator( wxUint32
*type
, wxUint32
*creator
)
2475 FSCatalogInfo catInfo
;
2478 if ( wxMacPathToFSRef( GetFullPath() , &fsRef
) == noErr
)
2480 if ( FSGetCatalogInfo (&fsRef
, kFSCatInfoFinderInfo
, &catInfo
, NULL
, NULL
, NULL
) == noErr
)
2482 finfo
= (FileInfo
*)&catInfo
.finderInfo
;
2483 *type
= finfo
->fileType
;
2484 *creator
= finfo
->fileCreator
;
2491 bool wxFileName::MacSetDefaultTypeAndCreator()
2493 wxUint32 type
, creator
;
2494 if ( wxFileName::MacFindDefaultTypeAndCreator(GetExt() , &type
,
2497 return MacSetTypeAndCreator( type
, creator
) ;
2502 bool wxFileName::MacFindDefaultTypeAndCreator( const wxString
& ext
, wxUint32
*type
, wxUint32
*creator
)
2504 MacEnsureDefaultExtensionsLoaded() ;
2505 wxString extl
= ext
.Lower() ;
2506 for( int i
= gMacDefaultExtensions
.Count() - 1 ; i
>= 0 ; --i
)
2508 if ( gMacDefaultExtensions
.Item(i
).m_ext
== extl
)
2510 *type
= gMacDefaultExtensions
.Item(i
).m_type
;
2511 *creator
= gMacDefaultExtensions
.Item(i
).m_creator
;
2518 void wxFileName::MacRegisterDefaultTypeAndCreator( const wxString
& ext
, wxUint32 type
, wxUint32 creator
)
2520 MacEnsureDefaultExtensionsLoaded() ;
2521 MacDefaultExtensionRecord rec
;
2523 rec
.m_creator
= creator
;
2524 wxStrncpy( rec
.m_ext
, ext
.Lower().c_str() , kMacExtensionMaxLength
) ;
2525 gMacDefaultExtensions
.Add( rec
) ;