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

#include <string>
#include <list>

#include <glibmm/ustring.h>

#include <boost/optional.hpp>

#include "interface/GraphObject.hpp"

namespace Raul  { class Path; }
namespace Sord  { class World; class Model; class Node; }
namespace Ingen { namespace Shared { class CommonInterface; } }

namespace Ingen {

namespace Shared { class World; }

namespace Serialisation {

class Parser {
public:
	virtual ~Parser() {}

	typedef Shared::GraphObject::Properties Properties;

	virtual bool parse_document(
		Ingen::Shared::World*         world,
		Shared::CommonInterface*      target,
		Glib::ustring                 document_uri,
		boost::optional<Raul::Path>   data_path=boost::optional<Raul::Path>(),
		boost::optional<Raul::Path>   parent=boost::optional<Raul::Path>(),
		boost::optional<Raul::Symbol> symbol=boost::optional<Raul::Symbol>(),
		boost::optional<Properties>   data=boost::optional<Properties>());

	virtual bool parse_string(
		Ingen::Shared::World*         world,
		Shared::CommonInterface*      target,
		const Glib::ustring&          str,
		const Glib::ustring&          base_uri,
		boost::optional<Raul::Path>   data_path=boost::optional<Raul::Path>(),
		boost::optional<Raul::Path>   parent=boost::optional<Raul::Path>(),
		boost::optional<Raul::Symbol> symbol=boost::optional<Raul::Symbol>(),
		boost::optional<Properties>   data=boost::optional<Properties>());

	virtual bool parse_update(
		Ingen::Shared::World*         world,
		Shared::CommonInterface*      target,
		const Glib::ustring&          str,
		const Glib::ustring&          base_uri,
		boost::optional<Raul::Path>   data_path=boost::optional<Raul::Path>(),
		boost::optional<Raul::Path>   parent=boost::optional<Raul::Path>(),
		boost::optional<Raul::Symbol> symbol=boost::optional<Raul::Symbol>(),
		boost::optional<Properties>   data=boost::optional<Properties>());

	struct PatchRecord {
		PatchRecord(const Raul::URI& u, const Glib::ustring& f) : uri(u), filename(f) {}
		const Raul::URI     uri;
		const Glib::ustring filename;
	};

	typedef std::list<PatchRecord> PatchRecords;

	virtual PatchRecords find_patches(
			Ingen::Shared::World* world,
			const Glib::ustring&  manifest_uri);

private:
	boost::optional<Raul::Path> parse(
		Ingen::Shared::World*         world,
		Shared::CommonInterface*      target,
		Sord::Model&                  model,
		Glib::ustring                 document_uri,
		boost::optional<Raul::Path>   data_path=boost::optional<Raul::Path>(),
		boost::optional<Raul::Path>   parent=boost::optional<Raul::Path>(),
		boost::optional<Raul::Symbol> symbol=boost::optional<Raul::Symbol>(),
		boost::optional<Properties>   data=boost::optional<Properties>());

	boost::optional<Raul::Path> parse_patch(
		Ingen::Shared::World*           world,
		Ingen::Shared::CommonInterface* target,
		Sord::Model&                    model,
		const Sord::Node&               subject,
		boost::optional<Raul::Path>     parent=boost::optional<Raul::Path>(),
		boost::optional<Raul::Symbol>   symbol=boost::optional<Raul::Symbol>(),
		boost::optional<Properties>     data=boost::optional<Properties>());

	boost::optional<Raul::Path> parse_node(
		Ingen::Shared::World*           world,
		Ingen::Shared::CommonInterface* target,
		Sord::Model&                    model,
		const Sord::Node&               subject,
		const Raul::Path&               path,
		boost::optional<Properties>     data=boost::optional<Properties>());

	bool parse_properties(
		Ingen::Shared::World*           world,
		Ingen::Shared::CommonInterface* target,
		Sord::Model&                    model,
		const Sord::Node&               subject,
		const Raul::URI&                uri,
		boost::optional<Properties>     data = boost::optional<Properties>());

	bool parse_connections(
		Ingen::Shared::World*           world,
		Ingen::Shared::CommonInterface* target,
		Sord::Model&                    model,
		const Sord::Node&               subject,
		const Raul::Path&               patch);

	bool skip_property(const Sord::Node& predicate);
};

} // namespace Serialisation
} // namespace Ingen

#endif // INGEN_SERIALISATION_PARSER_HPP