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