-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
+/**
+ * \file undo_funcs.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * Copyright 1995-2001 The LyX Team.
+ * \author Asger Alstrup
+ * \author Lars Gullik Bjønnes
+ * \author John Levon
+ * \author André Pönitz
+ * \author Jürgen Vigna
*
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
#include <config.h>
/// The flag used by FinishUndo().
bool undo_finished;
+
/// Whether actions are not added to the undo stacks.
bool undo_frozen;
namespace {
-/**
- * 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();
-}
-
-
-// Returns false if no undo possible.
-bool textHandleUndo(BufferView * bv, Undo & undo)
+void recordUndo(BufferView * bv, Undo::undo_kind kind,
+ ParagraphList::iterator first, ParagraphList::iterator last,
+ limited_stack<Undo> & stack)
{
Buffer * buf = bv->buffer();
- ParIterator const before = buf->getParFromID(undo.number_of_before_par);
- ParIterator const behind = buf->getParFromID(undo.number_of_behind_par);
- ParIterator const null = buf->par_iterator_end();
-
- int const before_id = (before == null) ? -1 : before->id();
- int const behind_id = (behind == null) ? -1 : behind->id();
- int const inset_id = undo.number_of_inset_id;
-
- Inset * inset = bv->buffer()->getInsetFromID(inset_id);
+ // 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;
- ParagraphList * plist = &bv->text->ownerParagraphs();
- if (inset) {
- ParagraphList * tmp = inset->getParagraphs(0);
- if (tmp && !tmp->empty())
- plist = tmp;
- }
+ // We simply record the entire outer paragraphs
+ ParagraphList * plist = &buf->paragraphs;
+ ParIterator null = buf->par_iterator_end();
- ParagraphList::iterator first;
- if (before == null) {
- // if there's no before take the beginning of parlist.
- first = plist->begin();
- text->setCursorIntern(plist->begin(), 0);
- } else {
- first = *before;
- ++first;
- }
- int const first_id = first->id();
-
- lyxerr << "\nhandle: before_id: " << before_id << "\n";
- lyxerr << "handle: first_id: " << first_id << "\n";
- lyxerr << "handle: behind_id: " << behind_id << "\n";
- lyxerr << "handle: inset_id: " << inset_id << "\n";
-
- // Set the right(new) inset-owner of the paragraph if there is any.
- UpdatableInset * in = 0;
- if (before != null)
- in = before->inInset();
- else if (inset_id >= 0) {
- Inset * inset = bv->buffer()->getInsetFromID(inset_id);
- in = static_cast<UpdatableInset *>(inset);
- }
- ParagraphList::iterator pit = undo.pars.begin();
- ParagraphList::iterator end = undo.pars.end();
- for ( ; pit != end; ++pit)
- pit->setInsetOwner(in);
- lyxerr << "in: " << in << "\n";
- lyxerr << "undo.pars.size(): " << undo.pars.size() << "\n";
-
- // remove stuff between first and behind
- if (behind == null)
- plist->erase(first, plist->end());
- else
- plist->erase(first, *behind);
- lyxerr << "after erase\n";
-
- // re-create first
- if (before == null) {
- // if there's no before take the beginning of parlist.
- lyxerr << "no 'before'\n";
- first = plist->begin();
- } else {
- lyxerr << "have 'before'\n";
- first = *before;
- ++first;
+ // 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();
}
+ // 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());
+
+ // Undo::ATOMIC are always recorded (no overlapping there).
- // inset saved paragraphs
- lyxerr << "undo.pars.size(): " << undo.pars.size() << "\n";
- plist->insert(first, undo.pars.begin(), undo.pars.end());
- lyxerr << "after insert\n";
- /*
- // 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;
}
- */
-
- // Set the cursor for redoing
- // if we have a par before the first.
- if (before != null) {
- Inset * it = before->inInset();
- LyXText * text = it ? it->getLyXText(bv) : bv->text;
- text->setCursorIntern(*before, 0);
}
- UpdatableInset * it = 0;
- if (first != plist->end())
- it = first->inInset();
- lyxerr << "it: " << it << "\n";
-
-
- text->redoParagraphs(text->cursor, plist->end());
+ // Record the cursor position in a stable way.
+ int const cursor_offset = std::distance
+ (text->ownerParagraphs().begin(), text->cursor.par());
- ParIterator tmppar = bv->buffer()->getParFromID(inset_id);
+ // Make and push the Undo entry
+ stack.push(Undo(kind, inset_id,
+ first_offset, last_offset,
+ cursor_offset, text->cursor.pos(),
+ ParagraphList()));
- if (tmppar != null) {
- lyxerr << "tmppar: " << tmppar->id() << "\n";
- LyXText * t;
- Inset * it = tmppar->inInset();
- if (it) {
- FuncRequest cmd(bv, LFUN_INSET_EDIT, "left");
- it->localDispatch(cmd);
- t = it->getLyXText(bv);
- } else {
- t = bv->text;
- }
- 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();
- } else {
- lyxerr << "tmppar == null \n";
- }
+ // Record the relevant paragraphs
+ ParagraphList & undo_pars = stack.top().pars;
- if (it) {
- lyxerr << "fit cursor...\n";
- bv->fitCursor();
- bv->updateInset(it);
- bv->text->setCursorIntern(bv->text->cursor.par(),
- bv->text->cursor.pos());
+ 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());
- finishUndo();
- bv->text->postPaint(0);
-
- lyxerr << "finished textHandleUndo...\n";
- return true;
+ // And make sure that next time, we should be combining if possible
+ undo_finished = false;
}
-void createUndo(BufferView * bv, Undo::undo_kind kind,
- int first_id, int last_id,
- limited_stack<Undo> & stack)
+// Returns false if no undo possible.
+bool performUndoOrRedo(BufferView * bv, Undo & undo)
{
Buffer * buf = bv->buffer();
-
- ParIterator null = buf->par_iterator_end();
- ParIterator prev = null;
- ParIterator before = null;
- ParIterator first = null;
- ParIterator last = null;
- ParIterator behind = null;
-
- for (ParIterator it = buf->par_iterator_begin(); it != null; ++it) {
- if (it->id() == first_id) {
- first = it;
- before = prev;
- }
- if (it->id() == last_id) {
- last = it;
- behind = last;
- ++behind;
+ 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);
+ }
+
+ // Re-insert old stuff instead
+ {
+ if (plist->empty()) {
+ plist->assign(undo.pars.begin(), undo.pars.end());
+ } else {
+ ParagraphList::iterator first = plist->begin();
+ advance(first, undo.first_par_offset);
+ plist->insert(first, undo.pars.begin(), undo.pars.end());
}
- prev = it;
}
- if (last == null)
- last = first;
-
- int const before_id = (before == null) ? -1 : before->id();
- int const behind_id = (behind == null) ? -1 : behind->id();
- int inset_id = (first->inInset()) ? first->inInset()->id() : -1;
-
- lyxerr << "\ncreate: before_id: " << before_id << "\n";
- lyxerr << "create: first_id: " << first_id << "\n";
- lyxerr << "create: last_id: " << last_id << "\n";
- lyxerr << "create: behind_id: " << behind_id << "\n";
- lyxerr << "create: inset_id: " << inset_id << "\n";
- lyxerr << "create: kind: " << kind << "\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 = &buf->paragraphs;
- }
+ // Rebreak the entire document
+ bv->text->fullRebreak();
- // 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 (!buf->undostack.empty() &&
- buf->undostack.top().kind == kind &&
- buf->undostack.top().number_of_before_par == before_id &&
- buf->undostack.top().number_of_behind_par == behind_id) {
- // No undo needed.
- return;
- }
- }
+ // set cursor
+ {
+ // Get a hold of the inset for the cursor, if relevant
+ UpdatableInset * inset =
+ static_cast<UpdatableInset *>(
+ buf->getInsetFromID(undo.inset_id));
- // Create a new Undo.
- LyXCursor const & cur = bv->theLockingInset() ?
- bv->theLockingInset()->cursor(bv) : bv->text->cursor;
+ 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);
- stack.push(Undo(kind, inset_id,
- before_id, behind_id, cur.par()->id(), cur.pos(), ParagraphList()));
+ if (inset) {
+ // Magic needed to update inset internal state
+ FuncRequest cmd(bv, LFUN_INSET_EDIT, "left");
+ inset->localDispatch(cmd);
+ }
- ParagraphList & undo_pars = stack.top().pars;
+ // set cursor again to force the position to be the right one
+ text->setCursorIntern(cursor, undo.cursor_pos);
- for (ParagraphList::iterator it = *first; it != *last; ++it) {
- undo_pars.push_back(*it);
- undo_pars.back().id(it->id());
+ // Clear any selection and set the selection
+ // cursor for any new selection.
+ text->clearSelection();
+ text->selection.cursor = text->cursor;
+ text->updateCounters();
}
- undo_pars.push_back(**last);
- undo_pars.back().id(last->id());
- // A memory optimization: Just store the layout
- // information when only edit.
-#warning Waste...
- //if (kind == Undo::EDIT)
- // for (size_t i = 0, n = undo_pars.size(); i < n; ++i)
- // undo_pars[i]->clearContents();
-
- undo_finished = false;
+ finishUndo();
+ return true;
}
// Returns false if no undo possible.
bool textUndoOrRedo(BufferView * bv,
limited_stack<Undo> & stack,
- limited_stack<Undo> & /*otherstack*/)
+ limited_stack<Undo> & otherstack)
{
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;
}
stack.pop();
finishUndo();
-/*
if (!undo_frozen) {
+ otherstack.push(undo);
+ otherstack.top().pars.clear();
Buffer * buf = bv->buffer();
- ParIterator p = buf->getParFromID(undo->number_of_before_par);
- ParIterator const end = buf->par_iterator_end();
- bool ok = false;
- ParagraphList::iterator first;
- // default constructed?
- if (p != end) {
- first = p.par();
- if (first->next())
- first = first->next();
- } else {
- // Set first 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.
- first = bv->text->ownerParagraphs()->begin();
- Inset * inset = bv->buffer()->getInsetFromID(inset_id);
- if (inset) {
- ParagraphList * result = inset->getParagraphs(0);
- if (result && !result->empty())
- first = result->begin();
- }
- }
- if (ok) {
- ParIterator behind = buf->getParFromID(undo.number_of_behind_par);
- createUndo(bv, undo.kind, first, behind.par(), otherstack);
+ 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);
+ bool const ret = performUndoOrRedo(bv, undo);
unFreezeUndo();
return ret;
}
} // 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.
}
+void finishUndo()
+{
+ // Makes sure the next operation will be stored.
+ undo_finished = true;
+}
+
+
bool textUndo(BufferView * bv)
{
return textUndoOrRedo(bv, bv->buffer()->undostack,
}
-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)
{
if (!undo_frozen) {
- createUndo(bv, kind, first->id(), last->id(), bv->buffer()->undostack);
+ 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());
+}
+