Return false from wxFileName::AppendDir() and InsertDir() on failure.

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

diff --git a/include/wx/dir.h b/include/wx/dir.h
index 317ad785930f8a352d44645beb9f5bd7e61c86cc..de389aef892e76b3e96d33e3904a0c1f1e64b66c 100644 (file)
--- a/include/wx/dir.h
+++ b/include/wx/dir.h
@@ -12,26 +12,27 @@
 #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"
+#include "wx/filefn.h"      // for wxS_DIR_DEFAULT
 
-#ifndef WX_PRECOMP
-    #include  "wx/string.h"
-#endif
+class WXDLLIMPEXP_FWD_BASE wxArrayString;
 
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
-// these flags define what kind of filenames is included in the list of files
-// enumerated by GetFirst/GetNext
-enum
+// These flags affect the behaviour of GetFirst/GetNext() and Traverse().
+// They define what types are included in the list of items they produce.
+// Note that wxDIR_NO_FOLLOW is relevant only on Unix and ignored under systems
+// not supporting symbolic links.
+enum wxDirFlags
 {
     wxDIR_FILES     = 0x0001,       // include files
     wxDIR_DIRS      = 0x0002,       // include directories
     wxDIR_HIDDEN    = 0x0004,       // include hidden files
     wxDIR_DOTDOT    = 0x0008,       // include '.' and '..'
+    wxDIR_NO_FOLLOW = 0x0010,       // don't dereference any symlink
 
     // by default, enumerate everything except '.' and '..'
     wxDIR_DEFAULT   = wxDIR_FILES | wxDIR_DIRS | wxDIR_HIDDEN
@@ -49,9 +50,11 @@ enum wxDirTraverseResult
 // wxDirTraverser: helper class for wxDir::Traverse()
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT_BASE 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 (wxDIR_IGNORE doesn't
@@ -64,7 +67,7 @@ public:
     virtual wxDirTraverseResult OnDir(const wxString& dirname) = 0;
 
     // called for each directory which we couldn't open during our traversal
-    // of the directory tyree
+    // 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
@@ -79,13 +82,11 @@ public:
 // wxDir: portable equivalent of {open/read/close}dir functions
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT_BASE wxDirData;
+class WXDLLIMPEXP_FWD_BASE wxDirData;
 
-class WXDLLEXPORT_BASE wxDir
+class WXDLLIMPEXP_BASE wxDir
 {
 public:
-    // test for existence of a directory with the given name
-    static bool Exists(const wxString& dir);
 
     // ctors
     // -----
@@ -96,23 +97,31 @@ public:
     // opens the directory for enumeration, use IsOpened() to test success
     wxDir(const wxString& dir);
 
-    // dtor cleans up the associated ressources
-    ~wxDir();
+    // dtor calls Close() automatically
+    ~wxDir() { Close(); }
 
     // open the directory for enumerating
     bool Open(const wxString& dir);
 
-    // returns TRUE if the directory was successfully opened
+    // close the directory, Open() can be called again later
+    void Close();
+
+    // 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;
 
+    // Same as GetName() but does include the trailing separator, unless the
+    // string is empty (only for invalid directories).
+    wxString GetNameWithSep() const;
+
+
     // file enumeration routines
     // -------------------------
 
     // 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;
@@ -121,10 +130,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
     //
@@ -140,12 +149,38 @@ 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
+
+
+    // static utilities for directory management
+    // (alias to wxFileName's functions for dirs)
+    // -----------------------------------------
+
+    // test for existence of a directory with the given name
+    static bool Exists(const wxString& dir);
+
+    static bool Make(const wxString &dir, int perm = wxS_DIR_DEFAULT,
+                     int flags = 0);
+
+    static bool Remove(const wxString &dir, int flags = 0);
+
+
 private:
     friend class wxDirData;
 
     wxDirData *m_data;
 
-    DECLARE_NO_COPY_CLASS(wxDir)
+    wxDECLARE_NO_COPY_CLASS(wxDir);
 };
 
 #endif // _WX_DIR_H_