src/document-undo.cpp

   1 #define __SP_DOCUMENT_UNDO_C__
   2
   3 /** \file
   4  * Undo/Redo stack implementation
   5  *
   6  * Authors:
   7  *   Lauris Kaplinski <lauris@kaplinski.com>
   8  *   MenTaLguY <mental@rydia.net>
   9  *
  10  * Copyright (C) 2007  MenTaLguY <mental@rydia.net>
  11  * Copyright (C) 1999-2003 authors
  12  * Copyright (C) 2001-2002 Ximian, Inc.
  13  *
  14  * Released under GNU GPL, read the file 'COPYING' for more information
  15  *
  16  * Using the split document model gives sodipodi a very simple and clean
  17  * undo implementation. Whenever mutation occurs in the XML tree,
  18  * SPObject invokes one of the five corresponding handlers of its
  19  * container document. This writes down a generic description of the
  20  * given action, and appends it to the recent action list, kept by the
  21  * document. There will be as many action records as there are mutation
  22  * events, which are all kept and processed together in the undo
  23  * stack. Two methods exist to indicate that the given action is completed:
  24  *
  25  * \verbatim
  26    void sp_document_done (SPDocument *document);
  27    void sp_document_maybe_done (SPDocument *document, const unsigned char *key) \endverbatim
  28  *
  29  * Both move the recent action list into the undo stack and clear the
  30  * list afterwards.  While the first method does an unconditional push,
  31  * the second one first checks the key of the most recent stack entry. If
  32  * the keys are identical, the current action list is appended to the
  33  * existing stack entry, instead of pushing it onto its own.  This
  34  * behaviour can be used to collect multi-step actions (like winding the
  35  * Gtk spinbutton) from the UI into a single undoable step.
  36  *
  37  * For controls implemented by Sodipodi itself, implementing undo as a
  38  * single step is usually done in a more efficent way. Most controls have
  39  * the abstract model of grab, drag, release, and change user
  40  * action. During the grab phase, all modifications are done to the
  41  * SPObject directly - i.e. they do not change XML tree, and thus do not
  42  * generate undo actions either.  Only at the release phase (normally
  43  * associated with releasing the mousebutton), changes are written back
  44  * to the XML tree, thus generating only a single set of undo actions.
  45  * (Lauris Kaplinski)
  46  */
  47
  48 #ifdef HAVE_CONFIG_H
  49 # include "config.h"
  50 #endif
  51
  52
  53
  54 #if HAVE_STRING_H
  55 #endif
  56
  57
  58 #if HAVE_STDLIB_H
  59 #endif
  60
  61 #include "xml/repr.h"
  62 #include "document-private.h"
  63 #include "inkscape.h"
  64 #include "debug/event-tracker.h"
  65 #include "debug/simple-event.h"
  66 #include "event.h"
  67
  68
  69 /*
  70  * Undo & redo
  71  */
  72 /**
  73  * Set undo sensitivity.
  74  *
  75  * \note
  76  *   Since undo sensitivity needs to be nested, setting undo sensitivity
  77  *   should be done like this:
  78  *\verbatim
  79         bool saved = sp_document_get_undo_sensitive(document);
  80         sp_document_set_undo_sensitive(document, false);
  81         ... do stuff ...
  82         sp_document_set_undo_sensitive(document, saved);  \endverbatim
  83  */
  84 void
  85 sp_document_set_undo_sensitive (SPDocument *doc, bool sensitive)
  86 {
  87         g_assert (doc != NULL);
  88         g_assert (doc->priv != NULL);
  89
  90         if ( sensitive == doc->priv->sensitive )
  91                 return;
  92
  93         if (sensitive) {
  94                 sp_repr_begin_transaction (doc->rdoc);
  95         } else {
  96                 doc->priv->partial = sp_repr_coalesce_log (
  97                         doc->priv->partial,
  98                         sp_repr_commit_undoable (doc->rdoc)
  99                 );
 100         }
 101
 102         doc->priv->sensitive = sensitive;
 103 }
 104
 105 /*TODO: Throughout the inkscape code tree set/get_undo_sensitive are used for
 106  * as is shown above.  Perhaps it makes sense to create new functions,
 107  * undo_ignore, and undo_recall to replace the start and end parts of the above.
 108  * The main complexity with this is that they have to nest, so you have to store
 109  * the saved bools in a stack.  Perhaps this is why the above solution is better.
 110  */
 111
 112 bool sp_document_get_undo_sensitive(SPDocument const *document) {
 113         g_assert(document != NULL);
 114         g_assert(document->priv != NULL);
 115
 116         return document->priv->sensitive;
 117 }
 118
 119 void
 120 sp_document_done (SPDocument *doc, const unsigned int event_type, Glib::ustring event_description)
 121 {
 122         sp_document_maybe_done (doc, NULL, event_type, event_description);
 123 }
 124
 125 void
 126 sp_document_reset_key (Inkscape::Application *inkscape, SPDesktop *desktop, GtkObject *base)
 127 {
 128         SPDocument *doc = (SPDocument *) base;
 129         doc->actionkey = NULL;
 130 }
 131
 132 void
 133 sp_document_maybe_done (SPDocument *doc, const gchar *key, const unsigned int event_type,
 134                         Glib::ustring event_description)
 135 {
 136         g_assert (doc != NULL);
 137         g_assert (doc->priv != NULL);
 138         g_assert (doc->priv->sensitive);
 139
 140         doc->collectOrphans();
 141
 142         sp_document_ensure_up_to_date (doc);
 143
 144         sp_document_clear_redo (doc);
 145
 146         Inkscape::XML::Event *log = sp_repr_coalesce_log (doc->priv->partial, sp_repr_commit_undoable (doc->rdoc));
 147         doc->priv->partial = NULL;
 148
 149         if (!log) {
 150                 sp_repr_begin_transaction (doc->rdoc);
 151                 return;
 152         }
 153
 154         if (key && doc->actionkey && !strcmp (key, doc->actionkey) && doc->priv->undo) {
 155                 ((Inkscape::Event *)doc->priv->undo->data)->event =
 156                     sp_repr_coalesce_log (((Inkscape::Event *)doc->priv->undo->data)->event, log);
 157         } else {
 158                 Inkscape::Event *event = new Inkscape::Event(log, event_type, event_description);
 159                 doc->priv->undo = g_slist_prepend (doc->priv->undo, event);
 160                 doc->priv->history_size++;
 161                 doc->priv->undoStackObservers.notifyUndoCommitEvent(event);
 162         }
 163
 164         doc->actionkey = key;
 165
 166         doc->virgin = FALSE;
 167         if (!doc->rroot->attribute("sodipodi:modified")) {
 168                 doc->rroot->setAttribute("sodipodi:modified", "true");
 169         }
 170
 171         sp_repr_begin_transaction (doc->rdoc);
 172
 173   doc->priv->commit_signal.emit();
 174 }
 175
 176 void
 177 sp_document_cancel (SPDocument *doc)
 178 {
 179         g_assert (doc != NULL);
 180         g_assert (doc->priv != NULL);
 181         g_assert (doc->priv->sensitive);
 182
 183         sp_repr_rollback (doc->rdoc);
 184
 185         if (doc->priv->partial) {
 186                 sp_repr_undo_log (doc->priv->partial);
 187                 sp_repr_free_log (doc->priv->partial);
 188                 doc->priv->partial = NULL;
 189         }
 190
 191         sp_repr_begin_transaction (doc->rdoc);
 192 }
 193
 194 namespace {
 195
 196 void finish_incomplete_transaction(SPDocument &doc) {
 197         SPDocumentPrivate &priv=*doc.priv;
 198         Inkscape::XML::Event *log=sp_repr_commit_undoable(doc.rdoc);
 199         if (log || priv.partial) {
 200                 g_warning ("Incomplete undo transaction:");
 201                 priv.partial = sp_repr_coalesce_log(priv.partial, log);
 202                 sp_repr_debug_print_log(priv.partial);
 203                 Inkscape::Event *event = new Inkscape::Event(priv.partial);
 204                 priv.undo = g_slist_prepend(priv.undo, event);
 205                 priv.undoStackObservers.notifyUndoCommitEvent(event);
 206                 priv.partial = NULL;
 207         }
 208 }
 209
 210 }
 211
 212 gboolean
 213 sp_document_undo (SPDocument *doc)
 214 {
 215         using Inkscape::Debug::EventTracker;
 216         using Inkscape::Debug::SimpleEvent;
 217
 218         gboolean ret;
 219
 220         EventTracker<SimpleEvent<Inkscape::Debug::Event::DOCUMENT> > tracker("undo");
 221
 222         g_assert (doc != NULL);
 223         g_assert (doc->priv != NULL);
 224         g_assert (doc->priv->sensitive);
 225
 226         doc->priv->sensitive = FALSE;
 227         doc->priv->seeking = true;
 228
 229         doc->actionkey = NULL;
 230
 231         finish_incomplete_transaction(*doc);
 232
 233         if (doc->priv->undo) {
 234                 Inkscape::Event *log=(Inkscape::Event *)doc->priv->undo->data;
 235                 doc->priv->undo = g_slist_remove (doc->priv->undo, log);
 236                 sp_repr_undo_log (log->event);
 237                 doc->priv->redo = g_slist_prepend (doc->priv->redo, log);
 238
 239                 doc->rroot->setAttribute("sodipodi:modified", "true");
 240                 doc->priv->undoStackObservers.notifyUndoEvent(log);
 241
 242                 ret = TRUE;
 243         } else {
 244                 ret = FALSE;
 245         }
 246
 247         sp_repr_begin_transaction (doc->rdoc);
 248
 249         doc->priv->sensitive = TRUE;
 250         doc->priv->seeking = false;
 251
 252         if (ret)
 253                 inkscape_external_change();
 254
 255         return ret;
 256 }
 257
 258 gboolean
 259 sp_document_redo (SPDocument *doc)
 260 {
 261         using Inkscape::Debug::EventTracker;
 262         using Inkscape::Debug::SimpleEvent;
 263
 264         gboolean ret;
 265
 266         EventTracker<SimpleEvent<Inkscape::Debug::Event::DOCUMENT> > tracker("redo");
 267
 268         g_assert (doc != NULL);
 269         g_assert (doc->priv != NULL);
 270         g_assert (doc->priv->sensitive);
 271
 272         doc->priv->sensitive = FALSE;
 273         doc->priv->seeking = true;
 274
 275         doc->actionkey = NULL;
 276
 277         finish_incomplete_transaction(*doc);
 278
 279         if (doc->priv->redo) {
 280                 Inkscape::Event *log=(Inkscape::Event *)doc->priv->redo->data;
 281                 doc->priv->redo = g_slist_remove (doc->priv->redo, log);
 282                 sp_repr_replay_log (log->event);
 283                 doc->priv->undo = g_slist_prepend (doc->priv->undo, log);
 284
 285                 doc->rroot->setAttribute("sodipodi:modified", "true");
 286                 doc->priv->undoStackObservers.notifyRedoEvent(log);
 287
 288                 ret = TRUE;
 289         } else {
 290                 ret = FALSE;
 291         }
 292
 293         sp_repr_begin_transaction (doc->rdoc);
 294
 295         doc->priv->sensitive = TRUE;
 296         doc->priv->seeking = false;
 297
 298         if (ret)
 299                 inkscape_external_change();
 300
 301         return ret;
 302 }
 303
 304 void
 305 sp_document_clear_undo (SPDocument *doc)
 306 {
 307         if (doc->priv->undo)
 308                 doc->priv->undoStackObservers.notifyClearUndoEvent();
 309
 310         while (doc->priv->undo) {
 311                 GSList *current;
 312
 313                 current = doc->priv->undo;
 314                 doc->priv->undo = current->next;
 315                 doc->priv->history_size--;
 316
 317                 delete ((Inkscape::Event *) current->data);
 318                 g_slist_free_1 (current);
 319         }
 320 }
 321
 322 void
 323 sp_document_clear_redo (SPDocument *doc)
 324 {
 325         if (doc->priv->redo)
 326                 doc->priv->undoStackObservers.notifyClearRedoEvent();
 327
 328         while (doc->priv->redo) {
 329                 GSList *current;
 330
 331                 current = doc->priv->redo;
 332                 doc->priv->redo = current->next;
 333                 doc->priv->history_size--;
 334
 335                 delete ((Inkscape::Event *) current->data);
 336                 g_slist_free_1 (current);
 337         }
 338 }
 339 /*
 340   Local Variables:
 341   mode:c++
 342   c-file-style:"stroustrup"
 343   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 344   indent-tabs-mode:nil
 345   fill-column:99
 346   End:
 347 */
 348 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :