libcommonc++  0.7
FileTraverser.h++
Go to the documentation of this file.
1 /* ---------------------------------------------------------------------------
2  commonc++ - A C++ Common Class Library
3  Copyright (C) 2005-2014 Mark A Lindner
4 
5  This file is part of commonc++.
6 
7  This library is free software; you can redistribute it and/or
8  modify it under the terms of the GNU Library General Public
9  License as published by the Free Software Foundation; either
10  version 2 of the License, or (at your option) any later version.
11 
12  This library is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  Library General Public License for more details.
16 
17  You should have received a copy of the GNU Library General Public
18  License along with this library; if not, write to the Free
19  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  ---------------------------------------------------------------------------
21 */
22 
23 #ifndef __ccxx_FileTraverser_hxx
24 #define __ccxx_FileTraverser_hxx
25 
26 #include <commonc++/FileName.h++>
28 #include <commonc++/RegExp.h++>
29 #include <commonc++/String.h++>
30 
31 namespace ccxx {
32 
42 {
43  public:
44 
52  FileTraverser(const String& basePath, bool depthFirst = true);
53 
55  virtual ~FileTraverser();
56 
64  inline void setPrunePattern(const RegExp& pattern)
65  { _prunePattern = pattern; }
66 
73  bool traverse();
74 
75  protected:
76 
86  virtual bool processFile(const FileName& name, bool isDir, uint_t depth) = 0;
87 
98  virtual bool handleError(const FileName& name, const IOException& ex);
99 
100  private:
101 
102  bool _traverse(FileName& filename, uint_t depth);
103 
104  String _baseDir;
105  bool _depthFirst;
106  RegExp _prunePattern;
107 };
108 
109 } // namespace ccxx
110 
111 #endif // __ccxx_FileTraverser_hxx
void setPrunePattern(const RegExp &pattern)
Set a prune pattern for the traverser.
Definition: FileTraverser.h++:64
An exception indicating an I/O error.
Definition: IOException.h++:36
A regular expression.
Definition: RegExp.h++:75
unsigned int uint_t
An alias for unsigned int.
Definition: Integers.h++:74
A depth- or breadth-first file traverser.
Definition: FileTraverser.h++:41
#define COMMONCPP_API
Definition: Common.h++:126
A flexible, reference counted, copy-on-write, thread-safe, nullable string.
Definition: String.h++:50
A class representing a filename.
Definition: FileName.h++:55
Definition: AllocationMap.c++:25