]> git.lyx.org Git - lyx.git/blobdiff - src/undo_funcs.C
More 'standard conformant blurb' nonsense.
[lyx.git] / src / undo_funcs.C
index 50a8dce3123b9e1ac95e4d09b8537c23624f8628..2705a0ed335a51ac96d861fa3eed82bfd64d4907 100644 (file)
 #include "support/LAssert.h"
 #include "iterators.h"
 
-#include <vector>
-
-using std::vector;
-using boost::shared_ptr;
-
 
 /// The flag used by FinishUndo().
 bool undo_finished;
+
 /// Whether actions are not added to the undo stacks.
 bool undo_frozen;
 
 namespace {
 
-/// Utility to return the cursor.
-LyXCursor const & undoCursor(BufferView * bv)
-{
-       if (bv->theLockingInset())
-               return bv->theLockingInset()->cursor(bv);
-       return bv->text->cursor;
-}
-
 
-/**
- * Returns a pointer to the very first Paragraph depending of where
- * we are so it will return the first paragraph of the buffer or the
- * first paragraph of the textinset we're in.
- */
-ParagraphList * undoParagraphs(BufferView * bv, int inset_id)
+void recordUndo(BufferView * bv, Undo::undo_kind kind,
+       ParagraphList::iterator first, ParagraphList::iterator last,
+       limited_stack<Undo> & stack)
 {
-       Inset * inset = bv->buffer()->getInsetFromID(inset_id);
-       if (inset) {
-               ParagraphList * result = inset->getParagraphs(0);
-               if (result && !result->empty())
-                       return result;
+       Buffer * buf = bv->buffer();
+
+       // First, record inset id, if cursor is in one
+       UpdatableInset * inset = first->inInset();
+       LyXText * text = inset ? inset->getLyXText(bv) : bv->text;
+       int const inset_id = inset ? inset->id() : -1;
+
+       // We simply record the entire outer paragraphs
+       ParagraphList * plist = &buf->paragraphs;
+       ParIterator null = buf->par_iterator_end();
+
+       // First, identify the outer paragraphs
+       for (ParIterator it = buf->par_iterator_begin(); it != null; ++it) {
+               if (it->id() == first->id())
+                       first = it.outerPar();
+               if (it->id() == last->id())
+                       last = it.outerPar();
        }
-       return &bv->text->ownerParagraphs();
-}
 
+       // And calculate a stable reference to them
+       int const first_offset = std::distance(plist->begin(), first);
+       int const last_offset = std::distance(last, plist->end());
 
-/**
- * Finish the undo operation in the case there was no entry
- * on the stack to perform.
- */
-void finishNoUndo(BufferView * bv)
-{
-       freezeUndo();
-       bv->unlockInset(bv->theLockingInset());
-       finishUndo();
-       bv->text->postPaint(0);
-       unFreezeUndo();
-}
-
+       // Undo::ATOMIC are always recorded (no overlapping there).
 
-// Returns false if no undo possible.
-bool textHandleUndo(BufferView * bv, Undo & undo)
-{
-       Buffer * b = bv->buffer();
-
-       ParIterator const before = b->getParFromID(undo.number_of_before_par);
-       ParIterator const behind = b->getParFromID(undo.number_of_behind_par);
-       ParIterator const end    = b->par_iterator_end();
-
-       // If there's no before take the beginning
-       // of the document for redoing.
-       if (before == end) {
-               LyXText * t = bv->text;
-               int num = undo.number_of_inset_id;
-               if (undo.number_of_inset_id >= 0) {
-                       Inset * in = bv->buffer()->getInsetFromID(num);
-                       if (in) {
-                               t = in->getLyXText(bv);
-                       } else {
-                               num = -1;
-                       }
-               }
-               t->setCursorIntern(undoParagraphs(bv, num)->begin(), 0);
-       }
-
-       // Set the right(new) inset-owner of the paragraph if there is any.
-       if (!undo.pars.empty()) {
-               Inset * in = 0;
-               if (before != end)
-                       in = before->inInset();
-               else if (undo.number_of_inset_id >= 0)
-                       in = bv->buffer()->getInsetFromID(undo.number_of_inset_id);
-               for (size_t i = 0, n = undo.pars.size(); i < n; ++i)
-                       undo.pars[i]->setInsetOwner(in);
-       }
-
-       // Replace the paragraphs with the undo informations.
-       vector<Paragraph *> deletelist;
-
-       // Now add old paragraphs to be deleted.
-       if (before != behind || (behind == end && before == end)) {
-               ParagraphList::iterator deletepar;
-               if (before != end) {
-                       deletepar = *before;
-                       ++deletepar;
-               } else {
-                       deletepar = undoParagraphs(bv, undo.number_of_inset_id)->begin();
-               }
-               // this surprisingly fills the undo! (Andre')
-               size_t par = 0;
-               //while (deletepar && deletepar != *behind)
-               while (deletepar != *behind) {
-                       deletelist.push_back(&*deletepar);
-                       ++deletepar;
-
-                       // A memory optimization for edit:
-                       // Only layout information
-                       // is stored in the undo. So restore
-                       // the text informations.
-                       if (undo.kind == Undo::EDIT) {
-                               undo.pars[par]->setContentsFromPar(*deletelist.back());
-                               ++par;
-                       }
+       // Overlapping only with insert and delete inside one paragraph:
+       // Nobody wants all removed character appear one by one when undoing.
+       if (! undo_finished && kind != Undo::ATOMIC) {
+               // Check whether storing is needed.
+               if (! buf->undostack.empty() 
+                   && buf->undostack.top().kind == kind 
+                   && buf->undostack.top().first_par_offset == first_offset
+                   && buf->undostack.top().last_par_offset == last_offset) {
+                       // No additonal undo recording needed -
+                       // effectively, we combine undo recordings to one.
+                       return;
                }
        }
 
-       // The order here is VERY IMPORTANT. We have to set the right
-       // next/prev pointer in the paragraphs so that a rebuild of
-       // the LyXText works!!!
+       // Record the cursor position in a stable way.
+       int const cursor_offset = std::distance
+               (text->ownerParagraphs().begin(), text->cursor.par());
 
-       // Thread the end of the undo onto the par in front if any.
-       if (!undo.pars.empty()) {
-#warning FIXME
-               //undo.pars.back()->next(&**behind);
-               //if (behind != end)
-               //(&**behind)->previous(undo.pars.back());
-       }
-
-       // Put the new stuff in the list if there is one.
-       Paragraph * undopar = undo.pars.empty() ? 0 : undo.pars.front();
-       if (!undo.pars.empty()) {
-#warning FIXME
-               //undo.pars.front()->previous(&**before);
-               if (before != end) {
-#warning FIXME
-                       //(&**before)->next(undopar);
-               } else {
-                       int id = undoParagraphs(bv, undo.number_of_inset_id)->begin()->id();
-                       ParIterator op = bv->buffer()->getParFromID(id);
-                       if (op != end && op->inInset()) {
-#warning FIXME reimplementaion needed here
-                               //static_cast<InsetText*>(op->inInset())->paragraph(undopar);
-                       } else {
-#warning FIXME reimplementation needed here
-                               //bv->buffer()->paragraphs.set(undopar);
-                       }
-               }
-       } else {
-               // We enter here on DELETE undo operations where we
-               // have to substitue the second paragraph with the
-               // first if the removed one is the first.
-               if (before == end && behind != end) {
-                       int id = undoParagraphs(bv, undo.number_of_inset_id)->begin()->id();
-                       ParIterator op = bv->buffer()->getParFromID(id);
-                       if (op != end && op->inInset()) {
-#warning FIXME reimplementation needed here
-                               //static_cast<InsetText*>(op->inInset())->paragraph(&**behind);
-                       } else {
-#warning FIXME reimplementation needed here
-                               //bv->buffer()->paragraphs.set(&**behind);
-                       }
-                       undopar = &**behind;
-               }
-       }
+       // Make and push the Undo entry
+       stack.push(Undo(kind, inset_id,
+               first_offset, last_offset,
+               cursor_offset, text->cursor.pos(),
+               ParagraphList()));
 
+       // Record the relevant paragraphs
+       ParagraphList & undo_pars = stack.top().pars;
 
-       // Set the cursor for redoing.
-       // If we have a par before the undopar.
-       if (before != end) {
-               Inset * it = before->inInset();
-               if (it)
-                       it->getLyXText(bv)->setCursorIntern(*before, 0);
-               else
-                       bv->text->setCursorIntern(*before, 0);
+       for (ParagraphList::iterator it = first; it != last; ++it) {
+               undo_pars.push_back(*it);
+               undo_pars.back().id(it->id());
        }
+       undo_pars.push_back(*last);
+       undo_pars.back().id(last->id());
 
-// we are not ready for this we cannot set the cursor for a paragraph
-// which is not already in a row of LyXText!!!
-#if 0
-       else { // otherwise this is the first one and we start here
-               Inset * it = undopar->inInset();
-               if (it)
-                       it->getLyXText(bv)->setCursorIntern(bv, undopar, 0);
-               else
-                       bv->text->setCursorIntern(bv, undopar, 0);
-       }
-#endif
-
-       UpdatableInset * it = 0;
-       if (undopar)
-               it = static_cast<UpdatableInset*>(undopar->inInset());
-
-       LyXText * text = it ? it->getLyXText(bv) : bv->text;
+       // And make sure that next time, we should be combining if possible
+       undo_finished = false;
+}
 
-       ParagraphList::iterator endpar = text->ownerParagraphs().end();
 
-       // Calculate the endpar for redoing the paragraphs.
-       if (behind != end) {
-               endpar = *behind;
-               ++endpar;
+// Returns false if no undo possible.
+bool performUndoOrRedo(BufferView * bv, Undo & undo)
+{
+       Buffer * buf = bv->buffer();
+       ParagraphList * plist = &buf->paragraphs;
+
+       // Remove new stuff between first and last
+       {
+               ParagraphList::iterator first = plist->begin();
+               advance(first, undo.first_par_offset);
+               ParagraphList::iterator last = plist->begin();
+               advance(last, plist->size() - undo.last_par_offset);
+               plist->erase(first, ++last);
        }
-
-       text->redoParagraphs(text->cursor, endpar);
-       ParIterator tmppar =
-               bv->buffer()->getParFromID(undo.number_of_cursor_par);
-
-       if (tmppar != end) {
-               LyXText * t;
-               Inset * it = tmppar->inInset();
-               if (it) {
-                       FuncRequest cmd(bv, LFUN_INSET_EDIT, "left");
-                       it->localDispatch(cmd);
-                       t = it->getLyXText(bv);
+               
+       // Re-insert old stuff instead
+       {
+               if (plist->empty()) {
+                       plist->assign(undo.pars.begin(), undo.pars.end());
                } else {
-                       t = bv->text;
+                       ParagraphList::iterator first = plist->begin();
+                       advance(first, undo.first_par_offset);
+                       plist->insert(first, undo.pars.begin(), undo.pars.end());
                }
-               t->setCursorIntern(*tmppar, undo.cursor_pos);
-               // Clear any selection and set the selection
-               // cursor for an evt. new selection.
-               t->clearSelection();
-               t->selection.cursor = t->cursor;
-               t->updateCounters();
        }
 
-       if (it) {
-               bv->fitCursor();
-               bv->updateInset(it);
-               bv->text->setCursorIntern(bv->text->cursor.par(),
-                                         bv->text->cursor.pos());
-       }
+       // Rebreak the entire document
+       bv->text->fullRebreak();
 
-       // And here it's safe enough to delete all removed paragraphs.
-       vector<Paragraph *>::iterator pit = deletelist.begin();
-       for(; pit != deletelist.end(); ++pit) {
-#warning FIXME
-               //(*pit)->previous(0);
-               //(*pit)->next(0);
-               delete (*pit);
-       }
+       // set cursor
+       {
+               // Get a hold of the inset for the cursor, if relevant
+               UpdatableInset * inset =
+                       static_cast<UpdatableInset *>(
+                               buf->getInsetFromID(undo.inset_id));
 
-       // Otherwise the undo destructor would delete the paragraphs
-       undo.pars.resize(0);
+               LyXText * text = inset ? inset->getLyXText(bv) : bv->text;
+               ParagraphList::iterator cursor = text->ownerParagraphs().begin();
+               advance(cursor, undo.cursor_par_offset);
+               text->setCursorIntern(cursor, undo.cursor_pos);
 
-       finishUndo();
-       bv->text->postPaint(0);
-       return true;
-}
-
-
-bool createUndo(BufferView * bv, Undo::undo_kind kind,
-       ParagraphList::iterator itfirst, ParagraphList::iterator itlast,
-       shared_ptr<Undo> & u)
-{
-       Buffer * b = bv->buffer();
-
-       ParIterator it     = b->par_iterator_begin();
-       ParIterator null   = b->par_iterator_end();
-       ParIterator prev   = null;
-       ParIterator before = null;
-       ParIterator first  = null;
-       ParIterator last   = null;
-       ParIterator behind = null;
-
-       for (; it != null; ++it) {
-               if ((*it)->id() == itfirst->id()) {
-                       first = it;
-                       before = prev;
-               } else if ((*it)->id() == itlast->id()) {
-                       last = it;
-                       behind = last;
-                       ++behind;
+               if (inset) {
+                       // Magic needed to update inset internal state
+                       FuncRequest cmd(bv, LFUN_INSET_EDIT, "left");
+                       inset->localDispatch(cmd);
                }
-               prev = it;
-       }
 
-       if (last == null)
-               last = first;
-
-       int const before_id = (before == null) ? -1 : (*before)->id();
-       int const first_id  = (first == null)  ? -1 : (*first)->id();
-       int const last_id   = (last == null)   ? -1 : (*last)->id();
-       int const behind_id = (behind == null) ? -1 : (*behind)->id();
-       int inset_id        = (first->inInset()) ? first->inInset()->id() : -1;
-
-       lyxerr << "\nbefore_id: " << before_id << "\n";
-       lyxerr << "first_id:  " << first_id  << "\n";
-       lyxerr << "last_id:   " << last_id   << "\n";
-       lyxerr << "behind_id: " << behind_id << "\n";
-       lyxerr << "inset_id:  " << inset_id  << "\n";
-
-       ParagraphList * plist = 0;
-       if (first != null)
-               plist = &first.plist();
-       else if (behind != null)
-               plist = &behind.plist();
-       else if (!plist) {
-               lyxerr << "plist from buffer (should this happen?)\n";
-               plist = &b->paragraphs;
-       }
+               // set cursor again to force the position to be the right one
+               text->setCursorIntern(cursor, undo.cursor_pos);
 
-       // Undo::EDIT and Undo::FINISH are
-       // always finished. (no overlapping there)
-       // overlapping only with insert and delete inside one paragraph:
-       // Nobody wants all removed  character
-       // appear one by one when undoing.
-       // EDIT is special since only layout information, not the
-       // contents of a paragaph are stored.
-       if (!undo_finished && (kind != Undo::EDIT) && (kind != Undo::FINISH)) {
-               // Check whether storing is needed.
-               if (!b->undostack.empty() &&
-                   b->undostack.top()->kind == kind &&
-                   b->undostack.top()->number_of_before_par == before_id &&
-                   b->undostack.top()->number_of_behind_par == behind_id) {
-                       // No undo needed.
-                       return false;
-               }
+               // Clear any selection and set the selection
+               // cursor for any new selection.
+               text->clearSelection();
+               text->selection.cursor = text->cursor;
+               text->updateCounters();
        }
 
-       // Create a new Undo.
-       std::vector<Paragraph *> undo_pars;
-
-       for (ParagraphList::iterator it = *first; it != *last; ++it) 
-               undo_pars.push_back(new Paragraph(*it, true));
-       undo_pars.push_back(new Paragraph(**last, true));
-
-       // A memory optimization: Just store the layout
-       // information when only edit.
-       if (kind == Undo::EDIT)
-               for (size_t i = 0, n = undo_pars.size(); i < n; ++i)
-                       undo_pars[i]->clearContents();
-
-       int cursor_par = undoCursor(bv).par()->id();
-       int cursor_pos = undoCursor(bv).pos();
-
-       lyxerr << "createUndo: inset_id: " << inset_id << "  before_id: "
-               << before_id << "  behind_id: " << behind_id << "\n";
-       u.reset(new Undo(kind, inset_id,
-               before_id, behind_id, cursor_par, cursor_pos, undo_pars));
-
-       undo_finished = false;
+       finishUndo();
        return true;
 }
 
 
 // Returns false if no undo possible.
 bool textUndoOrRedo(BufferView * bv,
-       limited_stack<boost::shared_ptr<Undo> > & stack,
-                   limited_stack<boost::shared_ptr<Undo> > & /*otherstack*/)
+       limited_stack<Undo> & stack,
+       limited_stack<Undo> & otherstack)
 {
-       //Buffer * b = bv->buffer();
-
        if (stack.empty()) {
-               finishNoUndo(bv);
+               /*
+                * Finish the undo operation in the case there was no entry
+                * on the stack to perform.
+                */
+               freezeUndo();
+               bv->unlockInset(bv->theLockingInset());
+               finishUndo();
+               unFreezeUndo();
                return false;
        }
 
-       shared_ptr<Undo> undo = stack.top();
+       Undo undo = stack.top();
        stack.pop();
        finishUndo();
 
        if (!undo_frozen) {
-/*
-               ParIterator p = b->getParFromID(undo->number_of_before_par);
-               bool ok = false;
-               ParagraphList::iterator first;
-               // default constructed?
-               ParIterator const end = b->par_iterator_end();
-               if (p != end) {
-                       first = p.par();
-                       if (first->next())
-                               first = first->next();
-               } else
-                       first = undoParagraphs(bv, undo->number_of_inset_id)->begin();
-               if (first) {
-                       shared_ptr<Undo> u;
-                       ParIterator behind = b->getParFromID(undo->number_of_behind_par);
-                       if (createUndo(bv, undo->kind, first, behind.par(), u))
-                               otherstack.push(u);
+               otherstack.push(undo);
+               otherstack.top().pars.clear();
+               Buffer * buf = bv->buffer();
+               ParagraphList & plist = buf->paragraphs;
+               if (undo.first_par_offset + undo.last_par_offset <= int(plist.size())) {
+                       ParagraphList::iterator first = plist.begin();
+                       advance(first, undo.first_par_offset);
+                       ParagraphList::iterator last = plist.begin();
+                       advance(last, plist.size() - undo.last_par_offset + 1);
+                       otherstack.top().pars.insert(otherstack.top().pars.begin(), first, last);
                }
-*/
        }
 
-       // Now we can unlock the inset for saftey because the inset
+       // Now we can unlock the inset for safety because the inset
        // pointer could be changed during the undo-function. Anyway
        // if needed we have to lock the right inset/position if this
        // is requested.
        freezeUndo();
        bv->unlockInset(bv->theLockingInset());
-       bool const ret = textHandleUndo(bv, *undo.get());
+       bool const ret = performUndoOrRedo(bv, undo);
        unFreezeUndo();
        return ret;
 }
@@ -419,13 +209,6 @@ bool textUndoOrRedo(BufferView * bv,
 } // namespace anon
 
 
-void finishUndo()
-{
-       // Makes sure the next operation will be stored.
-       undo_finished = true;
-}
-
-
 void freezeUndo()
 {
        // This is dangerous and for internal use only.
@@ -440,6 +223,13 @@ void unFreezeUndo()
 }
 
 
+void finishUndo()
+{
+       // Makes sure the next operation will be stored.
+       undo_finished = true;
+}
+
+
 bool textUndo(BufferView * bv)
 {
        return textUndoOrRedo(bv, bv->buffer()->undostack,
@@ -454,28 +244,25 @@ bool textRedo(BufferView * bv)
 }
 
 
-void setUndo(BufferView * bv, Undo::undo_kind kind,
-            ParagraphList::iterator first)
-{
-       setUndo(bv, kind, first, first);
-}
-
-
-void setUndo(BufferView * bv, Undo::undo_kind kind,
+void recordUndo(BufferView * bv, Undo::undo_kind kind,
             ParagraphList::iterator first, ParagraphList::iterator last)
 {
-#warning DISABLED
-       return;
        if (!undo_frozen) {
-               shared_ptr<Undo> u;
-               if (createUndo(bv, kind, first, last, u))
-                       bv->buffer()->undostack.push(u);
+               recordUndo(bv, kind, first, last, bv->buffer()->undostack);
                bv->buffer()->redostack.clear();
        }
 }
 
 
-void setCursorParUndo(BufferView * bv)
+void recordUndo(BufferView * bv, Undo::undo_kind kind,
+            ParagraphList::iterator first)
 {
-       setUndo(bv, Undo::FINISH, bv->text->cursor.par());
+       recordUndo(bv, kind, first, first);
 }
+
+
+void recordUndo(BufferView * bv, Undo::undo_kind kind)
+{
+       recordUndo(bv, kind, bv->text->cursor.par());
+}
+