* Licence details can be found in the file COPYING.
*
* \author Asger Alstrup
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author John Levon
- * \author André Pönitz
- * \author Jürgen Vigna
+ * \author André Pönitz
+ * \author Jürgen Vigna
* \author Abdelrazak Younes
*
* Full author contact details are available in file CREDITS.
#include "insets/Inset.h"
+#include "support/lassert.h"
#include "support/debug.h"
-#include "support/limited_stack.h"
-
-#include "support/assert.h"
#include <algorithm>
-#include <ostream>
+#include <deque>
using namespace std;
using namespace lyx::support;
struct UndoElement
{
+ ///
+ UndoElement(UndoKind kin, StableDocIterator const & cur,
+ StableDocIterator const & cel,
+ pit_type fro, pit_type en, ParagraphList * pl,
+ MathData * ar, BufferParams const & bp,
+ bool ifb, size_t gid) :
+ kind(kin), cursor(cur), cell(cel), from(fro), end(en),
+ pars(pl), array(ar), bparams(0), isFullBuffer(ifb), group_id(gid)
+ {
+ if (isFullBuffer)
+ bparams = new BufferParams(bp);
+ }
+ ///
+ UndoElement(UndoElement const & ue)
+ {
+ kind = ue.kind;
+ cursor = ue.cursor;
+ cell = ue.cell;
+ from = ue.from;
+ end = ue.end;
+ pars = ue.pars;
+ array = ue.array;
+ bparams = ue.isFullBuffer
+ ? new BufferParams(*ue.bparams) : ue.bparams;
+ isFullBuffer = ue.isFullBuffer;
+ group_id = ue.group_id;
+ }
+ ///
+ ~UndoElement()
+ {
+ if (isFullBuffer)
+ delete bparams;
+ }
/// Which kind of operation are we recording for?
UndoKind kind;
/// the position of the cursor
/// the contents of the saved MathData (for mathed)
MathData * array;
/// Only used in case of full backups
- BufferParams bparams;
+ BufferParams const * bparams;
/// Only used in case of full backups
bool isFullBuffer;
+ /// the element's group id
+ size_t group_id;
+private:
+ /// Protect construction
+ UndoElement();
+};
+
+
+class UndoElementStack
+{
+public:
+ /// limit is the maximum size of the stack
+ UndoElementStack(size_t limit = 100) { limit_ = limit; }
+ /// limit is the maximum size of the stack
+ ~UndoElementStack() { clear(); }
+
+ /// Return the top element.
+ UndoElement & top() { return c_.front(); }
+
+ /// Pop and throw away the top element.
+ void pop() { c_.pop_front(); }
+
+ /// Return true if the stack is empty.
+ bool empty() const { return c_.empty(); }
+
+ /// Clear all elements, deleting them.
+ void clear() {
+ for (size_t i = 0; i != c_.size(); ++i) {
+ delete c_[i].array;
+ delete c_[i].pars;
+ }
+ c_.clear();
+ }
+
+ /// Push an item on to the stack, deleting the bottom group on
+ /// overflow.
+ void push(UndoElement const & v) {
+ c_.push_front(v);
+ if (c_.size() > limit_) {
+ // remove a whole group at once.
+ const size_t gid = c_.back().group_id;
+ while (!c_.empty() && c_.back().group_id == gid)
+ c_.pop_back();
+ }
+ }
+
+private:
+ /// Internal contents.
+ std::deque<UndoElement> c_;
+ /// The maximum number elements stored.
+ size_t limit_;
};
struct Undo::Private
{
- Private(Buffer & buffer) : buffer_(buffer), undo_finished_(true) {}
+ Private(Buffer & buffer) : buffer_(buffer), undo_finished_(true),
+ group_id(0), group_level(0) {}
- // Returns false if no undo possible.
+ // Do one undo/redo step
+ void doTextUndoOrRedo(DocIterator & cur, UndoElementStack & stack, UndoElementStack & otherStack);
+ // Apply one undo/redo group. Returns false if no undo possible.
bool textUndoOrRedo(DocIterator & cur, bool isUndoOperation);
+
///
void doRecordUndo(UndoKind kind,
DocIterator const & cell,
pit_type last_pit,
DocIterator const & cur,
bool isFullBuffer,
- bool isUndoOperation);
-
+ UndoElementStack & stack);
///
void recordUndo(UndoKind kind,
- DocIterator & cur,
+ DocIterator const & cur,
pit_type first_pit,
pit_type last_pit);
///
Buffer & buffer_;
/// Undo stack.
- limited_stack<UndoElement> undostack_;
+ UndoElementStack undostack_;
/// Redo stack.
- limited_stack<UndoElement> redostack_;
+ UndoElementStack redostack_;
/// The flag used by Undo::finishUndo().
bool undo_finished_;
+
+ /// Current group Id.
+ size_t group_id;
+ /// Current group nesting nevel.
+ size_t group_level;
};
}
-static ostream & operator<<(ostream & os, UndoElement const & undo)
-{
- return os << " from: " << undo.from << " end: " << undo.end
- << " cell:\n" << undo.cell
- << " cursor:\n" << undo.cursor;
-}
-
-
static bool samePar(StableDocIterator const & i1, StableDocIterator const & i2)
{
StableDocIterator tmpi2 = i2;
pit_type first_pit, pit_type last_pit,
DocIterator const & cur,
bool isFullBuffer,
- bool isUndoOperation)
+ UndoElementStack & stack)
{
+ if (!group_level) {
+ LYXERR0("There is no group open (creating one)");
+ ++group_id;
+ }
+
if (first_pit > last_pit)
swap(first_pit, last_pit);
- // create the position information of the Undo entry
- UndoElement undo;
- undo.array = 0;
- undo.pars = 0;
- undo.kind = kind;
- undo.cell = cell;
- undo.cursor = cur;
- undo.bparams = buffer_.params();
- undo.isFullBuffer = isFullBuffer;
- //lyxerr << "recordUndo: cur: " << cur << endl;
- //lyxerr << "recordUndo: pos: " << cur.pos() << endl;
- //lyxerr << "recordUndo: cell: " << cell << endl;
- undo.from = first_pit;
- undo.end = cell.lastpit() - last_pit;
-
- limited_stack<UndoElement> & stack = isUndoOperation ?
- undostack_ : redostack_;
// Undo::ATOMIC are always recorded (no overlapping there).
// As nobody wants all removed character appear one by one when undoing,
// we want combine 'similar' non-ATOMIC undo recordings to one.
+ pit_type from = first_pit;
+ pit_type end = cell.lastpit() - last_pit;
if (!undo_finished_
&& kind != ATOMIC_UNDO
&& !stack.empty()
- && samePar(stack.top().cell, undo.cell)
- && stack.top().kind == undo.kind
- && stack.top().from == undo.from
- && stack.top().end == undo.end)
+ && samePar(stack.top().cell, cell)
+ && stack.top().kind == kind
+ && stack.top().from == from
+ && stack.top().end == end)
return;
+ if (isFullBuffer)
+ LYXERR(Debug::UNDO, "Create full buffer undo element of group " << group_id);
+ else
+ LYXERR(Debug::UNDO, "Create undo element of group " << group_id);
+ // create the position information of the Undo entry
+ UndoElement undo(kind, cur, cell, from, end, 0, 0,
+ buffer_.params(), isFullBuffer, group_id);
+
// fill in the real data to be saved
if (cell.inMathed()) {
// simply use the whole cell
}
-void Undo::Private::recordUndo(UndoKind kind, DocIterator & cur,
+void Undo::Private::recordUndo(UndoKind kind, DocIterator const & cur,
pit_type first_pit, pit_type last_pit)
{
LASSERT(first_pit <= cur.lastpit(), /**/);
LASSERT(last_pit <= cur.lastpit(), /**/);
doRecordUndo(kind, cur, first_pit, last_pit, cur,
- false, true);
+ false, undostack_);
undo_finished_ = false;
redostack_.clear();
}
-bool Undo::Private::textUndoOrRedo(DocIterator & cur, bool isUndoOperation)
+void Undo::Private::doTextUndoOrRedo(DocIterator & cur, UndoElementStack & stack, UndoElementStack & otherstack)
{
- undo_finished_ = true;
-
- limited_stack<UndoElement> & stack = isUndoOperation ?
- undostack_ : redostack_;
-
- if (stack.empty())
- // Nothing to do.
- return false;
-
- limited_stack<UndoElement> & otherstack = isUndoOperation ?
- redostack_ : undostack_;
-
// Adjust undo stack and get hold of current undo data.
- UndoElement undo = stack.top();
- stack.pop();
+ UndoElement & undo = stack.top();
+ LYXERR(Debug::UNDO, "Undo element of group " << undo.group_id);
+ // We'll pop the stack only when we're done with this element. So do NOT
+ // try to return early.
// We will store in otherstack the part of the document under 'undo'
- DocIterator cell_dit = undo.cell.asDocIterator(&buffer_.inset());
+ DocIterator cell_dit = undo.cell.asDocIterator(&buffer_);
doRecordUndo(ATOMIC_UNDO, cell_dit,
undo.from, cell_dit.lastpit() - undo.end, cur,
- undo.isFullBuffer, !isUndoOperation);
+ undo.isFullBuffer, otherstack);
// This does the actual undo/redo.
//LYXERR0("undo, performing: " << undo);
- bool labelsUpdateNeeded = false;
- DocIterator dit = undo.cell.asDocIterator(&buffer_.inset());
+ DocIterator dit = undo.cell.asDocIterator(&buffer_);
if (undo.isFullBuffer) {
LASSERT(undo.pars, /**/);
// This is a full document
- otherstack.top().bparams = buffer_.params();
- buffer_.params() = undo.bparams;
+ delete otherstack.top().bparams;
+ otherstack.top().bparams = new BufferParams(buffer_.params());
+ buffer_.params() = *undo.bparams;
swap(buffer_.paragraphs(), *undo.pars);
delete undo.pars;
undo.pars = 0;
plist.insert(first, undo.pars->begin(), undo.pars->end());
delete undo.pars;
undo.pars = 0;
- labelsUpdateNeeded = true;
}
LASSERT(undo.pars == 0, /**/);
LASSERT(undo.array == 0, /**/);
- cur = undo.cursor.asDocIterator(&buffer_.inset());
-
- if (labelsUpdateNeeded)
- updateLabels(buffer_);
+ cur = undo.cursor.asDocIterator(&buffer_);
+ // Now that we're done with undo, we pop it off the stack.
+ stack.pop();
+}
+
+
+bool Undo::Private::textUndoOrRedo(DocIterator & cur, bool isUndoOperation)
+{
undo_finished_ = true;
+
+ UndoElementStack & stack = isUndoOperation ? undostack_ : redostack_;
+
+ if (stack.empty())
+ // Nothing to do.
+ return false;
+
+ UndoElementStack & otherstack = isUndoOperation ? redostack_ : undostack_;
+
+ const size_t gid = stack.top().group_id;
+ while (!stack.empty() && stack.top().group_id == gid)
+ doTextUndoOrRedo(cur, stack, otherstack);
+
+ // Adapt the new material to current buffer.
+ buffer_.setBuffersForInsets(); // FIXME This shouldn't be here.
+ buffer_.updateLabels();
return true;
}
}
-void Undo::recordUndo(DocIterator & cur, UndoKind kind)
+void Undo::beginUndoGroup()
+{
+ if (d->group_level == 0) {
+ // create a new group
+ ++d->group_id;
+ LYXERR(Debug::UNDO, "+++++++Creating new group " << d->group_id);
+ }
+ ++d->group_level;
+}
+
+
+void Undo::endUndoGroup()
+{
+ if (d->group_level == 0)
+ LYXERR0("There is no undo group to end here");
+ --d->group_level;
+ if (d->group_level == 0) {
+ // real end of the group
+ LYXERR(Debug::UNDO, "-------End of group " << d->group_id);
+ }
+}
+
+
+
+void Undo::recordUndo(DocIterator const & cur, UndoKind kind)
{
d->recordUndo(kind, cur, cur.pit(), cur.pit());
}
-void Undo::recordUndoInset(DocIterator & cur, UndoKind kind)
+void Undo::recordUndoInset(DocIterator const & cur, UndoKind kind)
{
DocIterator c = cur;
c.pop_back();
- d->doRecordUndo(kind, c, c.pit(), c.pit(), cur, false, true);
+ d->doRecordUndo(kind, c, c.pit(), c.pit(), cur, false, d->undostack_);
}
-void Undo::recordUndo(DocIterator & cur, UndoKind kind, pit_type from)
+void Undo::recordUndo(DocIterator const & cur, UndoKind kind, pit_type from)
{
d->recordUndo(kind, cur, cur.pit(), from);
}
-void Undo::recordUndo(DocIterator & cur, UndoKind kind,
+void Undo::recordUndo(DocIterator const & cur, UndoKind kind,
pit_type from, pit_type to)
{
d->recordUndo(kind, cur, from, to);
}
-void Undo::recordUndoFullDocument(DocIterator & cur)
+void Undo::recordUndoFullDocument(DocIterator const & cur)
{
+ // This one may happen outside of the main undo group, so we
+ // put it in its own subgroup to avoid complaints.
+ beginUndoGroup();
d->doRecordUndo(
ATOMIC_UNDO,
- doc_iterator_begin(d->buffer_.inset()),
+ doc_iterator_begin(&d->buffer_),
0, d->buffer_.paragraphs().size() - 1,
cur,
true,
- true
+ d->undostack_
);
+ endUndoGroup();
}
projects / lyx.git / blobdiff