Fix missing back slash to do not stop all the extra dist files list
[synfig.git] / synfig-studio / src / synfigapp / actions / valuedescexport.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file valuedescexport.cpp
3 **      \brief Template File
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **      Copyright (c) 2008 Chris Moore
10 **
11 **      This package is free software; you can redistribute it and/or
12 **      modify it under the terms of the GNU General Public License as
13 **      published by the Free Software Foundation; either version 2 of
14 **      the License, or (at your option) any later version.
15 **
16 **      This package is distributed in the hope that it will be useful,
17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 **      General Public License for more details.
20 **      \endlegal
21 */
22 /* ========================================================================= */
23
24 /* === H E A D E R S ======================================================= */
25
26 #ifdef USING_PCH
27 #       include "pch.h"
28 #else
29 #ifdef HAVE_CONFIG_H
30 #       include <config.h>
31 #endif
32
33 #include "valuenodeadd.h"
34
35 #include "canvasadd.h"
36 #include "valuedescexport.h"
37 #include "layerparamconnect.h"
38 #include "layerparamset.h"
39
40 #include <synfigapp/canvasinterface.h>
41 #include <synfig/valuenode_const.h>
42
43 #include <synfigapp/general.h>
44
45 #endif
46
47 using namespace std;
48 using namespace etl;
49 using namespace synfig;
50 using namespace synfigapp;
51 using namespace Action;
52
53 /* === M A C R O S ========================================================= */
54
55 ACTION_INIT_NO_GET_LOCAL_NAME(Action::ValueDescExport);
56 ACTION_SET_NAME(Action::ValueDescExport,"ValueDescExport");
57 ACTION_SET_LOCAL_NAME(Action::ValueDescExport,N_("Export"));
58 ACTION_SET_TASK(Action::ValueDescExport,"export");
59 ACTION_SET_CATEGORY(Action::ValueDescExport,Action::CATEGORY_VALUEDESC);
60 ACTION_SET_PRIORITY(Action::ValueDescExport,0);
61 ACTION_SET_VERSION(Action::ValueDescExport,"0.0");
62 ACTION_SET_CVS_ID(Action::ValueDescExport,"$Id$");
63
64 /* === G L O B A L S ======================================================= */
65
66 /* === P R O C E D U R E S ================================================= */
67
68 /* === M E T H O D S ======================================================= */
69
70 Action::ValueDescExport::ValueDescExport()
71 {
72 }
73
74 synfig::String
75 Action::ValueDescExport::get_local_name()const
76 {
77         // TRANSLATORS: This is used in the 'history' dialog when a ValueNode is exported.  The first %s is what is exported, the 2nd is the name it is given.
78         return strprintf(_("Export '%s' as '%s'"),
79                                          value_desc.get_description(false).c_str(),
80                                          name.c_str());
81 }
82
83 Action::ParamVocab
84 Action::ValueDescExport::get_param_vocab()
85 {
86         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
87
88         ret.push_back(ParamDesc("value_desc",Param::TYPE_VALUEDESC)
89                 .set_local_name(_("ValueDesc"))
90         );
91
92         ret.push_back(ParamDesc("name",Param::TYPE_STRING)
93                 .set_local_name(_("Name"))
94                 .set_desc(_("The name that you want this value to be exported as"))
95                 .set_user_supplied()
96         );
97
98         return ret;
99 }
100
101 bool
102 Action::ValueDescExport::is_candidate(const ParamList &x)
103 {
104         if(candidate_check(get_param_vocab(),x))
105         {
106                 ValueDesc value_desc=x.find("value_desc")->second.get_value_desc();
107                 if(!value_desc)
108                         return false;
109                 if(value_desc.get_value_type()==ValueBase::TYPE_CANVAS)
110                         if(!value_desc.get_value().get(Canvas::Handle()))
111                                 return false;
112                 if(
113                         value_desc.parent_is_canvas()
114                         ||
115                         (value_desc.is_value_node() && value_desc.get_value_node()->is_exported())
116                         ||
117                         (value_desc.get_value_type()==ValueBase::TYPE_CANVAS && !value_desc.get_value().get(Canvas::Handle())->is_inline())
118                         )
119                 {
120                         return false;
121                 }
122                 return true;
123         }
124         return false;
125 }
126
127 bool
128 Action::ValueDescExport::set_param(const synfig::String& param_name, const Action::Param &param)
129 {
130         if(param_name=="value_desc" && param.get_type()==Param::TYPE_VALUEDESC)
131         {
132                 value_desc=param.get_value_desc();
133
134                 return true;
135         }
136
137         if(param_name=="name" && param.get_type()==Param::TYPE_STRING)
138         {
139                 name=param.get_string();
140
141                 return true;
142         }
143
144         return Action::CanvasSpecific::set_param(param_name,param);
145 }
146
147 bool
148 Action::ValueDescExport::is_ready()const
149 {
150         if(!value_desc || name.empty())
151                 return false;
152         return Action::CanvasSpecific::is_ready();
153 }
154
155 void
156 Action::ValueDescExport::prepare()
157 {
158         clear();
159
160         ValueNode::Handle value_node;
161
162         if(value_desc.get_value_type()==ValueBase::TYPE_CANVAS)
163         {
164                 // action: CanvasAdd
165                 if(!value_desc.is_const())
166                         throw Error(_("Can only export Canvas when used as constant parameter"));
167                 Canvas::Handle canvas(value_desc.get_value().get(Canvas::Handle()));
168                 if (canvas) canvas=canvas->clone();
169
170                 Action::Handle action(CanvasAdd::create());
171
172                 action->set_param("canvas",get_canvas());
173                 action->set_param("canvas_interface",get_canvas_interface());
174                 action->set_param("src",canvas);
175                 action->set_param("id",name);
176
177                 assert(action->is_ready());
178                 if(!action->is_ready())
179                         throw Error(Error::TYPE_NOTREADY);
180
181                 add_action_front(action);
182
183                 if(value_desc.parent_is_layer_param() && !value_desc.is_value_node())
184                 {
185                         // action: LayerParamSet
186                         Action::Handle action(LayerParamSet::create());
187
188                         action->set_param("canvas",get_canvas());
189                         action->set_param("canvas_interface",get_canvas_interface());
190                         action->set_param("layer",value_desc.get_layer());
191                         action->set_param("param",value_desc.get_param_name());
192                         action->set_param("new_value",ValueBase(canvas));
193
194                         assert(action->is_ready());
195                         if(!action->is_ready())
196                                 throw Error(Error::TYPE_NOTREADY);
197
198                         add_action_front(action);
199                 }
200
201                 return;
202         }
203
204         if(value_desc.is_value_node())
205         {
206                 if(value_desc.get_value_node()->is_exported())
207                         throw Error(_("ValueBase is already exported"));
208
209                 value_node=value_desc.get_value_node();
210         }
211         else
212         {
213                 // action: LayerParamConnect
214                 if(!value_desc.parent_is_layer_param())
215                         throw Error(_("Unable to export parameter. (Bug?)"));
216
217                 value_node=ValueNode_Const::create(value_desc.get_value());
218
219                 Action::Handle action(LayerParamConnect::create());
220
221                 action->set_param("canvas",get_canvas());
222                 action->set_param("canvas_interface",get_canvas_interface());
223                 action->set_param("layer",value_desc.get_layer());
224                 action->set_param("param",value_desc.get_param_name());
225                 action->set_param("value_node",value_node);
226
227                 assert(action->is_ready());
228                 if(!action->is_ready())
229                         throw Error(Error::TYPE_NOTREADY);
230
231                 add_action_front(action);
232         }
233
234         // action: ValueNodeAdd
235         Action::Handle action(ValueNodeAdd::create());
236
237         action->set_param("canvas",get_canvas());
238         action->set_param("canvas_interface",get_canvas_interface());
239         action->set_param("new",value_node);
240         action->set_param("name",name);
241
242         assert(action->is_ready());
243         if(!action->is_ready())
244                 throw Error(Error::TYPE_NOTREADY);
245
246         add_action_front(action);
247 }