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