directory_scanner.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 ** (if your name is missing here, please add it)
28 */
29
30
31 #pragma once
32
33 #include <memory>
34
35 namespace clan
36 {
39
40 class DirectoryScanner_Impl;
41
57 class DirectoryScanner
58 {
61
62 public:
64 DirectoryScanner();
65
67 ~DirectoryScanner();
68
72
73 public:
75
76 std::string get_directory_path();
77
79
80 std::string get_name();
81
83
84 int get_size();
85
87
88 std::string get_pathname();
89
91
92 bool is_directory();
93
95
96 bool is_hidden();
97
99
100 bool is_readable();
101
103
104 bool is_writable();
105
109
110 public:
112
115 bool scan(const std::string& pathname);
116
118
124 bool scan(const std::string& pathname, const std::string& pattern);
125
127
128 bool next();
129
133
134 private:
135 std::shared_ptr<DirectoryScanner_Impl> impl;
137 };
138
139 }
140
clan::DirectoryScanner
Directory scanning class.
Definition: directory_scanner.h:57
clan::DirectoryScanner::is_writable
bool is_writable()
Returns true if the file is writable by the current user.
clan
Definition: clanapp.h:35
clan::DirectoryScanner::next
bool next()
Find next file in directory scan.
clan::DirectoryScanner::get_pathname
std::string get_pathname()
Gets the pathname of the current file.
clan::DirectoryScanner::is_directory
bool is_directory()
Returns true if the current file is a directory.
clan::DirectoryScanner::get_name
std::string get_name()
Gets the name of the current file.
clan::StyleTokenType::string
@ keyword
clan::DirectoryScanner::get_size
int get_size()
Gets the size of the current file.
clan::DirectoryScanner::is_hidden
bool is_hidden()
Returns true if the file is hidden.
clan::DirectoryScanner::get_directory_path
std::string get_directory_path()
Gets the directory being scanned.
clan::DirectoryScanner::is_readable
bool is_readable()
Returns true if the file is readable by the current user.
clan::DirectoryScanner::scan
bool scan(const std::string &pathname)
Selects the directory to scan through.
clan::DirectoryScanner::~DirectoryScanner
~DirectoryScanner()
Destructor.
clan::DirectoryScanner::DirectoryScanner
DirectoryScanner()
Constructs directory scanner for iterating over a directory.