Don't define __STRICT_ANSI__, we should build both with and without it.

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

diff --git a/include/wx/dir.h b/include/wx/dir.h
index 43dddce6424c8a2600fa8e046f88375246ee6ffe..f23862e0a943f4013101fff45725f000a16c98ac 100644 (file)
--- a/include/wx/dir.h
+++ b/include/wx/dir.h
@@ -4,34 +4,34 @@
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     08.12.99
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     08.12.99

-// RCS-ID:      $Id$

 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DIR_H_
 #define _WX_DIR_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DIR_H_
 #define _WX_DIR_H_
 

-#ifdef __GNUG__
-    #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
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // 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_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
 
     // by default, enumerate everything except '.' and '..'
     wxDIR_DEFAULT   = wxDIR_FILES | wxDIR_DIRS | wxDIR_HIDDEN


@@ -49,29 +49,43 @@ enum wxDirTraverseResult
 // wxDirTraverser: helper class for wxDir::Traverse()
 // ----------------------------------------------------------------------------
 
 // wxDirTraverser: helper class for wxDir::Traverse()
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDirTraverser
+class WXDLLIMPEXP_BASE wxDirTraverser

 {
 public:
 {
 public:

+    /// a virtual dtor has been provided since this class has virtual members
+    virtual ~wxDirTraverser() { }

     // called for each file found by wxDir::Traverse()
     //
     // 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;
     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
 // ----------------------------------------------------------------------------
 
 };
 
 // ----------------------------------------------------------------------------
 // wxDir: portable equivalent of {open/read/close}dir functions
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDir
+class WXDLLIMPEXP_FWD_BASE wxDirData;
+
+class WXDLLIMPEXP_BASE wxDir

 {
 public:
 {
 public:

-    // test for existence of a directory with the given name
-    static bool Exists(const wxString& dir);

 
     // ctors
     // -----
 
     // ctors
     // -----


@@ -82,23 +96,31 @@ public:
     // opens the directory for enumeration, use IsOpened() to test success
     wxDir(const wxString& dir);
 
     // 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);
 
 
     // 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;
 
     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
     // 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;
     bool GetFirst(wxString *filename,
                   const wxString& filespec = wxEmptyString,
                   int flags = wxDIR_DEFAULT) const;


@@ -107,10 +129,10 @@ public:
     bool GetNext(wxString *filename) const;
 
     // return true if this directory has any files in it
     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
 
     // 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
     //
 
     // enumerate all files in this directory and its subdirectories
     //


@@ -126,10 +148,39 @@ public:
                               const wxString& filespec = wxEmptyString,
                               int flags = wxDIR_DEFAULT);
 
                               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:
 private:

-    friend class WXDLLEXPORT wxDirData;
+    friend class wxDirData;

 
     wxDirData *m_data;
 
     wxDirData *m_data;

+
+    wxDECLARE_NO_COPY_CLASS(wxDir);

 };
 
 #endif // _WX_DIR_H_
 };
 
 #endif // _WX_DIR_H_

+