/* === S Y N F I G ========================================================= */

/*!	\file action_system.h

**	\brief Template Header

**

**	$Id$

**

**	\legal

**	Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley

**

**	This package 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.

**

**	This package 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 more details.

**	\endlegal

*/

/* ========================================================================= */

/* === S T A R T =========================================================== */

#ifndef __SYNFIGAPP_ACTIONSYSTEM_H

#define __SYNFIGAPP_ACTIONSYSTEM_H

/* === H E A D E R S ======================================================= */

#include <set></set>

#include <sigc++ sigc++.h=""></sigc++>

#include <etl handle=""></etl>

#include <synfig canvas.h=""></synfig>

#include "action.h"

#include "uimanager.h"

/* === M A C R O S ========================================================= */

/* === T Y P E D E F S ===================================================== */

/* === C L A S S E S & S T R U C T S ======================================= */

namespace synfigapp {

class CanvasInterface;

namespace Action {

class System;

//! Passive action grouping class

class PassiveGrouper

{

	typedef std::set< etl::handle<canvasinterface> > RedrawSet;</canvasinterface>

	etl::loose_handle<system> instance_;</system>

	synfig::String name_;

	int depth_;

	RedrawSet redraw_set_;

	bool finished_;

public:

	PassiveGrouper(etl::loose_handle<system> instance_,synfig::String name_);</system>

	~PassiveGrouper();

	const synfig::String &get_name()const { return name_; }

	void set_name(const synfig::String &x) { name_=x; }

	etl::loose_handle<system> get_instance() { return instance_; }</system>

	void request_redraw(etl::handle<canvasinterface>);</canvasinterface>

	etl::handle<action::group> finish();</action::group>

	void cancel();

	void inc_depth() { depth_++; }

	void dec_depth() { depth_--; }

	const int &get_depth()const { return depth_; }

}; // END of class Action::PassiveGrouper

typedef std::list< etl::handle<action::undoable> > Stack;</action::undoable>

class System : public etl::shared_object, public sigc::trackable

{

	friend class PassiveGrouper;

	/*

 -- ** -- P U B L I C   T Y P E S ---------------------------------------------

	*/

public:

	/*

 -- ** -- P U B L I C  D A T A ------------------------------------------------

	*/

public:

	/*

 -- ** -- P R I V A T E   D A T A ---------------------------------------------

	*/

private:

	Stack undo_action_stack_;

	Stack redo_action_stack_;

	synfig::String most_recent_action_name_;

	std::list<passivegrouper*> group_stack_;</passivegrouper*>

	sigc::signal<void,bool> signal_undo_status_;</void,bool>

	sigc::signal<void,bool> signal_redo_status_;</void,bool>

	sigc::signal<void,etl::handle<action::undoable> > signal_new_action_;</void,etl::handle<action::undoable>

	sigc::signal<void> signal_undo_stack_cleared_;</void>

	sigc::signal<void> signal_redo_stack_cleared_;</void>

	sigc::signal<void> signal_undo_;</void>

	sigc::signal<void> signal_redo_;</void>

	sigc::signal<void,etl::handle<action::undoable> > signal_action_status_changed_;</void,etl::handle<action::undoable>

	mutable sigc::signal<void,bool> signal_unsaved_status_changed_;</void,bool>

	//! If this is non-zero, then the changes have not yet been saved.

	mutable int action_count_;

	etl::handle<uiinterface> ui_interface_;</uiinterface>

	bool clear_redo_stack_on_new_action_;

	/*

 -- ** -- P R I V A T E   M E T H O D S ---------------------------------------

	*/

private:

	bool undo_(etl::handle<uiinterface> uim);</uiinterface>

	bool redo_(etl::handle<uiinterface> uim);</uiinterface>

	/*

 -- ** -- S I G N A L   T E R M I N A L S -------------------------------------

	*/

private:

	/*

 -- ** -- P U B L I C   M E T H O D S -----------------------------------------

	*/

public:

	System();

	~System();

	/*

	template <typename t=""> bool</typename>

	perform_action(T x)

	{

		etl::handle<action::base> action((Action::Base*)new T(x));</action::base>

		return perform_action(action);

	}

	*/

	synfig::String get_most_recent_action_name() { return most_recent_action_name_; }

	bool get_clear_redo_stack_on_new_action()const { return clear_redo_stack_on_new_action_; }

	void set_clear_redo_stack_on_new_action(bool x) { clear_redo_stack_on_new_action_=x; }

	void request_redraw(etl::handle<canvasinterface>);</canvasinterface>

	bool perform_action(etl::handle<action::base> action);</action::base>

	bool set_action_status(etl::handle<action::undoable> action, bool x);</action::undoable>

	const Stack &undo_action_stack()const { return undo_action_stack_; }

	const Stack &redo_action_stack()const { return redo_action_stack_; }

	//! Undoes the last action

	bool undo();

	//! Redoes the last undone action

	bool redo();

	//! Clears the undo stack.

	void clear_undo_stack();

	//! Clears the redo stack.

	void clear_redo_stack();

	//! Increments the action counter

	/*! \note You should not have to call this under normal circumstances.

	**	\see dec_action_count(), reset_action_count(), get_action_count() */

	void inc_action_count()const;

	//! Decrements the action counter

	/*! \note You should not have to call this under normal circumstances.

	**	\see inc_action_count(), reset_action_count(), get_action_count() */

	void dec_action_count()const;

	//! Resets the action counter

	/*! \note You should not have to call this under normal circumstances.

	**	\see inc_action_count(), dec_action_count(), get_action_count() */

	void reset_action_count()const;

	//! Returns the number of actions performed since last save.

	/*!	\see inc_action_count(), dec_action_count(), reset_action_count() */

	int get_action_count()const { return action_count_; }

	void set_ui_interface(const etl::handle<uiinterface> &uim) { assert(uim); ui_interface_=uim; }</uiinterface>

	void unset_ui_interface() { ui_interface_=new DefaultUIInterface(); }

	const etl::handle<uiinterface> &get_ui_interface() { return ui_interface_; }</uiinterface>

	/*

 -- ** -- S I G N A L   I N T E R F A C E S -----------------------------------

	*/

public:

	sigc::signal<void,bool>& signal_unsaved_status_changed() { return signal_unsaved_status_changed_; }</void,bool>

	sigc::signal<void,bool>& signal_undo_status() { return signal_undo_status_; }</void,bool>

	sigc::signal<void,bool>& signal_redo_status() { return signal_redo_status_; }</void,bool>

	sigc::signal<void>& signal_undo_stack_cleared() { return signal_undo_stack_cleared_; }</void>

	sigc::signal<void>& signal_redo_stack_cleared() { return signal_redo_stack_cleared_; }</void>

	sigc::signal<void>& signal_undo() { return signal_undo_; }</void>

	sigc::signal<void>& signal_redo() { return signal_redo_; }</void>

	//!	Called whenever an undoable action is processed and added to the stack.

	sigc::signal<void,etl::handle<action::undoable> >& signal_new_action() { return signal_new_action_; }</void,etl::handle<action::undoable>

	sigc::signal<void,etl::handle<action::undoable> >& signal_action_status_changed() { return signal_action_status_changed_; }</void,etl::handle<action::undoable>

}; // END of class Action::System

}; // END of namespace synfigapp::Action

}; // END of namespace synfigapp

/* === E N D =============================================================== */

#endif