summaryrefslogtreecommitdiff
path: root/src/plugins/boost/FileLocator.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/plugins/boost/FileLocator.hpp')
-rw-r--r--src/plugins/boost/FileLocator.hpp64
1 files changed, 64 insertions, 0 deletions
diff --git a/src/plugins/boost/FileLocator.hpp b/src/plugins/boost/FileLocator.hpp
new file mode 100644
index 0000000..50a77db
--- /dev/null
+++ b/src/plugins/boost/FileLocator.hpp
@@ -0,0 +1,64 @@
+/*
+ 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 <map>
+#include <set>
+
+#include <core/ResourceLocator.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:
+ map<ResourceLocator::Type, std::vector<std::string>> 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 std::string &path,
+ std::set<ResourceLocator::Type> types);
+
+ 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_ */
+