From 1b29d7799c32b7be8bc563d2b21349115be04e6e Mon Sep 17 00:00:00 2001 From: David Robillard Date: Tue, 24 May 2011 23:48:12 +0000 Subject: Move appropriate client headers to public include directory. git-svn-id: http://svn.drobilla.net/lad/trunk/ingen@3319 a436a847-0d15-0410-975c-d299462d15a1 --- include/ingen/client/SigClientInterface.hpp | 125 ++++++++++++++++++++++++++++ 1 file changed, 125 insertions(+) create mode 100644 include/ingen/client/SigClientInterface.hpp (limited to 'include/ingen/client/SigClientInterface.hpp') diff --git a/include/ingen/client/SigClientInterface.hpp b/include/ingen/client/SigClientInterface.hpp new file mode 100644 index 00000000..2241425b --- /dev/null +++ b/include/ingen/client/SigClientInterface.hpp @@ -0,0 +1,125 @@ +/* This file is part of Ingen. + * Copyright 2007-2011 David Robillard + * + * 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_CLIENT_SIGCLIENTINTERFACE_HPP +#define INGEN_CLIENT_SIGCLIENTINTERFACE_HPP + +#include + +#include "raul/Path.hpp" + +#include "ingen/ClientInterface.hpp" +#include "ingen/client/signal.hpp" + +namespace Ingen { +namespace Client { + +/** A LibSigC++ signal emitting interface for clients to use. + * + * This simply emits a signal for every event that comes from the engine. + * For a higher level model based view of the engine, use ClientStore. + * + * The signals here match the calls to ClientInterface exactly. See the + * documentation for ClientInterface for meanings of signal parameters. + */ +class SigClientInterface : public Ingen::ClientInterface, + public INGEN_TRACKABLE +{ +public: + SigClientInterface() {} + + Raul::URI uri() const { return "http://drobilla.net/ns/ingen#internal"; } + + INGEN_SIGNAL(response_ok, void, int32_t) + INGEN_SIGNAL(response_error, void, int32_t, std::string) + INGEN_SIGNAL(bundle_begin, void) + INGEN_SIGNAL(bundle_end, void) + INGEN_SIGNAL(error, void, std::string) + INGEN_SIGNAL(new_patch, void, Raul::Path, uint32_t) + INGEN_SIGNAL(new_port, void, Raul::Path, Raul::URI, uint32_t, bool) + INGEN_SIGNAL(put, void, Raul::URI, Resource::Properties, Resource::Graph) + INGEN_SIGNAL(delta, void, Raul::URI, Resource::Properties, Resource::Properties) + INGEN_SIGNAL(object_moved, void, Raul::Path, Raul::Path) + INGEN_SIGNAL(object_deleted, void, Raul::URI) + INGEN_SIGNAL(connection, void, Raul::Path, Raul::Path) + INGEN_SIGNAL(disconnection, void, Raul::URI, Raul::URI) + INGEN_SIGNAL(disconnect_all, void, Raul::Path, Raul::Path) + INGEN_SIGNAL(variable_change, void, Raul::URI, Raul::URI, Raul::Atom) + INGEN_SIGNAL(property_change, void, Raul::URI, Raul::URI, Raul::Atom) + INGEN_SIGNAL(port_value, void, Raul::Path, Raul::Atom) + INGEN_SIGNAL(activity, void, Raul::Path) + + /** Fire pending signals. Only does anything on derived classes (that may queue) */ + virtual bool emit_signals() { return false; } + +protected: + + // ClientInterface hooks that fire the above signals + +#define EMIT(name, ...) { _signal_ ## name (__VA_ARGS__); } + + void bundle_begin() + { EMIT(bundle_begin); } + + void bundle_end() + { EMIT(bundle_end); } + + void response_ok(int32_t id) + { EMIT(response_ok, id); } + + void response_error(int32_t id, const std::string& msg) + { EMIT(response_error, id, msg); } + + void error(const std::string& msg) + { EMIT(error, msg); } + + void put(const Raul::URI& uri, + const Resource::Properties& properties, + Resource::Graph ctx=Resource::DEFAULT) + { EMIT(put, uri, properties, ctx); } + + void delta(const Raul::URI& uri, + const Resource::Properties& remove, + const Resource::Properties& add) + { EMIT(delta, uri, remove, add); } + + void connect(const Raul::Path& src_port_path, const Raul::Path& dst_port_path) + { EMIT(connection, src_port_path, dst_port_path); } + + void del(const Raul::URI& uri) + { EMIT(object_deleted, uri); } + + void move(const Raul::Path& old_path, const Raul::Path& new_path) + { EMIT(object_moved, old_path, new_path); } + + void disconnect(const Raul::URI& src, const Raul::URI& dst) + { EMIT(disconnection, src, dst); } + + void disconnect_all(const Raul::Path& parent_patch_path, const Raul::Path& path) + { EMIT(disconnect_all, parent_patch_path, path); } + + void set_property(const Raul::URI& subject, const Raul::URI& key, const Raul::Atom& value) + { EMIT(property_change, subject, key, value); } + + void activity(const Raul::Path& port_path) + { EMIT(activity, port_path); } +}; + +} // namespace Client +} // namespace Ingen + +#endif -- cgit v1.2.1