3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
10 * \author Jürgen Vigna
11 * \author Abdelrazak Younes
13 * Full author contact details are available in file CREDITS.
21 #include "BufferList.h"
22 #include "BufferParams.h"
24 #include "CutAndPaste.h"
25 #include "ErrorList.h"
26 #include "Paragraph.h"
27 #include "ParagraphList.h"
30 #include "mathed/InsetMath.h"
31 #include "mathed/MathData.h"
32 #include "mathed/MathRow.h"
34 #include "insets/InsetText.h"
36 #include "support/debug.h"
37 #include "support/lassert.h"
38 #include "support/lyxtime.h"
45 using namespace lyx::support;
51 These are the elements put on the undo stack. Each object contains
52 complete paragraphs from some cell and sufficient information to
53 restore the cursor state.
55 The cell is given by a DocIterator pointing to this cell, the
56 'interesting' range of paragraphs by counting them from begin and end
57 of cell, respectively.
59 The cursor is also given as DocIterator and should point to some place
60 in the stored paragraph range. In case of math, we simply store the
61 whole cell, as there usually is just a simple paragraph in a cell.
63 The idea is to store the contents of 'interesting' paragraphs in some
64 structure ('Undo') _before_ it is changed in some edit operation.
65 Obviously, the stored range should be as small as possible. However,
66 there is a lower limit: The StableDocIterator stored in the undo class
67 must be valid after the changes, too, as it will used as a pointer
68 where to insert the stored bits when performining undo.
73 UndoElement(UndoKind kin, CursorData const & cb,
74 StableDocIterator const & cel,
75 pit_type fro, pit_type en, ParagraphList * pl, MathData * ar,
76 bool lc, size_t gid) :
77 cur_before(cb), cell(cel), from(fro), end(en),
78 pars(pl), array(ar), bparams(nullptr),
79 group_id(gid), time(current_time()), kind(kin), lyx_clean(lc)
82 UndoElement(CursorData const & cb, BufferParams const & bp,
83 bool lc, size_t gid) :
84 cur_before(cb), cell(), from(0), end(0),
85 pars(nullptr), array(nullptr), bparams(new BufferParams(bp)),
86 group_id(gid), time(current_time()), kind(ATOMIC_UNDO), lyx_clean(lc)
89 UndoElement(UndoElement const & ue) :
90 cur_before(ue.cur_before), cur_after(ue.cur_after),
91 cell(ue.cell), from(ue.from), end(ue.end),
92 pars(ue.pars), array(ue.array),
93 bparams(ue.bparams ? new BufferParams(*ue.bparams) : nullptr),
94 group_id(ue.group_id), time(current_time()), kind(ue.kind),
95 lyx_clean(ue.lyx_clean)
103 /// the position of the cursor before recordUndo
104 CursorData cur_before;
105 /// the position of the cursor at the end of the undo group
106 CursorData cur_after;
107 /// the position of the cell described
108 StableDocIterator cell;
109 /// counted from begin of cell
111 /// complement to end of this cell
113 /// the contents of the saved Paragraphs (for texted)
114 ParagraphList * pars;
115 /// the contents of the saved MathData (for mathed)
117 /// Only used in case of params undo
118 BufferParams const * bparams;
119 /// the element's group id
123 /// Which kind of operation are we recording for?
125 /// Was the buffer clean at this point?
128 /// Protect construction
133 class UndoElementStack
136 /// limit is the maximum size of the stack
137 UndoElementStack(size_t limit = 100) { limit_ = limit; }
138 /// limit is the maximum size of the stack
139 ~UndoElementStack() { clear(); }
141 /// Return the top element.
142 UndoElement & top() { return c_.front(); }
144 /// Pop and throw away the top element.
145 void pop() { c_.pop_front(); }
147 /// Return true if the stack is empty.
148 bool empty() const { return c_.empty(); }
150 /// Clear all elements, deleting them.
152 for (size_t i = 0; i != c_.size(); ++i) {
159 /// Push an item on to the stack, deleting the bottom group on
161 void push(UndoElement const & v) {
162 // Remove some entries if the limit has been reached.
163 // However, if the only group on the stack is the one
164 // we are currently populating, do nothing.
165 if (c_.size() >= limit_
166 && c_.front().group_id != v.group_id) {
167 // remove a whole group at once.
168 const size_t gid = c_.back().group_id;
169 while (!c_.empty() && c_.back().group_id == gid)
175 /// Mark all the elements of the stack as dirty
177 for (size_t i = 0; i != c_.size(); ++i)
178 c_[i].lyx_clean = false;
182 /// Internal contents.
183 std::deque<UndoElement> c_;
184 /// The maximum number elements stored.
191 Private(Buffer & buffer) : buffer_(buffer),
192 group_id_(0), group_level_(0), undo_finished_(true) {}
194 // Do one undo/redo step
195 void doUndoRedoAction(CursorData & cur, UndoElementStack & stack,
196 UndoElementStack & otherStack);
197 // Apply one undo/redo group. Returns false if no undo possible.
198 bool undoRedoAction(CursorData & cur, bool isUndoOperation);
201 void doRecordUndo(UndoKind kind,
202 DocIterator const & cell,
205 CursorData const & cur,
206 UndoElementStack & stack);
208 void recordUndo(UndoKind kind,
209 DocIterator const & cell,
212 CursorData const & cur);
214 void doRecordUndoBufferParams(CursorData const & cur, UndoElementStack & stack);
216 void recordUndoBufferParams(CursorData const & cur);
221 UndoElementStack undostack_;
223 UndoElementStack redostack_;
225 /// Current group Id.
227 /// Current group nesting nevel.
229 /// the position of cursor before the group was created
230 CursorData group_cur_before_;
232 /// The flag used by Undo::finishUndo().
238 /////////////////////////////////////////////////////////////////////
242 /////////////////////////////////////////////////////////////////////
245 Undo::Undo(Buffer & buffer)
246 : d(new Undo::Private(buffer))
258 d->undostack_.clear();
259 d->redostack_.clear();
260 d->undo_finished_ = true;
261 // We used to do that, but I believe it is better to keep
262 // groups (only used in Buffer::reload for now (JMarc)
264 //d->group_level_ = 0;
268 bool Undo::hasUndoStack() const
270 return !d->undostack_.empty();
274 bool Undo::hasRedoStack() const
276 return !d->redostack_.empty();
280 void Undo::markDirty()
282 d->undo_finished_ = true;
283 d->undostack_.markDirty();
284 d->redostack_.markDirty();
288 /////////////////////////////////////////////////////////////////////
292 ///////////////////////////////////////////////////////////////////////
294 static bool samePar(StableDocIterator const & i1, StableDocIterator const & i2)
296 StableDocIterator tmpi2 = i2;
297 tmpi2.pos() = i1.pos();
302 void Undo::Private::doRecordUndo(UndoKind kind,
303 DocIterator const & cell,
304 pit_type first_pit, pit_type last_pit,
305 CursorData const & cur_before,
306 UndoElementStack & stack)
309 LYXERR0("There is no group open (creating one)");
313 if (first_pit > last_pit)
314 swap(first_pit, last_pit);
316 // Undo::ATOMIC are always recorded (no overlapping there).
317 // As nobody wants all removed character appear one by one when undoing,
318 // we want combine 'similar' non-ATOMIC undo recordings to one.
319 pit_type from = first_pit;
320 pit_type end = cell.lastpit() - last_pit;
322 && kind != ATOMIC_UNDO
324 && !stack.top().bparams
325 && samePar(stack.top().cell, cell)
326 && stack.top().kind == kind
327 && stack.top().from == from
328 && stack.top().end == end
329 && stack.top().cur_after == cur_before
330 && current_time() - stack.top().time <= 2) {
331 // reset cur_after; it will be filled correctly by endUndoGroup.
332 stack.top().cur_after = CursorData();
333 // update the timestamp of the undo element
334 stack.top().time = current_time();
338 LYXERR(Debug::UNDO, "Create undo element of group " << group_id_);
339 // create the position information of the Undo entry
340 UndoElement undo(kind,
341 group_cur_before_.empty() ? cur_before : group_cur_before_,
342 cell, from, end, nullptr, nullptr, buffer_.isClean(), group_id_);
344 // fill in the real data to be saved
345 if (cell.inMathed()) {
346 // simply use the whole cell
347 MathData & ar = cell.cell();
348 undo.array = new MathData(ar.buffer(), ar.begin(), ar.end());
350 // some more effort needed here as 'the whole cell' of the
351 // main Text _is_ the whole document.
352 // record the relevant paragraphs
353 Text const * text = cell.text();
355 ParagraphList const & plist = text->paragraphs();
356 ParagraphList::const_iterator first = plist.begin();
357 advance(first, first_pit);
358 ParagraphList::const_iterator last = plist.begin();
359 advance(last, last_pit + 1);
360 undo.pars = new ParagraphList(first, last);
363 // push the undo entry to undo stack
365 //lyxerr << "undo record: " << stack.top() << endl;
369 void Undo::Private::recordUndo(UndoKind kind,
370 DocIterator const & cell,
371 pit_type first_pit, pit_type last_pit,
372 CursorData const & cur)
374 LASSERT(first_pit <= cell.lastpit(), return);
375 LASSERT(last_pit <= cell.lastpit(), return);
377 doRecordUndo(kind, cell, first_pit, last_pit, cur,
380 // next time we'll try again to combine entries if possible
381 undo_finished_ = false;
383 // If we ran recordUndo, it means that we plan to change the buffer
390 void Undo::Private::doRecordUndoBufferParams(CursorData const & cur_before,
391 UndoElementStack & stack)
394 LYXERR0("There is no group open (creating one)");
398 LYXERR(Debug::UNDO, "Create full buffer undo element of group " << group_id_);
399 // create the position information of the Undo entry
400 UndoElement undo(group_cur_before_.empty() ? cur_before : group_cur_before_,
401 buffer_.params(), buffer_.isClean(),
404 // push the undo entry to undo stack
409 void Undo::Private::recordUndoBufferParams(CursorData const & cur)
411 doRecordUndoBufferParams(cur, undostack_);
413 // next time we'll try again to combine entries if possible
414 undo_finished_ = false;
416 // If we ran recordUndo, it means that we plan to change the buffer
423 void Undo::Private::doUndoRedoAction(CursorData & cur, UndoElementStack & stack, UndoElementStack & otherstack)
425 // Adjust undo stack and get hold of current undo data.
426 UndoElement & undo = stack.top();
427 LYXERR(Debug::UNDO, "Undo element of group " << undo.group_id);
428 // We'll pop the stack only when we're done with this element. So do NOT
429 // try to return early.
431 // We will store in otherstack the part of the document under 'undo'
432 DocIterator cell_dit = undo.cell.asDocIterator(&buffer_);
435 doRecordUndoBufferParams(undo.cur_after, otherstack);
437 LATTEST(undo.end <= cell_dit.lastpit());
438 doRecordUndo(ATOMIC_UNDO, cell_dit,
439 undo.from, cell_dit.lastpit() - undo.end, undo.cur_after,
442 otherstack.top().cur_after = undo.cur_before;
444 // This does the actual undo/redo.
445 //LYXERR0("undo, performing: " << undo);
446 DocIterator dit = undo.cell.asDocIterator(&buffer_);
448 // This is a params undo element
449 delete otherstack.top().bparams;
450 otherstack.top().bparams = new BufferParams(buffer_.params());
451 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
452 buffer_.params() = *undo.bparams;
453 cap::switchBetweenClasses(olddc, buffer_.params().documentClassPtr(),
454 static_cast<InsetText &>(buffer_.inset()));
455 } else if (dit.inMathed()) {
456 // We stored the full cell here as there is not much to be
457 // gained by storing just 'a few' paragraphs (most if not
458 // all math inset cells have just one paragraph!)
459 //LYXERR0("undo.array: " << *undo.array);
461 dit.cell().swap(*undo.array);
462 dit.inset().setBuffer(buffer_);
464 undo.array = nullptr;
466 // Some finer machinery is needed here.
467 Text * text = dit.text();
470 ParagraphList & plist = text->paragraphs();
472 // remove new stuff between first and last
473 ParagraphList::iterator first = plist.begin();
474 advance(first, undo.from);
475 ParagraphList::iterator last = plist.begin();
476 advance(last, plist.size() - undo.end);
477 plist.erase(first, last);
479 // re-insert old stuff instead
480 first = plist.begin();
481 advance(first, undo.from);
483 // this ugly stuff is needed until we get rid of the
484 // inset_owner backpointer
485 ParagraphList::iterator pit = undo.pars->begin();
486 ParagraphList::iterator const end = undo.pars->end();
487 for (; pit != end; ++pit)
488 pit->setInsetOwner(dit.realInset());
489 plist.insert(first, undo.pars->begin(), undo.pars->end());
491 // set the buffers for insets we created
492 ParagraphList::iterator fpit = plist.begin();
493 advance(fpit, undo.from);
494 ParagraphList::iterator fend = fpit;
495 advance(fend, undo.pars->size());
496 for (; fpit != fend; ++fpit)
497 fpit->setInsetBuffers(buffer_);
503 // We'll clean up in release mode.
504 LASSERT(undo.pars == nullptr, undo.pars = nullptr);
505 LASSERT(undo.array == nullptr, undo.array = nullptr);
507 if (!undo.cur_before.empty())
508 cur = undo.cur_before;
513 // Now that we're done with undo, we pop it off the stack.
518 bool Undo::Private::undoRedoAction(CursorData & cur, bool isUndoOperation)
520 undo_finished_ = true;
522 UndoElementStack & stack = isUndoOperation ? undostack_ : redostack_;
528 UndoElementStack & otherstack = isUndoOperation ? redostack_ : undostack_;
530 const size_t gid = stack.top().group_id;
531 while (!stack.empty() && stack.top().group_id == gid)
532 doUndoRedoAction(cur, stack, otherstack);
537 void Undo::finishUndo()
539 // Make sure the next operation will be stored.
540 d->undo_finished_ = true;
544 bool Undo::undoAction(CursorData & cur)
546 return d->undoRedoAction(cur, true);
550 bool Undo::redoAction(CursorData & cur)
552 return d->undoRedoAction(cur, false);
556 void Undo::beginUndoGroup()
558 if (d->group_level_ == 0) {
559 // create a new group
561 LYXERR(Debug::UNDO, "+++++++ Creating new group " << d->group_id_
562 << " for buffer " << &d->buffer_);
568 void Undo::beginUndoGroup(CursorData const & cur_before)
571 if (d->group_cur_before_.empty())
572 d->group_cur_before_ = cur_before;
576 void Undo::endUndoGroup()
578 if (d->group_level_ == 0) {
579 LYXERR0("There is no undo group to end here");
583 if (d->group_level_ == 0) {
584 // real end of the group
585 d->group_cur_before_ = CursorData();
586 LYXERR(Debug::UNDO, "------- End of group " << d->group_id_
587 << " of buffer " << &d->buffer_);
592 void Undo::endUndoGroup(CursorData const & cur_after)
595 if (!d->undostack_.empty() && d->undostack_.top().cur_after.empty())
596 d->undostack_.top().cur_after = cur_after;
600 void Undo::splitUndoGroup(CursorData const & cur)
602 size_t const level = d->group_level_;
606 d->group_level_ = level;
610 bool Undo::activeUndoGroup() const
612 return d->group_level_ > 0
613 && !d->undostack_.empty()
614 && d->undostack_.top().group_id == d->group_id_;
618 void Undo::recordUndo(CursorData const & cur, UndoKind kind)
620 d->recordUndo(kind, cur, cur.pit(), cur.pit(), cur);
624 void Undo::recordUndo(CursorData const & cur, pit_type from, pit_type to)
626 d->recordUndo(ATOMIC_UNDO, cur, from, to, cur);
630 void Undo::recordUndoInset(CursorData const & cur, Inset const * inset)
632 if (!inset || inset == &cur.inset()) {
635 d->recordUndo(ATOMIC_UNDO, c, c.pit(), c.pit(), cur);
636 } else if (inset == cur.nextInset())
639 LYXERR0("Inset not found, no undo stack added.");
643 void Undo::recordUndoBufferParams(CursorData const & cur)
645 d->recordUndoBufferParams(cur);
649 void Undo::recordUndoFullBuffer(CursorData const & cur)
651 // This one may happen outside of the main undo group, so we
652 // put it in its own subgroup to avoid complaints.
654 d->recordUndo(ATOMIC_UNDO, doc_iterator_begin(&d->buffer_),
655 0, d->buffer_.paragraphs().size() - 1, cur);
656 d->recordUndoBufferParams(cur);
660 /// UndoGroupHelper class stuff
662 class UndoGroupHelper::Impl {
663 friend class UndoGroupHelper;
664 set<Buffer *> buffers_;
668 UndoGroupHelper::UndoGroupHelper(Buffer * buf) : d(new UndoGroupHelper::Impl)
674 UndoGroupHelper::~UndoGroupHelper()
676 for (Buffer * buf : d->buffers_)
677 if (theBufferList().isLoaded(buf) || theBufferList().isInternal(buf))
678 buf->undo().endUndoGroup();
682 void UndoGroupHelper::resetBuffer(Buffer * buf)
684 if (buf && d->buffers_.count(buf) == 0) {
685 d->buffers_.insert(buf);
686 buf->undo().beginUndoGroup();