directory_scanner.h Source File - ClanLib SDK
Description: directory_scanner.h Source File

directory_scanner.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 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
33namespace clan
34{
37
38 class DirectoryScanner_Impl;
39
55 class DirectoryScanner
56 {
57 public:
59 DirectoryScanner();
60
62 ~DirectoryScanner();
63
65
66 std::string get_directory_path();
67
69
70 std::string get_name();
71
73
74 int get_size();
75
77
78 std::string get_pathname();
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}
clan::DirectoryScanner
Directory scanning class.
Definition directory_scanner.h:56
clan::DirectoryScanner::get_name
std::string get_name()
Gets the name of the current file.
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::get_directory_path
std::string get_directory_path()
Gets the directory being scanned.
clan::DirectoryScanner::get_pathname
std::string get_pathname()
Gets the pathname of the current file.
clan::DirectoryScanner::get_size
int get_size()
Gets the size of the current file.
clan::DirectoryScanner::is_directory
bool is_directory()
Returns true if the current file is a directory.
clan::DirectoryScanner::scan
bool scan(const std::string &pathname, const std::string &pattern)
Selects the directory to scan through.
clan::DirectoryScanner::DirectoryScanner
DirectoryScanner()
Constructs directory scanner for iterating over a directory.
clan::DirectoryScanner::is_hidden
bool is_hidden()
Returns true if the file is hidden.
clan::DirectoryScanner::~DirectoryScanner
~DirectoryScanner()
Destructor.
clan::DirectoryScanner::next
bool next()
Find next file in directory scan.
clan::DirectoryScanner::is_writable
bool is_writable()
Returns true if the file is writable by the current user.
clan
Definition clanapp.h:36