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

#include <stdint.h>

#include <list>
#include <string>

#include <boost/weak_ptr.hpp>

#include <libgnomecanvasmm.h>
#include <libgnomecanvasmm/bpath.h>
#include <libgnomecanvasmm/path-def.h>

namespace FlowCanvas {

class Canvas;
class Connectable;


/** A connection (line) between two canvas objects.
 *
 * \ingroup FlowCanvas
 */
class Connection : public Gnome::Canvas::Group
{
public:
	Connection(boost::shared_ptr<Canvas>      canvas,
	           boost::shared_ptr<Connectable> source,
	           boost::shared_ptr<Connectable> dest,
	           uint32_t                       color,
			   bool                           show_arrow_head = false);

	virtual ~Connection();

	virtual void move(double /*dx*/, double /*dy*/)
	{ /* ignore, src/dst take care of it */ }

	virtual void zoom(double z);

	bool selected() const { return _selected; }
	void set_selected(bool b);

	virtual double length_hint() const { return 0.0; }

	void set_label(const std::string& str);
	void show_handle(bool show);

	void set_color(uint32_t color);
	void set_highlighted(bool b);
	void raise_to_top();

	void select_tick();

	const boost::weak_ptr<Connectable> source() const { return _source; }
	const boost::weak_ptr<Connectable> dest()   const { return _dest; }

	enum HandleStyle {
		HANDLE_NONE,
		HANDLE_RECT,
		HANDLE_CIRCLE,
	};

	void set_handle_style(HandleStyle s) { _handle_style = s; }

protected:
	friend class Canvas;
	friend class Connectable;
	void update_location();

	const boost::weak_ptr<Canvas>      _canvas;
	const boost::weak_ptr<Connectable> _source;
	const boost::weak_ptr<Connectable> _dest;

	Gnome::Canvas::Bpath _bpath;
	GnomeCanvasPathDef*  _path;

	/** A handle on a connection line to allow mouse interaction. */
	struct Handle : public Gnome::Canvas::Group {
		explicit Handle(Gnome::Canvas::Group& parent)
			: Gnome::Canvas::Group(parent), shape(NULL), text(NULL) {}
		~Handle() { delete shape; delete text; }
		Gnome::Canvas::Shape* shape;
		Gnome::Canvas::Text*  text;
	}* _handle;

	uint32_t    _color;
	HandleStyle _handle_style;

	bool _selected       :1;
	bool _show_arrowhead :1;
};

typedef std::list<boost::shared_ptr<Connection> > ConnectionList;


} // namespace FlowCanvas

#endif // FLOWCANVAS_CONNECTION_HPP