1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxDir is a class for enumerating the files in a directory
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
15 #if defined(__GNUG__) && !defined(__APPLE__)
16 #pragma interface "dir.h"
20 #include "wx/string.h"
23 // ----------------------------------------------------------------------------
25 // ----------------------------------------------------------------------------
27 // these flags define what kind of filenames is included in the list of files
28 // enumerated by GetFirst/GetNext
31 wxDIR_FILES
= 0x0001, // include files
32 wxDIR_DIRS
= 0x0002, // include directories
33 wxDIR_HIDDEN
= 0x0004, // include hidden files
34 wxDIR_DOTDOT
= 0x0008, // include '.' and '..'
36 // by default, enumerate everything except '.' and '..'
37 wxDIR_DEFAULT
= wxDIR_FILES
| wxDIR_DIRS
| wxDIR_HIDDEN
40 // these constants are possible return value of wxDirTraverser::OnDir()
41 enum wxDirTraverseResult
43 wxDIR_IGNORE
= -1, // ignore this directory but continue with others
44 wxDIR_STOP
, // stop traversing
45 wxDIR_CONTINUE
// continue into this directory
48 // ----------------------------------------------------------------------------
49 // wxDirTraverser: helper class for wxDir::Traverse()
50 // ----------------------------------------------------------------------------
52 class WXDLLEXPORT wxDirTraverser
55 // called for each file found by wxDir::Traverse()
57 // return wxDIR_STOP or wxDIR_CONTINUE from here (wxDIR_IGNORE doesn't
59 virtual wxDirTraverseResult
OnFile(const wxString
& filename
) = 0;
61 // called for each directory found by wxDir::Traverse()
63 // return one of the enum elements defined above
64 virtual wxDirTraverseResult
OnDir(const wxString
& dirname
) = 0;
66 // called for each directory which we couldn't open during our traversal
67 // of the directory tyree
69 // this method can also return either wxDIR_STOP, wxDIR_IGNORE or
70 // wxDIR_CONTINUE but the latter is treated specially: it means to retry
71 // opening the directory and so may lead to infinite loop if it is
72 // returned unconditionally, be careful with this!
74 // the base class version always returns wxDIR_IGNORE
75 virtual wxDirTraverseResult
OnOpenError(const wxString
& dirname
);
78 // ----------------------------------------------------------------------------
79 // wxDir: portable equivalent of {open/read/close}dir functions
80 // ----------------------------------------------------------------------------
82 class WXDLLEXPORT wxDirData
;
84 class WXDLLEXPORT wxDir
87 // test for existence of a directory with the given name
88 static bool Exists(const wxString
& dir
);
93 // default, use Open()
94 wxDir() { m_data
= NULL
; }
96 // opens the directory for enumeration, use IsOpened() to test success
97 wxDir(const wxString
& dir
);
99 // dtor cleans up the associated ressources
102 // open the directory for enumerating
103 bool Open(const wxString
& dir
);
105 // returns TRUE if the directory was successfully opened
106 bool IsOpened() const;
108 // get the full name of the directory (without '/' at the end)
109 wxString
GetName() const;
111 // file enumeration routines
112 // -------------------------
114 // start enumerating all files matching filespec (or all files if it is
115 // empty) and flags, return TRUE on success
116 bool GetFirst(wxString
*filename
,
117 const wxString
& filespec
= wxEmptyString
,
118 int flags
= wxDIR_DEFAULT
) const;
120 // get next file in the enumeration started with GetFirst()
121 bool GetNext(wxString
*filename
) const;
123 // return true if this directory has any files in it
124 bool HasFiles(const wxString
& spec
= wxEmptyString
);
126 // return true if this directory has any subdirectories
127 bool HasSubDirs(const wxString
& spec
= wxEmptyString
);
129 // enumerate all files in this directory and its subdirectories
131 // return the number of files found
132 size_t Traverse(wxDirTraverser
& sink
,
133 const wxString
& filespec
= wxEmptyString
,
134 int flags
= wxDIR_DEFAULT
) const;
136 // simplest version of Traverse(): get the names of all files under this
137 // directory into filenames array, return the number of files
138 static size_t GetAllFiles(const wxString
& dirname
,
139 wxArrayString
*files
,
140 const wxString
& filespec
= wxEmptyString
,
141 int flags
= wxDIR_DEFAULT
);
144 friend class WXDLLEXPORT wxDirData
;
148 DECLARE_NO_COPY_CLASS(wxDir
)