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