X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/353327844e319db755c2e7a07a4cf5b53cef35c4..a69aabc360d54a93e355fab72c6513c75aaa7337:/include/wx/dir.h?ds=sidebyside diff --git a/include/wx/dir.h b/include/wx/dir.h index de2563540b..d41bca30c7 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 -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_DIR_H_ #define _WX_DIR_H_ -#ifdef __GNUG__ - #pragma interface "dir.h" -#endif +#include "wx/longlong.h" +#include "wx/string.h" -#ifndef WX_PRECOMP - #include "wx/string.h" -#endif +class WXDLLIMPEXP_BASE wxArrayString; // ---------------------------------------------------------------------------- // constants @@ -49,25 +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 tyree + // + // 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 wxDir +class WXDLLIMPEXP_BASE wxDirData; + +class WXDLLIMPEXP_BASE wxDir { public: // test for existence of a directory with the given name @@ -88,7 +101,7 @@ public: // 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) @@ -98,15 +111,20 @@ 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; - // 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; + // 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 // // return the number of files found @@ -121,10 +139,23 @@ 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); + + // returns the size of all directories recursively found in given path + static wxULongLong GetTotalSize(const wxString &dir, wxArrayString *filesSkipped = NULL); + private: - friend class WXDLLEXPORT wxDirData; + friend class wxDirData; wxDirData *m_data; + + DECLARE_NO_COPY_CLASS(wxDir) }; #endif // _WX_DIR_H_ +