]> git.lyx.org Git - lyx.git/blobdiff - src/Undo.cpp
Update my email and status.
[lyx.git] / src / Undo.cpp
index 655f6e38ddf7cfd38ac688b524434ed2c33af930..ee87fdb0ced4ec9fd9977598d53949161e93e419 100644 (file)
@@ -20,7 +20,7 @@
 #include "Buffer.h"
 #include "BufferParams.h"
 #include "buffer_funcs.h"
-#include "DocIterator.h"
+#include "Cursor.h"
 #include "Paragraph.h"
 #include "ParagraphList.h"
 #include "Text.h"
@@ -43,37 +43,36 @@ using namespace lyx::support;
 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
 {
        ///
-       UndoElement(UndoKind kin, StableDocIterator const & cur
+       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), cursor(cur), cell(cel), from(fro), end(en),
-               pars(pl), array(ar), bparams(0), isFullBuffer(ifb), lyx_clean(lc), group_id(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);
@@ -82,7 +81,8 @@ struct UndoElement
        UndoElement(UndoElement const & ue)
        {
                kind = ue.kind;
-               cursor = ue.cursor;
+               cur_before = ue.cur_before;
+               cur_after = ue.cur_after;
                cell = ue.cell;
                from = ue.from;
                end = ue.end;
@@ -102,8 +102,10 @@ struct UndoElement
        }
        /// Which kind of operation are we recording for?
        UndoKind kind;
-       /// the position of the cursor
-       StableDocIterator cursor;
+       /// 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
@@ -186,23 +188,26 @@ struct Undo::Private
                                   group_id(0), group_level(0) {}
        
        // Do one undo/redo step
-       void doTextUndoOrRedo(DocIterator & cur, UndoElementStack & stack, UndoElementStack & otherStack);
+       void doTextUndoOrRedo(CursorData & cur, UndoElementStack & stack, 
+                             UndoElementStack & otherStack);
        // Apply one undo/redo group. Returns false if no undo possible.
-       bool textUndoOrRedo(DocIterator & cur, bool isUndoOperation);
+       bool textUndoOrRedo(CursorData & cur, bool isUndoOperation);
 
        ///
        void doRecordUndo(UndoKind kind,
                DocIterator const & cell,
                pit_type first_pit,
                pit_type last_pit,
-               DocIterator const & cur,
+               CursorData const & cur,
                bool isFullBuffer,
                UndoElementStack & stack);
        ///
        void recordUndo(UndoKind kind,
-               DocIterator const & cur,
+               DocIterator const & cell,
                pit_type first_pit,
-               pit_type last_pit);
+               pit_type last_pit,
+               CursorData const & cur,
+               bool isFullBuffer);
 
        ///
        Buffer & buffer_;
@@ -239,6 +244,18 @@ Undo::~Undo()
 }
 
 
+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;
+}
+
+
 bool Undo::hasUndoStack() const
 {
        return !d->undostack_.empty();
@@ -276,7 +293,7 @@ static bool samePar(StableDocIterator const & i1, StableDocIterator const & i2)
 void Undo::Private::doRecordUndo(UndoKind kind,
        DocIterator const & cell,
        pit_type first_pit, pit_type last_pit,
-       DocIterator const & cur,
+       CursorData const & cur_before,
        bool isFullBuffer,
        UndoElementStack & stack)
 {
@@ -299,15 +316,18 @@ void Undo::Private::doRecordUndo(UndoKind kind,
            && samePar(stack.top().cell, cell)
            && stack.top().kind == kind
            && stack.top().from == from
-           && stack.top().end == end)
+           && 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, cell, from, end, 0, 0, 
+       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
@@ -332,22 +352,27 @@ void Undo::Private::doRecordUndo(UndoKind kind,
        // 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 const & 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,
+                              CursorData 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, undostack_);
+       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)
@@ -355,7 +380,7 @@ void Undo::Private::recordUndo(UndoKind kind, DocIterator const & cur,
 }
 
 
-void Undo::Private::doTextUndoOrRedo(DocIterator & cur, UndoElementStack & stack, UndoElementStack & otherstack)
+void Undo::Private::doTextUndoOrRedo(CursorData & cur, UndoElementStack & stack, UndoElementStack & otherstack)
 {
        // Adjust undo stack and get hold of current undo data.
        UndoElement & undo = stack.top();
@@ -367,8 +392,9 @@ void Undo::Private::doTextUndoOrRedo(DocIterator & cur, UndoElementStack & stack
        DocIterator cell_dit = undo.cell.asDocIterator(&buffer_);
 
        doRecordUndo(ATOMIC_UNDO, cell_dit,
-               undo.from, cell_dit.lastpit() - undo.end, cur,
+               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.
        //LYXERR0("undo, performing: " << undo);
@@ -422,7 +448,8 @@ void Undo::Private::doTextUndoOrRedo(DocIterator & cur, UndoElementStack & stack
        LASSERT(undo.pars == 0, /**/);
        LASSERT(undo.array == 0, /**/);
 
-       cur = undo.cursor.asDocIterator(&buffer_);
+       if (!undo.cur_before.empty())
+               cur = undo.cur_before;
        if (undo.lyx_clean)
                buffer_.markClean();
        else
@@ -432,7 +459,7 @@ void Undo::Private::doTextUndoOrRedo(DocIterator & cur, UndoElementStack & stack
 }
 
 
-bool Undo::Private::textUndoOrRedo(DocIterator & cur, bool isUndoOperation)
+bool Undo::Private::textUndoOrRedo(CursorData & cur, bool isUndoOperation)
 {
        undo_finished_ = true;
 
@@ -461,13 +488,13 @@ void Undo::finishUndo()
 }
 
 
-bool Undo::textUndo(DocIterator & cur)
+bool Undo::textUndo(CursorData & cur)
 {
        return d->textUndoOrRedo(cur, true);
 }
 
 
-bool Undo::textRedo(DocIterator & cur)
+bool Undo::textRedo(CursorData & cur)
 {
        return d->textUndoOrRedo(cur, false);
 }
@@ -486,8 +513,10 @@ void Undo::beginUndoGroup()
 
 void Undo::endUndoGroup()
 {
-       if (d->group_level == 0)
+       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
@@ -496,21 +525,31 @@ void Undo::endUndoGroup()
 }
 
 
+void Undo::endUndoGroup(CursorData const & cur)
+{
+       endUndoGroup();
+       if (!d->undostack_.empty() && d->undostack_.top().cur_after.empty())
+               d->undostack_.top().cur_after = cur;
+}
+
+
+// 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)
+void Undo::recordUndo(CursorData 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 const & cur, UndoKind kind,
+void Undo::recordUndoInset(CursorData const & cur, UndoKind kind,
                           Inset const * inset)
 {
        if (!inset || inset == &cur.inset()) {
                DocIterator c = cur;
                c.pop_back();
-               d->doRecordUndo(kind, c, c.pit(), c.pit(),
-                               cur, false, d->undostack_);
+               d->recordUndo(kind, c, c.pit(), c.pit(), cur, false);
        } else if (inset == cur.nextInset())
                recordUndo(cur, kind);
        else
@@ -518,32 +557,26 @@ void Undo::recordUndoInset(DocIterator const & cur, UndoKind kind,
 }
 
 
-void Undo::recordUndo(DocIterator const & cur, UndoKind kind, pit_type from)
+void Undo::recordUndo(CursorData 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 const & cur, UndoKind kind,
+void Undo::recordUndo(CursorData 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 const & cur)
+void Undo::recordUndoFullDocument(CursorData 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_),
-               0, d->buffer_.paragraphs().size() - 1,
-               cur,
-               true,
-               d->undostack_
-       );
+       d->recordUndo(ATOMIC_UNDO, doc_iterator_begin(&d->buffer_), 
+                     0, d->buffer_.paragraphs().size() - 1, cur, true);
        endUndoGroup();
 }