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