Factor out text writing from socket writing

5 files changed, 186 insertions, 101 deletions

diff --git a/ingen/SocketWriter.hpp b/ingen/SocketWriter.hpp
index bb5c332b..871a63f5 100644
--- a/ingen/SocketWriter.hpp
+++ b/ingen/SocketWriter.hpp
@@ -19,20 +19,14 @@
 
 #include <stdint.h>
 
-#include "ingen/AtomSink.hpp"
-#include "ingen/AtomWriter.hpp"
-#include "ingen/Interface.hpp"
-#include "ingen/types.hpp"
-#include "ingen/ingen.h"
+#include "ingen/TurtleWriter.hpp"
 #include "raul/Socket.hpp"
-#include "raul/URI.hpp"
-#include "sratom/sratom.h"
 
 namespace Ingen {
 
 /** An Interface that writes Turtle messages to a socket.
  */
-class INGEN_API SocketWriter : public AtomWriter, public AtomSink
+class INGEN_API SocketWriter : public TurtleWriter
 {
 public:
 	SocketWriter(URIMap&            map,
@@ -40,24 +34,12 @@ public:
 	             const Raul::URI&   uri,
 	             SPtr<Raul::Socket> sock);
 
-	~SocketWriter();
-
-	bool write(const LV2_Atom* msg);
+	size_t text_sink(const void* buf, size_t len) override;
 
+	/** Override of bundle_end to terminate bundles in the stream. */
 	void bundle_end();
 
-	int         fd()        { return _socket->fd(); }
-	Raul::URI   uri() const { return _uri; }
-	SerdWriter* writer()    { return _writer; }
-
 protected:
-	URIMap&            _map;
-	Sratom*            _sratom;
-	SerdNode           _base;
-	SerdURI            _base_uri;
-	SerdEnv*           _env;
-	SerdWriter*        _writer;
-	Raul::URI          _uri;
 	SPtr<Raul::Socket> _socket;
 };
 
diff --git a/ingen/TurtleWriter.hpp b/ingen/TurtleWriter.hpp
new file mode 100644
index 00000000..4ce10f3c
--- /dev/null
+++ b/ingen/TurtleWriter.hpp
@@ -0,0 +1,67 @@
+/*
+  This file is part of Ingen.
+  Copyright 2012-2016 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_TURTLE_WRITER_HPP
+#define INGEN_TURTLE_WRITER_HPP
+
+#include <stdint.h>
+
+#include "ingen/AtomSink.hpp"
+#include "ingen/AtomWriter.hpp"
+#include "ingen/Interface.hpp"
+#include "ingen/types.hpp"
+#include "ingen/ingen.h"
+#include "raul/URI.hpp"
+#include "sratom/sratom.h"
+
+namespace Ingen {
+
+/** An Interface that writes Turtle messages to a sink method.
+ *
+ * Derived classes must implement text_sink() to do something with the
+ * serialized messages.
+ */
+class INGEN_API TurtleWriter : public AtomWriter, public AtomSink
+{
+public:
+	TurtleWriter(URIMap&          map,
+	             URIs&            uris,
+	             const Raul::URI& uri);
+
+	virtual ~TurtleWriter();
+
+	/** AtomSink method which receives calls serialized to LV2 atoms. */
+	bool write(const LV2_Atom* msg);
+
+	/** Pure virtual text sink which receives calls serialized to Turtle. */
+	virtual size_t text_sink(const void* buf, size_t len) = 0;
+
+	Raul::URI uri() const { return _uri; }
+
+protected:
+	URIMap&     _map;
+	Sratom*     _sratom;
+	SerdNode    _base;
+	SerdURI     _base_uri;
+	SerdEnv*    _env;
+	SerdWriter* _writer;
+	Raul::URI   _uri;
+	bool        _wrote_prefixes;
+};
+
+}  // namespace Ingen
+
+#endif  // INGEN_TURTLE_WRITER_HPP
diff --git a/src/SocketWriter.cpp b/src/SocketWriter.cpp
index f58207de..1a628ac0 100644
--- a/src/SocketWriter.cpp
+++ b/src/SocketWriter.cpp
@@ -19,107 +19,39 @@
 #include <sys/socket.h>
 
 #include "ingen/SocketWriter.hpp"
-#include "ingen/URIMap.hpp"
 
 #ifndef MSG_NOSIGNAL
 #    define MSG_NOSIGNAL 0
 #endif
 
-#define USTR(s) ((const uint8_t*)(s))
-
 namespace Ingen {
 
-static size_t
-socket_sink(const void* buf, size_t len, void* stream)
-{
-	SocketWriter* writer = (SocketWriter*)stream;
-	ssize_t       ret    = send(writer->fd(), buf, len, MSG_NOSIGNAL);
-	if (ret < 0) {
-		return 0;
-	}
-	return ret;
-}
-
-static SerdStatus
-write_prefix(void* handle, const SerdNode* name, const SerdNode* uri)
-{
-	SocketWriter* writer = (SocketWriter*)handle;
-	serd_writer_set_prefix(writer->writer(), name, uri);
-	return SERD_SUCCESS;
-}
-
 SocketWriter::SocketWriter(URIMap&            map,
                            URIs&              uris,
                            const Raul::URI&   uri,
                            SPtr<Raul::Socket> sock)
-	: AtomWriter(map, uris, *this)
-	, _map(map)
-	, _sratom(sratom_new(&map.urid_map_feature()->urid_map))
-	, _uri(uri)
+	: TurtleWriter(map, uris, uri)
 	, _socket(sock)
-{
-	// Use <ingen:/> as base URI, so relative URIs are like bundle paths
-	_base = serd_node_from_string(SERD_URI, (const uint8_t*)"ingen:/");
-
-	serd_uri_parse(_base.buf, &_base_uri);
+{}
 
-	// Set up serialisation environment
-	_env = serd_env_new(&_base);
-	serd_env_set_prefix_from_strings(_env, USTR("atom"),  USTR("http://lv2plug.in/ns/ext/atom#"));
-	serd_env_set_prefix_from_strings(_env, USTR("doap"),  USTR("http://usefulinc.com/ns/doap#"));
-	serd_env_set_prefix_from_strings(_env, USTR("ingen"), USTR(INGEN_NS));
-	serd_env_set_prefix_from_strings(_env, USTR("lv2"),   USTR("http://lv2plug.in/ns/lv2core#"));
-	serd_env_set_prefix_from_strings(_env, USTR("midi"),  USTR("http://lv2plug.in/ns/ext/midi#"));
-	serd_env_set_prefix_from_strings(_env, USTR("owl"),   USTR("http://www.w3.org/2002/07/owl#"));
-	serd_env_set_prefix_from_strings(_env, USTR("patch"), USTR("http://lv2plug.in/ns/ext/patch#"));
-	serd_env_set_prefix_from_strings(_env, USTR("rdf"),   USTR("http://www.w3.org/1999/02/22-rdf-syntax-ns#"));
-	serd_env_set_prefix_from_strings(_env, USTR("rdfs"),  USTR("http://www.w3.org/2000/01/rdf-schema#"));
-	serd_env_set_prefix_from_strings(_env, USTR("xsd"),   USTR("http://www.w3.org/2001/XMLSchema#"));
-
-	// Make a Turtle writer that writes directly to the socket
-	_writer = serd_writer_new(
-		SERD_TURTLE,
-		(SerdStyle)(SERD_STYLE_RESOLVED|SERD_STYLE_ABBREVIATED|SERD_STYLE_CURIED),
-		_env,
-		&_base_uri,
-		socket_sink,
-		this);
-
-	// Write namespace prefixes to reduce traffic
-	serd_env_foreach(_env, write_prefix, this);
-
-	// Configure sratom to write directly to the writer (and thus the socket)
-	sratom_set_sink(_sratom,
-	                (const char*)_base.buf,
-	                (SerdStatementSink)serd_writer_write_statement,
-	                (SerdEndSink)serd_writer_end_anon,
-	                _writer);
-}
-
-SocketWriter::~SocketWriter()
-{
-	sratom_free(_sratom);
-	serd_writer_free(_writer);
-	serd_env_free(_env);
-}
-
-bool
-SocketWriter::write(const LV2_Atom* msg)
+size_t
+SocketWriter::text_sink(const void* buf, size_t len)
 {
-	sratom_write(_sratom, &_map.urid_unmap_feature()->urid_unmap, 0,
-	             NULL, NULL, msg->type, msg->size, LV2_ATOM_BODY_CONST(msg));
-	serd_writer_finish(_writer);
-	return true;
+	ssize_t ret = send(_socket->fd(), buf, len, MSG_NOSIGNAL);
+	if (ret < 0) {
+		return 0;
+	}
+	return ret;
 }
 
 void
 SocketWriter::bundle_end()
 {
-	AtomWriter::bundle_end();
+	TurtleWriter::bundle_end();
 
 	// Send a NULL byte to indicate end of bundle
 	const char end[] = { 0 };
-	send(fd(), end, 1, MSG_NOSIGNAL);
+	send(_socket->fd(), end, 1, MSG_NOSIGNAL);
 }
 
 } // namespace Ingen
diff --git a/src/TurtleWriter.cpp b/src/TurtleWriter.cpp
new file mode 100644
index 00000000..7ee4a43f
--- /dev/null
+++ b/src/TurtleWriter.cpp
@@ -0,0 +1,103 @@
+/*
+  This file is part of Ingen.
+  Copyright 2012-2016 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/>.
+*/
+
+#include "ingen/TurtleWriter.hpp"
+#include "ingen/URIMap.hpp"
+
+#define USTR(s) ((const uint8_t*)(s))
+
+namespace Ingen {
+
+static size_t
+c_text_sink(const void* buf, size_t len, void* stream)
+{
+	TurtleWriter* writer = (TurtleWriter*)stream;
+	return writer->text_sink(buf, len);
+}
+
+static SerdStatus
+write_prefix(void* handle, const SerdNode* name, const SerdNode* uri)
+{
+	serd_writer_set_prefix((SerdWriter*)handle, name, uri);
+	return SERD_SUCCESS;
+}
+
+TurtleWriter::TurtleWriter(URIMap&          map,
+                           URIs&            uris,
+                           const Raul::URI& uri)
+	: AtomWriter(map, uris, *this)
+	, _map(map)
+	, _sratom(sratom_new(&map.urid_map_feature()->urid_map))
+	, _uri(uri)
+	, _wrote_prefixes(false)
+{
+	// Use <ingen:/> as base URI, so relative URIs are like bundle paths
+	_base = serd_node_from_string(SERD_URI, (const uint8_t*)"ingen:/");
+	serd_uri_parse(_base.buf, &_base_uri);
+
+	// Set up serialisation environment
+	_env = serd_env_new(&_base);
+	serd_env_set_prefix_from_strings(_env, USTR("atom"),  USTR("http://lv2plug.in/ns/ext/atom#"));
+	serd_env_set_prefix_from_strings(_env, USTR("doap"),  USTR("http://usefulinc.com/ns/doap#"));
+	serd_env_set_prefix_from_strings(_env, USTR("ingen"), USTR(INGEN_NS));
+	serd_env_set_prefix_from_strings(_env, USTR("lv2"),   USTR("http://lv2plug.in/ns/lv2core#"));
+	serd_env_set_prefix_from_strings(_env, USTR("midi"),  USTR("http://lv2plug.in/ns/ext/midi#"));
+	serd_env_set_prefix_from_strings(_env, USTR("owl"),   USTR("http://www.w3.org/2002/07/owl#"));
+	serd_env_set_prefix_from_strings(_env, USTR("patch"), USTR("http://lv2plug.in/ns/ext/patch#"));
+	serd_env_set_prefix_from_strings(_env, USTR("rdf"),   USTR("http://www.w3.org/1999/02/22-rdf-syntax-ns#"));
+	serd_env_set_prefix_from_strings(_env, USTR("rdfs"),  USTR("http://www.w3.org/2000/01/rdf-schema#"));
+	serd_env_set_prefix_from_strings(_env, USTR("xsd"),   USTR("http://www.w3.org/2001/XMLSchema#"));
+
+	// Make a Turtle writer that writes to text_sink
+	_writer = serd_writer_new(
+		SERD_TURTLE,
+		(SerdStyle)(SERD_STYLE_RESOLVED|SERD_STYLE_ABBREVIATED|SERD_STYLE_CURIED),
+		_env,
+		&_base_uri,
+		c_text_sink,
+		this);
+
+	// Configure sratom to write directly to the writer (and thus text_sink)
+	sratom_set_sink(_sratom,
+	                (const char*)_base.buf,
+	                (SerdStatementSink)serd_writer_write_statement,
+	                (SerdEndSink)serd_writer_end_anon,
+	                _writer);
+}
+
+TurtleWriter::~TurtleWriter()
+{
+	sratom_free(_sratom);
+	serd_writer_free(_writer);
+	serd_env_free(_env);
+}
+
+bool
+TurtleWriter::write(const LV2_Atom* msg)
+{
+	if (!_wrote_prefixes) {
+		// Write namespace prefixes once to reduce traffic
+		serd_env_foreach(_env, write_prefix, _writer);
+		_wrote_prefixes = true;
+	}
+
+	sratom_write(_sratom, &_map.urid_unmap_feature()->urid_unmap, 0,
+	             NULL, NULL, msg->type, msg->size, LV2_ATOM_BODY_CONST(msg));
+	serd_writer_finish(_writer);
+	return true;
+}
+
+} // namespace Ingen
diff --git a/src/wscript b/src/wscript
index 18340c80..b43c8928 100644
--- a/src/wscript
+++ b/src/wscript
@@ -14,6 +14,7 @@ def build(bld):
         'Resource.cpp',
         'Serialiser.cpp',
         'Store.cpp',
+        'TurtleWriter.cpp',
         'URIMap.cpp',
         'URIs.cpp',
         'World.cpp',