diff options
Diffstat (limited to 'include/ingen/serialisation')
-rw-r--r-- | include/ingen/serialisation/Parser.hpp | 87 | ||||
-rw-r--r-- | include/ingen/serialisation/Serialiser.hpp | 83 |
2 files changed, 170 insertions, 0 deletions
diff --git a/include/ingen/serialisation/Parser.hpp b/include/ingen/serialisation/Parser.hpp new file mode 100644 index 00000000..3f7bcb35 --- /dev/null +++ b/include/ingen/serialisation/Parser.hpp @@ -0,0 +1,87 @@ +/* This file is part of Ingen. + * Copyright 2007-2011 David Robillard <http://drobilla.net> + * + * Ingen 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 2 of the License, or (at your option) 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 General Public License for details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef INGEN_SERIALISATION_PARSER_HPP +#define INGEN_SERIALISATION_PARSER_HPP + +#include <string> +#include <list> + +#include <boost/optional.hpp> +#include <glibmm/ustring.h> + +#include "raul/Path.hpp" +#include "serd/serd.h" + +#include "ingen/GraphObject.hpp" + +namespace Ingen { + +class CommonInterface; + +namespace Shared { class World; } + +namespace Serialisation { + +/** Parse Ingen objects from RDF. + * + * \ingroup IngenSerialisation + */ +class Parser { +public: + Parser(Shared::World& world); + + virtual ~Parser() {} + + typedef GraphObject::Properties Properties; + + virtual bool parse_file( + Shared::World* world, + CommonInterface* target, + Glib::ustring document_uri, + boost::optional<Raul::Path> parent = boost::optional<Raul::Path>(), + boost::optional<Raul::Symbol> symbol = boost::optional<Raul::Symbol>(), + boost::optional<Properties> data = boost::optional<Properties>()); + + virtual bool parse_string( + Shared::World* world, + CommonInterface* target, + const Glib::ustring& str, + const Glib::ustring& base_uri, + boost::optional<Raul::Path> parent = boost::optional<Raul::Path>(), + boost::optional<Raul::Symbol> symbol = boost::optional<Raul::Symbol>(), + boost::optional<Properties> data = boost::optional<Properties>()); + + struct PatchRecord { + PatchRecord(const Raul::URI& u, const Glib::ustring& f) + : patch_uri(u), file_uri(f) + {} + const Raul::URI patch_uri; + const Glib::ustring file_uri; + }; + + typedef std::list<PatchRecord> PatchRecords; + + virtual PatchRecords find_patches(Shared::World* world, + SerdEnv* env, + const Glib::ustring& manifest_uri); +}; + +} // namespace Serialisation +} // namespace Ingen + +#endif // INGEN_SERIALISATION_PARSER_HPP diff --git a/include/ingen/serialisation/Serialiser.hpp b/include/ingen/serialisation/Serialiser.hpp new file mode 100644 index 00000000..b4e7015b --- /dev/null +++ b/include/ingen/serialisation/Serialiser.hpp @@ -0,0 +1,83 @@ +/* This file is part of Ingen. + * Copyright 2007-2011 David Robillard <http://drobilla.net> + * + * Ingen 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 2 of the License, or (at your option) 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 General Public License for details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef INGEN_SERIALISATION_SERIALISER_HPP +#define INGEN_SERIALISATION_SERIALISER_HPP + +#include <stdexcept> +#include <string> + +#include "raul/Path.hpp" +#include "raul/SharedPtr.hpp" + +#include "sord/sordmm.hpp" + +#include "ingen/GraphObject.hpp" + +namespace Ingen { + +class Plugin; +class GraphObject; +class Patch; +class Node; +class Port; +class Connection; + +namespace Shared { class World; class Store; } + +namespace Serialisation { + +/** Serialises Ingen objects (patches, nodes, etc) to RDF. + * + * \ingroup IngenSerialisation + */ +class Serialiser +{ +public: + Serialiser(Shared::World& world, SharedPtr<Shared::Store> store); + + typedef GraphObject::Properties Properties; + + void to_file(SharedPtr<const GraphObject> object, + const std::string& filename); + + void write_bundle(SharedPtr<const Patch> patch, + const std::string& uri); + + std::string to_string(SharedPtr<const GraphObject> object, + const std::string& base_uri, + const Properties& extra_rdf); + + void start_to_string(const Raul::Path& root, + const std::string& base_uri); + + void serialise(SharedPtr<const GraphObject> object) throw (std::logic_error); + + void serialise_connection(const Sord::Node& parent, + SharedPtr<const Connection> c) throw (std::logic_error); + + std::string finish(); + +private: + struct Impl; + Impl* me; +}; + +} // namespace Serialisation +} // namespace Ingen + +#endif // INGEN_SERIALISATION_SERIALISER_HPP |