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