Move public headers to a separate include directory

This is more conventional and probably best practice (since it avoids polluting
the include path with non-headers), and is supported by the clang-tidy
llvm-header-guard check.

1 files changed, 99 insertions, 0 deletions

diff --git a/include/ingen/Parser.hpp b/include/ingen/Parser.hpp
new file mode 100644
index 00000000..45d087cd
--- /dev/null
+++ b/include/ingen/Parser.hpp
@@ -0,0 +1,99 @@
+/*
+  This file is part of Ingen.
+  Copyright 2007-2015 David Robillard <http://drobilla.net/>
+
+  Ingen is free software: you can redistribute it and/or modify it under the
+  terms of the GNU Affero General Public License as published by the Free
+  Software Foundation, either version 3 of the License, or any later version.
+
+  Ingen 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 Affero General Public License for details.
+
+  You should have received a copy of the GNU Affero General Public License
+  along with Ingen.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef INGEN_PARSER_HPP
+#define INGEN_PARSER_HPP
+
+#include "ingen/FilePath.hpp"
+#include "ingen/Properties.hpp"
+#include "ingen/URI.hpp"
+#include "ingen/ingen.h"
+#include "raul/Path.hpp"
+#include "raul/Symbol.hpp"
+
+#include <boost/optional/optional.hpp>
+
+#include <set>
+#include <string>
+#include <utility>
+
+namespace Sord { class World; }
+
+namespace ingen {
+
+class Interface;
+class World;
+
+/**
+   Parser for reading graphs from Turtle files or strings.
+
+   @ingroup Ingen
+*/
+class INGEN_API Parser {
+public:
+	explicit Parser() = default;
+
+	virtual ~Parser() = default;
+
+	/** Record of a resource listed in a bundle manifest. */
+	struct ResourceRecord {
+		inline ResourceRecord(URI u, FilePath f)
+			: uri(std::move(u)), filename(std::move(f))
+		{}
+
+		inline bool operator<(const ResourceRecord& r) const {
+			return uri < r.uri;
+		}
+
+		URI      uri;       ///< URI of resource (e.g. a Graph)
+		FilePath filename;  ///< Path of describing file (seeAlso)
+	};
+
+	/** Find all resources of a given type listed in a manifest file. */
+	virtual std::set<ResourceRecord> find_resources(Sord::World& world,
+	                                                const URI&   manifest_uri,
+	                                                const URI&   type_uri);
+
+	/** Parse a graph from RDF into a Interface (engine or client).
+	 *
+	 * If `path` is a file path, then the graph is loaded from that
+	 * file.  If it is a directory, then the manifest.ttl from that directory
+	 * is used instead.  In either case, any rdfs:seeAlso files are loaded and
+	 * the graph parsed from the resulting combined model.
+	 *
+	 * @return whether or not load was successful.
+	 */
+	virtual bool parse_file(
+		World&                               world,
+		Interface&                           target,
+		const FilePath&                      path,
+		const boost::optional<Raul::Path>&   parent = boost::optional<Raul::Path>(),
+		const boost::optional<Raul::Symbol>& symbol = boost::optional<Raul::Symbol>(),
+		const boost::optional<Properties>&   data   = boost::optional<Properties>());
+
+	virtual boost::optional<URI> parse_string(
+		World&                               world,
+		Interface&                           target,
+		const std::string&                   str,
+		const URI&                           base_uri,
+		const boost::optional<Raul::Path>&   parent = boost::optional<Raul::Path>(),
+		const boost::optional<Raul::Symbol>& symbol = boost::optional<Raul::Symbol>(),
+		const boost::optional<Properties>&   data   = boost::optional<Properties>());
+};
+
+} // namespace ingen
+
+#endif // INGEN_PARSER_HPP