/* This file is part of Om.  Copyright (C) 2005 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 NODEMODEL_H
#define NODEMODEL_H

#include <cstdlib>
#include <map>
#include <iostream>
#include <string>
#include "ObjectModel.h"
#include "PortModel.h"
#include "util/Path.h"

using std::string; using std::map; using std::find;
using std::cout; using std::cerr; using std::endl;

namespace LibOmClient {

class PatchModel;
class PluginModel;

	
/** Node model class, used by the client to store engine's state.
 *
 * \ingroup libomclient
 */
class NodeModel : public ObjectModel
{
public:
	NodeModel(const Path& node_path);
	virtual ~NodeModel();
	
	PortModel* get_port(const string& port_name);
	void       add_port(PortModel* pm);
	void       remove_port(const string& port_path);
	
	virtual void clear();

	const map<int, map<int, string> >& get_programs() const     { return m_banks; }
	void add_program(int bank, int program, const string& name);
	void remove_program(int bank, int program);

	const PluginModel* plugin() const                      { return m_plugin; }
	void               plugin(const PluginModel* const pi) { m_plugin = pi; }
	
	virtual void set_path(const Path& p);
	
	int                   num_ports() const  { return m_ports.size(); }
	const PortModelList&  ports() const      { return m_ports; }
	virtual bool          polyphonic() const { return m_polyphonic; }
	void                  polyphonic(bool b) { m_polyphonic = b; }
	float                 x() const          { return m_x; }
	void                  x(float a)         { m_x = a; }
	float                 y() const          { return m_y; }
	void                  y(float a)         { m_y = a; }
	
	PatchModel* parent_patch() const { return (PatchModel*)m_parent; }
	
protected:
	bool                        m_polyphonic;
	PortModelList               m_ports;  ///< List of ports (instead of map to preserve order)
	const PluginModel*          m_plugin; ///< The plugin this node is an instance of
	float                       m_x;      ///< Just metadata, here as an optimization for OmGtk
	float                       m_y;      ///< Just metadata, here as an optimization for OmGtk
	map<int, map<int, string> > m_banks;  ///< DSSI banks

private:
	// Prevent copies (undefined)
	NodeModel(const NodeModel& copy);
	NodeModel& operator=(const NodeModel& copy);	
};


typedef map<string, NodeModel*>   NodeModelMap;


} // namespace LibOmClient

#endif // NODEMODEL_H