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