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