X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/22f3361e1cf25c52a2da8fdfc5cb081809e18fb9..f01a77c7954ff4b7ee9f74af8df5a16f239d3537:/include/wx/dir.h?ds=sidebyside

diff --git a/include/wx/dir.h b/include/wx/dir.h
index 1e32ce38a5..9a73c6644e 100644
--- a/include/wx/dir.h
+++ b/include/wx/dir.h
@@ -6,19 +6,16 @@
 // Created:     08.12.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DIR_H_
 #define _WX_DIR_H_
 
-#if defined(__GNUG__) && !defined(__APPLE__)
-    #pragma interface "dir.h"
-#endif
+#include "wx/longlong.h"
+#include "wx/string.h"
 
-#ifndef WX_PRECOMP
-    #include  "wx/string.h"
-#endif
+class WXDLLIMPEXP_FWD_BASE wxArrayString;
 
 // ----------------------------------------------------------------------------
 // constants
@@ -49,27 +46,41 @@ enum wxDirTraverseResult
 // wxDirTraverser: helper class for wxDir::Traverse()
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxDirTraverser
+class WXDLLIMPEXP_BASE wxDirTraverser
 {
 public:
+    /// a virtual dtor has been provided since this class has virtual members
+    virtual ~wxDirTraverser() { }
     // called for each file found by wxDir::Traverse()
     //
-    // return wxDIR_STOP or wxDIR_CONTINUE from here
+    // return wxDIR_STOP or wxDIR_CONTINUE from here (wxDIR_IGNORE doesn't
+    // make sense)
     virtual wxDirTraverseResult OnFile(const wxString& filename) = 0;
 
     // called for each directory found by wxDir::Traverse()
     //
     // return one of the enum elements defined above
     virtual wxDirTraverseResult OnDir(const wxString& dirname) = 0;
+
+    // called for each directory which we couldn't open during our traversal
+    // of the directory tree
+    //
+    // this method can also return either wxDIR_STOP, wxDIR_IGNORE or
+    // wxDIR_CONTINUE but the latter is treated specially: it means to retry
+    // opening the directory and so may lead to infinite loop if it is
+    // returned unconditionally, be careful with this!
+    //
+    // the base class version always returns wxDIR_IGNORE
+    virtual wxDirTraverseResult OnOpenError(const wxString& dirname);
 };
 
 // ----------------------------------------------------------------------------
 // wxDir: portable equivalent of {open/read/close}dir functions
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxDirData;
+class WXDLLIMPEXP_FWD_BASE wxDirData;
 
-class WXDLLEXPORT wxDir
+class WXDLLIMPEXP_BASE wxDir
 {
 public:
     // test for existence of a directory with the given name
@@ -84,13 +95,13 @@ public:
     // opens the directory for enumeration, use IsOpened() to test success
     wxDir(const wxString& dir);
 
-    // dtor cleans up the associated ressources
+    // dtor cleans up the associated resources
     ~wxDir();
 
     // open the directory for enumerating
     bool Open(const wxString& dir);
 
-    // returns TRUE if the directory was successfully opened
+    // returns true if the directory was successfully opened
     bool IsOpened() const;
 
     // get the full name of the directory (without '/' at the end)
@@ -100,7 +111,7 @@ public:
     // -------------------------
 
     // start enumerating all files matching filespec (or all files if it is
-    // empty) and flags, return TRUE on success
+    // empty) and flags, return true on success
     bool GetFirst(wxString *filename,
                   const wxString& filespec = wxEmptyString,
                   int flags = wxDIR_DEFAULT) const;
@@ -109,10 +120,10 @@ public:
     bool GetNext(wxString *filename) const;
 
     // return true if this directory has any files in it
-    bool HasFiles(const wxString& spec = wxEmptyString);
+    bool HasFiles(const wxString& spec = wxEmptyString) const;
 
     // return true if this directory has any subdirectories
-    bool HasSubDirs(const wxString& spec = wxEmptyString);
+    bool HasSubDirs(const wxString& spec = wxEmptyString) const;
 
     // enumerate all files in this directory and its subdirectories
     //
@@ -128,8 +139,20 @@ public:
                               const wxString& filespec = wxEmptyString,
                               int flags = wxDIR_DEFAULT);
 
+    // check if there any files matching the given filespec under the given
+    // directory (i.e. searches recursively), return the file path if found or
+    // empty string otherwise
+    static wxString FindFirst(const wxString& dirname,
+                              const wxString& filespec,
+                              int flags = wxDIR_DEFAULT);
+
+#if wxUSE_LONGLONG
+    // returns the size of all directories recursively found in given path
+    static wxULongLong GetTotalSize(const wxString &dir, wxArrayString *filesSkipped = NULL);
+#endif // wxUSE_LONGLONG
+
 private:
-    friend class WXDLLEXPORT wxDirData;
+    friend class wxDirData;
 
     wxDirData *m_data;
 
@@ -137,3 +160,4 @@ private:
 };
 
 #endif // _WX_DIR_H_
+