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