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