synfig-studio/trunk/src/synfigapp/action.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file action.cpp
   3 **      \brief Template File
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2008 Chris Moore
  10 **
  11 **      This package is free software; you can redistribute it and/or
  12 **      modify it under the terms of the GNU General Public License as
  13 **      published by the Free Software Foundation; either version 2 of
  14 **      the License, or (at your option) any later version.
  15 **
  16 **      This package is distributed in the hope that it will be useful,
  17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19 **      General Public License for more details.
  20 **      \endlegal
  21 */
  22 /* ========================================================================= */
  23
  24 /* === H E A D E R S ======================================================= */
  25
  26 #ifdef USING_PCH
  27 #       include "pch.h"
  28 #else
  29 #ifdef HAVE_CONFIG_H
  30 #       include <config.h>
  31 #endif
  32
  33 #include "action.h"
  34 #include "instance.h"
  35
  36
  37 #include "actions/layerremove.h"
  38 #include "actions/layermove.h"
  39 #include "actions/layerraise.h"
  40 #include "actions/layerlower.h"
  41 #include "actions/layeradd.h"
  42 #include "actions/layeractivate.h"
  43 #include "actions/layerparamset.h"
  44 #include "actions/layerparamconnect.h"
  45 #include "actions/layerparamdisconnect.h"
  46 #include "actions/layerencapsulate.h"
  47 #include "actions/layerduplicate.h"
  48 #include "actions/layersetdesc.h"
  49
  50 #include "actions/valuenodeconstset.h"
  51 #include "actions/valuenodeadd.h"
  52 #include "actions/valuenodereplace.h"
  53 #include "actions/valuenodelinkconnect.h"
  54 #include "actions/valuenodelinkdisconnect.h"
  55 #include "actions/valuenodedynamiclistinsert.h"
  56 #include "actions/valuenodedynamiclistremove.h"
  57 #include "actions/valuenodedynamiclistinsertsmart.h"
  58 #include "actions/valuenodedynamiclistremovesmart.h"
  59 #include "actions/valuenodedynamiclistloop.h"
  60 #include "actions/valuenodedynamiclistunloop.h"
  61 #include "actions/valuenodedynamiclistrotateorder.h"
  62 #include "actions/valuenoderename.h"
  63 #include "actions/valuenoderemove.h"
  64
  65 #include "actions/valuedescset.h"
  66 #include "actions/valuedescexport.h"
  67 #include "actions/valuedescconvert.h"
  68 #include "actions/valuedescconnect.h"
  69 #include "actions/valuedescdisconnect.h"
  70 #include "actions/valuedesclink.h"
  71 #include "actions/valuedescblinelink.h"
  72
  73 #include "actions/waypointadd.h"
  74 #include "actions/waypointset.h"
  75 #include "actions/waypointsetsmart.h"
  76 #include "actions/waypointremove.h"
  77 // #include "actions/waypointsimpleadd.h"
  78
  79 #include "actions/activepointadd.h"
  80 #include "actions/activepointset.h"
  81 #include "actions/activepointsetsmart.h"
  82 #include "actions/activepointsetoff.h"
  83 #include "actions/activepointseton.h"
  84 #include "actions/activepointremove.h"
  85 // #include "actions/activepointsimpleadd.h"
  86
  87 #include "actions/keyframeadd.h"
  88 #include "actions/keyframeset.h"
  89 #include "actions/keyframeremove.h"
  90 #include "actions/keyframeduplicate.h"
  91 #include "actions/keyframewaypointset.h"
  92 #include "actions/keyframesetdelta.h"
  93
  94 #include "actions/timepointsmove.h"
  95 #include "actions/timepointscopy.h"
  96 #include "actions/timepointsdelete.h"
  97
  98 #include "actions/canvasdescriptionset.h"
  99 #include "actions/canvasidset.h"
 100 #include "actions/canvasnameset.h"
 101 #include "actions/canvasrenddescset.h"
 102 #include "actions/canvasadd.h"
 103 #include "actions/canvasremove.h"
 104
 105 #include "actions/editmodeset.h"
 106
 107 #include "actions/blinepointtangentmerge.h"
 108 #include "actions/blinepointtangentsplit.h"
 109
 110 #include "actions/gradientset.h"
 111 #include "actions/colorset.h"
 112
 113 #include "actions/groupaddlayers.h"
 114 #include "actions/groupremovelayers.h"
 115 #include "actions/groupremove.h"
 116 #include "actions/grouprename.h"
 117
 118 #include "canvasinterface.h"
 119
 120 #include "general.h"
 121
 122 #endif
 123
 124 using namespace std;
 125 using namespace etl;
 126 using namespace synfig;
 127 using namespace synfigapp;
 128 using namespace Action;
 129
 130 /* === P R O C E D U R E S ================================================= */
 131
 132 /* === S T A T I C S ======================================================= */
 133
 134 synfigapp::Action::Book *book_;
 135
 136 /* === M E T H O D S ======================================================= */
 137
 138 #define ADD_ACTION(x) { BookEntry &be(book()[x::name__]); \
 139         be.name=x::name__; \
 140         be.local_name=dgettext("synfigstudio",x::local_name__); \
 141         be.version=x::version__; \
 142         be.task=x::task__; \
 143         be.priority=x::priority__; \
 144         be.category=x::category__; \
 145         be.factory=x::create; \
 146         be.get_param_vocab=x::get_param_vocab; \
 147         be.is_candidate=x::is_candidate; \
 148         }
 149
 150
 151 Action::Main::Main()
 152 {
 153         book_=new synfigapp::Action::Book();
 154
 155         ADD_ACTION(Action::LayerRemove);
 156         ADD_ACTION(Action::LayerMove);
 157         ADD_ACTION(Action::LayerRaise);
 158         ADD_ACTION(Action::LayerLower);
 159         ADD_ACTION(Action::LayerAdd);
 160         ADD_ACTION(Action::LayerActivate);
 161         ADD_ACTION(Action::LayerParamSet);
 162         ADD_ACTION(Action::LayerParamConnect);
 163         ADD_ACTION(Action::LayerParamDisconnect);
 164         ADD_ACTION(Action::LayerEncapsulate);
 165         ADD_ACTION(Action::LayerDuplicate);
 166         ADD_ACTION(Action::LayerSetDesc);
 167
 168         ADD_ACTION(Action::ValueNodeConstSet);
 169         ADD_ACTION(Action::ValueNodeAdd);
 170         ADD_ACTION(Action::ValueNodeReplace);
 171         ADD_ACTION(Action::ValueNodeLinkConnect);
 172         ADD_ACTION(Action::ValueNodeLinkDisconnect);
 173         ADD_ACTION(Action::ValueNodeDynamicListInsert);
 174         ADD_ACTION(Action::ValueNodeDynamicListRemove);
 175         ADD_ACTION(Action::ValueNodeDynamicListInsertSmart);
 176         ADD_ACTION(Action::ValueNodeDynamicListRemoveSmart);
 177         ADD_ACTION(Action::ValueNodeDynamicListLoop);
 178         ADD_ACTION(Action::ValueNodeDynamicListUnLoop);
 179         ADD_ACTION(Action::ValueNodeDynamicListRotateOrder);
 180         ADD_ACTION(Action::ValueNodeRename);
 181         ADD_ACTION(Action::ValueNodeRemove);
 182
 183         ADD_ACTION(Action::ValueDescSet);
 184         ADD_ACTION(Action::ValueDescExport);
 185         ADD_ACTION(Action::ValueDescConvert);
 186         ADD_ACTION(Action::ValueDescConnect);
 187         ADD_ACTION(Action::ValueDescDisconnect);
 188         ADD_ACTION(Action::ValueDescLink);
 189         ADD_ACTION(Action::ValueDescBLineLink);
 190
 191         ADD_ACTION(Action::WaypointAdd);
 192         ADD_ACTION(Action::WaypointSet);
 193         ADD_ACTION(Action::WaypointSetSmart);
 194         ADD_ACTION(Action::WaypointRemove);
 195 //      ADD_ACTION(Action::WaypointSimpleAdd);
 196
 197         ADD_ACTION(Action::ActivepointAdd);
 198         ADD_ACTION(Action::ActivepointSet);
 199         ADD_ACTION(Action::ActivepointSetSmart);
 200         ADD_ACTION(Action::ActivepointSetOn);
 201         ADD_ACTION(Action::ActivepointSetOff);
 202         ADD_ACTION(Action::ActivepointRemove);
 203 //      ADD_ACTION(Action::ActivepointSimpleAdd);
 204
 205         ADD_ACTION(Action::KeyframeAdd);
 206         ADD_ACTION(Action::KeyframeSet);
 207         ADD_ACTION(Action::KeyframeRemove);
 208         ADD_ACTION(Action::KeyframeDuplicate);
 209         ADD_ACTION(Action::KeyframeWaypointSet);
 210         ADD_ACTION(Action::KeyframeSetDelta);
 211
 212         ADD_ACTION(Action::CanvasDescriptionSet);
 213         ADD_ACTION(Action::CanvasIdSet);
 214         ADD_ACTION(Action::CanvasNameSet);
 215         ADD_ACTION(Action::CanvasRendDescSet);
 216         ADD_ACTION(Action::CanvasAdd);
 217         ADD_ACTION(Action::CanvasRemove);
 218
 219         ADD_ACTION(Action::EditModeSet);
 220
 221         ADD_ACTION(Action::BLinePointTangentMerge);
 222         ADD_ACTION(Action::BLinePointTangentSplit);
 223
 224         ADD_ACTION(Action::GradientSet);
 225         ADD_ACTION(Action::ColorSet);
 226
 227         ADD_ACTION(Action::TimepointsMove);
 228         ADD_ACTION(Action::TimepointsCopy);
 229         ADD_ACTION(Action::TimepointsDelete);
 230
 231         ADD_ACTION(Action::GroupAddLayers);
 232         ADD_ACTION(Action::GroupRemoveLayers);
 233         ADD_ACTION(Action::GroupRemove);
 234         ADD_ACTION(Action::GroupRename);
 235 }
 236
 237 Action::Main::~Main()
 238 {
 239         delete book_;
 240
 241 }
 242
 243
 244 Action::Book& Action::book() { return *book_; }
 245
 246
 247 Action::Handle
 248 Action::create(const synfig::String &name)
 249 {
 250         if(!book().count(name))
 251                 return 0; //! \todo perhaps we should throw something instead?
 252         return book()[name].factory();
 253 }
 254
 255
 256 Action::CandidateList
 257 Action::compile_candidate_list(const ParamList& param_list, Category category)
 258 {
 259         Action::CandidateList ret;
 260
 261         Book::const_iterator iter;
 262
 263         //synfig::info("param_list.size()=%d",param_list.size());
 264
 265         for(iter=book().begin();iter!=book().end();++iter)
 266         {
 267                 if((iter->second.category&category))
 268                 {
 269                         if(iter->second.is_candidate(param_list))
 270                         {
 271                                 //synfig::info("Action \"%s\" is in",iter->second.name.c_str());
 272                                 ret.push_back(iter->second);
 273                         }
 274                         else
 275                         {
 276                                 //synfig::info("Action \"%s\" is not a candidate",iter->second.name.c_str());
 277                         }
 278                 }
 279                 else
 280                 {
 281                         //synfig::info("Action \"%s\" has unsuitable category",iter->second.name.c_str());
 282                 }
 283         }
 284
 285         return ret;
 286 }
 287
 288 Action::CandidateList::iterator
 289 Action::CandidateList::find(const synfig::String& x)
 290 {
 291         iterator iter;
 292         for(iter=begin();iter!=end();++iter)
 293                 if(iter->name==x)
 294                         break;
 295         return iter;
 296 }
 297
 298 void
 299 Action::Base::set_param_list(const ParamList &param_list)
 300 {
 301         ParamList::const_iterator iter;
 302
 303         for(iter=param_list.begin();iter!=param_list.end();++iter)
 304                 set_param(iter->first,iter->second);
 305 }
 306
 307 synfig::String
 308 Action::Base::get_layer_descriptions(const std::list<synfig::Layer::Handle> layers, synfig::String singular_prefix, synfig::String plural_prefix)
 309 {
 310         String ret;
 311         bool first = true;
 312
 313         if (plural_prefix.empty())
 314                 plural_prefix = singular_prefix;
 315
 316         if (layers.empty())
 317                 return plural_prefix;
 318
 319         if (layers.size() == 1)
 320                 ret = singular_prefix;
 321         else
 322                 ret = plural_prefix;
 323
 324         if (!ret.empty())
 325                 ret.push_back(' ');
 326
 327         for(std::list<synfig::Layer::Handle>::const_iterator iter=layers.begin(); iter!=layers.end(); ++iter)
 328         {
 329                 if (first)
 330                         first = false;
 331                 else
 332                         ret += ", ";
 333
 334                 ret += strprintf("'%s'", (*iter)->get_non_empty_description().c_str());
 335         }
 336
 337         return ret;
 338 }
 339
 340 synfig::String
 341 Action::Base::get_layer_descriptions(const std::list<std::pair<synfig::Layer::Handle,int> > layers, synfig::String singular_prefix, synfig::String plural_prefix)
 342 {
 343         String ret;
 344         bool first = true;
 345
 346         if (plural_prefix.empty())
 347                 plural_prefix = singular_prefix;
 348
 349         if (layers.empty())
 350                 return plural_prefix;
 351
 352         if (layers.size() == 1)
 353                 ret = singular_prefix;
 354         else
 355                 ret = plural_prefix;
 356
 357         if (!ret.empty())
 358                 ret.push_back(' ');
 359
 360         for(std::list<std::pair<synfig::Layer::Handle,int> >::const_iterator iter=layers.begin(); iter!=layers.end(); ++iter)
 361         {
 362                 if (first)
 363                         first = false;
 364                 else
 365                         ret += ", ";
 366
 367                 ret += strprintf("'%s'", iter->first->get_non_empty_description().c_str());
 368         }
 369
 370         return ret;
 371 }
 372
 373 void
 374 Super::perform()
 375 {
 376         set_dirty(false);
 377
 378         prepare();
 379
 380         ActionList::const_iterator iter;
 381         //synfig::info("%s:%d actions...", __FILE__, __LINE__);
 382         for(iter=action_list_.begin();iter!=action_list_.end();++iter)
 383         {
 384                 //synfig::info("%s:%d action: '%s'", __FILE__, __LINE__, (*iter)->get_name().c_str());
 385                 try
 386                 {
 387                         try
 388                         {
 389                                 (*iter)->perform();
 390                                 CanvasSpecific* canvas_specific(dynamic_cast<CanvasSpecific*>(iter->get()));
 391                                 if(canvas_specific && canvas_specific->is_dirty())
 392                                         set_dirty(true);
 393                         }
 394                         catch(...)
 395                         {
 396                                 if(iter!=action_list_.begin())
 397                                 {
 398                                         for(--iter;iter!=action_list_.begin();--iter)
 399                                                 (*iter)->undo();
 400                                         (*iter)->undo();
 401                                 }
 402                                 throw;
 403                         }
 404                 }
 405                 catch(Error x)
 406                 {
 407                         //synfig::info("%s:%d caught exception", __FILE__, __LINE__);
 408                         throw Error(x.get_type(),((*iter)->get_name()+": "+x.get_desc()).c_str());
 409                 }
 410                 //synfig::info("%s:%d finished action: '%s'", __FILE__, __LINE__, (*iter)->get_name().c_str());
 411         }
 412 }
 413
 414 void
 415 Super::undo()
 416 {
 417         set_dirty(false);
 418
 419         ActionList::const_reverse_iterator iter;
 420         for(iter=const_cast<const ActionList &>(action_list_).rbegin();iter!=const_cast<const ActionList &>(action_list_).rend();++iter)
 421         {
 422                 try {
 423                         (*iter)->undo();
 424                         CanvasSpecific* canvas_specific(dynamic_cast<CanvasSpecific*>(iter->get()));
 425                         if(canvas_specific && canvas_specific->is_dirty())
 426                                 set_dirty(true);
 427                 }
 428                 catch(...)
 429                 {
 430                         if(iter!=const_cast<const ActionList &>(action_list_).rbegin())
 431                         {
 432                                 for(--iter;iter!=const_cast<const ActionList &>(action_list_).rbegin();--iter)
 433                                         (*iter)->perform();
 434                                 (*iter)->perform();
 435                         }
 436                         throw;
 437                 }
 438         }
 439 }
 440
 441 void
 442 Super::add_action(etl::handle<Undoable> action)
 443 {
 444         action_list_.push_back(action);
 445         CanvasSpecific *specific_action=dynamic_cast<CanvasSpecific *>(action.get());
 446         if(specific_action && !get_canvas())
 447                 set_canvas(specific_action->get_canvas());
 448 }
 449
 450 void
 451 Super::add_action_front(etl::handle<Undoable> action)
 452 {
 453         action_list_.push_front(action);
 454         CanvasSpecific *specific_action=dynamic_cast<CanvasSpecific *>(action.get());
 455         if(specific_action && !get_canvas())
 456                 set_canvas(specific_action->get_canvas());
 457 }
 458
 459
 460 Group::Group(const synfig::String &str):
 461         name_(str),
 462         ready_(true)
 463 {
 464 }
 465
 466 Group::~Group()
 467 {
 468 }
 469
 470
 471
 472
 473 Action::ParamVocab
 474 Action::CanvasSpecific::get_param_vocab()
 475 {
 476         ParamVocab ret;
 477
 478         ret.push_back(ParamDesc("canvas",Param::TYPE_CANVAS)
 479                 .set_local_name(_("Canvas"))
 480                 .set_desc(_("Selected Canvas"))
 481         );
 482
 483         ret.push_back(ParamDesc("canvas_interface",Param::TYPE_CANVASINTERFACE)
 484                 .set_local_name(_("Canvas Interface"))
 485                 .set_desc(_("Canvas Interface"))
 486                 .set_optional(true)
 487         );
 488
 489
 490         return ret;
 491 }
 492
 493 bool
 494 CanvasSpecific::set_param(const synfig::String& name, const Param &param)
 495 {
 496         if(name=="canvas" && param.get_type()==Param::TYPE_CANVAS)
 497         {
 498                 if(!param.get_canvas())
 499                         return false;
 500                 set_canvas(param.get_canvas());
 501
 502                 return true;
 503         }
 504         if(name=="canvas_interface" && param.get_type()==Param::TYPE_CANVASINTERFACE)
 505         {
 506                 if(!param.get_canvas_interface())
 507                         return false;
 508                 set_canvas_interface(param.get_canvas_interface());
 509                 if(!get_canvas())
 510                         set_canvas(get_canvas_interface()->get_canvas());
 511
 512                 return true;
 513         }
 514         if(name=="edit_mode" && param.get_type()==Param::TYPE_EDITMODE)
 515         {
 516                 set_edit_mode(param.get_edit_mode());
 517
 518                 return true;
 519         }
 520
 521         return false;
 522 }
 523
 524 bool
 525 CanvasSpecific::is_ready()const
 526 {
 527         if(!get_canvas())
 528                 return false;
 529         return true;
 530 }
 531
 532 EditMode
 533 CanvasSpecific::get_edit_mode()const
 534 {
 535         if(mode_!=MODE_UNDEFINED)
 536                 return mode_;
 537
 538         if(get_canvas_interface())
 539                 return get_canvas_interface()->get_mode();
 540
 541         return MODE_NORMAL;
 542 }