source: molecuilder/src/Actions/ActionSequence.cpp@ 91b18cd

Last change on this file since 91b18cd was abd4a1, checked in by Tillmann Crueger <crueger@…>, 15 years ago

Added detailed documentation for the Action class

  • Property mode set to 100644
File size: 3.1 KB
Line 
1/*
2 * ActionSequenze.cpp
3 *
4 * Created on: Dec 17, 2009
5 * Author: crueger
6 */
7
8#include "Actions/ActionSequence.hpp"
9#include "Actions/Action.hpp"
10
11#include "Helpers/Assert.hpp"
12
13using namespace std;
14
15ActionSequence::ActionSequence()
16{}
17
18ActionSequence::~ActionSequence()
19{}
20
21
22void ActionSequence::addAction(Action* _action){
23 actions.push_back(_action);
24}
25
26Action* ActionSequence::removeLastAction(){
27 if(actions.empty()) {
28 return 0;
29 }
30 else {
31 Action* theAction;
32 theAction = actions.back();
33 actions.pop_back();
34 return theAction;
35 }
36}
37
38// this method is used outside the ActionModule
39// Each action registers itself with the history
40void ActionSequence::callAll(){
41 for(actionSet::iterator it=actions.begin(); it!=actions.end(); it++){
42 // we want to have a global bookkeeping for all actions in the sequence, so
43 // we bypass the normal call
44 (*it)->call();
45 }
46}
47
48// This method is used internally when MakroActions are constructed.
49// In this case only the makro Action should be registered and
50// handle the states
51ActionSequence::stateSet ActionSequence::callAll(bool){
52 stateSet states;
53 for(actionSet::iterator it=actions.begin(); it!=actions.end(); it++){
54 // we want to have a global bookkeeping for all actions in the sequence, so
55 // we bypass the normal call
56 Action::state_ptr state = (*it)->performCall();
57 states.push_back(state);
58 }
59 return states;
60}
61
62ActionSequence::stateSet ActionSequence::undoAll(stateSet states){
63 ASSERT(canUndo(),"Trying to undo a sequence that contains methods that can't be undone");
64 stateSet res;
65 actionSet::reverse_iterator actionRit = actions.rbegin();
66 stateSet::reverse_iterator stateRit = states.rbegin();
67 for(;actionRit!=actions.rend();++actionRit,++stateRit){
68 ASSERT(stateRit!=states.rend(),"End of states prematurely reached.");
69 if((*actionRit)->shouldUndo()){
70 Action::state_ptr newState = (*actionRit)->performUndo(*stateRit);
71 // The order of the states has to correspond to the order of the actions
72 // this is why we have to add at the beginning
73 res.push_front(newState);
74 }
75 else{
76 res.push_front(Action::success);
77 }
78 }
79 return res;
80}
81
82ActionSequence::stateSet ActionSequence::redoAll(stateSet states){
83 stateSet res;
84 actionSet::iterator actionIt = actions.begin();
85 stateSet::iterator stateIt = states.begin();
86 for(;actionIt!=actions.end();++actionIt,++stateIt){
87 ASSERT(stateIt!=states.end(),"End of states prematurely reached.");
88 if((*actionIt)->shouldUndo()){
89 Action::state_ptr newState =(*actionIt)->performRedo(*stateIt);
90 res.push_back(newState);
91 }
92 else{
93 res.push_back(Action::success);
94 }
95 }
96 return res;
97}
98
99bool ActionSequence::canUndo(){
100 bool canUndo=true;
101 for(deque<Action*>::iterator it=actions.begin(); it!=actions.end(); ++it){
102 if((*it)->shouldUndo()){
103 canUndo &= (*it)->canUndo();
104 }
105 }
106 return canUndo;
107}
108
109bool ActionSequence::shouldUndo(){
110 bool shouldUndo = false;
111 for(deque<Action*>::iterator it=actions.begin();it!=actions.end();++it){
112 shouldUndo |= (*it)->shouldUndo();
113 }
114 return shouldUndo;
115}
Note: See TracBrowser for help on using the repository browser.