src/common/filename.cpp

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