/* This file is part of Patchage.
 * Copyright (C) 2007-2009 Dave Robillard <http://drobilla.net>
 *
 * Patchage 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.
 *
 * Patchage 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 PATCHAGE_DRIVER_HPP
#define PATCHAGE_DRIVER_HPP

#include <boost/shared_ptr.hpp>
#include <sigc++/sigc++.h>
#include "raul/SRSWQueue.hpp"
#include "PatchageEvent.hpp"

class PatchagePort;
class PatchageCanvas;

/** Trival driver base class */
class Driver {
public:
	virtual ~Driver() {}

	virtual void process_events(Patchage* app) {
		while (!events().empty()) {
			PatchageEvent& ev = events().front();
			ev.execute(app);
			events().pop();
		}
	}

	virtual void attach(bool launch_daemon) = 0;
	virtual void detach()                   = 0;
	virtual bool is_attached() const        = 0;

	virtual void refresh()     = 0;
	virtual void destroy_all() {}

	virtual boost::shared_ptr<PatchagePort> create_port_view(
			Patchage*     patchage,
			const PortID& id) = 0;

	virtual bool connect(boost::shared_ptr<PatchagePort> src_port,
	                     boost::shared_ptr<PatchagePort> dst_port) = 0;

	virtual bool disconnect(boost::shared_ptr<PatchagePort> src_port,
	                        boost::shared_ptr<PatchagePort> dst_port) = 0;

	Raul::SRSWQueue<PatchageEvent>& events() { return _events; }

	sigc::signal<void> signal_attached;
	sigc::signal<void> signal_detached;

protected:
	Driver(size_t event_queue_size) : _events(event_queue_size) {}

	Raul::SRSWQueue<PatchageEvent> _events;
};


#endif // PATCHAGE_DRIVER_HPP