* 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 "Undo.h"
#include "Buffer.h"
+#include "BufferParams.h"
#include "buffer_funcs.h"
#include "Cursor.h"
-#include "debug.h"
-#include "BufferView.h"
-#include "LyXText.h"
#include "Paragraph.h"
#include "ParagraphList.h"
+#include "Text.h"
#include "mathed/MathSupport.h"
#include "mathed/MathData.h"
#include "insets/Inset.h"
+#include "support/lassert.h"
+#include "support/debug.h"
+
#include <algorithm>
+#include <deque>
+
+using namespace std;
+using namespace lyx::support;
namespace lyx {
-using std::advance;
-using std::endl;
+/**
+These are the elements put on the undo stack. Each object contains
+complete paragraphs from some cell and sufficient information to
+restore the cursor state.
+
+The cell is given by a DocIterator pointing to this cell, the
+'interesting' range of paragraphs by counting them from begin and end
+of cell, respectively.
+
+The cursor is also given as DocIterator and should point to some place
+in the stored paragraph range. In case of math, we simply store the
+whole cell, as there usually is just a simple paragraph in a cell.
+
+The idea is to store the contents of 'interesting' paragraphs in some
+structure ('Undo') _before_ it is changed in some edit operation.
+Obviously, the stored range should be as small as possible. However,
+there is a lower limit: The StableDocIterator stored in the undo class
+must be valid after the changes, too, as it will used as a pointer
+where to insert the stored bits when performining undo.
+*/
+struct UndoElement
+{
+ ///
+ UndoElement(UndoKind kin, CursorData const & cb,
+ StableDocIterator const & cel,
+ pit_type fro, pit_type en, ParagraphList * pl,
+ MathData * ar, BufferParams const & bp,
+ bool ifb, bool lc, size_t gid) :
+ kind(kin), cur_before(cb), cell(cel), from(fro), end(en),
+ pars(pl), array(ar), bparams(0), isFullBuffer(ifb),
+ lyx_clean(lc), group_id(gid)
+ {
+ if (isFullBuffer)
+ bparams = new BufferParams(bp);
+ }
+ ///
+ UndoElement(UndoElement const & ue)
+ {
+ kind = ue.kind;
+ cur_before = ue.cur_before;
+ cur_after = ue.cur_after;
+ 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;
+ lyx_clean = ue.lyx_clean;
+ 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 before recordUndo
+ CursorData cur_before;
+ /// the position of the cursor at the end of the undo group
+ CursorData cur_after;
+ /// the position of the cell described
+ StableDocIterator cell;
+ /// counted from begin of cell
+ pit_type from;
+ /// complement to end of this cell
+ pit_type end;
+ /// the contents of the saved Paragraphs (for texted)
+ ParagraphList * pars;
+ /// the contents of the saved MathData (for mathed)
+ MathData * array;
+ /// Only used in case of full backups
+ BufferParams const * bparams;
+ /// Only used in case of full backups
+ bool isFullBuffer;
+ /// Was the buffer clean at this point?
+ bool lyx_clean;
+ /// 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();
+ }
+ }
+
+ /// Mark all the elements of the stack as dirty
+ void markDirty() {
+ for (size_t i = 0; i != c_.size(); ++i)
+ c_[i].lyx_clean = false;
+ }
+
+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),
+ group_id(0), group_level(0) {}
+
+ // Do one undo/redo step
+ void doTextUndoOrRedo(CursorData & cur, UndoElementStack & stack,
+ UndoElementStack & otherStack);
+ // Apply one undo/redo group. Returns false if no undo possible.
+ bool textUndoOrRedo(CursorData & cur, bool isUndoOperation);
+
+ ///
+ void doRecordUndo(UndoKind kind,
+ DocIterator const & cell,
+ pit_type first_pit,
+ pit_type last_pit,
+ CursorData const & cur,
+ bool isFullBuffer,
+ UndoElementStack & stack);
+ ///
+ void recordUndo(UndoKind kind,
+ DocIterator const & cell,
+ pit_type first_pit,
+ pit_type last_pit,
+ CursorData const & cur,
+ bool isFullBuffer);
+
+ ///
+ Buffer & buffer_;
+ /// Undo stack.
+ UndoElementStack undostack_;
+ /// Redo stack.
+ 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;
+};
+
+
+/////////////////////////////////////////////////////////////////////
+//
+// Undo
+//
+/////////////////////////////////////////////////////////////////////
+
+
+Undo::Undo(Buffer & buffer)
+ : d(new Undo::Private(buffer))
+{}
+
+
+Undo::~Undo()
+{
+ delete d;
+}
+
+void Undo::clear()
+{
+ d->undostack_.clear();
+ d->redostack_.clear();
+ d->undo_finished_ = true;
+ // We used to do that, but I believe it is better to keep
+ // groups (only used in Buffer::reload for now (JMarc)
+ //d->group_id = 0;
+ //d->group_level = 0;
+}
-namespace {
-/// The flag used by finishUndo().
-bool undo_finished;
+bool Undo::hasUndoStack() const
+{
+ return !d->undostack_.empty();
+}
-std::ostream & operator<<(std::ostream & os, Undo const & undo)
+bool Undo::hasRedoStack() const
{
- return os << " from: " << undo.from << " end: " << undo.end
- << " cell:\n" << undo.cell
- << " cursor:\n" << undo.cursor;
+ return !d->redostack_.empty();
}
-bool samePar(StableDocIterator const & i1, StableDocIterator const & i2)
+void Undo::markDirty()
+{
+ d->undo_finished_ = true;
+ d->undostack_.markDirty();
+ d->redostack_.markDirty();
+}
+
+
+/////////////////////////////////////////////////////////////////////
+//
+// Undo::Private
+//
+///////////////////////////////////////////////////////////////////////
+
+static bool samePar(StableDocIterator const & i1, StableDocIterator const & i2)
{
StableDocIterator tmpi2 = i2;
tmpi2.pos() = i1.pos();
}
-void doRecordUndo(Undo::undo_kind kind,
+void Undo::Private::doRecordUndo(UndoKind kind,
DocIterator const & cell,
pit_type first_pit, pit_type last_pit,
- DocIterator const & cur,
- BufferParams const & bparams,
+ CursorData const & cur_before,
bool isFullBuffer,
- limited_stack<Undo> & stack)
+ UndoElementStack & stack)
{
+ if (!group_level) {
+ LYXERR0("There is no group open (creating one)");
+ ++group_id;
+ }
+
if (first_pit > last_pit)
- std::swap(first_pit, last_pit);
- // create the position information of the Undo entry
- Undo undo;
- undo.array = 0;
- undo.pars = 0;
- undo.kind = kind;
- undo.cell = cell;
- undo.cursor = cur;
- undo.bparams = bparams ;
- 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;
+ swap(first_pit, last_pit);
// 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.
- if (!undo_finished
- && kind != Undo::ATOMIC
+ 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) {
+ // reset cur_after; it will be filled correctly by endUndoGroup.
+ stack.top().cur_after = CursorData();
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_before, cell, from, end, 0, 0,
+ buffer_.params(), isFullBuffer, buffer_.isClean(), group_id);
// fill in the real data to be saved
if (cell.inMathed()) {
// simply use the whole cell
- undo.array = new MathData(cell.cell());
+ MathData & ar = cell.cell();
+ undo.array = new MathData(ar.buffer(), ar.begin(), ar.end());
} else {
// some more effort needed here as 'the whole cell' of the
- // main LyXText _is_ the whole document.
+ // main Text _is_ the whole document.
// record the relevant paragraphs
- LyXText const * text = cell.text();
- BOOST_ASSERT(text);
+ Text const * text = cell.text();
+ LASSERT(text, /**/);
ParagraphList const & plist = text->paragraphs();
ParagraphList::const_iterator first = plist.begin();
advance(first, first_pit);
// push the undo entry to undo stack
stack.push(undo);
- //lyxerr << "undo record: " << stack.top() << std::endl;
-
- // next time we'll try again to combine entries if possible
- undo_finished = false;
+ //lyxerr << "undo record: " << stack.top() << endl;
}
-void recordUndo(Undo::undo_kind kind,
- Cursor & cur, pit_type first_pit, pit_type last_pit,
- limited_stack<Undo> & stack)
+void Undo::Private::recordUndo(UndoKind kind,
+ DocIterator const & cell,
+ pit_type first_pit, pit_type last_pit,
+ CursorData const & cur,
+ bool isFullBuffer)
{
- BOOST_ASSERT(first_pit <= cur.lastpit());
- BOOST_ASSERT(last_pit <= cur.lastpit());
+ LASSERT(first_pit <= cell.lastpit(), /**/);
+ LASSERT(last_pit <= cell.lastpit(), /**/);
- doRecordUndo(kind, cur, first_pit, last_pit, cur,
- cur.bv().buffer()->params(), false, stack);
-}
+ doRecordUndo(kind, cell, first_pit, last_pit, cur,
+ isFullBuffer, undostack_);
+ // next time we'll try again to combine entries if possible
+ undo_finished_ = false;
+ // If we ran recordUndo, it means that we plan to change the buffer
+ buffer_.markDirty();
-// Returns false if no undo possible.
-bool textUndoOrRedo(BufferView & bv,
- limited_stack<Undo> & stack, limited_stack<Undo> & otherstack)
-{
- finishUndo();
+ redostack_.clear();
+ //lyxerr << "undostack:\n";
+ //for (size_t i = 0, n = buf.undostack().size(); i != n && i < 6; ++i)
+ // lyxerr << " " << i << ": " << buf.undostack()[i] << endl;
+}
- if (stack.empty()) {
- // Nothing to do.
- return false;
- }
+void Undo::Private::doTextUndoOrRedo(CursorData & cur, UndoElementStack & stack, UndoElementStack & otherstack)
+{
// Adjust undo stack and get hold of current undo data.
- Undo 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'
- Buffer * buf = bv.buffer();
- DocIterator cell_dit = undo.cell.asDocIterator(&buf->inset());
+ DocIterator cell_dit = undo.cell.asDocIterator(&buffer_);
- doRecordUndo(Undo::ATOMIC, cell_dit,
- undo.from, cell_dit.lastpit() - undo.end, bv.cursor(),
- undo.bparams, undo.isFullBuffer,
- otherstack);
+ doRecordUndo(ATOMIC_UNDO, cell_dit,
+ undo.from, cell_dit.lastpit() - undo.end, undo.cur_after,
+ undo.isFullBuffer, otherstack);
+ otherstack.top().cur_after = undo.cur_before;
// This does the actual undo/redo.
- //lyxerr << "undo, performing: " << undo << std::endl;
- DocIterator dit = undo.cell.asDocIterator(&buf->inset());
+ //LYXERR0("undo, performing: " << undo);
+ DocIterator dit = undo.cell.asDocIterator(&buffer_);
if (undo.isFullBuffer) {
- BOOST_ASSERT(undo.pars);
+ LASSERT(undo.pars, /**/);
// This is a full document
- otherstack.top().bparams = buf->params();
- buf->params() = undo.bparams;
- std::swap(buf->paragraphs(), *undo.pars);
+ 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;
} else if (dit.inMathed()) {
// We stored the full cell here as there is not much to be
// gained by storing just 'a few' paragraphs (most if not
// all math inset cells have just one paragraph!)
- //lyxerr << "undo.array: " << *undo.array <<endl;
- BOOST_ASSERT(undo.array);
+ //LYXERR0("undo.array: " << *undo.array);
+ LASSERT(undo.array, /**/);
dit.cell().swap(*undo.array);
delete undo.array;
undo.array = 0;
} else {
// Some finer machinery is needed here.
- LyXText * text = dit.text();
- BOOST_ASSERT(text);
- BOOST_ASSERT(undo.pars);
+ Text * text = dit.text();
+ LASSERT(text, /**/);
+ LASSERT(undo.pars, /**/);
ParagraphList & plist = text->paragraphs();
// remove new stuff between first and last
plist.insert(first, undo.pars->begin(), undo.pars->end());
delete undo.pars;
undo.pars = 0;
- updateLabels(*buf);
}
- BOOST_ASSERT(undo.pars == 0);
- BOOST_ASSERT(undo.array == 0);
+ LASSERT(undo.pars == 0, /**/);
+ LASSERT(undo.array == 0, /**/);
+
+ if (!undo.cur_before.empty())
+ cur = undo.cur_before;
+ if (undo.lyx_clean)
+ buffer_.markClean();
+ else
+ buffer_.markDirty();
+ // Now that we're done with undo, we pop it off the stack.
+ stack.pop();
+}
+
+
+bool Undo::Private::textUndoOrRedo(CursorData & cur, bool isUndoOperation)
+{
+ undo_finished_ = true;
- // Set cursor
- Cursor & cur = bv.cursor();
- cur.setCursor(undo.cursor.asDocIterator(&buf->inset()));
- cur.selection() = false;
- cur.resetAnchor();
- cur.fixIfBroken();
- finishUndo();
+ 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.
return true;
}
-} // namespace anon
-
-void finishUndo()
+void Undo::finishUndo()
{
// Make sure the next operation will be stored.
- undo_finished = true;
+ d->undo_finished_ = true;
}
-bool textUndo(BufferView & bv)
+bool Undo::textUndo(CursorData & cur)
{
- return textUndoOrRedo(bv, bv.buffer()->undostack(),
- bv.buffer()->redostack());
+ return d->textUndoOrRedo(cur, true);
}
-bool textRedo(BufferView & bv)
+bool Undo::textRedo(CursorData & cur)
{
- return textUndoOrRedo(bv, bv.buffer()->redostack(),
- bv.buffer()->undostack());
+ return d->textUndoOrRedo(cur, false);
}
-void recordUndo(Undo::undo_kind kind,
- Cursor & cur, pit_type first, pit_type last)
+void Undo::beginUndoGroup()
{
- Buffer * buf = cur.bv().buffer();
- recordUndo(kind, cur, first, last, buf->undostack());
- buf->redostack().clear();
- //lyxerr << "undostack:\n";
- //for (size_t i = 0, n = buf->undostack().size(); i != n && i < 6; ++i)
- // lyxerr << " " << i << ": " << buf->undostack()[i] << std::endl;
+ 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 recordUndo(Cursor & cur, Undo::undo_kind kind)
+void Undo::endUndoGroup()
{
- recordUndo(kind, cur, cur.pit(), cur.pit());
+ if (d->group_level == 0) {
+ LYXERR0("There is no undo group to end here");
+ return;
+ }
+ --d->group_level;
+ if (d->group_level == 0) {
+ // real end of the group
+ LYXERR(Debug::UNDO, "-------End of group " << d->group_id);
+ }
+}
+
+
+void Undo::endUndoGroup(CursorData const & cur)
+{
+ endUndoGroup();
+ if (!d->undostack_.empty() && d->undostack_.top().cur_after.empty())
+ d->undostack_.top().cur_after = cur;
}
-void recordUndoInset(Cursor & cur, Undo::undo_kind kind)
+// FIXME: remove these convenience functions and make
+// Private::recordUndo public as sole interface. The code in the
+// convenience functions can move to Cursor.cpp.
+
+void Undo::recordUndo(CursorData const & cur, UndoKind kind)
{
- Cursor c = cur;
- c.pop();
- Buffer * buf = cur.bv().buffer();
- doRecordUndo(kind, c, c.pit(), c.pit(), cur,
- buf->params(), false, buf->undostack());
+ d->recordUndo(kind, cur, cur.pit(), cur.pit(), cur, false);
}
-void recordUndoSelection(Cursor & cur, Undo::undo_kind kind)
+void Undo::recordUndoInset(CursorData const & cur, UndoKind kind,
+ Inset const * inset)
{
- recordUndo(kind, cur, cur.selBegin().pit(), cur.selEnd().pit());
+ if (!inset || inset == &cur.inset()) {
+ DocIterator c = cur;
+ c.pop_back();
+ d->recordUndo(kind, c, c.pit(), c.pit(), cur, false);
+ } else if (inset == cur.nextInset())
+ recordUndo(cur, kind);
+ else
+ LYXERR0("Inset not found, no undo stack added.");
}
-void recordUndo(Cursor & cur, Undo::undo_kind kind, pit_type from)
+void Undo::recordUndo(CursorData const & cur, UndoKind kind, pit_type from)
{
- recordUndo(kind, cur, cur.pit(), from);
+ d->recordUndo(kind, cur, cur.pit(), from, cur, false);
}
-void recordUndo(Cursor & cur, Undo::undo_kind kind,
+void Undo::recordUndo(CursorData const & cur, UndoKind kind,
pit_type from, pit_type to)
{
- recordUndo(kind, cur, from, to);
+ d->recordUndo(kind, cur, from, to, cur, false);
}
-void recordUndoFullDocument(BufferView * bv)
+void Undo::recordUndoFullDocument(CursorData const & cur)
{
- Buffer * buf = bv->buffer();
- doRecordUndo(
- Undo::ATOMIC,
- doc_iterator_begin(buf->inset()),
- 0, buf->paragraphs().size() - 1,
- bv->cursor(),
- buf->params(),
- true,
- buf->undostack()
- );
- undo_finished = false;
+ // This one may happen outside of the main undo group, so we
+ // put it in its own subgroup to avoid complaints.
+ beginUndoGroup();
+ d->recordUndo(ATOMIC_UNDO, doc_iterator_begin(&d->buffer_),
+ 0, d->buffer_.paragraphs().size() - 1, cur, true);
+ endUndoGroup();
}
projects / lyx.git / blobdiff