Add the possibility to disable invisible wxDataViewCtrl items.

[wxWidgets.git] / src / common / filename.cpp

diff --git a/src/common/filename.cpp b/src/common/filename.cpp
index 49c5ed0f573c2d26042a1b6d484bcaf017bbf9fb..dd770afb715de38d38e30017931361dc2f7fe6ba 100644 (file)
--- a/src/common/filename.cpp
+++ b/src/common/filename.cpp
@@ -22,7 +22,16 @@
                 drive:\dir1\dir2\...\dirN\filename.ext where drive is a single
                 letter. "." and ".." as for Unix but no "~".
 
                 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
+                There are also UNC names of the form \\share\fullpath and
+                MSW unique volume names of the form \\?\Volume{GUID}\fullpath.
+
+                The latter provide a uniform way to access a volume regardless of
+                its current mount point, i.e. you can change a volume's mount
+                point from D: to E:, or even remove it, and still be able to
+                access it through its unique volume name. More on the subject can
+                be found in MSDN's article "Naming a Volume" that is currently at
+                http://msdn.microsoft.com/en-us/library/aa365248(VS.85).aspx.
+

 
    wxPATH_MAC:  Mac OS 8/9 and Mac OS X under CodeWarrior 7 format, absolute file
                 names have the form
 
    wxPATH_MAC:  Mac OS 8/9 and Mac OS X under CodeWarrior 7 format, absolute file
                 names have the form


@@ -89,7 +98,7 @@
     #include "wx/msw/gccpriv.h"
 #endif
 
     #include "wx/msw/gccpriv.h"
 #endif
 

-#ifdef __WXWINCE__
+#ifdef __WXMSW__

 #include "wx/msw/private.h"
 #endif
 
 #include "wx/msw/private.h"
 #endif
 


@@ -179,7 +188,7 @@ public:
         // access time (see #10567)
         m_hFile = ::CreateFile
                     (
         // access time (see #10567)
         m_hFile = ::CreateFile
                     (

-                     filename.fn_str(),             // name
+                     filename.t_str(),             // name

                      mode == ReadAttr ? FILE_READ_ATTRIBUTES    // access mask
                                       : FILE_WRITE_ATTRIBUTES,
                      FILE_SHARE_READ |              // sharing mode
                      mode == ReadAttr ? FILE_READ_ATTRIBUTES    // access mask
                                       : FILE_WRITE_ATTRIBUTES,
                      FILE_SHARE_READ |              // sharing mode


@@ -296,7 +305,18 @@ static wxString wxGetVolumeString(const wxString& volume, wxPathFormat format)
         // although I didn't find any authoritative docs on this)
         if ( format == wxPATH_DOS && volume.length() > 1 )
         {
         // 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;
+            // We also have to check for Windows unique volume names here and
+            // return it with '\\?\' prepended to it
+            if ( wxFileName::IsMSWUniqueVolumeNamePath("\\\\?\\" + volume + "\\",
+                                                       format) )
+            {
+                path << "\\\\?\\" << volume;
+            }
+            else
+            {
+                // it must be a UNC path
+                path << wxFILE_SEP_PATH_DOS << wxFILE_SEP_PATH_DOS << volume;
+            }

         }
         else if  ( format == wxPATH_DOS || format == wxPATH_VMS )
         {
         }
         else if  ( format == wxPATH_DOS || format == wxPATH_VMS )
         {


@@ -326,6 +346,13 @@ static bool IsUNCPath(const wxString& path, wxPathFormat format)
                             !IsDOSPathSep(path[2u]);
 }
 
                             !IsDOSPathSep(path[2u]);
 }
 

+// ----------------------------------------------------------------------------
+// private constants
+// ----------------------------------------------------------------------------
+
+// length of \\?\Volume{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}\ string
+static const size_t wxMSWUniqueVolumePrefixLength = 49;
+

 } // anonymous namespace
 
 // ============================================================================
 } // anonymous namespace
 
 // ============================================================================


@@ -586,7 +613,7 @@ bool wxFileName::FileExists( const wxString &filePath )
 #elif defined(__WIN32__) && !defined(__WXMICROWIN__)
     // we must use GetFileAttributes() instead of the ANSI C functions because
     // it can cope with network (UNC) paths unlike them
 #elif defined(__WIN32__) && !defined(__WXMICROWIN__)
     // we must use GetFileAttributes() instead of the ANSI C functions because
     // it can cope with network (UNC) paths unlike them

-    DWORD ret = ::GetFileAttributes(filePath.fn_str());
+    DWORD ret = ::GetFileAttributes(filePath.t_str());

 
     return (ret != INVALID_FILE_ATTRIBUTES) && !(ret & FILE_ATTRIBUTE_DIRECTORY);
 #else // !__WIN32__
 
     return (ret != INVALID_FILE_ATTRIBUTES) && !(ret & FILE_ATTRIBUTE_DIRECTORY);
 #else // !__WIN32__


@@ -594,16 +621,13 @@ bool wxFileName::FileExists( const wxString &filePath )
         #define S_ISREG(mode) ((mode) & S_IFREG)
     #endif
     wxStructStat st;
         #define S_ISREG(mode) ((mode) & S_IFREG)
     #endif
     wxStructStat st;

-#ifndef wxNEED_WX_UNISTD_H
-    return (wxStat( filePath.fn_str() , &st) == 0 && S_ISREG(st.st_mode))
+
+    return (wxStat( filePath, &st) == 0 && S_ISREG(st.st_mode))

 #ifdef __OS2__
       || (errno == EACCES) // if access is denied something with that name
                             // exists and is opened in exclusive mode.
 #endif
       ;
 #ifdef __OS2__
       || (errno == EACCES) // if access is denied something with that name
                             // exists and is opened in exclusive mode.
 #endif
       ;

-#else
-    return wxStat( filePath , &st) == 0 && S_ISREG(st.st_mode);
-#endif

 #endif // __WIN32__/!__WIN32__
 }
 
 #endif // __WIN32__/!__WIN32__
 }
 


@@ -620,12 +644,17 @@ bool wxFileName::DirExists( const wxString &dirPath )
 #if defined(__WINDOWS__) || defined(__OS2__)
     // Windows fails to find directory named "c:\dir\" even if "c:\dir" exists,
     // so remove all trailing backslashes from the path - but don't do this for
 #if defined(__WINDOWS__) || defined(__OS2__)
     // Windows fails to find directory named "c:\dir\" even if "c:\dir" exists,
     // so remove all trailing backslashes from the path - but don't do this for

-    // the paths "d:\" (which are different from "d:") nor for just "\"
+    // the paths "d:\" (which are different from "d:"), for just "\" or for
+    // windows unique volume names ("\\?\Volume{GUID}\")

     while ( wxEndsWithPathSeparator(strPath) )
     {
         size_t len = strPath.length();
     while ( wxEndsWithPathSeparator(strPath) )
     {
         size_t len = strPath.length();

-        if ( len == 1 || (len == 3 && strPath[len - 2] == wxT(':')) )
+        if ( len == 1 || (len == 3 && strPath[len - 2] == wxT(':')) ||
+            (len == wxMSWUniqueVolumePrefixLength &&
+             wxFileName::IsMSWUniqueVolumeNamePath(strPath)))
+        {

             break;
             break;

+        }

 
         strPath.Truncate(len - 1);
     }
 
         strPath.Truncate(len - 1);
     }


@@ -641,7 +670,7 @@ bool wxFileName::DirExists( const wxString &dirPath )
     return false;
 #elif defined(__WIN32__) && !defined(__WXMICROWIN__)
     // stat() can't cope with network paths
     return false;
 #elif defined(__WIN32__) && !defined(__WXMICROWIN__)
     // stat() can't cope with network paths

-    DWORD ret = ::GetFileAttributes(strPath.fn_str());
+    DWORD ret = ::GetFileAttributes(strPath.t_str());

 
     return (ret != INVALID_FILE_ATTRIBUTES) && (ret & FILE_ATTRIBUTE_DIRECTORY);
 #elif defined(__OS2__)
 
     return (ret != INVALID_FILE_ATTRIBUTES) && (ret & FILE_ATTRIBUTE_DIRECTORY);
 #elif defined(__OS2__)


@@ -656,10 +685,10 @@ bool wxFileName::DirExists( const wxString &dirPath )
 
     wxStructStat st;
 #ifndef __VISAGECPP__
 
     wxStructStat st;
 #ifndef __VISAGECPP__

-    return wxStat(strPath.c_str(), &st) == 0 && ((st.st_mode & S_IFMT) == S_IFDIR);
+    return wxStat(strPath, &st) == 0 && ((st.st_mode & S_IFMT) == S_IFDIR);

 #else
     // S_IFMT not supported in VA compilers.. st_mode is a 2byte value only
 #else
     // S_IFMT not supported in VA compilers.. st_mode is a 2byte value only

-    return wxStat(strPath.c_str(), &st) == 0 && (st.st_mode == S_IFDIR);
+    return wxStat(strPath, &st) == 0 && (st.st_mode == S_IFDIR);

 #endif
 
 #endif // __WIN32__/!__WIN32__
 #endif
 
 #endif // __WIN32__/!__WIN32__


@@ -847,8 +876,8 @@ static wxString wxCreateTempImpl(
     }
 
 #elif defined(__WINDOWS__) && !defined(__WXMICROWIN__)
     }
 
 #elif defined(__WINDOWS__) && !defined(__WXMICROWIN__)

-    if ( !::GetTempFileName(dir.fn_str(), name.fn_str(), 0,
-                            wxStringBuffer(path, MAX_PATH + 1)) )
+    if (!::GetTempFileName(dir.t_str(), name.t_str(), 0,
+                           wxStringBuffer(path, MAX_PATH + 1)))

     {
         wxLogLastError(wxT("GetTempFileName"));
 
     {
         wxLogLastError(wxT("GetTempFileName"));
 


@@ -1162,9 +1191,24 @@ wxString wxFileName::GetTempDir()
             wxLogLastError(wxT("GetTempPath"));
         }
 #elif defined(__WXMAC__) && wxOSX_USE_CARBON
             wxLogLastError(wxT("GetTempPath"));
         }
 #elif defined(__WXMAC__) && wxOSX_USE_CARBON

-        dir = wxMacFindFolder(short(kOnSystemDisk), kTemporaryFolderType, kCreateFolder);
+        dir = wxMacFindFolderNoSeparator(short(kOnSystemDisk), kTemporaryFolderType, kCreateFolder);

 #endif // systems with native way
     }
 #endif // systems with native way
     }

+    else // we got directory from an environment variable
+    {
+        // remove any trailing path separators, we don't want to ever return
+        // them from this function for consistency
+        const size_t lastNonSep = dir.find_last_not_of(GetPathSeparators());
+        if ( lastNonSep == wxString::npos )
+        {
+            // the string consists entirely of separators, leave only one
+            dir = GetPathSeparator();
+        }
+        else
+        {
+            dir.erase(lastNonSep + 1);
+        }
+    }

 
     // fall back to hard coded value
     if ( dir.empty() )
 
     // fall back to hard coded value
     if ( dir.empty() )


@@ -1243,7 +1287,11 @@ bool wxFileName::Rmdir(const wxString& dir, int flags)
         SHFILEOPSTRUCT fileop;
         wxZeroMemory(fileop);
         fileop.wFunc = FO_DELETE;
         SHFILEOPSTRUCT fileop;
         wxZeroMemory(fileop);
         fileop.wFunc = FO_DELETE;

+    #if defined(__CYGWIN__) && defined(wxUSE_UNICODE)
+        fileop.pFrom = path.wc_str();
+    #else

         fileop.pFrom = path.fn_str();
         fileop.pFrom = path.fn_str();

+    #endif

         fileop.fFlags = FOF_SILENT | FOF_NOCONFIRMATION;
     #ifndef __WXWINCE__
         // FOF_NOERRORUI is not defined in WinCE
         fileop.fFlags = FOF_SILENT | FOF_NOCONFIRMATION;
     #ifndef __WXWINCE__
         // FOF_NOERRORUI is not defined in WinCE


@@ -1407,15 +1455,24 @@ bool wxFileName::Normalize(int flags,
 
             if ( dir == wxT("..") )
             {
 
             if ( dir == wxT("..") )
             {

-                if ( m_dirs.IsEmpty() )
+                if ( m_dirs.empty() )

                 {
                 {

-                    wxLogError(_("The path '%s' contains too many \"..\"!"),
-                               GetFullPath().c_str());
-                    return false;
-                }
+                    // We have more ".." than directory components so far.
+                    // Don't treat this as an error as the path could have been
+                    // entered by user so try to handle it reasonably: if the
+                    // path is absolute, just ignore the extra ".." because
+                    // "/.." is the same as "/". Otherwise, i.e. for relative
+                    // paths, keep ".." unchanged because removing it would
+                    // modify the file a relative path refers to.
+                    if ( !m_relative )
+                        continue;

 
 

-                m_dirs.RemoveAt(m_dirs.GetCount() - 1);
-                continue;
+                }
+                else // Normal case, go one step up.
+                {
+                    m_dirs.pop_back();
+                    continue;
+                }

             }
         }
 
             }
         }
 


@@ -1810,6 +1867,18 @@ bool wxFileName::IsPathSeparator(wxChar ch, wxPathFormat format)
     return ch != wxT('\0') && GetPathSeparators(format).Find(ch) != wxNOT_FOUND;
 }
 
     return ch != wxT('\0') && GetPathSeparators(format).Find(ch) != wxNOT_FOUND;
 }
 

+/* static */
+bool
+wxFileName::IsMSWUniqueVolumeNamePath(const wxString& path, wxPathFormat format)
+{
+    // return true if the format used is the DOS/Windows one and the string begins
+    // with a Windows unique volume name ("\\?\Volume{guid}\")
+    return format == wxPATH_DOS &&
+            path.length() >= wxMSWUniqueVolumePrefixLength &&
+             path.StartsWith(wxS("\\\\?\\Volume{")) &&
+              path[wxMSWUniqueVolumePrefixLength - 1] == wxFILE_SEP_PATH_DOS;
+}
+

 // ----------------------------------------------------------------------------
 // path components manipulation
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // path components manipulation
 // ----------------------------------------------------------------------------


@@ -2002,13 +2071,13 @@ wxString wxFileName::GetShortPath() const
     wxString path(GetFullPath());
 
 #if defined(__WXMSW__) && defined(__WIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
     wxString path(GetFullPath());
 
 #if defined(__WXMSW__) && defined(__WIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)

-    DWORD sz = ::GetShortPathName(path.fn_str(), NULL, 0);
+    DWORD sz = ::GetShortPathName(path.t_str(), NULL, 0);

     if ( sz != 0 )
     {
         wxString pathOut;
         if ( ::GetShortPathName
                (
     if ( sz != 0 )
     {
         wxString pathOut;
         if ( ::GetShortPathName
                (

-                path.fn_str(),
+                path.t_str(),

                 wxStringBuffer(pathOut, sz),
                 sz
                ) != 0 )
                 wxStringBuffer(pathOut, sz),
                 sz
                ) != 0 )


@@ -2066,12 +2135,12 @@ wxString wxFileName::GetLongPath() const
 
     if ( s_pfnGetLongPathName )
     {
 
     if ( s_pfnGetLongPathName )
     {

-        DWORD dwSize = (*s_pfnGetLongPathName)(path.fn_str(), NULL, 0);
+        DWORD dwSize = (*s_pfnGetLongPathName)(path.t_str(), NULL, 0);

         if ( dwSize > 0 )
         {
             if ( (*s_pfnGetLongPathName)
                  (
         if ( dwSize > 0 )
         {
             if ( (*s_pfnGetLongPathName)
                  (

-                  path.fn_str(),
+                  path.t_str(),

                   wxStringBuffer(pathOut, dwSize),
                   dwSize
                  ) != 0 )
                   wxStringBuffer(pathOut, dwSize),
                   dwSize
                  ) != 0 )


@@ -2123,7 +2192,7 @@ wxString wxFileName::GetLongPath() const
             continue;
         }
 
             continue;
         }
 

-        hFind = ::FindFirstFile(tmpPath.fn_str(), &findFileData);
+        hFind = ::FindFirstFile(tmpPath.t_str(), &findFileData);

         if (hFind == INVALID_HANDLE_VALUE)
         {
             // Error: most likely reason is that path doesn't exist, so
         if (hFind == INVALID_HANDLE_VALUE)
         {
             // Error: most likely reason is that path doesn't exist, so


@@ -2194,9 +2263,26 @@ wxFileName::SplitVolume(const wxString& fullpathWithVolume,
 
     wxString fullpath = fullpathWithVolume;
 
 
     wxString fullpath = fullpathWithVolume;
 

-    // special Windows UNC paths hack: transform \\share\path into share:path
-    if ( IsUNCPath(fullpath, format) )
+    if ( IsMSWUniqueVolumeNamePath(fullpath, format) )

     {
     {

+        // special Windows unique volume names hack: transform
+        // \\?\Volume{guid}\path into Volume{guid}:path
+        // note: this check must be done before the check for UNC path
+
+        // we know the last backslash from the unique volume name is located
+        // there from IsMSWUniqueVolumeNamePath
+        fullpath[wxMSWUniqueVolumePrefixLength - 1] = wxFILE_SEP_DSK;
+
+        // paths starting with a unique volume name should always be absolute
+        fullpath.insert(wxMSWUniqueVolumePrefixLength, 1, wxFILE_SEP_PATH_DOS);
+
+        // remove the leading "\\?\" part
+        fullpath.erase(0, 4);
+    }
+    else if ( IsUNCPath(fullpath, format) )
+    {
+        // special Windows UNC paths hack: transform \\share\path into share:path
+

         fullpath.erase(0, 2);
 
         size_t posFirstSlash =
         fullpath.erase(0, 2);
 
         size_t posFirstSlash =


@@ -2526,7 +2612,7 @@ bool wxFileName::GetTimes(wxDateTime *dtAccess,
 #elif defined(__UNIX_LIKE__) || defined(__WXMAC__) || defined(__OS2__) || (defined(__DOS__) && defined(__WATCOMC__))
     // no need to test for IsDir() here
     wxStructStat stBuf;
 #elif defined(__UNIX_LIKE__) || defined(__WXMAC__) || defined(__OS2__) || (defined(__DOS__) && defined(__WATCOMC__))
     // no need to test for IsDir() here
     wxStructStat stBuf;

-    if ( wxStat( GetFullPath().c_str(), &stBuf) == 0 )
+    if ( wxStat( GetFullPath(), &stBuf) == 0 )

     {
         if ( dtAccess )
             dtAccess->Set(stBuf.st_atime);
     {
         if ( dtAccess )
             dtAccess->Set(stBuf.st_atime);


@@ -2580,11 +2666,7 @@ wxULongLong wxFileName::GetSize(const wxString &filename)
     return wxULongLong(lpFileSizeHigh, ret);
 #else // ! __WIN32__
     wxStructStat st;
     return wxULongLong(lpFileSizeHigh, ret);
 #else // ! __WIN32__
     wxStructStat st;

-#ifndef wxNEED_WX_UNISTD_H
-    if (wxStat( filename.fn_str() , &st) != 0)
-#else

     if (wxStat( filename, &st) != 0)
     if (wxStat( filename, &st) != 0)

-#endif

         return wxInvalidSize;
     return wxULongLong(st.st_size);
 #endif
         return wxInvalidSize;
     return wxULongLong(st.st_size);
 #endif


@@ -2593,27 +2675,54 @@ wxULongLong wxFileName::GetSize(const wxString &filename)
 /* static */
 wxString wxFileName::GetHumanReadableSize(const wxULongLong &bs,
                                           const wxString &nullsize,
 /* static */
 wxString wxFileName::GetHumanReadableSize(const wxULongLong &bs,
                                           const wxString &nullsize,

-                                          int precision)
+                                          int precision,
+                                          wxSizeConvention conv)

 {
 {

-    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)
+    // deal with trivial case first
+    if ( bs == 0 || bs == wxInvalidSize )

         return nullsize;
 
         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);
+    // depending on the convention used the multiplier may be either 1000 or
+    // 1024 and the binary infix may be empty (for "KB") or "i" (for "KiB")
+    double multiplier = 1024.;
+    wxString biInfix;
+
+    switch ( conv )
+    {
+        case wxSIZE_CONV_TRADITIONAL:
+            // nothing to do, this corresponds to the default values of both
+            // the multiplier and infix string
+            break;
+
+        case wxSIZE_CONV_IEC:
+            biInfix = "i";
+            break;
+
+        case wxSIZE_CONV_SI:
+            multiplier = 1000;
+            break;
+    }
+
+    const double kiloByteSize = multiplier;
+    const double megaByteSize = multiplier * kiloByteSize;
+    const double gigaByteSize = multiplier * megaByteSize;
+    const double teraByteSize = multiplier * gigaByteSize;
+
+    const double bytesize = bs.ToDouble();
+
+    wxString result;
+    if ( bytesize < kiloByteSize )
+        result.Printf("%s B", bs.ToString());
+    else if ( bytesize < megaByteSize )
+        result.Printf("%.*f K%sB", precision, bytesize/kiloByteSize, biInfix);
+    else if (bytesize < gigaByteSize)
+        result.Printf("%.*f M%sB", precision, bytesize/megaByteSize, biInfix);
+    else if (bytesize < teraByteSize)
+        result.Printf("%.*f G%sB", precision, bytesize/gigaByteSize, biInfix);
+    else
+        result.Printf("%.*f T%sB", precision, bytesize/teraByteSize, biInfix);

 
 

-    return wxString::Format(_("%.*f TB"), precision, bytesize/TERABYTESIZE);
+    return result;

 }
 
 wxULongLong wxFileName::GetSize() const
 }
 
 wxULongLong wxFileName::GetSize() const


@@ -2621,9 +2730,11 @@ wxULongLong wxFileName::GetSize() const
     return GetSize(GetFullPath());
 }
 
     return GetSize(GetFullPath());
 }
 

-wxString wxFileName::GetHumanReadableSize(const wxString &failmsg, int precision) const
+wxString wxFileName::GetHumanReadableSize(const wxString& failmsg,
+                                          int precision,
+                                          wxSizeConvention conv) const

 {
 {

-    return GetHumanReadableSize(GetSize(), failmsg, precision);
+    return GetHumanReadableSize(GetSize(), failmsg, precision, conv);

 }
 
 #endif // wxUSE_LONGLONG
 }
 
 #endif // wxUSE_LONGLONG