]> git.saurik.com Git - wxWidgets.git/blame_incremental - src/common/filename.cpp
Fixes for previous fixes
[wxWidgets.git] / src / common / filename.cpp
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: src/common/filename.cpp
3// Purpose: wxFileName - encapsulates a file path
4// Author: Robert Roebling, Vadim Zeitlin
5// Modified by:
6// Created: 28.12.2000
7// RCS-ID: $Id$
8// Copyright: (c) 2000 Robert Roebling
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12/*
13 Here are brief descriptions of the filename formats supported by this class:
14
15 wxPATH_UNIX: standard Unix format, used under Darwin as well, absolute file
16 names have the form:
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
20
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 "~".
24
25 There are also UNC names of the form \\share\fullpath
26
27 wxPATH_MAC: Mac OS 8/9 and Mac OS X under CodeWarrior 7 format, absolute file
28 names have the form
29 volume:dir1:...:dirN:filename
30 and the relative file names are either
31 :dir1:...:dirN:filename
32 or just
33 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.
38
39 wxPATH_VMS: VMS native format, absolute file names have the form
40 <device>:[dir1.dir2.dir3]file.txt
41 or
42 <device>:[000000.dir1.dir2.dir3]file.txt
43
44 the <device> is the physical device (i.e. disk). 000000 is the
45 root directory on the device which can be omitted.
46
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
53 */
54
55// ============================================================================
56// declarations
57// ============================================================================
58
59// ----------------------------------------------------------------------------
60// headers
61// ----------------------------------------------------------------------------
62
63#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
64#pragma implementation "filename.h"
65#endif
66
67// For compilers that support precompilation, includes "wx.h".
68#include "wx/wxprec.h"
69
70#ifdef __BORLANDC__
71#pragma hdrstop
72#endif
73
74#ifndef WX_PRECOMP
75#include "wx/intl.h"
76#include "wx/log.h"
77#include "wx/file.h"
78#endif
79
80#include "wx/filename.h"
81#include "wx/tokenzr.h"
82#include "wx/config.h" // for wxExpandEnvVars
83#include "wx/utils.h"
84#include "wx/file.h"
85#include "wx/dynlib.h"
86
87// For GetShort/LongPathName
88#ifdef __WIN32__
89#include "wx/msw/wrapwin.h"
90#endif
91
92#ifdef __WXWINCE__
93#include "wx/msw/private.h"
94#endif
95
96#if defined(__WXMAC__)
97 #include "wx/mac/private.h" // includes mac headers
98#endif
99
100// utime() is POSIX so should normally be available on all Unices
101#ifdef __UNIX_LIKE__
102#include <sys/types.h>
103#include <utime.h>
104#include <sys/stat.h>
105#include <unistd.h>
106#endif
107
108#ifdef __DJGPP__
109#include <unistd.h>
110#endif
111
112#ifdef __MWERKS__
113#ifdef __MACH__
114#include <sys/types.h>
115#include <utime.h>
116#include <sys/stat.h>
117#include <unistd.h>
118#else
119#include <stat.h>
120#include <unistd.h>
121#include <unix.h>
122#endif
123#endif
124
125#ifdef __WATCOMC__
126#include <io.h>
127#include <sys/utime.h>
128#include <sys/stat.h>
129#endif
130
131#ifdef __VISAGECPP__
132#ifndef MAX_PATH
133#define MAX_PATH 256
134#endif
135#endif
136
137#ifdef __EMX__
138#include <os2.h>
139#define MAX_PATH _MAX_PATH
140#endif
141
142// ----------------------------------------------------------------------------
143// private classes
144// ----------------------------------------------------------------------------
145
146// small helper class which opens and closes the file - we use it just to get
147// a file handle for the given file name to pass it to some Win32 API function
148#if defined(__WIN32__) && !defined(__WXMICROWIN__)
149
150class wxFileHandle
151{
152public:
153 enum OpenMode
154 {
155 Read,
156 Write
157 };
158
159 wxFileHandle(const wxString& filename, OpenMode mode)
160 {
161 m_hFile = ::CreateFile
162 (
163 filename, // name
164 mode == Read ? GENERIC_READ // access mask
165 : GENERIC_WRITE,
166 0, // no sharing
167 NULL, // no secutity attr
168 OPEN_EXISTING, // creation disposition
169 0, // no flags
170 NULL // no template file
171 );
172
173 if ( m_hFile == INVALID_HANDLE_VALUE )
174 {
175 wxLogSysError(_("Failed to open '%s' for %s"),
176 filename.c_str(),
177 mode == Read ? _("reading") : _("writing"));
178 }
179 }
180
181 ~wxFileHandle()
182 {
183 if ( m_hFile != INVALID_HANDLE_VALUE )
184 {
185 if ( !::CloseHandle(m_hFile) )
186 {
187 wxLogSysError(_("Failed to close file handle"));
188 }
189 }
190 }
191
192 // return true only if the file could be opened successfully
193 bool IsOk() const { return m_hFile != INVALID_HANDLE_VALUE; }
194
195 // get the handle
196 operator HANDLE() const { return m_hFile; }
197
198private:
199 HANDLE m_hFile;
200};
201
202#endif // __WIN32__
203
204// ----------------------------------------------------------------------------
205// private functions
206// ----------------------------------------------------------------------------
207
208#if wxUSE_DATETIME && defined(__WIN32__) && !defined(__WXMICROWIN__)
209
210// convert between wxDateTime and FILETIME which is a 64-bit value representing
211// the number of 100-nanosecond intervals since January 1, 1601.
212
213static void ConvertFileTimeToWx(wxDateTime *dt, const FILETIME &ft)
214{
215 FILETIME ftcopy = ft;
216 FILETIME ftLocal;
217 if ( !::FileTimeToLocalFileTime(&ftcopy, &ftLocal) )
218 {
219 wxLogLastError(_T("FileTimeToLocalFileTime"));
220 }
221
222 SYSTEMTIME st;
223 if ( !::FileTimeToSystemTime(&ftLocal, &st) )
224 {
225 wxLogLastError(_T("FileTimeToSystemTime"));
226 }
227
228 dt->Set(st.wDay, wxDateTime::Month(st.wMonth - 1), st.wYear,
229 st.wHour, st.wMinute, st.wSecond, st.wMilliseconds);
230}
231
232static void ConvertWxToFileTime(FILETIME *ft, const wxDateTime& dt)
233{
234 SYSTEMTIME st;
235 st.wDay = dt.GetDay();
236 st.wMonth = dt.GetMonth() + 1;
237 st.wYear = dt.GetYear();
238 st.wHour = dt.GetHour();
239 st.wMinute = dt.GetMinute();
240 st.wSecond = dt.GetSecond();
241 st.wMilliseconds = dt.GetMillisecond();
242
243 FILETIME ftLocal;
244 if ( !::SystemTimeToFileTime(&st, &ftLocal) )
245 {
246 wxLogLastError(_T("SystemTimeToFileTime"));
247 }
248
249 if ( !::LocalFileTimeToFileTime(&ftLocal, ft) )
250 {
251 wxLogLastError(_T("LocalFileTimeToFileTime"));
252 }
253}
254
255#endif // wxUSE_DATETIME && __WIN32__
256
257// return a string with the volume par
258static wxString wxGetVolumeString(const wxString& volume, wxPathFormat format)
259{
260 wxString path;
261
262 if ( !volume.empty() )
263 {
264 format = wxFileName::GetFormat(format);
265
266 // Special Windows UNC paths hack, part 2: undo what we did in
267 // SplitPath() and make an UNC path if we have a drive which is not a
268 // single letter (hopefully the network shares can't be one letter only
269 // although I didn't find any authoritative docs on this)
270 if ( format == wxPATH_DOS && volume.length() > 1 )
271 {
272 path << wxFILE_SEP_PATH_DOS << wxFILE_SEP_PATH_DOS << volume;
273 }
274 else if ( format == wxPATH_DOS || format == wxPATH_VMS )
275 {
276 path << volume << wxFileName::GetVolumeSeparator(format);
277 }
278 // else ignore
279 }
280
281 return path;
282}
283
284// ============================================================================
285// implementation
286// ============================================================================
287
288// ----------------------------------------------------------------------------
289// wxFileName construction
290// ----------------------------------------------------------------------------
291
292void wxFileName::Assign( const wxFileName &filepath )
293{
294 m_volume = filepath.GetVolume();
295 m_dirs = filepath.GetDirs();
296 m_name = filepath.GetName();
297 m_ext = filepath.GetExt();
298 m_relative = filepath.m_relative;
299}
300
301void wxFileName::Assign(const wxString& volume,
302 const wxString& path,
303 const wxString& name,
304 const wxString& ext,
305 wxPathFormat format )
306{
307 SetPath( path, format );
308
309 m_volume = volume;
310 m_ext = ext;
311 m_name = name;
312}
313
314void wxFileName::SetPath( const wxString &path, wxPathFormat format )
315{
316 m_dirs.Clear();
317
318 if ( !path.empty() )
319 {
320 wxPathFormat my_format = GetFormat( format );
321 wxString my_path = path;
322
323 // 1) Determine if the path is relative or absolute.
324 wxChar leadingChar = my_path[0u];
325
326 switch (my_format)
327 {
328 case wxPATH_MAC:
329 m_relative = leadingChar == wxT(':');
330
331 // We then remove a leading ":". The reason is in our
332 // storage form for relative paths:
333 // ":dir:file.txt" actually means "./dir/file.txt" in
334 // DOS notation and should get stored as
335 // (relative) (dir) (file.txt)
336 // "::dir:file.txt" actually means "../dir/file.txt"
337 // stored as (relative) (..) (dir) (file.txt)
338 // This is important only for the Mac as an empty dir
339 // actually means <UP>, whereas under DOS, double
340 // slashes can be ignored: "\\\\" is the same as "\\".
341 if (m_relative)
342 my_path.erase( 0, 1 );
343 break;
344
345 case wxPATH_VMS:
346 // TODO: what is the relative path format here?
347 m_relative = false;
348 break;
349
350 default:
351 wxFAIL_MSG( _T("Unknown path format") );
352 // !! Fall through !!
353
354 case wxPATH_UNIX:
355 // the paths of the form "~" or "~username" are absolute
356 m_relative = leadingChar != wxT('/') && leadingChar != _T('~');
357 break;
358
359 case wxPATH_DOS:
360 m_relative = !IsPathSeparator(leadingChar, my_format);
361 break;
362
363 }
364
365 // 2) Break up the path into its members. If the original path
366 // was just "/" or "\\", m_dirs will be empty. We know from
367 // the m_relative field, if this means "nothing" or "root dir".
368
369 wxStringTokenizer tn( my_path, GetPathSeparators(my_format) );
370
371 while ( tn.HasMoreTokens() )
372 {
373 wxString token = tn.GetNextToken();
374
375 // Remove empty token under DOS and Unix, interpret them
376 // as .. under Mac.
377 if (token.empty())
378 {
379 if (my_format == wxPATH_MAC)
380 m_dirs.Add( wxT("..") );
381 // else ignore
382 }
383 else
384 {
385 m_dirs.Add( token );
386 }
387 }
388 }
389 else // no path at all
390 {
391 m_relative = true;
392 }
393}
394
395void wxFileName::Assign(const wxString& fullpath,
396 wxPathFormat format)
397{
398 wxString volume, path, name, ext;
399 SplitPath(fullpath, &volume, &path, &name, &ext, format);
400
401 Assign(volume, path, name, ext, format);
402}
403
404void wxFileName::Assign(const wxString& fullpathOrig,
405 const wxString& fullname,
406 wxPathFormat format)
407{
408 // always recognize fullpath as directory, even if it doesn't end with a
409 // slash
410 wxString fullpath = fullpathOrig;
411 if ( !wxEndsWithPathSeparator(fullpath) )
412 {
413 fullpath += GetPathSeparator(format);
414 }
415
416 wxString volume, path, name, ext;
417
418 // do some consistency checks in debug mode: the name should be really just
419 // the filename and the path should be really just a path
420#ifdef __WXDEBUG__
421 wxString pathDummy, nameDummy, extDummy;
422
423 SplitPath(fullname, &pathDummy, &name, &ext, format);
424
425 wxASSERT_MSG( pathDummy.empty(),
426 _T("the file name shouldn't contain the path") );
427
428 SplitPath(fullpath, &volume, &path, &nameDummy, &extDummy, format);
429
430 wxASSERT_MSG( nameDummy.empty() && extDummy.empty(),
431 _T("the path shouldn't contain file name nor extension") );
432
433#else // !__WXDEBUG__
434 SplitPath(fullname, NULL /* no path */, &name, &ext, format);
435 SplitPath(fullpath, &volume, &path, NULL, NULL, format);
436#endif // __WXDEBUG__/!__WXDEBUG__
437
438 Assign(volume, path, name, ext, format);
439}
440
441void wxFileName::AssignDir(const wxString& dir, wxPathFormat format)
442{
443 Assign(dir, _T(""), format);
444}
445
446void wxFileName::Clear()
447{
448 m_dirs.Clear();
449
450 m_volume =
451 m_name =
452 m_ext = wxEmptyString;
453
454 // we don't have any absolute path for now
455 m_relative = true;
456}
457
458/* static */
459wxFileName wxFileName::FileName(const wxString& file, wxPathFormat format)
460{
461 return wxFileName(file, format);
462}
463
464/* static */
465wxFileName wxFileName::DirName(const wxString& dir, wxPathFormat format)
466{
467 wxFileName fn;
468 fn.AssignDir(dir, format);
469 return fn;
470}
471
472// ----------------------------------------------------------------------------
473// existence tests
474// ----------------------------------------------------------------------------
475
476bool wxFileName::FileExists() const
477{
478 return wxFileName::FileExists( GetFullPath() );
479}
480
481bool wxFileName::FileExists( const wxString &file )
482{
483 return ::wxFileExists( file );
484}
485
486bool wxFileName::DirExists() const
487{
488 return wxFileName::DirExists( GetFullPath() );
489}
490
491bool wxFileName::DirExists( const wxString &dir )
492{
493 return ::wxDirExists( dir );
494}
495
496// ----------------------------------------------------------------------------
497// CWD and HOME stuff
498// ----------------------------------------------------------------------------
499
500void wxFileName::AssignCwd(const wxString& volume)
501{
502 AssignDir(wxFileName::GetCwd(volume));
503}
504
505/* static */
506wxString wxFileName::GetCwd(const wxString& volume)
507{
508 // if we have the volume, we must get the current directory on this drive
509 // and to do this we have to chdir to this volume - at least under Windows,
510 // I don't know how to get the current drive on another volume elsewhere
511 // (TODO)
512 wxString cwdOld;
513 if ( !volume.empty() )
514 {
515 cwdOld = wxGetCwd();
516 SetCwd(volume + GetVolumeSeparator());
517 }
518
519 wxString cwd = ::wxGetCwd();
520
521 if ( !volume.empty() )
522 {
523 SetCwd(cwdOld);
524 }
525
526 return cwd;
527}
528
529bool wxFileName::SetCwd()
530{
531 return wxFileName::SetCwd( GetFullPath() );
532}
533
534bool wxFileName::SetCwd( const wxString &cwd )
535{
536 return ::wxSetWorkingDirectory( cwd );
537}
538
539void wxFileName::AssignHomeDir()
540{
541 AssignDir(wxFileName::GetHomeDir());
542}
543
544wxString wxFileName::GetHomeDir()
545{
546 return ::wxGetHomeDir();
547}
548
549void wxFileName::AssignTempFileName(const wxString& prefix, wxFile *fileTemp)
550{
551 wxString tempname = CreateTempFileName(prefix, fileTemp);
552 if ( tempname.empty() )
553 {
554 // error, failed to get temp file name
555 Clear();
556 }
557 else // ok
558 {
559 Assign(tempname);
560 }
561}
562
563/* static */
564wxString
565wxFileName::CreateTempFileName(const wxString& prefix, wxFile *fileTemp)
566{
567 wxString path, dir, name;
568
569 // use the directory specified by the prefix
570 SplitPath(prefix, &dir, &name, NULL /* extension */);
571
572#if defined(__WXWINCE__)
573 if (dir.empty())
574 {
575 // FIXME. Create \temp dir?
576 dir = wxT("\\");
577 }
578 path = dir + wxT("\\") + prefix;
579 int i = 1;
580 while (wxFileExists(path))
581 {
582 path = dir + wxT("\\") + prefix ;
583 path << i;
584 i ++;
585 }
586
587#elif defined(__WINDOWS__) && !defined(__WXMICROWIN__)
588#ifdef __WIN32__
589 if ( dir.empty() )
590 {
591 if ( !::GetTempPath(MAX_PATH, wxStringBuffer(dir, MAX_PATH + 1)) )
592 {
593 wxLogLastError(_T("GetTempPath"));
594 }
595
596 if ( dir.empty() )
597 {
598 // GetTempFileName() fails if we pass it an empty string
599 dir = _T('.');
600 }
601 }
602 else // we have a dir to create the file in
603 {
604 // ensure we use only the back slashes as GetTempFileName(), unlike all
605 // the other APIs, is picky and doesn't accept the forward ones
606 dir.Replace(_T("/"), _T("\\"));
607 }
608
609 if ( !::GetTempFileName(dir, name, 0, wxStringBuffer(path, MAX_PATH + 1)) )
610 {
611 wxLogLastError(_T("GetTempFileName"));
612
613 path.clear();
614 }
615#else // Win16
616 if ( !::GetTempFileName(NULL, prefix, 0, wxStringBuffer(path, 1025)) )
617 {
618 path.clear();
619 }
620#endif // Win32/16
621
622#elif defined(__WXPM__)
623 // for now just create a file
624 //
625 // future enhancements can be to set some extended attributes for file
626 // systems OS/2 supports that have them (HPFS, FAT32) and security
627 // (HPFS386)
628 static const wxChar *szMktempSuffix = wxT("XXX");
629 path << dir << _T('/') << name << szMktempSuffix;
630
631 // Temporarily remove - MN
632 #ifndef __WATCOMC__
633 ::DosCreateDir(wxStringBuffer(path, MAX_PATH), NULL);
634 #endif
635
636#else // !Windows, !OS/2
637 if ( dir.empty() )
638 {
639#if defined(__WXMAC__) && !defined(__DARWIN__)
640 dir = wxMacFindFolder( (short) kOnSystemDisk, kTemporaryFolderType, kCreateFolder ) ;
641#else // !Mac
642 dir = wxGetenv(_T("TMP"));
643 if ( dir.empty() )
644 {
645 dir = wxGetenv(_T("TEMP"));
646 }
647
648 if ( dir.empty() )
649 {
650 // default
651 #ifdef __DOS__
652 dir = _T(".");
653 #else
654 dir = _T("/tmp");
655 #endif
656 }
657#endif // Mac/!Mac
658 }
659
660 path = dir;
661
662 if ( !wxEndsWithPathSeparator(dir) &&
663 (name.empty() || !wxIsPathSeparator(name[0u])) )
664 {
665 path += wxFILE_SEP_PATH;
666 }
667
668 path += name;
669
670#if defined(HAVE_MKSTEMP)
671 // scratch space for mkstemp()
672 path += _T("XXXXXX");
673
674 // we need to copy the path to the buffer in which mkstemp() can modify it
675 wxCharBuffer buf( wxConvFile.cWX2MB( path ) );
676
677 // cast is safe because the string length doesn't change
678 int fdTemp = mkstemp( (char*)(const char*) buf );
679 if ( fdTemp == -1 )
680 {
681 // this might be not necessary as mkstemp() on most systems should have
682 // already done it but it doesn't hurt neither...
683 path.clear();
684 }
685 else // mkstemp() succeeded
686 {
687 path = wxConvFile.cMB2WX( (const char*) buf );
688
689 // avoid leaking the fd
690 if ( fileTemp )
691 {
692 fileTemp->Attach(fdTemp);
693 }
694 else
695 {
696 close(fdTemp);
697 }
698 }
699#else // !HAVE_MKSTEMP
700
701#ifdef HAVE_MKTEMP
702 // same as above
703 path += _T("XXXXXX");
704
705 wxCharBuffer buf = wxConvFile.cWX2MB( path );
706 if ( !mktemp( (const char*) buf ) )
707 {
708 path.clear();
709 }
710 else
711 {
712 path = wxConvFile.cMB2WX( (const char*) buf );
713 }
714#else // !HAVE_MKTEMP (includes __DOS__)
715 // generate the unique file name ourselves
716 #if !defined(__DOS__) && (!defined(__MWERKS__) || defined(__DARWIN__) )
717 path << (unsigned int)getpid();
718 #endif
719
720 wxString pathTry;
721
722 static const size_t numTries = 1000;
723 for ( size_t n = 0; n < numTries; n++ )
724 {
725 // 3 hex digits is enough for numTries == 1000 < 4096
726 pathTry = path + wxString::Format(_T("%.03x"), n);
727 if ( !wxFile::Exists(pathTry) )
728 {
729 break;
730 }
731
732 pathTry.clear();
733 }
734
735 path = pathTry;
736#endif // HAVE_MKTEMP/!HAVE_MKTEMP
737
738 if ( !path.empty() )
739 {
740 }
741#endif // HAVE_MKSTEMP/!HAVE_MKSTEMP
742
743#endif // Windows/!Windows
744
745 if ( path.empty() )
746 {
747 wxLogSysError(_("Failed to create a temporary file name"));
748 }
749 else if ( fileTemp && !fileTemp->IsOpened() )
750 {
751 // open the file - of course, there is a race condition here, this is
752 // why we always prefer using mkstemp()...
753 //
754 // NB: GetTempFileName() under Windows creates the file, so using
755 // write_excl there would fail
756 if ( !fileTemp->Open(path,
757#if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
758 wxFile::write,
759#else
760 wxFile::write_excl,
761#endif
762 wxS_IRUSR | wxS_IWUSR) )
763 {
764 // FIXME: If !ok here should we loop and try again with another
765 // file name? That is the standard recourse if open(O_EXCL)
766 // fails, though of course it should be protected against
767 // possible infinite looping too.
768
769 wxLogError(_("Failed to open temporary file."));
770
771 path.clear();
772 }
773 }
774
775 return path;
776}
777
778// ----------------------------------------------------------------------------
779// directory operations
780// ----------------------------------------------------------------------------
781
782bool wxFileName::Mkdir( int perm, int flags )
783{
784 return wxFileName::Mkdir( GetFullPath(), perm, flags );
785}
786
787bool wxFileName::Mkdir( const wxString& dir, int perm, int flags )
788{
789 if ( flags & wxPATH_MKDIR_FULL )
790 {
791 // split the path in components
792 wxFileName filename;
793 filename.AssignDir(dir);
794
795 wxString currPath;
796 if ( filename.HasVolume())
797 {
798 currPath << wxGetVolumeString(filename.GetVolume(), wxPATH_NATIVE);
799 }
800
801 wxArrayString dirs = filename.GetDirs();
802 size_t count = dirs.GetCount();
803 for ( size_t i = 0; i < count; i++ )
804 {
805 if ( i > 0 ||
806#if defined(__WXMAC__) && !defined(__DARWIN__)
807 // relative pathnames are exactely the other way round under mac...
808 !filename.IsAbsolute()
809#else
810 filename.IsAbsolute()
811#endif
812 )
813 currPath += wxFILE_SEP_PATH;
814 currPath += dirs[i];
815
816 if (!DirExists(currPath))
817 {
818 if (!wxMkdir(currPath, perm))
819 {
820 // no need to try creating further directories
821 return false;
822 }
823 }
824 }
825
826 return true;
827
828 }
829
830 return ::wxMkdir( dir, perm );
831}
832
833bool wxFileName::Rmdir()
834{
835 return wxFileName::Rmdir( GetFullPath() );
836}
837
838bool wxFileName::Rmdir( const wxString &dir )
839{
840 return ::wxRmdir( dir );
841}
842
843// ----------------------------------------------------------------------------
844// path normalization
845// ----------------------------------------------------------------------------
846
847bool wxFileName::Normalize(int flags,
848 const wxString& cwd,
849 wxPathFormat format)
850{
851 // deal with env vars renaming first as this may seriously change the path
852 if ( flags & wxPATH_NORM_ENV_VARS )
853 {
854 wxString pathOrig = GetFullPath(format);
855 wxString path = wxExpandEnvVars(pathOrig);
856 if ( path != pathOrig )
857 {
858 Assign(path);
859 }
860 }
861
862
863 // the existing path components
864 wxArrayString dirs = GetDirs();
865
866 // the path to prepend in front to make the path absolute
867 wxFileName curDir;
868
869 format = GetFormat(format);
870
871 // make the path absolute
872 if ( (flags & wxPATH_NORM_ABSOLUTE) && !IsAbsolute(format) )
873 {
874 if ( cwd.empty() )
875 {
876 curDir.AssignCwd(GetVolume());
877 }
878 else // cwd provided
879 {
880 curDir.AssignDir(cwd);
881 }
882
883 // the path may be not absolute because it doesn't have the volume name
884 // but in this case we shouldn't modify the directory components of it
885 // but just set the current volume
886 if ( !HasVolume() && curDir.HasVolume() )
887 {
888 SetVolume(curDir.GetVolume());
889
890 if ( !m_relative )
891 {
892 // yes, it was the case - we don't need curDir then
893 curDir.Clear();
894 }
895 }
896 }
897
898 // handle ~ stuff under Unix only
899 if ( (format == wxPATH_UNIX) && (flags & wxPATH_NORM_TILDE) )
900 {
901 if ( !dirs.IsEmpty() )
902 {
903 wxString dir = dirs[0u];
904 if ( !dir.empty() && dir[0u] == _T('~') )
905 {
906 curDir.AssignDir(wxGetUserHome(dir.c_str() + 1));
907
908 dirs.RemoveAt(0u);
909 }
910 }
911 }
912
913 // transform relative path into abs one
914 if ( curDir.IsOk() )
915 {
916 wxArrayString dirsNew = curDir.GetDirs();
917 size_t count = dirs.GetCount();
918 for ( size_t n = 0; n < count; n++ )
919 {
920 dirsNew.Add(dirs[n]);
921 }
922
923 dirs = dirsNew;
924 }
925
926 // now deal with ".", ".." and the rest
927 m_dirs.Empty();
928 size_t count = dirs.GetCount();
929 for ( size_t n = 0; n < count; n++ )
930 {
931 wxString dir = dirs[n];
932
933 if ( flags & wxPATH_NORM_DOTS )
934 {
935 if ( dir == wxT(".") )
936 {
937 // just ignore
938 continue;
939 }
940
941 if ( dir == wxT("..") )
942 {
943 if ( m_dirs.IsEmpty() )
944 {
945 wxLogError(_("The path '%s' contains too many \"..\"!"),
946 GetFullPath().c_str());
947 return false;
948 }
949
950 m_dirs.RemoveAt(m_dirs.GetCount() - 1);
951 continue;
952 }
953 }
954
955 if ( (flags & wxPATH_NORM_CASE) && !IsCaseSensitive(format) )
956 {
957 dir.MakeLower();
958 }
959
960 m_dirs.Add(dir);
961 }
962
963 if ( (flags & wxPATH_NORM_CASE) && !IsCaseSensitive(format) )
964 {
965 // VZ: expand env vars here too?
966
967 m_name.MakeLower();
968 m_ext.MakeLower();
969 }
970
971 // we do have the path now
972 //
973 // NB: need to do this before (maybe) calling Assign() below
974 m_relative = false;
975
976#if defined(__WIN32__)
977 if ( (flags & wxPATH_NORM_LONG) && (format == wxPATH_DOS) )
978 {
979 Assign(GetLongPath());
980 }
981#endif // Win32
982
983 return true;
984}
985
986// ----------------------------------------------------------------------------
987// absolute/relative paths
988// ----------------------------------------------------------------------------
989
990bool wxFileName::IsAbsolute(wxPathFormat format) const
991{
992 // if our path doesn't start with a path separator, it's not an absolute
993 // path
994 if ( m_relative )
995 return false;
996
997 if ( !GetVolumeSeparator(format).empty() )
998 {
999 // this format has volumes and an absolute path must have one, it's not
1000 // enough to have the full path to bean absolute file under Windows
1001 if ( GetVolume().empty() )
1002 return false;
1003 }
1004
1005 return true;
1006}
1007
1008bool wxFileName::MakeRelativeTo(const wxString& pathBase, wxPathFormat format)
1009{
1010 wxFileName fnBase = wxFileName::DirName(pathBase, format);
1011
1012 // get cwd only once - small time saving
1013 wxString cwd = wxGetCwd();
1014 Normalize(wxPATH_NORM_ALL & ~wxPATH_NORM_CASE, cwd, format);
1015 fnBase.Normalize(wxPATH_NORM_ALL & ~wxPATH_NORM_CASE, cwd, format);
1016
1017 bool withCase = IsCaseSensitive(format);
1018
1019 // we can't do anything if the files live on different volumes
1020 if ( !GetVolume().IsSameAs(fnBase.GetVolume(), withCase) )
1021 {
1022 // nothing done
1023 return false;
1024 }
1025
1026 // same drive, so we don't need our volume
1027 m_volume.clear();
1028
1029 // remove common directories starting at the top
1030 while ( !m_dirs.IsEmpty() && !fnBase.m_dirs.IsEmpty() &&
1031 m_dirs[0u].IsSameAs(fnBase.m_dirs[0u], withCase) )
1032 {
1033 m_dirs.RemoveAt(0);
1034 fnBase.m_dirs.RemoveAt(0);
1035 }
1036
1037 // add as many ".." as needed
1038 size_t count = fnBase.m_dirs.GetCount();
1039 for ( size_t i = 0; i < count; i++ )
1040 {
1041 m_dirs.Insert(wxT(".."), 0u);
1042 }
1043
1044 if ( format == wxPATH_UNIX || format == wxPATH_DOS )
1045 {
1046 // a directory made relative with respect to itself is '.' under Unix
1047 // and DOS, by definition (but we don't have to insert "./" for the
1048 // files)
1049 if ( m_dirs.IsEmpty() && IsDir() )
1050 {
1051 m_dirs.Add(_T('.'));
1052 }
1053 }
1054
1055 m_relative = true;
1056
1057 // we were modified
1058 return true;
1059}
1060
1061// ----------------------------------------------------------------------------
1062// filename kind tests
1063// ----------------------------------------------------------------------------
1064
1065bool wxFileName::SameAs(const wxFileName& filepath, wxPathFormat format) const
1066{
1067 wxFileName fn1 = *this,
1068 fn2 = filepath;
1069
1070 // get cwd only once - small time saving
1071 wxString cwd = wxGetCwd();
1072 fn1.Normalize(wxPATH_NORM_ALL & ~wxPATH_NORM_CASE, cwd, format);
1073 fn2.Normalize(wxPATH_NORM_ALL & ~wxPATH_NORM_CASE, cwd, format);
1074
1075 if ( fn1.GetFullPath() == fn2.GetFullPath() )
1076 return true;
1077
1078 // TODO: compare inodes for Unix, this works even when filenames are
1079 // different but files are the same (symlinks) (VZ)
1080
1081 return false;
1082}
1083
1084/* static */
1085bool wxFileName::IsCaseSensitive( wxPathFormat format )
1086{
1087 // only Unix filenames are truely case-sensitive
1088 return GetFormat(format) == wxPATH_UNIX;
1089}
1090
1091/* static */
1092wxString wxFileName::GetForbiddenChars(wxPathFormat format)
1093{
1094 // Inits to forbidden characters that are common to (almost) all platforms.
1095 wxString strForbiddenChars = wxT("*?");
1096
1097 // If asserts, wxPathFormat has been changed. In case of a new path format
1098 // addition, the following code might have to be updated.
1099 wxCOMPILE_TIME_ASSERT(wxPATH_MAX == 5, wxPathFormatChanged);
1100 switch ( GetFormat(format) )
1101 {
1102 default :
1103 wxFAIL_MSG( wxT("Unknown path format") );
1104 // !! Fall through !!
1105
1106 case wxPATH_UNIX:
1107 break;
1108
1109 case wxPATH_MAC:
1110 // On a Mac even names with * and ? are allowed (Tested with OS
1111 // 9.2.1 and OS X 10.2.5)
1112 strForbiddenChars = wxEmptyString;
1113 break;
1114
1115 case wxPATH_DOS:
1116 strForbiddenChars += wxT("\\/:\"<>|");
1117 break;
1118
1119 case wxPATH_VMS:
1120 break;
1121 }
1122
1123 return strForbiddenChars;
1124}
1125
1126/* static */
1127wxString wxFileName::GetVolumeSeparator(wxPathFormat format)
1128{
1129 wxString sepVol;
1130
1131 if ( (GetFormat(format) == wxPATH_DOS) ||
1132 (GetFormat(format) == wxPATH_VMS) )
1133 {
1134 sepVol = wxFILE_SEP_DSK;
1135 }
1136 //else: leave empty
1137
1138 return sepVol;
1139}
1140
1141/* static */
1142wxString wxFileName::GetPathSeparators(wxPathFormat format)
1143{
1144 wxString seps;
1145 switch ( GetFormat(format) )
1146 {
1147 case wxPATH_DOS:
1148 // accept both as native APIs do but put the native one first as
1149 // this is the one we use in GetFullPath()
1150 seps << wxFILE_SEP_PATH_DOS << wxFILE_SEP_PATH_UNIX;
1151 break;
1152
1153 default:
1154 wxFAIL_MSG( _T("Unknown wxPATH_XXX style") );
1155 // fall through
1156
1157 case wxPATH_UNIX:
1158 seps = wxFILE_SEP_PATH_UNIX;
1159 break;
1160
1161 case wxPATH_MAC:
1162 seps = wxFILE_SEP_PATH_MAC;
1163 break;
1164
1165 case wxPATH_VMS:
1166 seps = wxFILE_SEP_PATH_VMS;
1167 break;
1168 }
1169
1170 return seps;
1171}
1172
1173/* static */
1174bool wxFileName::IsPathSeparator(wxChar ch, wxPathFormat format)
1175{
1176 // wxString::Find() doesn't work as expected with NUL - it will always find
1177 // it, so it is almost surely a bug if this function is called with NUL arg
1178 wxASSERT_MSG( ch != _T('\0'), _T("shouldn't be called with NUL") );
1179
1180 return GetPathSeparators(format).Find(ch) != wxNOT_FOUND;
1181}
1182
1183// ----------------------------------------------------------------------------
1184// path components manipulation
1185// ----------------------------------------------------------------------------
1186
1187/* static */ bool wxFileName::IsValidDirComponent(const wxString& dir)
1188{
1189 if ( dir.empty() )
1190 {
1191 wxFAIL_MSG( _T("empty directory passed to wxFileName::InsertDir()") );
1192
1193 return false;
1194 }
1195
1196 const size_t len = dir.length();
1197 for ( size_t n = 0; n < len; n++ )
1198 {
1199 if ( dir[n] == GetVolumeSeparator() || IsPathSeparator(dir[n]) )
1200 {
1201 wxFAIL_MSG( _T("invalid directory component in wxFileName") );
1202
1203 return false;
1204 }
1205 }
1206
1207 return true;
1208}
1209
1210void wxFileName::AppendDir( const wxString &dir )
1211{
1212 if ( IsValidDirComponent(dir) )
1213 m_dirs.Add( dir );
1214}
1215
1216void wxFileName::PrependDir( const wxString &dir )
1217{
1218 InsertDir(0, dir);
1219}
1220
1221void wxFileName::InsertDir( int before, const wxString &dir )
1222{
1223 if ( IsValidDirComponent(dir) )
1224 m_dirs.Insert( dir, before );
1225}
1226
1227void wxFileName::RemoveDir( int pos )
1228{
1229 m_dirs.RemoveAt( (size_t)pos );
1230}
1231
1232// ----------------------------------------------------------------------------
1233// accessors
1234// ----------------------------------------------------------------------------
1235
1236void wxFileName::SetFullName(const wxString& fullname)
1237{
1238 SplitPath(fullname, NULL /* no path */, &m_name, &m_ext);
1239}
1240
1241wxString wxFileName::GetFullName() const
1242{
1243 wxString fullname = m_name;
1244 if ( !m_ext.empty() )
1245 {
1246 fullname << wxFILE_SEP_EXT << m_ext;
1247 }
1248
1249 return fullname;
1250}
1251
1252wxString wxFileName::GetPath( int flags, wxPathFormat format ) const
1253{
1254 format = GetFormat( format );
1255
1256 wxString fullpath;
1257
1258 // return the volume with the path as well if requested
1259 if ( flags & wxPATH_GET_VOLUME )
1260 {
1261 fullpath += wxGetVolumeString(GetVolume(), format);
1262 }
1263
1264 // the leading character
1265 switch ( format )
1266 {
1267 case wxPATH_MAC:
1268 if ( m_relative )
1269 fullpath += wxFILE_SEP_PATH_MAC;
1270 break;
1271
1272 case wxPATH_DOS:
1273 if ( !m_relative )
1274 fullpath += wxFILE_SEP_PATH_DOS;
1275 break;
1276
1277 default:
1278 wxFAIL_MSG( wxT("Unknown path format") );
1279 // fall through
1280
1281 case wxPATH_UNIX:
1282 if ( !m_relative )
1283 {
1284 // normally the absolute file names start with a slash
1285 // with one exception: the ones like "~/foo.bar" don't
1286 // have it
1287 if ( m_dirs[0u] != _T('~') )
1288 {
1289 fullpath += wxFILE_SEP_PATH_UNIX;
1290 }
1291 }
1292 break;
1293
1294 case wxPATH_VMS:
1295 // no leading character here but use this place to unset
1296 // wxPATH_GET_SEPARATOR flag: under VMS it doesn't make sense
1297 // as, if I understand correctly, there should never be a dot
1298 // before the closing bracket
1299 flags &= ~wxPATH_GET_SEPARATOR;
1300 }
1301
1302 if ( m_dirs.empty() )
1303 {
1304 // there is nothing more
1305 return fullpath;
1306 }
1307
1308 // then concatenate all the path components using the path separator
1309 if ( format == wxPATH_VMS )
1310 {
1311 fullpath += wxT('[');
1312 }
1313
1314 const size_t dirCount = m_dirs.GetCount();
1315 for ( size_t i = 0; i < dirCount; i++ )
1316 {
1317 switch (format)
1318 {
1319 case wxPATH_MAC:
1320 if ( m_dirs[i] == wxT(".") )
1321 {
1322 // skip appending ':', this shouldn't be done in this
1323 // case as "::" is interpreted as ".." under Unix
1324 continue;
1325 }
1326
1327 // convert back from ".." to nothing
1328 if ( m_dirs[i] != wxT("..") )
1329 fullpath += m_dirs[i];
1330 break;
1331
1332 default:
1333 wxFAIL_MSG( wxT("Unexpected path format") );
1334 // still fall through
1335
1336 case wxPATH_DOS:
1337 case wxPATH_UNIX:
1338 fullpath += m_dirs[i];
1339 break;
1340
1341 case wxPATH_VMS:
1342 // TODO: What to do with ".." under VMS
1343
1344 // convert back from ".." to nothing
1345 if ( m_dirs[i] != wxT("..") )
1346 fullpath += m_dirs[i];
1347 break;
1348 }
1349
1350 if ( (flags & wxPATH_GET_SEPARATOR) || (i != dirCount - 1) )
1351 fullpath += GetPathSeparator(format);
1352 }
1353
1354 if ( format == wxPATH_VMS )
1355 {
1356 fullpath += wxT(']');
1357 }
1358
1359 return fullpath;
1360}
1361
1362wxString wxFileName::GetFullPath( wxPathFormat format ) const
1363{
1364 // we already have a function to get the path
1365 wxString fullpath = GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR,
1366 format);
1367
1368 // now just add the file name and extension to it
1369 fullpath += GetFullName();
1370
1371 return fullpath;
1372}
1373
1374// Return the short form of the path (returns identity on non-Windows platforms)
1375wxString wxFileName::GetShortPath() const
1376{
1377#if defined(__WXMSW__) && defined(__WIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
1378 wxString path(GetFullPath());
1379 wxString pathOut;
1380 DWORD sz = ::GetShortPathName(path, NULL, 0);
1381 bool ok = sz != 0;
1382 if ( ok )
1383 {
1384 ok = ::GetShortPathName
1385 (
1386 path,
1387 wxStringBuffer(pathOut, sz),
1388 sz
1389 ) != 0;
1390 }
1391 if (ok)
1392 return pathOut;
1393
1394 return path;
1395#else
1396 return GetFullPath();
1397#endif
1398}
1399
1400// Return the long form of the path (returns identity on non-Windows platforms)
1401wxString wxFileName::GetLongPath() const
1402{
1403 wxString pathOut,
1404 path = GetFullPath();
1405
1406#if defined(__WIN32__) && !defined(__WXMICROWIN__)
1407 bool success = false;
1408
1409#if wxUSE_DYNAMIC_LOADER
1410 typedef DWORD (WINAPI *GET_LONG_PATH_NAME)(const wxChar *, wxChar *, DWORD);
1411
1412 static bool s_triedToLoad = false;
1413
1414 if ( !s_triedToLoad )
1415 {
1416 // suppress the errors about missing GetLongPathName[AW]
1417 wxLogNull noLog;
1418
1419 s_triedToLoad = true;
1420 wxDynamicLibrary dllKernel(_T("kernel32"));
1421 if ( dllKernel.IsLoaded() )
1422 {
1423 // may succeed or fail depending on the Windows version
1424 static GET_LONG_PATH_NAME s_pfnGetLongPathName = NULL;
1425#ifdef _UNICODE
1426 s_pfnGetLongPathName = (GET_LONG_PATH_NAME) dllKernel.GetSymbol(_T("GetLongPathNameW"));
1427#else
1428 s_pfnGetLongPathName = (GET_LONG_PATH_NAME) dllKernel.GetSymbol(_T("GetLongPathNameA"));
1429#endif
1430
1431 if ( s_pfnGetLongPathName )
1432 {
1433 DWORD dwSize = (*s_pfnGetLongPathName)(path, NULL, 0);
1434 bool ok = dwSize > 0;
1435
1436 if ( ok )
1437 {
1438 DWORD sz = (*s_pfnGetLongPathName)(path, NULL, 0);
1439 ok = sz != 0;
1440 if ( ok )
1441 {
1442 ok = (*s_pfnGetLongPathName)
1443 (
1444 path,
1445 wxStringBuffer(pathOut, sz),
1446 sz
1447 ) != 0;
1448 success = true;
1449 }
1450 }
1451 }
1452 }
1453 }
1454
1455 if (success)
1456 return pathOut;
1457#endif // wxUSE_DYNAMIC_LOADER
1458
1459 if (!success)
1460 {
1461 // The OS didn't support GetLongPathName, or some other error.
1462 // We need to call FindFirstFile on each component in turn.
1463
1464 WIN32_FIND_DATA findFileData;
1465 HANDLE hFind;
1466
1467 if ( HasVolume() )
1468 pathOut = GetVolume() +
1469 GetVolumeSeparator(wxPATH_DOS) +
1470 GetPathSeparator(wxPATH_DOS);
1471 else
1472 pathOut = wxEmptyString;
1473
1474 wxArrayString dirs = GetDirs();
1475 dirs.Add(GetFullName());
1476
1477 wxString tmpPath;
1478
1479 size_t count = dirs.GetCount();
1480 for ( size_t i = 0; i < count; i++ )
1481 {
1482 // We're using pathOut to collect the long-name path, but using a
1483 // temporary for appending the last path component which may be
1484 // short-name
1485 tmpPath = pathOut + dirs[i];
1486
1487 if ( tmpPath.empty() )
1488 continue;
1489
1490 // can't see this being necessary? MF
1491 if ( tmpPath.Last() == GetVolumeSeparator(wxPATH_DOS) )
1492 {
1493 // Can't pass a drive and root dir to FindFirstFile,
1494 // so continue to next dir
1495 tmpPath += wxFILE_SEP_PATH;
1496 pathOut = tmpPath;
1497 continue;
1498 }
1499
1500 hFind = ::FindFirstFile(tmpPath, &findFileData);
1501 if (hFind == INVALID_HANDLE_VALUE)
1502 {
1503 // Error: most likely reason is that path doesn't exist, so
1504 // append any unprocessed parts and return
1505 for ( i += 1; i < count; i++ )
1506 tmpPath += wxFILE_SEP_PATH + dirs[i];
1507
1508 return tmpPath;
1509 }
1510
1511 pathOut += findFileData.cFileName;
1512 if ( (i < (count-1)) )
1513 pathOut += wxFILE_SEP_PATH;
1514
1515 ::FindClose(hFind);
1516 }
1517 }
1518#else // !Win32
1519 pathOut = path;
1520#endif // Win32/!Win32
1521
1522 return pathOut;
1523}
1524
1525wxPathFormat wxFileName::GetFormat( wxPathFormat format )
1526{
1527 if (format == wxPATH_NATIVE)
1528 {
1529#if defined(__WXMSW__) || defined(__WXPM__) || defined(__DOS__)
1530 format = wxPATH_DOS;
1531#elif defined(__WXMAC__) && !defined(__DARWIN__)
1532 format = wxPATH_MAC;
1533#elif defined(__VMS)
1534 format = wxPATH_VMS;
1535#else
1536 format = wxPATH_UNIX;
1537#endif
1538 }
1539 return format;
1540}
1541
1542// ----------------------------------------------------------------------------
1543// path splitting function
1544// ----------------------------------------------------------------------------
1545
1546/* static */
1547void wxFileName::SplitPath(const wxString& fullpathWithVolume,
1548 wxString *pstrVolume,
1549 wxString *pstrPath,
1550 wxString *pstrName,
1551 wxString *pstrExt,
1552 wxPathFormat format)
1553{
1554 format = GetFormat(format);
1555
1556 wxString fullpath = fullpathWithVolume;
1557
1558 // under VMS the end of the path is ']', not the path separator used to
1559 // separate the components
1560 wxString sepPath = format == wxPATH_VMS ? wxString(_T(']'))
1561 : GetPathSeparators(format);
1562
1563 // special Windows UNC paths hack: transform \\share\path into share:path
1564 if ( format == wxPATH_DOS )
1565 {
1566 if ( fullpath.length() >= 4 &&
1567 fullpath[0u] == wxFILE_SEP_PATH_DOS &&
1568 fullpath[1u] == wxFILE_SEP_PATH_DOS )
1569 {
1570 fullpath.erase(0, 2);
1571
1572 size_t posFirstSlash = fullpath.find_first_of(sepPath);
1573 if ( posFirstSlash != wxString::npos )
1574 {
1575 fullpath[posFirstSlash] = wxFILE_SEP_DSK;
1576
1577 // UNC paths are always absolute, right? (FIXME)
1578 fullpath.insert(posFirstSlash + 1, 1, wxFILE_SEP_PATH_DOS);
1579 }
1580 }
1581 }
1582
1583 // We separate the volume here
1584 if ( format == wxPATH_DOS || format == wxPATH_VMS )
1585 {
1586 wxString sepVol = GetVolumeSeparator(format);
1587
1588 size_t posFirstColon = fullpath.find_first_of(sepVol);
1589 if ( posFirstColon != wxString::npos )
1590 {
1591 if ( pstrVolume )
1592 {
1593 *pstrVolume = fullpath.Left(posFirstColon);
1594 }
1595
1596 // remove the volume name and the separator from the full path
1597 fullpath.erase(0, posFirstColon + sepVol.length());
1598 }
1599 }
1600
1601 // find the positions of the last dot and last path separator in the path
1602 size_t posLastDot = fullpath.find_last_of(wxFILE_SEP_EXT);
1603 size_t posLastSlash = fullpath.find_last_of(sepPath);
1604
1605 if ( (posLastDot != wxString::npos) &&
1606 ((format == wxPATH_UNIX) || (format == wxPATH_VMS)) )
1607 {
1608 if ( (posLastDot == 0) ||
1609 (fullpath[posLastDot - 1] == sepPath[0u] ) )
1610 {
1611 // under Unix and VMS, dot may be (and commonly is) the first
1612 // character of the filename, don't treat the entire filename as
1613 // extension in this case
1614 posLastDot = wxString::npos;
1615 }
1616 }
1617
1618 // if we do have a dot and a slash, check that the dot is in the name part
1619 if ( (posLastDot != wxString::npos) &&
1620 (posLastSlash != wxString::npos) &&
1621 (posLastDot < posLastSlash) )
1622 {
1623 // the dot is part of the path, not the start of the extension
1624 posLastDot = wxString::npos;
1625 }
1626
1627 // now fill in the variables provided by user
1628 if ( pstrPath )
1629 {
1630 if ( posLastSlash == wxString::npos )
1631 {
1632 // no path at all
1633 pstrPath->Empty();
1634 }
1635 else
1636 {
1637 // take everything up to the path separator but take care to make
1638 // the path equal to something like '/', not empty, for the files
1639 // immediately under root directory
1640 size_t len = posLastSlash;
1641
1642 // this rule does not apply to mac since we do not start with colons (sep)
1643 // except for relative paths
1644 if ( !len && format != wxPATH_MAC)
1645 len++;
1646
1647 *pstrPath = fullpath.Left(len);
1648
1649 // special VMS hack: remove the initial bracket
1650 if ( format == wxPATH_VMS )
1651 {
1652 if ( (*pstrPath)[0u] == _T('[') )
1653 pstrPath->erase(0, 1);
1654 }
1655 }
1656 }
1657
1658 if ( pstrName )
1659 {
1660 // take all characters starting from the one after the last slash and
1661 // up to, but excluding, the last dot
1662 size_t nStart = posLastSlash == wxString::npos ? 0 : posLastSlash + 1;
1663 size_t count;
1664 if ( posLastDot == wxString::npos )
1665 {
1666 // take all until the end
1667 count = wxString::npos;
1668 }
1669 else if ( posLastSlash == wxString::npos )
1670 {
1671 count = posLastDot;
1672 }
1673 else // have both dot and slash
1674 {
1675 count = posLastDot - posLastSlash - 1;
1676 }
1677
1678 *pstrName = fullpath.Mid(nStart, count);
1679 }
1680
1681 if ( pstrExt )
1682 {
1683 if ( posLastDot == wxString::npos )
1684 {
1685 // no extension
1686 pstrExt->Empty();
1687 }
1688 else
1689 {
1690 // take everything after the dot
1691 *pstrExt = fullpath.Mid(posLastDot + 1);
1692 }
1693 }
1694}
1695
1696/* static */
1697void wxFileName::SplitPath(const wxString& fullpath,
1698 wxString *path,
1699 wxString *name,
1700 wxString *ext,
1701 wxPathFormat format)
1702{
1703 wxString volume;
1704 SplitPath(fullpath, &volume, path, name, ext, format);
1705
1706 if ( path )
1707 {
1708 path->Prepend(wxGetVolumeString(volume, format));
1709 }
1710}
1711
1712// ----------------------------------------------------------------------------
1713// time functions
1714// ----------------------------------------------------------------------------
1715
1716#if wxUSE_DATETIME
1717
1718bool wxFileName::SetTimes(const wxDateTime *dtAccess,
1719 const wxDateTime *dtMod,
1720 const wxDateTime *dtCreate)
1721{
1722#if defined(__WIN32__)
1723 if ( IsDir() )
1724 {
1725 // VZ: please let me know how to do this if you can
1726 wxFAIL_MSG( _T("SetTimes() not implemented for the directories") );
1727 }
1728 else // file
1729 {
1730 wxFileHandle fh(GetFullPath(), wxFileHandle::Write);
1731 if ( fh.IsOk() )
1732 {
1733 FILETIME ftAccess, ftCreate, ftWrite;
1734
1735 if ( dtCreate )
1736 ConvertWxToFileTime(&ftCreate, *dtCreate);
1737 if ( dtAccess )
1738 ConvertWxToFileTime(&ftAccess, *dtAccess);
1739 if ( dtMod )
1740 ConvertWxToFileTime(&ftWrite, *dtMod);
1741
1742 if ( ::SetFileTime(fh,
1743 dtCreate ? &ftCreate : NULL,
1744 dtAccess ? &ftAccess : NULL,
1745 dtMod ? &ftWrite : NULL) )
1746 {
1747 return true;
1748 }
1749 }
1750 }
1751#elif defined(__UNIX_LIKE__) || (defined(__DOS__) && defined(__WATCOMC__))
1752 if ( !dtAccess && !dtMod )
1753 {
1754 // can't modify the creation time anyhow, don't try
1755 return true;
1756 }
1757
1758 // if dtAccess or dtMod is not specified, use the other one (which must be
1759 // non NULL because of the test above) for both times
1760 utimbuf utm;
1761 utm.actime = dtAccess ? dtAccess->GetTicks() : dtMod->GetTicks();
1762 utm.modtime = dtMod ? dtMod->GetTicks() : dtAccess->GetTicks();
1763 if ( utime(GetFullPath().fn_str(), &utm) == 0 )
1764 {
1765 return true;
1766 }
1767#else // other platform
1768#endif // platforms
1769
1770 wxLogSysError(_("Failed to modify file times for '%s'"),
1771 GetFullPath().c_str());
1772
1773 return false;
1774}
1775
1776bool wxFileName::Touch()
1777{
1778#if defined(__UNIX_LIKE__)
1779 // under Unix touching file is simple: just pass NULL to utime()
1780 if ( utime(GetFullPath().fn_str(), NULL) == 0 )
1781 {
1782 return true;
1783 }
1784
1785 wxLogSysError(_("Failed to touch the file '%s'"), GetFullPath().c_str());
1786
1787 return false;
1788#else // other platform
1789 wxDateTime dtNow = wxDateTime::Now();
1790
1791 return SetTimes(&dtNow, &dtNow, NULL /* don't change create time */);
1792#endif // platforms
1793}
1794
1795bool wxFileName::GetTimes(wxDateTime *dtAccess,
1796 wxDateTime *dtMod,
1797 wxDateTime *dtCreate) const
1798{
1799#if defined(__WIN32__)
1800 // we must use different methods for the files and directories under
1801 // Windows as CreateFile(GENERIC_READ) doesn't work for the directories and
1802 // CreateFile(FILE_FLAG_BACKUP_SEMANTICS) works -- but only under NT and
1803 // not 9x
1804 bool ok;
1805 FILETIME ftAccess, ftCreate, ftWrite;
1806 if ( IsDir() )
1807 {
1808 // implemented in msw/dir.cpp
1809 extern bool wxGetDirectoryTimes(const wxString& dirname,
1810 FILETIME *, FILETIME *, FILETIME *);
1811
1812 // we should pass the path without the trailing separator to
1813 // wxGetDirectoryTimes()
1814 ok = wxGetDirectoryTimes(GetPath(wxPATH_GET_VOLUME),
1815 &ftAccess, &ftCreate, &ftWrite);
1816 }
1817 else // file
1818 {
1819 wxFileHandle fh(GetFullPath(), wxFileHandle::Read);
1820 if ( fh.IsOk() )
1821 {
1822 ok = ::GetFileTime(fh,
1823 dtCreate ? &ftCreate : NULL,
1824 dtAccess ? &ftAccess : NULL,
1825 dtMod ? &ftWrite : NULL) != 0;
1826 }
1827 else
1828 {
1829 ok = false;
1830 }
1831 }
1832
1833 if ( ok )
1834 {
1835 if ( dtCreate )
1836 ConvertFileTimeToWx(dtCreate, ftCreate);
1837 if ( dtAccess )
1838 ConvertFileTimeToWx(dtAccess, ftAccess);
1839 if ( dtMod )
1840 ConvertFileTimeToWx(dtMod, ftWrite);
1841
1842 return true;
1843 }
1844#elif defined(__UNIX_LIKE__) || defined(__WXMAC__) || (defined(__DOS__) && defined(__WATCOMC__))
1845 wxStructStat stBuf;
1846 if ( wxStat( GetFullPath().c_str(), &stBuf) == 0 )
1847 {
1848 if ( dtAccess )
1849 dtAccess->Set(stBuf.st_atime);
1850 if ( dtMod )
1851 dtMod->Set(stBuf.st_mtime);
1852 if ( dtCreate )
1853 dtCreate->Set(stBuf.st_ctime);
1854
1855 return true;
1856 }
1857#else // other platform
1858#endif // platforms
1859
1860 wxLogSysError(_("Failed to retrieve file times for '%s'"),
1861 GetFullPath().c_str());
1862
1863 return false;
1864}
1865
1866#endif // wxUSE_DATETIME
1867
1868#ifdef __WXMAC__
1869
1870const short kMacExtensionMaxLength = 16 ;
1871class MacDefaultExtensionRecord
1872{
1873public :
1874 MacDefaultExtensionRecord()
1875 {
1876 m_ext[0] = 0 ;
1877 m_type = m_creator = NULL ;
1878 }
1879 MacDefaultExtensionRecord( const MacDefaultExtensionRecord& from )
1880 {
1881 wxStrcpy( m_ext , from.m_ext ) ;
1882 m_type = from.m_type ;
1883 m_creator = from.m_creator ;
1884 }
1885 MacDefaultExtensionRecord( const wxChar * extension , OSType type , OSType creator )
1886 {
1887 wxStrncpy( m_ext , extension , kMacExtensionMaxLength ) ;
1888 m_ext[kMacExtensionMaxLength] = 0 ;
1889 m_type = type ;
1890 m_creator = creator ;
1891 }
1892 wxChar m_ext[kMacExtensionMaxLength] ;
1893 OSType m_type ;
1894 OSType m_creator ;
1895} ;
1896
1897#include "wx/dynarray.h"
1898WX_DECLARE_OBJARRAY(MacDefaultExtensionRecord, MacDefaultExtensionArray) ;
1899
1900bool gMacDefaultExtensionsInited = false ;
1901
1902#include "wx/arrimpl.cpp"
1903
1904WX_DEFINE_EXPORTED_OBJARRAY(MacDefaultExtensionArray) ;
1905
1906MacDefaultExtensionArray gMacDefaultExtensions ;
1907
1908static void MacEnsureDefaultExtensionsLoaded()
1909{
1910 if ( !gMacDefaultExtensionsInited )
1911 {
1912
1913 // load the default extensions
1914 MacDefaultExtensionRecord defaults[1] =
1915 {
1916 MacDefaultExtensionRecord( wxT("txt") , 'TEXT' , 'ttxt' ) ,
1917
1918 } ;
1919 // we could load the pc exchange prefs here too
1920
1921 for ( size_t i = 0 ; i < WXSIZEOF( defaults ) ; ++i )
1922 {
1923 gMacDefaultExtensions.Add( defaults[i] ) ;
1924 }
1925 gMacDefaultExtensionsInited = true ;
1926 }
1927}
1928bool wxFileName::MacSetTypeAndCreator( wxUint32 type , wxUint32 creator )
1929{
1930 FInfo fndrInfo ;
1931 FSSpec spec ;
1932 wxMacFilename2FSSpec(GetFullPath(),&spec) ;
1933 OSErr err = FSpGetFInfo( &spec , &fndrInfo ) ;
1934 wxCHECK( err == noErr , false ) ;
1935
1936 fndrInfo.fdType = type ;
1937 fndrInfo.fdCreator = creator ;
1938 FSpSetFInfo( &spec , &fndrInfo ) ;
1939 return true ;
1940}
1941
1942bool wxFileName::MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator )
1943{
1944 FInfo fndrInfo ;
1945 FSSpec spec ;
1946 wxMacFilename2FSSpec(GetFullPath(),&spec) ;
1947 OSErr err = FSpGetFInfo( &spec , &fndrInfo ) ;
1948 wxCHECK( err == noErr , false ) ;
1949
1950 *type = fndrInfo.fdType ;
1951 *creator = fndrInfo.fdCreator ;
1952 return true ;
1953}
1954
1955bool wxFileName::MacSetDefaultTypeAndCreator()
1956{
1957 wxUint32 type , creator ;
1958 if ( wxFileName::MacFindDefaultTypeAndCreator(GetExt() , &type ,
1959 &creator ) )
1960 {
1961 return MacSetTypeAndCreator( type , creator ) ;
1962 }
1963 return false;
1964}
1965
1966bool wxFileName::MacFindDefaultTypeAndCreator( const wxString& ext , wxUint32 *type , wxUint32 *creator )
1967{
1968 MacEnsureDefaultExtensionsLoaded() ;
1969 wxString extl = ext.Lower() ;
1970 for( int i = gMacDefaultExtensions.Count() - 1 ; i >= 0 ; --i )
1971 {
1972 if ( gMacDefaultExtensions.Item(i).m_ext == extl )
1973 {
1974 *type = gMacDefaultExtensions.Item(i).m_type ;
1975 *creator = gMacDefaultExtensions.Item(i).m_creator ;
1976 return true ;
1977 }
1978 }
1979 return false ;
1980}
1981
1982void wxFileName::MacRegisterDefaultTypeAndCreator( const wxString& ext , wxUint32 type , wxUint32 creator )
1983{
1984 MacEnsureDefaultExtensionsLoaded() ;
1985 MacDefaultExtensionRecord rec ;
1986 rec.m_type = type ;
1987 rec.m_creator = creator ;
1988 wxStrncpy( rec.m_ext , ext.Lower().c_str() , kMacExtensionMaxLength ) ;
1989 gMacDefaultExtensions.Add( rec ) ;
1990}
1991#endif