/*
  This file is part of Ingen.
  Copyright 2007-2012 David Robillard <http://drobilla.net/>

  Ingen is free software: you can redistribute it and/or modify it under the
  terms of the GNU Affero General Public License as published by the Free
  Software Foundation, either version 3 of the License, or 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 Affero General Public License for details.

  You should have received a copy of the GNU Affero General Public License
  along with Ingen.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef INGEN_SERIALISATION_SERIALISER_HPP
#define INGEN_SERIALISATION_SERIALISER_HPP

#include <stdexcept>
#include <string>

#include "raul/Path.hpp"
#include "raul/SharedPtr.hpp"

#include "sord/sordmm.hpp"

#include "ingen/GraphObject.hpp"

namespace Ingen {

class Plugin;
class GraphObject;
class Patch;
class Node;
class Port;
class Edge;

namespace Shared {
class World;
class Store;
}

namespace Serialisation {

/**
   Write Ingen objects to Turtle files or strings.

   @ingroup IngenSerialisation
*/
class Serialiser
{
public:
	explicit Serialiser(Shared::World& world);
	virtual ~Serialiser();

	typedef GraphObject::Properties Properties;

	virtual void to_file(SharedPtr<const GraphObject> object,
	                     const std::string&           filename);

	virtual void write_bundle(SharedPtr<const Patch> patch,
	                          const std::string&     path);

	virtual std::string to_string(SharedPtr<const GraphObject> object,
	                              const std::string&           base_uri);

	virtual void start_to_string(const Raul::Path&  root,
	                             const std::string& base_uri);

	virtual void serialise(SharedPtr<const GraphObject> object)
			throw (std::logic_error);

	virtual void serialise_edge(const Sord::Node&     parent,
	                            SharedPtr<const Edge> c)
			throw (std::logic_error);

	virtual std::string finish();

private:
	struct Impl;
	Impl* me;
};

} // namespace Serialisation
} // namespace Ingen

#endif // INGEN_SERIALISATION_SERIALISER_HPP