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