summaryrefslogtreecommitdiffstats
path: root/ingen/Serialiser.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'ingen/Serialiser.hpp')
-rw-r--r--ingen/Serialiser.hpp105
1 files changed, 105 insertions, 0 deletions
diff --git a/ingen/Serialiser.hpp b/ingen/Serialiser.hpp
new file mode 100644
index 00000000..16a7a912
--- /dev/null
+++ b/ingen/Serialiser.hpp
@@ -0,0 +1,105 @@
+/*
+ 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_SERIALISER_HPP
+#define INGEN_SERIALISER_HPP
+
+#include <stdexcept>
+#include <string>
+
+#include "ingen/Properties.hpp"
+#include "ingen/ingen.h"
+#include "ingen/types.hpp"
+#include "sord/sordmm.hpp"
+
+namespace Raul { class Path; }
+
+namespace ingen {
+
+class Arc;
+class Node;
+class URI;
+class World;
+
+/**
+ Serialiser for writing graphs to Turtle files or strings.
+
+ @ingroup Ingen
+*/
+class INGEN_API Serialiser
+{
+public:
+ explicit Serialiser(World& world);
+ virtual ~Serialiser();
+
+ /** Write a graph and all its contents as a complete bundle. */
+ virtual void write_bundle(SPtr<const Node> graph,
+ const URI& uri);
+
+ /** Begin a serialization to a string.
+ *
+ * This must be called before any serializing methods.
+ *
+ * The results of the serialization will be returned by the finish() method after
+ * the desired objects have been serialised.
+ *
+ * All serialized paths will have the root path chopped from their prefix
+ * (therefore all serialized paths must be descendants of the root)
+ */
+ virtual void start_to_string(const Raul::Path& root,
+ const URI& base_uri);
+
+ /** Begin a serialization to a file.
+ *
+ * This must be called before any serializing methods.
+ *
+ * All serialized paths will have the root path chopped from their prefix
+ * (therefore all serialized paths must be descendants of the root)
+ */
+ virtual void start_to_file(const Raul::Path& root,
+ const std::string& filename);
+
+ /** Serialize an object (graph, block, or port).
+ *
+ * @throw std::logic_error
+ */
+ virtual void serialise(SPtr<const Node> object,
+ Property::Graph context = Property::Graph::DEFAULT);
+
+ /** Serialize an arc.
+ *
+ * @throw std::logic_error
+ */
+ virtual void serialise_arc(const Sord::Node& parent,
+ SPtr<const Arc> arc);
+
+ /** Finish serialization.
+ *
+ * If this is a file serialization, this must be called to finish and close
+ * the output file, and the empty string is returned.
+ *
+ * If this is a string serialization, the serialized result is returned.
+ */
+ virtual std::string finish();
+
+private:
+ struct Impl;
+ Impl* me;
+};
+
+} // namespace ingen
+
+#endif // INGEN_SERIALISER_HPP