]> git.saurik.com Git - wxWidgets.git/blob - include/wx/dir.h
wxLaunchDefaultBrowser() now supports wxBROWSER_NEW_WINDOW flag (and it actually...
[wxWidgets.git] / include / wx / dir.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/dir.h
3 // Purpose: wxDir is a class for enumerating the files in a directory
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 08.12.99
7 // RCS-ID: $Id$
8 // Copyright: (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_DIR_H_
13 #define _WX_DIR_H_
14
15 #ifndef WX_PRECOMP
16 #include "wx/string.h"
17 #endif
18
19 class WXDLLIMPEXP_BASE wxArrayString;
20
21 // ----------------------------------------------------------------------------
22 // constants
23 // ----------------------------------------------------------------------------
24
25 // these flags define what kind of filenames is included in the list of files
26 // enumerated by GetFirst/GetNext
27 enum
28 {
29 wxDIR_FILES = 0x0001, // include files
30 wxDIR_DIRS = 0x0002, // include directories
31 wxDIR_HIDDEN = 0x0004, // include hidden files
32 wxDIR_DOTDOT = 0x0008, // include '.' and '..'
33
34 // by default, enumerate everything except '.' and '..'
35 wxDIR_DEFAULT = wxDIR_FILES | wxDIR_DIRS | wxDIR_HIDDEN
36 };
37
38 // these constants are possible return value of wxDirTraverser::OnDir()
39 enum wxDirTraverseResult
40 {
41 wxDIR_IGNORE = -1, // ignore this directory but continue with others
42 wxDIR_STOP, // stop traversing
43 wxDIR_CONTINUE // continue into this directory
44 };
45
46 // ----------------------------------------------------------------------------
47 // wxDirTraverser: helper class for wxDir::Traverse()
48 // ----------------------------------------------------------------------------
49
50 class WXDLLIMPEXP_BASE wxDirTraverser
51 {
52 public:
53 /// a virtual dtor has been provided since this class has virtual members
54 virtual ~wxDirTraverser() { }
55 // called for each file found by wxDir::Traverse()
56 //
57 // return wxDIR_STOP or wxDIR_CONTINUE from here (wxDIR_IGNORE doesn't
58 // make sense)
59 virtual wxDirTraverseResult OnFile(const wxString& filename) = 0;
60
61 // called for each directory found by wxDir::Traverse()
62 //
63 // return one of the enum elements defined above
64 virtual wxDirTraverseResult OnDir(const wxString& dirname) = 0;
65
66 // called for each directory which we couldn't open during our traversal
67 // of the directory tyree
68 //
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!
73 //
74 // the base class version always returns wxDIR_IGNORE
75 virtual wxDirTraverseResult OnOpenError(const wxString& dirname);
76 };
77
78 // ----------------------------------------------------------------------------
79 // wxDir: portable equivalent of {open/read/close}dir functions
80 // ----------------------------------------------------------------------------
81
82 class WXDLLIMPEXP_BASE wxDirData;
83
84 class WXDLLIMPEXP_BASE wxDir
85 {
86 public:
87 // test for existence of a directory with the given name
88 static bool Exists(const wxString& dir);
89
90 // ctors
91 // -----
92
93 // default, use Open()
94 wxDir() { m_data = NULL; }
95
96 // opens the directory for enumeration, use IsOpened() to test success
97 wxDir(const wxString& dir);
98
99 // dtor cleans up the associated ressources
100 ~wxDir();
101
102 // open the directory for enumerating
103 bool Open(const wxString& dir);
104
105 // returns true if the directory was successfully opened
106 bool IsOpened() const;
107
108 // get the full name of the directory (without '/' at the end)
109 wxString GetName() const;
110
111 // file enumeration routines
112 // -------------------------
113
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;
119
120 // get next file in the enumeration started with GetFirst()
121 bool GetNext(wxString *filename) const;
122
123 // return true if this directory has any files in it
124 bool HasFiles(const wxString& spec = wxEmptyString);
125
126 // return true if this directory has any subdirectories
127 bool HasSubDirs(const wxString& spec = wxEmptyString);
128
129 // enumerate all files in this directory and its subdirectories
130 //
131 // return the number of files found
132 size_t Traverse(wxDirTraverser& sink,
133 const wxString& filespec = wxEmptyString,
134 int flags = wxDIR_DEFAULT) const;
135
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);
142
143 private:
144 friend class wxDirData;
145
146 wxDirData *m_data;
147
148 DECLARE_NO_COPY_CLASS(wxDir)
149 };
150
151 #endif // _WX_DIR_H_
152