src/undo.C

   1 /**
   2  * \file undo.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Asger Alstrup
   7  * \author Lars Gullik Bjønnes
   8  * \author John Levon
   9  * \author André Pönitz
  10  * \author Jürgen Vigna
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #include <config.h>
  16
  17 #include "undo.h"
  18
  19 #include "buffer.h"
  20 #include "cursor.h"
  21 #include "debug.h"
  22 #include "BufferView.h"
  23 #include "lyxtext.h"
  24 #include "paragraph.h"
  25
  26 #include "mathed/math_support.h"
  27
  28 #include <algorithm>
  29
  30 using std::advance;
  31
  32 using lyx::par_type;
  33
  34 using std::endl;
  35
  36
  37 namespace {
  38
  39 /// The flag used by finishUndo().
  40 bool undo_finished;
  41
  42
  43 std::ostream & operator<<(std::ostream & os, Undo const & undo)
  44 {
  45         return os << " from: " << undo.from
  46                 << " end: " << undo.end
  47                 << " cursor:\n" << undo.cursor;
  48 }
  49
  50
  51 void recordUndo(Undo::undo_kind kind,
  52         LCursor & cur, par_type first_par, par_type last_par,
  53         limited_stack<Undo> & stack)
  54 {
  55         BOOST_ASSERT(first_par <= cur.lastpar());
  56         BOOST_ASSERT(last_par <= cur.lastpar());
  57
  58         if (first_par > last_par)
  59                 std::swap(first_par, last_par);
  60
  61         // create the position information of the Undo entry
  62         Undo undo;
  63         undo.kind = kind;
  64         undo.cursor = StableDocIterator(cur);
  65         undo.from = first_par;
  66         undo.end = cur.lastpar() - last_par;
  67
  68         // Undo::ATOMIC are always recorded (no overlapping there).
  69         // As nobody wants all removed character appear one by one when undoing,
  70         // we want combine 'similar' non-ATOMIC undo recordings to one.
  71         if (!undo_finished
  72             && kind != Undo::ATOMIC
  73             && !stack.empty()
  74             && stack.top().cursor.size() == undo.cursor.size()
  75                   && stack.top().kind == undo.kind
  76                   && stack.top().from == undo.from
  77                   && stack.top().end == undo.end)
  78                 return;
  79
  80         // fill in the real data to be saved
  81         if (cur.inMathed()) {
  82                 // simply use the whole cell
  83                 undo.array = asString(cur.cell());
  84         } else {
  85                 // some more effort needed here as 'the whole cell' of the
  86                 // main LyXText _is_ the whole document.
  87                 // record the relevant paragraphs
  88                 LyXText * text = cur.text();
  89                 BOOST_ASSERT(text);
  90                 ParagraphList & plist = text->paragraphs();
  91                 ParagraphList::iterator first = plist.begin();
  92                 advance(first, first_par);
  93                 ParagraphList::iterator last = plist.begin();
  94                 advance(last, last_par + 1);
  95                 undo.pars = ParagraphList(first, last);
  96         }
  97
  98         // push the undo entry to undo stack
  99         //lyxerr << "undo record: " << stack.top() << std::endl;
 100         stack.push(undo);
 101
 102         // next time we'll try again to combine entries if possible
 103         undo_finished = false;
 104 }
 105
 106
 107 void performUndoOrRedo(BufferView & bv, Undo const & undo)
 108 {
 109         LCursor & cur = bv.cursor();
 110         lyxerr << "undo, performing: " << undo << std::endl;
 111         cur.setCursor(undo.cursor.asDocIterator(&bv.buffer()->inset()), false);
 112
 113         if (cur.inMathed()) {
 114                 // We stored the full cell here as there is not much to be
 115                 // gained by storing just 'a few' paragraphs (most if not
 116                 // all math inset cells have just one paragraph!)
 117                 asArray(undo.array, cur.cell());
 118         } else {
 119                 // Some finer machinery is needed here.
 120                 LyXText * text = cur.text();
 121                 BOOST_ASSERT(text);
 122                 ParagraphList & plist = text->paragraphs();
 123
 124                 // remove new stuff between first and last
 125                 ParagraphList::iterator first = plist.begin();
 126                 advance(first, undo.from);
 127                 ParagraphList::iterator last = plist.begin();
 128                 advance(last, plist.size() - undo.end);
 129                 plist.erase(first, last);
 130
 131                 // re-insert old stuff instead
 132                 first = plist.begin();
 133                 advance(first, undo.from);
 134                 plist.insert(first, undo.pars.begin(), undo.pars.end());
 135         }
 136
 137         cur.resetAnchor();
 138         finishUndo();
 139 }
 140
 141
 142 // returns false if no undo possible
 143 bool textUndoOrRedo(BufferView & bv,
 144         limited_stack<Undo> & stack, limited_stack<Undo> & otherstack)
 145 {
 146         if (stack.empty()) {
 147                 // nothing to do
 148                 finishUndo();
 149                 return false;
 150         }
 151
 152         Undo undo = stack.top();
 153         stack.pop();
 154         finishUndo();
 155
 156         // this implements redo
 157         otherstack.push(undo);
 158         DocIterator dit =
 159                 undo.cursor.asDocIterator(&bv.buffer()->inset());
 160         if (dit.inMathed()) {
 161                 // Easy way out: store a full cell.
 162                 otherstack.top().array = asString(dit.cell());
 163         } else {
 164                 // As cells might be too large in texted, store just a part
 165                 // of the paragraph list.
 166                 otherstack.top().pars.clear();
 167                 LyXText * text = dit.text();
 168                 BOOST_ASSERT(text);
 169                 ParagraphList & plist = text->paragraphs();
 170                 if (undo.from + undo.end <= int(plist.size())) {
 171                         ParagraphList::iterator first = plist.begin();
 172                         advance(first, undo.from);
 173                         ParagraphList::iterator last = plist.begin();
 174                         advance(last, plist.size() - undo.end);
 175                         otherstack.top().pars.insert(otherstack.top().pars.begin(), first, last);
 176                 }
 177         }
 178         otherstack.top().cursor = bv.cursor();
 179         //lyxerr << " undo other: " << otherstack.top() << std::endl;
 180
 181         performUndoOrRedo(bv, undo);
 182         return true;
 183 }
 184
 185 } // namespace anon
 186
 187
 188 void finishUndo()
 189 {
 190         // makes sure the next operation will be stored
 191         undo_finished = true;
 192 }
 193
 194
 195 bool textUndo(BufferView & bv)
 196 {
 197         return textUndoOrRedo(bv, bv.buffer()->undostack(),
 198                               bv.buffer()->redostack());
 199 }
 200
 201
 202 bool textRedo(BufferView & bv)
 203 {
 204         return textUndoOrRedo(bv, bv.buffer()->redostack(),
 205                               bv.buffer()->undostack());
 206 }
 207
 208
 209 void recordUndo(Undo::undo_kind kind,
 210         LCursor & cur, par_type first, par_type last)
 211 {
 212         Buffer * buf = cur.bv().buffer();
 213         recordUndo(kind, cur, first, last, buf->undostack());
 214         buf->redostack().clear();
 215         lyxerr << "undostack:\n";
 216         for (size_t i = 0, n = buf->undostack().size(); i != n && i < 6; ++i)
 217                 lyxerr << "  " << i << ": " << buf->undostack()[i] << std::endl;
 218 }
 219
 220
 221 void recordUndo(LCursor & cur, Undo::undo_kind kind)
 222 {
 223         recordUndo(kind, cur, cur.par(), cur.par());
 224 }
 225
 226
 227 void recordUndoInset(LCursor & cur, Undo::undo_kind kind)
 228 {
 229         LCursor c = cur;
 230         c.pop();
 231         recordUndo(c, kind);
 232 }
 233
 234
 235 void recordUndoSelection(LCursor & cur, Undo::undo_kind kind)
 236 {
 237         recordUndo(kind, cur, cur.selBegin().par(), cur.selEnd().par());
 238 }
 239
 240
 241 void recordUndo(LCursor & cur, Undo::undo_kind kind, par_type from)
 242 {
 243         recordUndo(kind, cur, cur.par(), from);
 244 }
 245
 246
 247 void recordUndo(LCursor & cur, Undo::undo_kind kind,
 248         par_type from, par_type to)
 249 {
 250         recordUndo(kind, cur, from, to);
 251 }
 252
 253
 254 void recordUndoFullDocument(LCursor &)
 255 {
 256         //recordUndo(Undo::ATOMIC,
 257         //      cur, 0, cur.bv().text()->paragraphs().size() - 1);
 258 }