1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
/*
Ousía
Copyright (C) 2014, 2015 Benjamin Paaßen, Andreas Stöckel
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _OUSIA_FILE_LOCATOR_HPP_
#define _OUSIA_FILE_LOCATOR_HPP_
#include <core/ResourceLocator.hpp>
#include <map>
#include <set>
#include <vector>
#include <boost/filesystem/path.hpp>
namespace ousia {
/**
* A ResourceLocator is a class able to locate resources in some way, usually
* on the hard drive.
*
* We specify this as an abstract superclass to have an interface layer between
* the program core and possible future extensions in terms of resource
* locations (e.g. online resources, .zip files, etc.).
*/
class FileLocator : public ResourceLocator {
private:
std::map<ResourceLocator::Type, std::vector<boost::filesystem::path>> searchPaths;
public:
FileLocator() : searchPaths() {}
/**
* Adds a search paths for the given types.
*
* @param path is a fully qualified/canonical path to a directory.
* @param types is a set of Resource Types. The FileLocator will look for
* resources of the specified types at the given path in the
* future.
*/
void addSearchPath(const boost::filesystem::path &path,
std::set<ResourceLocator::Type> types);
/**
* Returns the backing map containing all search paths for a given type.
* This is read-only.
*/
const std::map<ResourceLocator::Type, std::vector<boost::filesystem::path>> &
getSearchPaths() const
{
return searchPaths;
}
Location locate(const std::string &path, const std::string &relativeTo,
const Type type) const override;
std::unique_ptr<std::istream> stream(
const std::string &location) const override;
};
}
#endif /* _OUSIA_FILE_LOCATOR_HPP_ */
|
