Extensive documentation typo patch (closes #13063).

[wxWidgets.git] / src / msw / dir.cpp

diff --git a/src/msw/dir.cpp b/src/msw/dir.cpp
index fc9c933185413555fd869da817ce412491b3254f..672397394b01c976ad537e07d4837674111e6ef4 100644 (file)
--- a/src/msw/dir.cpp
+++ b/src/msw/dir.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        msw/dir.cpp
+// Name:        src/msw/dir.cpp
 // Purpose:     wxDir implementation for Win32
 // Author:      Vadim Zeitlin
 // Modified by:
@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "dir.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
@@ -34,9 +30,8 @@
 #endif // PCH
 
 #include "wx/dir.h"
-#include "wx/filefn.h"          // for wxPathExists()
 
-#ifdef __WXMSW__
+#ifdef __WINDOWS__
     #include "wx/msw/private.h"
 #endif
 
@@ -44,56 +39,64 @@
 // define the types and functions used for file searching
 // ----------------------------------------------------------------------------
 
+namespace
+{
+
 typedef WIN32_FIND_DATA FIND_STRUCT;
 typedef HANDLE FIND_DATA;
 typedef DWORD FIND_ATTR;
 
-static inline FIND_DATA InitFindData() { return INVALID_HANDLE_VALUE; }
+inline FIND_DATA InitFindData()
+{
+    return INVALID_HANDLE_VALUE;
+}
 
-static inline bool IsFindDataOk(FIND_DATA fd)
+inline bool IsFindDataOk(FIND_DATA fd)
 {
         return fd != INVALID_HANDLE_VALUE;
 }
 
-static inline void FreeFindData(FIND_DATA fd)
+inline void FreeFindData(FIND_DATA fd)
 {
-        if ( !::FindClose(fd) )
-        {
-            wxLogLastError(_T("FindClose"));
-        }
+    if ( !::FindClose(fd) )
+    {
+        wxLogLastError(wxT("FindClose"));
+    }
 }
 
-static inline FIND_DATA FindFirst(const wxString& spec,
-                                      FIND_STRUCT *finddata)
+inline FIND_DATA FindFirst(const wxString& spec,
+                           FIND_STRUCT *finddata)
 {
-        return ::FindFirstFile(spec, finddata);
+    return ::FindFirstFile(spec.t_str(), finddata);
 }
 
-static inline bool FindNext(FIND_DATA fd, FIND_STRUCT *finddata)
+inline bool FindNext(FIND_DATA fd, FIND_STRUCT *finddata)
 {
-        return ::FindNextFile(fd, finddata) != 0;
+    return ::FindNextFile(fd, finddata) != 0;
 }
 
-static const wxChar *GetNameFromFindData(FIND_STRUCT *finddata)
+const wxChar *GetNameFromFindData(FIND_STRUCT *finddata)
 {
-        return finddata->cFileName;
+    return finddata->cFileName;
 }
 
-static const FIND_ATTR GetAttrFromFindData(FIND_STRUCT *finddata)
+inline FIND_ATTR GetAttrFromFindData(FIND_STRUCT *finddata)
 {
-        return finddata->dwFileAttributes;
+    return finddata->dwFileAttributes;
 }
 
-static inline bool IsDir(FIND_ATTR attr)
+inline bool IsDir(FIND_ATTR attr)
 {
-        return (attr & FILE_ATTRIBUTE_DIRECTORY) != 0;
+    return (attr & FILE_ATTRIBUTE_DIRECTORY) != 0;
 }
 
-static inline bool IsHidden(FIND_ATTR attr)
+inline bool IsHidden(FIND_ATTR attr)
 {
-        return (attr & (FILE_ATTRIBUTE_HIDDEN | FILE_ATTRIBUTE_SYSTEM)) != 0;
+    return (attr & (FILE_ATTRIBUTE_HIDDEN | FILE_ATTRIBUTE_SYSTEM)) != 0;
 }
 
+} // anonymous namespace
+
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
@@ -136,7 +139,7 @@ private:
 
     int      m_flags;
 
-    DECLARE_NO_COPY_CLASS(wxDirData)
+    wxDECLARE_NO_COPY_CLASS(wxDirData);
 };
 
 // ============================================================================
@@ -175,7 +178,7 @@ void wxDirData::Rewind()
 
 bool wxDirData::Read(wxString *filename)
 {
-    bool first = FALSE;
+    bool first = false;
 
     WIN32_FIND_DATA finddata;
     #define PTR_TO_FINDDATA (&finddata)
@@ -186,13 +189,16 @@ bool wxDirData::Read(wxString *filename)
         wxString filespec = m_dirname;
         if ( !wxEndsWithPathSeparator(filespec) )
         {
-            filespec += _T('\\');
+            filespec += wxT('\\');
         }
-        filespec += (!m_filespec ? _T("*.*") : m_filespec.c_str());
+        if ( !m_filespec )
+            filespec += wxT("*.*");
+        else
+            filespec += m_filespec;
 
         m_finddata = FindFirst(filespec, PTR_TO_FINDDATA);
 
-        first = TRUE;
+        first = true;
     }
 
     if ( !IsFindDataOk(m_finddata) )
@@ -200,7 +206,7 @@ bool wxDirData::Read(wxString *filename)
 #ifdef __WIN32__
         DWORD err = ::GetLastError();
 
-        if ( err != ERROR_FILE_NOT_FOUND )
+        if ( err != ERROR_FILE_NOT_FOUND && err != ERROR_NO_MORE_FILES )
         {
             wxLogSysError(err, _("Can not enumerate files in directory '%s'"),
                           m_dirname.c_str());
@@ -208,7 +214,7 @@ bool wxDirData::Read(wxString *filename)
 #endif // __WIN32__
         //else: not an error, just no (such) files
 
-        return FALSE;
+        return false;
     }
 
     const wxChar *name;
@@ -218,7 +224,7 @@ bool wxDirData::Read(wxString *filename)
     {
         if ( first )
         {
-            first = FALSE;
+            first = false;
         }
         else
         {
@@ -229,12 +235,12 @@ bool wxDirData::Read(wxString *filename)
 
                 if ( err != ERROR_NO_MORE_FILES )
                 {
-                    wxLogLastError(_T("FindNext"));
+                    wxLogLastError(wxT("FindNext"));
                 }
 #endif // __WIN32__
                 //else: not an error, just no more (such) files
 
-                return FALSE;
+                return false;
             }
         }
 
@@ -242,9 +248,9 @@ bool wxDirData::Read(wxString *filename)
         attr = GetAttrFromFindData(PTR_TO_FINDDATA);
 
         // don't return "." and ".." unless asked for
-        if ( name[0] == _T('.') &&
-             ((name[1] == _T('.') && name[2] == _T('\0')) ||
-              (name[1] == _T('\0'))) )
+        if ( name[0] == wxT('.') &&
+             ((name[1] == wxT('.') && name[2] == wxT('\0')) ||
+              (name[1] == wxT('\0'))) )
         {
             if ( !(m_flags & wxDIR_DOTDOT) )
                 continue;
@@ -277,17 +283,7 @@ bool wxDirData::Read(wxString *filename)
         break;
     }
 
-    return TRUE;
-}
-
-// ----------------------------------------------------------------------------
-// wxDir helpers
-// ----------------------------------------------------------------------------
-
-/* static */
-bool wxDir::Exists(const wxString& dir)
-{
-    return wxPathExists(dir);
+    return true;
 }
 
 // ----------------------------------------------------------------------------
@@ -304,9 +300,20 @@ wxDir::wxDir(const wxString& dirname)
 bool wxDir::Open(const wxString& dirname)
 {
     delete M_DIR;
-    m_data = new wxDirData(dirname);
 
-    return TRUE;
+    // The Unix code does a similar test
+    if (wxDirExists(dirname))
+    {
+        m_data = new wxDirData(dirname);
+
+        return true;
+    }
+    else
+    {
+        m_data = NULL;
+
+        return false;
+    }
 }
 
 bool wxDir::IsOpened() const
@@ -323,9 +330,9 @@ wxString wxDir::GetName() const
         if ( !name.empty() )
         {
             // bring to canonical Windows form
-            name.Replace(_T("/"), _T("\\"));
+            name.Replace(wxT("/"), wxT("\\"));
 
-            if ( name.Last() == _T('\\') )
+            if ( name.Last() == wxT('\\') )
             {
                 // chop off the last (back)slash
                 name.Truncate(name.length() - 1);
@@ -349,7 +356,7 @@ bool wxDir::GetFirst(wxString *filename,
                      const wxString& filespec,
                      int flags) const
 {
-    wxCHECK_MSG( IsOpened(), FALSE, _T("must wxDir::Open() first") );
+    wxCHECK_MSG( IsOpened(), false, wxT("must wxDir::Open() first") );
 
     M_DIR->Rewind();
 
@@ -361,9 +368,9 @@ bool wxDir::GetFirst(wxString *filename,
 
 bool wxDir::GetNext(wxString *filename) const
 {
-    wxCHECK_MSG( IsOpened(), FALSE, _T("must wxDir::Open() first") );
+    wxCHECK_MSG( IsOpened(), false, wxT("must wxDir::Open() first") );
 
-    wxCHECK_MSG( filename, FALSE, _T("bad pointer in wxDir::GetNext()") );
+    wxCHECK_MSG( filename, false, wxT("bad pointer in wxDir::GetNext()") );
 
     return M_DIR->Read(filename);
 }
@@ -378,15 +385,21 @@ extern bool
 wxGetDirectoryTimes(const wxString& dirname,
                     FILETIME *ftAccess, FILETIME *ftCreate, FILETIME *ftMod)
 {
+#ifdef __WXWINCE__
+    // FindFirst() is going to fail
+    wxASSERT_MSG( !dirname.empty(),
+                  wxT("incorrect directory name format in wxGetDirectoryTimes") );
+#else
     // FindFirst() is going to fail
-    wxASSERT_MSG( !dirname.empty() && dirname.Last() != _T('\\'),
-                  _T("incorrect directory name format in wxGetDirectoryTimes") );
+    wxASSERT_MSG( !dirname.empty() && dirname.Last() != wxT('\\'),
+                  wxT("incorrect directory name format in wxGetDirectoryTimes") );
+#endif
 
     FIND_STRUCT fs;
     FIND_DATA fd = FindFirst(dirname, &fs);
     if ( !IsFindDataOk(fd) )
     {
-        return FALSE;
+        return false;
     }
 
     *ftAccess = fs.ftLastAccessTime;
@@ -395,7 +408,7 @@ wxGetDirectoryTimes(const wxString& dirname,
 
     FindClose(fd);
 
-    return TRUE;
+    return true;
 }
 
 #endif // __WIN32__