]> git.saurik.com Git - wxWidgets.git/blame - src/common/filename.cpp
static class variable needs a definition
[wxWidgets.git] / src / common / filename.cpp
CommitLineData
df5ddbca 1/////////////////////////////////////////////////////////////////////////////
097ead30
VZ
2// Name: src/common/filename.cpp
3// Purpose: wxFileName - encapsulates a file path
844f90fb 4// Author: Robert Roebling, Vadim Zeitlin
df5ddbca
RR
5// Modified by:
6// Created: 28.12.2000
7// RCS-ID: $Id$
8// Copyright: (c) 2000 Robert Roebling
65571936 9// Licence: wxWindows licence
df5ddbca
RR
10/////////////////////////////////////////////////////////////////////////////
11
04c943b1
VZ
12/*
13 Here are brief descriptions of the filename formats supported by this class:
14
2bc60417
RR
15 wxPATH_UNIX: standard Unix format, used under Darwin as well, absolute file
16 names have the form:
04c943b1
VZ
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
2bc60417 21 wxPATH_DOS: DOS/Windows format, absolute file names have the form:
04c943b1
VZ
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
ae4d7004 27 wxPATH_MAC: Mac OS 8/9 and Mac OS X under CodeWarrior 7 format, absolute file
2bc60417 28 names have the form
04c943b1
VZ
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).
a385b5df 35 Since the volume is just part of the file path, it is not
353f41cb 36 treated like a separate entity as it is done under DOS and
90a68369 37 VMS, it is just treated as another dir.
04c943b1
VZ
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.
ba623ba2 50 [ start of directory specification
04c943b1
VZ
51 . separator between directory and subdirectory
52 ] between directory and file
53 */
54
097ead30
VZ
55// ============================================================================
56// declarations
57// ============================================================================
58
59// ----------------------------------------------------------------------------
60// headers
61// ----------------------------------------------------------------------------
62
df5ddbca
RR
63// For compilers that support precompilation, includes "wx.h".
64#include "wx/wxprec.h"
65
66#ifdef __BORLANDC__
0b9ab0bd 67#pragma hdrstop
df5ddbca
RR
68#endif
69
70#ifndef WX_PRECOMP
57bd4c60
WS
71 #ifdef __WXMSW__
72 #include "wx/msw/wrapwin.h" // For GetShort/LongPathName
73 #endif
ad9835c9
WS
74 #include "wx/dynarray.h"
75 #include "wx/intl.h"
76 #include "wx/log.h"
de6185e2 77 #include "wx/utils.h"
df5ddbca
RR
78#endif
79
80#include "wx/filename.h"
b70a2866 81#include "wx/private/filename.h"
df5ddbca 82#include "wx/tokenzr.h"
844f90fb 83#include "wx/config.h" // for wxExpandEnvVars
35a6691a 84#include "wx/dynlib.h"
df5ddbca 85
57bd4c60
WS
86#if defined(__WIN32__) && defined(__MINGW32__)
87 #include "wx/msw/gccpriv.h"
951cd180
VZ
88#endif
89
1c193821
JS
90#ifdef __WXWINCE__
91#include "wx/msw/private.h"
92#endif
93
76a5e5d2
SC
94#if defined(__WXMAC__)
95 #include "wx/mac/private.h" // includes mac headers
96#endif
97
951cd180
VZ
98// utime() is POSIX so should normally be available on all Unices
99#ifdef __UNIX_LIKE__
0b9ab0bd
RL
100#include <sys/types.h>
101#include <utime.h>
102#include <sys/stat.h>
103#include <unistd.h>
9e9b65c1
JS
104#endif
105
444d61ba
VS
106#ifdef __DJGPP__
107#include <unistd.h>
108#endif
109
01d981ec 110#ifdef __MWERKS__
31907d03
SC
111#ifdef __MACH__
112#include <sys/types.h>
113#include <utime.h>
114#include <sys/stat.h>
115#include <unistd.h>
116#else
0b9ab0bd
RL
117#include <stat.h>
118#include <unistd.h>
119#include <unix.h>
01d981ec 120#endif
31907d03 121#endif
01d981ec 122
d9f54bb0 123#ifdef __WATCOMC__
0b9ab0bd
RL
124#include <io.h>
125#include <sys/utime.h>
126#include <sys/stat.h>
d9f54bb0
VS
127#endif
128
24eb81cb
DW
129#ifdef __VISAGECPP__
130#ifndef MAX_PATH
131#define MAX_PATH 256
132#endif
133#endif
134
01c9a906 135#ifdef __EMX__
5d66debf 136#include <os2.h>
01c9a906
SN
137#define MAX_PATH _MAX_PATH
138#endif
139
23b8a262
JS
140
141wxULongLong wxInvalidSize = (unsigned)-1;
142
143
951cd180
VZ
144// ----------------------------------------------------------------------------
145// private classes
146// ----------------------------------------------------------------------------
147
148// small helper class which opens and closes the file - we use it just to get
149// a file handle for the given file name to pass it to some Win32 API function
c67d6888 150#if defined(__WIN32__) && !defined(__WXMICROWIN__)
951cd180
VZ
151
152class wxFileHandle
153{
154public:
6dbb903b
VZ
155 enum OpenMode
156 {
157 Read,
158 Write
159 };
160
161 wxFileHandle(const wxString& filename, OpenMode mode)
951cd180
VZ
162 {
163 m_hFile = ::CreateFile
164 (
6dbb903b 165 filename, // name
0ea621cc 166 mode == Read ? GENERIC_READ // access mask
6dbb903b 167 : GENERIC_WRITE,
54bcff35
VZ
168 FILE_SHARE_READ | // sharing mode
169 FILE_SHARE_WRITE, // (allow everything)
6dbb903b
VZ
170 NULL, // no secutity attr
171 OPEN_EXISTING, // creation disposition
172 0, // no flags
173 NULL // no template file
951cd180
VZ
174 );
175
176 if ( m_hFile == INVALID_HANDLE_VALUE )
177 {
6dbb903b
VZ
178 wxLogSysError(_("Failed to open '%s' for %s"),
179 filename.c_str(),
180 mode == Read ? _("reading") : _("writing"));
951cd180
VZ
181 }
182 }
183
184 ~wxFileHandle()
185 {
186 if ( m_hFile != INVALID_HANDLE_VALUE )
187 {
188 if ( !::CloseHandle(m_hFile) )
189 {
190 wxLogSysError(_("Failed to close file handle"));
191 }
192 }
193 }
194
f363e05c 195 // return true only if the file could be opened successfully
951cd180
VZ
196 bool IsOk() const { return m_hFile != INVALID_HANDLE_VALUE; }
197
198 // get the handle
199 operator HANDLE() const { return m_hFile; }
200
201private:
202 HANDLE m_hFile;
203};
204
205#endif // __WIN32__
206
207// ----------------------------------------------------------------------------
208// private functions
209// ----------------------------------------------------------------------------
210
e2b87f38 211#if wxUSE_DATETIME && defined(__WIN32__) && !defined(__WXMICROWIN__)
951cd180
VZ
212
213// convert between wxDateTime and FILETIME which is a 64-bit value representing
214// the number of 100-nanosecond intervals since January 1, 1601.
215
d56e2b97 216static void ConvertFileTimeToWx(wxDateTime *dt, const FILETIME &ft)
951cd180 217{
752f10a8 218 FILETIME ftcopy = ft;
6dbb903b 219 FILETIME ftLocal;
752f10a8 220 if ( !::FileTimeToLocalFileTime(&ftcopy, &ftLocal) )
6dbb903b
VZ
221 {
222 wxLogLastError(_T("FileTimeToLocalFileTime"));
223 }
d56e2b97 224
6dbb903b
VZ
225 SYSTEMTIME st;
226 if ( !::FileTimeToSystemTime(&ftLocal, &st) )
227 {
228 wxLogLastError(_T("FileTimeToSystemTime"));
229 }
d56e2b97 230
6dbb903b
VZ
231 dt->Set(st.wDay, wxDateTime::Month(st.wMonth - 1), st.wYear,
232 st.wHour, st.wMinute, st.wSecond, st.wMilliseconds);
951cd180
VZ
233}
234
d56e2b97 235static void ConvertWxToFileTime(FILETIME *ft, const wxDateTime& dt)
951cd180 236{
6dbb903b
VZ
237 SYSTEMTIME st;
238 st.wDay = dt.GetDay();
ad816476
WS
239 st.wMonth = (WORD)(dt.GetMonth() + 1);
240 st.wYear = (WORD)dt.GetYear();
6dbb903b
VZ
241 st.wHour = dt.GetHour();
242 st.wMinute = dt.GetMinute();
243 st.wSecond = dt.GetSecond();
244 st.wMilliseconds = dt.GetMillisecond();
245
246 FILETIME ftLocal;
247 if ( !::SystemTimeToFileTime(&st, &ftLocal) )
248 {
249 wxLogLastError(_T("SystemTimeToFileTime"));
250 }
d56e2b97 251
6dbb903b
VZ
252 if ( !::LocalFileTimeToFileTime(&ftLocal, ft) )
253 {
254 wxLogLastError(_T("LocalFileTimeToFileTime"));
255 }
951cd180
VZ
256}
257
e2b87f38 258#endif // wxUSE_DATETIME && __WIN32__
951cd180 259
67c34f64
VZ
260// return a string with the volume par
261static wxString wxGetVolumeString(const wxString& volume, wxPathFormat format)
262{
263 wxString path;
264
265 if ( !volume.empty() )
266 {
6ce27aa2
VZ
267 format = wxFileName::GetFormat(format);
268
67c34f64
VZ
269 // Special Windows UNC paths hack, part 2: undo what we did in
270 // SplitPath() and make an UNC path if we have a drive which is not a
271 // single letter (hopefully the network shares can't be one letter only
272 // although I didn't find any authoritative docs on this)
273 if ( format == wxPATH_DOS && volume.length() > 1 )
274 {
275 path << wxFILE_SEP_PATH_DOS << wxFILE_SEP_PATH_DOS << volume;
276 }
277 else if ( format == wxPATH_DOS || format == wxPATH_VMS )
278 {
279 path << volume << wxFileName::GetVolumeSeparator(format);
280 }
281 // else ignore
282 }
283
284 return path;
285}
286
097ead30
VZ
287// ============================================================================
288// implementation
289// ============================================================================
290
291// ----------------------------------------------------------------------------
844f90fb 292// wxFileName construction
097ead30 293// ----------------------------------------------------------------------------
df5ddbca 294
a35b27b1
RR
295void wxFileName::Assign( const wxFileName &filepath )
296{
04c943b1 297 m_volume = filepath.GetVolume();
844f90fb 298 m_dirs = filepath.GetDirs();
04c943b1
VZ
299 m_name = filepath.GetName();
300 m_ext = filepath.GetExt();
a2fa5040 301 m_relative = filepath.m_relative;
dfecbee5 302 m_hasExt = filepath.m_hasExt;
df5ddbca
RR
303}
304
04c943b1
VZ
305void wxFileName::Assign(const wxString& volume,
306 const wxString& path,
307 const wxString& name,
308 const wxString& ext,
dfecbee5 309 bool hasExt,
04c943b1 310 wxPathFormat format )
a7b51bc8
RR
311{
312 SetPath( path, format );
313
314 m_volume = volume;
315 m_ext = ext;
316 m_name = name;
dfecbee5
VZ
317
318 m_hasExt = hasExt;
a7b51bc8
RR
319}
320
f1e77933 321void wxFileName::SetPath( const wxString& pathOrig, wxPathFormat format )
df5ddbca 322{
844f90fb 323 m_dirs.Clear();
90a68369 324
f1e77933 325 if ( pathOrig.empty() )
df5ddbca 326 {
f1e77933
VZ
327 // no path at all
328 m_relative = true;
a2fa5040 329
f1e77933
VZ
330 return;
331 }
90a68369 332
f1e77933 333 format = GetFormat( format );
a2fa5040 334
f1e77933
VZ
335 // 0) deal with possible volume part first
336 wxString volume,
337 path;
338 SplitVolume(pathOrig, &volume, &path, format);
339 if ( !volume.empty() )
340 {
341 m_relative = false;
a2fa5040 342
f1e77933
VZ
343 SetVolume(volume);
344 }
f363e05c 345
f1e77933
VZ
346 // 1) Determine if the path is relative or absolute.
347 wxChar leadingChar = path[0u];
a2fa5040 348
f1e77933
VZ
349 switch (format)
350 {
351 case wxPATH_MAC:
352 m_relative = leadingChar == wxT(':');
353
354 // We then remove a leading ":". The reason is in our
355 // storage form for relative paths:
356 // ":dir:file.txt" actually means "./dir/file.txt" in
357 // DOS notation and should get stored as
358 // (relative) (dir) (file.txt)
359 // "::dir:file.txt" actually means "../dir/file.txt"
360 // stored as (relative) (..) (dir) (file.txt)
361 // This is important only for the Mac as an empty dir
362 // actually means <UP>, whereas under DOS, double
363 // slashes can be ignored: "\\\\" is the same as "\\".
364 if (m_relative)
365 path.erase( 0, 1 );
366 break;
a2fa5040 367
f1e77933
VZ
368 case wxPATH_VMS:
369 // TODO: what is the relative path format here?
370 m_relative = false;
371 break;
90a68369 372
f1e77933
VZ
373 default:
374 wxFAIL_MSG( _T("Unknown path format") );
375 // !! Fall through !!
90a68369 376
f1e77933
VZ
377 case wxPATH_UNIX:
378 // the paths of the form "~" or "~username" are absolute
379 m_relative = leadingChar != wxT('/') && leadingChar != _T('~');
380 break;
353f41cb 381
f1e77933
VZ
382 case wxPATH_DOS:
383 m_relative = !IsPathSeparator(leadingChar, format);
384 break;
844f90fb 385
df5ddbca 386 }
f1e77933
VZ
387
388 // 2) Break up the path into its members. If the original path
389 // was just "/" or "\\", m_dirs will be empty. We know from
390 // the m_relative field, if this means "nothing" or "root dir".
391
392 wxStringTokenizer tn( path, GetPathSeparators(format) );
393
394 while ( tn.HasMoreTokens() )
a7b51bc8 395 {
f1e77933
VZ
396 wxString token = tn.GetNextToken();
397
398 // Remove empty token under DOS and Unix, interpret them
399 // as .. under Mac.
400 if (token.empty())
401 {
402 if (format == wxPATH_MAC)
403 m_dirs.Add( wxT("..") );
404 // else ignore
405 }
406 else
407 {
408 m_dirs.Add( token );
409 }
a7b51bc8 410 }
844f90fb
VZ
411}
412
413void wxFileName::Assign(const wxString& fullpath,
414 wxPathFormat format)
415{
04c943b1 416 wxString volume, path, name, ext;
dfecbee5
VZ
417 bool hasExt;
418 SplitPath(fullpath, &volume, &path, &name, &ext, &hasExt, format);
844f90fb 419
dfecbee5 420 Assign(volume, path, name, ext, hasExt, format);
844f90fb
VZ
421}
422
81f25632 423void wxFileName::Assign(const wxString& fullpathOrig,
844f90fb
VZ
424 const wxString& fullname,
425 wxPathFormat format)
426{
81f25632
VZ
427 // always recognize fullpath as directory, even if it doesn't end with a
428 // slash
429 wxString fullpath = fullpathOrig;
430 if ( !wxEndsWithPathSeparator(fullpath) )
431 {
33b97389 432 fullpath += GetPathSeparator(format);
81f25632
VZ
433 }
434
52dbd056 435 wxString volume, path, name, ext;
dfecbee5 436 bool hasExt;
81f25632
VZ
437
438 // do some consistency checks in debug mode: the name should be really just
353f41cb 439 // the filename and the path should be really just a path
81f25632 440#ifdef __WXDEBUG__
dfecbee5 441 wxString volDummy, pathDummy, nameDummy, extDummy;
81f25632 442
dfecbee5 443 SplitPath(fullname, &volDummy, &pathDummy, &name, &ext, &hasExt, format);
81f25632 444
dfecbee5 445 wxASSERT_MSG( volDummy.empty() && pathDummy.empty(),
81f25632
VZ
446 _T("the file name shouldn't contain the path") );
447
448 SplitPath(fullpath, &volume, &path, &nameDummy, &extDummy, format);
449
450 wxASSERT_MSG( nameDummy.empty() && extDummy.empty(),
451 _T("the path shouldn't contain file name nor extension") );
452
453#else // !__WXDEBUG__
284be59b
VZ
454 SplitPath(fullname, NULL /* no volume */, NULL /* no path */,
455 &name, &ext, &hasExt, format);
52dbd056 456 SplitPath(fullpath, &volume, &path, NULL, NULL, format);
81f25632 457#endif // __WXDEBUG__/!__WXDEBUG__
844f90fb 458
dfecbee5 459 Assign(volume, path, name, ext, hasExt, format);
52dbd056
VZ
460}
461
4c2deb19
VZ
462void wxFileName::Assign(const wxString& pathOrig,
463 const wxString& name,
464 const wxString& ext,
465 wxPathFormat format)
466{
467 wxString volume,
468 path;
469 SplitVolume(pathOrig, &volume, &path, format);
470
471 Assign(volume, path, name, ext, format);
472}
473
52dbd056
VZ
474void wxFileName::AssignDir(const wxString& dir, wxPathFormat format)
475{
b494c48b 476 Assign(dir, wxEmptyString, format);
844f90fb
VZ
477}
478
479void wxFileName::Clear()
480{
481 m_dirs.Clear();
04c943b1
VZ
482
483 m_volume =
844f90fb
VZ
484 m_name =
485 m_ext = wxEmptyString;
fb969475
VZ
486
487 // we don't have any absolute path for now
f363e05c 488 m_relative = true;
dfecbee5
VZ
489
490 // nor any extension
491 m_hasExt = false;
844f90fb
VZ
492}
493
494/* static */
520200fd 495wxFileName wxFileName::FileName(const wxString& file, wxPathFormat format)
844f90fb 496{
520200fd 497 return wxFileName(file, format);
844f90fb
VZ
498}
499
500/* static */
520200fd 501wxFileName wxFileName::DirName(const wxString& dir, wxPathFormat format)
844f90fb
VZ
502{
503 wxFileName fn;
520200fd 504 fn.AssignDir(dir, format);
844f90fb 505 return fn;
df5ddbca
RR
506}
507
844f90fb
VZ
508// ----------------------------------------------------------------------------
509// existence tests
510// ----------------------------------------------------------------------------
511
8e41796c 512bool wxFileName::FileExists() const
df5ddbca 513{
a35b27b1
RR
514 return wxFileName::FileExists( GetFullPath() );
515}
516
517bool wxFileName::FileExists( const wxString &file )
518{
519 return ::wxFileExists( file );
df5ddbca
RR
520}
521
8e41796c 522bool wxFileName::DirExists() const
df5ddbca 523{
db759dde 524 return wxFileName::DirExists( GetPath() );
a35b27b1
RR
525}
526
527bool wxFileName::DirExists( const wxString &dir )
528{
da865fdd 529 return ::wxDirExists( dir );
df5ddbca
RR
530}
531
844f90fb
VZ
532// ----------------------------------------------------------------------------
533// CWD and HOME stuff
534// ----------------------------------------------------------------------------
535
6f91bc33 536void wxFileName::AssignCwd(const wxString& volume)
df5ddbca 537{
6f91bc33 538 AssignDir(wxFileName::GetCwd(volume));
a35b27b1
RR
539}
540
844f90fb 541/* static */
6f91bc33 542wxString wxFileName::GetCwd(const wxString& volume)
a35b27b1 543{
6f91bc33
VZ
544 // if we have the volume, we must get the current directory on this drive
545 // and to do this we have to chdir to this volume - at least under Windows,
546 // I don't know how to get the current drive on another volume elsewhere
547 // (TODO)
548 wxString cwdOld;
549 if ( !volume.empty() )
550 {
551 cwdOld = wxGetCwd();
552 SetCwd(volume + GetVolumeSeparator());
553 }
554
555 wxString cwd = ::wxGetCwd();
556
557 if ( !volume.empty() )
558 {
559 SetCwd(cwdOld);
560 }
ae4d7004 561
6f91bc33 562 return cwd;
a35b27b1
RR
563}
564
565bool wxFileName::SetCwd()
566{
db759dde 567 return wxFileName::SetCwd( GetPath() );
df5ddbca
RR
568}
569
a35b27b1 570bool wxFileName::SetCwd( const wxString &cwd )
df5ddbca 571{
a35b27b1 572 return ::wxSetWorkingDirectory( cwd );
df5ddbca
RR
573}
574
a35b27b1
RR
575void wxFileName::AssignHomeDir()
576{
844f90fb 577 AssignDir(wxFileName::GetHomeDir());
a35b27b1 578}
844f90fb 579
a35b27b1
RR
580wxString wxFileName::GetHomeDir()
581{
582 return ::wxGetHomeDir();
583}
844f90fb 584
68351053 585
b70a2866
MW
586// ----------------------------------------------------------------------------
587// CreateTempFileName
588// ----------------------------------------------------------------------------
589
590#if wxUSE_FILE || wxUSE_FFILE
591
592
593#if !defined wx_fdopen && defined HAVE_FDOPEN
594 #define wx_fdopen fdopen
595#endif
596
597// NB: GetTempFileName() under Windows creates the file, so using
598// O_EXCL there would fail
599#ifdef __WINDOWS__
600 #define wxOPEN_EXCL 0
601#else
602 #define wxOPEN_EXCL O_EXCL
603#endif
604
605
606#ifdef wxOpenOSFHandle
607#define WX_HAVE_DELETE_ON_CLOSE
608// On Windows create a file with the FILE_FLAGS_DELETE_ON_CLOSE flags.
609//
610static int wxOpenWithDeleteOnClose(const wxString& filename)
df5ddbca 611{
b70a2866
MW
612 DWORD access = GENERIC_READ | GENERIC_WRITE;
613
614 DWORD disposition = OPEN_ALWAYS;
615
616 DWORD attributes = FILE_ATTRIBUTE_TEMPORARY |
617 FILE_FLAG_DELETE_ON_CLOSE;
618
619 HANDLE h = ::CreateFile(filename, access, 0, NULL,
620 disposition, attributes, NULL);
621
622 return wxOpenOSFHandle(h, 0);
ade35f11 623}
b70a2866 624#endif // wxOpenOSFHandle
ade35f11 625
b70a2866
MW
626
627// Helper to open the file
628//
629static int wxTempOpen(const wxString& path, bool *deleteOnClose)
630{
631#ifdef WX_HAVE_DELETE_ON_CLOSE
632 if (*deleteOnClose)
633 return wxOpenWithDeleteOnClose(path);
634#endif
635
636 *deleteOnClose = false;
637
638 return wxOpen(path, wxO_BINARY | O_RDWR | O_CREAT | wxOPEN_EXCL, 0600);
639}
640
641
642#if wxUSE_FFILE
643// Helper to open the file and attach it to the wxFFile
644//
645static bool wxTempOpen(wxFFile *file, const wxString& path, bool *deleteOnClose)
ade35f11 646{
b70a2866
MW
647#ifndef wx_fdopen
648 *deleteOnClose = false;
649 return file->Open(path, _T("w+b"));
650#else // wx_fdopen
651 int fd = wxTempOpen(path, deleteOnClose);
652 if (fd != -1)
653 return false;
654 file->Attach(wx_fdopen(fd, "w+b"));
655 return file->IsOpened();
656#endif // wx_fdopen
657}
658#endif // wxUSE_FFILE
659
660
661#if !wxUSE_FILE
662 #define WXFILEARGS(x, y) y
663#elif !wxUSE_FFILE
664 #define WXFILEARGS(x, y) x
665#else
666 #define WXFILEARGS(x, y) x, y
667#endif
668
669
670// Implementation of wxFileName::CreateTempFileName().
671//
672static wxString wxCreateTempImpl(
673 const wxString& prefix,
674 WXFILEARGS(wxFile *fileTemp, wxFFile *ffileTemp),
675 bool *deleteOnClose = NULL)
676{
677#if wxUSE_FILE && wxUSE_FFILE
678 wxASSERT(fileTemp == NULL || ffileTemp == NULL);
679#endif
ade35f11 680 wxString path, dir, name;
b70a2866
MW
681 bool wantDeleteOnClose = false;
682
683 if (deleteOnClose)
684 {
685 // set the result to false initially
686 wantDeleteOnClose = *deleteOnClose;
687 *deleteOnClose = false;
688 }
689 else
690 {
691 // easier if it alwasys points to something
692 deleteOnClose = &wantDeleteOnClose;
693 }
ade35f11
VZ
694
695 // use the directory specified by the prefix
b70a2866 696 wxFileName::SplitPath(prefix, &dir, &name, NULL /* extension */);
ade35f11 697
6091caf0
JS
698 if (dir.empty())
699 {
8d7d6dea 700 dir = wxFileName::GetTempDir();
6091caf0
JS
701 }
702
1c193821 703#if defined(__WXWINCE__)
f05ba7ff 704 path = dir + wxT("\\") + name;
1c193821 705 int i = 1;
b70a2866 706 while (wxFileName::FileExists(path))
1c193821 707 {
f05ba7ff 708 path = dir + wxT("\\") + name ;
1c193821
JS
709 path << i;
710 i ++;
711 }
ade35f11 712
1c193821 713#elif defined(__WINDOWS__) && !defined(__WXMICROWIN__)
ade35f11
VZ
714 if ( !::GetTempFileName(dir, name, 0, wxStringBuffer(path, MAX_PATH + 1)) )
715 {
716 wxLogLastError(_T("GetTempFileName"));
717
718 path.clear();
719 }
ade35f11 720
5a3912f2 721#else // !Windows
ade35f11
VZ
722 path = dir;
723
724 if ( !wxEndsWithPathSeparator(dir) &&
725 (name.empty() || !wxIsPathSeparator(name[0u])) )
726 {
d9f54bb0 727 path += wxFILE_SEP_PATH;
ade35f11
VZ
728 }
729
730 path += name;
731
7070f55b 732#if defined(HAVE_MKSTEMP)
ade35f11
VZ
733 // scratch space for mkstemp()
734 path += _T("XXXXXX");
735
74cf9763 736 // we need to copy the path to the buffer in which mkstemp() can modify it
2b5f62a0 737 wxCharBuffer buf( wxConvFile.cWX2MB( path ) );
74cf9763
VZ
738
739 // cast is safe because the string length doesn't change
ca11abde 740 int fdTemp = mkstemp( (char*)(const char*) buf );
df22f860 741 if ( fdTemp == -1 )
ade35f11
VZ
742 {
743 // this might be not necessary as mkstemp() on most systems should have
744 // already done it but it doesn't hurt neither...
745 path.clear();
746 }
df22f860
VZ
747 else // mkstemp() succeeded
748 {
ca11abde 749 path = wxConvFile.cMB2WX( (const char*) buf );
a62848fd 750
b70a2866 751 #if wxUSE_FILE
df22f860
VZ
752 // avoid leaking the fd
753 if ( fileTemp )
754 {
755 fileTemp->Attach(fdTemp);
756 }
757 else
b70a2866
MW
758 #endif
759
760 #if wxUSE_FFILE
761 if ( ffileTemp )
762 {
763 #ifdef wx_fdopen
764 ffileTemp->Attach(wx_fdopen(fdTemp, "r+b"));
765 #else
766 ffileTemp->Open(path, _T("r+b"));
767 close(fdTemp);
768 #endif
769 }
770 else
771 #endif
772
df22f860
VZ
773 {
774 close(fdTemp);
775 }
776 }
ade35f11
VZ
777#else // !HAVE_MKSTEMP
778
779#ifdef HAVE_MKTEMP
780 // same as above
781 path += _T("XXXXXX");
782
ca11abde 783 wxCharBuffer buf = wxConvFile.cWX2MB( path );
b70a2866 784 if ( !mktemp( (char*)(const char*) buf ) )
ade35f11
VZ
785 {
786 path.clear();
787 }
aed08d79
RR
788 else
789 {
ca11abde 790 path = wxConvFile.cMB2WX( (const char*) buf );
aed08d79 791 }
7070f55b 792#else // !HAVE_MKTEMP (includes __DOS__)
ade35f11 793 // generate the unique file name ourselves
68351053 794 #if !defined(__DOS__) && !defined(__PALMOS__) && (!defined(__MWERKS__) || defined(__DARWIN__) )
ade35f11 795 path << (unsigned int)getpid();
7070f55b 796 #endif
ade35f11
VZ
797
798 wxString pathTry;
799
800 static const size_t numTries = 1000;
801 for ( size_t n = 0; n < numTries; n++ )
802 {
803 // 3 hex digits is enough for numTries == 1000 < 4096
3e778e3b 804 pathTry = path + wxString::Format(_T("%.03x"), (unsigned int) n);
b70a2866 805 if ( !wxFileName::FileExists(pathTry) )
ade35f11
VZ
806 {
807 break;
808 }
809
810 pathTry.clear();
811 }
812
813 path = pathTry;
814#endif // HAVE_MKTEMP/!HAVE_MKTEMP
815
df22f860
VZ
816#endif // HAVE_MKSTEMP/!HAVE_MKSTEMP
817
818#endif // Windows/!Windows
819
820 if ( path.empty() )
821 {
822 wxLogSysError(_("Failed to create a temporary file name"));
823 }
b70a2866 824 else
df22f860 825 {
b70a2866
MW
826 bool ok = true;
827
df22f860 828 // open the file - of course, there is a race condition here, this is
ade35f11 829 // why we always prefer using mkstemp()...
b70a2866
MW
830 #if wxUSE_FILE
831 if ( fileTemp && !fileTemp->IsOpened() )
832 {
833 *deleteOnClose = wantDeleteOnClose;
834 int fd = wxTempOpen(path, deleteOnClose);
835 if (fd != -1)
836 fileTemp->Attach(fd);
837 else
838 ok = false;
839 }
840 #endif
841
842 #if wxUSE_FFILE
843 if ( ffileTemp && !ffileTemp->IsOpened() )
844 {
845 *deleteOnClose = wantDeleteOnClose;
846 ok = wxTempOpen(ffileTemp, path, deleteOnClose);
847 }
848 #endif
849
850 if ( !ok )
ade35f11
VZ
851 {
852 // FIXME: If !ok here should we loop and try again with another
853 // file name? That is the standard recourse if open(O_EXCL)
854 // fails, though of course it should be protected against
855 // possible infinite looping too.
856
857 wxLogError(_("Failed to open temporary file."));
858
859 path.clear();
860 }
861 }
ade35f11
VZ
862
863 return path;
df5ddbca
RR
864}
865
b70a2866
MW
866
867static bool wxCreateTempImpl(
868 const wxString& prefix,
869 WXFILEARGS(wxFile *fileTemp, wxFFile *ffileTemp),
870 wxString *name)
871{
872 bool deleteOnClose = true;
873
874 *name = wxCreateTempImpl(prefix,
875 WXFILEARGS(fileTemp, ffileTemp),
876 &deleteOnClose);
877
878 bool ok = !name->empty();
879
880 if (deleteOnClose)
881 name->clear();
882#ifdef __UNIX__
883 else if (ok && wxRemoveFile(*name))
884 name->clear();
885#endif
886
887 return ok;
888}
889
890
891static void wxAssignTempImpl(
892 wxFileName *fn,
893 const wxString& prefix,
894 WXFILEARGS(wxFile *fileTemp, wxFFile *ffileTemp))
895{
896 wxString tempname;
897 tempname = wxCreateTempImpl(prefix, WXFILEARGS(fileTemp, ffileTemp));
898
899 if ( tempname.empty() )
900 {
901 // error, failed to get temp file name
902 fn->Clear();
903 }
904 else // ok
905 {
906 fn->Assign(tempname);
907 }
908}
909
910
911void wxFileName::AssignTempFileName(const wxString& prefix)
912{
913 wxAssignTempImpl(this, prefix, WXFILEARGS(NULL, NULL));
914}
915
916/* static */
917wxString wxFileName::CreateTempFileName(const wxString& prefix)
918{
919 return wxCreateTempImpl(prefix, WXFILEARGS(NULL, NULL));
920}
921
922#endif // wxUSE_FILE || wxUSE_FFILE
923
924
925#if wxUSE_FILE
926
927wxString wxCreateTempFileName(const wxString& prefix,
928 wxFile *fileTemp,
929 bool *deleteOnClose)
930{
931 return wxCreateTempImpl(prefix, WXFILEARGS(fileTemp, NULL), deleteOnClose);
932}
933
934bool wxCreateTempFile(const wxString& prefix,
935 wxFile *fileTemp,
936 wxString *name)
937{
938 return wxCreateTempImpl(prefix, WXFILEARGS(fileTemp, NULL), name);
939}
940
941void wxFileName::AssignTempFileName(const wxString& prefix, wxFile *fileTemp)
942{
943 wxAssignTempImpl(this, prefix, WXFILEARGS(fileTemp, NULL));
944}
945
946/* static */
947wxString
948wxFileName::CreateTempFileName(const wxString& prefix, wxFile *fileTemp)
949{
950 return wxCreateTempFileName(prefix, fileTemp);
951}
952
68351053
WS
953#endif // wxUSE_FILE
954
b70a2866
MW
955
956#if wxUSE_FFILE
957
958wxString wxCreateTempFileName(const wxString& prefix,
959 wxFFile *fileTemp,
960 bool *deleteOnClose)
961{
962 return wxCreateTempImpl(prefix, WXFILEARGS(NULL, fileTemp), deleteOnClose);
963}
964
965bool wxCreateTempFile(const wxString& prefix,
966 wxFFile *fileTemp,
967 wxString *name)
968{
969 return wxCreateTempImpl(prefix, WXFILEARGS(NULL, fileTemp), name);
970
971}
972
973void wxFileName::AssignTempFileName(const wxString& prefix, wxFFile *fileTemp)
974{
975 wxAssignTempImpl(this, prefix, WXFILEARGS(NULL, fileTemp));
976}
977
978/* static */
979wxString
980wxFileName::CreateTempFileName(const wxString& prefix, wxFFile *fileTemp)
981{
982 return wxCreateTempFileName(prefix, fileTemp);
983}
984
985#endif // wxUSE_FFILE
986
987
844f90fb
VZ
988// ----------------------------------------------------------------------------
989// directory operations
990// ----------------------------------------------------------------------------
991
8d7d6dea
JS
992wxString wxFileName::GetTempDir()
993{
994 wxString dir;
995 dir = wxGetenv(_T("TMPDIR"));
996 if (dir.empty())
997 {
998 dir = wxGetenv(_T("TMP"));
999 if (dir.empty())
1000 {
1001 dir = wxGetenv(_T("TEMP"));
1002 }
1003 }
1004
1005#if defined(__WXWINCE__)
1006 if (dir.empty())
1007 {
1008 // FIXME. Create \temp dir?
1009 if (DirExists(wxT("\\temp")))
1010 dir = wxT("\\temp");
1011 }
1012#elif defined(__WINDOWS__) && !defined(__WXMICROWIN__)
1013
1014 if ( dir.empty() )
1015 {
1016 if ( !::GetTempPath(MAX_PATH, wxStringBuffer(dir, MAX_PATH + 1)) )
1017 {
1018 wxLogLastError(_T("GetTempPath"));
1019 }
1020
1021 if ( dir.empty() )
1022 {
1023 // GetTempFileName() fails if we pass it an empty string
1024 dir = _T('.');
1025 }
1026 }
1027#else // !Windows
1028
1029 if ( dir.empty() )
1030 {
1031 // default
1032#if defined(__DOS__) || defined(__OS2__)
1033 dir = _T(".");
1034#elif defined(__WXMAC__)
1035 dir = wxMacFindFolder(short(kOnSystemDisk), kTemporaryFolderType, kCreateFolder);
1036#else
1037 dir = _T("/tmp");
1038#endif
1039 }
1040#endif
1041
1042 return dir;
1043}
1044
1527281e 1045bool wxFileName::Mkdir( int perm, int flags )
a35b27b1 1046{
db759dde 1047 return wxFileName::Mkdir(GetPath(), perm, flags);
a35b27b1
RR
1048}
1049
1527281e 1050bool wxFileName::Mkdir( const wxString& dir, int perm, int flags )
df5ddbca 1051{
1527281e 1052 if ( flags & wxPATH_MKDIR_FULL )
f0ce3409 1053 {
1527281e
VZ
1054 // split the path in components
1055 wxFileName filename;
1056 filename.AssignDir(dir);
f0ce3409 1057
f0ce3409 1058 wxString currPath;
0ea621cc
VZ
1059 if ( filename.HasVolume())
1060 {
1527281e 1061 currPath << wxGetVolumeString(filename.GetVolume(), wxPATH_NATIVE);
0ea621cc 1062 }
f0ce3409 1063
1527281e
VZ
1064 wxArrayString dirs = filename.GetDirs();
1065 size_t count = dirs.GetCount();
1066 for ( size_t i = 0; i < count; i++ )
1067 {
a62848fd 1068 if ( i > 0 ||
6b9eeef2 1069#if defined(__WXMAC__) && !defined(__DARWIN__)
a62848fd
WS
1070 // relative pathnames are exactely the other way round under mac...
1071 !filename.IsAbsolute()
6b9eeef2 1072#else
a62848fd 1073 filename.IsAbsolute()
6b9eeef2
SC
1074#endif
1075 )
f0ce3409 1076 currPath += wxFILE_SEP_PATH;
1527281e 1077 currPath += dirs[i];
f0ce3409
JS
1078
1079 if (!DirExists(currPath))
1527281e 1080 {
f0ce3409 1081 if (!wxMkdir(currPath, perm))
1527281e
VZ
1082 {
1083 // no need to try creating further directories
f363e05c 1084 return false;
1527281e
VZ
1085 }
1086 }
f0ce3409
JS
1087 }
1088
f363e05c 1089 return true;
f0ce3409
JS
1090
1091 }
1527281e
VZ
1092
1093 return ::wxMkdir( dir, perm );
df5ddbca
RR
1094}
1095
a35b27b1 1096bool wxFileName::Rmdir()
df5ddbca 1097{
db759dde 1098 return wxFileName::Rmdir( GetPath() );
df5ddbca
RR
1099}
1100
a35b27b1 1101bool wxFileName::Rmdir( const wxString &dir )
df5ddbca 1102{
a35b27b1 1103 return ::wxRmdir( dir );
df5ddbca
RR
1104}
1105
844f90fb
VZ
1106// ----------------------------------------------------------------------------
1107// path normalization
1108// ----------------------------------------------------------------------------
1109
32a0d013 1110bool wxFileName::Normalize(int flags,
844f90fb
VZ
1111 const wxString& cwd,
1112 wxPathFormat format)
a35b27b1 1113{
05e1201c
VZ
1114 // deal with env vars renaming first as this may seriously change the path
1115 if ( flags & wxPATH_NORM_ENV_VARS )
1116 {
1117 wxString pathOrig = GetFullPath(format);
1118 wxString path = wxExpandEnvVars(pathOrig);
1119 if ( path != pathOrig )
1120 {
1121 Assign(path);
1122 }
1123 }
1124
1125
844f90fb
VZ
1126 // the existing path components
1127 wxArrayString dirs = GetDirs();
1128
1129 // the path to prepend in front to make the path absolute
1130 wxFileName curDir;
1131
1132 format = GetFormat(format);
ae4d7004 1133
844f90fb 1134 // make the path absolute
a2fa5040 1135 if ( (flags & wxPATH_NORM_ABSOLUTE) && !IsAbsolute(format) )
a35b27b1 1136 {
844f90fb 1137 if ( cwd.empty() )
6f91bc33
VZ
1138 {
1139 curDir.AssignCwd(GetVolume());
1140 }
1141 else // cwd provided
1142 {
844f90fb 1143 curDir.AssignDir(cwd);
6f91bc33 1144 }
52dbd056
VZ
1145
1146 // the path may be not absolute because it doesn't have the volume name
1147 // but in this case we shouldn't modify the directory components of it
1148 // but just set the current volume
1149 if ( !HasVolume() && curDir.HasVolume() )
1150 {
1151 SetVolume(curDir.GetVolume());
1152
a2fa5040 1153 if ( !m_relative )
52dbd056
VZ
1154 {
1155 // yes, it was the case - we don't need curDir then
1156 curDir.Clear();
1157 }
1158 }
a35b27b1 1159 }
ae4d7004 1160
844f90fb
VZ
1161 // handle ~ stuff under Unix only
1162 if ( (format == wxPATH_UNIX) && (flags & wxPATH_NORM_TILDE) )
a35b27b1 1163 {
844f90fb
VZ
1164 if ( !dirs.IsEmpty() )
1165 {
1166 wxString dir = dirs[0u];
1167 if ( !dir.empty() && dir[0u] == _T('~') )
1168 {
1169 curDir.AssignDir(wxGetUserHome(dir.c_str() + 1));
1170
da2fd5ac 1171 dirs.RemoveAt(0u);
844f90fb
VZ
1172 }
1173 }
a35b27b1 1174 }
844f90fb 1175
52dbd056 1176 // transform relative path into abs one
844f90fb 1177 if ( curDir.IsOk() )
a35b27b1 1178 {
844f90fb
VZ
1179 wxArrayString dirsNew = curDir.GetDirs();
1180 size_t count = dirs.GetCount();
1181 for ( size_t n = 0; n < count; n++ )
1182 {
1183 dirsNew.Add(dirs[n]);
1184 }
1185
1186 dirs = dirsNew;
a35b27b1 1187 }
844f90fb
VZ
1188
1189 // now deal with ".", ".." and the rest
1190 m_dirs.Empty();
1191 size_t count = dirs.GetCount();
1192 for ( size_t n = 0; n < count; n++ )
a35b27b1 1193 {
844f90fb
VZ
1194 wxString dir = dirs[n];
1195
2bc60417 1196 if ( flags & wxPATH_NORM_DOTS )
844f90fb
VZ
1197 {
1198 if ( dir == wxT(".") )
1199 {
1200 // just ignore
1201 continue;
1202 }
1203
1204 if ( dir == wxT("..") )
1205 {
1206 if ( m_dirs.IsEmpty() )
1207 {
1208 wxLogError(_("The path '%s' contains too many \"..\"!"),
1209 GetFullPath().c_str());
f363e05c 1210 return false;
844f90fb
VZ
1211 }
1212
ae4d7004 1213 m_dirs.RemoveAt(m_dirs.GetCount() - 1);
844f90fb
VZ
1214 continue;
1215 }
1216 }
1217
844f90fb
VZ
1218 if ( (flags & wxPATH_NORM_CASE) && !IsCaseSensitive(format) )
1219 {
1220 dir.MakeLower();
1221 }
1222
1223 m_dirs.Add(dir);
a35b27b1 1224 }
a62848fd 1225
6bda7391 1226#if defined(__WIN32__) && !defined(__WXWINCE__) && wxUSE_OLE
21f60945
JS
1227 if ( (flags & wxPATH_NORM_SHORTCUT) )
1228 {
1229 wxString filename;
1230 if (GetShortcutTarget(GetFullPath(format), filename))
1231 {
1232 // Repeat this since we may now have a new path
1233 if ( (flags & wxPATH_NORM_CASE) && !IsCaseSensitive(format) )
1234 {
1235 filename.MakeLower();
1236 }
1237 m_relative = false;
1238 Assign(filename);
1239 }
1240 }
1241#endif
844f90fb
VZ
1242
1243 if ( (flags & wxPATH_NORM_CASE) && !IsCaseSensitive(format) )
1244 {
1245 // VZ: expand env vars here too?
1246
55268a3a 1247 m_volume.MakeLower();
844f90fb
VZ
1248 m_name.MakeLower();
1249 m_ext.MakeLower();
1250 }
1251
e83ecba9
VZ
1252 // we do have the path now
1253 //
1254 // NB: need to do this before (maybe) calling Assign() below
f363e05c 1255 m_relative = false;
e83ecba9 1256
52dbd056
VZ
1257#if defined(__WIN32__)
1258 if ( (flags & wxPATH_NORM_LONG) && (format == wxPATH_DOS) )
9e9b65c1
JS
1259 {
1260 Assign(GetLongPath());
1261 }
52dbd056 1262#endif // Win32
9e9b65c1 1263
f363e05c 1264 return true;
a2fa5040
VZ
1265}
1266
21f60945
JS
1267// ----------------------------------------------------------------------------
1268// get the shortcut target
1269// ----------------------------------------------------------------------------
1270
5671b3b6
JS
1271// WinCE (3) doesn't have CLSID_ShellLink, IID_IShellLink definitions.
1272// The .lnk file is a plain text file so it should be easy to
1273// make it work. Hint from Google Groups:
1274// "If you open up a lnk file, you'll see a
1275// number, followed by a pound sign (#), followed by more text. The
1276// number is the number of characters that follows the pound sign. The
1277// characters after the pound sign are the command line (which _can_
1278// include arguments) to be executed. Any path (e.g. \windows\program
1279// files\myapp.exe) that includes spaces needs to be enclosed in
1280// quotation marks."
1281
6bda7391 1282#if defined(__WIN32__) && !defined(__WXWINCE__) && wxUSE_OLE
5671b3b6
JS
1283// The following lines are necessary under WinCE
1284// #include "wx/msw/private.h"
1285// #include <ole2.h>
21f60945 1286#include <shlobj.h>
5671b3b6
JS
1287#if defined(__WXWINCE__)
1288#include <shlguid.h>
1289#endif
21f60945 1290
cea0869c
VZ
1291bool wxFileName::GetShortcutTarget(const wxString& shortcutPath,
1292 wxString& targetFilename,
1293 wxString* arguments)
21f60945 1294{
21f60945
JS
1295 wxString path, file, ext;
1296 wxSplitPath(shortcutPath, & path, & file, & ext);
a62848fd
WS
1297
1298 HRESULT hres;
1299 IShellLink* psl;
1300 bool success = false;
21f60945
JS
1301
1302 // Assume it's not a shortcut if it doesn't end with lnk
489f6cf7 1303 if (ext.CmpNoCase(wxT("lnk"))!=0)
a62848fd
WS
1304 return false;
1305
1306 // create a ShellLink object
1307 hres = CoCreateInstance(CLSID_ShellLink, NULL, CLSCTX_INPROC_SERVER,
1308 IID_IShellLink, (LPVOID*) &psl);
1309
1310 if (SUCCEEDED(hres))
1311 {
1312 IPersistFile* ppf;
1313 hres = psl->QueryInterface( IID_IPersistFile, (LPVOID *) &ppf);
1314 if (SUCCEEDED(hres))
1315 {
1316 WCHAR wsz[MAX_PATH];
1317
1318 MultiByteToWideChar(CP_ACP, MB_PRECOMPOSED, shortcutPath.mb_str(), -1, wsz,
1319 MAX_PATH);
1320
1321 hres = ppf->Load(wsz, 0);
cea0869c
VZ
1322 ppf->Release();
1323
a62848fd
WS
1324 if (SUCCEEDED(hres))
1325 {
21f60945 1326 wxChar buf[2048];
59ba321b
JS
1327 // Wrong prototype in early versions
1328#if defined(__MINGW32__) && !wxCHECK_W32API_VERSION(2, 2)
1329 psl->GetPath((CHAR*) buf, 2048, NULL, SLGP_UNCPRIORITY);
1330#else
a62848fd 1331 psl->GetPath(buf, 2048, NULL, SLGP_UNCPRIORITY);
59ba321b 1332#endif
a62848fd 1333 targetFilename = wxString(buf);
21f60945
JS
1334 success = (shortcutPath != targetFilename);
1335
a62848fd 1336 psl->GetArguments(buf, 2048);
21f60945 1337 wxString args(buf);
b494c48b 1338 if (!args.empty() && arguments)
21f60945
JS
1339 {
1340 *arguments = args;
a62848fd
WS
1341 }
1342 }
1343 }
cea0869c
VZ
1344
1345 psl->Release();
a62848fd 1346 }
a62848fd 1347 return success;
21f60945 1348}
cea0869c
VZ
1349
1350#endif // __WIN32__ && !__WXWINCE__
21f60945
JS
1351
1352
a2fa5040
VZ
1353// ----------------------------------------------------------------------------
1354// absolute/relative paths
1355// ----------------------------------------------------------------------------
1356
1357bool wxFileName::IsAbsolute(wxPathFormat format) const
1358{
1359 // if our path doesn't start with a path separator, it's not an absolute
1360 // path
1361 if ( m_relative )
f363e05c 1362 return false;
a2fa5040
VZ
1363
1364 if ( !GetVolumeSeparator(format).empty() )
1365 {
1366 // this format has volumes and an absolute path must have one, it's not
1367 // enough to have the full path to bean absolute file under Windows
1368 if ( GetVolume().empty() )
f363e05c 1369 return false;
a2fa5040
VZ
1370 }
1371
f363e05c 1372 return true;
a35b27b1
RR
1373}
1374
f7d886af
VZ
1375bool wxFileName::MakeRelativeTo(const wxString& pathBase, wxPathFormat format)
1376{
cef9731a 1377 wxFileName fnBase = wxFileName::DirName(pathBase, format);
f7d886af
VZ
1378
1379 // get cwd only once - small time saving
1380 wxString cwd = wxGetCwd();
b5b62eea
JS
1381 Normalize(wxPATH_NORM_ALL & ~wxPATH_NORM_CASE, cwd, format);
1382 fnBase.Normalize(wxPATH_NORM_ALL & ~wxPATH_NORM_CASE, cwd, format);
f7d886af
VZ
1383
1384 bool withCase = IsCaseSensitive(format);
1385
1386 // we can't do anything if the files live on different volumes
1387 if ( !GetVolume().IsSameAs(fnBase.GetVolume(), withCase) )
1388 {
1389 // nothing done
f363e05c 1390 return false;
f7d886af
VZ
1391 }
1392
1393 // same drive, so we don't need our volume
1394 m_volume.clear();
1395
1396 // remove common directories starting at the top
1397 while ( !m_dirs.IsEmpty() && !fnBase.m_dirs.IsEmpty() &&
1398 m_dirs[0u].IsSameAs(fnBase.m_dirs[0u], withCase) )
1399 {
ae4d7004
VZ
1400 m_dirs.RemoveAt(0);
1401 fnBase.m_dirs.RemoveAt(0);
f7d886af
VZ
1402 }
1403
1404 // add as many ".." as needed
1405 size_t count = fnBase.m_dirs.GetCount();
1406 for ( size_t i = 0; i < count; i++ )
1407 {
1408 m_dirs.Insert(wxT(".."), 0u);
1409 }
90a68369 1410
2db991f4
VZ
1411 if ( format == wxPATH_UNIX || format == wxPATH_DOS )
1412 {
1413 // a directory made relative with respect to itself is '.' under Unix
1414 // and DOS, by definition (but we don't have to insert "./" for the
1415 // files)
1416 if ( m_dirs.IsEmpty() && IsDir() )
1417 {
1418 m_dirs.Add(_T('.'));
0ea621cc 1419 }
2db991f4
VZ
1420 }
1421
f363e05c 1422 m_relative = true;
f7d886af
VZ
1423
1424 // we were modified
f363e05c 1425 return true;
f7d886af
VZ
1426}
1427
844f90fb
VZ
1428// ----------------------------------------------------------------------------
1429// filename kind tests
1430// ----------------------------------------------------------------------------
1431
2b5f62a0 1432bool wxFileName::SameAs(const wxFileName& filepath, wxPathFormat format) const
df5ddbca 1433{
844f90fb
VZ
1434 wxFileName fn1 = *this,
1435 fn2 = filepath;
1436
1437 // get cwd only once - small time saving
1438 wxString cwd = wxGetCwd();
55268a3a
VZ
1439 fn1.Normalize(wxPATH_NORM_ALL | wxPATH_NORM_CASE, cwd, format);
1440 fn2.Normalize(wxPATH_NORM_ALL | wxPATH_NORM_CASE, cwd, format);
844f90fb
VZ
1441
1442 if ( fn1.GetFullPath() == fn2.GetFullPath() )
f363e05c 1443 return true;
844f90fb
VZ
1444
1445 // TODO: compare inodes for Unix, this works even when filenames are
1446 // different but files are the same (symlinks) (VZ)
1447
f363e05c 1448 return false;
df5ddbca
RR
1449}
1450
844f90fb 1451/* static */
df5ddbca
RR
1452bool wxFileName::IsCaseSensitive( wxPathFormat format )
1453{
04c943b1
VZ
1454 // only Unix filenames are truely case-sensitive
1455 return GetFormat(format) == wxPATH_UNIX;
df5ddbca
RR
1456}
1457
f363e05c
VZ
1458/* static */
1459wxString wxFileName::GetForbiddenChars(wxPathFormat format)
1460{
1461 // Inits to forbidden characters that are common to (almost) all platforms.
1462 wxString strForbiddenChars = wxT("*?");
1463
1c6f2414 1464 // If asserts, wxPathFormat has been changed. In case of a new path format
f363e05c 1465 // addition, the following code might have to be updated.
1c6f2414 1466 wxCOMPILE_TIME_ASSERT(wxPATH_MAX == 5, wxPathFormatChanged);
f363e05c
VZ
1467 switch ( GetFormat(format) )
1468 {
1469 default :
1470 wxFAIL_MSG( wxT("Unknown path format") );
1471 // !! Fall through !!
1472
1473 case wxPATH_UNIX:
1474 break;
1475
1476 case wxPATH_MAC:
1477 // On a Mac even names with * and ? are allowed (Tested with OS
1478 // 9.2.1 and OS X 10.2.5)
1479 strForbiddenChars = wxEmptyString;
1480 break;
1481
1482 case wxPATH_DOS:
1483 strForbiddenChars += wxT("\\/:\"<>|");
1484 break;
1485
1486 case wxPATH_VMS:
1487 break;
1488 }
1489
1490 return strForbiddenChars;
1491}
1492
04c943b1 1493/* static */
bcfa2b31 1494wxString wxFileName::GetVolumeSeparator(wxPathFormat WXUNUSED_IN_WINCE(format))
844f90fb 1495{
bcfa2b31
WS
1496#ifdef __WXWINCE__
1497 return wxEmptyString;
1498#else
04c943b1
VZ
1499 wxString sepVol;
1500
a385b5df
RR
1501 if ( (GetFormat(format) == wxPATH_DOS) ||
1502 (GetFormat(format) == wxPATH_VMS) )
04c943b1 1503 {
04c943b1
VZ
1504 sepVol = wxFILE_SEP_DSK;
1505 }
a385b5df 1506 //else: leave empty
04c943b1
VZ
1507
1508 return sepVol;
bcfa2b31 1509#endif
844f90fb
VZ
1510}
1511
1512/* static */
1513wxString wxFileName::GetPathSeparators(wxPathFormat format)
1514{
1515 wxString seps;
1516 switch ( GetFormat(format) )
df5ddbca 1517 {
844f90fb 1518 case wxPATH_DOS:
04c943b1
VZ
1519 // accept both as native APIs do but put the native one first as
1520 // this is the one we use in GetFullPath()
1521 seps << wxFILE_SEP_PATH_DOS << wxFILE_SEP_PATH_UNIX;
844f90fb
VZ
1522 break;
1523
1524 default:
f363e05c 1525 wxFAIL_MSG( _T("Unknown wxPATH_XXX style") );
844f90fb
VZ
1526 // fall through
1527
1528 case wxPATH_UNIX:
9e8d8607 1529 seps = wxFILE_SEP_PATH_UNIX;
844f90fb
VZ
1530 break;
1531
1532 case wxPATH_MAC:
9e8d8607 1533 seps = wxFILE_SEP_PATH_MAC;
844f90fb 1534 break;
04c943b1 1535
3c621059
JJ
1536 case wxPATH_VMS:
1537 seps = wxFILE_SEP_PATH_VMS;
1538 break;
df5ddbca
RR
1539 }
1540
844f90fb 1541 return seps;
df5ddbca
RR
1542}
1543
f1e77933
VZ
1544/* static */
1545wxString wxFileName::GetPathTerminators(wxPathFormat format)
1546{
1547 format = GetFormat(format);
1548
1549 // under VMS the end of the path is ']', not the path separator used to
1550 // separate the components
1551 return format == wxPATH_VMS ? wxString(_T(']')) : GetPathSeparators(format);
1552}
1553
844f90fb
VZ
1554/* static */
1555bool wxFileName::IsPathSeparator(wxChar ch, wxPathFormat format)
df5ddbca 1556{
04c943b1 1557 // wxString::Find() doesn't work as expected with NUL - it will always find
2fb5a4ce
VZ
1558 // it, so test for it separately
1559 return ch != _T('\0') && GetPathSeparators(format).Find(ch) != wxNOT_FOUND;
df5ddbca
RR
1560}
1561
844f90fb
VZ
1562// ----------------------------------------------------------------------------
1563// path components manipulation
1564// ----------------------------------------------------------------------------
1565
5bb9aeb2
VZ
1566/* static */ bool wxFileName::IsValidDirComponent(const wxString& dir)
1567{
1568 if ( dir.empty() )
1569 {
1570 wxFAIL_MSG( _T("empty directory passed to wxFileName::InsertDir()") );
1571
1572 return false;
1573 }
1574
1575 const size_t len = dir.length();
1576 for ( size_t n = 0; n < len; n++ )
1577 {
1578 if ( dir[n] == GetVolumeSeparator() || IsPathSeparator(dir[n]) )
1579 {
1580 wxFAIL_MSG( _T("invalid directory component in wxFileName") );
1581
1582 return false;
1583 }
1584 }
1585
1586 return true;
1587}
1588
2458d90b 1589void wxFileName::AppendDir( const wxString& dir )
df5ddbca 1590{
5bb9aeb2
VZ
1591 if ( IsValidDirComponent(dir) )
1592 m_dirs.Add( dir );
df5ddbca
RR
1593}
1594
2458d90b 1595void wxFileName::PrependDir( const wxString& dir )
df5ddbca 1596{
5bb9aeb2 1597 InsertDir(0, dir);
df5ddbca
RR
1598}
1599
2458d90b 1600void wxFileName::InsertDir(size_t before, const wxString& dir)
df5ddbca 1601{
5bb9aeb2 1602 if ( IsValidDirComponent(dir) )
2458d90b 1603 m_dirs.Insert(dir, before);
df5ddbca
RR
1604}
1605
2458d90b 1606void wxFileName::RemoveDir(size_t pos)
df5ddbca 1607{
2458d90b 1608 m_dirs.RemoveAt(pos);
df5ddbca
RR
1609}
1610
844f90fb
VZ
1611// ----------------------------------------------------------------------------
1612// accessors
1613// ----------------------------------------------------------------------------
1614
7124df9b
VZ
1615void wxFileName::SetFullName(const wxString& fullname)
1616{
dfecbee5
VZ
1617 SplitPath(fullname, NULL /* no volume */, NULL /* no path */,
1618 &m_name, &m_ext, &m_hasExt);
7124df9b
VZ
1619}
1620
844f90fb 1621wxString wxFileName::GetFullName() const
a35b27b1 1622{
844f90fb 1623 wxString fullname = m_name;
dfecbee5 1624 if ( m_hasExt )
a35b27b1 1625 {
9e8d8607 1626 fullname << wxFILE_SEP_EXT << m_ext;
a35b27b1 1627 }
a35b27b1 1628
844f90fb 1629 return fullname;
a35b27b1
RR
1630}
1631
33b97389 1632wxString wxFileName::GetPath( int flags, wxPathFormat format ) const
df5ddbca
RR
1633{
1634 format = GetFormat( format );
844f90fb 1635
353f41cb
RR
1636 wxString fullpath;
1637
33b97389
VZ
1638 // return the volume with the path as well if requested
1639 if ( flags & wxPATH_GET_VOLUME )
1640 {
1641 fullpath += wxGetVolumeString(GetVolume(), format);
1642 }
1643
034742fc
VZ
1644 // the leading character
1645 switch ( format )
1646 {
1647 case wxPATH_MAC:
1648 if ( m_relative )
1649 fullpath += wxFILE_SEP_PATH_MAC;
1650 break;
1651
1652 case wxPATH_DOS:
1653 if ( !m_relative )
1654 fullpath += wxFILE_SEP_PATH_DOS;
1655 break;
1656
1657 default:
1658 wxFAIL_MSG( wxT("Unknown path format") );
1659 // fall through
1660
1661 case wxPATH_UNIX:
1662 if ( !m_relative )
1663 {
1664 // normally the absolute file names start with a slash
1665 // with one exception: the ones like "~/foo.bar" don't
1666 // have it
9b3a3820 1667 if ( m_dirs.IsEmpty() || m_dirs[0u] != _T('~') )
034742fc
VZ
1668 {
1669 fullpath += wxFILE_SEP_PATH_UNIX;
1670 }
1671 }
1672 break;
1673
1674 case wxPATH_VMS:
1675 // no leading character here but use this place to unset
1676 // wxPATH_GET_SEPARATOR flag: under VMS it doesn't make sense
1677 // as, if I understand correctly, there should never be a dot
1678 // before the closing bracket
1679 flags &= ~wxPATH_GET_SEPARATOR;
1680 }
1681
1682 if ( m_dirs.empty() )
1683 {
1684 // there is nothing more
1685 return fullpath;
1686 }
1687
1688 // then concatenate all the path components using the path separator
1689 if ( format == wxPATH_VMS )
1690 {
1691 fullpath += wxT('[');
1692 }
1693
5bb9aeb2 1694 const size_t dirCount = m_dirs.GetCount();
034742fc 1695 for ( size_t i = 0; i < dirCount; i++ )
353f41cb 1696 {
034742fc 1697 switch (format)
5bb9aeb2
VZ
1698 {
1699 case wxPATH_MAC:
034742fc
VZ
1700 if ( m_dirs[i] == wxT(".") )
1701 {
1702 // skip appending ':', this shouldn't be done in this
1703 // case as "::" is interpreted as ".." under Unix
1704 continue;
1705 }
2361ce82 1706
034742fc 1707 // convert back from ".." to nothing
489f6cf7 1708 if ( !m_dirs[i].IsSameAs(wxT("..")) )
034742fc 1709 fullpath += m_dirs[i];
5bb9aeb2 1710 break;
2361ce82 1711
5bb9aeb2 1712 default:
034742fc
VZ
1713 wxFAIL_MSG( wxT("Unexpected path format") );
1714 // still fall through
2361ce82 1715
034742fc 1716 case wxPATH_DOS:
5bb9aeb2 1717 case wxPATH_UNIX:
034742fc 1718 fullpath += m_dirs[i];
5bb9aeb2 1719 break;
2361ce82 1720
5bb9aeb2 1721 case wxPATH_VMS:
034742fc 1722 // TODO: What to do with ".." under VMS
353f41cb 1723
034742fc 1724 // convert back from ".." to nothing
489f6cf7 1725 if ( !m_dirs[i].IsSameAs(wxT("..")) )
353f41cb 1726 fullpath += m_dirs[i];
034742fc 1727 break;
4175794e
VZ
1728 }
1729
034742fc
VZ
1730 if ( (flags & wxPATH_GET_SEPARATOR) || (i != dirCount - 1) )
1731 fullpath += GetPathSeparator(format);
df5ddbca 1732 }
034742fc
VZ
1733
1734 if ( format == wxPATH_VMS )
5bb9aeb2 1735 {
034742fc 1736 fullpath += wxT(']');
5bb9aeb2 1737 }
844f90fb 1738
353f41cb 1739 return fullpath;
df5ddbca
RR
1740}
1741
1742wxString wxFileName::GetFullPath( wxPathFormat format ) const
1743{
4175794e
VZ
1744 // we already have a function to get the path
1745 wxString fullpath = GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR,
1746 format);
04c943b1 1747
4175794e 1748 // now just add the file name and extension to it
04c943b1
VZ
1749 fullpath += GetFullName();
1750
1751 return fullpath;
df5ddbca
RR
1752}
1753
9e9b65c1
JS
1754// Return the short form of the path (returns identity on non-Windows platforms)
1755wxString wxFileName::GetShortPath() const
1756{
9e9b65c1 1757 wxString path(GetFullPath());
2f3d9587
VZ
1758
1759#if defined(__WXMSW__) && defined(__WIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
75ef5722 1760 DWORD sz = ::GetShortPathName(path, NULL, 0);
2f3d9587 1761 if ( sz != 0 )
9e9b65c1 1762 {
2f3d9587
VZ
1763 wxString pathOut;
1764 if ( ::GetShortPathName
75ef5722
JS
1765 (
1766 path,
de564874 1767 wxStringBuffer(pathOut, sz),
75ef5722 1768 sz
2f3d9587
VZ
1769 ) != 0 )
1770 {
1771 return pathOut;
1772 }
9e9b65c1 1773 }
2f3d9587 1774#endif // Windows
5716a1ab
VZ
1775
1776 return path;
9e9b65c1
JS
1777}
1778
1779// Return the long form of the path (returns identity on non-Windows platforms)
1780wxString wxFileName::GetLongPath() const
1781{
52dbd056
VZ
1782 wxString pathOut,
1783 path = GetFullPath();
1784
1785#if defined(__WIN32__) && !defined(__WXMICROWIN__)
05e7001c 1786
35a6691a 1787#if wxUSE_DYNAMIC_LOADER
62dcaed6 1788 typedef DWORD (WINAPI *GET_LONG_PATH_NAME)(const wxChar *, wxChar *, DWORD);
05e7001c 1789
2f3d9587
VZ
1790 // this is MT-safe as in the worst case we're going to resolve the function
1791 // twice -- but as the result is the same in both threads, it's ok
1792 static GET_LONG_PATH_NAME s_pfnGetLongPathName = NULL;
1793 if ( !s_pfnGetLongPathName )
9e9b65c1 1794 {
2f3d9587 1795 static bool s_triedToLoad = false;
2361ce82 1796
2f3d9587 1797 if ( !s_triedToLoad )
05e7001c 1798 {
2f3d9587
VZ
1799 s_triedToLoad = true;
1800
1801 wxDynamicLibrary dllKernel(_T("kernel32"));
1802
4377d3ab
WS
1803 const wxChar* GetLongPathName = _T("GetLongPathName")
1804#if wxUSE_UNICODE
1805 _T("W");
1806#else // ANSI
1807 _T("A");
1808#endif // Unicode/ANSI
1809
1810 if ( dllKernel.HasSymbol(GetLongPathName) )
05e7001c 1811 {
2f3d9587 1812 s_pfnGetLongPathName = (GET_LONG_PATH_NAME)
4377d3ab 1813 dllKernel.GetSymbol(GetLongPathName);
05e7001c 1814 }
2f3d9587
VZ
1815
1816 // note that kernel32.dll can be unloaded, it stays in memory
1817 // anyhow as all Win32 programs link to it and so it's safe to call
1818 // GetLongPathName() even after unloading it
05e7001c 1819 }
9e9b65c1 1820 }
2361ce82 1821
2f3d9587
VZ
1822 if ( s_pfnGetLongPathName )
1823 {
1824 DWORD dwSize = (*s_pfnGetLongPathName)(path, NULL, 0);
1825 if ( dwSize > 0 )
1826 {
1827 if ( (*s_pfnGetLongPathName)
1828 (
1829 path,
1830 wxStringBuffer(pathOut, dwSize),
1831 dwSize
1832 ) != 0 )
1833 {
1834 return pathOut;
1835 }
1836 }
1837 }
0b9ab0bd 1838#endif // wxUSE_DYNAMIC_LOADER
05e7001c 1839
2f3d9587
VZ
1840 // The OS didn't support GetLongPathName, or some other error.
1841 // We need to call FindFirstFile on each component in turn.
05e7001c 1842
2f3d9587
VZ
1843 WIN32_FIND_DATA findFileData;
1844 HANDLE hFind;
b5b62eea 1845
2f3d9587
VZ
1846 if ( HasVolume() )
1847 pathOut = GetVolume() +
1848 GetVolumeSeparator(wxPATH_DOS) +
1849 GetPathSeparator(wxPATH_DOS);
1850 else
1851 pathOut = wxEmptyString;
05e7001c 1852
2f3d9587
VZ
1853 wxArrayString dirs = GetDirs();
1854 dirs.Add(GetFullName());
77fe02a8 1855
2f3d9587 1856 wxString tmpPath;
5d978d07 1857
2f3d9587
VZ
1858 size_t count = dirs.GetCount();
1859 for ( size_t i = 0; i < count; i++ )
1860 {
1861 // We're using pathOut to collect the long-name path, but using a
1862 // temporary for appending the last path component which may be
1863 // short-name
1864 tmpPath = pathOut + dirs[i];
05e7001c 1865
2f3d9587
VZ
1866 if ( tmpPath.empty() )
1867 continue;
52dbd056 1868
2f3d9587
VZ
1869 // can't see this being necessary? MF
1870 if ( tmpPath.Last() == GetVolumeSeparator(wxPATH_DOS) )
1871 {
1872 // Can't pass a drive and root dir to FindFirstFile,
1873 // so continue to next dir
1874 tmpPath += wxFILE_SEP_PATH;
1875 pathOut = tmpPath;
1876 continue;
1877 }
05e7001c 1878
2f3d9587
VZ
1879 hFind = ::FindFirstFile(tmpPath, &findFileData);
1880 if (hFind == INVALID_HANDLE_VALUE)
1881 {
1882 // Error: most likely reason is that path doesn't exist, so
1883 // append any unprocessed parts and return
1884 for ( i += 1; i < count; i++ )
1885 tmpPath += wxFILE_SEP_PATH + dirs[i];
b5b62eea 1886
2f3d9587
VZ
1887 return tmpPath;
1888 }
05e7001c 1889
2f3d9587
VZ
1890 pathOut += findFileData.cFileName;
1891 if ( (i < (count-1)) )
1892 pathOut += wxFILE_SEP_PATH;
52dbd056 1893
2f3d9587 1894 ::FindClose(hFind);
05e7001c 1895 }
52dbd056
VZ
1896#else // !Win32
1897 pathOut = path;
1898#endif // Win32/!Win32
5716a1ab 1899
05e7001c 1900 return pathOut;
9e9b65c1
JS
1901}
1902
df5ddbca
RR
1903wxPathFormat wxFileName::GetFormat( wxPathFormat format )
1904{
1905 if (format == wxPATH_NATIVE)
1906 {
5a3912f2 1907#if defined(__WXMSW__) || defined(__OS2__) || defined(__DOS__)
df5ddbca 1908 format = wxPATH_DOS;
4d293f8e 1909#elif defined(__WXMAC__) && !defined(__DARWIN__)
04c943b1 1910 format = wxPATH_MAC;
3c621059 1911#elif defined(__VMS)
04c943b1 1912 format = wxPATH_VMS;
844f90fb 1913#else
df5ddbca
RR
1914 format = wxPATH_UNIX;
1915#endif
1916 }
1917 return format;
1918}
a35b27b1 1919
9e8d8607
VZ
1920// ----------------------------------------------------------------------------
1921// path splitting function
1922// ----------------------------------------------------------------------------
1923
6f91bc33 1924/* static */
f1e77933
VZ
1925void
1926wxFileName::SplitVolume(const wxString& fullpathWithVolume,
1927 wxString *pstrVolume,
1928 wxString *pstrPath,
1929 wxPathFormat format)
9e8d8607
VZ
1930{
1931 format = GetFormat(format);
1932
04c943b1
VZ
1933 wxString fullpath = fullpathWithVolume;
1934
04c943b1
VZ
1935 // special Windows UNC paths hack: transform \\share\path into share:path
1936 if ( format == wxPATH_DOS )
9e8d8607 1937 {
04c943b1
VZ
1938 if ( fullpath.length() >= 4 &&
1939 fullpath[0u] == wxFILE_SEP_PATH_DOS &&
1940 fullpath[1u] == wxFILE_SEP_PATH_DOS )
9e8d8607 1941 {
04c943b1
VZ
1942 fullpath.erase(0, 2);
1943
f1e77933
VZ
1944 size_t posFirstSlash =
1945 fullpath.find_first_of(GetPathTerminators(format));
04c943b1
VZ
1946 if ( posFirstSlash != wxString::npos )
1947 {
1948 fullpath[posFirstSlash] = wxFILE_SEP_DSK;
1949
1950 // UNC paths are always absolute, right? (FIXME)
de564874 1951 fullpath.insert(posFirstSlash + 1, 1, wxFILE_SEP_PATH_DOS);
04c943b1 1952 }
3c621059
JJ
1953 }
1954 }
04c943b1 1955
a385b5df
RR
1956 // We separate the volume here
1957 if ( format == wxPATH_DOS || format == wxPATH_VMS )
04c943b1 1958 {
a385b5df 1959 wxString sepVol = GetVolumeSeparator(format);
24eb81cb 1960
04c943b1
VZ
1961 size_t posFirstColon = fullpath.find_first_of(sepVol);
1962 if ( posFirstColon != wxString::npos )
1963 {
1964 if ( pstrVolume )
1965 {
1966 *pstrVolume = fullpath.Left(posFirstColon);
1967 }
1968
1969 // remove the volume name and the separator from the full path
1970 fullpath.erase(0, posFirstColon + sepVol.length());
1971 }
1972 }
1973
f1e77933
VZ
1974 if ( pstrPath )
1975 *pstrPath = fullpath;
1976}
1977
1978/* static */
1979void wxFileName::SplitPath(const wxString& fullpathWithVolume,
1980 wxString *pstrVolume,
1981 wxString *pstrPath,
1982 wxString *pstrName,
1983 wxString *pstrExt,
dfecbee5 1984 bool *hasExt,
f1e77933
VZ
1985 wxPathFormat format)
1986{
1987 format = GetFormat(format);
1988
1989 wxString fullpath;
1990 SplitVolume(fullpathWithVolume, pstrVolume, &fullpath, format);
1991
04c943b1
VZ
1992 // find the positions of the last dot and last path separator in the path
1993 size_t posLastDot = fullpath.find_last_of(wxFILE_SEP_EXT);
f1e77933 1994 size_t posLastSlash = fullpath.find_last_of(GetPathTerminators(format));
04c943b1 1995
e5a573a2 1996 // check whether this dot occurs at the very beginning of a path component
04c943b1 1997 if ( (posLastDot != wxString::npos) &&
e5a573a2
VZ
1998 (posLastDot == 0 ||
1999 IsPathSeparator(fullpath[posLastDot - 1]) ||
2000 (format == wxPATH_VMS && fullpath[posLastDot - 1] == _T(']'))) )
f1e77933
VZ
2001 {
2002 // dot may be (and commonly -- at least under Unix -- is) the first
2003 // character of the filename, don't treat the entire filename as
2004 // extension in this case
2005 posLastDot = wxString::npos;
2006 }
9e8d8607 2007
8e7dda21
VZ
2008 // if we do have a dot and a slash, check that the dot is in the name part
2009 if ( (posLastDot != wxString::npos) &&
2010 (posLastSlash != wxString::npos) &&
2011 (posLastDot < posLastSlash) )
9e8d8607
VZ
2012 {
2013 // the dot is part of the path, not the start of the extension
2014 posLastDot = wxString::npos;
2015 }
2016
2017 // now fill in the variables provided by user
2018 if ( pstrPath )
2019 {
2020 if ( posLastSlash == wxString::npos )
2021 {
2022 // no path at all
2023 pstrPath->Empty();
2024 }
2025 else
2026 {
04c943b1 2027 // take everything up to the path separator but take care to make
353f41cb 2028 // the path equal to something like '/', not empty, for the files
04c943b1
VZ
2029 // immediately under root directory
2030 size_t len = posLastSlash;
91b4bd63
SC
2031
2032 // this rule does not apply to mac since we do not start with colons (sep)
2033 // except for relative paths
2034 if ( !len && format != wxPATH_MAC)
04c943b1
VZ
2035 len++;
2036
2037 *pstrPath = fullpath.Left(len);
2038
2039 // special VMS hack: remove the initial bracket
2040 if ( format == wxPATH_VMS )
2041 {
2042 if ( (*pstrPath)[0u] == _T('[') )
2043 pstrPath->erase(0, 1);
2044 }
9e8d8607
VZ
2045 }
2046 }
2047
2048 if ( pstrName )
2049 {
42b1f941
VZ
2050 // take all characters starting from the one after the last slash and
2051 // up to, but excluding, the last dot
9e8d8607 2052 size_t nStart = posLastSlash == wxString::npos ? 0 : posLastSlash + 1;
8e7dda21
VZ
2053 size_t count;
2054 if ( posLastDot == wxString::npos )
2055 {
2056 // take all until the end
2057 count = wxString::npos;
2058 }
2059 else if ( posLastSlash == wxString::npos )
2060 {
2061 count = posLastDot;
2062 }
2063 else // have both dot and slash
2064 {
2065 count = posLastDot - posLastSlash - 1;
2066 }
9e8d8607
VZ
2067
2068 *pstrName = fullpath.Mid(nStart, count);
2069 }
2070
dfecbee5
VZ
2071 // finally deal with the extension here: we have an added complication that
2072 // extension may be empty (but present) as in "foo." where trailing dot
2073 // indicates the empty extension at the end -- and hence we must remember
2074 // that we have it independently of pstrExt
2075 if ( posLastDot == wxString::npos )
9e8d8607 2076 {
dfecbee5
VZ
2077 // no extension
2078 if ( pstrExt )
2079 pstrExt->clear();
2080 if ( hasExt )
2081 *hasExt = false;
2082 }
2083 else
2084 {
2085 // take everything after the dot
2086 if ( pstrExt )
9e8d8607 2087 *pstrExt = fullpath.Mid(posLastDot + 1);
dfecbee5
VZ
2088 if ( hasExt )
2089 *hasExt = true;
9e8d8607
VZ
2090 }
2091}
951cd180 2092
6f91bc33
VZ
2093/* static */
2094void wxFileName::SplitPath(const wxString& fullpath,
2095 wxString *path,
2096 wxString *name,
2097 wxString *ext,
2098 wxPathFormat format)
2099{
2100 wxString volume;
2101 SplitPath(fullpath, &volume, path, name, ext, format);
2102
67c34f64 2103 if ( path )
6f91bc33 2104 {
67c34f64 2105 path->Prepend(wxGetVolumeString(volume, format));
6f91bc33
VZ
2106 }
2107}
2108
951cd180
VZ
2109// ----------------------------------------------------------------------------
2110// time functions
2111// ----------------------------------------------------------------------------
2112
e2b87f38
VZ
2113#if wxUSE_DATETIME
2114
6dbb903b
VZ
2115bool wxFileName::SetTimes(const wxDateTime *dtAccess,
2116 const wxDateTime *dtMod,
2117 const wxDateTime *dtCreate)
951cd180 2118{
2b5f62a0
VZ
2119#if defined(__WIN32__)
2120 if ( IsDir() )
2121 {
2122 // VZ: please let me know how to do this if you can
2123 wxFAIL_MSG( _T("SetTimes() not implemented for the directories") );
2124 }
2125 else // file
2126 {
2127 wxFileHandle fh(GetFullPath(), wxFileHandle::Write);
2128 if ( fh.IsOk() )
2129 {
2130 FILETIME ftAccess, ftCreate, ftWrite;
2131
2132 if ( dtCreate )
2133 ConvertWxToFileTime(&ftCreate, *dtCreate);
2134 if ( dtAccess )
2135 ConvertWxToFileTime(&ftAccess, *dtAccess);
2136 if ( dtMod )
2137 ConvertWxToFileTime(&ftWrite, *dtMod);
2138
2139 if ( ::SetFileTime(fh,
2140 dtCreate ? &ftCreate : NULL,
2141 dtAccess ? &ftAccess : NULL,
2142 dtMod ? &ftWrite : NULL) )
2143 {
f363e05c 2144 return true;
2b5f62a0
VZ
2145 }
2146 }
2147 }
2148#elif defined(__UNIX_LIKE__) || (defined(__DOS__) && defined(__WATCOMC__))
17a1ebd1
VZ
2149 wxUnusedVar(dtCreate);
2150
246c704f
VZ
2151 if ( !dtAccess && !dtMod )
2152 {
2153 // can't modify the creation time anyhow, don't try
f363e05c 2154 return true;
246c704f
VZ
2155 }
2156
2157 // if dtAccess or dtMod is not specified, use the other one (which must be
2158 // non NULL because of the test above) for both times
951cd180 2159 utimbuf utm;
246c704f
VZ
2160 utm.actime = dtAccess ? dtAccess->GetTicks() : dtMod->GetTicks();
2161 utm.modtime = dtMod ? dtMod->GetTicks() : dtAccess->GetTicks();
401eb3de 2162 if ( utime(GetFullPath().fn_str(), &utm) == 0 )
951cd180 2163 {
f363e05c 2164 return true;
951cd180 2165 }
951cd180 2166#else // other platform
7a893a31
WS
2167 wxUnusedVar(dtAccess);
2168 wxUnusedVar(dtMod);
2169 wxUnusedVar(dtCreate);
951cd180
VZ
2170#endif // platforms
2171
2172 wxLogSysError(_("Failed to modify file times for '%s'"),
2173 GetFullPath().c_str());
2174
f363e05c 2175 return false;
951cd180
VZ
2176}
2177
2178bool wxFileName::Touch()
2179{
2180#if defined(__UNIX_LIKE__)
2181 // under Unix touching file is simple: just pass NULL to utime()
401eb3de 2182 if ( utime(GetFullPath().fn_str(), NULL) == 0 )
951cd180 2183 {
f363e05c 2184 return true;
951cd180
VZ
2185 }
2186
2187 wxLogSysError(_("Failed to touch the file '%s'"), GetFullPath().c_str());
2188
f363e05c 2189 return false;
951cd180
VZ
2190#else // other platform
2191 wxDateTime dtNow = wxDateTime::Now();
2192
6dbb903b 2193 return SetTimes(&dtNow, &dtNow, NULL /* don't change create time */);
951cd180
VZ
2194#endif // platforms
2195}
2196
2197bool wxFileName::GetTimes(wxDateTime *dtAccess,
2198 wxDateTime *dtMod,
6dbb903b 2199 wxDateTime *dtCreate) const
951cd180 2200{
2b5f62a0
VZ
2201#if defined(__WIN32__)
2202 // we must use different methods for the files and directories under
2203 // Windows as CreateFile(GENERIC_READ) doesn't work for the directories and
2204 // CreateFile(FILE_FLAG_BACKUP_SEMANTICS) works -- but only under NT and
2205 // not 9x
2206 bool ok;
2207 FILETIME ftAccess, ftCreate, ftWrite;
2208 if ( IsDir() )
2209 {
2210 // implemented in msw/dir.cpp
2211 extern bool wxGetDirectoryTimes(const wxString& dirname,
2212 FILETIME *, FILETIME *, FILETIME *);
2213
2214 // we should pass the path without the trailing separator to
2215 // wxGetDirectoryTimes()
2216 ok = wxGetDirectoryTimes(GetPath(wxPATH_GET_VOLUME),
2217 &ftAccess, &ftCreate, &ftWrite);
2218 }
2219 else // file
2220 {
2221 wxFileHandle fh(GetFullPath(), wxFileHandle::Read);
2222 if ( fh.IsOk() )
2223 {
2224 ok = ::GetFileTime(fh,
2225 dtCreate ? &ftCreate : NULL,
2226 dtAccess ? &ftAccess : NULL,
2227 dtMod ? &ftWrite : NULL) != 0;
2228 }
2229 else
2230 {
f363e05c 2231 ok = false;
2b5f62a0
VZ
2232 }
2233 }
2234
2235 if ( ok )
2236 {
2237 if ( dtCreate )
2238 ConvertFileTimeToWx(dtCreate, ftCreate);
2239 if ( dtAccess )
2240 ConvertFileTimeToWx(dtAccess, ftAccess);
2241 if ( dtMod )
2242 ConvertFileTimeToWx(dtMod, ftWrite);
2243
f363e05c 2244 return true;
2b5f62a0 2245 }
bf58daba 2246#elif defined(__UNIX_LIKE__) || defined(__WXMAC__) || defined(__OS2__) || (defined(__DOS__) && defined(__WATCOMC__))
951cd180 2247 wxStructStat stBuf;
92980e90 2248 if ( wxStat( GetFullPath().c_str(), &stBuf) == 0 )
951cd180
VZ
2249 {
2250 if ( dtAccess )
2251 dtAccess->Set(stBuf.st_atime);
2252 if ( dtMod )
2253 dtMod->Set(stBuf.st_mtime);
6dbb903b
VZ
2254 if ( dtCreate )
2255 dtCreate->Set(stBuf.st_ctime);
951cd180 2256
f363e05c 2257 return true;
951cd180 2258 }
951cd180 2259#else // other platform
7a893a31
WS
2260 wxUnusedVar(dtAccess);
2261 wxUnusedVar(dtMod);
2262 wxUnusedVar(dtCreate);
951cd180
VZ
2263#endif // platforms
2264
2265 wxLogSysError(_("Failed to retrieve file times for '%s'"),
2266 GetFullPath().c_str());
2267
f363e05c 2268 return false;
951cd180
VZ
2269}
2270
e2b87f38
VZ
2271#endif // wxUSE_DATETIME
2272
23b8a262
JS
2273
2274// ----------------------------------------------------------------------------
2275// file size functions
2276// ----------------------------------------------------------------------------
2277
2278/* static */
2279wxULongLong wxFileName::GetSize(const wxString &filename)
2280{
2281 if (!wxFileExists(filename))
2282 return wxInvalidSize;
2283
cdbce971
WS
2284#if defined(__WXPALMOS__)
2285 // TODO
2286 return wxInvalidSize;
2287#elif defined(__WIN32__)
23b8a262
JS
2288 wxFileHandle f(filename, wxFileHandle::Read);
2289 if (!f.IsOk())
2290 return wxInvalidSize;
2291
2292 DWORD lpFileSizeHigh;
2293 DWORD ret = GetFileSize(f, &lpFileSizeHigh);
2294 if (ret == INVALID_FILE_SIZE)
2295 return wxInvalidSize;
2296
2297 // compose the low-order and high-order byte sizes
2298 return wxULongLong(ret | (lpFileSizeHigh << sizeof(WORD)*2));
2299
2300#else // ! __WIN32__
2301
2302 wxStructStat st;
2303#ifndef wxNEED_WX_UNISTD_H
2304 if (wxStat( filename.fn_str() , &st) != 0)
2305#else
2306 if (wxStat( filename, &st) != 0)
2307#endif
2308 return wxInvalidSize;
2309 return wxULongLong(st.st_size);
2310#endif
2311}
2312
2313/* static */
2314wxString wxFileName::GetHumanReadableSize(const wxULongLong &bs,
2315 const wxString &nullsize,
2316 int precision)
2317{
2318 static const double KILOBYTESIZE = 1024.0;
2319 static const double MEGABYTESIZE = 1024.0*KILOBYTESIZE;
2320 static const double GIGABYTESIZE = 1024.0*MEGABYTESIZE;
2321 static const double TERABYTESIZE = 1024.0*GIGABYTESIZE;
2322
2323 if (bs == 0 || bs == wxInvalidSize)
2324 return nullsize;
2325
2326 double bytesize = bs.ToDouble();
2327 if (bytesize < KILOBYTESIZE)
2328 return wxString::Format(_("%s B"), bs.ToString().c_str());
2329 if (bytesize < MEGABYTESIZE)
2330 return wxString::Format(_("%.*f kB"), precision, bytesize/KILOBYTESIZE);
2331 if (bytesize < GIGABYTESIZE)
2332 return wxString::Format(_("%.*f MB"), precision, bytesize/MEGABYTESIZE);
2333 if (bytesize < TERABYTESIZE)
2334 return wxString::Format(_("%.*f GB"), precision, bytesize/GIGABYTESIZE);
2335
2336 return wxString::Format(_("%.*f TB"), precision, bytesize/TERABYTESIZE);
2337}
2338
2339wxULongLong wxFileName::GetSize() const
2340{
2341 return GetSize(GetFullPath());
2342}
2343
2344wxString wxFileName::GetHumanReadableSize(const wxString &failmsg, int precision) const
2345{
2346 return GetHumanReadableSize(GetSize(), failmsg, precision);
2347}
2348
2349
2350// ----------------------------------------------------------------------------
2351// Mac-specific functions
2352// ----------------------------------------------------------------------------
2353
4dfbcdd5
SC
2354#ifdef __WXMAC__
2355
2356const short kMacExtensionMaxLength = 16 ;
0ca4ae93 2357class MacDefaultExtensionRecord
4dfbcdd5 2358{
0ca4ae93
SC
2359public :
2360 MacDefaultExtensionRecord()
2361 {
2362 m_ext[0] = 0 ;
1a183bb1 2363 m_type = m_creator = 0 ;
0ca4ae93
SC
2364 }
2365 MacDefaultExtensionRecord( const MacDefaultExtensionRecord& from )
2366 {
44c44c82 2367 wxStrcpy( m_ext , from.m_ext ) ;
0ca4ae93
SC
2368 m_type = from.m_type ;
2369 m_creator = from.m_creator ;
2370 }
44c44c82 2371 MacDefaultExtensionRecord( const wxChar * extension , OSType type , OSType creator )
0ca4ae93 2372 {
44c44c82 2373 wxStrncpy( m_ext , extension , kMacExtensionMaxLength ) ;
0ca4ae93
SC
2374 m_ext[kMacExtensionMaxLength] = 0 ;
2375 m_type = type ;
2376 m_creator = creator ;
2377 }
44c44c82 2378 wxChar m_ext[kMacExtensionMaxLength] ;
4dfbcdd5
SC
2379 OSType m_type ;
2380 OSType m_creator ;
0ca4ae93 2381} ;
4dfbcdd5 2382
4dfbcdd5 2383WX_DECLARE_OBJARRAY(MacDefaultExtensionRecord, MacDefaultExtensionArray) ;
0ca4ae93
SC
2384
2385bool gMacDefaultExtensionsInited = false ;
2386
4dfbcdd5 2387#include "wx/arrimpl.cpp"
0ca4ae93
SC
2388
2389WX_DEFINE_EXPORTED_OBJARRAY(MacDefaultExtensionArray) ;
4dfbcdd5
SC
2390
2391MacDefaultExtensionArray gMacDefaultExtensions ;
4dfbcdd5 2392
5974c3cf
SC
2393// load the default extensions
2394MacDefaultExtensionRecord gDefaults[] =
4dfbcdd5 2395{
5974c3cf
SC
2396 MacDefaultExtensionRecord( wxT("txt") , 'TEXT' , 'ttxt' ) ,
2397 MacDefaultExtensionRecord( wxT("tif") , 'TIFF' , '****' ) ,
2398 MacDefaultExtensionRecord( wxT("jpg") , 'JPEG' , '****' ) ,
2399} ;
0ea621cc 2400
5974c3cf
SC
2401static void MacEnsureDefaultExtensionsLoaded()
2402{
2403 if ( !gMacDefaultExtensionsInited )
4dfbcdd5 2404 {
5974c3cf
SC
2405 // we could load the pc exchange prefs here too
2406 for ( size_t i = 0 ; i < WXSIZEOF( gDefaults ) ; ++i )
2407 {
2408 gMacDefaultExtensions.Add( gDefaults[i] ) ;
2409 }
2410 gMacDefaultExtensionsInited = true ;
0ea621cc 2411 }
4dfbcdd5 2412}
a2b77260 2413
0ea621cc 2414bool wxFileName::MacSetTypeAndCreator( wxUint32 type , wxUint32 creator )
4dfbcdd5 2415{
a2b77260
SC
2416 FSRef fsRef ;
2417 FSCatalogInfo catInfo;
2418 FileInfo *finfo ;
4dfbcdd5 2419
a2b77260
SC
2420 if ( wxMacPathToFSRef( GetFullPath() , &fsRef ) == noErr )
2421 {
a62848fd
WS
2422 if ( FSGetCatalogInfo (&fsRef, kFSCatInfoFinderInfo, &catInfo, NULL, NULL, NULL) == noErr )
2423 {
2424 finfo = (FileInfo*)&catInfo.finderInfo;
2425 finfo->fileType = type ;
2426 finfo->fileCreator = creator ;
2427 FSSetCatalogInfo( &fsRef, kFSCatInfoFinderInfo, &catInfo ) ;
a2b77260 2428 return true ;
a62848fd 2429 }
a2b77260
SC
2430 }
2431 return false ;
4dfbcdd5
SC
2432}
2433
0ea621cc 2434bool wxFileName::MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator )
4dfbcdd5 2435{
a2b77260
SC
2436 FSRef fsRef ;
2437 FSCatalogInfo catInfo;
2438 FileInfo *finfo ;
4dfbcdd5 2439
a2b77260
SC
2440 if ( wxMacPathToFSRef( GetFullPath() , &fsRef ) == noErr )
2441 {
a62848fd
WS
2442 if ( FSGetCatalogInfo (&fsRef, kFSCatInfoFinderInfo, &catInfo, NULL, NULL, NULL) == noErr )
2443 {
2444 finfo = (FileInfo*)&catInfo.finderInfo;
2445 *type = finfo->fileType ;
2446 *creator = finfo->fileCreator ;
a2b77260 2447 return true ;
a62848fd 2448 }
a2b77260
SC
2449 }
2450 return false ;
4dfbcdd5
SC
2451}
2452
2453bool wxFileName::MacSetDefaultTypeAndCreator()
2454{
2455 wxUint32 type , creator ;
2456 if ( wxFileName::MacFindDefaultTypeAndCreator(GetExt() , &type ,
2457 &creator ) )
2458 {
f63fb56d
GD
2459 return MacSetTypeAndCreator( type , creator ) ;
2460 }
2461 return false;
4dfbcdd5
SC
2462}
2463
0ea621cc 2464bool wxFileName::MacFindDefaultTypeAndCreator( const wxString& ext , wxUint32 *type , wxUint32 *creator )
4dfbcdd5
SC
2465{
2466 MacEnsureDefaultExtensionsLoaded() ;
2467 wxString extl = ext.Lower() ;
2468 for( int i = gMacDefaultExtensions.Count() - 1 ; i >= 0 ; --i )
2469 {
2470 if ( gMacDefaultExtensions.Item(i).m_ext == extl )
2471 {
2472 *type = gMacDefaultExtensions.Item(i).m_type ;
2473 *creator = gMacDefaultExtensions.Item(i).m_creator ;
2474 return true ;
2475 }
2476 }
2477 return false ;
2478}
2479
2480void wxFileName::MacRegisterDefaultTypeAndCreator( const wxString& ext , wxUint32 type , wxUint32 creator )
2481{
2482 MacEnsureDefaultExtensionsLoaded() ;
2483 MacDefaultExtensionRecord rec ;
2484 rec.m_type = type ;
2485 rec.m_creator = creator ;
44c44c82 2486 wxStrncpy( rec.m_ext , ext.Lower().c_str() , kMacExtensionMaxLength ) ;
4dfbcdd5
SC
2487 gMacDefaultExtensions.Add( rec ) ;
2488}
2489#endif