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 // Needed for Unicode/Ansi conversion
640 #if defined(HAVE_MKSTEMP)
641 // scratch space for mkstemp()
642 path
+= _T("XXXXXX");
645 strcpy( buf
, wxConvFile
.cWC2MB( path
) );
647 strcpy( buf
, path
.c_str() );
649 int fdTemp
= mkstemp( buf
);
652 // this might be not necessary as mkstemp() on most systems should have
653 // already done it but it doesn't hurt neither...
656 else // mkstemp() succeeded
659 path
= wxConvFile
.cMB2WC( buf
);
663 // avoid leaking the fd
666 fileTemp
->Attach(fdTemp
);
673 #else // !HAVE_MKSTEMP
677 path
+= _T("XXXXXX");
680 strcpy( buf
, wxConvFile
.cWC2MB( path
) );
682 strcpy( buf
, path
.c_str() );
691 path
= wxConvFile
.cMB2WC( buf
);
696 #else // !HAVE_MKTEMP (includes __DOS__)
697 // generate the unique file name ourselves
699 path
<< (unsigned int)getpid();
704 static const size_t numTries
= 1000;
705 for ( size_t n
= 0; n
< numTries
; n
++ )
707 // 3 hex digits is enough for numTries == 1000 < 4096
708 pathTry
= path
+ wxString::Format(_T("%.03x"), n
);
709 if ( !wxFile::Exists(pathTry
) )
718 #endif // HAVE_MKTEMP/!HAVE_MKTEMP
723 #endif // HAVE_MKSTEMP/!HAVE_MKSTEMP
725 #endif // Windows/!Windows
729 wxLogSysError(_("Failed to create a temporary file name"));
731 else if ( fileTemp
&& !fileTemp
->IsOpened() )
733 // open the file - of course, there is a race condition here, this is
734 // why we always prefer using mkstemp()...
736 // NB: GetTempFileName() under Windows creates the file, so using
737 // write_excl there would fail
738 if ( !fileTemp
->Open(path
,
739 #if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
744 wxS_IRUSR
| wxS_IWUSR
) )
746 // FIXME: If !ok here should we loop and try again with another
747 // file name? That is the standard recourse if open(O_EXCL)
748 // fails, though of course it should be protected against
749 // possible infinite looping too.
751 wxLogError(_("Failed to open temporary file."));
760 // ----------------------------------------------------------------------------
761 // directory operations
762 // ----------------------------------------------------------------------------
764 bool wxFileName::Mkdir( int perm
, int flags
)
766 return wxFileName::Mkdir( GetFullPath(), perm
, flags
);
769 bool wxFileName::Mkdir( const wxString
& dir
, int perm
, int flags
)
771 if ( flags
& wxPATH_MKDIR_FULL
)
773 // split the path in components
775 filename
.AssignDir(dir
);
778 if ( filename
.HasVolume())
780 currPath
<< wxGetVolumeString(filename
.GetVolume(), wxPATH_NATIVE
);
783 wxArrayString dirs
= filename
.GetDirs();
784 size_t count
= dirs
.GetCount();
785 for ( size_t i
= 0; i
< count
; i
++ )
787 if ( i
> 0 || filename
.IsAbsolute() )
788 currPath
+= wxFILE_SEP_PATH
;
791 if (!DirExists(currPath
))
793 if (!wxMkdir(currPath
, perm
))
795 // no need to try creating further directories
805 return ::wxMkdir( dir
, perm
);
808 bool wxFileName::Rmdir()
810 return wxFileName::Rmdir( GetFullPath() );
813 bool wxFileName::Rmdir( const wxString
&dir
)
815 return ::wxRmdir( dir
);
818 // ----------------------------------------------------------------------------
819 // path normalization
820 // ----------------------------------------------------------------------------
822 bool wxFileName::Normalize(int flags
,
826 // the existing path components
827 wxArrayString dirs
= GetDirs();
829 // the path to prepend in front to make the path absolute
832 format
= GetFormat(format
);
834 // make the path absolute
835 if ( (flags
& wxPATH_NORM_ABSOLUTE
) && !IsAbsolute(format
) )
839 curDir
.AssignCwd(GetVolume());
843 curDir
.AssignDir(cwd
);
846 // the path may be not absolute because it doesn't have the volume name
847 // but in this case we shouldn't modify the directory components of it
848 // but just set the current volume
849 if ( !HasVolume() && curDir
.HasVolume() )
851 SetVolume(curDir
.GetVolume());
855 // yes, it was the case - we don't need curDir then
861 // handle ~ stuff under Unix only
862 if ( (format
== wxPATH_UNIX
) && (flags
& wxPATH_NORM_TILDE
) )
864 if ( !dirs
.IsEmpty() )
866 wxString dir
= dirs
[0u];
867 if ( !dir
.empty() && dir
[0u] == _T('~') )
869 curDir
.AssignDir(wxGetUserHome(dir
.c_str() + 1));
876 // transform relative path into abs one
879 wxArrayString dirsNew
= curDir
.GetDirs();
880 size_t count
= dirs
.GetCount();
881 for ( size_t n
= 0; n
< count
; n
++ )
883 dirsNew
.Add(dirs
[n
]);
889 // now deal with ".", ".." and the rest
891 size_t count
= dirs
.GetCount();
892 for ( size_t n
= 0; n
< count
; n
++ )
894 wxString dir
= dirs
[n
];
896 if ( flags
& wxPATH_NORM_DOTS
)
898 if ( dir
== wxT(".") )
904 if ( dir
== wxT("..") )
906 if ( m_dirs
.IsEmpty() )
908 wxLogError(_("The path '%s' contains too many \"..\"!"),
909 GetFullPath().c_str());
913 m_dirs
.RemoveAt(m_dirs
.GetCount() - 1);
918 if ( flags
& wxPATH_NORM_ENV_VARS
)
920 dir
= wxExpandEnvVars(dir
);
923 if ( (flags
& wxPATH_NORM_CASE
) && !IsCaseSensitive(format
) )
931 if ( (flags
& wxPATH_NORM_CASE
) && !IsCaseSensitive(format
) )
933 // VZ: expand env vars here too?
939 // we do have the path now
941 // NB: need to do this before (maybe) calling Assign() below
944 #if defined(__WIN32__)
945 if ( (flags
& wxPATH_NORM_LONG
) && (format
== wxPATH_DOS
) )
947 Assign(GetLongPath());
954 // ----------------------------------------------------------------------------
955 // absolute/relative paths
956 // ----------------------------------------------------------------------------
958 bool wxFileName::IsAbsolute(wxPathFormat format
) const
960 // if our path doesn't start with a path separator, it's not an absolute
965 if ( !GetVolumeSeparator(format
).empty() )
967 // this format has volumes and an absolute path must have one, it's not
968 // enough to have the full path to bean absolute file under Windows
969 if ( GetVolume().empty() )
976 bool wxFileName::MakeRelativeTo(const wxString
& pathBase
, wxPathFormat format
)
978 wxFileName
fnBase(pathBase
, format
);
980 // get cwd only once - small time saving
981 wxString cwd
= wxGetCwd();
982 Normalize(wxPATH_NORM_ALL
, cwd
, format
);
983 fnBase
.Normalize(wxPATH_NORM_ALL
, cwd
, format
);
985 bool withCase
= IsCaseSensitive(format
);
987 // we can't do anything if the files live on different volumes
988 if ( !GetVolume().IsSameAs(fnBase
.GetVolume(), withCase
) )
994 // same drive, so we don't need our volume
997 // remove common directories starting at the top
998 while ( !m_dirs
.IsEmpty() && !fnBase
.m_dirs
.IsEmpty() &&
999 m_dirs
[0u].IsSameAs(fnBase
.m_dirs
[0u], withCase
) )
1002 fnBase
.m_dirs
.RemoveAt(0);
1005 // add as many ".." as needed
1006 size_t count
= fnBase
.m_dirs
.GetCount();
1007 for ( size_t i
= 0; i
< count
; i
++ )
1009 m_dirs
.Insert(wxT(".."), 0u);
1012 if ( format
== wxPATH_UNIX
|| format
== wxPATH_DOS
)
1014 // a directory made relative with respect to itself is '.' under Unix
1015 // and DOS, by definition (but we don't have to insert "./" for the
1017 if ( m_dirs
.IsEmpty() && IsDir() )
1019 m_dirs
.Add(_T('.'));
1029 // ----------------------------------------------------------------------------
1030 // filename kind tests
1031 // ----------------------------------------------------------------------------
1033 bool wxFileName::SameAs(const wxFileName
&filepath
, wxPathFormat format
)
1035 wxFileName fn1
= *this,
1038 // get cwd only once - small time saving
1039 wxString cwd
= wxGetCwd();
1040 fn1
.Normalize(wxPATH_NORM_ALL
, cwd
, format
);
1041 fn2
.Normalize(wxPATH_NORM_ALL
, cwd
, format
);
1043 if ( fn1
.GetFullPath() == fn2
.GetFullPath() )
1046 // TODO: compare inodes for Unix, this works even when filenames are
1047 // different but files are the same (symlinks) (VZ)
1053 bool wxFileName::IsCaseSensitive( wxPathFormat format
)
1055 // only Unix filenames are truely case-sensitive
1056 return GetFormat(format
) == wxPATH_UNIX
;
1060 wxString
wxFileName::GetVolumeSeparator(wxPathFormat format
)
1064 if ( (GetFormat(format
) == wxPATH_DOS
) ||
1065 (GetFormat(format
) == wxPATH_VMS
) )
1067 sepVol
= wxFILE_SEP_DSK
;
1075 wxString
wxFileName::GetPathSeparators(wxPathFormat format
)
1078 switch ( GetFormat(format
) )
1081 // accept both as native APIs do but put the native one first as
1082 // this is the one we use in GetFullPath()
1083 seps
<< wxFILE_SEP_PATH_DOS
<< wxFILE_SEP_PATH_UNIX
;
1087 wxFAIL_MSG( _T("unknown wxPATH_XXX style") );
1091 seps
= wxFILE_SEP_PATH_UNIX
;
1095 seps
= wxFILE_SEP_PATH_MAC
;
1099 seps
= wxFILE_SEP_PATH_VMS
;
1107 bool wxFileName::IsPathSeparator(wxChar ch
, wxPathFormat format
)
1109 // wxString::Find() doesn't work as expected with NUL - it will always find
1110 // it, so it is almost surely a bug if this function is called with NUL arg
1111 wxASSERT_MSG( ch
!= _T('\0'), _T("shouldn't be called with NUL") );
1113 return GetPathSeparators(format
).Find(ch
) != wxNOT_FOUND
;
1116 // ----------------------------------------------------------------------------
1117 // path components manipulation
1118 // ----------------------------------------------------------------------------
1120 void wxFileName::AppendDir( const wxString
&dir
)
1125 void wxFileName::PrependDir( const wxString
&dir
)
1127 m_dirs
.Insert( dir
, 0 );
1130 void wxFileName::InsertDir( int before
, const wxString
&dir
)
1132 m_dirs
.Insert( dir
, before
);
1135 void wxFileName::RemoveDir( int pos
)
1137 m_dirs
.Remove( (size_t)pos
);
1140 // ----------------------------------------------------------------------------
1142 // ----------------------------------------------------------------------------
1144 void wxFileName::SetFullName(const wxString
& fullname
)
1146 SplitPath(fullname
, NULL
/* no path */, &m_name
, &m_ext
);
1149 wxString
wxFileName::GetFullName() const
1151 wxString fullname
= m_name
;
1152 if ( !m_ext
.empty() )
1154 fullname
<< wxFILE_SEP_EXT
<< m_ext
;
1160 wxString
wxFileName::GetPath( int flags
, wxPathFormat format
) const
1162 format
= GetFormat( format
);
1166 // return the volume with the path as well if requested
1167 if ( flags
& wxPATH_GET_VOLUME
)
1169 fullpath
+= wxGetVolumeString(GetVolume(), format
);
1172 // the leading character
1177 fullpath
+= wxFILE_SEP_PATH_MAC
;
1182 fullpath
+= wxFILE_SEP_PATH_DOS
;
1186 wxFAIL_MSG( _T("unknown path format") );
1192 // normally the absolute file names starts with a slash with
1193 // one exception: file names like "~/foo.bar" don't have it
1194 if ( m_dirs
.IsEmpty() || m_dirs
[0u] != _T('~') )
1196 fullpath
+= wxFILE_SEP_PATH_UNIX
;
1202 // no leading character here but use this place to unset
1203 // wxPATH_GET_SEPARATOR flag: under VMS it doesn't make sense as,
1204 // if I understand correctly, there should never be a dot before
1205 // the closing bracket
1206 flags
&= ~wxPATH_GET_SEPARATOR
;
1209 // then concatenate all the path components using the path separator
1210 size_t dirCount
= m_dirs
.GetCount();
1213 if ( format
== wxPATH_VMS
)
1215 fullpath
+= wxT('[');
1218 for ( size_t i
= 0; i
< dirCount
; i
++ )
1223 if ( m_dirs
[i
] == wxT(".") )
1225 // skip appending ':', this shouldn't be done in this
1226 // case as "::" is interpreted as ".." under Unix
1230 // convert back from ".." to nothing
1231 if ( m_dirs
[i
] != wxT("..") )
1232 fullpath
+= m_dirs
[i
];
1236 wxFAIL_MSG( wxT("unexpected path format") );
1237 // still fall through
1241 fullpath
+= m_dirs
[i
];
1245 // TODO: What to do with ".." under VMS
1247 // convert back from ".." to nothing
1248 if ( m_dirs
[i
] != wxT("..") )
1249 fullpath
+= m_dirs
[i
];
1253 if ( (flags
& wxPATH_GET_SEPARATOR
) || (i
!= dirCount
- 1) )
1254 fullpath
+= GetPathSeparator(format
);
1257 if ( format
== wxPATH_VMS
)
1259 fullpath
+= wxT(']');
1266 wxString
wxFileName::GetFullPath( wxPathFormat format
) const
1268 // we already have a function to get the path
1269 wxString fullpath
= GetPath(wxPATH_GET_VOLUME
| wxPATH_GET_SEPARATOR
,
1272 // now just add the file name and extension to it
1273 fullpath
+= GetFullName();
1278 // Return the short form of the path (returns identity on non-Windows platforms)
1279 wxString
wxFileName::GetShortPath() const
1281 #if defined(__WXMSW__) && defined(__WIN32__) && !defined(__WXMICROWIN__)
1282 wxString
path(GetFullPath());
1284 DWORD sz
= ::GetShortPathName(path
, NULL
, 0);
1288 ok
= ::GetShortPathName
1291 pathOut
.GetWriteBuf(sz
),
1294 pathOut
.UngetWriteBuf();
1301 return GetFullPath();
1305 // Return the long form of the path (returns identity on non-Windows platforms)
1306 wxString
wxFileName::GetLongPath() const
1309 path
= GetFullPath();
1311 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
1312 bool success
= FALSE
;
1314 #if wxUSE_DYNAMIC_LOADER
1315 typedef DWORD (WINAPI
*GET_LONG_PATH_NAME
)(const wxChar
*, wxChar
*, DWORD
);
1317 static bool s_triedToLoad
= FALSE
;
1319 if ( !s_triedToLoad
)
1321 // suppress the errors about missing GetLongPathName[AW]
1324 s_triedToLoad
= TRUE
;
1325 wxDynamicLibrary
dllKernel(_T("kernel32"));
1326 if ( dllKernel
.IsLoaded() )
1328 // may succeed or fail depending on the Windows version
1329 static GET_LONG_PATH_NAME s_pfnGetLongPathName
= NULL
;
1331 s_pfnGetLongPathName
= (GET_LONG_PATH_NAME
) dllKernel
.GetSymbol(_T("GetLongPathNameW"));
1333 s_pfnGetLongPathName
= (GET_LONG_PATH_NAME
) dllKernel
.GetSymbol(_T("GetLongPathNameA"));
1336 if ( s_pfnGetLongPathName
)
1338 DWORD dwSize
= (*s_pfnGetLongPathName
)(path
, NULL
, 0);
1339 bool ok
= dwSize
> 0;
1343 DWORD sz
= (*s_pfnGetLongPathName
)(path
, NULL
, 0);
1347 ok
= (*s_pfnGetLongPathName
)
1350 pathOut
.GetWriteBuf(sz
),
1353 pathOut
.UngetWriteBuf();
1364 #endif // wxUSE_DYNAMIC_LOADER
1368 // The OS didn't support GetLongPathName, or some other error.
1369 // We need to call FindFirstFile on each component in turn.
1371 WIN32_FIND_DATA findFileData
;
1373 pathOut
= wxEmptyString
;
1375 wxArrayString dirs
= GetDirs();
1376 dirs
.Add(GetFullName());
1380 size_t count
= dirs
.GetCount();
1381 for ( size_t i
= 0; i
< count
; i
++ )
1383 // We're using pathOut to collect the long-name path, but using a
1384 // temporary for appending the last path component which may be
1386 tmpPath
= pathOut
+ dirs
[i
];
1388 if ( tmpPath
.empty() )
1391 if ( tmpPath
.Last() == wxT(':') )
1393 // Can't pass a drive and root dir to FindFirstFile,
1394 // so continue to next dir
1395 tmpPath
+= wxFILE_SEP_PATH
;
1400 hFind
= ::FindFirstFile(tmpPath
, &findFileData
);
1401 if (hFind
== INVALID_HANDLE_VALUE
)
1403 // Error: return immediately with the original path
1407 pathOut
+= findFileData
.cFileName
;
1408 if ( (i
< (count
-1)) )
1409 pathOut
+= wxFILE_SEP_PATH
;
1416 #endif // Win32/!Win32
1421 wxPathFormat
wxFileName::GetFormat( wxPathFormat format
)
1423 if (format
== wxPATH_NATIVE
)
1425 #if defined(__WXMSW__) || defined(__WXPM__) || defined(__DOS__)
1426 format
= wxPATH_DOS
;
1427 #elif defined(__WXMAC__) && !defined(__DARWIN__)
1428 format
= wxPATH_MAC
;
1429 #elif defined(__VMS)
1430 format
= wxPATH_VMS
;
1432 format
= wxPATH_UNIX
;
1438 // ----------------------------------------------------------------------------
1439 // path splitting function
1440 // ----------------------------------------------------------------------------
1443 void wxFileName::SplitPath(const wxString
& fullpathWithVolume
,
1444 wxString
*pstrVolume
,
1448 wxPathFormat format
)
1450 format
= GetFormat(format
);
1452 wxString fullpath
= fullpathWithVolume
;
1454 // under VMS the end of the path is ']', not the path separator used to
1455 // separate the components
1456 wxString sepPath
= format
== wxPATH_VMS
? wxString(_T(']'))
1457 : GetPathSeparators(format
);
1459 // special Windows UNC paths hack: transform \\share\path into share:path
1460 if ( format
== wxPATH_DOS
)
1462 if ( fullpath
.length() >= 4 &&
1463 fullpath
[0u] == wxFILE_SEP_PATH_DOS
&&
1464 fullpath
[1u] == wxFILE_SEP_PATH_DOS
)
1466 fullpath
.erase(0, 2);
1468 size_t posFirstSlash
= fullpath
.find_first_of(sepPath
);
1469 if ( posFirstSlash
!= wxString::npos
)
1471 fullpath
[posFirstSlash
] = wxFILE_SEP_DSK
;
1473 // UNC paths are always absolute, right? (FIXME)
1474 fullpath
.insert(posFirstSlash
+ 1, wxFILE_SEP_PATH_DOS
);
1479 // We separate the volume here
1480 if ( format
== wxPATH_DOS
|| format
== wxPATH_VMS
)
1482 wxString sepVol
= GetVolumeSeparator(format
);
1484 size_t posFirstColon
= fullpath
.find_first_of(sepVol
);
1485 if ( posFirstColon
!= wxString::npos
)
1489 *pstrVolume
= fullpath
.Left(posFirstColon
);
1492 // remove the volume name and the separator from the full path
1493 fullpath
.erase(0, posFirstColon
+ sepVol
.length());
1497 // find the positions of the last dot and last path separator in the path
1498 size_t posLastDot
= fullpath
.find_last_of(wxFILE_SEP_EXT
);
1499 size_t posLastSlash
= fullpath
.find_last_of(sepPath
);
1501 if ( (posLastDot
!= wxString::npos
) &&
1502 ((format
== wxPATH_UNIX
) || (format
== wxPATH_VMS
)) )
1504 if ( (posLastDot
== 0) ||
1505 (fullpath
[posLastDot
- 1] == sepPath
[0u] ) )
1507 // under Unix and VMS, dot may be (and commonly is) the first
1508 // character of the filename, don't treat the entire filename as
1509 // extension in this case
1510 posLastDot
= wxString::npos
;
1514 // if we do have a dot and a slash, check that the dot is in the name part
1515 if ( (posLastDot
!= wxString::npos
) &&
1516 (posLastSlash
!= wxString::npos
) &&
1517 (posLastDot
< posLastSlash
) )
1519 // the dot is part of the path, not the start of the extension
1520 posLastDot
= wxString::npos
;
1523 // now fill in the variables provided by user
1526 if ( posLastSlash
== wxString::npos
)
1533 // take everything up to the path separator but take care to make
1534 // the path equal to something like '/', not empty, for the files
1535 // immediately under root directory
1536 size_t len
= posLastSlash
;
1538 // this rule does not apply to mac since we do not start with colons (sep)
1539 // except for relative paths
1540 if ( !len
&& format
!= wxPATH_MAC
)
1543 *pstrPath
= fullpath
.Left(len
);
1545 // special VMS hack: remove the initial bracket
1546 if ( format
== wxPATH_VMS
)
1548 if ( (*pstrPath
)[0u] == _T('[') )
1549 pstrPath
->erase(0, 1);
1556 // take all characters starting from the one after the last slash and
1557 // up to, but excluding, the last dot
1558 size_t nStart
= posLastSlash
== wxString::npos
? 0 : posLastSlash
+ 1;
1560 if ( posLastDot
== wxString::npos
)
1562 // take all until the end
1563 count
= wxString::npos
;
1565 else if ( posLastSlash
== wxString::npos
)
1569 else // have both dot and slash
1571 count
= posLastDot
- posLastSlash
- 1;
1574 *pstrName
= fullpath
.Mid(nStart
, count
);
1579 if ( posLastDot
== wxString::npos
)
1586 // take everything after the dot
1587 *pstrExt
= fullpath
.Mid(posLastDot
+ 1);
1593 void wxFileName::SplitPath(const wxString
& fullpath
,
1597 wxPathFormat format
)
1600 SplitPath(fullpath
, &volume
, path
, name
, ext
, format
);
1604 path
->Prepend(wxGetVolumeString(volume
, format
));
1608 // ----------------------------------------------------------------------------
1610 // ----------------------------------------------------------------------------
1612 bool wxFileName::SetTimes(const wxDateTime
*dtAccess
,
1613 const wxDateTime
*dtMod
,
1614 const wxDateTime
*dtCreate
)
1616 #if defined(__UNIX_LIKE__) || (defined(__DOS__) && defined(__WATCOMC__))
1617 if ( !dtAccess
&& !dtMod
)
1619 // can't modify the creation time anyhow, don't try
1623 // if dtAccess or dtMod is not specified, use the other one (which must be
1624 // non NULL because of the test above) for both times
1626 utm
.actime
= dtAccess
? dtAccess
->GetTicks() : dtMod
->GetTicks();
1627 utm
.modtime
= dtMod
? dtMod
->GetTicks() : dtAccess
->GetTicks();
1628 if ( utime(GetFullPath().fn_str(), &utm
) == 0 )
1632 #elif defined(__WIN32__)
1633 wxFileHandle
fh(GetFullPath(), wxFileHandle::Write
);
1636 FILETIME ftAccess
, ftCreate
, ftWrite
;
1639 ConvertWxToFileTime(&ftCreate
, *dtCreate
);
1641 ConvertWxToFileTime(&ftAccess
, *dtAccess
);
1643 ConvertWxToFileTime(&ftWrite
, *dtMod
);
1645 if ( ::SetFileTime(fh
,
1646 dtCreate
? &ftCreate
: NULL
,
1647 dtAccess
? &ftAccess
: NULL
,
1648 dtMod
? &ftWrite
: NULL
) )
1653 #else // other platform
1656 wxLogSysError(_("Failed to modify file times for '%s'"),
1657 GetFullPath().c_str());
1662 bool wxFileName::Touch()
1664 #if defined(__UNIX_LIKE__)
1665 // under Unix touching file is simple: just pass NULL to utime()
1666 if ( utime(GetFullPath().fn_str(), NULL
) == 0 )
1671 wxLogSysError(_("Failed to touch the file '%s'"), GetFullPath().c_str());
1674 #else // other platform
1675 wxDateTime dtNow
= wxDateTime::Now();
1677 return SetTimes(&dtNow
, &dtNow
, NULL
/* don't change create time */);
1681 bool wxFileName::GetTimes(wxDateTime
*dtAccess
,
1683 wxDateTime
*dtCreate
) const
1685 #if defined(__UNIX_LIKE__) || defined(__WXMAC__) || (defined(__DOS__) && defined(__WATCOMC__))
1687 if ( wxStat( GetFullPath().c_str(), &stBuf
) == 0 )
1690 dtAccess
->Set(stBuf
.st_atime
);
1692 dtMod
->Set(stBuf
.st_mtime
);
1694 dtCreate
->Set(stBuf
.st_ctime
);
1698 #elif defined(__WIN32__)
1699 wxFileHandle
fh(GetFullPath(), wxFileHandle::Read
);
1702 FILETIME ftAccess
, ftCreate
, ftWrite
;
1704 if ( ::GetFileTime(fh
,
1705 dtCreate
? &ftCreate
: NULL
,
1706 dtAccess
? &ftAccess
: NULL
,
1707 dtMod
? &ftWrite
: NULL
) )
1710 ConvertFileTimeToWx(dtCreate
, ftCreate
);
1712 ConvertFileTimeToWx(dtAccess
, ftAccess
);
1714 ConvertFileTimeToWx(dtMod
, ftWrite
);
1719 #else // other platform
1722 wxLogSysError(_("Failed to retrieve file times for '%s'"),
1723 GetFullPath().c_str());
1730 const short kMacExtensionMaxLength
= 16 ;
1731 class MacDefaultExtensionRecord
1734 MacDefaultExtensionRecord()
1737 m_type
= m_creator
= NULL
;
1739 MacDefaultExtensionRecord( const MacDefaultExtensionRecord
& from
)
1741 strcpy( m_ext
, from
.m_ext
) ;
1742 m_type
= from
.m_type
;
1743 m_creator
= from
.m_creator
;
1745 MacDefaultExtensionRecord( char * extension
, OSType type
, OSType creator
)
1747 strncpy( m_ext
, extension
, kMacExtensionMaxLength
) ;
1748 m_ext
[kMacExtensionMaxLength
] = 0 ;
1750 m_creator
= creator
;
1752 char m_ext
[kMacExtensionMaxLength
] ;
1757 #include "wx/dynarray.h"
1758 WX_DECLARE_OBJARRAY(MacDefaultExtensionRecord
, MacDefaultExtensionArray
) ;
1760 bool gMacDefaultExtensionsInited
= false ;
1762 #include "wx/arrimpl.cpp"
1764 WX_DEFINE_EXPORTED_OBJARRAY(MacDefaultExtensionArray
) ;
1766 MacDefaultExtensionArray gMacDefaultExtensions
;
1768 static void MacEnsureDefaultExtensionsLoaded()
1770 if ( !gMacDefaultExtensionsInited
)
1773 // load the default extensions
1774 MacDefaultExtensionRecord defaults
[1] =
1776 MacDefaultExtensionRecord( "txt" , 'TEXT' , 'ttxt' ) ,
1779 // we could load the pc exchange prefs here too
1781 for ( int i
= 0 ; i
< WXSIZEOF( defaults
) ; ++i
)
1783 gMacDefaultExtensions
.Add( defaults
[i
] ) ;
1785 gMacDefaultExtensionsInited
= true ;
1788 bool wxFileName::MacSetTypeAndCreator( wxUint32 type
, wxUint32 creator
)
1792 wxMacFilename2FSSpec(GetFullPath(),&spec
) ;
1793 OSErr err
= FSpGetFInfo( &spec
, &fndrInfo
) ;
1794 wxCHECK( err
== noErr
, false ) ;
1796 fndrInfo
.fdType
= type
;
1797 fndrInfo
.fdCreator
= creator
;
1798 FSpSetFInfo( &spec
, &fndrInfo
) ;
1802 bool wxFileName::MacGetTypeAndCreator( wxUint32
*type
, wxUint32
*creator
)
1806 wxMacFilename2FSSpec(GetFullPath(),&spec
) ;
1807 OSErr err
= FSpGetFInfo( &spec
, &fndrInfo
) ;
1808 wxCHECK( err
== noErr
, false ) ;
1810 *type
= fndrInfo
.fdType
;
1811 *creator
= fndrInfo
.fdCreator
;
1815 bool wxFileName::MacSetDefaultTypeAndCreator()
1817 wxUint32 type
, creator
;
1818 if ( wxFileName::MacFindDefaultTypeAndCreator(GetExt() , &type
,
1821 return MacSetTypeAndCreator( type
, creator
) ;
1826 bool wxFileName::MacFindDefaultTypeAndCreator( const wxString
& ext
, wxUint32
*type
, wxUint32
*creator
)
1828 MacEnsureDefaultExtensionsLoaded() ;
1829 wxString extl
= ext
.Lower() ;
1830 for( int i
= gMacDefaultExtensions
.Count() - 1 ; i
>= 0 ; --i
)
1832 if ( gMacDefaultExtensions
.Item(i
).m_ext
== extl
)
1834 *type
= gMacDefaultExtensions
.Item(i
).m_type
;
1835 *creator
= gMacDefaultExtensions
.Item(i
).m_creator
;
1842 void wxFileName::MacRegisterDefaultTypeAndCreator( const wxString
& ext
, wxUint32 type
, wxUint32 creator
)
1844 MacEnsureDefaultExtensionsLoaded() ;
1845 MacDefaultExtensionRecord rec
;
1847 rec
.m_creator
= creator
;
1848 strncpy( rec
.m_ext
, ext
.Lower().c_str() , kMacExtensionMaxLength
) ;
1849 gMacDefaultExtensions
.Add( rec
) ;