X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c67d6888d421207045dc6ce9c9762727118c92e2..0d91b2342a1f83b3b9db145c7210efd5d9547cc8:/src/common/filename.cpp diff --git a/src/common/filename.cpp b/src/common/filename.cpp index 46f2d0c03d..f55a693ae8 100644 --- a/src/common/filename.cpp +++ b/src/common/filename.cpp @@ -6,9 +6,52 @@ // Created: 28.12.2000 // RCS-ID: $Id$ // Copyright: (c) 2000 Robert Roebling -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// +/* + Here are brief descriptions of the filename formats supported by this class: + + wxPATH_UNIX: standard Unix format, used under Darwin as well, absolute file + names have the form: + /dir1/dir2/.../dirN/filename, "." and ".." stand for the + current and parent directory respectively, "~" is parsed as the + user HOME and "~username" as the HOME of that user + + wxPATH_DOS: DOS/Windows format, absolute file names have the form: + drive:\dir1\dir2\...\dirN\filename.ext where drive is a single + letter. "." and ".." as for Unix but no "~". + + There are also UNC names of the form \\share\fullpath + + wxPATH_MAC: Mac OS 8/9 and Mac OS X under CodeWarrior 7 format, absolute file + names have the form + volume:dir1:...:dirN:filename + and the relative file names are either + :dir1:...:dirN:filename + or just + filename + (although :filename works as well). + Since the volume is just part of the file path, it is not + treated like a separate entity as it is done under DOS and + VMS, it is just treated as another dir. + + wxPATH_VMS: VMS native format, absolute file names have the form + :[dir1.dir2.dir3]file.txt + or + :[000000.dir1.dir2.dir3]file.txt + + the is the physical device (i.e. disk). 000000 is the + root directory on the device which can be omitted. + + Note that VMS uses different separators unlike Unix: + : always after the device. If the path does not contain : than + the default (the device of the current directory) is assumed. + [ start of directory specification + . separator between directory and subdirectory + ] between directory and file + */ + // ============================================================================ // declarations // ============================================================================ @@ -17,52 +60,89 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "filename.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ - #pragma hdrstop +#pragma hdrstop #endif #ifndef WX_PRECOMP + #include "wx/dynarray.h" #include "wx/intl.h" #include "wx/log.h" + #include "wx/file.h" + #include "wx/utils.h" #endif #include "wx/filename.h" #include "wx/tokenzr.h" #include "wx/config.h" // for wxExpandEnvVars -#include "wx/utils.h" - -#if wxUSE_DYNLIB_CLASS - #include "wx/dynlib.h" -#endif +#include "wx/file.h" +#include "wx/dynlib.h" // For GetShort/LongPathName #ifdef __WIN32__ - #include +#include "wx/msw/wrapwin.h" +#if defined(__MINGW32__) +#include "wx/msw/gccpriv.h" +#endif +#endif + +#ifdef __WXWINCE__ +#include "wx/msw/private.h" +#endif - #include "wx/msw/winundef.h" +#if defined(__WXMAC__) + #include "wx/mac/private.h" // includes mac headers #endif // utime() is POSIX so should normally be available on all Unices #ifdef __UNIX_LIKE__ - #include - #include - #include - #include +#include +#include +#include +#include +#endif + +#ifdef __DJGPP__ +#include #endif #ifdef __MWERKS__ - #include - #include - #include +#ifdef __MACH__ +#include +#include +#include +#include +#else +#include +#include +#include +#endif +#endif + +#ifdef __WATCOMC__ +#include +#include +#include +#endif + +#ifdef __VISAGECPP__ +#ifndef MAX_PATH +#define MAX_PATH 256 +#endif +#endif + +#ifdef __EMX__ +#include +#define MAX_PATH _MAX_PATH #endif + +wxULongLong wxInvalidSize = (unsigned)-1; + + // ---------------------------------------------------------------------------- // private classes // ---------------------------------------------------------------------------- @@ -74,23 +154,32 @@ class wxFileHandle { public: - wxFileHandle(const wxString& filename) + enum OpenMode + { + Read, + Write + }; + + wxFileHandle(const wxString& filename, OpenMode mode) { m_hFile = ::CreateFile ( - filename, // name - GENERIC_READ, // access mask - 0, // no sharing - NULL, // no secutity attr - OPEN_EXISTING, // creation disposition - 0, // no flags - NULL // no template file + filename, // name + mode == Read ? GENERIC_READ // access mask + : GENERIC_WRITE, + FILE_SHARE_READ | // sharing mode + FILE_SHARE_WRITE, // (allow everything) + NULL, // no secutity attr + OPEN_EXISTING, // creation disposition + 0, // no flags + NULL // no template file ); if ( m_hFile == INVALID_HANDLE_VALUE ) { - wxLogSysError(_("Failed to open '%s' for reading"), - filename.c_str()); + wxLogSysError(_("Failed to open '%s' for %s"), + filename.c_str(), + mode == Read ? _("reading") : _("writing")); } } @@ -105,7 +194,7 @@ public: } } - // return TRUE only if the file could be opened successfully + // return true only if the file could be opened successfully bool IsOk() const { return m_hFile != INVALID_HANDLE_VALUE; } // get the handle @@ -121,40 +210,81 @@ private: // private functions // ---------------------------------------------------------------------------- -#if defined(__WIN32__) && !defined(__WXMICROWIN__) +#if wxUSE_DATETIME && defined(__WIN32__) && !defined(__WXMICROWIN__) // convert between wxDateTime and FILETIME which is a 64-bit value representing // the number of 100-nanosecond intervals since January 1, 1601. -// the number of milliseconds between the Unix Epoch (January 1, 1970) and the -// FILETIME reference point (January 1, 1601) -static const wxLongLong FILETIME_EPOCH_OFFSET = wxLongLong(0xa97, 0x30b66800); - static void ConvertFileTimeToWx(wxDateTime *dt, const FILETIME &ft) { - wxLongLong ll(ft.dwHighDateTime, ft.dwLowDateTime); - - // convert 100ns to ms - ll /= 10000; + FILETIME ftcopy = ft; + FILETIME ftLocal; + if ( !::FileTimeToLocalFileTime(&ftcopy, &ftLocal) ) + { + wxLogLastError(_T("FileTimeToLocalFileTime")); + } - // move it to our Epoch - ll -= FILETIME_EPOCH_OFFSET; + SYSTEMTIME st; + if ( !::FileTimeToSystemTime(&ftLocal, &st) ) + { + wxLogLastError(_T("FileTimeToSystemTime")); + } - *dt = wxDateTime(ll); + dt->Set(st.wDay, wxDateTime::Month(st.wMonth - 1), st.wYear, + st.wHour, st.wMinute, st.wSecond, st.wMilliseconds); } static void ConvertWxToFileTime(FILETIME *ft, const wxDateTime& dt) { - // do the reverse of ConvertFileTimeToWx() - wxLongLong ll = dt.GetValue(); - ll *= 10000; - ll += FILETIME_EPOCH_OFFSET; + SYSTEMTIME st; + st.wDay = dt.GetDay(); + st.wMonth = (WORD)(dt.GetMonth() + 1); + st.wYear = (WORD)dt.GetYear(); + st.wHour = dt.GetHour(); + st.wMinute = dt.GetMinute(); + st.wSecond = dt.GetSecond(); + st.wMilliseconds = dt.GetMillisecond(); + + FILETIME ftLocal; + if ( !::SystemTimeToFileTime(&st, &ftLocal) ) + { + wxLogLastError(_T("SystemTimeToFileTime")); + } - ft->dwHighDateTime = ll.GetHi(); - ft->dwLowDateTime = ll.GetLo(); + if ( !::LocalFileTimeToFileTime(&ftLocal, ft) ) + { + wxLogLastError(_T("LocalFileTimeToFileTime")); + } } -#endif // __WIN32__ +#endif // wxUSE_DATETIME && __WIN32__ + +// return a string with the volume par +static wxString wxGetVolumeString(const wxString& volume, wxPathFormat format) +{ + wxString path; + + if ( !volume.empty() ) + { + format = wxFileName::GetFormat(format); + + // Special Windows UNC paths hack, part 2: undo what we did in + // SplitPath() and make an UNC path if we have a drive which is not a + // single letter (hopefully the network shares can't be one letter only + // although I didn't find any authoritative docs on this) + if ( format == wxPATH_DOS && volume.length() > 1 ) + { + path << wxFILE_SEP_PATH_DOS << wxFILE_SEP_PATH_DOS << volume; + } + else if ( format == wxPATH_DOS || format == wxPATH_VMS ) + { + path << volume << wxFileName::GetVolumeSeparator(format); + } + // else ignore + } + + return path; +} // ============================================================================ // implementation @@ -166,73 +296,214 @@ static void ConvertWxToFileTime(FILETIME *ft, const wxDateTime& dt) void wxFileName::Assign( const wxFileName &filepath ) { - m_ext = filepath.GetExt(); - m_name = filepath.GetName(); + m_volume = filepath.GetVolume(); m_dirs = filepath.GetDirs(); + m_name = filepath.GetName(); + m_ext = filepath.GetExt(); + m_relative = filepath.m_relative; + m_hasExt = filepath.m_hasExt; +} + +void wxFileName::Assign(const wxString& volume, + const wxString& path, + const wxString& name, + const wxString& ext, + bool hasExt, + wxPathFormat format ) +{ + SetPath( path, format ); + + m_volume = volume; + m_ext = ext; + m_name = name; + + m_hasExt = hasExt; } -void wxFileName::Assign( const wxString& path, - const wxString& name, - const wxString& ext, - wxPathFormat format ) +void wxFileName::SetPath( const wxString& pathOrig, wxPathFormat format ) { - wxStringTokenizer tn(path, GetPathSeparators(format), - wxTOKEN_RET_EMPTY_ALL); - int i = 0; m_dirs.Clear(); - while ( tn.HasMoreTokens() ) + + if ( pathOrig.empty() ) { - wxString token = tn.GetNextToken(); + // no path at all + m_relative = true; - // If the path starts with a slash (or two for a network path), - // we need the first dir entry to be an empty for later reassembly. - if ((i < 2) || !token.IsEmpty()) - m_dirs.Add( token ); + return; + } - i ++; + format = GetFormat( format ); + + // 0) deal with possible volume part first + wxString volume, + path; + SplitVolume(pathOrig, &volume, &path, format); + if ( !volume.empty() ) + { + m_relative = false; + + SetVolume(volume); } - m_ext = ext; - m_name = name; + // 1) Determine if the path is relative or absolute. + wxChar leadingChar = path[0u]; + + switch (format) + { + case wxPATH_MAC: + m_relative = leadingChar == wxT(':'); + + // We then remove a leading ":". The reason is in our + // storage form for relative paths: + // ":dir:file.txt" actually means "./dir/file.txt" in + // DOS notation and should get stored as + // (relative) (dir) (file.txt) + // "::dir:file.txt" actually means "../dir/file.txt" + // stored as (relative) (..) (dir) (file.txt) + // This is important only for the Mac as an empty dir + // actually means , whereas under DOS, double + // slashes can be ignored: "\\\\" is the same as "\\". + if (m_relative) + path.erase( 0, 1 ); + break; + + case wxPATH_VMS: + // TODO: what is the relative path format here? + m_relative = false; + break; + + default: + wxFAIL_MSG( _T("Unknown path format") ); + // !! Fall through !! + + case wxPATH_UNIX: + // the paths of the form "~" or "~username" are absolute + m_relative = leadingChar != wxT('/') && leadingChar != _T('~'); + break; + + case wxPATH_DOS: + m_relative = !IsPathSeparator(leadingChar, format); + break; + + } + + // 2) Break up the path into its members. If the original path + // was just "/" or "\\", m_dirs will be empty. We know from + // the m_relative field, if this means "nothing" or "root dir". + + wxStringTokenizer tn( path, GetPathSeparators(format) ); + + while ( tn.HasMoreTokens() ) + { + wxString token = tn.GetNextToken(); + + // Remove empty token under DOS and Unix, interpret them + // as .. under Mac. + if (token.empty()) + { + if (format == wxPATH_MAC) + m_dirs.Add( wxT("..") ); + // else ignore + } + else + { + m_dirs.Add( token ); + } + } } void wxFileName::Assign(const wxString& fullpath, wxPathFormat format) { - wxString path, name, ext; - SplitPath(fullpath, &path, &name, &ext, format); + wxString volume, path, name, ext; + bool hasExt; + SplitPath(fullpath, &volume, &path, &name, &ext, &hasExt, format); - Assign(path, name, ext, format); + Assign(volume, path, name, ext, hasExt, format); } -void wxFileName::Assign(const wxString& path, +void wxFileName::Assign(const wxString& fullpathOrig, const wxString& fullname, wxPathFormat format) { - wxString name, ext; - SplitPath(fullname, NULL /* no path */, &name, &ext, format); + // always recognize fullpath as directory, even if it doesn't end with a + // slash + wxString fullpath = fullpathOrig; + if ( !wxEndsWithPathSeparator(fullpath) ) + { + fullpath += GetPathSeparator(format); + } + + wxString volume, path, name, ext; + bool hasExt; + + // do some consistency checks in debug mode: the name should be really just + // the filename and the path should be really just a path +#ifdef __WXDEBUG__ + wxString volDummy, pathDummy, nameDummy, extDummy; + + SplitPath(fullname, &volDummy, &pathDummy, &name, &ext, &hasExt, format); + + wxASSERT_MSG( volDummy.empty() && pathDummy.empty(), + _T("the file name shouldn't contain the path") ); + + SplitPath(fullpath, &volume, &path, &nameDummy, &extDummy, format); + + wxASSERT_MSG( nameDummy.empty() && extDummy.empty(), + _T("the path shouldn't contain file name nor extension") ); + +#else // !__WXDEBUG__ + SplitPath(fullname, NULL /* no volume */, NULL /* no path */, + &name, &ext, &hasExt, format); + SplitPath(fullpath, &volume, &path, NULL, NULL, format); +#endif // __WXDEBUG__/!__WXDEBUG__ + + Assign(volume, path, name, ext, hasExt, format); +} + +void wxFileName::Assign(const wxString& pathOrig, + const wxString& name, + const wxString& ext, + wxPathFormat format) +{ + wxString volume, + path; + SplitVolume(pathOrig, &volume, &path, format); - Assign(path, name, ext, format); + Assign(volume, path, name, ext, format); +} + +void wxFileName::AssignDir(const wxString& dir, wxPathFormat format) +{ + Assign(dir, wxEmptyString, format); } void wxFileName::Clear() { m_dirs.Clear(); + + m_volume = m_name = m_ext = wxEmptyString; + + // we don't have any absolute path for now + m_relative = true; + + // nor any extension + m_hasExt = false; } /* static */ -wxFileName wxFileName::FileName(const wxString& file) +wxFileName wxFileName::FileName(const wxString& file, wxPathFormat format) { - return wxFileName(file); + return wxFileName(file, format); } /* static */ -wxFileName wxFileName::DirName(const wxString& dir) +wxFileName wxFileName::DirName(const wxString& dir, wxPathFormat format) { wxFileName fn; - fn.AssignDir(dir); + fn.AssignDir(dir, format); return fn; } @@ -240,7 +511,7 @@ wxFileName wxFileName::DirName(const wxString& dir) // existence tests // ---------------------------------------------------------------------------- -bool wxFileName::FileExists() +bool wxFileName::FileExists() const { return wxFileName::FileExists( GetFullPath() ); } @@ -250,9 +521,9 @@ bool wxFileName::FileExists( const wxString &file ) return ::wxFileExists( file ); } -bool wxFileName::DirExists() +bool wxFileName::DirExists() const { - return wxFileName::DirExists( GetFullPath() ); + return wxFileName::DirExists( GetPath() ); } bool wxFileName::DirExists( const wxString &dir ) @@ -264,20 +535,38 @@ bool wxFileName::DirExists( const wxString &dir ) // CWD and HOME stuff // ---------------------------------------------------------------------------- -void wxFileName::AssignCwd() +void wxFileName::AssignCwd(const wxString& volume) { - AssignDir(wxFileName::GetCwd()); + AssignDir(wxFileName::GetCwd(volume)); } /* static */ -wxString wxFileName::GetCwd() +wxString wxFileName::GetCwd(const wxString& volume) { - return ::wxGetCwd(); + // if we have the volume, we must get the current directory on this drive + // and to do this we have to chdir to this volume - at least under Windows, + // I don't know how to get the current drive on another volume elsewhere + // (TODO) + wxString cwdOld; + if ( !volume.empty() ) + { + cwdOld = wxGetCwd(); + SetCwd(volume + GetVolumeSeparator()); + } + + wxString cwd = ::wxGetCwd(); + + if ( !volume.empty() ) + { + SetCwd(cwdOld); + } + + return cwd; } bool wxFileName::SetCwd() { - return wxFileName::SetCwd( GetFullPath() ); + return wxFileName::SetCwd( GetPath() ); } bool wxFileName::SetCwd( const wxString &cwd ) @@ -295,69 +584,277 @@ wxString wxFileName::GetHomeDir() return ::wxGetHomeDir(); } -void wxFileName::AssignTempFileName( const wxString &prefix ) +#if wxUSE_FILE + +void wxFileName::AssignTempFileName(const wxString& prefix, wxFile *fileTemp) { - wxString fullname; - if ( wxGetTempFileName(prefix, fullname) ) + wxString tempname = CreateTempFileName(prefix, fileTemp); + if ( tempname.empty() ) { - Assign(fullname); + // error, failed to get temp file name + Clear(); } - else // error + else // ok { - Clear(); + Assign(tempname); + } +} + +/* static */ +wxString +wxFileName::CreateTempFileName(const wxString& prefix, wxFile *fileTemp) +{ + wxString path, dir, name; + + // use the directory specified by the prefix + SplitPath(prefix, &dir, &name, NULL /* extension */); + + if (dir.empty()) + { + dir = wxGetenv(_T("TMPDIR")); + if (dir.empty()) + { + dir = wxGetenv(_T("TMP")); + if (dir.empty()) + { + dir = wxGetenv(_T("TEMP")); + } + } + } + +#if defined(__WXWINCE__) + if (dir.empty()) + { + // FIXME. Create \temp dir? + if (DirExists(wxT("\\temp"))) + dir = wxT("\\temp"); + } + path = dir + wxT("\\") + name; + int i = 1; + while (FileExists(path)) + { + path = dir + wxT("\\") + name ; + path << i; + i ++; + } + +#elif defined(__WINDOWS__) && !defined(__WXMICROWIN__) + + if ( dir.empty() ) + { + if ( !::GetTempPath(MAX_PATH, wxStringBuffer(dir, MAX_PATH + 1)) ) + { + wxLogLastError(_T("GetTempPath")); + } + + if ( dir.empty() ) + { + // GetTempFileName() fails if we pass it an empty string + dir = _T('.'); + } + } + else // we have a dir to create the file in + { + // ensure we use only the back slashes as GetTempFileName(), unlike all + // the other APIs, is picky and doesn't accept the forward ones + dir.Replace(_T("/"), _T("\\")); + } + + if ( !::GetTempFileName(dir, name, 0, wxStringBuffer(path, MAX_PATH + 1)) ) + { + wxLogLastError(_T("GetTempFileName")); + + path.clear(); + } + +#else // !Windows + if ( dir.empty() ) + { + // default +#if defined(__DOS__) || defined(__OS2__) + dir = _T("."); +#elif defined(__WXMAC__) + dir = wxMacFindFolder(short(kOnSystemDisk), kTemporaryFolderType, kCreateFolder); +#else + dir = _T("/tmp"); +#endif + } + + path = dir; + + if ( !wxEndsWithPathSeparator(dir) && + (name.empty() || !wxIsPathSeparator(name[0u])) ) + { + path += wxFILE_SEP_PATH; + } + + path += name; + +#if defined(HAVE_MKSTEMP) + // scratch space for mkstemp() + path += _T("XXXXXX"); + + // we need to copy the path to the buffer in which mkstemp() can modify it + wxCharBuffer buf( wxConvFile.cWX2MB( path ) ); + + // cast is safe because the string length doesn't change + int fdTemp = mkstemp( (char*)(const char*) buf ); + if ( fdTemp == -1 ) + { + // this might be not necessary as mkstemp() on most systems should have + // already done it but it doesn't hurt neither... + path.clear(); + } + else // mkstemp() succeeded + { + path = wxConvFile.cMB2WX( (const char*) buf ); + + // avoid leaking the fd + if ( fileTemp ) + { + fileTemp->Attach(fdTemp); + } + else + { + close(fdTemp); + } + } +#else // !HAVE_MKSTEMP + +#ifdef HAVE_MKTEMP + // same as above + path += _T("XXXXXX"); + + wxCharBuffer buf = wxConvFile.cWX2MB( path ); + if ( !mktemp( (const char*) buf ) ) + { + path.clear(); + } + else + { + path = wxConvFile.cMB2WX( (const char*) buf ); + } +#else // !HAVE_MKTEMP (includes __DOS__) + // generate the unique file name ourselves + #if !defined(__DOS__) && !defined(__PALMOS__) && (!defined(__MWERKS__) || defined(__DARWIN__) ) + path << (unsigned int)getpid(); + #endif + + wxString pathTry; + + static const size_t numTries = 1000; + for ( size_t n = 0; n < numTries; n++ ) + { + // 3 hex digits is enough for numTries == 1000 < 4096 + pathTry = path + wxString::Format(_T("%.03x"), (unsigned int) n); + if ( !FileExists(pathTry) ) + { + break; + } + + pathTry.clear(); + } + + path = pathTry; +#endif // HAVE_MKTEMP/!HAVE_MKTEMP + +#endif // HAVE_MKSTEMP/!HAVE_MKSTEMP + +#endif // Windows/!Windows + + if ( path.empty() ) + { + wxLogSysError(_("Failed to create a temporary file name")); + } + else if ( fileTemp && !fileTemp->IsOpened() ) + { + // open the file - of course, there is a race condition here, this is + // why we always prefer using mkstemp()... + // + // NB: GetTempFileName() under Windows creates the file, so using + // write_excl there would fail + if ( !fileTemp->Open(path, +#if defined(__WINDOWS__) && !defined(__WXMICROWIN__) + wxFile::write, +#else + wxFile::write_excl, +#endif + wxS_IRUSR | wxS_IWUSR) ) + { + // FIXME: If !ok here should we loop and try again with another + // file name? That is the standard recourse if open(O_EXCL) + // fails, though of course it should be protected against + // possible infinite looping too. + + wxLogError(_("Failed to open temporary file.")); + + path.clear(); + } } + + return path; } +#endif // wxUSE_FILE + // ---------------------------------------------------------------------------- // directory operations // ---------------------------------------------------------------------------- -bool wxFileName::Mkdir( int perm, bool full ) +bool wxFileName::Mkdir( int perm, int flags ) { - return wxFileName::Mkdir( GetFullPath(), perm, full ); + return wxFileName::Mkdir(GetPath(), perm, flags); } -bool wxFileName::Mkdir( const wxString &dir, int perm, bool full ) +bool wxFileName::Mkdir( const wxString& dir, int perm, int flags ) { - if (full) + if ( flags & wxPATH_MKDIR_FULL ) { - wxFileName filename(dir); - wxArrayString dirs = filename.GetDirs(); - dirs.Add(filename.GetName()); + // split the path in components + wxFileName filename; + filename.AssignDir(dir); - size_t count = dirs.GetCount(); - size_t i; wxString currPath; - int noErrors = 0; - for ( i = 0; i < count; i++ ) + if ( filename.HasVolume()) { - currPath += dirs[i]; + currPath << wxGetVolumeString(filename.GetVolume(), wxPATH_NATIVE); + } - if (currPath.Last() == wxT(':')) - { - // Can't create a root directory so continue to next dir + wxArrayString dirs = filename.GetDirs(); + size_t count = dirs.GetCount(); + for ( size_t i = 0; i < count; i++ ) + { + if ( i > 0 || +#if defined(__WXMAC__) && !defined(__DARWIN__) + // relative pathnames are exactely the other way round under mac... + !filename.IsAbsolute() +#else + filename.IsAbsolute() +#endif + ) currPath += wxFILE_SEP_PATH; - continue; - } + currPath += dirs[i]; if (!DirExists(currPath)) + { if (!wxMkdir(currPath, perm)) - noErrors ++; - - if ( (i < (count-1)) ) - currPath += wxFILE_SEP_PATH; + { + // no need to try creating further directories + return false; + } + } } - return (noErrors == 0); + return true; } - else - return ::wxMkdir( dir, perm ); + + return ::wxMkdir( dir, perm ); } bool wxFileName::Rmdir() { - return wxFileName::Rmdir( GetFullPath() ); + return wxFileName::Rmdir( GetPath() ); } bool wxFileName::Rmdir( const wxString &dir ) @@ -369,10 +866,22 @@ bool wxFileName::Rmdir( const wxString &dir ) // path normalization // ---------------------------------------------------------------------------- -bool wxFileName::Normalize(wxPathNormalize flags, +bool wxFileName::Normalize(int flags, const wxString& cwd, wxPathFormat format) { + // deal with env vars renaming first as this may seriously change the path + if ( flags & wxPATH_NORM_ENV_VARS ) + { + wxString pathOrig = GetFullPath(format); + wxString path = wxExpandEnvVars(pathOrig); + if ( path != pathOrig ) + { + Assign(path); + } + } + + // the existing path components wxArrayString dirs = GetDirs(); @@ -382,16 +891,34 @@ bool wxFileName::Normalize(wxPathNormalize flags, format = GetFormat(format); // make the path absolute - if ( (flags & wxPATH_NORM_ABSOLUTE) && !IsAbsolute() ) + if ( (flags & wxPATH_NORM_ABSOLUTE) && !IsAbsolute(format) ) { if ( cwd.empty() ) - curDir.AssignCwd(); - else + { + curDir.AssignCwd(GetVolume()); + } + else // cwd provided + { curDir.AssignDir(cwd); - } + } - // handle ~ stuff under Unix only - if ( (format == wxPATH_UNIX) && (flags & wxPATH_NORM_TILDE) ) + // the path may be not absolute because it doesn't have the volume name + // but in this case we shouldn't modify the directory components of it + // but just set the current volume + if ( !HasVolume() && curDir.HasVolume() ) + { + SetVolume(curDir.GetVolume()); + + if ( !m_relative ) + { + // yes, it was the case - we don't need curDir then + curDir.Clear(); + } + } + } + + // handle ~ stuff under Unix only + if ( (format == wxPATH_UNIX) && (flags & wxPATH_NORM_TILDE) ) { if ( !dirs.IsEmpty() ) { @@ -405,6 +932,7 @@ bool wxFileName::Normalize(wxPathNormalize flags, } } + // transform relative path into abs one if ( curDir.IsOk() ) { wxArrayString dirsNew = curDir.GetDirs(); @@ -424,7 +952,7 @@ bool wxFileName::Normalize(wxPathNormalize flags, { wxString dir = dirs[n]; - if ( flags && wxPATH_NORM_DOTS ) + if ( flags & wxPATH_NORM_DOTS ) { if ( dir == wxT(".") ) { @@ -438,19 +966,14 @@ bool wxFileName::Normalize(wxPathNormalize flags, { wxLogError(_("The path '%s' contains too many \"..\"!"), GetFullPath().c_str()); - return FALSE; + return false; } - m_dirs.Remove(m_dirs.GetCount() - 1); + m_dirs.RemoveAt(m_dirs.GetCount() - 1); continue; } } - if ( flags & wxPATH_NORM_ENV_VARS ) - { - dir = wxExpandEnvVars(dir); - } - if ( (flags & wxPATH_NORM_CASE) && !IsCaseSensitive(format) ) { dir.MakeLower(); @@ -459,73 +982,290 @@ bool wxFileName::Normalize(wxPathNormalize flags, m_dirs.Add(dir); } +#if defined(__WIN32__) && !defined(__WXWINCE__) && wxUSE_OLE + if ( (flags & wxPATH_NORM_SHORTCUT) ) + { + wxString filename; + if (GetShortcutTarget(GetFullPath(format), filename)) + { + // Repeat this since we may now have a new path + if ( (flags & wxPATH_NORM_CASE) && !IsCaseSensitive(format) ) + { + filename.MakeLower(); + } + m_relative = false; + Assign(filename); + } + } +#endif + if ( (flags & wxPATH_NORM_CASE) && !IsCaseSensitive(format) ) { // VZ: expand env vars here too? + m_volume.MakeLower(); m_name.MakeLower(); m_ext.MakeLower(); } -#if defined(__WXMSW__) && defined(__WIN32__) - if (flags & wxPATH_NORM_LONG) + // we do have the path now + // + // NB: need to do this before (maybe) calling Assign() below + m_relative = false; + +#if defined(__WIN32__) + if ( (flags & wxPATH_NORM_LONG) && (format == wxPATH_DOS) ) { Assign(GetLongPath()); } +#endif // Win32 + + return true; +} + +// ---------------------------------------------------------------------------- +// get the shortcut target +// ---------------------------------------------------------------------------- + +// WinCE (3) doesn't have CLSID_ShellLink, IID_IShellLink definitions. +// The .lnk file is a plain text file so it should be easy to +// make it work. Hint from Google Groups: +// "If you open up a lnk file, you'll see a +// number, followed by a pound sign (#), followed by more text. The +// number is the number of characters that follows the pound sign. The +// characters after the pound sign are the command line (which _can_ +// include arguments) to be executed. Any path (e.g. \windows\program +// files\myapp.exe) that includes spaces needs to be enclosed in +// quotation marks." + +#if defined(__WIN32__) && !defined(__WXWINCE__) && wxUSE_OLE +// The following lines are necessary under WinCE +// #include "wx/msw/private.h" +// #include +#include +#if defined(__WXWINCE__) +#include #endif - return TRUE; +bool wxFileName::GetShortcutTarget(const wxString& shortcutPath, + wxString& targetFilename, + wxString* arguments) +{ + wxString path, file, ext; + wxSplitPath(shortcutPath, & path, & file, & ext); + + HRESULT hres; + IShellLink* psl; + bool success = false; + + // Assume it's not a shortcut if it doesn't end with lnk + if (ext.CmpNoCase(wxT("lnk"))!=0) + return false; + + // create a ShellLink object + hres = CoCreateInstance(CLSID_ShellLink, NULL, CLSCTX_INPROC_SERVER, + IID_IShellLink, (LPVOID*) &psl); + + if (SUCCEEDED(hres)) + { + IPersistFile* ppf; + hres = psl->QueryInterface( IID_IPersistFile, (LPVOID *) &ppf); + if (SUCCEEDED(hres)) + { + WCHAR wsz[MAX_PATH]; + + MultiByteToWideChar(CP_ACP, MB_PRECOMPOSED, shortcutPath.mb_str(), -1, wsz, + MAX_PATH); + + hres = ppf->Load(wsz, 0); + ppf->Release(); + + if (SUCCEEDED(hres)) + { + wxChar buf[2048]; + // Wrong prototype in early versions +#if defined(__MINGW32__) && !wxCHECK_W32API_VERSION(2, 2) + psl->GetPath((CHAR*) buf, 2048, NULL, SLGP_UNCPRIORITY); +#else + psl->GetPath(buf, 2048, NULL, SLGP_UNCPRIORITY); +#endif + targetFilename = wxString(buf); + success = (shortcutPath != targetFilename); + + psl->GetArguments(buf, 2048); + wxString args(buf); + if (!args.empty() && arguments) + { + *arguments = args; + } + } + } + + psl->Release(); + } + return success; +} + +#endif // __WIN32__ && !__WXWINCE__ + + +// ---------------------------------------------------------------------------- +// absolute/relative paths +// ---------------------------------------------------------------------------- + +bool wxFileName::IsAbsolute(wxPathFormat format) const +{ + // if our path doesn't start with a path separator, it's not an absolute + // path + if ( m_relative ) + return false; + + if ( !GetVolumeSeparator(format).empty() ) + { + // this format has volumes and an absolute path must have one, it's not + // enough to have the full path to bean absolute file under Windows + if ( GetVolume().empty() ) + return false; + } + + return true; +} + +bool wxFileName::MakeRelativeTo(const wxString& pathBase, wxPathFormat format) +{ + wxFileName fnBase = wxFileName::DirName(pathBase, format); + + // get cwd only once - small time saving + wxString cwd = wxGetCwd(); + Normalize(wxPATH_NORM_ALL & ~wxPATH_NORM_CASE, cwd, format); + fnBase.Normalize(wxPATH_NORM_ALL & ~wxPATH_NORM_CASE, cwd, format); + + bool withCase = IsCaseSensitive(format); + + // we can't do anything if the files live on different volumes + if ( !GetVolume().IsSameAs(fnBase.GetVolume(), withCase) ) + { + // nothing done + return false; + } + + // same drive, so we don't need our volume + m_volume.clear(); + + // remove common directories starting at the top + while ( !m_dirs.IsEmpty() && !fnBase.m_dirs.IsEmpty() && + m_dirs[0u].IsSameAs(fnBase.m_dirs[0u], withCase) ) + { + m_dirs.RemoveAt(0); + fnBase.m_dirs.RemoveAt(0); + } + + // add as many ".." as needed + size_t count = fnBase.m_dirs.GetCount(); + for ( size_t i = 0; i < count; i++ ) + { + m_dirs.Insert(wxT(".."), 0u); + } + + if ( format == wxPATH_UNIX || format == wxPATH_DOS ) + { + // a directory made relative with respect to itself is '.' under Unix + // and DOS, by definition (but we don't have to insert "./" for the + // files) + if ( m_dirs.IsEmpty() && IsDir() ) + { + m_dirs.Add(_T('.')); + } + } + + m_relative = true; + + // we were modified + return true; } // ---------------------------------------------------------------------------- // filename kind tests // ---------------------------------------------------------------------------- -bool wxFileName::SameAs( const wxFileName &filepath, wxPathFormat format) +bool wxFileName::SameAs(const wxFileName& filepath, wxPathFormat format) const { wxFileName fn1 = *this, fn2 = filepath; // get cwd only once - small time saving wxString cwd = wxGetCwd(); - fn1.Normalize(wxPATH_NORM_ALL, cwd, format); - fn2.Normalize(wxPATH_NORM_ALL, cwd, format); + fn1.Normalize(wxPATH_NORM_ALL | wxPATH_NORM_CASE, cwd, format); + fn2.Normalize(wxPATH_NORM_ALL | wxPATH_NORM_CASE, cwd, format); if ( fn1.GetFullPath() == fn2.GetFullPath() ) - return TRUE; + return true; // TODO: compare inodes for Unix, this works even when filenames are // different but files are the same (symlinks) (VZ) - return FALSE; + return false; } /* static */ bool wxFileName::IsCaseSensitive( wxPathFormat format ) { - // only DOS and OpenVMS filenames are case-sensitive - return GetFormat(format) != wxPATH_DOS && GetFormat(format) != wxPATH_VMS; + // only Unix filenames are truely case-sensitive + return GetFormat(format) == wxPATH_UNIX; } -bool wxFileName::IsRelative( wxPathFormat format ) +/* static */ +wxString wxFileName::GetForbiddenChars(wxPathFormat format) { - return !IsAbsolute(format); + // Inits to forbidden characters that are common to (almost) all platforms. + wxString strForbiddenChars = wxT("*?"); + + // If asserts, wxPathFormat has been changed. In case of a new path format + // addition, the following code might have to be updated. + wxCOMPILE_TIME_ASSERT(wxPATH_MAX == 5, wxPathFormatChanged); + switch ( GetFormat(format) ) + { + default : + wxFAIL_MSG( wxT("Unknown path format") ); + // !! Fall through !! + + case wxPATH_UNIX: + break; + + case wxPATH_MAC: + // On a Mac even names with * and ? are allowed (Tested with OS + // 9.2.1 and OS X 10.2.5) + strForbiddenChars = wxEmptyString; + break; + + case wxPATH_DOS: + strForbiddenChars += wxT("\\/:\"<>|"); + break; + + case wxPATH_VMS: + break; + } + + return strForbiddenChars; } -bool wxFileName::IsAbsolute( wxPathFormat format ) +/* static */ +wxString wxFileName::GetVolumeSeparator(wxPathFormat WXUNUSED_IN_WINCE(format)) { - wxChar ch = m_dirs.IsEmpty() ? _T('\0') : m_dirs[0u][0u]; +#ifdef __WXWINCE__ + return wxEmptyString; +#else + wxString sepVol; - // Hack to cope with e.g. c:\thing - need something better - wxChar driveSep = _T('\0'); - if (!m_dirs.IsEmpty() && m_dirs[0].Length() > 1) - driveSep = m_dirs[0u][1u]; + if ( (GetFormat(format) == wxPATH_DOS) || + (GetFormat(format) == wxPATH_VMS) ) + { + sepVol = wxFILE_SEP_DSK; + } + //else: leave empty - // the path is absolute if it starts with a path separator or, only for - // Unix filenames, with "~" or "~user" - return IsPathSeparator(ch, format) || - driveSep == _T(':') || - (GetFormat(format) == wxPATH_UNIX && ch == _T('~') ); + return sepVol; +#endif } /* static */ @@ -535,12 +1275,13 @@ wxString wxFileName::GetPathSeparators(wxPathFormat format) switch ( GetFormat(format) ) { case wxPATH_DOS: - // accept both as native APIs do - seps << wxFILE_SEP_PATH_UNIX << wxFILE_SEP_PATH_DOS; + // accept both as native APIs do but put the native one first as + // this is the one we use in GetFullPath() + seps << wxFILE_SEP_PATH_DOS << wxFILE_SEP_PATH_UNIX; break; default: - wxFAIL_MSG( _T("unknown wxPATH_XXX style") ); + wxFAIL_MSG( _T("Unknown wxPATH_XXX style") ); // fall through case wxPATH_UNIX: @@ -550,7 +1291,7 @@ wxString wxFileName::GetPathSeparators(wxPathFormat format) case wxPATH_MAC: seps = wxFILE_SEP_PATH_MAC; break; - + case wxPATH_VMS: seps = wxFILE_SEP_PATH_VMS; break; @@ -560,41 +1301,70 @@ wxString wxFileName::GetPathSeparators(wxPathFormat format) } /* static */ -bool wxFileName::IsPathSeparator(wxChar ch, wxPathFormat format) +wxString wxFileName::GetPathTerminators(wxPathFormat format) { - return GetPathSeparators(format).Find(ch) != wxNOT_FOUND; + format = GetFormat(format); + + // under VMS the end of the path is ']', not the path separator used to + // separate the components + return format == wxPATH_VMS ? wxString(_T(']')) : GetPathSeparators(format); } -bool wxFileName::IsWild( wxPathFormat format ) +/* static */ +bool wxFileName::IsPathSeparator(wxChar ch, wxPathFormat format) { - // FIXME: this is probably false for Mac and this is surely wrong for most - // of Unix shells (think about "[...]") - (void)format; - return m_name.find_first_of(_T("*?")) != wxString::npos; + // wxString::Find() doesn't work as expected with NUL - it will always find + // it, so test for it separately + return ch != _T('\0') && GetPathSeparators(format).Find(ch) != wxNOT_FOUND; } // ---------------------------------------------------------------------------- // path components manipulation // ---------------------------------------------------------------------------- -void wxFileName::AppendDir( const wxString &dir ) +/* static */ bool wxFileName::IsValidDirComponent(const wxString& dir) +{ + if ( dir.empty() ) + { + wxFAIL_MSG( _T("empty directory passed to wxFileName::InsertDir()") ); + + return false; + } + + const size_t len = dir.length(); + for ( size_t n = 0; n < len; n++ ) + { + if ( dir[n] == GetVolumeSeparator() || IsPathSeparator(dir[n]) ) + { + wxFAIL_MSG( _T("invalid directory component in wxFileName") ); + + return false; + } + } + + return true; +} + +void wxFileName::AppendDir( const wxString& dir ) { - m_dirs.Add( dir ); + if ( IsValidDirComponent(dir) ) + m_dirs.Add( dir ); } -void wxFileName::PrependDir( const wxString &dir ) +void wxFileName::PrependDir( const wxString& dir ) { - m_dirs.Insert( dir, 0 ); + InsertDir(0, dir); } -void wxFileName::InsertDir( int before, const wxString &dir ) +void wxFileName::InsertDir(size_t before, const wxString& dir) { - m_dirs.Insert( dir, before ); + if ( IsValidDirComponent(dir) ) + m_dirs.Insert(dir, before); } -void wxFileName::RemoveDir( int pos ) +void wxFileName::RemoveDir(size_t pos) { - m_dirs.Remove( (size_t)pos ); + m_dirs.RemoveAt(pos); } // ---------------------------------------------------------------------------- @@ -603,13 +1373,14 @@ void wxFileName::RemoveDir( int pos ) void wxFileName::SetFullName(const wxString& fullname) { - SplitPath(fullname, NULL /* no path */, &m_name, &m_ext); + SplitPath(fullname, NULL /* no volume */, NULL /* no path */, + &m_name, &m_ext, &m_hasExt); } wxString wxFileName::GetFullName() const { wxString fullname = m_name; - if ( !m_ext.empty() ) + if ( m_hasExt ) { fullname << wxFILE_SEP_EXT << m_ext; } @@ -617,225 +1388,287 @@ wxString wxFileName::GetFullName() const return fullname; } -wxString wxFileName::GetPath( bool add_separator, wxPathFormat format ) const +wxString wxFileName::GetPath( int flags, wxPathFormat format ) const { format = GetFormat( format ); - wxString ret; - size_t count = m_dirs.GetCount(); - for ( size_t i = 0; i < count; i++ ) + wxString fullpath; + + // return the volume with the path as well if requested + if ( flags & wxPATH_GET_VOLUME ) { - ret += m_dirs[i]; - if ( add_separator || (i < count) ) - ret += wxFILE_SEP_PATH; + fullpath += wxGetVolumeString(GetVolume(), format); } - return ret; -} - -wxString wxFileName::GetFullPath( wxPathFormat format ) const -{ - format = GetFormat( format ); - - wxString ret; - if (format == wxPATH_DOS) + // the leading character + switch ( format ) { - for (size_t i = 0; i < m_dirs.GetCount(); i++) - { - ret += m_dirs[i]; - ret += '\\'; - } + case wxPATH_MAC: + if ( m_relative ) + fullpath += wxFILE_SEP_PATH_MAC; + break; + + case wxPATH_DOS: + if ( !m_relative ) + fullpath += wxFILE_SEP_PATH_DOS; + break; + + default: + wxFAIL_MSG( wxT("Unknown path format") ); + // fall through + + case wxPATH_UNIX: + if ( !m_relative ) + { + // normally the absolute file names start with a slash + // with one exception: the ones like "~/foo.bar" don't + // have it + if ( m_dirs.IsEmpty() || m_dirs[0u] != _T('~') ) + { + fullpath += wxFILE_SEP_PATH_UNIX; + } + } + break; + + case wxPATH_VMS: + // no leading character here but use this place to unset + // wxPATH_GET_SEPARATOR flag: under VMS it doesn't make sense + // as, if I understand correctly, there should never be a dot + // before the closing bracket + flags &= ~wxPATH_GET_SEPARATOR; } - else - if (format == wxPATH_UNIX) + + if ( m_dirs.empty() ) { - for (size_t i = 0; i < m_dirs.GetCount(); i++) - { - ret += m_dirs[i]; - ret += '/'; - } + // there is nothing more + return fullpath; } - else - if (format == wxPATH_VMS) + + // then concatenate all the path components using the path separator + if ( format == wxPATH_VMS ) { - ret += '['; - for (size_t i = 0; i < m_dirs.GetCount(); i++) - { - ret += '.'; - ret += m_dirs[i]; - } - ret += ']'; + fullpath += wxT('['); } - else + + const size_t dirCount = m_dirs.GetCount(); + for ( size_t i = 0; i < dirCount; i++ ) { - for (size_t i = 0; i < m_dirs.GetCount(); i++) + switch (format) { - ret += m_dirs[i]; - ret += ':'; + case wxPATH_MAC: + if ( m_dirs[i] == wxT(".") ) + { + // skip appending ':', this shouldn't be done in this + // case as "::" is interpreted as ".." under Unix + continue; + } + + // convert back from ".." to nothing + if ( !m_dirs[i].IsSameAs(wxT("..")) ) + fullpath += m_dirs[i]; + break; + + default: + wxFAIL_MSG( wxT("Unexpected path format") ); + // still fall through + + case wxPATH_DOS: + case wxPATH_UNIX: + fullpath += m_dirs[i]; + break; + + case wxPATH_VMS: + // TODO: What to do with ".." under VMS + + // convert back from ".." to nothing + if ( !m_dirs[i].IsSameAs(wxT("..")) ) + fullpath += m_dirs[i]; + break; } + + if ( (flags & wxPATH_GET_SEPARATOR) || (i != dirCount - 1) ) + fullpath += GetPathSeparator(format); } - - ret += m_name; - - if (!m_ext.IsEmpty()) + + if ( format == wxPATH_VMS ) { - ret += '.'; - ret += m_ext; + fullpath += wxT(']'); } - - return ret; + + return fullpath; +} + +wxString wxFileName::GetFullPath( wxPathFormat format ) const +{ + // we already have a function to get the path + wxString fullpath = GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR, + format); + + // now just add the file name and extension to it + fullpath += GetFullName(); + + return fullpath; } // Return the short form of the path (returns identity on non-Windows platforms) wxString wxFileName::GetShortPath() const { -#if defined(__WXMSW__) && defined(__WIN32__) && !defined(__WXMICROWIN__) wxString path(GetFullPath()); - wxString pathOut; + +#if defined(__WXMSW__) && defined(__WIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__) DWORD sz = ::GetShortPathName(path, NULL, 0); - bool ok = sz != 0; - if ( ok ) + if ( sz != 0 ) { - ok = ::GetShortPathName + wxString pathOut; + if ( ::GetShortPathName ( path, - pathOut.GetWriteBuf(sz), + wxStringBuffer(pathOut, sz), sz - ) != 0; - pathOut.UngetWriteBuf(); + ) != 0 ) + { + return pathOut; + } } - if (ok) - return pathOut; +#endif // Windows return path; -#else - return GetFullPath(); -#endif } // Return the long form of the path (returns identity on non-Windows platforms) wxString wxFileName::GetLongPath() const { -#if defined(__WXMSW__) && defined(__WIN32__) && !defined(__WXMICROWIN__) - wxString path(GetFullPath()); - wxString pathOut; - bool success = FALSE; + wxString pathOut, + path = GetFullPath(); - // VZ: this code was disabled, why? -#if 0 // wxUSE_DYNLIB_CLASS - typedef DWORD (*GET_LONG_PATH_NAME)(const wxChar *, wxChar *, DWORD); +#if defined(__WIN32__) && !defined(__WXMICROWIN__) - static bool s_triedToLoad = FALSE; +#if wxUSE_DYNAMIC_LOADER + typedef DWORD (WINAPI *GET_LONG_PATH_NAME)(const wxChar *, wxChar *, DWORD); - if ( !s_triedToLoad ) + // this is MT-safe as in the worst case we're going to resolve the function + // twice -- but as the result is the same in both threads, it's ok + static GET_LONG_PATH_NAME s_pfnGetLongPathName = NULL; + if ( !s_pfnGetLongPathName ) { - s_triedToLoad = TRUE; - wxDllType dllKernel = wxDllLoader::LoadLibrary(_T("kernel32")); - if ( dllKernel ) + static bool s_triedToLoad = false; + + if ( !s_triedToLoad ) { - // may succeed or fail depending on the Windows version - static GET_LONG_PATH_NAME s_pfnGetLongPathName = NULL; -#ifdef _UNICODE - s_pfnGetLongPathName = (GET_LONG_PATH_NAME) wxDllLoader::GetSymbol(dllKernel, _T("GetLongPathNameW")); -#else - s_pfnGetLongPathName = (GET_LONG_PATH_NAME) wxDllLoader::GetSymbol(dllKernel, _T("GetLongPathNameA")); -#endif + s_triedToLoad = true; - wxDllLoader::UnloadLibrary(dllKernel); + wxDynamicLibrary dllKernel(_T("kernel32")); - if ( s_pfnGetLongPathName ) - { - DWORD dwSize = (*s_pfnGetLongPathName)(path, NULL, 0); - bool ok = dwSize > 0; + const wxChar* GetLongPathName = _T("GetLongPathName") +#if wxUSE_UNICODE + _T("W"); +#else // ANSI + _T("A"); +#endif // Unicode/ANSI - if ( ok ) - { - DWORD sz = (*s_pfnGetLongPathName)(path, NULL, 0); - ok = sz != 0; - if ( ok ) - { - ok = (*s_pfnGetLongPathName) - ( - path, - pathOut.GetWriteBuf(sz), - sz - ) != 0; - pathOut.UngetWriteBuf(); - - success = TRUE; - } - } + if ( dllKernel.HasSymbol(GetLongPathName) ) + { + s_pfnGetLongPathName = (GET_LONG_PATH_NAME) + dllKernel.GetSymbol(GetLongPathName); } + + // note that kernel32.dll can be unloaded, it stays in memory + // anyhow as all Win32 programs link to it and so it's safe to call + // GetLongPathName() even after unloading it } } - if (success) - return pathOut; -#endif // wxUSE_DYNLIB_CLASS - if (!success) + if ( s_pfnGetLongPathName ) { - // The OS didn't support GetLongPathName, or some other error. - // We need to call FindFirstFile on each component in turn. + DWORD dwSize = (*s_pfnGetLongPathName)(path, NULL, 0); + if ( dwSize > 0 ) + { + if ( (*s_pfnGetLongPathName) + ( + path, + wxStringBuffer(pathOut, dwSize), + dwSize + ) != 0 ) + { + return pathOut; + } + } + } +#endif // wxUSE_DYNAMIC_LOADER + + // The OS didn't support GetLongPathName, or some other error. + // We need to call FindFirstFile on each component in turn. + + WIN32_FIND_DATA findFileData; + HANDLE hFind; - WIN32_FIND_DATA findFileData; - HANDLE hFind; + if ( HasVolume() ) + pathOut = GetVolume() + + GetVolumeSeparator(wxPATH_DOS) + + GetPathSeparator(wxPATH_DOS); + else pathOut = wxEmptyString; - wxArrayString dirs = GetDirs(); - dirs.Add(GetFullName()); + wxArrayString dirs = GetDirs(); + dirs.Add(GetFullName()); - size_t count = dirs.GetCount(); - size_t i; - wxString tmpPath; + wxString tmpPath; - for ( i = 0; i < count; i++ ) - { - // We're using pathOut to collect the long-name path, - // but using a temporary for appending the last path component which may be short-name - tmpPath = pathOut + dirs[i]; + size_t count = dirs.GetCount(); + for ( size_t i = 0; i < count; i++ ) + { + // We're using pathOut to collect the long-name path, but using a + // temporary for appending the last path component which may be + // short-name + tmpPath = pathOut + dirs[i]; - if (tmpPath.Last() == wxT(':')) - { - // Can't pass a drive and root dir to FindFirstFile, - // so continue to next dir - tmpPath += wxFILE_SEP_PATH; - pathOut = tmpPath; - continue; - } + if ( tmpPath.empty() ) + continue; - hFind = ::FindFirstFile(tmpPath, &findFileData); - if (hFind == INVALID_HANDLE_VALUE) - { - // Error: return immediately with the original path - return path; - } - else - { - pathOut += findFileData.cFileName; - if ( (i < (count-1)) ) - pathOut += wxFILE_SEP_PATH; + // can't see this being necessary? MF + if ( tmpPath.Last() == GetVolumeSeparator(wxPATH_DOS) ) + { + // Can't pass a drive and root dir to FindFirstFile, + // so continue to next dir + tmpPath += wxFILE_SEP_PATH; + pathOut = tmpPath; + continue; + } - ::FindClose(hFind); - } + hFind = ::FindFirstFile(tmpPath, &findFileData); + if (hFind == INVALID_HANDLE_VALUE) + { + // Error: most likely reason is that path doesn't exist, so + // append any unprocessed parts and return + for ( i += 1; i < count; i++ ) + tmpPath += wxFILE_SEP_PATH + dirs[i]; + + return tmpPath; } + + pathOut += findFileData.cFileName; + if ( (i < (count-1)) ) + pathOut += wxFILE_SEP_PATH; + + ::FindClose(hFind); } +#else // !Win32 + pathOut = path; +#endif // Win32/!Win32 return pathOut; -#else - return GetFullPath(); -#endif } wxPathFormat wxFileName::GetFormat( wxPathFormat format ) { if (format == wxPATH_NATIVE) { -#if defined(__WXMSW__) || defined(__WXPM__) +#if defined(__WXMSW__) || defined(__OS2__) || defined(__DOS__) format = wxPATH_DOS; #elif defined(__WXMAC__) && !defined(__DARWIN__) - format = wxPATH_MAC; + format = wxPATH_MAC; #elif defined(__VMS) - format = wxPATH_VMS; + format = wxPATH_VMS; #else format = wxPATH_UNIX; #endif @@ -847,42 +1680,90 @@ wxPathFormat wxFileName::GetFormat( wxPathFormat format ) // path splitting function // ---------------------------------------------------------------------------- -void wxFileName::SplitPath(const wxString& fullpath, - wxString *pstrPath, - wxString *pstrName, - wxString *pstrExt, - wxPathFormat format) +/* static */ +void +wxFileName::SplitVolume(const wxString& fullpathWithVolume, + wxString *pstrVolume, + wxString *pstrPath, + wxPathFormat format) { format = GetFormat(format); - // find the positions of the last dot and last path separator in the path - size_t posLastDot = fullpath.find_last_of(wxFILE_SEP_EXT); - size_t posLastSlash = fullpath.find_last_of(GetPathSeparators(format)); + wxString fullpath = fullpathWithVolume; - if ( (posLastDot != wxString::npos) && (format == wxPATH_UNIX) ) + // special Windows UNC paths hack: transform \\share\path into share:path + if ( format == wxPATH_DOS ) { - if ( (posLastDot == 0) || - (fullpath[posLastDot - 1] == wxFILE_SEP_PATH_UNIX) ) + if ( fullpath.length() >= 4 && + fullpath[0u] == wxFILE_SEP_PATH_DOS && + fullpath[1u] == wxFILE_SEP_PATH_DOS ) { - // under Unix, dot may be (and commonly is) the first character of - // the filename, don't treat the entire filename as extension in - // this case - posLastDot = wxString::npos; + fullpath.erase(0, 2); + + size_t posFirstSlash = + fullpath.find_first_of(GetPathTerminators(format)); + if ( posFirstSlash != wxString::npos ) + { + fullpath[posFirstSlash] = wxFILE_SEP_DSK; + + // UNC paths are always absolute, right? (FIXME) + fullpath.insert(posFirstSlash + 1, 1, wxFILE_SEP_PATH_DOS); + } } } - else - if ( (posLastDot != wxString::npos) && (format == wxPATH_VMS) ) + + // We separate the volume here + if ( format == wxPATH_DOS || format == wxPATH_VMS ) { - if ( (posLastDot == 0) || - (fullpath[posLastDot - 1] == ']' ) ) + wxString sepVol = GetVolumeSeparator(format); + + size_t posFirstColon = fullpath.find_first_of(sepVol); + if ( posFirstColon != wxString::npos ) { - // under OpenVMS, dot may be (and commonly is) the first character of - // the filename, don't treat the entire filename as extension in - // this case - posLastDot = wxString::npos; + if ( pstrVolume ) + { + *pstrVolume = fullpath.Left(posFirstColon); + } + + // remove the volume name and the separator from the full path + fullpath.erase(0, posFirstColon + sepVol.length()); } } + if ( pstrPath ) + *pstrPath = fullpath; +} + +/* static */ +void wxFileName::SplitPath(const wxString& fullpathWithVolume, + wxString *pstrVolume, + wxString *pstrPath, + wxString *pstrName, + wxString *pstrExt, + bool *hasExt, + wxPathFormat format) +{ + format = GetFormat(format); + + wxString fullpath; + SplitVolume(fullpathWithVolume, pstrVolume, &fullpath, format); + + // find the positions of the last dot and last path separator in the path + size_t posLastDot = fullpath.find_last_of(wxFILE_SEP_EXT); + size_t posLastSlash = fullpath.find_last_of(GetPathTerminators(format)); + + // check whether this dot occurs at the very beginning of a path component + if ( (posLastDot != wxString::npos) && + (posLastDot == 0 || + IsPathSeparator(fullpath[posLastDot - 1]) || + (format == wxPATH_VMS && fullpath[posLastDot - 1] == _T(']'))) ) + { + // dot may be (and commonly -- at least under Unix -- is) the first + // character of the filename, don't treat the entire filename as + // extension in this case + posLastDot = wxString::npos; + } + // if we do have a dot and a slash, check that the dot is in the name part if ( (posLastDot != wxString::npos) && (posLastSlash != wxString::npos) && @@ -902,8 +1783,24 @@ void wxFileName::SplitPath(const wxString& fullpath, } else { - // take all until the separator - *pstrPath = fullpath.Left(posLastSlash); + // take everything up to the path separator but take care to make + // the path equal to something like '/', not empty, for the files + // immediately under root directory + size_t len = posLastSlash; + + // this rule does not apply to mac since we do not start with colons (sep) + // except for relative paths + if ( !len && format != wxPATH_MAC) + len++; + + *pstrPath = fullpath.Left(len); + + // special VMS hack: remove the initial bracket + if ( format == wxPATH_VMS ) + { + if ( (*pstrPath)[0u] == _T('[') ) + pstrPath->erase(0, 1); + } } } @@ -930,18 +1827,41 @@ void wxFileName::SplitPath(const wxString& fullpath, *pstrName = fullpath.Mid(nStart, count); } - if ( pstrExt ) + // finally deal with the extension here: we have an added complication that + // extension may be empty (but present) as in "foo." where trailing dot + // indicates the empty extension at the end -- and hence we must remember + // that we have it independently of pstrExt + if ( posLastDot == wxString::npos ) { - if ( posLastDot == wxString::npos ) - { - // no extension - pstrExt->Empty(); - } - else - { - // take everything after the dot + // no extension + if ( pstrExt ) + pstrExt->clear(); + if ( hasExt ) + *hasExt = false; + } + else + { + // take everything after the dot + if ( pstrExt ) *pstrExt = fullpath.Mid(posLastDot + 1); - } + if ( hasExt ) + *hasExt = true; + } +} + +/* static */ +void wxFileName::SplitPath(const wxString& fullpath, + wxString *path, + wxString *name, + wxString *ext, + wxPathFormat format) +{ + wxString volume; + SplitPath(fullpath, &volume, path, name, ext, format); + + if ( path ) + { + path->Prepend(wxGetVolumeString(volume, format)); } } @@ -949,15 +1869,48 @@ void wxFileName::SplitPath(const wxString& fullpath, // time functions // ---------------------------------------------------------------------------- -bool wxFileName::SetTimes(const wxDateTime *dtCreate, - const wxDateTime *dtAccess, - const wxDateTime *dtMod) +#if wxUSE_DATETIME + +bool wxFileName::SetTimes(const wxDateTime *dtAccess, + const wxDateTime *dtMod, + const wxDateTime *dtCreate) { -#if defined(__UNIX_LIKE__) +#if defined(__WIN32__) + if ( IsDir() ) + { + // VZ: please let me know how to do this if you can + wxFAIL_MSG( _T("SetTimes() not implemented for the directories") ); + } + else // file + { + wxFileHandle fh(GetFullPath(), wxFileHandle::Write); + if ( fh.IsOk() ) + { + FILETIME ftAccess, ftCreate, ftWrite; + + if ( dtCreate ) + ConvertWxToFileTime(&ftCreate, *dtCreate); + if ( dtAccess ) + ConvertWxToFileTime(&ftAccess, *dtAccess); + if ( dtMod ) + ConvertWxToFileTime(&ftWrite, *dtMod); + + if ( ::SetFileTime(fh, + dtCreate ? &ftCreate : NULL, + dtAccess ? &ftAccess : NULL, + dtMod ? &ftWrite : NULL) ) + { + return true; + } + } + } +#elif defined(__UNIX_LIKE__) || (defined(__DOS__) && defined(__WATCOMC__)) + wxUnusedVar(dtCreate); + if ( !dtAccess && !dtMod ) { // can't modify the creation time anyhow, don't try - return TRUE; + return true; } // if dtAccess or dtMod is not specified, use the other one (which must be @@ -965,116 +1918,328 @@ bool wxFileName::SetTimes(const wxDateTime *dtCreate, utimbuf utm; utm.actime = dtAccess ? dtAccess->GetTicks() : dtMod->GetTicks(); utm.modtime = dtMod ? dtMod->GetTicks() : dtAccess->GetTicks(); - if ( utime(GetFullPath(), &utm) == 0 ) + if ( utime(GetFullPath().fn_str(), &utm) == 0 ) { - return TRUE; - } -#elif defined(__WIN32__) - wxFileHandle fh(GetFullPath()); - if ( fh.IsOk() ) - { - FILETIME ftAccess, ftCreate, ftWrite; - - if ( dtCreate ) - ConvertWxToFileTime(&ftCreate, *dtCreate); - if ( dtAccess ) - ConvertWxToFileTime(&ftAccess, *dtAccess); - if ( dtMod ) - ConvertWxToFileTime(&ftWrite, *dtMod); - - if ( ::SetFileTime(fh, - dtCreate ? &ftCreate : NULL, - dtAccess ? &ftAccess : NULL, - dtMod ? &ftWrite : NULL) ) - { - return TRUE; - } + return true; } #else // other platform + wxUnusedVar(dtAccess); + wxUnusedVar(dtMod); + wxUnusedVar(dtCreate); #endif // platforms wxLogSysError(_("Failed to modify file times for '%s'"), GetFullPath().c_str()); - return FALSE; + return false; } bool wxFileName::Touch() { #if defined(__UNIX_LIKE__) // under Unix touching file is simple: just pass NULL to utime() - if ( utime(GetFullPath(), NULL) == 0 ) + if ( utime(GetFullPath().fn_str(), NULL) == 0 ) { - return TRUE; + return true; } wxLogSysError(_("Failed to touch the file '%s'"), GetFullPath().c_str()); - return FALSE; + return false; #else // other platform wxDateTime dtNow = wxDateTime::Now(); - return SetTimes(NULL /* don't change create time */, &dtNow, &dtNow); + return SetTimes(&dtNow, &dtNow, NULL /* don't change create time */); #endif // platforms } bool wxFileName::GetTimes(wxDateTime *dtAccess, wxDateTime *dtMod, - wxDateTime *dtChange) const + wxDateTime *dtCreate) const { -#if defined(__UNIX_LIKE__) - wxStructStat stBuf; - if ( wxStat(GetFullPath(), &stBuf) == 0 ) +#if defined(__WIN32__) + // we must use different methods for the files and directories under + // Windows as CreateFile(GENERIC_READ) doesn't work for the directories and + // CreateFile(FILE_FLAG_BACKUP_SEMANTICS) works -- but only under NT and + // not 9x + bool ok; + FILETIME ftAccess, ftCreate, ftWrite; + if ( IsDir() ) + { + // implemented in msw/dir.cpp + extern bool wxGetDirectoryTimes(const wxString& dirname, + FILETIME *, FILETIME *, FILETIME *); + + // we should pass the path without the trailing separator to + // wxGetDirectoryTimes() + ok = wxGetDirectoryTimes(GetPath(wxPATH_GET_VOLUME), + &ftAccess, &ftCreate, &ftWrite); + } + else // file { + wxFileHandle fh(GetFullPath(), wxFileHandle::Read); + if ( fh.IsOk() ) + { + ok = ::GetFileTime(fh, + dtCreate ? &ftCreate : NULL, + dtAccess ? &ftAccess : NULL, + dtMod ? &ftWrite : NULL) != 0; + } + else + { + ok = false; + } + } + + if ( ok ) + { + if ( dtCreate ) + ConvertFileTimeToWx(dtCreate, ftCreate); if ( dtAccess ) - dtAccess->Set(stBuf.st_atime); + ConvertFileTimeToWx(dtAccess, ftAccess); if ( dtMod ) - dtMod->Set(stBuf.st_mtime); - if ( dtChange ) - dtChange->Set(stBuf.st_ctime); + ConvertFileTimeToWx(dtMod, ftWrite); - return TRUE; + return true; } -#elif defined(__WXMAC__) +#elif defined(__UNIX_LIKE__) || defined(__WXMAC__) || defined(__OS2__) || (defined(__DOS__) && defined(__WATCOMC__)) wxStructStat stBuf; - if ( wxStat(GetFullPath(), &stBuf) == 0 ) + if ( wxStat( GetFullPath().c_str(), &stBuf) == 0 ) { if ( dtAccess ) dtAccess->Set(stBuf.st_atime); if ( dtMod ) dtMod->Set(stBuf.st_mtime); - if ( dtChange ) - dtChange->Set(stBuf.st_ctime); + if ( dtCreate ) + dtCreate->Set(stBuf.st_ctime); - return TRUE; + return true; } -#elif defined(__WIN32__) - wxFileHandle fh(GetFullPath()); - if ( fh.IsOk() ) +#else // other platform + wxUnusedVar(dtAccess); + wxUnusedVar(dtMod); + wxUnusedVar(dtCreate); +#endif // platforms + + wxLogSysError(_("Failed to retrieve file times for '%s'"), + GetFullPath().c_str()); + + return false; +} + +#endif // wxUSE_DATETIME + + +// ---------------------------------------------------------------------------- +// file size functions +// ---------------------------------------------------------------------------- + +/* static */ +wxULongLong wxFileName::GetSize(const wxString &filename) +{ + if (!wxFileExists(filename)) + return wxInvalidSize; + +#ifdef __WIN32__ + wxFileHandle f(filename, wxFileHandle::Read); + if (!f.IsOk()) + return wxInvalidSize; + + DWORD lpFileSizeHigh; + DWORD ret = GetFileSize(f, &lpFileSizeHigh); + if (ret == INVALID_FILE_SIZE) + return wxInvalidSize; + + // compose the low-order and high-order byte sizes + return wxULongLong(ret | (lpFileSizeHigh << sizeof(WORD)*2)); + +#else // ! __WIN32__ + + wxStructStat st; +#ifndef wxNEED_WX_UNISTD_H + if (wxStat( filename.fn_str() , &st) != 0) +#else + if (wxStat( filename, &st) != 0) +#endif + return wxInvalidSize; + return wxULongLong(st.st_size); +#endif +} + +/* static */ +wxString wxFileName::GetHumanReadableSize(const wxULongLong &bs, + const wxString &nullsize, + int precision) +{ + static const double KILOBYTESIZE = 1024.0; + static const double MEGABYTESIZE = 1024.0*KILOBYTESIZE; + static const double GIGABYTESIZE = 1024.0*MEGABYTESIZE; + static const double TERABYTESIZE = 1024.0*GIGABYTESIZE; + + if (bs == 0 || bs == wxInvalidSize) + return nullsize; + + double bytesize = bs.ToDouble(); + if (bytesize < KILOBYTESIZE) + return wxString::Format(_("%s B"), bs.ToString().c_str()); + if (bytesize < MEGABYTESIZE) + return wxString::Format(_("%.*f kB"), precision, bytesize/KILOBYTESIZE); + if (bytesize < GIGABYTESIZE) + return wxString::Format(_("%.*f MB"), precision, bytesize/MEGABYTESIZE); + if (bytesize < TERABYTESIZE) + return wxString::Format(_("%.*f GB"), precision, bytesize/GIGABYTESIZE); + + return wxString::Format(_("%.*f TB"), precision, bytesize/TERABYTESIZE); +} + +wxULongLong wxFileName::GetSize() const +{ + return GetSize(GetFullPath()); +} + +wxString wxFileName::GetHumanReadableSize(const wxString &failmsg, int precision) const +{ + return GetHumanReadableSize(GetSize(), failmsg, precision); +} + + +// ---------------------------------------------------------------------------- +// Mac-specific functions +// ---------------------------------------------------------------------------- + +#ifdef __WXMAC__ + +const short kMacExtensionMaxLength = 16 ; +class MacDefaultExtensionRecord +{ +public : + MacDefaultExtensionRecord() + { + m_ext[0] = 0 ; + m_type = m_creator = 0 ; + } + MacDefaultExtensionRecord( const MacDefaultExtensionRecord& from ) + { + wxStrcpy( m_ext , from.m_ext ) ; + m_type = from.m_type ; + m_creator = from.m_creator ; + } + MacDefaultExtensionRecord( const wxChar * extension , OSType type , OSType creator ) + { + wxStrncpy( m_ext , extension , kMacExtensionMaxLength ) ; + m_ext[kMacExtensionMaxLength] = 0 ; + m_type = type ; + m_creator = creator ; + } + wxChar m_ext[kMacExtensionMaxLength] ; + OSType m_type ; + OSType m_creator ; +} ; + +WX_DECLARE_OBJARRAY(MacDefaultExtensionRecord, MacDefaultExtensionArray) ; + +bool gMacDefaultExtensionsInited = false ; + +#include "wx/arrimpl.cpp" + +WX_DEFINE_EXPORTED_OBJARRAY(MacDefaultExtensionArray) ; + +MacDefaultExtensionArray gMacDefaultExtensions ; + +// load the default extensions +MacDefaultExtensionRecord gDefaults[] = +{ + MacDefaultExtensionRecord( wxT("txt") , 'TEXT' , 'ttxt' ) , + MacDefaultExtensionRecord( wxT("tif") , 'TIFF' , '****' ) , + MacDefaultExtensionRecord( wxT("jpg") , 'JPEG' , '****' ) , +} ; + +static void MacEnsureDefaultExtensionsLoaded() +{ + if ( !gMacDefaultExtensionsInited ) { - FILETIME ftAccess, ftCreate, ftWrite; + // we could load the pc exchange prefs here too + for ( size_t i = 0 ; i < WXSIZEOF( gDefaults ) ; ++i ) + { + gMacDefaultExtensions.Add( gDefaults[i] ) ; + } + gMacDefaultExtensionsInited = true ; + } +} + +bool wxFileName::MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) +{ + FSRef fsRef ; + FSCatalogInfo catInfo; + FileInfo *finfo ; - if ( ::GetFileTime(fh, - dtMod ? &ftCreate : NULL, - dtAccess ? &ftAccess : NULL, - dtChange ? &ftWrite : NULL) ) + if ( wxMacPathToFSRef( GetFullPath() , &fsRef ) == noErr ) + { + if ( FSGetCatalogInfo (&fsRef, kFSCatInfoFinderInfo, &catInfo, NULL, NULL, NULL) == noErr ) { - if ( dtMod ) - ConvertFileTimeToWx(dtMod, ftCreate); - if ( dtAccess ) - ConvertFileTimeToWx(dtAccess, ftAccess); - if ( dtChange ) - ConvertFileTimeToWx(dtChange, ftWrite); + finfo = (FileInfo*)&catInfo.finderInfo; + finfo->fileType = type ; + finfo->fileCreator = creator ; + FSSetCatalogInfo( &fsRef, kFSCatInfoFinderInfo, &catInfo ) ; + return true ; + } + } + return false ; +} - return TRUE; +bool wxFileName::MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) +{ + FSRef fsRef ; + FSCatalogInfo catInfo; + FileInfo *finfo ; + + if ( wxMacPathToFSRef( GetFullPath() , &fsRef ) == noErr ) + { + if ( FSGetCatalogInfo (&fsRef, kFSCatInfoFinderInfo, &catInfo, NULL, NULL, NULL) == noErr ) + { + finfo = (FileInfo*)&catInfo.finderInfo; + *type = finfo->fileType ; + *creator = finfo->fileCreator ; + return true ; } } -#else // other platform -#endif // platforms + return false ; +} - wxLogSysError(_("Failed to retrieve file times for '%s'"), - GetFullPath().c_str()); +bool wxFileName::MacSetDefaultTypeAndCreator() +{ + wxUint32 type , creator ; + if ( wxFileName::MacFindDefaultTypeAndCreator(GetExt() , &type , + &creator ) ) + { + return MacSetTypeAndCreator( type , creator ) ; + } + return false; +} - return FALSE; +bool wxFileName::MacFindDefaultTypeAndCreator( const wxString& ext , wxUint32 *type , wxUint32 *creator ) +{ + MacEnsureDefaultExtensionsLoaded() ; + wxString extl = ext.Lower() ; + for( int i = gMacDefaultExtensions.Count() - 1 ; i >= 0 ; --i ) + { + if ( gMacDefaultExtensions.Item(i).m_ext == extl ) + { + *type = gMacDefaultExtensions.Item(i).m_type ; + *creator = gMacDefaultExtensions.Item(i).m_creator ; + return true ; + } + } + return false ; } +void wxFileName::MacRegisterDefaultTypeAndCreator( const wxString& ext , wxUint32 type , wxUint32 creator ) +{ + MacEnsureDefaultExtensionsLoaded() ; + MacDefaultExtensionRecord rec ; + rec.m_type = type ; + rec.m_creator = creator ; + wxStrncpy( rec.m_ext , ext.Lower().c_str() , kMacExtensionMaxLength ) ; + gMacDefaultExtensions.Add( rec ) ; +} +#endif