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