]> git.lyx.org Git - lyx.git/blobdiff - src/Undo.cpp
* GuiView.cpp:
[lyx.git] / src / Undo.cpp
index 8378859ea3fe21ba25e74d5f4627de3621a3f913..06bd16ccc80ce13c0956397b14c23e33931ed925 100644 (file)
 
 #include "insets/Inset.h"
 
+#include "support/lassert.h"
 #include "support/debug.h"
-#include "support/limited_stack.h"
 
 #include <algorithm>
-#include <ostream>
+#include <deque>
 
 using namespace std;
 using namespace lyx::support;
 
-namespace lyx {
 
+namespace lyx {
 
 /**
 These are the elements put on the undo stack. Each object contains complete
@@ -61,10 +61,43 @@ 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.
-
 */
+
+
 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) :
+               kind(kin), cursor(cur), cell(cel), from(fro), end(en),
+               pars(pl), array(ar), bparams(0), isFullBuffer(ifb)
+       {
+               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;
+       }
+       ///
+       ~UndoElement()
+       {
+               if (isFullBuffer)
+                       delete bparams;
+       }
        /// Which kind of operation are we recording for?
        UndoKind kind;
        /// the position of the cursor
@@ -80,15 +113,60 @@ struct UndoElement
        /// 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;
+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 item on overflow.
+       void push(UndoElement const & v) {
+               c_.push_front(v);
+               if (c_.size() > limit_)
+                       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) {}
+       Private(Buffer & buffer) : buffer_(buffer), undo_finished_(true) {}
        
        // Returns false if no undo possible.
        bool textUndoOrRedo(DocIterator & cur, bool isUndoOperation);
@@ -110,18 +188,25 @@ struct Undo::Private
        ///
        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;
+       bool undo_finished_;
 };
 
 
-Undo::Undo(Buffer & buffer): d(new Undo::Private(buffer))
-{
-}
+/////////////////////////////////////////////////////////////////////
+//
+// Undo
+//
+/////////////////////////////////////////////////////////////////////
+
+
+Undo::Undo(Buffer & buffer)
+       : d(new Undo::Private(buffer))
+{}
 
 
 Undo::~Undo()
@@ -132,37 +217,29 @@ Undo::~Undo()
 
 bool Undo::hasUndoStack() const
 {
-       return !d->undostack.empty();
+       return !d->undostack_.empty();
 }
 
 
 bool Undo::hasRedoStack() const
 {
-       return !d->redostack.empty();
-}
-
-
-
-
-namespace {
-
-ostream & operator<<(ostream & os, UndoElement const & undo)
-{
-       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)
+static bool samePar(StableDocIterator const & i1, StableDocIterator const & i2)
 {
        StableDocIterator tmpi2 = i2;
        tmpi2.pos() = i1.pos();
        return i1 == tmpi2;
 }
 
-} // namespace anon
 
+/////////////////////////////////////////////////////////////////////
+//
+// Undo::Private
+//
+///////////////////////////////////////////////////////////////////////
 
 void Undo::Private::doRecordUndo(UndoKind kind,
        DocIterator const & cell,
@@ -173,36 +250,26 @@ void Undo::Private::doRecordUndo(UndoKind kind,
 {
        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.
-       if (!undo_finished
+       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()
-           && 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;
 
+       // create the position information of the Undo entry
+       UndoElement undo(kind, cur, cell, from, end, 0, 0, 
+                        buffer_.params(), isFullBuffer);
+
        // fill in the real data to be saved
        if (cell.inMathed()) {
                // simply use the whole cell
@@ -212,7 +279,7 @@ void Undo::Private::doRecordUndo(UndoKind kind,
                // main Text _is_ the whole document.
                // record the relevant paragraphs
                Text const * text = cell.text();
-               BOOST_ASSERT(text);
+               LASSERT(text, /**/);
                ParagraphList const & plist = text->paragraphs();
                ParagraphList::const_iterator first = plist.begin();
                advance(first, first_pit);
@@ -226,21 +293,21 @@ void Undo::Private::doRecordUndo(UndoKind kind,
        //lyxerr << "undo record: " << stack.top() << endl;
 
        // next time we'll try again to combine entries if possible
-       undo_finished = false;
+       undo_finished_ = false;
 }
 
 
 void Undo::Private::recordUndo(UndoKind kind, DocIterator & cur,
        pit_type first_pit, pit_type last_pit)
 {
-       BOOST_ASSERT(first_pit <= cur.lastpit());
-       BOOST_ASSERT(last_pit <= cur.lastpit());
+       LASSERT(first_pit <= cur.lastpit(), /**/);
+       LASSERT(last_pit <= cur.lastpit(), /**/);
 
        doRecordUndo(kind, cur, first_pit, last_pit, cur,
                false, true);
 
-       undo_finished = false;
-       redostack.clear();
+       undo_finished_ = false;
+       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;
@@ -249,21 +316,20 @@ void Undo::Private::recordUndo(UndoKind kind, DocIterator & cur,
 
 bool Undo::Private::textUndoOrRedo(DocIterator & cur, bool isUndoOperation)
 {
-       undo_finished = true;
+       undo_finished_ = true;
 
-       limited_stack<UndoElement> & stack = isUndoOperation ?
-               undostack : redostack;
+       UndoElementStack & stack = isUndoOperation ?  undostack_ : redostack_;
 
        if (stack.empty())
                // Nothing to do.
                return false;
 
-       limited_stack<UndoElement> & otherstack = isUndoOperation ?
-               redostack : undostack;
+       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();
+       // 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());
@@ -277,10 +343,11 @@ bool Undo::Private::textUndoOrRedo(DocIterator & cur, bool isUndoOperation)
        bool labelsUpdateNeeded = false;
        DocIterator dit = undo.cell.asDocIterator(&buffer_.inset());
        if (undo.isFullBuffer) {
-               BOOST_ASSERT(undo.pars);
+               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;
@@ -289,15 +356,15 @@ bool Undo::Private::textUndoOrRedo(DocIterator & cur, bool isUndoOperation)
                // gained by storing just 'a few' paragraphs (most if not
                // all math inset cells have just one paragraph!)
                //LYXERR0("undo.array: " << *undo.array);
-               BOOST_ASSERT(undo.array);
+               LASSERT(undo.array, /**/);
                dit.cell().swap(*undo.array);
                delete undo.array;
                undo.array = 0;
        } else {
                // Some finer machinery is needed here.
                Text * text = dit.text();
-               BOOST_ASSERT(text);
-               BOOST_ASSERT(undo.pars);
+               LASSERT(text, /**/);
+               LASSERT(undo.pars, /**/);
                ParagraphList & plist = text->paragraphs();
 
                // remove new stuff between first and last
@@ -322,14 +389,16 @@ bool Undo::Private::textUndoOrRedo(DocIterator & cur, bool isUndoOperation)
                undo.pars = 0;
                labelsUpdateNeeded = true;
        }
-       BOOST_ASSERT(undo.pars == 0);
-       BOOST_ASSERT(undo.array == 0);
+       LASSERT(undo.pars == 0, /**/);
+       LASSERT(undo.array == 0, /**/);
 
        cur = undo.cursor.asDocIterator(&buffer_.inset());
-       
+       // Now that we're done with undo, we pop it off the stack.
+       stack.pop();
+
        if (labelsUpdateNeeded)
                updateLabels(buffer_);
-       undo_finished = true;
+       undo_finished_ = true;
        return true;
 }
 
@@ -337,7 +406,7 @@ bool Undo::Private::textUndoOrRedo(DocIterator & cur, bool isUndoOperation)
 void Undo::finishUndo()
 {
        // Make sure the next operation will be stored.
-       d->undo_finished = true;
+       d->undo_finished_ = true;
 }
 
 
@@ -363,7 +432,7 @@ void Undo::recordUndoInset(DocIterator & 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, true);
 }