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