/*
  This file is part of Ingen.
  Copyright 2007-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_CLIENT_SIGCLIENTINTERFACE_HPP
#define INGEN_CLIENT_SIGCLIENTINTERFACE_HPP

#include <stdint.h>

#include <string>

#include "raul/Path.hpp"

#include "ingen/Interface.hpp"
#include "ingen/client/signal.hpp"
#include "ingen/ingen.h"

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.
 *
 * @ingroup IngenClient
 */
class INGEN_API SigClientInterface : public Ingen::Interface,
                                     public INGEN_TRACKABLE
{
public:
	SigClientInterface() {}

	Raul::URI uri() const { return Raul::URI("ingen:/clients/sig"); }

	INGEN_SIGNAL(response, void, int32_t, Status, std::string)
	INGEN_SIGNAL(bundle_begin, void)
	INGEN_SIGNAL(bundle_end, void)
	INGEN_SIGNAL(error, void, std::string)
	INGEN_SIGNAL(put, void, Raul::URI, Properties, Resource::Graph)
	INGEN_SIGNAL(delta, void, Raul::URI, Properties, Properties, Resource::Graph)
	INGEN_SIGNAL(object_copied, void, Raul::URI, Raul::URI)
	INGEN_SIGNAL(object_moved, void, Raul::Path, Raul::Path)
	INGEN_SIGNAL(object_deleted, void, Raul::URI, Properties)
	INGEN_SIGNAL(connection, void, Raul::Path, Raul::Path)
	INGEN_SIGNAL(disconnection, void, Raul::Path, Raul::Path)
	INGEN_SIGNAL(disconnect_all, void, Raul::Path, Raul::Path)
	INGEN_SIGNAL(property_change, void, Raul::URI, Raul::URI, Atom, Resource::Graph)

	/** 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(int32_t id, Status status, const std::string& subject)
	{ EMIT(response, id, status, subject); }

	void error(const std::string& msg)
	{ EMIT(error, msg); }

	void put(const Raul::URI&  uri,
	         const Properties& properties,
	         Resource::Graph   ctx = Resource::Graph::DEFAULT)
	{ EMIT(put, uri, properties, ctx); }

	void delta(const Raul::URI&  uri,
	           const Properties& remove,
	           const Properties& add,
	           Resource::Graph   ctx = Resource::Graph::DEFAULT)
	{ EMIT(delta, uri, remove, add, ctx); }

	void connect(const Raul::Path& tail, const Raul::Path& head)
	{ EMIT(connection, tail, head); }

	void del(const Raul::URI&  uri,
	         const Properties& properties = Properties())
	{ EMIT(object_deleted, uri, properties); }

	void copy(const Raul::URI& old_uri, const Raul::URI& new_uri)
	{ EMIT(object_copied, old_uri, new_uri); }

	void move(const Raul::Path& old_path, const Raul::Path& new_path)
	{ EMIT(object_moved, old_path, new_path); }

	void disconnect(const Raul::Path& tail, const Raul::Path& head)
	{ EMIT(disconnection, tail, head); }

	void disconnect_all(const Raul::Path& graph, const Raul::Path& path)
	{ EMIT(disconnect_all, graph, path); }

	void set_property(const Raul::URI& subject,
	                  const Raul::URI& key,
	                  const Atom&      value,
	                  Resource::Graph  ctx = Resource::Graph::DEFAULT)
	{ EMIT(property_change, subject, key, value, ctx); }

	void undo() {}
	void redo() {}
	void set_response_id(int32_t id) {}
	void get(const Raul::URI& uri) {}
};

} // namespace Client
} // namespace Ingen

#endif