]> git.saurik.com Git - wxWidgets.git/blob - src/os2/dir.cpp
docs updates and typos and lies fixes
[wxWidgets.git] / src / os2 / dir.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: os2/dir.cpp
3 // Purpose: wxDir implementation for OS/2
4 // Author: Vadim Zeitlin
5 // Modified by: Stefan Neis
6 // Created: 08.12.99
7 // RCS-ID: $Id$
8 // Copyright: (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 #ifdef __GNUG__
21 #pragma implementation "dir.h"
22 #endif
23
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
26
27 #ifndef WX_PRECOMP
28 #include "wx/intl.h"
29 #include "wx/log.h"
30 #endif // PCH
31
32 #include "wx/dir.h"
33 #include "wx/filefn.h" // for wxMatchWild
34
35 #include <sys/types.h>
36
37 #define INCL_DOSFILEMGR
38 #include <os2.h>
39
40 #ifdef __EMX__
41 #include <dirent.h>
42 #endif
43
44 // ----------------------------------------------------------------------------
45 // define the types and functions used for file searching
46 // ----------------------------------------------------------------------------
47
48 typedef FILEFINDBUF3 FIND_STRUCT;
49 typedef HDIR FIND_DATA;
50 typedef ULONG FIND_ATTR;
51
52 static inline FIND_DATA InitFindData() { return ERROR_INVALID_HANDLE; }
53
54 static inline bool IsFindDataOk(
55 FIND_DATA vFd
56 )
57 {
58 return vFd != ERROR_INVALID_HANDLE;
59 }
60
61 static inline void FreeFindData(
62 FIND_DATA vFd
63 )
64 {
65 if (!::DosFindClose(vFd))
66 {
67 wxLogLastError(_T("DosFindClose"));
68 }
69 }
70
71 static inline FIND_DATA FindFirst(
72 const wxString& rsSpec
73 , FIND_STRUCT* pFinddata
74 )
75 {
76 ULONG ulFindCount = 1;
77 FIND_DATA hDir;
78 FIND_ATTR rc;
79
80 rc = ::DosFindFirst( rsSpec.c_str()
81 ,&hDir
82 ,FILE_NORMAL
83 ,pFinddata
84 ,sizeof(FILEFINDBUF3)
85 ,&ulFindCount
86 ,FIL_STANDARD
87 );
88 if (rc != 0)
89 return 0;
90 return hDir;
91 }
92
93 static inline bool FindNext(
94 FIND_DATA vFd
95 , FIND_STRUCT* pFinddata
96 )
97 {
98 ULONG ulFindCount = 1;
99
100 return ::DosFindNext( vFd
101 ,pFinddata
102 ,sizeof(FILEFINDBUF3)
103 ,&ulFindCount
104 ) != 0;
105 }
106
107 static const wxChar* GetNameFromFindData(
108 FIND_STRUCT* pFinddata
109 )
110 {
111 return pFinddata->achName;
112 }
113
114 static const FIND_ATTR GetAttrFromFindData(
115 FIND_STRUCT* pFinddata
116 )
117 {
118 return pFinddata->attrFile;
119 }
120
121 static inline bool IsDir(
122 FIND_ATTR vAttr
123 )
124 {
125 return (vAttr & FILE_DIRECTORY) != 0;
126 }
127
128 static inline bool IsHidden(
129 FIND_ATTR vAttr
130 )
131 {
132 return (vAttr & (FILE_HIDDEN | FILE_SYSTEM)) != 0;
133 }
134
135 // ----------------------------------------------------------------------------
136 // constants
137 // ----------------------------------------------------------------------------
138
139 #ifndef MAX_PATH
140 #define MAX_PATH 260 // from PM++ headers
141 #endif
142
143 // ----------------------------------------------------------------------------
144 // macros
145 // ----------------------------------------------------------------------------
146
147 #define M_DIR ((wxDirData *)m_data)
148
149 // ----------------------------------------------------------------------------
150 // private classes
151 // ----------------------------------------------------------------------------
152
153 // this class stores everything we need to enumerate the files
154 class wxDirData
155 {
156 public:
157 wxDirData(const wxString& rsDirname);
158 ~wxDirData();
159
160 void SetFileSpec(const wxString& rsFilespec) { m_sFilespec = rsFilespec; }
161 void SetFlags(int nFlags) { m_nFlags = nFlags; }
162
163 const wxString& GetName() const { return m_sDirname; }
164 void Close();
165 void Rewind();
166 bool Read(wxString* rsFilename);
167
168 private:
169 FIND_DATA m_vFinddata;
170 wxString m_sDirname;
171 wxString m_sFilespec;
172 int m_nFlags;
173 }; // end of CLASS wxDirData
174
175 // ============================================================================
176 // implementation
177 // ============================================================================
178
179 // ----------------------------------------------------------------------------
180 // wxDirData
181 // ----------------------------------------------------------------------------
182
183 wxDirData::wxDirData(
184 const wxString& rsDirname
185 )
186 : m_sDirname(rsDirname)
187 {
188 m_vFinddata = InitFindData();
189 } // end of wxDirData::wxDirData
190
191 wxDirData::~wxDirData()
192 {
193 Close();
194 } // end of wxDirData::~wxDirData
195
196 void wxDirData::Close()
197 {
198 if ( IsFindDataOk(m_vFinddata) )
199 {
200 FreeFindData(m_vFinddata);
201 m_vFinddata = InitFindData();
202 }
203 } // end of wxDirData::Close
204
205 void wxDirData::Rewind()
206 {
207 Close();
208 } // end of wxDirData::Rewind
209
210 bool wxDirData::Read(
211 wxString* psFilename
212 )
213 {
214 bool bFirst = FALSE;
215
216 FILEFINDBUF3 vFinddata;
217 #define PTR_TO_FINDDATA (&vFinddata)
218
219 if (!IsFindDataOk(m_vFinddata))
220 {
221 //
222 // Open first
223 //
224 wxString sFilespec = m_sDirname;
225
226 if ( !wxEndsWithPathSeparator(sFilespec) )
227 {
228 sFilespec += _T('\\');
229 }
230 sFilespec += (!m_sFilespec ? _T("*.*") : m_sFilespec.c_str());
231
232 m_vFinddata = FindFirst( sFilespec
233 ,PTR_TO_FINDDATA
234 );
235 bFirst = TRUE;
236 }
237
238 if ( !IsFindDataOk(m_vFinddata) )
239 {
240 return FALSE;
241 }
242
243 const wxChar* zName;
244 FIND_ATTR vAttr;
245
246 for ( ;; )
247 {
248 if (bFirst)
249 {
250 bFirst = FALSE;
251 }
252 else
253 {
254 if (!FindNext( m_vFinddata
255 ,PTR_TO_FINDDATA
256 ))
257 {
258 return FALSE;
259 }
260 }
261
262 zName = GetNameFromFindData(PTR_TO_FINDDATA);
263 vAttr = GetAttrFromFindData(PTR_TO_FINDDATA);
264
265 //
266 // Don't return "." and ".." unless asked for
267 //
268 if ( zName[0] == _T('.') &&
269 ((zName[1] == _T('.') && zName[2] == _T('\0')) ||
270 (zName[1] == _T('\0'))) )
271 {
272 if (!(m_nFlags & wxDIR_DOTDOT))
273 continue;
274 }
275
276 //
277 // Check the type now
278 //
279 if (!(m_nFlags & wxDIR_FILES) && !IsDir(vAttr))
280 {
281 //
282 // It's a file, but we don't want them
283 //
284 continue;
285 }
286 else if (!(m_nFlags & wxDIR_DIRS) && IsDir(vAttr) )
287 {
288 //
289 // It's a dir, and we don't want it
290 //
291 continue;
292 }
293
294 //
295 // Finally, check whether it's a hidden file
296 //
297 if (!(m_nFlags & wxDIR_HIDDEN))
298 {
299 if (IsHidden(vAttr))
300 {
301 //
302 // It's a hidden file, skip it
303 //
304 continue;
305 }
306 }
307 *psFilename = zName;
308 break;
309 }
310 return TRUE;
311 } // end of wxDirData::Read
312
313 // ----------------------------------------------------------------------------
314 // wxDir helpers
315 // ----------------------------------------------------------------------------
316
317 /* static */
318 bool wxDir::Exists(
319 const wxString& rsDir
320 )
321 {
322 return wxPathExists(rsDir);
323 } // end of wxDir::Exists
324
325 // ----------------------------------------------------------------------------
326 // wxDir construction/destruction
327 // ----------------------------------------------------------------------------
328
329 wxDir::wxDir(
330 const wxString& rsDirname
331 )
332 {
333 m_data = NULL;
334
335 (void)Open(rsDirname);
336 } // end of wxDir::wxDir
337
338 bool wxDir::Open(
339 const wxString& rsDirname
340 )
341 {
342 delete M_DIR;
343 m_data = new wxDirData(rsDirname);
344 return TRUE;
345 } // end of wxDir::Open
346
347 bool wxDir::IsOpened() const
348 {
349 return m_data != NULL;
350 } // end of wxDir::IsOpen
351
352 wxString wxDir::GetName() const
353 {
354 wxString name;
355 if ( m_data )
356 {
357 name = M_DIR->GetName();
358 if ( !name.empty() )
359 {
360 // bring to canonical Windows form
361 name.Replace(_T("/"), _T("\\"));
362
363 if ( name.Last() == _T('\\') )
364 {
365 // chop off the last (back)slash
366 name.Truncate(name.length() - 1);
367 }
368 }
369 }
370
371 return name;
372 }
373
374 wxDir::~wxDir()
375 {
376 delete M_DIR;
377 } // end of wxDir::~wxDir
378
379 // ----------------------------------------------------------------------------
380 // wxDir enumerating
381 // ----------------------------------------------------------------------------
382
383 bool wxDir::GetFirst(
384 wxString* psFilename
385 , const wxString& rsFilespec
386 , int nFlags
387 ) const
388 {
389 wxCHECK_MSG( IsOpened(), FALSE, _T("must wxDir::Open() first") );
390 M_DIR->Rewind();
391 M_DIR->SetFileSpec(rsFilespec);
392 M_DIR->SetFlags(nFlags);
393 return GetNext(psFilename);
394 } // end of wxDir::GetFirst
395
396 bool wxDir::GetNext(
397 wxString* psFilename
398 ) const
399 {
400 wxCHECK_MSG( IsOpened(), FALSE, _T("must wxDir::Open() first") );
401 wxCHECK_MSG( psFilename, FALSE, _T("bad pointer in wxDir::GetNext()") );
402 return M_DIR->Read(psFilename);
403 } // end of wxDir::GetNext
404