/* This file is part of Ingen.
 * Copyright (C) 2007 Dave 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 THREADEDSIGCLIENTINTERFACE_H
#define THREADEDSIGCLIENTINTERFACE_H

#include <inttypes.h>
#include <string>
#include <sigc++/sigc++.h>
#include <glibmm/thread.h>
#include "raul/Atom.hpp"
#include "interface/ClientInterface.hpp"
#include "SigClientInterface.hpp"
#include "raul/SRSWQueue.hpp"

using std::string;

/** Returns nothing and takes no parameters (because they have all been bound) */
typedef sigc::slot<void> Closure;

namespace Ingen {
namespace Shared { class EngineInterface; }
namespace Client {


/** A LibSigC++ signal emitting interface for clients to use.
 *
 * This emits signals (possibly) in a different thread than the ClientInterface
 * functions are called.  It must be explicitly driven with the emit_signals()
 * function, which fires all enqueued signals up until the present.  You can
 * use this in a GTK idle callback for receiving thread safe engine signals.
 */
class ThreadedSigClientInterface : public SigClientInterface
{
public:
	ThreadedSigClientInterface(uint32_t queue_size)
	: _sigs(queue_size)
	, response_ok_slot(signal_response_ok.make_slot())
	, response_error_slot(signal_response_error.make_slot())
	, error_slot(signal_error.make_slot())
	, new_plugin_slot(signal_new_plugin.make_slot())
	, new_patch_slot(signal_new_patch.make_slot())
	, new_node_slot(signal_new_node.make_slot())
	, new_port_slot(signal_new_port.make_slot())
	, connection_slot(signal_connection.make_slot())
	, clear_patch_slot(signal_clear_patch.make_slot())
	, object_destroyed_slot(signal_object_destroyed.make_slot())
	, object_renamed_slot(signal_object_renamed.make_slot())
	, disconnection_slot(signal_disconnection.make_slot())
	, variable_change_slot(signal_variable_change.make_slot())
	, property_change_slot(signal_property_change.make_slot())
	, port_value_slot(signal_port_value.make_slot())
	, activity_slot(signal_activity.make_slot())
	, program_add_slot(signal_program_add.make_slot())
	, program_remove_slot(signal_program_remove.make_slot())
	{
	}

	virtual std::string uri() const { return "(internal)"; }

    virtual void subscribe(Shared::EngineInterface* engine) { throw; }

	bool enabled() const { return _attached; }

	void bundle_begin()
		{ push_sig(bundle_begin_slot); }

	void bundle_end()
		{ push_sig(bundle_end_slot); }
	
	void transfer_begin() {}
	void transfer_end()   {}

	void response_ok(int32_t id)
		{ push_sig(sigc::bind(response_ok_slot, id)); }
	
	void response_error(int32_t id, const string& msg)
		{ push_sig(sigc::bind(response_error_slot, id, msg)); }

	void error(const string& msg)
		{ push_sig(sigc::bind(error_slot, msg)); }
	
	void new_plugin(const string& uri, const string& type_uri, const string& symbol)
		{ push_sig(sigc::bind(new_plugin_slot, uri, type_uri, symbol)); }
	
	bool new_object(const Shared::GraphObject* object);
	
	void new_patch(const string& path, uint32_t poly)
		{ push_sig(sigc::bind(new_patch_slot, path, poly)); }
	
	void new_node(const string& path, const string& plugin_uri)
		{ push_sig(sigc::bind(new_node_slot, path, plugin_uri)); }
	
	void new_port(const string& path, const string& type, uint32_t index, bool is_output)
		{ push_sig(sigc::bind(new_port_slot, path, type, index, is_output)); }
	
	void connect(const string& src_port_path, const string& dst_port_path)
		{ push_sig(sigc::bind(connection_slot, src_port_path, dst_port_path)); }

	void destroy(const string& path)
		{ push_sig(sigc::bind(object_destroyed_slot, path)); }
	
	void clear_patch(const string& path)
		{ push_sig(sigc::bind(clear_patch_slot, path)); }

	void rename(const string& old_path, const string& new_path)
		{ push_sig(sigc::bind(object_renamed_slot, old_path, new_path)); }
	
	void disconnect(const string& src_port_path, const string& dst_port_path)
		{ push_sig(sigc::bind(disconnection_slot, src_port_path, dst_port_path)); }
	
	void set_variable(const string& path, const string& key, const Raul::Atom& value)
		{ push_sig(sigc::bind(variable_change_slot, path, key, value)); }
	
	void set_property(const string& path, const string& key, const Raul::Atom& value)
		{ push_sig(sigc::bind(property_change_slot, path, key, value)); }

	void set_port_value(const string& port_path, const Raul::Atom& value)
		{ push_sig(sigc::bind(port_value_slot, port_path, value)); }
	
	void set_voice_value(const string& port_path, uint32_t voice, const Raul::Atom& value)
		{ push_sig(sigc::bind(voice_value_slot, port_path, voice, value)); }
	
	void activity(const string& port_path)
		{ push_sig(sigc::bind(activity_slot, port_path)); }

	void program_add(const string& path, uint32_t bank, uint32_t program, const string& name)
		{ push_sig(sigc::bind(program_add_slot, path, bank, program, name)); }
	
	void program_remove(const string& path, uint32_t bank, uint32_t program)
		{ push_sig(sigc::bind(program_remove_slot, path, bank, program)); }

	/** Process all queued events - Called from GTK thread to emit signals. */
	bool emit_signals();

private:
	void push_sig(Closure ev);
	
	Glib::Mutex _mutex;
	Glib::Cond  _cond;

	Raul::SRSWQueue<Closure> _sigs;
	bool                     _attached;

	sigc::slot<void>                                     bundle_begin_slot; 
	sigc::slot<void>                                     bundle_end_slot; 
	sigc::slot<void, int32_t>                            response_ok_slot; 
	sigc::slot<void, int32_t, string>                    response_error_slot; 
	sigc::slot<void, string>                             error_slot; 
	sigc::slot<void, string, string, string>             new_plugin_slot; 
	sigc::slot<void, string, uint32_t>                   new_patch_slot; 
	sigc::slot<void, string, string>                     new_node_slot; 
	sigc::slot<void, string, string, uint32_t, bool>     new_port_slot;
	sigc::slot<void, string, string>                     connection_slot;
	sigc::slot<void, string>                             clear_patch_slot; 
	sigc::slot<void, string>                             object_destroyed_slot; 
	sigc::slot<void, string, string>                     object_renamed_slot; 
	sigc::slot<void, string, string>                     disconnection_slot; 
	sigc::slot<void, string, string, Raul::Atom>         variable_change_slot; 
	sigc::slot<void, string, string, Raul::Atom>         property_change_slot; 
	sigc::slot<void, string, Raul::Atom>                 port_value_slot; 
	sigc::slot<void, string, uint32_t, Raul::Atom>       voice_value_slot; 
	sigc::slot<void, string>                             activity_slot; 
	sigc::slot<void, string, uint32_t, uint32_t, string> program_add_slot; 
	sigc::slot<void, string, uint32_t, uint32_t>         program_remove_slot; 
};


} // namespace Client
} // namespace Ingen

#endif