From 9d7c1e971d51561c4bb28fa1064503e5f266908f Mon Sep 17 00:00:00 2001 From: David Robillard Date: Tue, 24 Feb 2015 09:20:22 +0000 Subject: Demodularize Parser and Serialiser. git-svn-id: http://svn.drobilla.net/lad/trunk/ingen@5606 a436a847-0d15-0410-975c-d299462d15a1 --- src/serialisation/Parser.cpp | 655 ------------------------------------ src/serialisation/Serialiser.cpp | 547 ------------------------------ src/serialisation/serialisation.cpp | 43 --- src/serialisation/wscript | 30 -- 4 files changed, 1275 deletions(-) delete mode 100644 src/serialisation/Parser.cpp delete mode 100644 src/serialisation/Serialiser.cpp delete mode 100644 src/serialisation/serialisation.cpp delete mode 100644 src/serialisation/wscript (limited to 'src/serialisation') diff --git a/src/serialisation/Parser.cpp b/src/serialisation/Parser.cpp deleted file mode 100644 index 663a7833..00000000 --- a/src/serialisation/Parser.cpp +++ /dev/null @@ -1,655 +0,0 @@ -/* - This file is part of Ingen. - Copyright 2007-2012 David Robillard - - 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 . -*/ - -#include -#include -#include -#include - -#include -#include -#include - -#include "ingen/Atom.hpp" -#include "ingen/Interface.hpp" -#include "ingen/Log.hpp" -#include "ingen/URIMap.hpp" -#include "ingen/URIs.hpp" -#include "ingen/World.hpp" -#include "ingen/serialisation/Parser.hpp" -#include "lv2/lv2plug.in/ns/ext/atom/atom.h" -#include "serd/serd.h" -#include "sord/sordmm.hpp" -#include "sratom/sratom.h" - -using namespace std; - -typedef set RDFNodes; - -namespace Ingen { -namespace Serialisation { - -static std::string -relative_uri(const std::string& base, const std::string& uri, bool leading_slash) -{ - std::string ret; - if (uri != base) { - SerdURI base_uri; - serd_uri_parse((const uint8_t*)base.c_str(), &base_uri); - - SerdURI normal_base_uri; - SerdNode normal_base_uri_node = serd_node_new_uri_from_string( - (const uint8_t*)".", &base_uri, &normal_base_uri); - - std::string normal_base_str((const char*)normal_base_uri_node.buf); - - ret = uri; - if (uri.length() >= normal_base_str.length() - && uri.substr(0, normal_base_str.length()) == normal_base_str) { - ret = uri.substr(normal_base_str.length()); - } - - serd_node_free(&normal_base_uri_node); - } - - if (leading_slash && ret[0] != '/') { - ret = std::string("/").append(ret); - } - return ret; -} - -static std::string -get_basename(const std::string& uri) -{ - std::string ret = Glib::path_get_basename(uri); - ret = ret.substr(0, ret.find_last_of('.')); - return ret; -} - -static bool -skip_property(Ingen::URIs& uris, const Sord::Node& predicate) -{ - return (predicate.to_string() == INGEN__file || - predicate.to_string() == uris.ingen_arc || - predicate.to_string() == uris.ingen_block || - predicate.to_string() == uris.lv2_port); -} - -static Resource::Properties -get_properties(Ingen::World* world, - Sord::Model& model, - const Sord::Node& subject) -{ - SerdChunk out = { NULL, 0 }; - LV2_URID_Map* map = &world->uri_map().urid_map_feature()->urid_map; - LV2_URID_Unmap* unmap = &world->uri_map().urid_unmap_feature()->urid_unmap; - Sratom* sratom = sratom_new(map); - - LV2_Atom_Forge forge; - lv2_atom_forge_init(&forge, map); - lv2_atom_forge_set_sink(&forge, sratom_forge_sink, sratom_forge_deref, &out); - - const Sord::Node nil; - Resource::Properties props; - for (Sord::Iter i = model.find(subject, nil, nil); !i.end(); ++i) { - if (!skip_property(world->uris(), i.get_predicate())) { - out.len = 0; - sratom_read(sratom, &forge, world->rdf_world()->c_obj(), - model.c_obj(), i.get_object().c_obj()); - const LV2_Atom* atom = (const LV2_Atom*)out.buf; - Atom atomm; - // FIXME: Don't bloat out all URIs - if (atom->type == forge.URID) { - atomm = world->forge().alloc_uri( - unmap->unmap(unmap->handle, - ((const LV2_Atom_URID*)atom)->body)); - } else { - atomm = world->forge().alloc( - atom->size, atom->type, LV2_ATOM_BODY_CONST(atom)); - } - props.insert(make_pair(Raul::URI(i.get_predicate().to_string()), - atomm)); - } - } - - free((uint8_t*)out.buf); - sratom_free(sratom); - return props; -} - -typedef std::pair PortRecord; - -static boost::optional -get_port(Ingen::World* world, - Sord::Model& model, - const Sord::Node& subject, - const Raul::Path& parent, - uint32_t* index) -{ - const URIs& uris = world->uris(); - - // Get all properties - Resource::Properties props = get_properties(world, model, subject); - - // Get index if requested (for Graphs) - if (index) { - Resource::Properties::const_iterator i = props.find(uris.lv2_index); - if (i == props.end() - || i->second.type() != world->forge().Int - || i->second.get() < 0) { - world->log().error(fmt("Port %1% has no valid index\n") % subject); - return boost::optional(); - } - *index = i->second.get(); - } - - // Get symbol - Resource::Properties::const_iterator s = props.find(uris.lv2_symbol); - std::string sym; - if (s != props.end()) { - sym = s->second.ptr(); - } else { - const std::string subject_str = subject.to_string(); - const size_t last_slash = subject_str.find_last_of("/"); - - sym = ((last_slash == string::npos) - ? subject_str - : subject_str.substr(last_slash + 1)); - } - - if (!Raul::Symbol::is_valid(sym)) { - world->log().error(fmt("Port %1% has invalid symbol `%2%'\n") - % subject % sym); - return boost::optional(); - } - - const Raul::Symbol port_sym(sym); - const Raul::Path port_path(parent.child(port_sym)); - - return make_pair(port_path, props); -} - -static boost::optional -parse( - World* world, - Interface* target, - Sord::Model& model, - const std::string& base_uri, - Sord::Node& subject, - boost::optional parent = boost::optional(), - boost::optional symbol = boost::optional(), - boost::optional data = boost::optional()); - -static boost::optional -parse_graph( - World* world, - Interface* target, - Sord::Model& model, - const std::string& base_uri, - const Sord::Node& subject, - boost::optional parent = boost::optional(), - boost::optional symbol = boost::optional(), - boost::optional data = boost::optional()); - -static boost::optional -parse_block( - World* world, - Interface* target, - Sord::Model& model, - const std::string& base_uri, - const Sord::Node& subject, - const Raul::Path& path, - boost::optional data = boost::optional()); - -static bool -parse_properties( - World* world, - Interface* target, - Sord::Model& model, - const Sord::Node& subject, - const Raul::URI& uri, - boost::optional data = boost::optional()); - -static bool -parse_arcs( - World* world, - Interface* target, - Sord::Model& model, - const std::string& base_uri, - const Sord::Node& subject, - const Raul::Path& graph); - -static boost::optional -parse_block(Ingen::World* world, - Ingen::Interface* target, - Sord::Model& model, - const std::string& base_uri, - const Sord::Node& subject, - const Raul::Path& path, - boost::optional data) -{ - const URIs& uris = world->uris(); - - const Sord::URI ingen_prototype(*world->rdf_world(), uris.ingen_prototype); - const Sord::Node nil; - - Sord::Iter i = model.find(subject, ingen_prototype, nil); - if (i.end() || i.get_object().type() != Sord::Node::URI) { - if (!i.end()) { - std::cerr << "type: " << i.get_object().type() << std::endl; - } - world->log().error( - fmt("Block %1% (%2%) missing mandatory ingen:prototype\n") % - subject.to_string() % path); - return boost::optional(); - } - - const std::string type_uri = relative_uri(base_uri, - i.get_object().to_string(), - false); - - if (!serd_uri_string_has_scheme((const uint8_t*)type_uri.c_str())) { - SerdURI base_uri_parts; - serd_uri_parse((const uint8_t*)base_uri.c_str(), &base_uri_parts); - - SerdURI ignored; - SerdNode sub_uri = serd_node_new_uri_from_string( - i.get_object().to_u_string(), - &base_uri_parts, - &ignored); - - const std::string sub_uri_str = (const char*)sub_uri.buf; - const std::string basename = get_basename(sub_uri_str); - const std::string sub_file = sub_uri_str + '/' + basename + ".ttl"; - - const SerdNode sub_base = serd_node_from_string( - SERD_URI, (const uint8_t*)sub_file.c_str()); - - Sord::Model sub_model(*world->rdf_world(), sub_file); - SerdEnv* env = serd_env_new(&sub_base); - sub_model.load_file(env, SERD_TURTLE, sub_file); - serd_env_free(env); - - Sord::URI sub_node(*world->rdf_world(), sub_file); - parse_graph(world, target, sub_model, (const char*)sub_base.buf, sub_node, - path.parent(), Raul::Symbol(path.symbol())); - - parse_graph(world, target, model, base_uri, subject, - path.parent(), Raul::Symbol(path.symbol())); - } else { - Resource::Properties props = get_properties(world, model, subject); - props.insert(make_pair(uris.rdf_type, - uris.forge.alloc_uri(uris.ingen_Block))); - target->put(Node::path_to_uri(path), props); - } - return path; -} - -static boost::optional -parse_graph(Ingen::World* world, - Ingen::Interface* target, - Sord::Model& model, - const std::string& base_uri, - const Sord::Node& subject_node, - boost::optional parent, - boost::optional a_symbol, - boost::optional data) -{ - const URIs& uris = world->uris(); - - const Sord::URI ingen_block(*world->rdf_world(), uris.ingen_block); - const Sord::URI ingen_polyphony(*world->rdf_world(), uris.ingen_polyphony); - const Sord::URI lv2_port(*world->rdf_world(), LV2_CORE__port); - - const Sord::Node& graph = subject_node; - const Sord::Node nil; - - Raul::Symbol symbol("_"); - if (a_symbol) { - symbol = *a_symbol; - } - - string graph_path_str = relative_uri(base_uri, subject_node.to_string(), true); - if (parent && a_symbol) { - graph_path_str = parent->child(*a_symbol); - } else if (parent) { - graph_path_str = *parent; - } - - if (!Raul::Path::is_valid(graph_path_str)) { - world->log().error(fmt("Graph %1% has invalid path\n") - % graph_path_str); - return boost::optional(); - } - - // Create graph - Raul::Path graph_path(graph_path_str); - Resource::Properties props = get_properties(world, model, subject_node); - target->put(Node::path_to_uri(graph_path), props); - - // For each block in this graph - for (Sord::Iter n = model.find(subject_node, ingen_block, nil); !n.end(); ++n) { - Sord::Node node = n.get_object(); - const Raul::Path block_path = graph_path.child( - Raul::Symbol(get_basename(node.to_string()))); - - // Parse and create block - parse_block(world, target, model, base_uri, node, block_path, - boost::optional()); - - // For each port on this block - for (Sord::Iter p = model.find(node, lv2_port, nil); !p.end(); ++p) { - Sord::Node port = p.get_object(); - - // Get all properties - boost::optional port_record = get_port( - world, model, port, block_path, NULL); - if (!port_record) { - world->log().error(fmt("Invalid port %1%\n") % port); - return boost::optional(); - } - - // Create port and/or set all port properties - target->put(Node::path_to_uri(port_record->first), - port_record->second); - } - } - - // For each port on this graph - typedef std::map PortRecords; - PortRecords ports; - for (Sord::Iter p = model.find(graph, lv2_port, nil); !p.end(); ++p) { - Sord::Node port = p.get_object(); - - // Get all properties - uint32_t index = 0; - boost::optional port_record = get_port( - world, model, port, graph_path, &index); - if (!port_record) { - world->log().error(fmt("Invalid port %1%\n") % port); - return boost::optional(); - } - - // Store port information in ports map - ports[index] = *port_record; - } - - // Create ports in order by index - for (const auto& p : ports) { - target->put(Node::path_to_uri(p.second.first), - p.second.second); - } - - parse_arcs(world, target, model, base_uri, subject_node, graph_path); - - return graph_path; -} - -static bool -parse_arc(Ingen::World* world, - Ingen::Interface* target, - Sord::Model& model, - const std::string& base_uri, - const Sord::Node& subject, - const Raul::Path& graph) -{ - const URIs& uris = world->uris(); - - const Sord::URI ingen_tail(*world->rdf_world(), uris.ingen_tail); - const Sord::URI ingen_head(*world->rdf_world(), uris.ingen_head); - const Sord::Node nil; - - Sord::Iter t = model.find(subject, ingen_tail, nil); - Sord::Iter h = model.find(subject, ingen_head, nil); - - if (t.end()) { - world->log().error("Arc has no tail"); - return false; - } else if (h.end()) { - world->log().error("Arc has no head"); - return false; - } - - const std::string tail_str = relative_uri( - base_uri, t.get_object().to_string(), true); - if (!Raul::Path::is_valid(tail_str)) { - world->log().error("Arc tail has invalid URI"); - return false; - } - - const std::string head_str = relative_uri( - base_uri, h.get_object().to_string(), true); - if (!Raul::Path::is_valid(head_str)) { - world->log().error("Arc head has invalid URI"); - return false; - } - - if (!(++t).end()) { - world->log().error("Arc has multiple tails"); - return false; - } else if (!(++h).end()) { - world->log().error("Arc has multiple heads"); - return false; - } - - target->connect(graph.child(Raul::Path(tail_str)), - graph.child(Raul::Path(head_str))); - - return true; -} - -static bool -parse_arcs(Ingen::World* world, - Ingen::Interface* target, - Sord::Model& model, - const std::string& base_uri, - const Sord::Node& subject, - const Raul::Path& graph) -{ - const Sord::URI ingen_arc(*world->rdf_world(), world->uris().ingen_arc); - const Sord::Node nil; - - for (Sord::Iter i = model.find(subject, ingen_arc, nil); !i.end(); ++i) { - parse_arc(world, target, model, base_uri, i.get_object(), graph); - } - - return true; -} - -static bool -parse_properties(Ingen::World* world, - Ingen::Interface* target, - Sord::Model& model, - const Sord::Node& subject, - const Raul::URI& uri, - boost::optional data) -{ - Resource::Properties properties = get_properties(world, model, subject); - - target->put(uri, properties); - - // Set passed properties last to override any loaded values - if (data) - target->put(uri, data.get()); - - return true; -} - -static boost::optional -parse(Ingen::World* world, - Ingen::Interface* target, - Sord::Model& model, - const std::string& base_uri, - Sord::Node& subject, - boost::optional parent, - boost::optional symbol, - boost::optional data) -{ - const URIs& uris = world->uris(); - - const Sord::URI graph_class (*world->rdf_world(), uris.ingen_Graph); - const Sord::URI block_class (*world->rdf_world(), uris.ingen_Block); - const Sord::URI arc_class (*world->rdf_world(), uris.ingen_Arc); - const Sord::URI internal_class(*world->rdf_world(), uris.ingen_Internal); - const Sord::URI in_port_class (*world->rdf_world(), LV2_CORE__InputPort); - const Sord::URI out_port_class(*world->rdf_world(), LV2_CORE__OutputPort); - const Sord::URI lv2_class (*world->rdf_world(), LV2_CORE__Plugin); - const Sord::URI rdf_type (*world->rdf_world(), uris.rdf_type); - const Sord::Node nil; - - // Parse explicit subject graph - if (subject.is_valid()) { - return parse_graph(world, target, model, base_uri, subject, parent, symbol, data); - } - - // Get all subjects and their types (?subject a ?type) - typedef std::map< Sord::Node, std::set > Subjects; - Subjects subjects; - for (Sord::Iter i = model.find(subject, rdf_type, nil); !i.end(); ++i) { - const Sord::Node& subject = i.get_subject(); - const Sord::Node& rdf_class = i.get_object(); - - assert(rdf_class.is_uri()); - Subjects::iterator s = subjects.find(subject); - if (s == subjects.end()) { - std::set types; - types.insert(rdf_class); - subjects.insert(make_pair(subject, types)); - } else { - s->second.insert(rdf_class); - } - } - - // Parse and create each subject - for (const auto& i : subjects) { - const Sord::Node& s = i.first; - const std::set& types = i.second; - boost::optional ret; - const Raul::Path rel_path(relative_uri(base_uri, s.to_string(), true)); - const Raul::Path path = parent ? parent->child(rel_path) : rel_path; - if (types.find(graph_class) != types.end()) { - ret = parse_graph(world, target, model, base_uri, s, parent, symbol, data); - } else if (types.find(block_class) != types.end()) { - ret = parse_block(world, target, model, base_uri, s, path, data); - } else if (types.find(in_port_class) != types.end() || - types.find(out_port_class) != types.end()) { - parse_properties( - world, target, model, s, Node::path_to_uri(path), data); - ret = path; - } else if (types.find(arc_class) != types.end()) { - Raul::Path parent_path(parent ? parent.get() : Raul::Path("/")); - parse_arc(world, target, model, base_uri, s, parent_path); - } else { - world->log().error("Subject has no known types\n"); - } - } - - return boost::optional(); -} - -/** Parse a graph from RDF into a Interface (engine or client). - * @return whether or not load was successful. - */ -bool -Parser::parse_file(Ingen::World* world, - Ingen::Interface* target, - const std::string& path, - boost::optional parent, - boost::optional symbol, - boost::optional data) -{ - std::string file_path = path; - if (!Glib::path_is_absolute(file_path)) { - file_path = Glib::build_filename(Glib::get_current_dir(), file_path); - } - if (Glib::file_test(file_path, Glib::FILE_TEST_IS_DIR)) { - // This is a bundle, append "/name.ttl" to get graph file path - file_path = Glib::build_filename(path, get_basename(path) + ".ttl"); - } - - std::string uri; - try { - uri = Glib::filename_to_uri(file_path, ""); - } catch (const Glib::ConvertError& e) { - world->log().error(fmt("Path to URI conversion error: %1%\n") - % e.what()); - return false; - } - - const uint8_t* uri_c_str = (const uint8_t*)uri.c_str(); - SerdNode base_node = serd_node_from_string(SERD_URI, uri_c_str); - SerdEnv* env = serd_env_new(&base_node); - - // Load graph file into model - Sord::Model model(*world->rdf_world(), uri, SORD_SPO|SORD_PSO, false); - model.load_file(env, SERD_TURTLE, uri); - - serd_env_free(env); - - world->log().info(fmt("Parsing %1%\n") % file_path); - if (parent) - world->log().info(fmt("Parent: %1%\n") % parent->c_str()); - if (symbol) - world->log().info(fmt("Symbol: %1%\n") % symbol->c_str()); - - Sord::Node subject(*world->rdf_world(), Sord::Node::URI, uri); - boost::optional parsed_path - = parse(world, target, model, model.base_uri().to_string(), - subject, parent, symbol, data); - - if (parsed_path) { - target->set_property(Node::path_to_uri(*parsed_path), - Raul::URI(INGEN__file), - world->forge().alloc_uri(uri)); - return true; - } else { - world->log().warn("Document URI lost\n"); - return false; - } -} - -boost::optional -Parser::parse_string(Ingen::World* world, - Ingen::Interface* target, - const std::string& str, - const std::string& base_uri, - boost::optional parent, - boost::optional symbol, - boost::optional data) -{ - // Load string into model - Sord::Model model(*world->rdf_world(), base_uri, SORD_SPO|SORD_PSO, false); - - SerdEnv* env = serd_env_new(NULL); - if (!base_uri.empty()) { - const SerdNode base = serd_node_from_string( - SERD_URI, (const uint8_t*)base_uri.c_str()); - serd_env_set_base_uri(env, &base); - } - model.load_string(env, SERD_TURTLE, str.c_str(), str.length(), base_uri); - - Raul::URI actual_base((const char*)serd_env_get_base_uri(env, NULL)->buf); - serd_env_free(env); - - world->log().info(fmt("Parsing string (base %1%)\n") % base_uri); - - Sord::Node subject; - parse(world, target, model, actual_base, subject, parent, symbol, data); - return actual_base; -} - -} // namespace Serialisation -} // namespace Ingen diff --git a/src/serialisation/Serialiser.cpp b/src/serialisation/Serialiser.cpp deleted file mode 100644 index 775736ae..00000000 --- a/src/serialisation/Serialiser.cpp +++ /dev/null @@ -1,547 +0,0 @@ -/* - This file is part of Ingen. - Copyright 2007-2012 David Robillard - - 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 . -*/ - -#include -#include - -#include -#include -#include -#include - -#include -#include -#include -#include -#include -#include - -#include "ingen/Arc.hpp" -#include "ingen/Interface.hpp" -#include "ingen/Log.hpp" -#include "ingen/Node.hpp" -#include "ingen/Plugin.hpp" -#include "ingen/Resource.hpp" -#include "ingen/Store.hpp" -#include "ingen/URIMap.hpp" -#include "ingen/URIs.hpp" -#include "ingen/World.hpp" -#include "ingen/serialisation/Serialiser.hpp" -#include "lv2/lv2plug.in/ns/ext/state/state.h" -#include "lv2/lv2plug.in/ns/extensions/ui/ui.h" -#include "raul/Path.hpp" -#include "sord/sordmm.hpp" -#include "sratom/sratom.h" - -using namespace std; -using namespace Sord; -using namespace Ingen; - -namespace Ingen { -namespace Serialisation { - -struct Serialiser::Impl { - typedef Resource::Properties Properties; - - explicit Impl(World& world) - : _root_path("/") - , _world(world) - , _model(NULL) - , _sratom(sratom_new(&_world.uri_map().urid_map_feature()->urid_map)) - {} - - ~Impl() { - sratom_free(_sratom); - } - - enum class Mode { TO_FILE, TO_STRING }; - - void start_to_filename(const std::string& filename); - - void serialise_graph(SPtr p, - const Sord::Node& id); - - void serialise_block(SPtr n, - const Sord::Node& class_id, - const Sord::Node& id); - - void serialise_port(const Node* p, - Resource::Graph context, - const Sord::Node& id); - - void serialise_properties(Sord::Node id, - const Resource::Properties& props); - - void write_bundle(SPtr graph, - const std::string& uri); - - Sord::Node path_rdf_node(const Raul::Path& path); - - void write_manifest(const std::string& bundle_path, - SPtr graph, - const std::string& graph_symbol); - - void serialise_arc(const Sord::Node& parent, - SPtr a) - throw (std::logic_error); - - std::string finish(); - - Raul::Path _root_path; - Mode _mode; - std::string _base_uri; - World& _world; - Sord::Model* _model; - Sratom* _sratom; -}; - -Serialiser::Serialiser(World& world) - : me(new Impl(world)) -{} - -Serialiser::~Serialiser() -{ - delete me; -} - -void -Serialiser::Impl::write_manifest(const std::string& bundle_path, - SPtr graph, - const std::string& graph_symbol) -{ - const string manifest_path(Glib::build_filename(bundle_path, "manifest.ttl")); - const string binary_path(Glib::Module::build_path("", "ingen_lv2")); - - start_to_filename(manifest_path); - - Sord::World& world = _model->world(); - const URIs& uris = _world.uris(); - - const string filename(graph_symbol + ".ttl"); - const Sord::URI subject(world, filename, _base_uri); - - _model->add_statement(subject, - Sord::URI(world, uris.rdf_type), - Sord::URI(world, uris.ingen_Graph)); - _model->add_statement(subject, - Sord::URI(world, uris.rdf_type), - Sord::URI(world, uris.lv2_Plugin)); - _model->add_statement(subject, - Sord::URI(world, uris.rdfs_seeAlso), - Sord::URI(world, filename, _base_uri)); - _model->add_statement(subject, - Sord::URI(world, uris.lv2_prototype), - Sord::URI(world, uris.ingen_GraphPrototype)); - - finish(); -} - -void -Serialiser::write_bundle(SPtr graph, - const std::string& path) -{ - me->write_bundle(graph, path); -} - -void -Serialiser::Impl::write_bundle(SPtr graph, - const std::string& a_path) -{ - std::string path = Glib::filename_from_uri(a_path); - if (Glib::file_test(path, Glib::FILE_TEST_EXISTS) - && !Glib::file_test(path, Glib::FILE_TEST_IS_DIR)) { - path = Glib::path_get_dirname(path); - } - - _world.log().info(fmt("Writing bundle %1%\n") % path); - - if (path[path.length() - 1] != '/') - path.append("/"); - - g_mkdir_with_parents(path.c_str(), 0744); - - string symbol = Glib::path_get_basename(path); - symbol = symbol.substr(0, symbol.find(".")); - - const string root_file = Glib::build_filename(path, symbol + ".ttl"); - - start_to_filename(root_file); - const Raul::Path old_root_path = _root_path; - _root_path = graph->path(); - serialise_graph(graph, Sord::URI(_model->world(), root_file, _base_uri)); - _root_path = old_root_path; - finish(); - - write_manifest(path, graph, symbol); -} - -/** Begin a serialization to a file. - * - * This must be called before any serializing methods. - */ -void -Serialiser::Impl::start_to_filename(const string& filename) -{ - assert(filename.find(":") == string::npos || filename.substr(0, 5) == "file:"); - if (filename.find(":") == string::npos) { - _base_uri = "file://" + filename; - } else { - _base_uri = filename; - } - - _model = new Sord::Model(*_world.rdf_world(), _base_uri); - _mode = Mode::TO_FILE; -} - -void -Serialiser::start_to_string(const Raul::Path& root, const string& base_uri) -{ - me->_root_path = root; - me->_base_uri = base_uri; - me->_model = new Sord::Model(*me->_world.rdf_world(), base_uri); - me->_mode = Impl::Mode::TO_STRING; -} - -void -Serialiser::start_to_file(const Raul::Path& root, const string& filename) -{ - me->_root_path = root; - me->start_to_filename(filename); -} - -std::string -Serialiser::finish() -{ - return me->finish(); -} - -std::string -Serialiser::Impl::finish() -{ - string ret = ""; - if (_mode == Mode::TO_FILE) { - SerdStatus st = _model->write_to_file(_base_uri, SERD_TURTLE); - if (st) { - _world.log().error(fmt("Error writing file %1% (%2%)\n") - % _base_uri % serd_strerror(st)); - } - } else { - ret = _model->write_to_string(_base_uri, SERD_TURTLE); - } - - delete _model; - _model = NULL; - _base_uri = ""; - - return ret; -} - -Sord::Node -Serialiser::Impl::path_rdf_node(const Raul::Path& path) -{ - assert(_model); - assert(path == _root_path || path.is_child_of(_root_path)); - return Sord::URI(_model->world(), - path.substr(_root_path.base().length()), - _base_uri); -} - -void -Serialiser::serialise(SPtr object) throw (std::logic_error) -{ - if (!me->_model) - throw std::logic_error("serialise called without serialisation in progress"); - - if (object->graph_type() == Node::GraphType::GRAPH) { - me->serialise_graph(object, me->path_rdf_node(object->path())); - } else if (object->graph_type() == Node::GraphType::BLOCK) { - const Sord::URI plugin_id(me->_model->world(), object->plugin()->uri()); - me->serialise_block(object, plugin_id, me->path_rdf_node(object->path())); - } else if (object->graph_type() == Node::GraphType::PORT) { - me->serialise_port(object.get(), - Resource::Graph::DEFAULT, - me->path_rdf_node(object->path())); - } else { - me->serialise_properties(me->path_rdf_node(object->path()), - object->properties()); - } -} - -void -Serialiser::Impl::serialise_graph(SPtr graph, - const Sord::Node& graph_id) -{ - Sord::World& world = _model->world(); - const URIs& uris = _world.uris(); - - _model->add_statement(graph_id, - Sord::URI(world, uris.rdf_type), - Sord::URI(world, uris.ingen_Graph)); - - _model->add_statement(graph_id, - Sord::URI(world, uris.rdf_type), - Sord::URI(world, uris.lv2_Plugin)); - - _model->add_statement(graph_id, - Sord::URI(world, uris.lv2_extensionData), - Sord::URI(world, LV2_STATE__interface)); - - _model->add_statement(graph_id, - Sord::URI(world, LV2_UI__ui), - Sord::URI(world, "http://drobilla.net/ns/ingen#GraphUIGtk2")); - - // Always write a symbol (required by Ingen) - Raul::Symbol symbol("_"); - Node::Properties::const_iterator s = graph->properties().find(uris.lv2_symbol); - if (s == graph->properties().end() - || s->second.type() != _world.forge().String - || !Raul::Symbol::is_valid(s->second.ptr())) { - const std::string base = Glib::path_get_basename( - _model->base_uri().to_c_string()); - symbol = Raul::Symbol::symbolify(base.substr(0, base.find('.'))); - _model->add_statement( - graph_id, - Sord::URI(world, uris.lv2_symbol), - Sord::Literal(world, symbol.c_str())); - } else { - symbol = Raul::Symbol::symbolify(s->second.ptr()); - } - - // If the graph has no doap:name (required by LV2), use the symbol - if (graph->properties().find(uris.doap_name) == graph->properties().end()) - _model->add_statement(graph_id, - Sord::URI(world, uris.doap_name), - Sord::Literal(world, symbol.c_str())); - - const Node::Properties props = graph->properties(Resource::Graph::INTERNAL); - serialise_properties(graph_id, props); - - const Store::const_range kids = _world.store()->children_range(graph); - for (Store::const_iterator n = kids.first; n != kids.second; ++n) { - if (n->first.parent() != graph->path()) - continue; - - if (n->second->graph_type() == Node::GraphType::GRAPH) { - SPtr subgraph = n->second; - - SerdURI base_uri; - serd_uri_parse((const uint8_t*)_base_uri.c_str(), &base_uri); - - const string sub_bundle_path = subgraph->path().substr(1) + ".ingen"; - - SerdURI subgraph_uri; - SerdNode subgraph_node = serd_node_new_uri_from_string( - (const uint8_t*)sub_bundle_path.c_str(), - &base_uri, - &subgraph_uri); - - const Sord::URI subgraph_id(world, (const char*)subgraph_node.buf); - - // Save our state - std::string my_base_uri = _base_uri; - Sord::Model* my_model = _model; - - // Write child bundle within this bundle - write_bundle(subgraph, subgraph_id.to_string()); - - // Restore our state - _base_uri = my_base_uri; - _model = my_model; - - // Serialise reference to graph block - const Sord::Node block_id(path_rdf_node(subgraph->path())); - _model->add_statement(graph_id, - Sord::URI(world, uris.ingen_block), - block_id); - serialise_block(subgraph, subgraph_id, block_id); - } else if (n->second->graph_type() == Node::GraphType::BLOCK) { - SPtr block = n->second; - - const Sord::URI class_id(world, block->plugin()->uri()); - const Sord::Node block_id(path_rdf_node(n->second->path())); - _model->add_statement(graph_id, - Sord::URI(world, uris.ingen_block), - block_id); - serialise_block(block, class_id, block_id); - } - } - - for (uint32_t i = 0; i < graph->num_ports(); ++i) { - Node* p = graph->port(i); - const Sord::Node port_id = path_rdf_node(p->path()); - - // Ensure lv2:name always exists so Graph is a valid LV2 plugin - if (p->properties().find(uris.lv2_name) == p->properties().end()) - p->set_property(uris.lv2_name, - _world.forge().alloc(p->symbol().c_str())); - - _model->add_statement(graph_id, - Sord::URI(world, LV2_CORE__port), - port_id); - serialise_port(p, Resource::Graph::INTERNAL, port_id); - } - - for (const auto& a : graph->arcs()) { - serialise_arc(graph_id, a.second); - } -} - -void -Serialiser::Impl::serialise_block(SPtr block, - const Sord::Node& class_id, - const Sord::Node& block_id) -{ - const URIs& uris = _world.uris(); - - _model->add_statement(block_id, - Sord::URI(_model->world(), uris.rdf_type), - Sord::URI(_model->world(), uris.ingen_Block)); - _model->add_statement(block_id, - Sord::URI(_model->world(), uris.ingen_prototype), - class_id); - - const Node::Properties props = block->properties(Resource::Graph::EXTERNAL); - serialise_properties(block_id, props); - - for (uint32_t i = 0; i < block->num_ports(); ++i) { - Node* const p = block->port(i); - const Sord::Node port_id = path_rdf_node(p->path()); - serialise_port(p, Resource::Graph::EXTERNAL, port_id); - _model->add_statement(block_id, - Sord::URI(_model->world(), uris.lv2_port), - port_id); - } -} - -void -Serialiser::Impl::serialise_port(const Node* port, - Resource::Graph context, - const Sord::Node& port_id) -{ - URIs& uris = _world.uris(); - Sord::World& world = _model->world(); - Node::Properties props = port->properties(context); - - if (context == Resource::Graph::INTERNAL) { - // Always write lv2:symbol for Graph ports (required for lv2:Plugin) - _model->add_statement(port_id, - Sord::URI(world, uris.lv2_symbol), - Sord::Literal(world, port->path().symbol())); - } else { - // Never write lv2:index for plugin instances (not persistent/stable) - props.erase(uris.lv2_index); - } - - if (context == Resource::Graph::INTERNAL && - port->has_property(uris.rdf_type, uris.lv2_ControlPort) && - port->has_property(uris.rdf_type, uris.lv2_InputPort)) - { - const Atom& val = port->get_property(uris.ingen_value); - if (val.is_valid()) { - props.insert(make_pair(uris.lv2_default, val)); - } else { - _world.log().warn("Control input has no value, lv2:default omitted.\n"); - } - } else if (context != Resource::Graph::INTERNAL && - !port->has_property(uris.rdf_type, uris.lv2_InputPort)) { - props.erase(uris.ingen_value); - } - - serialise_properties(port_id, props); -} - -void -Serialiser::serialise_arc(const Sord::Node& parent, - SPtr arc) - throw (std::logic_error) -{ - return me->serialise_arc(parent, arc); -} - -void -Serialiser::Impl::serialise_arc(const Sord::Node& parent, - SPtr arc) - throw (std::logic_error) -{ - if (!_model) - throw std::logic_error( - "serialise_arc called without serialisation in progress"); - - Sord::World& world = _model->world(); - const URIs& uris = _world.uris(); - - const Sord::Node src = path_rdf_node(arc->tail_path()); - const Sord::Node dst = path_rdf_node(arc->head_path()); - const Sord::Node arc_id = Sord::Node::blank_id(*_world.rdf_world()); - _model->add_statement(arc_id, - Sord::URI(world, uris.ingen_tail), - src); - _model->add_statement(arc_id, - Sord::URI(world, uris.ingen_head), - dst); - - if (parent.is_valid()) { - _model->add_statement(parent, - Sord::URI(world, uris.ingen_arc), - arc_id); - } else { - _model->add_statement(arc_id, - Sord::URI(world, uris.rdf_type), - Sord::URI(world, uris.ingen_Arc)); - } -} - -static bool -skip_property(Ingen::URIs& uris, const Sord::Node& predicate) -{ - return (predicate.to_string() == INGEN__file || - predicate.to_string() == uris.ingen_arc || - predicate.to_string() == uris.ingen_block || - predicate.to_string() == uris.lv2_port); -} - -void -Serialiser::Impl::serialise_properties(Sord::Node id, - const Node::Properties& props) -{ - LV2_URID_Unmap* unmap = &_world.uri_map().urid_unmap_feature()->urid_unmap; - SerdNode base = serd_node_from_string(SERD_URI, - (const uint8_t*)_base_uri.c_str()); - SerdEnv* env = serd_env_new(&base); - SordInserter* inserter = sord_inserter_new(_model->c_obj(), env); - - sratom_set_sink(_sratom, _base_uri.c_str(), - (SerdStatementSink)sord_inserter_write_statement, NULL, - inserter); - - sratom_set_pretty_numbers(_sratom, true); - - for (const auto& p : props) { - const Sord::URI key(_model->world(), p.first); - if (!skip_property(_world.uris(), key)) { - sratom_write(_sratom, unmap, 0, - sord_node_to_serd_node(id.c_obj()), - sord_node_to_serd_node(key.c_obj()), - p.second.type(), p.second.size(), p.second.get_body()); - } - } - - sord_inserter_free(inserter); - serd_env_free(env); -} - -} // namespace Serialisation -} // namespace Ingen diff --git a/src/serialisation/serialisation.cpp b/src/serialisation/serialisation.cpp deleted file mode 100644 index b335845e..00000000 --- a/src/serialisation/serialisation.cpp +++ /dev/null @@ -1,43 +0,0 @@ -/* - This file is part of Ingen. - Copyright 2007-2012 David Robillard - - 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 . -*/ - -#include "ingen/Module.hpp" -#include "ingen/World.hpp" - -#include "ingen/serialisation/Parser.hpp" -#include "ingen/serialisation/Serialiser.hpp" - -using namespace Ingen; - -struct IngenSerialisationModule : public Ingen::Module { - virtual void load(Ingen::World* world) { - world->set_parser( - SPtr( - new Serialisation::Parser())); - world->set_serialiser( - SPtr( - new Serialisation::Serialiser(*world))); - } -}; - -extern "C" { - -Ingen::Module* -ingen_module_load() { - return new IngenSerialisationModule(); -} - -} // extern "C" diff --git a/src/serialisation/wscript b/src/serialisation/wscript deleted file mode 100644 index 82aeffd4..00000000 --- a/src/serialisation/wscript +++ /dev/null @@ -1,30 +0,0 @@ -#!/usr/bin/env python -from waflib.extras import autowaf as autowaf - -def build(bld): - obj = bld(features = 'c cshlib cxx cxxshlib', - source = ['Parser.cpp', - 'Serialiser.cpp', - 'serialisation.cpp'], - export_includes = ['../..'], - includes = ['.', '../..'], - name = 'libingen_serialisation', - target = 'ingen_serialisation', - install_path = '${LIBDIR}', - use = 'libingen') - autowaf.use_lib(bld, obj, 'GLIBMM LV2 LILV RAUL SERD SORD SRATOM') - - if bld.env.BUILD_TESTS: - obj = bld(features = 'c cshlib cxx cxxshlib', - source = ['Parser.cpp', - 'Serialiser.cpp', - 'serialisation.cpp'], - export_includes = ['../..'], - includes = ['.', '../..'], - name = 'libingen_serialisation_profiled', - target = 'ingen_serialisation_profiled', - install_path = '', - use = 'libingen_profiled', - lib = bld.env.INGEN_TEST_LIBS, - cxxflags = bld.env.INGEN_TEST_CXXFLAGS) - autowaf.use_lib(bld, obj, 'GLIBMM LV2 LILV RAUL SERD SORD SRATOM') -- cgit v1.2.1