|
0
|
1 /* |
|
|
2 * directory.h -- open and read directories |
|
|
3 * |
|
|
4 * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> |
|
|
5 * |
|
|
6 * Permission to use, copy, modify, and/or distribute this software for any |
|
|
7 * purpose with or without fee is hereby granted, provided that the above |
|
|
8 * copyright notice and this permission notice appear in all copies. |
|
|
9 * |
|
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
|
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
|
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
|
|
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
|
|
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
|
|
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
|
|
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
|
17 */ |
|
|
18 |
|
|
19 #ifndef _DIRECTORY_H_ |
|
|
20 #define _DIRECTORY_H_ |
|
|
21 |
|
|
22 #include <cstddef> |
|
|
23 #include <string> |
|
|
24 #include <vector> |
|
|
25 |
|
|
26 namespace irccd { |
|
|
27 |
|
|
28 /** |
|
|
29 * @class Entry |
|
|
30 * @brief entry in the directory list |
|
|
31 */ |
|
|
32 class DirectoryEntry { |
|
|
33 public: |
|
|
34 /** |
|
|
35 * @enum Type |
|
|
36 * @brief Describe the type of an entry |
|
|
37 */ |
|
|
38 enum Type { |
|
|
39 Unknown = 0, |
|
|
40 File, |
|
|
41 Dir, |
|
|
42 Link |
|
|
43 }; |
|
|
44 |
|
|
45 std::string name; //! name of entry (base name) |
|
|
46 Type type{Unknown}; //! type of file |
|
|
47 |
|
|
48 friend bool operator==(const DirectoryEntry &e1, const DirectoryEntry &e2); |
|
|
49 }; |
|
|
50 |
|
|
51 /** |
|
|
52 * @class Directory |
|
|
53 * @brief class to manipulate directories |
|
|
54 * |
|
|
55 * This class allow the user to iterate directories in a for range based |
|
|
56 * loop using iterators. |
|
|
57 */ |
|
|
58 class Directory { |
|
|
59 public: |
|
|
60 /** |
|
|
61 * @enum Flags |
|
|
62 * @brief optional flags to read directories |
|
|
63 */ |
|
|
64 enum Flags { |
|
|
65 Dot = (1 << 0), //!< If set, lists "." too |
|
|
66 DotDot = (1 << 1) //!< If set, lists ".." too |
|
|
67 }; |
|
|
68 |
|
|
69 using List = std::vector<DirectoryEntry>; |
|
|
70 |
|
|
71 // C++ Container compatibility |
|
|
72 using value_type = List::value_type; |
|
|
73 using iterator = List::iterator; |
|
|
74 using const_iterator = List::const_iterator; |
|
|
75 |
|
|
76 private: |
|
|
77 List m_list; |
|
|
78 |
|
|
79 void systemLoad(const std::string &path, int flags); |
|
|
80 |
|
|
81 public: |
|
|
82 /** |
|
|
83 * Default constructor, does nothing. |
|
|
84 */ |
|
|
85 Directory(); |
|
|
86 |
|
|
87 /** |
|
|
88 * Open a directory and read all its content. |
|
|
89 * @param path the path |
|
|
90 * @param flags the optional flags |
|
|
91 */ |
|
|
92 Directory(const std::string &path, int flags = 0); |
|
|
93 |
|
|
94 /** |
|
|
95 * Virtual destructor defaulted. |
|
|
96 */ |
|
|
97 virtual ~Directory() = default; |
|
|
98 |
|
|
99 /** |
|
|
100 * Return an iterator the beginning. |
|
|
101 * |
|
|
102 * @return the iterator |
|
|
103 */ |
|
|
104 List::iterator begin(); |
|
|
105 |
|
|
106 /** |
|
|
107 * Return a const iterator the beginning. |
|
|
108 * |
|
|
109 * @return the iterator |
|
|
110 */ |
|
|
111 List::const_iterator cbegin() const; |
|
|
112 |
|
|
113 /** |
|
|
114 * Return an iterator to past the end. |
|
|
115 * |
|
|
116 * @return the iterator |
|
|
117 */ |
|
|
118 List::iterator end(); |
|
|
119 |
|
|
120 /** |
|
|
121 * Return a const iterator to past the end. |
|
|
122 * |
|
|
123 * @return the iterator |
|
|
124 */ |
|
|
125 List::const_iterator cend() const; |
|
|
126 |
|
|
127 /** |
|
|
128 * Get the number of entries in the directory. |
|
|
129 * |
|
|
130 * @return the number |
|
|
131 */ |
|
|
132 int count() const; |
|
|
133 |
|
|
134 friend bool operator==(const Directory &d1, const Directory &d2); |
|
|
135 }; |
|
|
136 |
|
|
137 } // !irccd |
|
|
138 |
|
|
139 #endif // !_DIRECTORY_H_ |
