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::ValueDescLinkOpposite);
 200         ADD_ACTION(Action::ValueDescBLineLink);
 201
 202         ADD_ACTION(Action::WaypointAdd);
 203         ADD_ACTION(Action::WaypointSet);
 204         ADD_ACTION(Action::WaypointSetSmart);
 205         ADD_ACTION(Action::WaypointRemove);
 206         ADD_ACTION(Action::WaypointConnect);
 207         ADD_ACTION(Action::WaypointDisconnect);
 208 //      ADD_ACTION(Action::WaypointSimpleAdd);
 209
 210         ADD_ACTION(Action::ActivepointAdd);
 211         ADD_ACTION(Action::ActivepointSet);
 212         ADD_ACTION(Action::ActivepointSetSmart);
 213         ADD_ACTION(Action::ActivepointSetOn);
 214         ADD_ACTION(Action::ActivepointSetOff);
 215         ADD_ACTION(Action::ActivepointRemove);
 216 //      ADD_ACTION(Action::ActivepointSimpleAdd);
 217
 218         ADD_ACTION(Action::KeyframeAdd);
 219         ADD_ACTION(Action::KeyframeSet);
 220         ADD_ACTION(Action::KeyframeRemove);
 221         ADD_ACTION(Action::KeyframeDuplicate);
 222         ADD_ACTION(Action::KeyframeWaypointSet);
 223         ADD_ACTION(Action::KeyframeSetDelta);
 224
 225         ADD_ACTION(Action::CanvasDescriptionSet);
 226         ADD_ACTION(Action::CanvasIdSet);
 227         ADD_ACTION(Action::CanvasNameSet);
 228         ADD_ACTION(Action::CanvasRendDescSet);
 229         ADD_ACTION(Action::CanvasAdd);
 230         ADD_ACTION(Action::CanvasRemove);
 231
 232         ADD_ACTION(Action::EditModeSet);
 233
 234         ADD_ACTION(Action::BLinePointTangentMerge);
 235         ADD_ACTION(Action::BLinePointTangentSplit);
 236
 237         ADD_ACTION(Action::GradientSet);
 238         ADD_ACTION(Action::ColorSetFromOC);
 239         ADD_ACTION(Action::ColorSetFromFC);
 240
 241         ADD_ACTION(Action::TimepointsMove);
 242         ADD_ACTION(Action::TimepointsCopy);
 243         ADD_ACTION(Action::TimepointsDelete);
 244
 245         ADD_ACTION(Action::GroupAddLayers);
 246         ADD_ACTION(Action::GroupRemoveLayers);
 247         ADD_ACTION(Action::GroupRemove);
 248         ADD_ACTION(Action::GroupRename);
 249 }
 250
 251 Action::Main::~Main()
 252 {
 253         delete book_;
 254
 255 }
 256
 257
 258 Action::Book& Action::book() { return *book_; }
 259
 260
 261 Action::Handle
 262 Action::create(const synfig::String &name)
 263 {
 264         if(!book().count(name))
 265                 return 0; //! \todo perhaps we should throw something instead?
 266         return book()[name].factory();
 267 }
 268
 269
 270 Action::CandidateList
 271 Action::compile_candidate_list(const ParamList& param_list, Category category)
 272 {
 273         Action::CandidateList ret;
 274
 275         Book::const_iterator iter;
 276
 277         //synfig::info("param_list.size()=%d",param_list.size());
 278
 279         for(iter=book().begin();iter!=book().end();++iter)
 280         {
 281                 if((iter->second.category&category))
 282                 {
 283                         if(iter->second.is_candidate(param_list))
 284                         {
 285                                 //synfig::info("Action \"%s\" is in",iter->second.name.c_str());
 286                                 ret.push_back(iter->second);
 287                         }
 288                         else
 289                         {
 290                                 //synfig::info("Action \"%s\" is not a candidate",iter->second.name.c_str());
 291                         }
 292                 }
 293                 else
 294                 {
 295                         //synfig::info("Action \"%s\" has unsuitable category",iter->second.name.c_str());
 296                 }
 297         }
 298
 299         return ret;
 300 }
 301
 302 Action::CandidateList::iterator
 303 Action::CandidateList::find(const synfig::String& x)
 304 {
 305         iterator iter;
 306         for(iter=begin();iter!=end();++iter)
 307                 if(iter->name==x)
 308                         break;
 309         return iter;
 310 }
 311
 312 void
 313 Action::Base::set_param_list(const ParamList &param_list)
 314 {
 315         ParamList::const_iterator iter;
 316
 317         for(iter=param_list.begin();iter!=param_list.end();++iter)
 318                 set_param(iter->first,iter->second);
 319 }
 320
 321 synfig::String
 322 Action::Base::get_layer_descriptions(const std::list<synfig::Layer::Handle> layers, synfig::String singular_prefix, synfig::String plural_prefix)
 323 {
 324         String ret;
 325         bool first = true;
 326
 327         if (plural_prefix.empty())
 328                 plural_prefix = singular_prefix;
 329
 330         if (layers.empty())
 331                 return plural_prefix;
 332
 333         if (layers.size() == 1)
 334                 ret = singular_prefix;
 335         else
 336                 ret = plural_prefix;
 337
 338         if (!ret.empty())
 339                 ret.push_back(' ');
 340
 341         for(std::list<synfig::Layer::Handle>::const_iterator iter=layers.begin(); iter!=layers.end(); ++iter)
 342         {
 343                 if (first)
 344                         first = false;
 345                 else
 346                         ret += ", ";
 347
 348                 ret += strprintf("'%s'", (*iter)->get_non_empty_description().c_str());
 349         }
 350
 351         return ret;
 352 }
 353
 354 synfig::String
 355 Action::Base::get_layer_descriptions(const std::list<std::pair<synfig::Layer::Handle,int> > layers, synfig::String singular_prefix, synfig::String plural_prefix)
 356 {
 357         String ret;
 358         bool first = true;
 359
 360         if (plural_prefix.empty())
 361                 plural_prefix = singular_prefix;
 362
 363         if (layers.empty())
 364                 return plural_prefix;
 365
 366         if (layers.size() == 1)
 367                 ret = singular_prefix;
 368         else
 369                 ret = plural_prefix;
 370
 371         if (!ret.empty())
 372                 ret.push_back(' ');
 373
 374         for(std::list<std::pair<synfig::Layer::Handle,int> >::const_iterator iter=layers.begin(); iter!=layers.end(); ++iter)
 375         {
 376                 if (first)
 377                         first = false;
 378                 else
 379                         ret += ", ";
 380
 381                 ret += strprintf("'%s'", iter->first->get_non_empty_description().c_str());
 382         }
 383
 384         return ret;
 385 }
 386
 387 void
 388 Super::perform()
 389 {
 390         set_dirty(false);
 391
 392         prepare();
 393
 394         ActionList::const_iterator iter;
 395         for(iter=action_list_.begin();iter!=action_list_.end();++iter)
 396         {
 397                 //// debug actions
 398                 // synfig::info("%s:%d action: '%s'", __FILE__, __LINE__, (*iter)->get_name().c_str());
 399                 try
 400                 {
 401                         try
 402                         {
 403                                 (*iter)->perform();
 404                                 CanvasSpecific* canvas_specific(dynamic_cast<CanvasSpecific*>(iter->get()));
 405                                 if(canvas_specific && canvas_specific->is_dirty())
 406                                         set_dirty(true);
 407                         }
 408                         catch(...)
 409                         {
 410                                 if(iter!=action_list_.begin())
 411                                 {
 412                                         for(--iter;iter!=action_list_.begin();--iter)
 413                                                 (*iter)->undo();
 414                                         (*iter)->undo();
 415                                 }
 416                                 throw;
 417                         }
 418                 }
 419                 catch(Error x)
 420                 {
 421                         //synfig::info("%s:%d caught exception", __FILE__, __LINE__);
 422                         throw Error(x.get_type(),((*iter)->get_local_name()+": "+x.get_desc()).c_str());
 423                 }
 424                 //synfig::info("%s:%d finished action: '%s'", __FILE__, __LINE__, (*iter)->get_name().c_str());
 425         }
 426 }
 427
 428 void
 429 Super::undo()
 430 {
 431         set_dirty(false);
 432
 433         ActionList::const_reverse_iterator iter;
 434         for(iter=const_cast<const ActionList &>(action_list_).rbegin();iter!=const_cast<const ActionList &>(action_list_).rend();++iter)
 435         {
 436                 try {
 437                         (*iter)->undo();
 438                         CanvasSpecific* canvas_specific(dynamic_cast<CanvasSpecific*>(iter->get()));
 439                         if(canvas_specific && canvas_specific->is_dirty())
 440                                 set_dirty(true);
 441                 }
 442                 catch(...)
 443                 {
 444                         if(iter!=const_cast<const ActionList &>(action_list_).rbegin())
 445                         {
 446                                 for(--iter;iter!=const_cast<const ActionList &>(action_list_).rbegin();--iter)
 447                                         (*iter)->perform();
 448                                 (*iter)->perform();
 449                         }
 450                         throw;
 451                 }
 452         }
 453 }
 454
 455 void
 456 Super::add_action(etl::handle<Undoable> action)
 457 {
 458         action_list_.push_back(action);
 459         CanvasSpecific *specific_action=dynamic_cast<CanvasSpecific *>(action.get());
 460         if(specific_action && !get_canvas())
 461                 set_canvas(specific_action->get_canvas());
 462 }
 463
 464 void
 465 Super::add_action_front(etl::handle<Undoable> action)
 466 {
 467         action_list_.push_front(action);
 468         CanvasSpecific *specific_action=dynamic_cast<CanvasSpecific *>(action.get());
 469         if(specific_action && !get_canvas())
 470                 set_canvas(specific_action->get_canvas());
 471 }
 472
 473
 474 Group::Group(const synfig::String &str):
 475         name_(str),
 476         ready_(true)
 477 {
 478 }
 479
 480 Group::~Group()
 481 {
 482 }
 483
 484
 485
 486
 487 Action::ParamVocab
 488 Action::CanvasSpecific::get_param_vocab()
 489 {
 490         ParamVocab ret;
 491
 492         ret.push_back(ParamDesc("canvas",Param::TYPE_CANVAS)
 493                 .set_local_name(_("Canvas"))
 494                 .set_desc(_("Selected Canvas"))
 495         );
 496
 497         ret.push_back(ParamDesc("canvas_interface",Param::TYPE_CANVASINTERFACE)
 498                 .set_local_name(_("Canvas Interface"))
 499                 .set_desc(_("Canvas Interface"))
 500                 .set_optional(true)
 501         );
 502
 503
 504         return ret;
 505 }
 506
 507 bool
 508 CanvasSpecific::set_param(const synfig::String& name, const Param &param)
 509 {
 510         if(name=="canvas" && param.get_type()==Param::TYPE_CANVAS)
 511         {
 512                 if(!param.get_canvas())
 513                         return false;
 514                 set_canvas(param.get_canvas());
 515
 516                 return true;
 517         }
 518         if(name=="canvas_interface" && param.get_type()==Param::TYPE_CANVASINTERFACE)
 519         {
 520                 if(!param.get_canvas_interface())
 521                         return false;
 522                 set_canvas_interface(param.get_canvas_interface());
 523                 if(!get_canvas())
 524                         set_canvas(get_canvas_interface()->get_canvas());
 525
 526                 return true;
 527         }
 528         if(name=="edit_mode" && param.get_type()==Param::TYPE_EDITMODE)
 529         {
 530                 set_edit_mode(param.get_edit_mode());
 531
 532                 return true;
 533         }
 534
 535         return false;
 536 }
 537
 538 bool
 539 CanvasSpecific::is_ready()const
 540 {
 541         if(!get_canvas())
 542                 return false;
 543         return true;
 544 }
 545
 546 EditMode
 547 CanvasSpecific::get_edit_mode()const
 548 {
 549         if(mode_!=MODE_UNDEFINED)
 550                 return mode_;
 551
 552         if(get_canvas_interface())
 553                 return get_canvas_interface()->get_mode();
 554
 555         return MODE_NORMAL;
 556 }