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

#include "QueuedEvent.hpp"
#include "raul/Path.hpp"
#include "raul/Array.hpp"
#include "interface/DataType.hpp"
#include "interface/Resource.hpp"

namespace Ingen {

class PatchImpl;
class PortImpl;
class DriverPort;


/** An event to add a Port to a Patch.
 *
 * \ingroup engine
 */
class CreatePortEvent : public QueuedEvent
{
public:
	CreatePortEvent(
			Engine&                             engine,
			SharedPtr<Responder>                responder,
			SampleCount                         timestamp,
			const Raul::Path&                   path,
			const Raul::URI&                    type,
			bool                                is_output,
			QueuedEventSource*                  source,
			const Shared::Resource::Properties& properties);

	void pre_process();
	void execute(ProcessContext& context);
	void post_process();

private:

	enum ErrorType {
		NO_ERROR,
		UNKNOWN_TYPE,
		CREATION_FAILED
	};

	ErrorType               _error;
	Raul::Path              _path;
	Raul::URI               _type;
	bool                    _is_output;
	Shared::DataType        _data_type;
	PatchImpl*              _patch;
	PortImpl*               _patch_port;
	Raul::Array<PortImpl*>* _ports_array; ///< New (external) ports array for Patch
	DriverPort*             _driver_port; ///< Driver (eg Jack) port if this is a toplevel port
	bool                    _succeeded;

	Shared::Resource::Properties _properties;
};


} // namespace Ingen

#endif // CREATEPORTEVENT_H