ugh. Nesting the (per class) plugin sentries can require them to

[wxWidgets.git] / include / wx / dir.h

diff --git a/include/wx/dir.h b/include/wx/dir.h
index f8b0b67f3cab965649516fa63134dc647edb78b6..43dddce6424c8a2600fa8e046f88375246ee6ffe 100644 (file)
--- a/include/wx/dir.h
+++ b/include/wx/dir.h
@@ -37,6 +37,32 @@ enum
     wxDIR_DEFAULT   = wxDIR_FILES | wxDIR_DIRS | wxDIR_HIDDEN
 };
 
+// these constants are possible return value of wxDirTraverser::OnDir()
+enum wxDirTraverseResult
+{
+    wxDIR_IGNORE = -1,      // ignore this directory but continue with others
+    wxDIR_STOP,             // stop traversing
+    wxDIR_CONTINUE          // continue into this directory
+};
+
+// ----------------------------------------------------------------------------
+// wxDirTraverser: helper class for wxDir::Traverse()
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxDirTraverser
+{
+public:
+    // called for each file found by wxDir::Traverse()
+    //
+    // return wxDIR_STOP or wxDIR_CONTINUE from here
+    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;
+};
+
 // ----------------------------------------------------------------------------
 // wxDir: portable equivalent of {open/read/close}dir functions
 // ----------------------------------------------------------------------------
@@ -65,6 +91,9 @@ public:
     // returns TRUE if the directory was successfully opened
     bool IsOpened() const;
 
+    // get the full name of the directory (without '/' at the end)
+    wxString GetName() const;
+
     // file enumeration routines
     // -------------------------
 
@@ -74,31 +103,28 @@ public:
                   const wxString& filespec = wxEmptyString,
                   int flags = wxDIR_DEFAULT) const;
 
-    // get next file in the enumeration started with either GetFirst() or
-    // GetFirstNormal()
+    // get next file in the enumeration started with GetFirst()
     bool GetNext(wxString *filename) const;
 
-    // TODO using scandir() when available later, emulating it otherwise
-#if 0
-    // get all files in the directory into an array, return TRUE on success
+    // return true if this directory has any files in it
+    bool HasFiles(const wxString& spec = wxEmptyString);
+
+    // return true if this directory has any subdirectories
+    bool HasSubDirs(const wxString& spec = wxEmptyString);
+
+    // enumerate all files in this directory and its subdirectories
     //
-    // this function uses Select() function to select the files
-    // unless the filespec is explicitly given and Compare() function to sort
-    // them
-    bool Read(wxArrayString& filenames,
-              const wxString& filespec = wxEmptyString) const;
-
-protected:
-    // this function is called by Read() if filespec is not specified in
-    // Read(): it should return TRUE if the file matches our selection
-    // criteria and FALSE otherwise
-    virtual bool Select(const wxChar* filename);
-
-    // This function is called by Read() to sort the array: it should return
-    // -1, 0 or +1 if the first file is less than, equal to or greater than
-    // the second. The base class version does 
-    virtual int Compare(const wxChar *filename1, const wxChar *filename2);
-#endif // 0
+    // return the number of files found
+    size_t Traverse(wxDirTraverser& sink,
+                    const wxString& filespec = wxEmptyString,
+                    int flags = wxDIR_DEFAULT) const;
+
+    // simplest version of Traverse(): get the names of all files under this
+    // directory into filenames array, return the number of files
+    static size_t GetAllFiles(const wxString& dirname,
+                              wxArrayString *files,
+                              const wxString& filespec = wxEmptyString,
+                              int flags = wxDIR_DEFAULT);
 
 private:
     friend class WXDLLEXPORT wxDirData;