directory_scanner.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2016 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 */
28 
29 #pragma once
30 
31 #include <memory>
32 
33 namespace clan
34 {
37 
38  class DirectoryScanner_Impl;
39 
56  {
57  public:
60 
63 
65 
67 
69 
71 
73 
74  int get_size();
75 
77 
79 
81 
82  bool is_directory();
83 
85 
86  bool is_hidden();
87 
89 
90  bool is_readable();
91 
93 
94  bool is_writable();
95 
97 
100  bool scan(const std::string& pathname);
101 
103 
109  bool scan(const std::string& pathname, const std::string& pattern);
110 
112 
113  bool next();
114 
115  private:
116  std::shared_ptr<DirectoryScanner_Impl> impl;
117  };
118 
120 }
Directory scanning class.
Definition: directory_scanner.h:55
Definition: clanapp.h:35
std::string get_name()
Gets the name of the current file.
bool is_directory()
Returns true if the current file is a directory.
DirectoryScanner()
Constructs directory scanner for iterating over a directory.
bool next()
Find next file in directory scan.
int get_size()
Gets the size of the current file.
bool is_hidden()
Returns true if the file is hidden.
std::string get_pathname()
Gets the pathname of the current file.
bool scan(const std::string &pathname)
Selects the directory to scan through.
bool is_writable()
Returns true if the file is writable by the current user.
~DirectoryScanner()
Destructor.
std::string get_directory_path()
Gets the directory being scanned.
bool is_readable()
Returns true if the file is readable by the current user.