Changeset 0ec9f5

Timestamp:

Apr 23, 2021, 9:02:12 PM (5 years ago)

Author:

Frederik Heber <frederik.heber@…>

Branches:

Candidate_v1.7.0, stable

Children:

0fbea3

Parents:

5061d9

git-author:

Frederik Heber <frederik.heber@…> (04/06/21 20:09:39)

git-committer:

Frederik Heber <frederik.heber@…> (04/23/21 21:02:12)

Message:

Added UndoMarkAction.

NOTE: This action is necessary as not all actions are actually recorded
in the history. For example, the UndoAction is an action that is not
pushed into the history deque and also must not as further undos would
then become impossible. There are other actions that just do output
or similar things that do not change the state.
This makes it impossible to undo back to a certain state by blindly
counting actions as one cannot know from the outside whether an action
is stateless or not.

• ActionHistory allows to mark a certain HistoryElement.
• marked element is reset when undone in history.
• marked element can be set and unset via UndoMarkAction.
• ActionQueue relays undoTillMark() to ActionHistory.
• extended UndoAction by param "till-mark" to allow step-wise undo and

undoing till the set mark.

• TESTS: added regression test case on undo-mark.

Files:

• doc/userguide/userguide.xml (modified) (1 diff)
• src/Actions/ActionHistory.cpp (modified) (2 diffs)
• src/Actions/ActionHistory.hpp (modified) (2 diffs)
• src/Actions/ActionQueue.cpp (modified) (1 diff)
• src/Actions/ActionQueue.hpp (modified) (2 diffs)
• src/Actions/CommandAction/UndoMarkAction.cpp (added)
• src/Actions/CommandAction/UndoMarkAction.def (added)
• src/Actions/CommandAction/UndoMarkAction.hpp (added)
• src/Actions/GlobalListOfActions.hpp (modified) (1 diff)
• src/Actions/Makefile.am (modified) (3 diffs)
• src/Actions/UndoAction.cpp (modified) (1 diff)
• src/Actions/UndoAction.def (modified) (2 diffs)
• tests/Python/AllActions/options.dat (modified) (2 diffs)
• tests/regression/Makefile.am (modified) (1 diff)
• tests/regression/Options/UndoMark/testsuite-options-undo-mark.at (added)
• tests/regression/Options/testsuite-options.at (modified) (1 diff)

doc/userguide/userguide.xml

@@ -426 +426 @@
         superfluous but it comes in very handy in the interactive ones. Also
         this should tell you that actions are placed internally in a queue, i.e. a history,
-        that undo and redo manipulate.</para>
+        that undo and redo manipulate.</para>
+        <para>Furthermore, a specific event in the history of actions can be 
+        marked using
+        <programlisting>... --add-atom H --domain-position &quot;0,0,0&quot; --undo-mark --select-all-atoms --remove-atom</programlisting>
+        Using this mark (that is unset by <programlisting>--undo-mark 0</programlisting>) 
+        one can then step directly back to that event by undoing all actions in between
+        the current and the marked event.
+        <programlisting>--undo --till-mark 1</programlisting>
+        Here, this will jump back to when the hydrogen atom was just added.
+        This function is required as not all actions produce an event in the Action 
+        history. Certain events will just calculate something and output, i.e. they
+        do not change the state. However, thereby one cannot simply count actions
+        to return back to a specific state. Hence, this function allows to mark a
+        specific state beforehand.
+        </para>
         <para>Due to a current limitation of the implementation each command can be used on the command-line only once. Note that this <emphasis role="italic">only</emphasis> applies to the command-line interface. All other interfaces, especially all interactive ones, do not have such a restriction. For the command-line interface there are several ways to work around it. Either by splitting the whole chain of commands into several chunks, each using only unique commands and using the input file (the state) to contain  and transport the intermediate stages as input for the next stage. Or to switch to other commands: often there are several possible ways of achieving a goal, especially when using selections.</para>
         <para>Being done now with the preliminaries we now go through all available actions present in MoleCuilder.</para>

src/Actions/ActionHistory.cpp

@@ -64 +64 @@
   HistoryElement elem = history.back();
   LOG(1, "INFO: Undoing action " << elem.action->getName());
+  if ((mark != NULL) && (mark == &elem)) {
+    LOG(2, "DEBUG: Undoing marked item in ActionHistory, hence resetting mark.");
+    mark = NULL;
+  }
   history.pop_back();
   ActionState::ptr newState = elem.action->undo(elem.state);
@@ -93 +97 @@
 }
 
+void ActionHistory::setMark() {
+  mark = &(history.back());
+}
+
+void ActionHistory::unsetMark() {
+  mark = NULL;
+}
+
+void ActionHistory::undoTillMark() {
+  if (mark == NULL) {
+    undoLast();
+  } else {
+    while (mark != &(history.back()))
+      undoLast();
+  }
+}
+
 void ActionHistory::addElement(Action* action,ActionState::ptr state){
   yrotsih.clear();

src/Actions/ActionHistory.hpp

@@ -43 +43 @@
   bool hasRedo();
 
+  void setMark();
+  void unsetMark();
+  void undoTillMark();
+
   void addElement(Action*,ActionState::ptr);
   void clear();
@@ -49 +53 @@
   std::deque<HistoryElement> history;
   std::deque<HistoryElement> yrotsih;
+
+  //!> marks a specific state in the history to allow undoing directly till that
+  HistoryElement * mark;
 
 public:

src/Actions/ActionQueue.cpp

@@ -412 +412 @@
 }
 
+void ActionQueue::setMark() {
+  history->setMark();
+}
+
+void ActionQueue::unsetMark() {
+  history->unsetMark();
+}
+
+void ActionQueue::undoTillMark()
+{
+  history->undoTillMark();
+}
+
 bool ActionQueue::canUndo() const
 {

src/Actions/ActionQueue.hpp

@@ -129 +129 @@
   void outputAsPython(std::ostream &output) const;
 
-  /** Undoes last called Acfriend void ::cleanUp();tion.
+  /** Undoes last called Action.
    *
    */
@@ -138 +138 @@
    */
   void redoLast();
+
+  /**
+   * Marks the current item of the action history to allow returning to that state lateron.
+   */
+  void setMark();
+
+  /**
+   * Resets any currently marked item in the action history.
+   */
+  void unsetMark();
+
+  /** Undoes actions till a set mark in the ActionHistory.
+   *
+   */
+  void undoTillMark();
 
   /** Checks whether there is one completed Action stored in ActionHistory in the past.

src/Actions/GlobalListOfActions.hpp

@@ -54 +54 @@
   (CommandSetRandomNumbersDistribution) \
   (CommandStoreSession) \
+  (CommandUndoMark) \
   (CommandVerbose) \
   (CommandVersion) \

src/Actions/Makefile.am

@@ -207 +207 @@
   Actions/CommandAction/NoDryRunAction.cpp \
   Actions/CommandAction/StoreSessionAction.cpp \
+  Actions/CommandAction/UndoMarkAction.cpp \
   Actions/CommandAction/VerboseAction.cpp \
   Actions/CommandAction/VersionAction.cpp \
@@ -219 +220 @@
   Actions/CommandAction/NoDryRunAction.hpp \
   Actions/CommandAction/StoreSessionAction.hpp \
+  Actions/CommandAction/UndoMarkAction.hpp \
   Actions/CommandAction/VerboseAction.hpp \
   Actions/CommandAction/VersionAction.hpp \
@@ -231 +233 @@
   Actions/CommandAction/NoDryRunAction.def \
   Actions/CommandAction/StoreSessionAction.def \
+  Actions/CommandAction/UndoMarkAction.def \
   Actions/CommandAction/VerboseAction.def \
   Actions/CommandAction/VersionAction.def \

src/Actions/UndoAction.cpp

@@ -52 +52 @@
 ActionState::ptr UndoAction::performCall(){
   // std::cout << "Undo" << std::endl;
-  ActionQueue::getInstance().undoLast();
+  if (params.undoTillMark.get())
+    ActionQueue::getInstance().undoTillMark();
+  else
+    ActionQueue::getInstance().undoLast();
   return Action::success;
 }

src/Actions/UndoAction.def

@@ -13 +13 @@
 // ValueStorage by the token "Z" -> first column: int, Z, "Z"
 // "undefine" if no parameters are required, use (NOPARAM_DEFAULT) for each (undefined) default value
-#undef paramtypes
-#undef paramreferences
-#undef paramtokens
-#undef paramdescriptions
-#undef paramdefaults
+#define paramtypes (bool)
+#define paramtokens ("till-mark")
+#define paramdescriptions ("whether to undo just a single step (false) or until a previously set mark (true)")
+#define paramdefaults (PARAM_DEFAULT(false))
+#define paramreferences (undoTillMark)
+#define paramvalids (DummyValidator<bool>())
 
 // some defines for all the names, you may use ACTION, STATE and PARAMS
@@ -27 +28 @@
 
 // finally the information stored in the ActionTrait specialization
-#define DESCRIPTION "undo last action"
+#define DESCRIPTION "undo last action or until a given mark"
 #undef SHORTFORM

tests/Python/AllActions/options.dat

@@ -250 +250 @@
 take_best_of            "5"
 tesselation_radius      "5."
+till-mark       "0"
 time_step_zero  "0"
 training_file   "training.dat"
@@ -255 +256 @@
 translate_shapes        "1. 2. 3."
 translation     "0. 0. 0."
+undo-mark       "0"
 unselect_atom_by_element        "1"
 unselect_atom_by_element        "4"

tests/regression/Makefile.am

@@ -180 +180 @@
         $(srcdir)/Options/Session/testsuite-options-store-session-python.at \
         $(srcdir)/Options/SetDefaultName/testsuite-options-set-default-name.at \
+        $(srcdir)/Options/UndoMark/testsuite-options-undo-mark.at \
         $(srcdir)/Options/Verbosity/testsuite-options-verbosity.at \
         $(srcdir)/Options/Warranty/testsuite-options-warranty.at \

tests/regression/Options/testsuite-options.at

@@ -55 +55 @@
 m4_include([Options/DryRun/testsuite-options-no-dryrun.at])
 m4_include([Options/DryRun/testsuite-options-dryrun-storesession.at])
+
+# test undo mark
+m4_include([Options/UndoMark/testsuite-options-undo-mark.at])