]> git.lyx.org Git - lyx.git/blobdiff - src/Undo.cpp
Kill LFUN_PARAGRAPH_SPACING in favour of LFUN_PARAGRAPH_PARAMS.
[lyx.git] / src / Undo.cpp
index 06bd16ccc80ce13c0956397b14c23e33931ed925..a24bdead03e3861df2d6d18ab52e0b738be626ed 100644 (file)
@@ -4,10 +4,10 @@
  * 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.
@@ -71,9 +71,9 @@ struct UndoElement
                    StableDocIterator const & cel,
                    pit_type fro, pit_type en, ParagraphList * pl, 
                    MathData * ar, BufferParams const & bp, 
-                   bool ifb) :
+                   bool ifb, size_t gid) :
                kind(kin), cursor(cur), cell(cel), from(fro), end(en),
-               pars(pl), array(ar), bparams(0), isFullBuffer(ifb)
+               pars(pl), array(ar), bparams(0), isFullBuffer(ifb), group_id(gid)
        {
                if (isFullBuffer)
                        bparams = new BufferParams(bp);
@@ -91,6 +91,7 @@ struct UndoElement
                bparams = ue.isFullBuffer
                        ? new BufferParams(*ue.bparams) : ue.bparams;
                isFullBuffer = ue.isFullBuffer;
+               group_id = ue.group_id;
        }
        ///
        ~UndoElement()
@@ -116,6 +117,8 @@ struct UndoElement
        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();  
@@ -148,12 +151,16 @@ public:
                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();
+               }
        }
 
 private:
@@ -166,10 +173,14 @@ private:
 
 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,
@@ -177,11 +188,10 @@ struct Undo::Private
                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);
 
@@ -194,6 +204,11 @@ struct Undo::Private
 
        /// The flag used by Undo::finishUndo().
        bool undo_finished_;
+
+       /// Current group Id.
+       size_t group_id;
+       /// Current group nesting nevel.
+       size_t group_level;
 };
 
 
@@ -246,8 +261,13 @@ void Undo::Private::doRecordUndo(UndoKind kind,
        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);
 
@@ -256,7 +276,6 @@ void Undo::Private::doRecordUndo(UndoKind kind,
        // 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()
@@ -266,9 +285,13 @@ void Undo::Private::doRecordUndo(UndoKind kind,
            && 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, group_id);
 
        // fill in the real data to be saved
        if (cell.inMathed()) {
@@ -297,14 +320,14 @@ void Undo::Private::doRecordUndo(UndoKind kind,
 }
 
 
-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();
@@ -314,34 +337,24 @@ void Undo::Private::recordUndo(UndoKind kind, DocIterator & cur,
 }
 
 
-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();
+       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
@@ -387,18 +400,35 @@ bool Undo::Private::textUndoOrRedo(DocIterator & cur, bool isUndoOperation)
                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());
+       cur = undo.cursor.asDocIterator(&buffer_);
        // Now that we're done with undo, we pop it off the stack.
        stack.pop();
+}
 
-       if (labelsUpdateNeeded)
-               updateLabels(buffer_);
+
+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;
 }
 
@@ -422,43 +452,71 @@ bool Undo::textRedo(DocIterator & cur)
 }
 
 
-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();
 }