/* This file is part of Om.  Copyright (C) 2006 Dave Robillard.
 * 
 * Om 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.
 * 
 * Om 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.,
 * 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef NODEBASE_H
#define NODEBASE_H

#include <string>
#include <cstdlib>
#include "Node.h"
using std::string;

namespace Om {

class Plugin;
class Patch;
namespace Shared {
	class ClientInterface;
} using Shared::ClientInterface;


/** Common implementation stuff for Node.
 *
 * Pretty much just attributes and getters/setters are here.
 *
 * \ingroup engine
 */
class NodeBase : public Node
{
public:
	NodeBase(const string& name, size_t poly, Patch* parent, samplerate srate, size_t buffer_size);

	virtual ~NodeBase();

	virtual void activate();
	virtual void deactivate();
	bool activated() { return _activated; }

	virtual void run(size_t nframes);
		
	virtual void set_port_buffer(size_t voice, size_t port_num, void* buf) {}
	
	virtual void add_to_patch() {}
	virtual void remove_from_patch() {}
	
	void add_to_store();
	void remove_from_store();
	
	//void send_creation_messages(ClientInterface* client) const;
	
	size_t num_ports() const { return _num_ports; }
	size_t poly() const      { return _poly; }
	bool   traversed() const { return _traversed; }
	void   traversed(bool b) { _traversed = b; }
	
	const Array<Port*>& ports() const { return *_ports; }
	
	virtual List<Node*>* providers()               { return _providers; }
	virtual void         providers(List<Node*>* l) { _providers = l; }
	
	virtual List<Node*>* dependants()               { return _dependants; }
	virtual void         dependants(List<Node*>* l) { _dependants = l; }
	
	Patch* parent_patch() const { return (_parent == NULL) ? NULL : _parent->as_patch(); }

	virtual const Plugin* plugin() const                 { exit(EXIT_FAILURE); }
	virtual void          plugin(const Plugin* const pi) { exit(EXIT_FAILURE); }
	
	void set_path(const Path& new_path);
	
protected:	
	// Disallow copies (undefined)
	NodeBase(const NodeBase&);
	NodeBase& operator=(const NodeBase&);
	
	size_t      _poly;

	samplerate  _srate;
	size_t      _buffer_size;
	bool        _activated;

	size_t        _num_ports; ///< number of ports PER VOICE
	Array<Port*>* _ports;     ///< Access in audio thread only

	bool         _traversed;  ///< Flag for process order algorithm
	List<Node*>* _providers;  ///< Nodes connected to this one's input ports
	List<Node*>* _dependants; ///< Nodes this one's output ports are connected to
};


} // namespace Om

#endif // NODEBASE_H