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 license
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 specyfication
51 . separator between directory and subdirectory
52 ] between directory and file
55 // ============================================================================
57 // ============================================================================
59 // ----------------------------------------------------------------------------
61 // ----------------------------------------------------------------------------
64 #pragma implementation "filename.h"
67 // For compilers that support precompilation, includes "wx.h".
68 #include "wx/wxprec.h"
80 #include "wx/filename.h"
81 #include "wx/tokenzr.h"
82 #include "wx/config.h" // for wxExpandEnvVars
85 #include "wx/dynlib.h"
87 // For GetShort/LongPathName
90 #include "wx/msw/winundef.h"
93 #if defined(__WXMAC__)
94 #include "wx/mac/private.h" // includes mac headers
97 // utime() is POSIX so should normally be available on all Unices
99 #include <sys/types.h>
101 #include <sys/stat.h>
117 #include <sys/utime.h>
118 #include <sys/stat.h>
127 // ----------------------------------------------------------------------------
129 // ----------------------------------------------------------------------------
131 // small helper class which opens and closes the file - we use it just to get
132 // a file handle for the given file name to pass it to some Win32 API function
133 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
144 wxFileHandle(const wxString
& filename
, OpenMode mode
)
146 m_hFile
= ::CreateFile
149 mode
== Read
? GENERIC_READ
// access mask
152 NULL
, // no secutity attr
153 OPEN_EXISTING
, // creation disposition
155 NULL
// no template file
158 if ( m_hFile
== INVALID_HANDLE_VALUE
)
160 wxLogSysError(_("Failed to open '%s' for %s"),
162 mode
== Read
? _("reading") : _("writing"));
168 if ( m_hFile
!= INVALID_HANDLE_VALUE
)
170 if ( !::CloseHandle(m_hFile
) )
172 wxLogSysError(_("Failed to close file handle"));
177 // return TRUE only if the file could be opened successfully
178 bool IsOk() const { return m_hFile
!= INVALID_HANDLE_VALUE
; }
181 operator HANDLE() const { return m_hFile
; }
189 // ----------------------------------------------------------------------------
191 // ----------------------------------------------------------------------------
193 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
195 // convert between wxDateTime and FILETIME which is a 64-bit value representing
196 // the number of 100-nanosecond intervals since January 1, 1601.
198 static void ConvertFileTimeToWx(wxDateTime
*dt
, const FILETIME
&ft
)
200 FILETIME ftcopy
= ft
;
202 if ( !::FileTimeToLocalFileTime(&ftcopy
, &ftLocal
) )
204 wxLogLastError(_T("FileTimeToLocalFileTime"));
208 if ( !::FileTimeToSystemTime(&ftLocal
, &st
) )
210 wxLogLastError(_T("FileTimeToSystemTime"));
213 dt
->Set(st
.wDay
, wxDateTime::Month(st
.wMonth
- 1), st
.wYear
,
214 st
.wHour
, st
.wMinute
, st
.wSecond
, st
.wMilliseconds
);
217 static void ConvertWxToFileTime(FILETIME
*ft
, const wxDateTime
& dt
)
220 st
.wDay
= dt
.GetDay();
221 st
.wMonth
= dt
.GetMonth() + 1;
222 st
.wYear
= dt
.GetYear();
223 st
.wHour
= dt
.GetHour();
224 st
.wMinute
= dt
.GetMinute();
225 st
.wSecond
= dt
.GetSecond();
226 st
.wMilliseconds
= dt
.GetMillisecond();
229 if ( !::SystemTimeToFileTime(&st
, &ftLocal
) )
231 wxLogLastError(_T("SystemTimeToFileTime"));
234 if ( !::LocalFileTimeToFileTime(&ftLocal
, ft
) )
236 wxLogLastError(_T("LocalFileTimeToFileTime"));
242 // return a string with the volume par
243 static wxString
wxGetVolumeString(const wxString
& volume
, wxPathFormat format
)
247 if ( !volume
.empty() )
249 format
= wxFileName::GetFormat(format
);
251 // Special Windows UNC paths hack, part 2: undo what we did in
252 // SplitPath() and make an UNC path if we have a drive which is not a
253 // single letter (hopefully the network shares can't be one letter only
254 // although I didn't find any authoritative docs on this)
255 if ( format
== wxPATH_DOS
&& volume
.length() > 1 )
257 path
<< wxFILE_SEP_PATH_DOS
<< wxFILE_SEP_PATH_DOS
<< volume
;
259 else if ( format
== wxPATH_DOS
|| format
== wxPATH_VMS
)
261 path
<< volume
<< wxFileName::GetVolumeSeparator(format
);
269 // ============================================================================
271 // ============================================================================
273 // ----------------------------------------------------------------------------
274 // wxFileName construction
275 // ----------------------------------------------------------------------------
277 void wxFileName::Assign( const wxFileName
&filepath
)
279 m_volume
= filepath
.GetVolume();
280 m_dirs
= filepath
.GetDirs();
281 m_name
= filepath
.GetName();
282 m_ext
= filepath
.GetExt();
283 m_relative
= filepath
.m_relative
;
286 void wxFileName::Assign(const wxString
& volume
,
287 const wxString
& path
,
288 const wxString
& name
,
290 wxPathFormat format
)
292 SetPath( path
, format
);
299 void wxFileName::SetPath( const wxString
&path
, wxPathFormat format
)
305 wxPathFormat my_format
= GetFormat( format
);
306 wxString my_path
= path
;
308 // 1) Determine if the path is relative or absolute.
309 wxChar leadingChar
= my_path
[0u];
314 m_relative
= leadingChar
== wxT(':');
316 // We then remove a leading ":". The reason is in our
317 // storage form for relative paths:
318 // ":dir:file.txt" actually means "./dir/file.txt" in
319 // DOS notation and should get stored as
320 // (relative) (dir) (file.txt)
321 // "::dir:file.txt" actually means "../dir/file.txt"
322 // stored as (relative) (..) (dir) (file.txt)
323 // This is important only for the Mac as an empty dir
324 // actually means <UP>, whereas under DOS, double
325 // slashes can be ignored: "\\\\" is the same as "\\".
327 my_path
.erase( 0, 1 );
331 // TODO: what is the relative path format here?
336 // the paths of the form "~" or "~username" are absolute
337 m_relative
= leadingChar
!= wxT('/') && leadingChar
!= _T('~');
341 m_relative
= !IsPathSeparator(leadingChar
, my_format
);
345 wxFAIL_MSG( wxT("error") );
349 // 2) Break up the path into its members. If the original path
350 // was just "/" or "\\", m_dirs will be empty. We know from
351 // the m_relative field, if this means "nothing" or "root dir".
353 wxStringTokenizer
tn( my_path
, GetPathSeparators(my_format
) );
355 while ( tn
.HasMoreTokens() )
357 wxString token
= tn
.GetNextToken();
359 // Remove empty token under DOS and Unix, interpret them
363 if (my_format
== wxPATH_MAC
)
364 m_dirs
.Add( wxT("..") );
373 else // no path at all
379 void wxFileName::Assign(const wxString
& fullpath
,
382 wxString volume
, path
, name
, ext
;
383 SplitPath(fullpath
, &volume
, &path
, &name
, &ext
, format
);
385 Assign(volume
, path
, name
, ext
, format
);
388 void wxFileName::Assign(const wxString
& fullpathOrig
,
389 const wxString
& fullname
,
392 // always recognize fullpath as directory, even if it doesn't end with a
394 wxString fullpath
= fullpathOrig
;
395 if ( !wxEndsWithPathSeparator(fullpath
) )
397 fullpath
+= GetPathSeparator(format
);
400 wxString volume
, path
, name
, ext
;
402 // do some consistency checks in debug mode: the name should be really just
403 // the filename and the path should be really just a path
405 wxString pathDummy
, nameDummy
, extDummy
;
407 SplitPath(fullname
, &pathDummy
, &name
, &ext
, format
);
409 wxASSERT_MSG( pathDummy
.empty(),
410 _T("the file name shouldn't contain the path") );
412 SplitPath(fullpath
, &volume
, &path
, &nameDummy
, &extDummy
, format
);
414 wxASSERT_MSG( nameDummy
.empty() && extDummy
.empty(),
415 _T("the path shouldn't contain file name nor extension") );
417 #else // !__WXDEBUG__
418 SplitPath(fullname
, NULL
/* no path */, &name
, &ext
, format
);
419 SplitPath(fullpath
, &volume
, &path
, NULL
, NULL
, format
);
420 #endif // __WXDEBUG__/!__WXDEBUG__
422 Assign(volume
, path
, name
, ext
, format
);
425 void wxFileName::AssignDir(const wxString
& dir
, wxPathFormat format
)
427 Assign(dir
, _T(""), format
);
430 void wxFileName::Clear()
436 m_ext
= wxEmptyString
;
440 wxFileName
wxFileName::FileName(const wxString
& file
)
442 return wxFileName(file
);
446 wxFileName
wxFileName::DirName(const wxString
& dir
)
453 // ----------------------------------------------------------------------------
455 // ----------------------------------------------------------------------------
457 bool wxFileName::FileExists()
459 return wxFileName::FileExists( GetFullPath() );
462 bool wxFileName::FileExists( const wxString
&file
)
464 return ::wxFileExists( file
);
467 bool wxFileName::DirExists()
469 return wxFileName::DirExists( GetFullPath() );
472 bool wxFileName::DirExists( const wxString
&dir
)
474 return ::wxDirExists( dir
);
477 // ----------------------------------------------------------------------------
478 // CWD and HOME stuff
479 // ----------------------------------------------------------------------------
481 void wxFileName::AssignCwd(const wxString
& volume
)
483 AssignDir(wxFileName::GetCwd(volume
));
487 wxString
wxFileName::GetCwd(const wxString
& volume
)
489 // if we have the volume, we must get the current directory on this drive
490 // and to do this we have to chdir to this volume - at least under Windows,
491 // I don't know how to get the current drive on another volume elsewhere
494 if ( !volume
.empty() )
497 SetCwd(volume
+ GetVolumeSeparator());
500 wxString cwd
= ::wxGetCwd();
502 if ( !volume
.empty() )
510 bool wxFileName::SetCwd()
512 return wxFileName::SetCwd( GetFullPath() );
515 bool wxFileName::SetCwd( const wxString
&cwd
)
517 return ::wxSetWorkingDirectory( cwd
);
520 void wxFileName::AssignHomeDir()
522 AssignDir(wxFileName::GetHomeDir());
525 wxString
wxFileName::GetHomeDir()
527 return ::wxGetHomeDir();
530 void wxFileName::AssignTempFileName(const wxString
& prefix
, wxFile
*fileTemp
)
532 wxString tempname
= CreateTempFileName(prefix
, fileTemp
);
533 if ( tempname
.empty() )
535 // error, failed to get temp file name
546 wxFileName::CreateTempFileName(const wxString
& prefix
, wxFile
*fileTemp
)
548 wxString path
, dir
, name
;
550 // use the directory specified by the prefix
551 SplitPath(prefix
, &dir
, &name
, NULL
/* extension */);
553 #if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
558 if ( !::GetTempPath(MAX_PATH
, wxStringBuffer(dir
, MAX_PATH
+ 1)) )
560 wxLogLastError(_T("GetTempPath"));
565 // GetTempFileName() fails if we pass it an empty string
569 else // we have a dir to create the file in
571 // ensure we use only the back slashes as GetTempFileName(), unlike all
572 // the other APIs, is picky and doesn't accept the forward ones
573 dir
.Replace(_T("/"), _T("\\"));
576 if ( !::GetTempFileName(dir
, name
, 0, wxStringBuffer(path
, MAX_PATH
+ 1)) )
578 wxLogLastError(_T("GetTempFileName"));
583 if ( !::GetTempFileName(NULL
, prefix
, 0, wxStringBuffer(path
, 1025)) )
589 #elif defined(__WXPM__)
590 // for now just create a file
592 // future enhancements can be to set some extended attributes for file
593 // systems OS/2 supports that have them (HPFS, FAT32) and security
595 static const wxChar
*szMktempSuffix
= wxT("XXX");
596 path
<< dir
<< _T('/') << name
<< szMktempSuffix
;
598 // Temporarily remove - MN
600 ::DosCreateDir(wxStringBuffer(path
, MAX_PATH
), NULL
);
603 #else // !Windows, !OS/2
606 #if defined(__WXMAC__) && !defined(__DARWIN__)
607 dir
= wxMacFindFolder( (short) kOnSystemDisk
, kTemporaryFolderType
, kCreateFolder
) ;
609 dir
= wxGetenv(_T("TMP"));
612 dir
= wxGetenv(_T("TEMP"));
629 if ( !wxEndsWithPathSeparator(dir
) &&
630 (name
.empty() || !wxIsPathSeparator(name
[0u])) )
632 path
+= wxFILE_SEP_PATH
;
637 #if defined(HAVE_MKSTEMP)
638 // scratch space for mkstemp()
639 path
+= _T("XXXXXX");
641 // we need to copy the path to the buffer in which mkstemp() can modify it
642 wxCharBuffer
buf(path
.fn_str());
644 // cast is safe because the string length doesn't change
645 int fdTemp
= mkstemp( (char *)buf
.data() );
648 // this might be not necessary as mkstemp() on most systems should have
649 // already done it but it doesn't hurt neither...
652 else // mkstemp() succeeded
654 path
= wxConvFile
.cMB2WX(buf
);
656 // avoid leaking the fd
659 fileTemp
->Attach(fdTemp
);
666 #else // !HAVE_MKSTEMP
670 path
+= _T("XXXXXX");
672 wxCharBuffer
buf(path
.fn_str());
673 if ( !mktemp( buf
) )
679 path
= wxConvFile
.cMB2WX(buf
);
681 #else // !HAVE_MKTEMP (includes __DOS__)
682 // generate the unique file name ourselves
684 path
<< (unsigned int)getpid();
689 static const size_t numTries
= 1000;
690 for ( size_t n
= 0; n
< numTries
; n
++ )
692 // 3 hex digits is enough for numTries == 1000 < 4096
693 pathTry
= path
+ wxString::Format(_T("%.03x"), n
);
694 if ( !wxFile::Exists(pathTry
) )
703 #endif // HAVE_MKTEMP/!HAVE_MKTEMP
708 #endif // HAVE_MKSTEMP/!HAVE_MKSTEMP
710 #endif // Windows/!Windows
714 wxLogSysError(_("Failed to create a temporary file name"));
716 else if ( fileTemp
&& !fileTemp
->IsOpened() )
718 // open the file - of course, there is a race condition here, this is
719 // why we always prefer using mkstemp()...
721 // NB: GetTempFileName() under Windows creates the file, so using
722 // write_excl there would fail
723 if ( !fileTemp
->Open(path
,
724 #if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
729 wxS_IRUSR
| wxS_IWUSR
) )
731 // FIXME: If !ok here should we loop and try again with another
732 // file name? That is the standard recourse if open(O_EXCL)
733 // fails, though of course it should be protected against
734 // possible infinite looping too.
736 wxLogError(_("Failed to open temporary file."));
745 // ----------------------------------------------------------------------------
746 // directory operations
747 // ----------------------------------------------------------------------------
749 bool wxFileName::Mkdir( int perm
, int flags
)
751 return wxFileName::Mkdir( GetFullPath(), perm
, flags
);
754 bool wxFileName::Mkdir( const wxString
& dir
, int perm
, int flags
)
756 if ( flags
& wxPATH_MKDIR_FULL
)
758 // split the path in components
760 filename
.AssignDir(dir
);
763 if ( filename
.HasVolume())
765 currPath
<< wxGetVolumeString(filename
.GetVolume(), wxPATH_NATIVE
);
768 wxArrayString dirs
= filename
.GetDirs();
769 size_t count
= dirs
.GetCount();
770 for ( size_t i
= 0; i
< count
; i
++ )
772 if ( i
> 0 || filename
.IsAbsolute() )
773 currPath
+= wxFILE_SEP_PATH
;
776 if (!DirExists(currPath
))
778 if (!wxMkdir(currPath
, perm
))
780 // no need to try creating further directories
790 return ::wxMkdir( dir
, perm
);
793 bool wxFileName::Rmdir()
795 return wxFileName::Rmdir( GetFullPath() );
798 bool wxFileName::Rmdir( const wxString
&dir
)
800 return ::wxRmdir( dir
);
803 // ----------------------------------------------------------------------------
804 // path normalization
805 // ----------------------------------------------------------------------------
807 bool wxFileName::Normalize(int flags
,
811 // the existing path components
812 wxArrayString dirs
= GetDirs();
814 // the path to prepend in front to make the path absolute
817 format
= GetFormat(format
);
819 // make the path absolute
820 if ( (flags
& wxPATH_NORM_ABSOLUTE
) && !IsAbsolute(format
) )
824 curDir
.AssignCwd(GetVolume());
828 curDir
.AssignDir(cwd
);
831 // the path may be not absolute because it doesn't have the volume name
832 // but in this case we shouldn't modify the directory components of it
833 // but just set the current volume
834 if ( !HasVolume() && curDir
.HasVolume() )
836 SetVolume(curDir
.GetVolume());
840 // yes, it was the case - we don't need curDir then
846 // handle ~ stuff under Unix only
847 if ( (format
== wxPATH_UNIX
) && (flags
& wxPATH_NORM_TILDE
) )
849 if ( !dirs
.IsEmpty() )
851 wxString dir
= dirs
[0u];
852 if ( !dir
.empty() && dir
[0u] == _T('~') )
854 curDir
.AssignDir(wxGetUserHome(dir
.c_str() + 1));
861 // transform relative path into abs one
864 wxArrayString dirsNew
= curDir
.GetDirs();
865 size_t count
= dirs
.GetCount();
866 for ( size_t n
= 0; n
< count
; n
++ )
868 dirsNew
.Add(dirs
[n
]);
874 // now deal with ".", ".." and the rest
876 size_t count
= dirs
.GetCount();
877 for ( size_t n
= 0; n
< count
; n
++ )
879 wxString dir
= dirs
[n
];
881 if ( flags
& wxPATH_NORM_DOTS
)
883 if ( dir
== wxT(".") )
889 if ( dir
== wxT("..") )
891 if ( m_dirs
.IsEmpty() )
893 wxLogError(_("The path '%s' contains too many \"..\"!"),
894 GetFullPath().c_str());
898 m_dirs
.RemoveAt(m_dirs
.GetCount() - 1);
903 if ( flags
& wxPATH_NORM_ENV_VARS
)
905 dir
= wxExpandEnvVars(dir
);
908 if ( (flags
& wxPATH_NORM_CASE
) && !IsCaseSensitive(format
) )
916 if ( (flags
& wxPATH_NORM_CASE
) && !IsCaseSensitive(format
) )
918 // VZ: expand env vars here too?
924 // we do have the path now
926 // NB: need to do this before (maybe) calling Assign() below
929 #if defined(__WIN32__)
930 if ( (flags
& wxPATH_NORM_LONG
) && (format
== wxPATH_DOS
) )
932 Assign(GetLongPath());
939 // ----------------------------------------------------------------------------
940 // absolute/relative paths
941 // ----------------------------------------------------------------------------
943 bool wxFileName::IsAbsolute(wxPathFormat format
) const
945 // if our path doesn't start with a path separator, it's not an absolute
950 if ( !GetVolumeSeparator(format
).empty() )
952 // this format has volumes and an absolute path must have one, it's not
953 // enough to have the full path to bean absolute file under Windows
954 if ( GetVolume().empty() )
961 bool wxFileName::MakeRelativeTo(const wxString
& pathBase
, wxPathFormat format
)
963 wxFileName
fnBase(pathBase
, format
);
965 // get cwd only once - small time saving
966 wxString cwd
= wxGetCwd();
967 Normalize(wxPATH_NORM_ALL
, cwd
, format
);
968 fnBase
.Normalize(wxPATH_NORM_ALL
, cwd
, format
);
970 bool withCase
= IsCaseSensitive(format
);
972 // we can't do anything if the files live on different volumes
973 if ( !GetVolume().IsSameAs(fnBase
.GetVolume(), withCase
) )
979 // same drive, so we don't need our volume
982 // remove common directories starting at the top
983 while ( !m_dirs
.IsEmpty() && !fnBase
.m_dirs
.IsEmpty() &&
984 m_dirs
[0u].IsSameAs(fnBase
.m_dirs
[0u], withCase
) )
987 fnBase
.m_dirs
.RemoveAt(0);
990 // add as many ".." as needed
991 size_t count
= fnBase
.m_dirs
.GetCount();
992 for ( size_t i
= 0; i
< count
; i
++ )
994 m_dirs
.Insert(wxT(".."), 0u);
997 if ( format
== wxPATH_UNIX
|| format
== wxPATH_DOS
)
999 // a directory made relative with respect to itself is '.' under Unix
1000 // and DOS, by definition (but we don't have to insert "./" for the
1002 if ( m_dirs
.IsEmpty() && IsDir() )
1004 m_dirs
.Add(_T('.'));
1014 // ----------------------------------------------------------------------------
1015 // filename kind tests
1016 // ----------------------------------------------------------------------------
1018 bool wxFileName::SameAs(const wxFileName
&filepath
, wxPathFormat format
)
1020 wxFileName fn1
= *this,
1023 // get cwd only once - small time saving
1024 wxString cwd
= wxGetCwd();
1025 fn1
.Normalize(wxPATH_NORM_ALL
, cwd
, format
);
1026 fn2
.Normalize(wxPATH_NORM_ALL
, cwd
, format
);
1028 if ( fn1
.GetFullPath() == fn2
.GetFullPath() )
1031 // TODO: compare inodes for Unix, this works even when filenames are
1032 // different but files are the same (symlinks) (VZ)
1038 bool wxFileName::IsCaseSensitive( wxPathFormat format
)
1040 // only Unix filenames are truely case-sensitive
1041 return GetFormat(format
) == wxPATH_UNIX
;
1045 wxString
wxFileName::GetVolumeSeparator(wxPathFormat format
)
1049 if ( (GetFormat(format
) == wxPATH_DOS
) ||
1050 (GetFormat(format
) == wxPATH_VMS
) )
1052 sepVol
= wxFILE_SEP_DSK
;
1060 wxString
wxFileName::GetPathSeparators(wxPathFormat format
)
1063 switch ( GetFormat(format
) )
1066 // accept both as native APIs do but put the native one first as
1067 // this is the one we use in GetFullPath()
1068 seps
<< wxFILE_SEP_PATH_DOS
<< wxFILE_SEP_PATH_UNIX
;
1072 wxFAIL_MSG( _T("unknown wxPATH_XXX style") );
1076 seps
= wxFILE_SEP_PATH_UNIX
;
1080 seps
= wxFILE_SEP_PATH_MAC
;
1084 seps
= wxFILE_SEP_PATH_VMS
;
1092 bool wxFileName::IsPathSeparator(wxChar ch
, wxPathFormat format
)
1094 // wxString::Find() doesn't work as expected with NUL - it will always find
1095 // it, so it is almost surely a bug if this function is called with NUL arg
1096 wxASSERT_MSG( ch
!= _T('\0'), _T("shouldn't be called with NUL") );
1098 return GetPathSeparators(format
).Find(ch
) != wxNOT_FOUND
;
1101 // ----------------------------------------------------------------------------
1102 // path components manipulation
1103 // ----------------------------------------------------------------------------
1105 void wxFileName::AppendDir( const wxString
&dir
)
1110 void wxFileName::PrependDir( const wxString
&dir
)
1112 m_dirs
.Insert( dir
, 0 );
1115 void wxFileName::InsertDir( int before
, const wxString
&dir
)
1117 m_dirs
.Insert( dir
, before
);
1120 void wxFileName::RemoveDir( int pos
)
1122 m_dirs
.Remove( (size_t)pos
);
1125 // ----------------------------------------------------------------------------
1127 // ----------------------------------------------------------------------------
1129 void wxFileName::SetFullName(const wxString
& fullname
)
1131 SplitPath(fullname
, NULL
/* no path */, &m_name
, &m_ext
);
1134 wxString
wxFileName::GetFullName() const
1136 wxString fullname
= m_name
;
1137 if ( !m_ext
.empty() )
1139 fullname
<< wxFILE_SEP_EXT
<< m_ext
;
1145 wxString
wxFileName::GetPath( int flags
, wxPathFormat format
) const
1147 format
= GetFormat( format
);
1151 // return the volume with the path as well if requested
1152 if ( flags
& wxPATH_GET_VOLUME
)
1154 fullpath
+= wxGetVolumeString(GetVolume(), format
);
1157 // the leading character
1162 fullpath
+= wxFILE_SEP_PATH_MAC
;
1167 fullpath
+= wxFILE_SEP_PATH_DOS
;
1171 wxFAIL_MSG( _T("unknown path format") );
1177 // normally the absolute file names starts with a slash with
1178 // one exception: file names like "~/foo.bar" don't have it
1179 if ( m_dirs
.IsEmpty() || m_dirs
[0u] != _T('~') )
1181 fullpath
+= wxFILE_SEP_PATH_UNIX
;
1187 // no leading character here but use this place to unset
1188 // wxPATH_GET_SEPARATOR flag: under VMS it doesn't make sense as,
1189 // if I understand correctly, there should never be a dot before
1190 // the closing bracket
1191 flags
&= ~wxPATH_GET_SEPARATOR
;
1194 // then concatenate all the path components using the path separator
1195 size_t dirCount
= m_dirs
.GetCount();
1198 if ( format
== wxPATH_VMS
)
1200 fullpath
+= wxT('[');
1203 for ( size_t i
= 0; i
< dirCount
; i
++ )
1208 if ( m_dirs
[i
] == wxT(".") )
1210 // skip appending ':', this shouldn't be done in this
1211 // case as "::" is interpreted as ".." under Unix
1215 // convert back from ".." to nothing
1216 if ( m_dirs
[i
] != wxT("..") )
1217 fullpath
+= m_dirs
[i
];
1221 wxFAIL_MSG( wxT("unexpected path format") );
1222 // still fall through
1226 fullpath
+= m_dirs
[i
];
1230 // TODO: What to do with ".." under VMS
1232 // convert back from ".." to nothing
1233 if ( m_dirs
[i
] != wxT("..") )
1234 fullpath
+= m_dirs
[i
];
1238 if ( (flags
& wxPATH_GET_SEPARATOR
) || (i
!= dirCount
- 1) )
1239 fullpath
+= GetPathSeparator(format
);
1242 if ( format
== wxPATH_VMS
)
1244 fullpath
+= wxT(']');
1251 wxString
wxFileName::GetFullPath( wxPathFormat format
) const
1253 // we already have a function to get the path
1254 wxString fullpath
= GetPath(wxPATH_GET_VOLUME
| wxPATH_GET_SEPARATOR
,
1257 // now just add the file name and extension to it
1258 fullpath
+= GetFullName();
1263 // Return the short form of the path (returns identity on non-Windows platforms)
1264 wxString
wxFileName::GetShortPath() const
1266 #if defined(__WXMSW__) && defined(__WIN32__) && !defined(__WXMICROWIN__)
1267 wxString
path(GetFullPath());
1269 DWORD sz
= ::GetShortPathName(path
, NULL
, 0);
1273 ok
= ::GetShortPathName
1276 pathOut
.GetWriteBuf(sz
),
1279 pathOut
.UngetWriteBuf();
1286 return GetFullPath();
1290 // Return the long form of the path (returns identity on non-Windows platforms)
1291 wxString
wxFileName::GetLongPath() const
1294 path
= GetFullPath();
1296 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
1297 bool success
= FALSE
;
1299 #if wxUSE_DYNAMIC_LOADER
1300 typedef DWORD (WINAPI
*GET_LONG_PATH_NAME
)(const wxChar
*, wxChar
*, DWORD
);
1302 static bool s_triedToLoad
= FALSE
;
1304 if ( !s_triedToLoad
)
1306 // suppress the errors about missing GetLongPathName[AW]
1309 s_triedToLoad
= TRUE
;
1310 wxDynamicLibrary
dllKernel(_T("kernel32"));
1311 if ( dllKernel
.IsLoaded() )
1313 // may succeed or fail depending on the Windows version
1314 static GET_LONG_PATH_NAME s_pfnGetLongPathName
= NULL
;
1316 s_pfnGetLongPathName
= (GET_LONG_PATH_NAME
) dllKernel
.GetSymbol(_T("GetLongPathNameW"));
1318 s_pfnGetLongPathName
= (GET_LONG_PATH_NAME
) dllKernel
.GetSymbol(_T("GetLongPathNameA"));
1321 if ( s_pfnGetLongPathName
)
1323 DWORD dwSize
= (*s_pfnGetLongPathName
)(path
, NULL
, 0);
1324 bool ok
= dwSize
> 0;
1328 DWORD sz
= (*s_pfnGetLongPathName
)(path
, NULL
, 0);
1332 ok
= (*s_pfnGetLongPathName
)
1335 pathOut
.GetWriteBuf(sz
),
1338 pathOut
.UngetWriteBuf();
1349 #endif // wxUSE_DYNAMIC_LOADER
1353 // The OS didn't support GetLongPathName, or some other error.
1354 // We need to call FindFirstFile on each component in turn.
1356 WIN32_FIND_DATA findFileData
;
1358 pathOut
= wxEmptyString
;
1360 wxArrayString dirs
= GetDirs();
1361 dirs
.Add(GetFullName());
1365 size_t count
= dirs
.GetCount();
1366 for ( size_t i
= 0; i
< count
; i
++ )
1368 // We're using pathOut to collect the long-name path, but using a
1369 // temporary for appending the last path component which may be
1371 tmpPath
= pathOut
+ dirs
[i
];
1373 if ( tmpPath
.empty() )
1376 if ( tmpPath
.Last() == wxT(':') )
1378 // Can't pass a drive and root dir to FindFirstFile,
1379 // so continue to next dir
1380 tmpPath
+= wxFILE_SEP_PATH
;
1385 hFind
= ::FindFirstFile(tmpPath
, &findFileData
);
1386 if (hFind
== INVALID_HANDLE_VALUE
)
1388 // Error: return immediately with the original path
1392 pathOut
+= findFileData
.cFileName
;
1393 if ( (i
< (count
-1)) )
1394 pathOut
+= wxFILE_SEP_PATH
;
1401 #endif // Win32/!Win32
1406 wxPathFormat
wxFileName::GetFormat( wxPathFormat format
)
1408 if (format
== wxPATH_NATIVE
)
1410 #if defined(__WXMSW__) || defined(__WXPM__) || defined(__DOS__)
1411 format
= wxPATH_DOS
;
1412 #elif defined(__WXMAC__) && !defined(__DARWIN__)
1413 format
= wxPATH_MAC
;
1414 #elif defined(__VMS)
1415 format
= wxPATH_VMS
;
1417 format
= wxPATH_UNIX
;
1423 // ----------------------------------------------------------------------------
1424 // path splitting function
1425 // ----------------------------------------------------------------------------
1428 void wxFileName::SplitPath(const wxString
& fullpathWithVolume
,
1429 wxString
*pstrVolume
,
1433 wxPathFormat format
)
1435 format
= GetFormat(format
);
1437 wxString fullpath
= fullpathWithVolume
;
1439 // under VMS the end of the path is ']', not the path separator used to
1440 // separate the components
1441 wxString sepPath
= format
== wxPATH_VMS
? wxString(_T(']'))
1442 : GetPathSeparators(format
);
1444 // special Windows UNC paths hack: transform \\share\path into share:path
1445 if ( format
== wxPATH_DOS
)
1447 if ( fullpath
.length() >= 4 &&
1448 fullpath
[0u] == wxFILE_SEP_PATH_DOS
&&
1449 fullpath
[1u] == wxFILE_SEP_PATH_DOS
)
1451 fullpath
.erase(0, 2);
1453 size_t posFirstSlash
= fullpath
.find_first_of(sepPath
);
1454 if ( posFirstSlash
!= wxString::npos
)
1456 fullpath
[posFirstSlash
] = wxFILE_SEP_DSK
;
1458 // UNC paths are always absolute, right? (FIXME)
1459 fullpath
.insert(posFirstSlash
+ 1, wxFILE_SEP_PATH_DOS
);
1464 // We separate the volume here
1465 if ( format
== wxPATH_DOS
|| format
== wxPATH_VMS
)
1467 wxString sepVol
= GetVolumeSeparator(format
);
1469 size_t posFirstColon
= fullpath
.find_first_of(sepVol
);
1470 if ( posFirstColon
!= wxString::npos
)
1474 *pstrVolume
= fullpath
.Left(posFirstColon
);
1477 // remove the volume name and the separator from the full path
1478 fullpath
.erase(0, posFirstColon
+ sepVol
.length());
1482 // find the positions of the last dot and last path separator in the path
1483 size_t posLastDot
= fullpath
.find_last_of(wxFILE_SEP_EXT
);
1484 size_t posLastSlash
= fullpath
.find_last_of(sepPath
);
1486 if ( (posLastDot
!= wxString::npos
) &&
1487 ((format
== wxPATH_UNIX
) || (format
== wxPATH_VMS
)) )
1489 if ( (posLastDot
== 0) ||
1490 (fullpath
[posLastDot
- 1] == sepPath
[0u] ) )
1492 // under Unix and VMS, dot may be (and commonly is) the first
1493 // character of the filename, don't treat the entire filename as
1494 // extension in this case
1495 posLastDot
= wxString::npos
;
1499 // if we do have a dot and a slash, check that the dot is in the name part
1500 if ( (posLastDot
!= wxString::npos
) &&
1501 (posLastSlash
!= wxString::npos
) &&
1502 (posLastDot
< posLastSlash
) )
1504 // the dot is part of the path, not the start of the extension
1505 posLastDot
= wxString::npos
;
1508 // now fill in the variables provided by user
1511 if ( posLastSlash
== wxString::npos
)
1518 // take everything up to the path separator but take care to make
1519 // the path equal to something like '/', not empty, for the files
1520 // immediately under root directory
1521 size_t len
= posLastSlash
;
1523 // this rule does not apply to mac since we do not start with colons (sep)
1524 // except for relative paths
1525 if ( !len
&& format
!= wxPATH_MAC
)
1528 *pstrPath
= fullpath
.Left(len
);
1530 // special VMS hack: remove the initial bracket
1531 if ( format
== wxPATH_VMS
)
1533 if ( (*pstrPath
)[0u] == _T('[') )
1534 pstrPath
->erase(0, 1);
1541 // take all characters starting from the one after the last slash and
1542 // up to, but excluding, the last dot
1543 size_t nStart
= posLastSlash
== wxString::npos
? 0 : posLastSlash
+ 1;
1545 if ( posLastDot
== wxString::npos
)
1547 // take all until the end
1548 count
= wxString::npos
;
1550 else if ( posLastSlash
== wxString::npos
)
1554 else // have both dot and slash
1556 count
= posLastDot
- posLastSlash
- 1;
1559 *pstrName
= fullpath
.Mid(nStart
, count
);
1564 if ( posLastDot
== wxString::npos
)
1571 // take everything after the dot
1572 *pstrExt
= fullpath
.Mid(posLastDot
+ 1);
1578 void wxFileName::SplitPath(const wxString
& fullpath
,
1582 wxPathFormat format
)
1585 SplitPath(fullpath
, &volume
, path
, name
, ext
, format
);
1589 path
->Prepend(wxGetVolumeString(volume
, format
));
1593 // ----------------------------------------------------------------------------
1595 // ----------------------------------------------------------------------------
1597 bool wxFileName::SetTimes(const wxDateTime
*dtAccess
,
1598 const wxDateTime
*dtMod
,
1599 const wxDateTime
*dtCreate
)
1601 #if defined(__UNIX_LIKE__) || (defined(__DOS__) && defined(__WATCOMC__))
1602 if ( !dtAccess
&& !dtMod
)
1604 // can't modify the creation time anyhow, don't try
1608 // if dtAccess or dtMod is not specified, use the other one (which must be
1609 // non NULL because of the test above) for both times
1611 utm
.actime
= dtAccess
? dtAccess
->GetTicks() : dtMod
->GetTicks();
1612 utm
.modtime
= dtMod
? dtMod
->GetTicks() : dtAccess
->GetTicks();
1613 if ( utime(GetFullPath().fn_str(), &utm
) == 0 )
1617 #elif defined(__WIN32__)
1618 wxFileHandle
fh(GetFullPath(), wxFileHandle::Write
);
1621 FILETIME ftAccess
, ftCreate
, ftWrite
;
1624 ConvertWxToFileTime(&ftCreate
, *dtCreate
);
1626 ConvertWxToFileTime(&ftAccess
, *dtAccess
);
1628 ConvertWxToFileTime(&ftWrite
, *dtMod
);
1630 if ( ::SetFileTime(fh
,
1631 dtCreate
? &ftCreate
: NULL
,
1632 dtAccess
? &ftAccess
: NULL
,
1633 dtMod
? &ftWrite
: NULL
) )
1638 #else // other platform
1641 wxLogSysError(_("Failed to modify file times for '%s'"),
1642 GetFullPath().c_str());
1647 bool wxFileName::Touch()
1649 #if defined(__UNIX_LIKE__)
1650 // under Unix touching file is simple: just pass NULL to utime()
1651 if ( utime(GetFullPath().fn_str(), NULL
) == 0 )
1656 wxLogSysError(_("Failed to touch the file '%s'"), GetFullPath().c_str());
1659 #else // other platform
1660 wxDateTime dtNow
= wxDateTime::Now();
1662 return SetTimes(&dtNow
, &dtNow
, NULL
/* don't change create time */);
1666 bool wxFileName::GetTimes(wxDateTime
*dtAccess
,
1668 wxDateTime
*dtCreate
) const
1670 #if defined(__UNIX_LIKE__) || defined(__WXMAC__) || (defined(__DOS__) && defined(__WATCOMC__))
1672 if ( wxStat( GetFullPath().c_str(), &stBuf
) == 0 )
1675 dtAccess
->Set(stBuf
.st_atime
);
1677 dtMod
->Set(stBuf
.st_mtime
);
1679 dtCreate
->Set(stBuf
.st_ctime
);
1683 #elif defined(__WIN32__)
1684 wxFileHandle
fh(GetFullPath(), wxFileHandle::Read
);
1687 FILETIME ftAccess
, ftCreate
, ftWrite
;
1689 if ( ::GetFileTime(fh
,
1690 dtCreate
? &ftCreate
: NULL
,
1691 dtAccess
? &ftAccess
: NULL
,
1692 dtMod
? &ftWrite
: NULL
) )
1695 ConvertFileTimeToWx(dtCreate
, ftCreate
);
1697 ConvertFileTimeToWx(dtAccess
, ftAccess
);
1699 ConvertFileTimeToWx(dtMod
, ftWrite
);
1704 #else // other platform
1707 wxLogSysError(_("Failed to retrieve file times for '%s'"),
1708 GetFullPath().c_str());
1715 const short kMacExtensionMaxLength
= 16 ;
1716 class MacDefaultExtensionRecord
1719 MacDefaultExtensionRecord()
1722 m_type
= m_creator
= NULL
;
1724 MacDefaultExtensionRecord( const MacDefaultExtensionRecord
& from
)
1726 strcpy( m_ext
, from
.m_ext
) ;
1727 m_type
= from
.m_type
;
1728 m_creator
= from
.m_creator
;
1730 MacDefaultExtensionRecord( char * extension
, OSType type
, OSType creator
)
1732 strncpy( m_ext
, extension
, kMacExtensionMaxLength
) ;
1733 m_ext
[kMacExtensionMaxLength
] = 0 ;
1735 m_creator
= creator
;
1737 char m_ext
[kMacExtensionMaxLength
] ;
1742 #include "wx/dynarray.h"
1743 WX_DECLARE_OBJARRAY(MacDefaultExtensionRecord
, MacDefaultExtensionArray
) ;
1745 bool gMacDefaultExtensionsInited
= false ;
1747 #include "wx/arrimpl.cpp"
1749 WX_DEFINE_EXPORTED_OBJARRAY(MacDefaultExtensionArray
) ;
1751 MacDefaultExtensionArray gMacDefaultExtensions
;
1753 static void MacEnsureDefaultExtensionsLoaded()
1755 if ( !gMacDefaultExtensionsInited
)
1758 // load the default extensions
1759 MacDefaultExtensionRecord defaults
[1] =
1761 MacDefaultExtensionRecord( "txt" , 'TEXT' , 'ttxt' ) ,
1764 // we could load the pc exchange prefs here too
1766 for ( int i
= 0 ; i
< WXSIZEOF( defaults
) ; ++i
)
1768 gMacDefaultExtensions
.Add( defaults
[i
] ) ;
1770 gMacDefaultExtensionsInited
= true ;
1773 bool wxFileName::MacSetTypeAndCreator( wxUint32 type
, wxUint32 creator
)
1777 wxMacFilename2FSSpec(GetFullPath(),&spec
) ;
1778 OSErr err
= FSpGetFInfo( &spec
, &fndrInfo
) ;
1779 wxCHECK( err
== noErr
, false ) ;
1781 fndrInfo
.fdType
= type
;
1782 fndrInfo
.fdCreator
= creator
;
1783 FSpSetFInfo( &spec
, &fndrInfo
) ;
1787 bool wxFileName::MacGetTypeAndCreator( wxUint32
*type
, wxUint32
*creator
)
1791 wxMacFilename2FSSpec(GetFullPath(),&spec
) ;
1792 OSErr err
= FSpGetFInfo( &spec
, &fndrInfo
) ;
1793 wxCHECK( err
== noErr
, false ) ;
1795 *type
= fndrInfo
.fdType
;
1796 *creator
= fndrInfo
.fdCreator
;
1800 bool wxFileName::MacSetDefaultTypeAndCreator()
1802 wxUint32 type
, creator
;
1803 if ( wxFileName::MacFindDefaultTypeAndCreator(GetExt() , &type
,
1806 return MacSetTypeAndCreator( type
, creator
) ;
1811 bool wxFileName::MacFindDefaultTypeAndCreator( const wxString
& ext
, wxUint32
*type
, wxUint32
*creator
)
1813 MacEnsureDefaultExtensionsLoaded() ;
1814 wxString extl
= ext
.Lower() ;
1815 for( int i
= gMacDefaultExtensions
.Count() - 1 ; i
>= 0 ; --i
)
1817 if ( gMacDefaultExtensions
.Item(i
).m_ext
== extl
)
1819 *type
= gMacDefaultExtensions
.Item(i
).m_type
;
1820 *creator
= gMacDefaultExtensions
.Item(i
).m_creator
;
1827 void wxFileName::MacRegisterDefaultTypeAndCreator( const wxString
& ext
, wxUint32 type
, wxUint32 creator
)
1829 MacEnsureDefaultExtensionsLoaded() ;
1830 MacDefaultExtensionRecord rec
;
1832 rec
.m_creator
= creator
;
1833 strncpy( rec
.m_ext
, ext
.Lower().c_str() , kMacExtensionMaxLength
) ;
1834 gMacDefaultExtensions
.Add( rec
) ;