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 #else // !Windows
 623     if ( dir.empty() )
 624     {
 625 #if defined(__WXMAC__) && !defined(__DARWIN__)
 626         dir = wxMacFindFolder(  (short) kOnSystemDisk, kTemporaryFolderType, kCreateFolder ) ;
 627 #else // !Mac
 628         dir = wxGetenv(_T("TMP"));
 629         if ( dir.empty() )
 630         {
 631             dir = wxGetenv(_T("TEMP"));
 632         }
 633
 634         if ( dir.empty() )
 635         {
 636             // default
 637             #if defined(__DOS__) || defined(__OS2__)
 638                 dir = _T(".");
 639             #else
 640                 dir = _T("/tmp");
 641             #endif
 642         }
 643 #endif // Mac/!Mac
 644     }
 645
 646     path = dir;
 647
 648     if ( !wxEndsWithPathSeparator(dir) &&
 649             (name.empty() || !wxIsPathSeparator(name[0u])) )
 650     {
 651         path += wxFILE_SEP_PATH;
 652     }
 653
 654     path += name;
 655
 656 #if defined(HAVE_MKSTEMP)
 657     // scratch space for mkstemp()
 658     path += _T("XXXXXX");
 659
 660     // we need to copy the path to the buffer in which mkstemp() can modify it
 661     wxCharBuffer buf( wxConvFile.cWX2MB( path ) );
 662
 663     // cast is safe because the string length doesn't change
 664     int fdTemp = mkstemp( (char*)(const char*) buf );
 665     if ( fdTemp == -1 )
 666     {
 667         // this might be not necessary as mkstemp() on most systems should have
 668         // already done it but it doesn't hurt neither...
 669         path.clear();
 670     }
 671     else // mkstemp() succeeded
 672     {
 673         path = wxConvFile.cMB2WX( (const char*) buf );
 674
 675         // avoid leaking the fd
 676         if ( fileTemp )
 677         {
 678             fileTemp->Attach(fdTemp);
 679         }
 680         else
 681         {
 682             close(fdTemp);
 683         }
 684     }
 685 #else // !HAVE_MKSTEMP
 686
 687 #ifdef HAVE_MKTEMP
 688     // same as above
 689     path += _T("XXXXXX");
 690
 691     wxCharBuffer buf = wxConvFile.cWX2MB( path );
 692     if ( !mktemp( (const char*) buf ) )
 693     {
 694         path.clear();
 695     }
 696     else
 697     {
 698         path = wxConvFile.cMB2WX( (const char*) buf );
 699     }
 700 #else // !HAVE_MKTEMP (includes __DOS__)
 701     // generate the unique file name ourselves
 702     #if !defined(__DOS__) && (!defined(__MWERKS__) || defined(__DARWIN__) )
 703     path << (unsigned int)getpid();
 704     #endif
 705
 706     wxString pathTry;
 707
 708     static const size_t numTries = 1000;
 709     for ( size_t n = 0; n < numTries; n++ )
 710     {
 711         // 3 hex digits is enough for numTries == 1000 < 4096
 712         pathTry = path + wxString::Format(_T("%.03x"), (unsigned int) n);
 713         if ( !wxFile::Exists(pathTry) )
 714         {
 715             break;
 716         }
 717
 718         pathTry.clear();
 719     }
 720
 721     path = pathTry;
 722 #endif // HAVE_MKTEMP/!HAVE_MKTEMP
 723
 724     if ( !path.empty() )
 725     {
 726     }
 727 #endif // HAVE_MKSTEMP/!HAVE_MKSTEMP
 728
 729 #endif // Windows/!Windows
 730
 731     if ( path.empty() )
 732     {
 733         wxLogSysError(_("Failed to create a temporary file name"));
 734     }
 735     else if ( fileTemp && !fileTemp->IsOpened() )
 736     {
 737         // open the file - of course, there is a race condition here, this is
 738         // why we always prefer using mkstemp()...
 739         //
 740         // NB: GetTempFileName() under Windows creates the file, so using
 741         //     write_excl there would fail
 742         if ( !fileTemp->Open(path,
 743 #if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
 744                              wxFile::write,
 745 #else
 746                              wxFile::write_excl,
 747 #endif
 748                              wxS_IRUSR | wxS_IWUSR) )
 749         {
 750             // FIXME: If !ok here should we loop and try again with another
 751             //        file name?  That is the standard recourse if open(O_EXCL)
 752             //        fails, though of course it should be protected against
 753             //        possible infinite looping too.
 754
 755             wxLogError(_("Failed to open temporary file."));
 756
 757             path.clear();
 758         }
 759     }
 760
 761     return path;
 762 }
 763
 764 // ----------------------------------------------------------------------------
 765 // directory operations
 766 // ----------------------------------------------------------------------------
 767
 768 bool wxFileName::Mkdir( int perm, int flags )
 769 {
 770     return wxFileName::Mkdir( GetFullPath(), perm, flags );
 771 }
 772
 773 bool wxFileName::Mkdir( const wxString& dir, int perm, int flags )
 774 {
 775     if ( flags & wxPATH_MKDIR_FULL )
 776     {
 777         // split the path in components
 778         wxFileName filename;
 779         filename.AssignDir(dir);
 780
 781         wxString currPath;
 782         if ( filename.HasVolume())
 783         {
 784             currPath << wxGetVolumeString(filename.GetVolume(), wxPATH_NATIVE);
 785         }
 786
 787         wxArrayString dirs = filename.GetDirs();
 788         size_t count = dirs.GetCount();
 789         for ( size_t i = 0; i < count; i++ )
 790         {
 791             if ( i > 0 ||
 792 #if defined(__WXMAC__) && !defined(__DARWIN__)
 793                         // relative pathnames are exactely the other way round under mac...
 794                 !filename.IsAbsolute()
 795 #else
 796                 filename.IsAbsolute()
 797 #endif
 798             )
 799                 currPath += wxFILE_SEP_PATH;
 800             currPath += dirs[i];
 801
 802             if (!DirExists(currPath))
 803             {
 804                 if (!wxMkdir(currPath, perm))
 805                 {
 806                     // no need to try creating further directories
 807                     return false;
 808                 }
 809             }
 810         }
 811
 812         return true;
 813
 814     }
 815
 816     return ::wxMkdir( dir, perm );
 817 }
 818
 819 bool wxFileName::Rmdir()
 820 {
 821     return wxFileName::Rmdir( GetFullPath() );
 822 }
 823
 824 bool wxFileName::Rmdir( const wxString &dir )
 825 {
 826     return ::wxRmdir( dir );
 827 }
 828
 829 // ----------------------------------------------------------------------------
 830 // path normalization
 831 // ----------------------------------------------------------------------------
 832
 833 bool wxFileName::Normalize(int flags,
 834                            const wxString& cwd,
 835                            wxPathFormat format)
 836 {
 837     // deal with env vars renaming first as this may seriously change the path
 838     if ( flags & wxPATH_NORM_ENV_VARS )
 839     {
 840         wxString pathOrig = GetFullPath(format);
 841         wxString path = wxExpandEnvVars(pathOrig);
 842         if ( path != pathOrig )
 843         {
 844             Assign(path);
 845         }
 846     }
 847
 848
 849     // the existing path components
 850     wxArrayString dirs = GetDirs();
 851
 852     // the path to prepend in front to make the path absolute
 853     wxFileName curDir;
 854
 855     format = GetFormat(format);
 856
 857     // make the path absolute
 858     if ( (flags & wxPATH_NORM_ABSOLUTE) && !IsAbsolute(format) )
 859     {
 860         if ( cwd.empty() )
 861         {
 862             curDir.AssignCwd(GetVolume());
 863         }
 864         else // cwd provided
 865         {
 866             curDir.AssignDir(cwd);
 867         }
 868
 869         // the path may be not absolute because it doesn't have the volume name
 870         // but in this case we shouldn't modify the directory components of it
 871         // but just set the current volume
 872         if ( !HasVolume() && curDir.HasVolume() )
 873         {
 874             SetVolume(curDir.GetVolume());
 875
 876             if ( !m_relative )
 877             {
 878                 // yes, it was the case - we don't need curDir then
 879                 curDir.Clear();
 880             }
 881         }
 882     }
 883
 884     // handle ~ stuff under Unix only
 885     if ( (format == wxPATH_UNIX) && (flags & wxPATH_NORM_TILDE) )
 886     {
 887         if ( !dirs.IsEmpty() )
 888         {
 889             wxString dir = dirs[0u];
 890             if ( !dir.empty() && dir[0u] == _T('~') )
 891             {
 892                 curDir.AssignDir(wxGetUserHome(dir.c_str() + 1));
 893
 894                 dirs.RemoveAt(0u);
 895             }
 896         }
 897     }
 898
 899     // transform relative path into abs one
 900     if ( curDir.IsOk() )
 901     {
 902         wxArrayString dirsNew = curDir.GetDirs();
 903         size_t count = dirs.GetCount();
 904         for ( size_t n = 0; n < count; n++ )
 905         {
 906             dirsNew.Add(dirs[n]);
 907         }
 908
 909         dirs = dirsNew;
 910     }
 911
 912     // now deal with ".", ".." and the rest
 913     m_dirs.Empty();
 914     size_t count = dirs.GetCount();
 915     for ( size_t n = 0; n < count; n++ )
 916     {
 917         wxString dir = dirs[n];
 918
 919         if ( flags & wxPATH_NORM_DOTS )
 920         {
 921             if ( dir == wxT(".") )
 922             {
 923                 // just ignore
 924                 continue;
 925             }
 926
 927             if ( dir == wxT("..") )
 928             {
 929                 if ( m_dirs.IsEmpty() )
 930                 {
 931                     wxLogError(_("The path '%s' contains too many \"..\"!"),
 932                                GetFullPath().c_str());
 933                     return false;
 934                 }
 935
 936                 m_dirs.RemoveAt(m_dirs.GetCount() - 1);
 937                 continue;
 938             }
 939         }
 940
 941         if ( (flags & wxPATH_NORM_CASE) && !IsCaseSensitive(format) )
 942         {
 943             dir.MakeLower();
 944         }
 945
 946         m_dirs.Add(dir);
 947     }
 948
 949     if ( (flags & wxPATH_NORM_CASE) && !IsCaseSensitive(format) )
 950     {
 951         // VZ: expand env vars here too?
 952
 953         m_name.MakeLower();
 954         m_ext.MakeLower();
 955     }
 956
 957     // we do have the path now
 958     //
 959     // NB: need to do this before (maybe) calling Assign() below
 960     m_relative = false;
 961
 962 #if defined(__WIN32__)
 963     if ( (flags & wxPATH_NORM_LONG) && (format == wxPATH_DOS) )
 964     {
 965         Assign(GetLongPath());
 966     }
 967 #endif // Win32
 968
 969     return true;
 970 }
 971
 972 // ----------------------------------------------------------------------------
 973 // absolute/relative paths
 974 // ----------------------------------------------------------------------------
 975
 976 bool wxFileName::IsAbsolute(wxPathFormat format) const
 977 {
 978     // if our path doesn't start with a path separator, it's not an absolute
 979     // path
 980     if ( m_relative )
 981         return false;
 982
 983     if ( !GetVolumeSeparator(format).empty() )
 984     {
 985         // this format has volumes and an absolute path must have one, it's not
 986         // enough to have the full path to bean absolute file under Windows
 987         if ( GetVolume().empty() )
 988             return false;
 989     }
 990
 991     return true;
 992 }
 993
 994 bool wxFileName::MakeRelativeTo(const wxString& pathBase, wxPathFormat format)
 995 {
 996     wxFileName fnBase = wxFileName::DirName(pathBase, format);
 997
 998     // get cwd only once - small time saving
 999     wxString cwd = wxGetCwd();
1000     Normalize(wxPATH_NORM_ALL & ~wxPATH_NORM_CASE, cwd, format);
1001     fnBase.Normalize(wxPATH_NORM_ALL & ~wxPATH_NORM_CASE, cwd, format);
1002
1003     bool withCase = IsCaseSensitive(format);
1004
1005     // we can't do anything if the files live on different volumes
1006     if ( !GetVolume().IsSameAs(fnBase.GetVolume(), withCase) )
1007     {
1008         // nothing done
1009         return false;
1010     }
1011
1012     // same drive, so we don't need our volume
1013     m_volume.clear();
1014
1015     // remove common directories starting at the top
1016     while ( !m_dirs.IsEmpty() && !fnBase.m_dirs.IsEmpty() &&
1017                 m_dirs[0u].IsSameAs(fnBase.m_dirs[0u], withCase) )
1018     {
1019         m_dirs.RemoveAt(0);
1020         fnBase.m_dirs.RemoveAt(0);
1021     }
1022
1023     // add as many ".." as needed
1024     size_t count = fnBase.m_dirs.GetCount();
1025     for ( size_t i = 0; i < count; i++ )
1026     {
1027         m_dirs.Insert(wxT(".."), 0u);
1028     }
1029
1030     if ( format == wxPATH_UNIX || format == wxPATH_DOS )
1031     {
1032         // a directory made relative with respect to itself is '.' under Unix
1033         // and DOS, by definition (but we don't have to insert "./" for the
1034         // files)
1035         if ( m_dirs.IsEmpty() && IsDir() )
1036         {
1037             m_dirs.Add(_T('.'));
1038         }
1039     }
1040
1041     m_relative = true;
1042
1043     // we were modified
1044     return true;
1045 }
1046
1047 // ----------------------------------------------------------------------------
1048 // filename kind tests
1049 // ----------------------------------------------------------------------------
1050
1051 bool wxFileName::SameAs(const wxFileName& filepath, wxPathFormat format) const
1052 {
1053     wxFileName fn1 = *this,
1054                fn2 = filepath;
1055
1056     // get cwd only once - small time saving
1057     wxString cwd = wxGetCwd();
1058     fn1.Normalize(wxPATH_NORM_ALL & ~wxPATH_NORM_CASE, cwd, format);
1059     fn2.Normalize(wxPATH_NORM_ALL & ~wxPATH_NORM_CASE, cwd, format);
1060
1061     if ( fn1.GetFullPath() == fn2.GetFullPath() )
1062         return true;
1063
1064     // TODO: compare inodes for Unix, this works even when filenames are
1065     //       different but files are the same (symlinks) (VZ)
1066
1067     return false;
1068 }
1069
1070 /* static */
1071 bool wxFileName::IsCaseSensitive( wxPathFormat format )
1072 {
1073     // only Unix filenames are truely case-sensitive
1074     return GetFormat(format) == wxPATH_UNIX;
1075 }
1076
1077 /* static */
1078 wxString wxFileName::GetForbiddenChars(wxPathFormat format)
1079 {
1080     // Inits to forbidden characters that are common to (almost) all platforms.
1081     wxString strForbiddenChars = wxT("*?");
1082
1083     // If asserts, wxPathFormat has been changed. In case of a new path format
1084     // addition, the following code might have to be updated.
1085     wxCOMPILE_TIME_ASSERT(wxPATH_MAX == 5, wxPathFormatChanged);
1086     switch ( GetFormat(format) )
1087     {
1088         default :
1089             wxFAIL_MSG( wxT("Unknown path format") );
1090             // !! Fall through !!
1091
1092         case wxPATH_UNIX:
1093             break;
1094
1095         case wxPATH_MAC:
1096             // On a Mac even names with * and ? are allowed (Tested with OS
1097             // 9.2.1 and OS X 10.2.5)
1098             strForbiddenChars = wxEmptyString;
1099             break;
1100
1101         case wxPATH_DOS:
1102             strForbiddenChars += wxT("\\/:\"<>|");
1103             break;
1104
1105         case wxPATH_VMS:
1106             break;
1107     }
1108
1109     return strForbiddenChars;
1110 }
1111
1112 /* static */
1113 wxString wxFileName::GetVolumeSeparator(wxPathFormat format)
1114 {
1115     wxString sepVol;
1116
1117     if ( (GetFormat(format) == wxPATH_DOS) ||
1118          (GetFormat(format) == wxPATH_VMS) )
1119     {
1120         sepVol = wxFILE_SEP_DSK;
1121     }
1122     //else: leave empty
1123
1124     return sepVol;
1125 }
1126
1127 /* static */
1128 wxString wxFileName::GetPathSeparators(wxPathFormat format)
1129 {
1130     wxString seps;
1131     switch ( GetFormat(format) )
1132     {
1133         case wxPATH_DOS:
1134             // accept both as native APIs do but put the native one first as
1135             // this is the one we use in GetFullPath()
1136             seps << wxFILE_SEP_PATH_DOS << wxFILE_SEP_PATH_UNIX;
1137             break;
1138
1139         default:
1140             wxFAIL_MSG( _T("Unknown wxPATH_XXX style") );
1141             // fall through
1142
1143         case wxPATH_UNIX:
1144             seps = wxFILE_SEP_PATH_UNIX;
1145             break;
1146
1147         case wxPATH_MAC:
1148             seps = wxFILE_SEP_PATH_MAC;
1149             break;
1150
1151         case wxPATH_VMS:
1152             seps = wxFILE_SEP_PATH_VMS;
1153             break;
1154     }
1155
1156     return seps;
1157 }
1158
1159 /* static */
1160 bool wxFileName::IsPathSeparator(wxChar ch, wxPathFormat format)
1161 {
1162     // wxString::Find() doesn't work as expected with NUL - it will always find
1163     // it, so it is almost surely a bug if this function is called with NUL arg
1164     wxASSERT_MSG( ch != _T('\0'), _T("shouldn't be called with NUL") );
1165
1166     return GetPathSeparators(format).Find(ch) != wxNOT_FOUND;
1167 }
1168
1169 // ----------------------------------------------------------------------------
1170 // path components manipulation
1171 // ----------------------------------------------------------------------------
1172
1173 /* static */ bool wxFileName::IsValidDirComponent(const wxString& dir)
1174 {
1175     if ( dir.empty() )
1176     {
1177         wxFAIL_MSG( _T("empty directory passed to wxFileName::InsertDir()") );
1178
1179         return false;
1180     }
1181
1182     const size_t len = dir.length();
1183     for ( size_t n = 0; n < len; n++ )
1184     {
1185         if ( dir[n] == GetVolumeSeparator() || IsPathSeparator(dir[n]) )
1186         {
1187             wxFAIL_MSG( _T("invalid directory component in wxFileName") );
1188
1189             return false;
1190         }
1191     }
1192
1193     return true;
1194 }
1195
1196 void wxFileName::AppendDir( const wxString &dir )
1197 {
1198     if ( IsValidDirComponent(dir) )
1199         m_dirs.Add( dir );
1200 }
1201
1202 void wxFileName::PrependDir( const wxString &dir )
1203 {
1204     InsertDir(0, dir);
1205 }
1206
1207 void wxFileName::InsertDir( int before, const wxString &dir )
1208 {
1209     if ( IsValidDirComponent(dir) )
1210         m_dirs.Insert( dir, before );
1211 }
1212
1213 void wxFileName::RemoveDir( int pos )
1214 {
1215     m_dirs.RemoveAt( (size_t)pos );
1216 }
1217
1218 // ----------------------------------------------------------------------------
1219 // accessors
1220 // ----------------------------------------------------------------------------
1221
1222 void wxFileName::SetFullName(const wxString& fullname)
1223 {
1224     SplitPath(fullname, NULL /* no path */, &m_name, &m_ext);
1225 }
1226
1227 wxString wxFileName::GetFullName() const
1228 {
1229     wxString fullname = m_name;
1230     if ( !m_ext.empty() )
1231     {
1232         fullname << wxFILE_SEP_EXT << m_ext;
1233     }
1234
1235     return fullname;
1236 }
1237
1238 wxString wxFileName::GetPath( int flags, wxPathFormat format ) const
1239 {
1240     format = GetFormat( format );
1241
1242     wxString fullpath;
1243
1244     // return the volume with the path as well if requested
1245     if ( flags & wxPATH_GET_VOLUME )
1246     {
1247         fullpath += wxGetVolumeString(GetVolume(), format);
1248     }
1249
1250     // the leading character
1251     switch ( format )
1252     {
1253         case wxPATH_MAC:
1254             if ( m_relative )
1255                 fullpath += wxFILE_SEP_PATH_MAC;
1256             break;
1257
1258         case wxPATH_DOS:
1259             if ( !m_relative )
1260                 fullpath += wxFILE_SEP_PATH_DOS;
1261             break;
1262
1263         default:
1264             wxFAIL_MSG( wxT("Unknown path format") );
1265             // fall through
1266
1267         case wxPATH_UNIX:
1268             if ( !m_relative )
1269             {
1270                 // normally the absolute file names start with a slash
1271                 // with one exception: the ones like "~/foo.bar" don't
1272                 // have it
1273                 if ( m_dirs.IsEmpty() || m_dirs[0u] != _T('~') )
1274                 {
1275                     fullpath += wxFILE_SEP_PATH_UNIX;
1276                 }
1277             }
1278             break;
1279
1280         case wxPATH_VMS:
1281             // no leading character here but use this place to unset
1282             // wxPATH_GET_SEPARATOR flag: under VMS it doesn't make sense
1283             // as, if I understand correctly, there should never be a dot
1284             // before the closing bracket
1285             flags &= ~wxPATH_GET_SEPARATOR;
1286     }
1287
1288     if ( m_dirs.empty() )
1289     {
1290         // there is nothing more
1291         return fullpath;
1292     }
1293
1294     // then concatenate all the path components using the path separator
1295     if ( format == wxPATH_VMS )
1296     {
1297         fullpath += wxT('[');
1298     }
1299
1300     const size_t dirCount = m_dirs.GetCount();
1301     for ( size_t i = 0; i < dirCount; i++ )
1302     {
1303         switch (format)
1304         {
1305             case wxPATH_MAC:
1306                 if ( m_dirs[i] == wxT(".") )
1307                 {
1308                     // skip appending ':', this shouldn't be done in this
1309                     // case as "::" is interpreted as ".." under Unix
1310                     continue;
1311                 }
1312
1313                 // convert back from ".." to nothing
1314                 if ( m_dirs[i] != wxT("..") )
1315                      fullpath += m_dirs[i];
1316                 break;
1317
1318             default:
1319                 wxFAIL_MSG( wxT("Unexpected path format") );
1320                 // still fall through
1321
1322             case wxPATH_DOS:
1323             case wxPATH_UNIX:
1324                 fullpath += m_dirs[i];
1325                 break;
1326
1327             case wxPATH_VMS:
1328                 // TODO: What to do with ".." under VMS
1329
1330                 // convert back from ".." to nothing
1331                 if ( m_dirs[i] != wxT("..") )
1332                     fullpath += m_dirs[i];
1333                 break;
1334         }
1335
1336         if ( (flags & wxPATH_GET_SEPARATOR) || (i != dirCount - 1) )
1337             fullpath += GetPathSeparator(format);
1338     }
1339
1340     if ( format == wxPATH_VMS )
1341     {
1342         fullpath += wxT(']');
1343     }
1344
1345     return fullpath;
1346 }
1347
1348 wxString wxFileName::GetFullPath( wxPathFormat format ) const
1349 {
1350     // we already have a function to get the path
1351     wxString fullpath = GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR,
1352                                 format);
1353
1354     // now just add the file name and extension to it
1355     fullpath += GetFullName();
1356
1357     return fullpath;
1358 }
1359
1360 // Return the short form of the path (returns identity on non-Windows platforms)
1361 wxString wxFileName::GetShortPath() const
1362 {
1363 #if defined(__WXMSW__) && defined(__WIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
1364     wxString path(GetFullPath());
1365     wxString pathOut;
1366     DWORD sz = ::GetShortPathName(path, NULL, 0);
1367     bool ok = sz != 0;
1368     if ( ok )
1369     {
1370         ok = ::GetShortPathName
1371                (
1372                 path,
1373                 wxStringBuffer(pathOut, sz),
1374                 sz
1375                ) != 0;
1376     }
1377     if (ok)
1378         return pathOut;
1379
1380     return path;
1381 #else
1382     return GetFullPath();
1383 #endif
1384 }
1385
1386 // Return the long form of the path (returns identity on non-Windows platforms)
1387 wxString wxFileName::GetLongPath() const
1388 {
1389     wxString pathOut,
1390              path = GetFullPath();
1391
1392 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
1393     bool success = false;
1394
1395 #if wxUSE_DYNAMIC_LOADER
1396     typedef DWORD (WINAPI *GET_LONG_PATH_NAME)(const wxChar *, wxChar *, DWORD);
1397
1398     static bool s_triedToLoad = false;
1399
1400     if ( !s_triedToLoad )
1401     {
1402         // suppress the errors about missing GetLongPathName[AW]
1403         wxLogNull noLog;
1404
1405         s_triedToLoad = true;
1406         wxDynamicLibrary dllKernel(_T("kernel32"));
1407         if ( dllKernel.IsLoaded() )
1408         {
1409             // may succeed or fail depending on the Windows version
1410             static GET_LONG_PATH_NAME s_pfnGetLongPathName = NULL;
1411 #ifdef _UNICODE
1412             s_pfnGetLongPathName = (GET_LONG_PATH_NAME) dllKernel.GetSymbol(_T("GetLongPathNameW"));
1413 #else
1414             s_pfnGetLongPathName = (GET_LONG_PATH_NAME) dllKernel.GetSymbol(_T("GetLongPathNameA"));
1415 #endif
1416
1417             if ( s_pfnGetLongPathName )
1418             {
1419                 DWORD dwSize = (*s_pfnGetLongPathName)(path, NULL, 0);
1420                 bool ok = dwSize > 0;
1421
1422                 if ( ok )
1423                 {
1424                     DWORD sz = (*s_pfnGetLongPathName)(path, NULL, 0);
1425                     ok = sz != 0;
1426                     if ( ok )
1427                     {
1428                         ok = (*s_pfnGetLongPathName)
1429                                 (
1430                                 path,
1431                                 wxStringBuffer(pathOut, sz),
1432                                 sz
1433                                 ) != 0;
1434                         success = true;
1435                     }
1436                 }
1437             }
1438         }
1439     }
1440
1441     if (success)
1442         return pathOut;
1443 #endif // wxUSE_DYNAMIC_LOADER
1444
1445     if (!success)
1446     {
1447         // The OS didn't support GetLongPathName, or some other error.
1448         // We need to call FindFirstFile on each component in turn.
1449
1450         WIN32_FIND_DATA findFileData;
1451         HANDLE hFind;
1452
1453         if ( HasVolume() )
1454             pathOut = GetVolume() +
1455                       GetVolumeSeparator(wxPATH_DOS) +
1456                       GetPathSeparator(wxPATH_DOS);
1457         else
1458             pathOut = wxEmptyString;
1459
1460         wxArrayString dirs = GetDirs();
1461         dirs.Add(GetFullName());
1462
1463         wxString tmpPath;
1464
1465         size_t count = dirs.GetCount();
1466         for ( size_t i = 0; i < count; i++ )
1467         {
1468             // We're using pathOut to collect the long-name path, but using a
1469             // temporary for appending the last path component which may be
1470             // short-name
1471             tmpPath = pathOut + dirs[i];
1472
1473             if ( tmpPath.empty() )
1474                 continue;
1475
1476             // can't see this being necessary? MF
1477             if ( tmpPath.Last() == GetVolumeSeparator(wxPATH_DOS) )
1478             {
1479                 // Can't pass a drive and root dir to FindFirstFile,
1480                 // so continue to next dir
1481                 tmpPath += wxFILE_SEP_PATH;
1482                 pathOut = tmpPath;
1483                 continue;
1484             }
1485
1486             hFind = ::FindFirstFile(tmpPath, &findFileData);
1487             if (hFind == INVALID_HANDLE_VALUE)
1488             {
1489                 // Error: most likely reason is that path doesn't exist, so
1490                 // append any unprocessed parts and return
1491                 for ( i += 1; i < count; i++ )
1492                     tmpPath += wxFILE_SEP_PATH + dirs[i];
1493
1494                 return tmpPath;
1495             }
1496
1497             pathOut += findFileData.cFileName;
1498             if ( (i < (count-1)) )
1499                 pathOut += wxFILE_SEP_PATH;
1500
1501             ::FindClose(hFind);
1502         }
1503     }
1504 #else // !Win32
1505     pathOut = path;
1506 #endif // Win32/!Win32
1507
1508     return pathOut;
1509 }
1510
1511 wxPathFormat wxFileName::GetFormat( wxPathFormat format )
1512 {
1513     if (format == wxPATH_NATIVE)
1514     {
1515 #if defined(__WXMSW__) || defined(__OS2__) || defined(__DOS__)
1516         format = wxPATH_DOS;
1517 #elif defined(__WXMAC__) && !defined(__DARWIN__)
1518         format = wxPATH_MAC;
1519 #elif defined(__VMS)
1520         format = wxPATH_VMS;
1521 #else
1522         format = wxPATH_UNIX;
1523 #endif
1524     }
1525     return format;
1526 }
1527
1528 // ----------------------------------------------------------------------------
1529 // path splitting function
1530 // ----------------------------------------------------------------------------
1531
1532 /* static */
1533 void wxFileName::SplitPath(const wxString& fullpathWithVolume,
1534                            wxString *pstrVolume,
1535                            wxString *pstrPath,
1536                            wxString *pstrName,
1537                            wxString *pstrExt,
1538                            wxPathFormat format)
1539 {
1540     format = GetFormat(format);
1541
1542     wxString fullpath = fullpathWithVolume;
1543
1544     // under VMS the end of the path is ']', not the path separator used to
1545     // separate the components
1546     wxString sepPath = format == wxPATH_VMS ? wxString(_T(']'))
1547                                             : GetPathSeparators(format);
1548
1549     // special Windows UNC paths hack: transform \\share\path into share:path
1550     if ( format == wxPATH_DOS )
1551     {
1552         if ( fullpath.length() >= 4 &&
1553                 fullpath[0u] == wxFILE_SEP_PATH_DOS &&
1554                     fullpath[1u] == wxFILE_SEP_PATH_DOS )
1555         {
1556             fullpath.erase(0, 2);
1557
1558             size_t posFirstSlash = fullpath.find_first_of(sepPath);
1559             if ( posFirstSlash != wxString::npos )
1560             {
1561                 fullpath[posFirstSlash] = wxFILE_SEP_DSK;
1562
1563                 // UNC paths are always absolute, right? (FIXME)
1564                 fullpath.insert(posFirstSlash + 1, 1, wxFILE_SEP_PATH_DOS);
1565             }
1566         }
1567     }
1568
1569     // We separate the volume here
1570     if ( format == wxPATH_DOS || format == wxPATH_VMS )
1571     {
1572         wxString sepVol = GetVolumeSeparator(format);
1573
1574         size_t posFirstColon = fullpath.find_first_of(sepVol);
1575         if ( posFirstColon != wxString::npos )
1576         {
1577             if ( pstrVolume )
1578             {
1579                 *pstrVolume = fullpath.Left(posFirstColon);
1580             }
1581
1582             // remove the volume name and the separator from the full path
1583             fullpath.erase(0, posFirstColon + sepVol.length());
1584         }
1585     }
1586
1587     // find the positions of the last dot and last path separator in the path
1588     size_t posLastDot = fullpath.find_last_of(wxFILE_SEP_EXT);
1589     size_t posLastSlash = fullpath.find_last_of(sepPath);
1590
1591     if ( (posLastDot != wxString::npos) &&
1592             ((format == wxPATH_UNIX) || (format == wxPATH_VMS)) )
1593     {
1594         if ( (posLastDot == 0) ||
1595              (fullpath[posLastDot - 1] == sepPath[0u] ) )
1596         {
1597             // under Unix and VMS, dot may be (and commonly is) the first
1598             // character of the filename, don't treat the entire filename as
1599             // extension in this case
1600             posLastDot = wxString::npos;
1601         }
1602     }
1603
1604     // if we do have a dot and a slash, check that the dot is in the name part
1605     if ( (posLastDot != wxString::npos) &&
1606          (posLastSlash != wxString::npos) &&
1607          (posLastDot < posLastSlash) )
1608     {
1609         // the dot is part of the path, not the start of the extension
1610         posLastDot = wxString::npos;
1611     }
1612
1613     // now fill in the variables provided by user
1614     if ( pstrPath )
1615     {
1616         if ( posLastSlash == wxString::npos )
1617         {
1618             // no path at all
1619             pstrPath->Empty();
1620         }
1621         else
1622         {
1623             // take everything up to the path separator but take care to make
1624             // the path equal to something like '/', not empty, for the files
1625             // immediately under root directory
1626             size_t len = posLastSlash;
1627
1628             // this rule does not apply to mac since we do not start with colons (sep)
1629             // except for relative paths
1630             if ( !len && format != wxPATH_MAC)
1631                 len++;
1632
1633             *pstrPath = fullpath.Left(len);
1634
1635             // special VMS hack: remove the initial bracket
1636             if ( format == wxPATH_VMS )
1637             {
1638                 if ( (*pstrPath)[0u] == _T('[') )
1639                     pstrPath->erase(0, 1);
1640             }
1641         }
1642     }
1643
1644     if ( pstrName )
1645     {
1646         // take all characters starting from the one after the last slash and
1647         // up to, but excluding, the last dot
1648         size_t nStart = posLastSlash == wxString::npos ? 0 : posLastSlash + 1;
1649         size_t count;
1650         if ( posLastDot == wxString::npos )
1651         {
1652             // take all until the end
1653             count = wxString::npos;
1654         }
1655         else if ( posLastSlash == wxString::npos )
1656         {
1657             count = posLastDot;
1658         }
1659         else // have both dot and slash
1660         {
1661             count = posLastDot - posLastSlash - 1;
1662         }
1663
1664         *pstrName = fullpath.Mid(nStart, count);
1665     }
1666
1667     if ( pstrExt )
1668     {
1669         if ( posLastDot == wxString::npos )
1670         {
1671             // no extension
1672             pstrExt->Empty();
1673         }
1674         else
1675         {
1676             // take everything after the dot
1677             *pstrExt = fullpath.Mid(posLastDot + 1);
1678         }
1679     }
1680 }
1681
1682 /* static */
1683 void wxFileName::SplitPath(const wxString& fullpath,
1684                            wxString *path,
1685                            wxString *name,
1686                            wxString *ext,
1687                            wxPathFormat format)
1688 {
1689     wxString volume;
1690     SplitPath(fullpath, &volume, path, name, ext, format);
1691
1692     if ( path )
1693     {
1694         path->Prepend(wxGetVolumeString(volume, format));
1695     }
1696 }
1697
1698 // ----------------------------------------------------------------------------
1699 // time functions
1700 // ----------------------------------------------------------------------------
1701
1702 #if wxUSE_DATETIME
1703
1704 bool wxFileName::SetTimes(const wxDateTime *dtAccess,
1705                           const wxDateTime *dtMod,
1706                           const wxDateTime *dtCreate)
1707 {
1708 #if defined(__WIN32__)
1709     if ( IsDir() )
1710     {
1711         // VZ: please let me know how to do this if you can
1712         wxFAIL_MSG( _T("SetTimes() not implemented for the directories") );
1713     }
1714     else // file
1715     {
1716         wxFileHandle fh(GetFullPath(), wxFileHandle::Write);
1717         if ( fh.IsOk() )
1718         {
1719             FILETIME ftAccess, ftCreate, ftWrite;
1720
1721             if ( dtCreate )
1722                 ConvertWxToFileTime(&ftCreate, *dtCreate);
1723             if ( dtAccess )
1724                 ConvertWxToFileTime(&ftAccess, *dtAccess);
1725             if ( dtMod )
1726                 ConvertWxToFileTime(&ftWrite, *dtMod);
1727
1728             if ( ::SetFileTime(fh,
1729                                dtCreate ? &ftCreate : NULL,
1730                                dtAccess ? &ftAccess : NULL,
1731                                dtMod ? &ftWrite : NULL) )
1732             {
1733                 return true;
1734             }
1735         }
1736     }
1737 #elif defined(__UNIX_LIKE__) || (defined(__DOS__) && defined(__WATCOMC__))
1738     if ( !dtAccess && !dtMod )
1739     {
1740         // can't modify the creation time anyhow, don't try
1741         return true;
1742     }
1743
1744     // if dtAccess or dtMod is not specified, use the other one (which must be
1745     // non NULL because of the test above) for both times
1746     utimbuf utm;
1747     utm.actime = dtAccess ? dtAccess->GetTicks() : dtMod->GetTicks();
1748     utm.modtime = dtMod ? dtMod->GetTicks() : dtAccess->GetTicks();
1749     if ( utime(GetFullPath().fn_str(), &utm) == 0 )
1750     {
1751         return true;
1752     }
1753 #else // other platform
1754 #endif // platforms
1755
1756     wxLogSysError(_("Failed to modify file times for '%s'"),
1757                   GetFullPath().c_str());
1758
1759     return false;
1760 }
1761
1762 bool wxFileName::Touch()
1763 {
1764 #if defined(__UNIX_LIKE__)
1765     // under Unix touching file is simple: just pass NULL to utime()
1766     if ( utime(GetFullPath().fn_str(), NULL) == 0 )
1767     {
1768         return true;
1769     }
1770
1771     wxLogSysError(_("Failed to touch the file '%s'"), GetFullPath().c_str());
1772
1773     return false;
1774 #else // other platform
1775     wxDateTime dtNow = wxDateTime::Now();
1776
1777     return SetTimes(&dtNow, &dtNow, NULL /* don't change create time */);
1778 #endif // platforms
1779 }
1780
1781 bool wxFileName::GetTimes(wxDateTime *dtAccess,
1782                           wxDateTime *dtMod,
1783                           wxDateTime *dtCreate) const
1784 {
1785 #if defined(__WIN32__)
1786     // we must use different methods for the files and directories under
1787     // Windows as CreateFile(GENERIC_READ) doesn't work for the directories and
1788     // CreateFile(FILE_FLAG_BACKUP_SEMANTICS) works -- but only under NT and
1789     // not 9x
1790     bool ok;
1791     FILETIME ftAccess, ftCreate, ftWrite;
1792     if ( IsDir() )
1793     {
1794         // implemented in msw/dir.cpp
1795         extern bool wxGetDirectoryTimes(const wxString& dirname,
1796                                         FILETIME *, FILETIME *, FILETIME *);
1797
1798         // we should pass the path without the trailing separator to
1799         // wxGetDirectoryTimes()
1800         ok = wxGetDirectoryTimes(GetPath(wxPATH_GET_VOLUME),
1801                                  &ftAccess, &ftCreate, &ftWrite);
1802     }
1803     else // file
1804     {
1805         wxFileHandle fh(GetFullPath(), wxFileHandle::Read);
1806         if ( fh.IsOk() )
1807         {
1808             ok = ::GetFileTime(fh,
1809                                dtCreate ? &ftCreate : NULL,
1810                                dtAccess ? &ftAccess : NULL,
1811                                dtMod ? &ftWrite : NULL) != 0;
1812         }
1813         else
1814         {
1815             ok = false;
1816         }
1817     }
1818
1819     if ( ok )
1820     {
1821         if ( dtCreate )
1822             ConvertFileTimeToWx(dtCreate, ftCreate);
1823         if ( dtAccess )
1824             ConvertFileTimeToWx(dtAccess, ftAccess);
1825         if ( dtMod )
1826             ConvertFileTimeToWx(dtMod, ftWrite);
1827
1828         return true;
1829     }
1830 #elif defined(__UNIX_LIKE__) || defined(__WXMAC__) || (defined(__DOS__) && defined(__WATCOMC__))
1831     wxStructStat stBuf;
1832     if ( wxStat( GetFullPath().c_str(), &stBuf) == 0 )
1833     {
1834         if ( dtAccess )
1835             dtAccess->Set(stBuf.st_atime);
1836         if ( dtMod )
1837             dtMod->Set(stBuf.st_mtime);
1838         if ( dtCreate )
1839             dtCreate->Set(stBuf.st_ctime);
1840
1841         return true;
1842     }
1843 #else // other platform
1844 #endif // platforms
1845
1846     wxLogSysError(_("Failed to retrieve file times for '%s'"),
1847                   GetFullPath().c_str());
1848
1849     return false;
1850 }
1851
1852 #endif // wxUSE_DATETIME
1853
1854 #ifdef __WXMAC__
1855
1856 const short kMacExtensionMaxLength = 16 ;
1857 class MacDefaultExtensionRecord
1858 {
1859 public :
1860   MacDefaultExtensionRecord()
1861   {
1862     m_ext[0] = 0 ;
1863     m_type = m_creator = NULL ;
1864   }
1865   MacDefaultExtensionRecord( const MacDefaultExtensionRecord& from )
1866   {
1867     wxStrcpy( m_ext , from.m_ext ) ;
1868     m_type = from.m_type ;
1869     m_creator = from.m_creator ;
1870   }
1871   MacDefaultExtensionRecord( const wxChar * extension , OSType type , OSType creator )
1872   {
1873     wxStrncpy( m_ext , extension , kMacExtensionMaxLength ) ;
1874     m_ext[kMacExtensionMaxLength] = 0 ;
1875     m_type = type ;
1876     m_creator = creator ;
1877   }
1878   wxChar m_ext[kMacExtensionMaxLength] ;
1879   OSType m_type ;
1880   OSType m_creator ;
1881 }  ;
1882
1883 #include "wx/dynarray.h"
1884 WX_DECLARE_OBJARRAY(MacDefaultExtensionRecord, MacDefaultExtensionArray) ;
1885
1886 bool gMacDefaultExtensionsInited = false ;
1887
1888 #include "wx/arrimpl.cpp"
1889
1890 WX_DEFINE_EXPORTED_OBJARRAY(MacDefaultExtensionArray) ;
1891
1892 MacDefaultExtensionArray gMacDefaultExtensions ;
1893
1894 static void MacEnsureDefaultExtensionsLoaded()
1895 {
1896   if ( !gMacDefaultExtensionsInited )
1897   {
1898
1899     // load the default extensions
1900     MacDefaultExtensionRecord defaults[1] =
1901     {
1902       MacDefaultExtensionRecord( wxT("txt") , 'TEXT' , 'ttxt' ) ,
1903
1904     } ;
1905     // we could load the pc exchange prefs here too
1906
1907     for ( size_t i = 0 ; i < WXSIZEOF( defaults ) ; ++i )
1908     {
1909       gMacDefaultExtensions.Add( defaults[i] ) ;
1910     }
1911     gMacDefaultExtensionsInited = true ;
1912   }
1913 }
1914 bool wxFileName::MacSetTypeAndCreator( wxUint32 type , wxUint32 creator )
1915 {
1916   FInfo fndrInfo ;
1917   FSSpec spec ;
1918   wxMacFilename2FSSpec(GetFullPath(),&spec) ;
1919   OSErr err = FSpGetFInfo( &spec , &fndrInfo ) ;
1920   wxCHECK( err == noErr , false ) ;
1921
1922   fndrInfo.fdType = type ;
1923   fndrInfo.fdCreator = creator ;
1924   FSpSetFInfo( &spec , &fndrInfo ) ;
1925   return true ;
1926 }
1927
1928 bool wxFileName::MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator )
1929 {
1930   FInfo fndrInfo ;
1931   FSSpec spec ;
1932   wxMacFilename2FSSpec(GetFullPath(),&spec) ;
1933   OSErr err = FSpGetFInfo( &spec , &fndrInfo ) ;
1934   wxCHECK( err == noErr , false ) ;
1935
1936   *type = fndrInfo.fdType ;
1937   *creator = fndrInfo.fdCreator ;
1938   return true ;
1939 }
1940
1941 bool wxFileName::MacSetDefaultTypeAndCreator()
1942 {
1943     wxUint32 type , creator ;
1944     if ( wxFileName::MacFindDefaultTypeAndCreator(GetExt() , &type ,
1945       &creator ) )
1946     {
1947         return MacSetTypeAndCreator( type , creator ) ;
1948     }
1949     return false;
1950 }
1951
1952 bool wxFileName::MacFindDefaultTypeAndCreator( const wxString& ext , wxUint32 *type , wxUint32 *creator )
1953 {
1954   MacEnsureDefaultExtensionsLoaded() ;
1955   wxString extl = ext.Lower() ;
1956   for( int i = gMacDefaultExtensions.Count() - 1 ; i >= 0 ; --i )
1957   {
1958     if ( gMacDefaultExtensions.Item(i).m_ext == extl )
1959     {
1960       *type = gMacDefaultExtensions.Item(i).m_type ;
1961       *creator = gMacDefaultExtensions.Item(i).m_creator ;
1962       return true ;
1963     }
1964   }
1965   return false ;
1966 }
1967
1968 void wxFileName::MacRegisterDefaultTypeAndCreator( const wxString& ext , wxUint32 type , wxUint32 creator )
1969 {
1970   MacEnsureDefaultExtensionsLoaded() ;
1971   MacDefaultExtensionRecord rec ;
1972   rec.m_type = type ;
1973   rec.m_creator = creator ;
1974   wxStrncpy( rec.m_ext , ext.Lower().c_str() , kMacExtensionMaxLength ) ;
1975   gMacDefaultExtensions.Add( rec ) ;
1976 }
1977 #endif