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