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

/*!	\file layerencapsulate.cpp

**	\brief Template File

**

**	$Id$

**

**	\legal

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

**	Copyright (c) 2007, 2008 Chris Moore

**

**	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

*/

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

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

#ifdef USING_PCH

#	include "pch.h"

#else

#ifdef HAVE_CONFIG_H

#	include <config.h></config.h>

#endif

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

#include "layerencapsulate.h"

#include "layeradd.h"

#include "layerremove.h"

#include <synfigapp canvasinterface.h=""></synfigapp>

#include <synfigapp localization.h=""></synfigapp>

#endif

using namespace std;

using namespace etl;

using namespace synfig;

using namespace synfigapp;

using namespace Action;

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

ACTION_INIT_NO_GET_LOCAL_NAME(Action::LayerEncapsulate);

ACTION_SET_NAME(Action::LayerEncapsulate,"LayerEncapsulate");

ACTION_SET_LOCAL_NAME(Action::LayerEncapsulate,N_("Group Layer"));

ACTION_SET_TASK(Action::LayerEncapsulate,"encapsulate");

ACTION_SET_CATEGORY(Action::LayerEncapsulate,Action::CATEGORY_LAYER);

ACTION_SET_PRIORITY(Action::LayerEncapsulate,0);

ACTION_SET_VERSION(Action::LayerEncapsulate,"0.0");

ACTION_SET_CVS_ID(Action::LayerEncapsulate,"$Id$");

/* === G L O B A L S ======================================================= */

/* === P R O C E D U R E S ================================================= */

/* === M E T H O D S ======================================================= */

Action::LayerEncapsulate::LayerEncapsulate()

{

    children_lock=false;

}

synfig::String

Action::LayerEncapsulate::get_local_name()const

{

	return get_layer_descriptions(layers, _("Group Layer"), _("Group Layers"));

}

Action::ParamVocab

Action::LayerEncapsulate::get_param_vocab()

{

	ParamVocab ret(Action::CanvasSpecific::get_param_vocab());

	ret.push_back(ParamDesc("layer",Param::TYPE_LAYER)

		.set_local_name(_("Layer"))

		.set_desc(_("Layer to be grouped"))

		.set_supports_multiple()

	);

	ret.push_back(ParamDesc("description",Param::TYPE_STRING)

		.set_local_name(_("Description"))

		.set_desc(_("Description of new group"))

		.set_optional()

	);

	return ret;

}

bool

Action::LayerEncapsulate::is_candidate(const ParamList &x)

{

	return candidate_check(get_param_vocab(),x);

}

bool

Action::LayerEncapsulate::set_param(const synfig::String& name, const Action::Param ¶m)

{

	if(name=="layer" && param.get_type()==Param::TYPE_LAYER)

	{

		layers.push_back(param.get_layer());

		return true;

	}

	if(name=="description" && param.get_type()==Param::TYPE_STRING)

	{

		description = param.get_string();

		return true;

	}

        if(name=="children_lock" && param.get_type()==Param::TYPE_BOOL)

	{

		children_lock = param.get_bool();

		return true;

	}

	return Action::CanvasSpecific::set_param(name,param);

}

bool

Action::LayerEncapsulate::is_ready()const

{

	if(layers.empty())

		return false;

	return Action::CanvasSpecific::is_ready();

}

int

Action::LayerEncapsulate::lowest_depth()const

{

	std::list<synfig::layer::handle>::const_iterator iter;</synfig::layer::handle>

	int lowest_depth(0x7fffffff);

	for(iter=layers.begin();iter!=layers.end();++iter)

	{

		int depth((*iter)->get_depth());

		if(depth

			lowest_depth=depth;

	}

	if(lowest_depth==0x7fffffff)

		return 0;

	return lowest_depth;

}

void

Action::LayerEncapsulate::prepare()

{

	if(!first_time())

		return;

	if(layers.empty())

		throw Error(_("No layers to group"));

	// First create the new canvas and layer

	if(!child_canvas)

		child_canvas=Canvas::create_inline(get_canvas());

	Layer::Handle new_layer(Layer::create("group"));

	if (!description.empty()) new_layer->set_description(description);

	new_layer->set_param("canvas",child_canvas);

        new_layer->set_param("children_lock", ValueBase(children_lock));

	int target_depth(lowest_depth());

	// Add the layer

	{

		Action::Handle action(LayerAdd::create());

		action->set_param("canvas",get_canvas());

		action->set_param("canvas_interface",get_canvas_interface());

		action->set_param("new",new_layer);

		add_action(action);

	}

	// Move the layer

	{

		Action::Handle action(Action::create("LayerMove"));

		assert(action);

		action->set_param("canvas",get_canvas());

		action->set_param("canvas_interface",get_canvas_interface());

		action->set_param("layer",new_layer);

		action->set_param("new_index",target_depth);

		add_action(action);

	}

	std::list<synfig::layer::handle>::reverse_iterator i;</synfig::layer::handle>

	for(i=layers.rbegin();i!=layers.rend();++i)

	{

		Layer::Handle layer(*i);

		Canvas::Handle subcanvas(layer->get_canvas());

		// Find the iterator for the layer

		Canvas::iterator iter=find(subcanvas->begin(),subcanvas->end(),layer);

		// If we couldn't find the layer in the canvas, then bail

		if(*iter!=layer)

			throw Error(_("This layer doesn't exist anymore."));

		if(!subcanvas)

			throw Error(_("This layer doesn't have a parent canvas"));

		// If the subcanvas isn't the same as the canvas,

		// then it had better be an inline canvas. If not,

		// bail

		if(get_canvas()!=subcanvas && !subcanvas->is_inline())

			throw Error(_("This layer doesn't belong to this canvas anymore"));

		if(get_canvas()!=subcanvas)

			throw Error(_("get_canvas()!=subcanvas"));

		// Remove the layer from the old canvas

		{

			Action::Handle action(LayerRemove::create());

			action->set_param("canvas",subcanvas);

			action->set_param("canvas_interface",get_canvas_interface());

			action->set_param("layer",layer);

			add_action(action);

		}

		// Add the layer to the new canvas

		{

			Action::Handle action(LayerAdd::create());

			action->set_param("canvas",child_canvas);

			action->set_param("canvas_interface",get_canvas_interface());

			action->set_param("new",layer);

			add_action(action);

		}

	}

}