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_local_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_subtract(xmlpp::Element* root,ValueNode_Subtract::ConstHandle value_node,Canvas::ConstHandle canvas=0)
 346 {
 347         assert(value_node);
 348         root->set_name("subtract");
 349
 350         ValueNode::ConstHandle lhs=value_node->get_lhs();
 351         ValueNode::ConstHandle rhs=value_node->get_rhs();
 352         ValueNode::ConstHandle scalar=value_node->get_scalar();
 353
 354         assert(lhs);
 355         assert(rhs);
 356
 357         root->set_attribute("type",ValueBase::type_name(value_node->get_type()));
 358
 359         if(lhs==rhs)
 360                 warning("LHS is equal to RHS, this <subtract> will always be zero!");
 361
 362         //if(value_node->get_scalar()!=1)
 363         //      root->set_attribute("scalar",strprintf(VECTOR_VALUE_TYPE_FORMAT,value_node->get_scalar()));
 364
 365         if(!scalar->get_id().empty())
 366                 root->set_attribute("scalar",scalar->get_relative_id(canvas));
 367         else
 368                 encode_value_node(root->add_child("scalar")->add_child("value_node"),scalar,canvas);
 369
 370         if(!lhs->get_id().empty())
 371                 root->set_attribute("lhs",lhs->get_relative_id(canvas));
 372         else
 373                 encode_value_node(root->add_child("lhs")->add_child("value_node"),lhs,canvas);
 374
 375         if(!rhs->get_id().empty())
 376                 root->set_attribute("rhs",rhs->get_relative_id(canvas));
 377         else
 378                 encode_value_node(root->add_child("rhs")->add_child("value_node"),rhs,canvas);
 379
 380         return root;
 381 }
 382
 383 xmlpp::Element* encode_dynamic_list(xmlpp::Element* root,ValueNode_DynamicList::ConstHandle value_node,Canvas::ConstHandle canvas=0)
 384 {
 385         assert(value_node);
 386         const float fps(canvas?canvas->rend_desc().get_frame_rate():0);
 387
 388         root->set_name(value_node->get_name());
 389
 390         root->set_attribute("type",ValueBase::type_name(value_node->get_contained_type()));
 391
 392         vector<ValueNode_DynamicList::ListEntry>::const_iterator iter;
 393
 394         ValueNode_BLine::ConstHandle bline_value_node(ValueNode_BLine::ConstHandle::cast_dynamic(value_node));
 395
 396         if(bline_value_node)
 397         {
 398                 if(bline_value_node->get_loop())
 399                         root->set_attribute("loop","true");
 400                 else
 401                         root->set_attribute("loop","false");
 402         }
 403
 404         for(iter=value_node->list.begin();iter!=value_node->list.end();++iter)
 405         {
 406                 xmlpp::Element  *entry_node=root->add_child("entry");
 407                 assert(iter->value_node);
 408                 if(!iter->value_node->get_id().empty())
 409                         entry_node->set_attribute("use",iter->value_node->get_relative_id(canvas));
 410                 else
 411                         encode_value_node(entry_node->add_child("value_node"),iter->value_node,canvas);
 412
 413                 // process waypoints
 414                 {
 415                         typedef synfig::ValueNode_DynamicList::ListEntry::Activepoint Activepoint;
 416                         typedef synfig::ValueNode_DynamicList::ListEntry::ActivepointList ActivepointList;
 417                         String begin_sequence;
 418                         String end_sequence;
 419
 420                         const ActivepointList& timing_info(iter->timing_info);
 421                         ActivepointList::const_iterator entry_iter;
 422
 423                         for(entry_iter=timing_info.begin();entry_iter!=timing_info.end();++entry_iter)
 424                                 if(entry_iter->state==true)
 425                                 {
 426                                         if(entry_iter->priority)
 427                                         {
 428                                                 printf("begin priority is %d\n", entry_iter->priority);
 429                                                 begin_sequence+=strprintf("p%d ",entry_iter->priority);
 430                                         }
 431                                         begin_sequence+=entry_iter->time.get_string(fps)+", ";
 432                                 }
 433                                 else
 434                                 {
 435                                         if(entry_iter->priority)
 436                                         {
 437                                                 printf("end priority is %d\n", entry_iter->priority);
 438                                                 end_sequence+=strprintf("p%d ",entry_iter->priority);
 439                                         }
 440                                         end_sequence+=entry_iter->time.get_string(fps)+", ";
 441                                 }
 442
 443                         // If this is just a plane-jane vanilla entry,
 444                         // then don't bother with begins and ends
 445                         if(end_sequence.empty() && begin_sequence=="SOT, ")
 446                                 begin_sequence.clear();
 447
 448                         if(!begin_sequence.empty())
 449                         {
 450                                 // Remove the last ", " stuff
 451                                 begin_sequence=String(begin_sequence.begin(),begin_sequence.end()-2);
 452                                 // Add the attribute
 453                                 entry_node->set_attribute("on",begin_sequence);
 454                         }
 455
 456                         if(!end_sequence.empty())
 457                         {
 458                                 // Remove the last ", " stuff
 459                                 end_sequence=String(end_sequence.begin(),end_sequence.end()-2);
 460                                 // Add the attribute
 461                                 entry_node->set_attribute("off",end_sequence);
 462                         }
 463                 }
 464         }
 465
 466         return root;
 467 }
 468
 469 // Generic linkable data node entry
 470 xmlpp::Element* encode_linkable_value_node(xmlpp::Element* root,LinkableValueNode::ConstHandle value_node,Canvas::ConstHandle canvas=0)
 471 {
 472         assert(value_node);
 473         root->set_name(value_node->get_name());
 474
 475         root->set_attribute("type",ValueBase::type_name(value_node->get_type()));
 476
 477         int i;
 478         for(i=0;i<value_node->link_count();i++)
 479         {
 480                 ValueNode::ConstHandle link=value_node->get_link(i).constant();
 481                 if(!link)
 482                         throw runtime_error("Bad link");
 483                 if(link->is_exported())
 484                         root->set_attribute(value_node->link_name(i),link->get_relative_id(canvas));
 485                 else
 486                         encode_value_node(root->add_child(value_node->link_name(i))->add_child("value_node"),link,canvas);
 487         }
 488
 489         return root;
 490 }
 491
 492 xmlpp::Element* encode_value_node(xmlpp::Element* root,ValueNode::ConstHandle value_node,Canvas::ConstHandle canvas)
 493 {
 494         assert(value_node);
 495
 496         if(ValueNode_Animated::ConstHandle::cast_dynamic(value_node))
 497                 encode_animated(root,ValueNode_Animated::ConstHandle::cast_dynamic(value_node),canvas);
 498         else
 499         if(ValueNode_Subtract::ConstHandle::cast_dynamic(value_node))
 500                 encode_subtract(root,ValueNode_Subtract::ConstHandle::cast_dynamic(value_node),canvas);
 501         else
 502         if(ValueNode_DynamicList::ConstHandle::cast_dynamic(value_node))
 503                 encode_dynamic_list(root,ValueNode_DynamicList::ConstHandle::cast_dynamic(value_node),canvas);
 504         else if(ValueNode_Const::ConstHandle::cast_dynamic(value_node))
 505         {
 506                 encode_value(root,ValueNode_Const::ConstHandle::cast_dynamic(value_node)->get_value(),canvas);
 507         }
 508         else
 509         if(LinkableValueNode::ConstHandle::cast_dynamic(value_node))
 510                 encode_linkable_value_node(root,LinkableValueNode::ConstHandle::cast_dynamic(value_node),canvas);
 511         else
 512         {
 513                 error(_("Unknown ValueNode Type (%s), cannot create an XML representation"),value_node->get_local_name().c_str());
 514                 root->set_name("nil");
 515         }
 516
 517         assert(root);
 518
 519         if(!value_node->get_id().empty())
 520                 root->set_attribute("id",value_node->get_id());
 521
 522         if(value_node->rcount()>1)
 523                 root->set_attribute("guid",(value_node->get_guid()^canvas->get_root()->get_guid()).get_string());
 524
 525         return root;
 526 }
 527
 528 xmlpp::Element* encode_layer(xmlpp::Element* root,Layer::ConstHandle layer)
 529 {
 530         root->set_name("layer");
 531
 532         root->set_attribute("type",layer->get_name());
 533         root->set_attribute("active",layer->active()?"true":"false");
 534
 535         if(!layer->get_version().empty())
 536                 root->set_attribute("version",layer->get_version());
 537         if(!layer->get_description().empty())
 538                 root->set_attribute("desc",layer->get_description());
 539         if(!layer->get_group().empty())
 540                 root->set_attribute("group",layer->get_group());
 541
 542         Layer::Vocab vocab(layer->get_param_vocab());
 543         Layer::Vocab::const_iterator iter;
 544
 545         const Layer::DynamicParamList &dynamic_param_list=layer->dynamic_param_list();
 546
 547         for(iter=vocab.begin();iter!=vocab.end();++iter)
 548         {
 549                 // Handle dynamic parameters
 550                 if(dynamic_param_list.count(iter->get_name()))
 551                 {
 552                         xmlpp::Element *node=root->add_child("param");
 553                         node->set_attribute("name",iter->get_name());
 554
 555                         handle<const ValueNode> value_node=dynamic_param_list.find(iter->get_name())->second;
 556
 557                         // If the valuenode has no ID, then it must be defined in-place
 558                         if(value_node->get_id().empty())
 559                         {
 560                                 encode_value_node(node->add_child("value_node"),value_node,layer->get_canvas().constant());
 561                         }
 562                         else
 563                         {
 564                                 node->set_attribute("use",value_node->get_relative_id(layer->get_canvas()));
 565                         }
 566                 }
 567                 else  // Handle normal parameters
 568                 if(iter->get_critical())
 569                 {
 570                         ValueBase value=layer->get_param(iter->get_name());
 571                         if(!value.is_valid())
 572                         {
 573                                 error("Layer doesn't know its own vocabulary -- "+iter->get_name());
 574                                 continue;
 575                         }
 576
 577                         if(value.get_type()==ValueBase::TYPE_CANVAS)
 578                         {
 579                                 // the ->is_inline() below was crashing if the canvas
 580                                 // contained a PasteCanvas with the default <No Image
 581                                 // Selected> Canvas setting;  this avoids the crash
 582                                 if (!value.get(Canvas::LooseHandle()))
 583                                         continue;
 584
 585                                 if (!value.get(Canvas::LooseHandle())->is_inline())
 586                                 {
 587                                         Canvas::Handle child(value.get(Canvas::LooseHandle()));
 588
 589                                         if(!value.get(Canvas::Handle()))
 590                                                 continue;
 591                                         xmlpp::Element *node=root->add_child("param");
 592                                         node->set_attribute("name",iter->get_name());
 593                                         node->set_attribute("use",child->get_relative_id(layer->get_canvas()));
 594                                         continue;
 595                                 }
 596                         }
 597                         xmlpp::Element *node=root->add_child("param");
 598                         node->set_attribute("name",iter->get_name());
 599
 600                         encode_value(node->add_child("value"),value,layer->get_canvas().constant());
 601                 }
 602         }
 603
 604
 605         return root;
 606 }
 607
 608 xmlpp::Element* encode_canvas(xmlpp::Element* root,Canvas::ConstHandle canvas)
 609 {
 610         assert(canvas);
 611         const RendDesc &rend_desc=canvas->rend_desc();
 612         root->set_name("canvas");
 613
 614         if(canvas->is_root())
 615                 root->set_attribute("version",canvas->get_version());
 616
 617         if(!canvas->get_id().empty() && !canvas->is_root() && !canvas->is_inline())
 618                 root->set_attribute("id",canvas->get_id());
 619
 620         if(!canvas->parent() || canvas->parent()->rend_desc().get_w()!=canvas->rend_desc().get_w())
 621                 root->set_attribute("width",strprintf("%d",rend_desc.get_w()));
 622
 623         if(!canvas->parent() || canvas->parent()->rend_desc().get_h()!=canvas->rend_desc().get_h())
 624                 root->set_attribute("height",strprintf("%d",rend_desc.get_h()));
 625
 626         if(!canvas->parent() || canvas->parent()->rend_desc().get_x_res()!=canvas->rend_desc().get_x_res())
 627                 root->set_attribute("xres",strprintf("%f",rend_desc.get_x_res()));
 628
 629         if(!canvas->parent() || canvas->parent()->rend_desc().get_y_res()!=canvas->rend_desc().get_y_res())
 630                 root->set_attribute("yres",strprintf("%f",rend_desc.get_y_res()));
 631
 632
 633         if(!canvas->parent() ||
 634                 canvas->parent()->rend_desc().get_tl()!=canvas->rend_desc().get_tl() ||
 635                 canvas->parent()->rend_desc().get_br()!=canvas->rend_desc().get_br())
 636         root->set_attribute("view-box",strprintf(VIEW_BOX_FORMAT,
 637                 rend_desc.get_tl()[0],
 638                 rend_desc.get_tl()[1],
 639                 rend_desc.get_br()[0],
 640                 rend_desc.get_br()[1])
 641         );
 642
 643         if(!canvas->parent() || canvas->parent()->rend_desc().get_antialias()!=canvas->rend_desc().get_antialias())
 644                 root->set_attribute("antialias",strprintf("%d",rend_desc.get_antialias()));
 645
 646         if(!canvas->parent())
 647                 root->set_attribute("fps",strprintf(TIME_TYPE_FORMAT,rend_desc.get_frame_rate()));
 648
 649         if(!canvas->parent() || canvas->parent()->rend_desc().get_time_start()!=canvas->rend_desc().get_time_start())
 650                 root->set_attribute("begin-time",rend_desc.get_time_start().get_string(rend_desc.get_frame_rate()));
 651
 652         if(!canvas->parent() || canvas->parent()->rend_desc().get_time_end()!=canvas->rend_desc().get_time_end())
 653                 root->set_attribute("end-time",rend_desc.get_time_end().get_string(rend_desc.get_frame_rate()));
 654
 655         if(!canvas->is_inline())
 656         {
 657                 root->set_attribute("bgcolor",strprintf(VIEW_BOX_FORMAT,
 658                         rend_desc.get_bg_color().get_r(),
 659                         rend_desc.get_bg_color().get_g(),
 660                         rend_desc.get_bg_color().get_b(),
 661                         rend_desc.get_bg_color().get_a())
 662                 );
 663
 664                 if(!canvas->get_name().empty())
 665                         root->add_child("name")->set_child_text(canvas->get_name());
 666                 if(!canvas->get_description().empty())
 667                         root->add_child("desc")->set_child_text(canvas->get_description());
 668                 if(!canvas->get_author().empty())
 669                         root->add_child("author")->set_child_text(canvas->get_description());
 670
 671                 std::list<String> meta_keys(canvas->get_meta_data_keys());
 672                 while(!meta_keys.empty())
 673                 {
 674                         xmlpp::Element* meta_element(root->add_child("meta"));
 675                         meta_element->set_attribute("name",meta_keys.front());
 676                         meta_element->set_attribute("content",canvas->get_meta_data(meta_keys.front()));
 677                         meta_keys.pop_front();
 678                 }
 679                 for(KeyframeList::const_iterator iter=canvas->keyframe_list().begin();iter!=canvas->keyframe_list().end();++iter)
 680                         encode_keyframe(root->add_child("keyframe"),*iter,canvas->rend_desc().get_frame_rate());
 681         }
 682
 683         // Output the <defs> section
 684         //! \todo check where the parentheses should really go - around the && or the ||?
 685         if((!canvas->is_inline() && !canvas->value_node_list().empty()) || !canvas->children().empty())
 686         {
 687                 xmlpp::Element *node=root->add_child("defs");
 688                 const ValueNodeList &value_node_list(canvas->value_node_list());
 689
 690                 for(ValueNodeList::const_iterator iter=value_node_list.begin();iter!=value_node_list.end();++iter)
 691                 {
 692                         // If the value_node is a constant, then use the shorthand
 693                         if(handle<ValueNode_Const>::cast_dynamic(*iter))
 694                         {
 695                                 ValueNode_Const::Handle value_node(ValueNode_Const::Handle::cast_dynamic(*iter));
 696                                 reinterpret_cast<xmlpp::Element*>(encode_value(node->add_child("value"),value_node->get_value()))->set_attribute("id",value_node->get_id());
 697                                 continue;
 698                         }
 699                         encode_value_node(node->add_child("value_node"),*iter,canvas);
 700                         // writeme
 701                 }
 702
 703                 for(Canvas::Children::const_iterator iter=canvas->children().begin();iter!=canvas->children().end();++iter)
 704                 {
 705                         encode_canvas(node->add_child("canvas"),*iter);
 706                 }
 707         }
 708
 709         Canvas::const_reverse_iterator iter;
 710
 711         for(iter=canvas->rbegin();iter!=canvas->rend();++iter)
 712                 encode_layer(root->add_child("layer"),*iter);
 713
 714         return root;
 715 }
 716
 717 bool
 718 synfig::save_canvas(const String &filename, Canvas::ConstHandle canvas)
 719 {
 720     ChangeLocale change_locale(LC_NUMERIC, "C");
 721
 722         synfig::String tmp_filename(filename+".TMP");
 723
 724         if (filename_extension(filename) == ".sifz")
 725                 xmlSetCompressMode(9);
 726         else
 727                 xmlSetCompressMode(0);
 728
 729         try
 730         {
 731                 assert(canvas);
 732                 xmlpp::Document document;
 733
 734                 encode_canvas(document.create_root_node("canvas"),canvas);
 735
 736                 document.write_to_file_formatted(tmp_filename);
 737         }
 738         catch(...) { synfig::error("synfig::save_canvas(): Caught unknown exception"); return false; }
 739
 740
 741 #ifdef _WIN32
 742         // On Win32 platforms, rename() has bad behavior. work around it.
 743         char old_file[80]="sif.XXXXXXXX";
 744         mktemp(old_file);
 745         rename(filename.c_str(),old_file);
 746         if(rename(tmp_filename.c_str(),filename.c_str())!=0)
 747         {
 748                 rename(old_file,tmp_filename.c_str());
 749                 synfig::error("synfig::save_canvas(): Unable to rename file to correct filename, errno=%d",errno);
 750                 return false;
 751         }
 752         remove(old_file);
 753 #else
 754         if(rename(tmp_filename.c_str(),filename.c_str())!=0)
 755         {
 756                 synfig::error("synfig::save_canvas(): Unable to rename file to correct filename, errno=%d",errno);
 757                 return false;
 758         }
 759 #endif
 760
 761         return true;
 762 }
 763
 764 String
 765 synfig::canvas_to_string(Canvas::ConstHandle canvas)
 766 {
 767     ChangeLocale change_locale(LC_NUMERIC, "C");
 768         assert(canvas);
 769
 770         xmlpp::Document document;
 771
 772         encode_canvas(document.create_root_node("canvas"),canvas);
 773
 774         return document.write_to_string_formatted();
 775 }