Fix 1778930: TCB is the default waypoint type except for angles, which default to...
[synfig.git] / synfig-core / trunk / src / synfig / savecanvas.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file savecanvas.cpp
3 **      \brief Writeme
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **
10 **      This package is free software; you can redistribute it and/or
11 **      modify it under the terms of the GNU General Public License as
12 **      published by the Free Software Foundation; either version 2 of
13 **      the License, or (at your option) any later version.
14 **
15 **      This package is distributed in the hope that it will be useful,
16 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
17 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 **      General Public License for more details.
19 **      \endlegal
20 */
21 /* ========================================================================= */
22
23 /* === H E A D E R S ======================================================= */
24
25 #ifdef USING_PCH
26 #       include "pch.h"
27 #else
28 #ifdef HAVE_CONFIG_H
29 #       include <config.h>
30 #endif
31
32 #ifdef HAVE_SYS_ERRNO_H
33 #       include <sys/errno.h>
34 #endif
35
36 #include "savecanvas.h"
37 #include "general.h"
38 #include "valuenode.h"
39 #include "valuenode_subtract.h"
40 #include "valuenode_animated.h"
41 #include "valuenode_composite.h"
42 #include "valuenode_const.h"
43 #include "valuenode_linear.h"
44 #include "valuenode_dynamiclist.h"
45 #include "valuenode_reference.h"
46 #include "valuenode_segcalctangent.h"
47 #include "valuenode_segcalcvertex.h"
48 #include "valuenode_bline.h"
49 #include "time.h"
50 #include "keyframe.h"
51 #include "layer.h"
52 #include "string.h"
53 #include "paramdesc.h"
54
55 #include <libxml++/libxml++.h>
56 #include <ETL/stringf>
57 #include "gradient.h"
58 #include <errno.h>
59
60 #endif
61
62 /* === U S I N G =========================================================== */
63
64 using namespace std;
65 using namespace etl;
66 using namespace synfig;
67
68 /* === M A C R O S ========================================================= */
69
70 #define COLOR_VALUE_TYPE_FORMAT         "%f"
71 #define VECTOR_VALUE_TYPE_FORMAT        "%0.10f"
72 #define TIME_TYPE_FORMAT                        "%0.3f"
73 #define VIEW_BOX_FORMAT                         "%f %f %f %f"
74
75 /* === G L O B A L S ======================================================= */
76
77 /* === P R O C E D U R E S ================================================= */
78
79 xmlpp::Element* encode_canvas(xmlpp::Element* root,Canvas::ConstHandle canvas);
80 xmlpp::Element* encode_value_node(xmlpp::Element* root,ValueNode::ConstHandle value_node,Canvas::ConstHandle canvas);
81
82 xmlpp::Element* encode_keyframe(xmlpp::Element* root,const Keyframe &kf, float fps)
83 {
84         root->set_name("keyframe");
85         root->set_attribute("time",kf.get_time().get_string(fps));
86         if(!kf.get_description().empty())
87                 root->set_child_text(kf.get_description());
88         return root;
89 }
90
91
92 xmlpp::Element* encode_real(xmlpp::Element* root,Real v)
93 {
94         root->set_name("real");
95         root->set_attribute("value",strprintf(VECTOR_VALUE_TYPE_FORMAT,v));
96         return root;
97 }
98
99 xmlpp::Element* encode_time(xmlpp::Element* root,Time t, float /*fps*/=0)
100 {
101         root->set_name("time");
102         //root->set_attribute("value",t.get_string(fps));
103         root->set_attribute("value",t.get_string());
104         return root;
105 }
106
107 xmlpp::Element* encode_integer(xmlpp::Element* root,int i)
108 {
109         root->set_name("integer");
110         root->set_attribute("value",strprintf("%i",i));
111         return root;
112 }
113
114 xmlpp::Element* encode_bool(xmlpp::Element* root,bool b)
115 {
116         root->set_name("bool");
117         root->set_attribute("value",b?"true":"false");
118         return root;
119 }
120
121 xmlpp::Element* encode_string(xmlpp::Element* root,const String &str)
122 {
123         root->set_name("string");
124         root->set_child_text(str);
125         return root;
126 }
127
128 xmlpp::Element* encode_vector(xmlpp::Element* root,Vector vect)
129 {
130         root->set_name("vector");
131         root->add_child("x")->set_child_text(strprintf(VECTOR_VALUE_TYPE_FORMAT,(float)vect[0]));
132         root->add_child("y")->set_child_text(strprintf(VECTOR_VALUE_TYPE_FORMAT,(float)vect[1]));
133         return root;
134 }
135
136 xmlpp::Element* encode_color(xmlpp::Element* root,Color color)
137 {
138         root->set_name("color");
139         root->add_child("r")->set_child_text(strprintf(COLOR_VALUE_TYPE_FORMAT,(float)color.get_r()));
140         root->add_child("g")->set_child_text(strprintf(COLOR_VALUE_TYPE_FORMAT,(float)color.get_g()));
141         root->add_child("b")->set_child_text(strprintf(COLOR_VALUE_TYPE_FORMAT,(float)color.get_b()));
142         root->add_child("a")->set_child_text(strprintf(COLOR_VALUE_TYPE_FORMAT,(float)color.get_a()));
143         return root;
144 }
145
146 xmlpp::Element* encode_angle(xmlpp::Element* root,Angle theta)
147 {
148         root->set_name("angle");
149         root->set_attribute("value",strprintf("%f",(float)Angle::deg(theta).get()));
150         return root;
151 }
152
153 xmlpp::Element* encode_segment(xmlpp::Element* root,Segment seg)
154 {
155         root->set_name("segment");
156         encode_vector(root->add_child("p1")->add_child("vector"),seg.p1);
157         encode_vector(root->add_child("t1")->add_child("vector"),seg.t1);
158         encode_vector(root->add_child("p2")->add_child("vector"),seg.p2);
159         encode_vector(root->add_child("t2")->add_child("vector"),seg.t2);
160         return root;
161 }
162
163 xmlpp::Element* encode_bline_point(xmlpp::Element* root,BLinePoint bline_point)
164 {
165         root->set_name(ValueBase::type_name(ValueBase::TYPE_BLINEPOINT));
166
167         encode_vector(root->add_child("vertex")->add_child("vector"),bline_point.get_vertex());
168         encode_vector(root->add_child("t1")->add_child("vector"),bline_point.get_tangent1());
169
170         if(bline_point.get_split_tangent_flag())
171                 encode_vector(root->add_child("t2")->add_child("vector"),bline_point.get_tangent2());
172
173         encode_real(root->add_child("width")->add_child("real"),bline_point.get_width());
174         encode_real(root->add_child("origin")->add_child("real"),bline_point.get_origin());
175         return root;
176 }
177
178 xmlpp::Element* encode_gradient(xmlpp::Element* root,Gradient x)
179 {
180         root->set_name("gradient");
181
182         Gradient::const_iterator iter;
183         x.sort();
184         for(iter=x.begin();iter!=x.end();iter++)
185         {
186                 xmlpp::Element *cpoint(encode_color(root->add_child("color"),iter->color));
187                 cpoint->set_attribute("pos",strprintf("%f",iter->pos));
188         }
189         return root;
190 }
191
192
193 xmlpp::Element* encode_value(xmlpp::Element* root,const ValueBase &data,Canvas::ConstHandle canvas=0);
194
195 xmlpp::Element* encode_list(xmlpp::Element* root,std::list<ValueBase> list, Canvas::ConstHandle canvas=0)
196 {
197         root->set_name("list");
198
199         while(!list.empty())
200         {
201                 encode_value(root->add_child("value"),list.front(),canvas);
202                 list.pop_front();
203         }
204
205         return root;
206 }
207
208 xmlpp::Element* encode_value(xmlpp::Element* root,const ValueBase &data,Canvas::ConstHandle canvas)
209 {
210         switch(data.get_type())
211         {
212         case ValueBase::TYPE_REAL:
213                 return encode_real(root,data.get(Real()));
214         case ValueBase::TYPE_TIME:
215                 if(canvas)
216                         return encode_time(root,data.get(Time()),canvas->rend_desc().get_frame_rate());
217                 else
218                         return encode_time(root,data.get(Time()));
219         case ValueBase::TYPE_INTEGER:
220                 return encode_integer(root,data.get(int()));
221         case ValueBase::TYPE_COLOR:
222                 return encode_color(root,data.get(Color()));
223         case ValueBase::TYPE_VECTOR:
224                 return encode_vector(root,data.get(Vector()));
225         case ValueBase::TYPE_ANGLE:
226                 return encode_angle(root,data.get(Angle()));
227         case ValueBase::TYPE_BOOL:
228                 return encode_bool(root,data.get(bool()));
229         case ValueBase::TYPE_STRING:
230                 return encode_string(root,data.get(String()));
231         case ValueBase::TYPE_SEGMENT:
232                 return encode_segment(root,data.get(Segment()));
233         case ValueBase::TYPE_BLINEPOINT:
234                 return encode_bline_point(root,data.get(BLinePoint()));
235         case ValueBase::TYPE_GRADIENT:
236                 return encode_gradient(root,data.get(Gradient()));
237         case ValueBase::TYPE_LIST:
238                 return encode_list(root,data,canvas);
239         case ValueBase::TYPE_CANVAS:
240                 return encode_canvas(root,data.get(Canvas::Handle()).get());
241         case ValueBase::TYPE_NIL:
242                 synfig::error("Encountered NIL ValueBase");
243                 root->set_name("nil");
244                 return root;
245         default:
246                 synfig::error(strprintf("Unknown value(%s), cannot create XML representation!",ValueBase::type_name(data.get_type()).c_str()));
247                 root->set_name("nil");
248                 return root;
249         }
250 }
251
252 xmlpp::Element* encode_animated(xmlpp::Element* root,ValueNode_Animated::ConstHandle value_node,Canvas::ConstHandle canvas=0)
253 {
254         assert(value_node);
255         root->set_name("animated");
256
257         root->set_attribute("type",ValueBase::type_name(value_node->get_type()));
258
259         const ValueNode_Animated::WaypointList &waypoint_list=value_node->waypoint_list();
260         ValueNode_Animated::WaypointList::const_iterator iter;
261
262         for(iter=waypoint_list.begin();iter!=waypoint_list.end();++iter)
263         {
264                 xmlpp::Element *waypoint_node=root->add_child("waypoint");
265                 //waypoint_node->set_attribute("time",iter->get_time().get_string(canvas->rend_desc().get_frame_rate()));
266                 waypoint_node->set_attribute("time",iter->get_time().get_string());
267
268                 //waypoint_node->add_child(encode_value(iter->get_value(),canvas));
269                 if(iter->get_value_node()->is_exported())
270                         waypoint_node->set_attribute("use",iter->get_value_node()->get_relative_id(canvas));
271                 else {
272                         ValueNode::ConstHandle value_node = iter->get_value_node();
273                         if(ValueNode_Const::ConstHandle::cast_dynamic(value_node)) {
274                                 const ValueBase data = ValueNode_Const::ConstHandle::cast_dynamic(value_node)->get_value();
275                                 if (data.get_type() == ValueBase::TYPE_CANVAS)
276                                         waypoint_node->set_attribute("use",data.get(Canvas::Handle()).get()->get_relative_id(canvas));
277                                 else
278                                         encode_value_node(waypoint_node->add_child("value_node"),iter->get_value_node(),canvas);
279                         }
280                         else
281                                 encode_value_node(waypoint_node->add_child("value_node"),iter->get_value_node(),canvas);
282                 }
283
284                 switch(iter->get_before())
285                 {
286                 case INTERPOLATION_HALT:
287                         waypoint_node->set_attribute("before","halt");
288                         break;
289                 case INTERPOLATION_LINEAR:
290                         // This is the default value for angles, so don't add a new attribute for them
291                         if (value_node->get_type() != ValueBase::TYPE_ANGLE)
292                                 waypoint_node->set_attribute("before","linear");
293                         break;
294                 case INTERPOLATION_MANUAL:
295                         waypoint_node->set_attribute("before","manual");
296                         break;
297                 case INTERPOLATION_CONSTANT:
298                         waypoint_node->set_attribute("before","constant");
299                         break;
300                 case INTERPOLATION_TCB:
301                         // This is the default value, so don't add a new attribute (unless it's an angle - they default to linear)
302                         if (value_node->get_type() == ValueBase::TYPE_ANGLE)
303                                 waypoint_node->set_attribute("before","tcb");
304                         break;
305                 default:
306                         error("Unknown waypoint type for \"before\" attribute");
307                 }
308
309                 switch(iter->get_after())
310                 {
311                 case INTERPOLATION_HALT:
312                         waypoint_node->set_attribute("after","halt");
313                         break;
314                 case INTERPOLATION_LINEAR:
315                         // This is the default value for angles, so don't add a new attribute for them
316                         if (value_node->get_type() != ValueBase::TYPE_ANGLE)
317                                 waypoint_node->set_attribute("after","linear");
318                         break;
319                 case INTERPOLATION_MANUAL:
320                         waypoint_node->set_attribute("after","manual");
321                         break;
322                 case INTERPOLATION_CONSTANT:
323                         waypoint_node->set_attribute("after","constant");
324                         break;
325                 case INTERPOLATION_TCB:
326                         // This is the default value, so don't add a new attribute (unless it's an angle - they default to linear)
327                         if (value_node->get_type() == ValueBase::TYPE_ANGLE)
328                                 waypoint_node->set_attribute("after","tcb");
329                         break;
330                 default:
331                         error("Unknown waypoint type for \"after\" attribute");
332                 }
333
334                 if(iter->get_tension()!=0.0)
335                         waypoint_node->set_attribute("tension",strprintf("%f",iter->get_tension()));
336                 if(iter->get_time_tension()!=0.0)
337                         waypoint_node->set_attribute("temporal-tension",strprintf("%f",iter->get_time_tension()));
338                 if(iter->get_continuity()!=0.0)
339                         waypoint_node->set_attribute("continuity",strprintf("%f",iter->get_continuity()));
340                 if(iter->get_bias()!=0.0)
341                         waypoint_node->set_attribute("bias",strprintf("%f",iter->get_bias()));
342
343         }
344
345         return root;
346 }
347
348 xmlpp::Element* encode_composite(xmlpp::Element* root,ValueNode_Composite::ConstHandle value_node,Canvas::ConstHandle canvas=0)
349 {
350         assert(value_node);
351         root->set_name("composite");
352
353         root->set_attribute("type",ValueBase::type_name(value_node->get_type()));
354
355         int i;
356         for(i=0;i<value_node->link_count();i++)
357         {
358                 string name(strprintf("c%d",i+1));
359                 assert(value_node->get_link(i));
360                 if(value_node->get_link(i)->is_exported())
361                         root->set_attribute(name,value_node->get_link(i)->get_relative_id(canvas));
362                 else
363                         encode_value_node(root->add_child(name)->add_child("value_node"),value_node->get_link(i).constant(),canvas);
364         }
365
366         return root;
367 }
368
369 xmlpp::Element* encode_subtract(xmlpp::Element* root,ValueNode_Subtract::ConstHandle value_node,Canvas::ConstHandle canvas=0)
370 {
371         assert(value_node);
372         root->set_name("subtract");
373
374         ValueNode::ConstHandle lhs=value_node->get_lhs();
375         ValueNode::ConstHandle rhs=value_node->get_rhs();
376         ValueNode::ConstHandle scalar=value_node->get_scalar();
377
378         assert(lhs);
379         assert(rhs);
380
381         root->set_attribute("type",ValueBase::type_name(value_node->get_type()));
382
383         if(lhs==rhs)
384                 warning("LHS is equal to RHS, this <subtract> will always be zero!");
385
386         //if(value_node->get_scalar()!=1)
387         //      root->set_attribute("scalar",strprintf(VECTOR_VALUE_TYPE_FORMAT,value_node->get_scalar()));
388
389         if(!scalar->get_id().empty())
390                 root->set_attribute("scalar",scalar->get_relative_id(canvas));
391         else
392                 encode_value_node(root->add_child("scalar")->add_child("value_node"),scalar,canvas);
393
394         if(!lhs->get_id().empty())
395                 root->set_attribute("lhs",lhs->get_relative_id(canvas));
396         else
397                 encode_value_node(root->add_child("lhs")->add_child("value_node"),lhs,canvas);
398
399         if(!rhs->get_id().empty())
400                 root->set_attribute("rhs",rhs->get_relative_id(canvas));
401         else
402                 encode_value_node(root->add_child("rhs")->add_child("value_node"),rhs,canvas);
403
404         return root;
405 }
406
407 xmlpp::Element* encode_dynamic_list(xmlpp::Element* root,ValueNode_DynamicList::ConstHandle value_node,Canvas::ConstHandle canvas=0)
408 {
409         assert(value_node);
410         const float fps(canvas?canvas->rend_desc().get_frame_rate():0);
411
412         root->set_name(value_node->get_name());
413
414         root->set_attribute("type",ValueBase::type_name(value_node->get_contained_type()));
415
416         vector<ValueNode_DynamicList::ListEntry>::const_iterator iter;
417
418         ValueNode_BLine::ConstHandle bline_value_node(ValueNode_BLine::ConstHandle::cast_dynamic(value_node));
419
420         if(bline_value_node)
421         {
422                 if(bline_value_node->get_loop())
423                         root->set_attribute("loop","true");
424                 else
425                         root->set_attribute("loop","false");
426         }
427
428         for(iter=value_node->list.begin();iter!=value_node->list.end();++iter)
429         {
430                 xmlpp::Element  *entry_node=root->add_child("entry");
431                 assert(iter->value_node);
432                 if(!iter->value_node->get_id().empty())
433                         entry_node->set_attribute("use",iter->value_node->get_relative_id(canvas));
434                 else
435                         encode_value_node(entry_node->add_child("value_node"),iter->value_node,canvas);
436
437                 // process waypoints
438                 {
439                         typedef synfig::ValueNode_DynamicList::ListEntry::Activepoint Activepoint;
440                         typedef synfig::ValueNode_DynamicList::ListEntry::ActivepointList ActivepointList;
441                         String begin_sequence;
442                         String end_sequence;
443
444                         const ActivepointList& timing_info(iter->timing_info);
445                         ActivepointList::const_iterator entry_iter;
446
447                         for(entry_iter=timing_info.begin();entry_iter!=timing_info.end();++entry_iter)
448                                 if(entry_iter->state==true)
449                                 {
450                                         if(entry_iter->priority)
451                                         {
452                                                 printf("begin priority is %d\n", entry_iter->priority);
453                                                 begin_sequence+=strprintf("p%d ",entry_iter->priority);
454                                         }
455                                         begin_sequence+=entry_iter->time.get_string(fps)+", ";
456                                 }
457                                 else
458                                 {
459                                         if(entry_iter->priority)
460                                         {
461                                                 printf("end priority is %d\n", entry_iter->priority);
462                                                 end_sequence+=strprintf("p%d ",entry_iter->priority);
463                                         }
464                                         end_sequence+=entry_iter->time.get_string(fps)+", ";
465                                 }
466
467                         // If this is just a plane-jane vanilla entry,
468                         // then don't bother with begins and ends
469                         if(end_sequence.empty() && begin_sequence=="SOT, ")
470                                 begin_sequence.clear();
471
472                         if(!begin_sequence.empty())
473                         {
474                                 // Remove the last ", " stuff
475                                 begin_sequence=String(begin_sequence.begin(),begin_sequence.end()-2);
476                                 // Add the attribute
477                                 entry_node->set_attribute("on",begin_sequence);
478                         }
479
480                         if(!end_sequence.empty())
481                         {
482                                 // Remove the last ", " stuff
483                                 end_sequence=String(end_sequence.begin(),end_sequence.end()-2);
484                                 // Add the attribute
485                                 entry_node->set_attribute("off",end_sequence);
486                         }
487                 }
488         }
489
490         return root;
491 }
492
493 // Generic linkable data node entry
494 xmlpp::Element* encode_linkable_value_node(xmlpp::Element* root,LinkableValueNode::ConstHandle value_node,Canvas::ConstHandle canvas=0)
495 {
496         assert(value_node);
497         root->set_name(value_node->get_name());
498
499         root->set_attribute("type",ValueBase::type_name(value_node->get_type()));
500
501         int i;
502         for(i=0;i<value_node->link_count();i++)
503         {
504                 ValueNode::ConstHandle link=value_node->get_link(i).constant();
505                 if(!link)
506                         throw runtime_error("Bad link");
507                 if(link->is_exported())
508                         root->set_attribute(value_node->link_name(i),link->get_relative_id(canvas));
509                 else
510                         encode_value_node(root->add_child(value_node->link_name(i))->add_child("value_node"),link,canvas);
511         }
512
513         return root;
514 }
515
516 xmlpp::Element* encode_value_node(xmlpp::Element* root,ValueNode::ConstHandle value_node,Canvas::ConstHandle canvas)
517 {
518         assert(value_node);
519
520         if(ValueNode_Animated::ConstHandle::cast_dynamic(value_node))
521                 encode_animated(root,ValueNode_Animated::ConstHandle::cast_dynamic(value_node),canvas);
522         else
523         if(ValueNode_Composite::ConstHandle::cast_dynamic(value_node))
524                 encode_composite(root,ValueNode_Composite::ConstHandle::cast_dynamic(value_node),canvas);
525         else
526         if(ValueNode_Subtract::ConstHandle::cast_dynamic(value_node))
527                 encode_subtract(root,ValueNode_Subtract::ConstHandle::cast_dynamic(value_node),canvas);
528         else
529         if(ValueNode_DynamicList::ConstHandle::cast_dynamic(value_node))
530                 encode_dynamic_list(root,ValueNode_DynamicList::ConstHandle::cast_dynamic(value_node),canvas);
531         else if(ValueNode_Const::ConstHandle::cast_dynamic(value_node))
532         {
533                 encode_value(root,ValueNode_Const::ConstHandle::cast_dynamic(value_node)->get_value(),canvas);
534         }
535         else
536         if(LinkableValueNode::ConstHandle::cast_dynamic(value_node))
537                 encode_linkable_value_node(root,LinkableValueNode::ConstHandle::cast_dynamic(value_node),canvas);
538         else
539         {
540                 error(_("Unknown ValueNode Type (%s), cannot create an XML representation"),value_node->get_local_name().c_str());
541                 root->set_name("nil");
542         }
543
544         assert(root);
545
546         if(!value_node->get_id().empty())
547                 root->set_attribute("id",value_node->get_id());
548
549         if(value_node->rcount()>1)
550                 root->set_attribute("guid",(value_node->get_guid()^canvas->get_root()->get_guid()).get_string());
551
552         return root;
553 }
554
555 xmlpp::Element* encode_layer(xmlpp::Element* root,Layer::ConstHandle layer)
556 {
557         root->set_name("layer");
558
559         root->set_attribute("type",layer->get_name());
560         root->set_attribute("active",layer->active()?"true":"false");
561
562         if(!layer->get_version().empty())
563                 root->set_attribute("version",layer->get_version());
564         if(!layer->get_description().empty())
565                 root->set_attribute("desc",layer->get_description());
566         if(!layer->get_group().empty())
567                 root->set_attribute("group",layer->get_group());
568
569         Layer::Vocab vocab(layer->get_param_vocab());
570         Layer::Vocab::const_iterator iter;
571
572         const Layer::DynamicParamList &dynamic_param_list=layer->dynamic_param_list();
573
574         for(iter=vocab.begin();iter!=vocab.end();++iter)
575         {
576                 // Handle dynamic parameters
577                 if(dynamic_param_list.count(iter->get_name()))
578                 {
579                         xmlpp::Element *node=root->add_child("param");
580                         node->set_attribute("name",iter->get_name());
581
582                         handle<const ValueNode> value_node=dynamic_param_list.find(iter->get_name())->second;
583
584                         // If the valuenode has no ID, then it must be defined in-place
585                         if(value_node->get_id().empty())
586                         {
587                                 encode_value_node(node->add_child("value_node"),value_node,layer->get_canvas().constant());
588                         }
589                         else
590                         {
591                                 node->set_attribute("use",value_node->get_relative_id(layer->get_canvas()));
592                         }
593                 }
594                 else  // Handle normal parameters
595                 if(iter->get_critical())
596                 {
597                         ValueBase value=layer->get_param(iter->get_name());
598                         if(!value.is_valid())
599                         {
600                                 error("Layer doesn't know its own vocabulary -- "+iter->get_name());
601                                 continue;
602                         }
603
604                         if(value.get_type()==ValueBase::TYPE_CANVAS)
605                         {
606                                 // the ->is_inline() below was crashing if the canvas
607                                 // contained a PasteCanvas with the default <No Image
608                                 // Selected> Canvas setting;  this avoids the crash
609                                 if (!value.get(Canvas::LooseHandle()))
610                                         continue;
611
612                                 if (!value.get(Canvas::LooseHandle())->is_inline())
613                                 {
614                                         Canvas::Handle child(value.get(Canvas::LooseHandle()));
615
616                                         if(!value.get(Canvas::Handle()))
617                                                 continue;
618                                         xmlpp::Element *node=root->add_child("param");
619                                         node->set_attribute("name",iter->get_name());
620                                         node->set_attribute("use",child->get_relative_id(layer->get_canvas()));
621                                         continue;
622                                 }
623                         }
624                         xmlpp::Element *node=root->add_child("param");
625                         node->set_attribute("name",iter->get_name());
626
627                         encode_value(node->add_child("value"),value,layer->get_canvas().constant());
628                 }
629         }
630
631
632         return root;
633 }
634
635 xmlpp::Element* encode_canvas(xmlpp::Element* root,Canvas::ConstHandle canvas)
636 {
637         assert(canvas);
638         const RendDesc &rend_desc=canvas->rend_desc();
639         root->set_name("canvas");
640
641         if(canvas->is_root())
642                 root->set_attribute("version","0.1");
643
644         if(!canvas->get_id().empty() && !canvas->is_root() && !canvas->is_inline())
645                 root->set_attribute("id",canvas->get_id());
646
647         if(!canvas->parent() || canvas->parent()->rend_desc().get_w()!=canvas->rend_desc().get_w())
648                 root->set_attribute("width",strprintf("%d",rend_desc.get_w()));
649
650         if(!canvas->parent() || canvas->parent()->rend_desc().get_h()!=canvas->rend_desc().get_h())
651                 root->set_attribute("height",strprintf("%d",rend_desc.get_h()));
652
653         if(!canvas->parent() || canvas->parent()->rend_desc().get_x_res()!=canvas->rend_desc().get_x_res())
654                 root->set_attribute("xres",strprintf("%f",rend_desc.get_x_res()));
655
656         if(!canvas->parent() || canvas->parent()->rend_desc().get_y_res()!=canvas->rend_desc().get_y_res())
657                 root->set_attribute("yres",strprintf("%f",rend_desc.get_y_res()));
658
659
660         if(!canvas->parent() ||
661                 canvas->parent()->rend_desc().get_tl()!=canvas->rend_desc().get_tl() ||
662                 canvas->parent()->rend_desc().get_br()!=canvas->rend_desc().get_br())
663         root->set_attribute("view-box",strprintf(VIEW_BOX_FORMAT,
664                 rend_desc.get_tl()[0],
665                 rend_desc.get_tl()[1],
666                 rend_desc.get_br()[0],
667                 rend_desc.get_br()[1])
668         );
669
670         if(!canvas->parent() || canvas->parent()->rend_desc().get_antialias()!=canvas->rend_desc().get_antialias())
671                 root->set_attribute("antialias",strprintf("%d",rend_desc.get_antialias()));
672
673         if(!canvas->parent())
674                 root->set_attribute("fps",strprintf(TIME_TYPE_FORMAT,rend_desc.get_frame_rate()));
675
676         if(!canvas->parent() || canvas->parent()->rend_desc().get_time_start()!=canvas->rend_desc().get_time_start())
677                 root->set_attribute("begin-time",rend_desc.get_time_start().get_string(rend_desc.get_frame_rate()));
678
679         if(!canvas->parent() || canvas->parent()->rend_desc().get_time_end()!=canvas->rend_desc().get_time_end())
680                 root->set_attribute("end-time",rend_desc.get_time_end().get_string(rend_desc.get_frame_rate()));
681
682         if(!canvas->is_inline())
683         {
684                 root->set_attribute("bgcolor",strprintf(VIEW_BOX_FORMAT,
685                         rend_desc.get_bg_color().get_r(),
686                         rend_desc.get_bg_color().get_g(),
687                         rend_desc.get_bg_color().get_b(),
688                         rend_desc.get_bg_color().get_a())
689                 );
690
691                 if(!canvas->get_name().empty())
692                         root->add_child("name")->set_child_text(canvas->get_name());
693                 if(!canvas->get_description().empty())
694                         root->add_child("desc")->set_child_text(canvas->get_description());
695                 if(!canvas->get_author().empty())
696                         root->add_child("author")->set_child_text(canvas->get_description());
697
698                 std::list<String> meta_keys(canvas->get_meta_data_keys());
699                 while(!meta_keys.empty())
700                 {
701                         xmlpp::Element* meta_element(root->add_child("meta"));
702                         meta_element->set_attribute("name",meta_keys.front());
703                         meta_element->set_attribute("content",canvas->get_meta_data(meta_keys.front()));
704                         meta_keys.pop_front();
705                 }
706                 for(KeyframeList::const_iterator iter=canvas->keyframe_list().begin();iter!=canvas->keyframe_list().end();++iter)
707                         encode_keyframe(root->add_child("keyframe"),*iter,canvas->rend_desc().get_frame_rate());
708         }
709
710         // Output the <defs> section
711         if(!canvas->is_inline() && !canvas->value_node_list().empty() || !canvas->children().empty())
712         {
713                 xmlpp::Element *node=root->add_child("defs");
714                 const ValueNodeList &value_node_list(canvas->value_node_list());
715
716                 for(ValueNodeList::const_iterator iter=value_node_list.begin();iter!=value_node_list.end();++iter)
717                 {
718                         // If the value_node is a constant, then use the shorthand
719                         if(handle<ValueNode_Const>::cast_dynamic(*iter))
720                         {
721                                 ValueNode_Const::Handle value_node(ValueNode_Const::Handle::cast_dynamic(*iter));
722                                 reinterpret_cast<xmlpp::Element*>(encode_value(node->add_child("value"),value_node->get_value()))->set_attribute("id",value_node->get_id());
723                                 continue;
724                         }
725                         encode_value_node(node->add_child("value_node"),*iter,canvas);
726                         // writeme
727                 }
728
729                 for(Canvas::Children::const_iterator iter=canvas->children().begin();iter!=canvas->children().end();++iter)
730                 {
731                         encode_canvas(node->add_child("canvas"),*iter);
732                 }
733         }
734
735         Canvas::const_reverse_iterator iter;
736
737         for(iter=canvas->rbegin();iter!=canvas->rend();++iter)
738                 encode_layer(root->add_child("layer"),*iter);
739
740         return root;
741 }
742
743 bool
744 synfig::save_canvas(const String &filename, Canvas::ConstHandle canvas)
745 {
746     ChangeLocale change_locale(LC_NUMERIC, "C");
747
748         synfig::String tmp_filename(filename+".TMP");
749
750         try
751         {
752                 assert(canvas);
753                 xmlpp::Document document;
754
755                 encode_canvas(document.create_root_node("canvas"),canvas);
756
757                 document.write_to_file_formatted(tmp_filename);
758         }
759         catch(...) { synfig::error("synfig::save_canvas(): Caught unknown exception"); return false; }
760
761
762 #ifdef _WIN32
763         // On Win32 platforms, rename() has bad behavior. work around it.
764         char old_file[80]="sif.XXXXXXXX";
765         mktemp(old_file);
766         rename(filename.c_str(),old_file);
767         if(rename(tmp_filename.c_str(),filename.c_str())!=0)
768         {
769                 rename(old_file,tmp_filename.c_str());
770                 synfig::error("synfig::save_canvas(): Unable to rename file to correct filename, errno=%d",errno);
771                 return false;
772         }
773         remove(old_file);
774 #else
775         if(rename(tmp_filename.c_str(),filename.c_str())!=0)
776         {
777                 synfig::error("synfig::save_canvas(): Unable to rename file to correct filename, errno=%d",errno);
778                 return false;
779         }
780 #endif
781
782         return true;
783 }
784
785 String
786 synfig::canvas_to_string(Canvas::ConstHandle canvas)
787 {
788     ChangeLocale change_locale(LC_NUMERIC, "C");
789         assert(canvas);
790
791         xmlpp::Document document;
792
793         encode_canvas(document.create_root_node("canvas"),canvas);
794
795         return document.write_to_string_formatted();
796 }