* 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.
namespace lyx {
/**
-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.
+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 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 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 ranged should be as small as possible. However, it
-there is a lower limit: The StableDocIterator pointing 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.
+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
{
///
StableDocIterator const & cel,
pit_type fro, pit_type en, ParagraphList * pl,
MathData * ar, BufferParams const & bp,
- bool ifb) :
+ bool ifb, bool lc, size_t gid) :
kind(kin), cursor(cur), cell(cel), from(fro), end(en),
- pars(pl), array(ar), bparams(&bp), isFullBuffer(ifb)
- {}
+ 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;
+ 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;
+ 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
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();
c_.clear();
}
- /// Push an item on to the stack, deleting the
- /// bottom item on overflow.
+ /// 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_)
- c_.pop_back();
+ 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_;
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 & cell,
pit_type first_pit,
- pit_type last_pit);
+ pit_type last_pit,
+ DocIterator const & cur,
+ bool isFullBuffer);
///
Buffer & buffer_;
/// The flag used by Undo::finishUndo().
bool undo_finished_;
+
+ /// Current group Id.
+ size_t group_id;
+ /// Current group nesting nevel.
+ size_t group_level;
};
}
+void Undo::clear()
+{
+ d->undostack_.clear();
+ d->redostack_.clear();
+ d->undo_finished_ = true;
+ d->group_id = 0;
+ d->group_level = 0;
+}
+
+
bool Undo::hasUndoStack() const
{
return !d->undostack_.empty();
}
-static bool samePar(StableDocIterator const & i1, StableDocIterator const & i2)
+void Undo::markDirty()
{
- StableDocIterator tmpi2 = i2;
- tmpi2.pos() = i1.pos();
- return i1 == tmpi2;
+ d->undo_finished_ = true;
+ d->undostack_.markDirty();
+ d->redostack_.markDirty();
}
//
///////////////////////////////////////////////////////////////////////
+static bool samePar(StableDocIterator const & i1, StableDocIterator const & i2)
+{
+ StableDocIterator tmpi2 = i2;
+ tmpi2.pos() = i1.pos();
+ return i1 == tmpi2;
+}
+
+
void Undo::Private::doRecordUndo(UndoKind kind,
DocIterator const & cell,
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);
// we want combine 'similar' non-ATOMIC undo recordings to one.
pit_type from = first_pit;
pit_type end = cell.lastpit() - last_pit;
- UndoElementStack & stack = isUndoOperation ? undostack_ : redostack_;
if (!undo_finished_
&& kind != ATOMIC_UNDO
&& !stack.empty()
&& 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);
+ 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 Text _is_ the whole document.
// push the undo entry to undo stack
stack.push(undo);
//lyxerr << "undo record: " << stack.top() << endl;
-
- // next time we'll try again to combine entries if possible
- undo_finished_ = false;
}
-void Undo::Private::recordUndo(UndoKind kind, DocIterator & cur,
- pit_type first_pit, pit_type last_pit)
+void Undo::Private::recordUndo(UndoKind kind,
+ DocIterator const & cell,
+ pit_type first_pit, pit_type last_pit,
+ DocIterator const & cur,
+ bool isFullBuffer)
{
- LASSERT(first_pit <= cur.lastpit(), /**/);
- LASSERT(last_pit <= cur.lastpit(), /**/);
+ LASSERT(first_pit <= cell.lastpit(), /**/);
+ LASSERT(last_pit <= cell.lastpit(), /**/);
- doRecordUndo(kind, cur, first_pit, last_pit, cur,
- false, true);
+ 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();
+
redostack_.clear();
//lyxerr << "undostack:\n";
//for (size_t i = 0, n = buf.undostack().size(); i != n && i < 6; ++i)
}
-bool Undo::Private::textUndoOrRedo(DocIterator & cur, bool isUndoOperation)
+void Undo::Private::doTextUndoOrRedo(DocIterator & cur, UndoElementStack & stack, UndoElementStack & otherstack)
{
- undo_finished_ = true;
-
- UndoElementStack & stack = isUndoOperation ? undostack_ : redostack_;
-
- if (stack.empty())
- // Nothing to do.
- return false;
-
- UndoElementStack & 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();
+ delete otherstack.top().bparams;
+ otherstack.top().bparams = new BufferParams(buffer_.params());
buffer_.params() = *undo.bparams;
swap(buffer_.paragraphs(), *undo.pars);
delete undo.pars;
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_);
+ 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(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.
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);
+ }
+}
+
+// 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(DocIterator const & cur, UndoKind kind)
{
- d->recordUndo(kind, cur, cur.pit(), cur.pit());
+ d->recordUndo(kind, cur, cur.pit(), cur.pit(), cur, false);
}
-void Undo::recordUndoInset(DocIterator & cur, UndoKind kind)
+void Undo::recordUndoInset(DocIterator const & cur, UndoKind kind,
+ Inset const * inset)
{
- DocIterator c = cur;
- c.pop_back();
- d->doRecordUndo(kind, c, c.pit(), c.pit(), cur, false, true);
+ 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 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);
+ d->recordUndo(kind, cur, cur.pit(), from, cur, false);
}
-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);
+ d->recordUndo(kind, cur, from, to, cur, false);
}
-void Undo::recordUndoFullDocument(DocIterator & cur)
+void Undo::recordUndoFullDocument(DocIterator const & cur)
{
- d->doRecordUndo(
- ATOMIC_UNDO,
- doc_iterator_begin(d->buffer_.inset()),
- 0, d->buffer_.paragraphs().size() - 1,
- cur,
- true,
- true
- );
+ // 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();
}