src/undo_funcs.C

   1 /* This file is part of
   2  * ======================================================
   3  *
   4  *           LyX, The Document Processor
   5  *
   6  *           Copyright 1995-2001 The LyX Team.
   7  *
   8  * ====================================================== */
   9
  10 #include <config.h>
  11
  12 #ifdef __GNUG__
  13 #pragma implementation
  14 #endif
  15
  16 #include "undo_funcs.h"
  17 #include "lyxtext.h"
  18 #include "BufferView.h"
  19 #include "buffer.h"
  20 #include "insets/inset.h"
  21 #include "debug.h"
  22 #include "support/LAssert.h"
  23
  24 /// the flag used by FinishUndo();
  25 bool undo_finished;
  26 /// a flag
  27 bool undo_frozen;
  28
  29 bool textUndo(BufferView * bv)
  30 {
  31         // returns false if no undo possible
  32         Undo * undo = bv->buffer()->undostack.pop();
  33         if (undo) {
  34                 finishUndo();
  35                 if (!undo_frozen) {
  36                         Paragraph * first = bv->buffer()->getParFromID(undo->number_of_before_par);
  37                         if (!first)
  38                                 first = firstUndoParagraph(bv, undo->number_of_inset_id);
  39                         if (first) {
  40                                 bv->buffer()->redostack.push(
  41                                         createUndo(bv, undo->kind, first,
  42                                                            bv->buffer()->getParFromID(undo->number_of_behind_par)));
  43                         }
  44                 }
  45         }
  46         return textHandleUndo(bv, undo);
  47 }
  48
  49
  50 bool textRedo(BufferView * bv)
  51 {
  52         // returns false if no redo possible
  53         Undo * undo = bv->buffer()->redostack.pop();
  54         if (undo) {
  55                 finishUndo();
  56                 if (!undo_frozen) {
  57                         Paragraph * first = bv->buffer()->getParFromID(undo->number_of_before_par);
  58                         if (!first)
  59                                 first = firstUndoParagraph(bv, undo->number_of_inset_id);
  60                         if (first) {
  61                                 bv->buffer()->undostack.push(
  62                                         createUndo(bv, undo->kind, first,
  63                                                    bv->buffer()->getParFromID(undo->number_of_behind_par)));
  64                         }
  65                 }
  66         }
  67         return textHandleUndo(bv, undo);
  68 }
  69
  70
  71 bool textHandleUndo(BufferView * bv, Undo * undo)
  72 {
  73         // returns false if no undo possible
  74         bool result = false;
  75         if (undo) {
  76                 Paragraph * before =
  77                         bv->buffer()->getParFromID(undo->number_of_before_par);
  78                 Paragraph * behind =
  79                         bv->buffer()->getParFromID(undo->number_of_behind_par);
  80                 Paragraph * tmppar;
  81                 Paragraph * tmppar2;
  82                 Paragraph * endpar;
  83                 Paragraph * tmppar5;
  84
  85                 // if there's no before take the beginning
  86                 // of the document for redoing
  87                 if (!before) {
  88                         LyXText * t = bv->text;
  89                         int num = undo->number_of_inset_id;
  90                         if (undo->number_of_inset_id >= 0) {
  91                                 Inset * in = bv->buffer()->getInsetFromID(num);
  92                                 if (in) {
  93                                         t = in->getLyXText(bv);
  94                                 } else {
  95                                         num = -1;
  96                                 }
  97                         }
  98                         t->setCursorIntern(bv, firstUndoParagraph(bv, num), 0);
  99                 }
 100
 101                 // replace the paragraphs with the undo informations
 102
 103                 Paragraph * tmppar3 = undo->par;
 104                 undo->par = 0; // otherwise the undo destructor would delete the paragraph
 105                 Paragraph * tmppar4 = tmppar3;
 106
 107                 if (tmppar4) {
 108                         while (tmppar4->next())
 109                                 tmppar4 = tmppar4->next();
 110                 } // get last undo par
 111
 112                 // now remove the old text if there is any
 113                 if (before != behind || (!behind && !before)) {
 114                         if (before)
 115                                 tmppar5 = before->next();
 116                         else
 117                                 tmppar5 = firstUndoParagraph(bv, undo->number_of_inset_id);
 118                         tmppar2 = tmppar3;
 119                         while (tmppar5 && tmppar5 != behind) {
 120                                 tmppar = tmppar5;
 121                                 tmppar5 = tmppar5->next();
 122                                 // a memory optimization for edit: Only layout information
 123                                 // is stored in the undo. So restore the text informations.
 124                                 if (undo->kind == Undo::EDIT) {
 125                                         tmppar2->setContentsFromPar(tmppar);
 126                                         tmppar->clearContents();
 127                                         tmppar2 = tmppar2->next();
 128                                 }
 129                         }
 130                 }
 131
 132                 // put the new stuff in the list if there is one
 133                 if (tmppar3){
 134                         if (before)
 135                                 before->next(tmppar3);
 136                         else
 137                                 bv->text->ownerParagraph(tmppar3->id(), tmppar3);
 138                         tmppar3->previous(before);
 139                 } else {
 140                         // Do we really enter here ??? (Jug)
 141                         if (!before)
 142                                 bv->text->ownerParagraph(behind);
 143                 }
 144                 if (tmppar4) {
 145                         tmppar4->next(behind);
 146                         if (behind)
 147                                 behind->previous(tmppar4);
 148                 }
 149
 150
 151                 // Set the cursor for redoing
 152                 if (before) {
 153                         bv->text->setCursorIntern(bv, before, 0);
 154                 }
 155
 156                 // calculate the endpar for redoing the paragraphs.
 157                 if (behind) {
 158                                 endpar = behind->next();
 159                 } else
 160                         endpar = behind;
 161
 162                 tmppar = bv->buffer()->getParFromID(undo->number_of_cursor_par);
 163                 UpdatableInset* it = static_cast<UpdatableInset*>(tmppar3->inInset());
 164                 if (it) {
 165                         it->getLyXText(bv)->redoParagraphs(bv, it->getLyXText(bv)->cursor,
 166                                                            endpar);
 167                         if (tmppar){
 168                                 it->getLyXText(bv)->setCursorIntern(bv, tmppar, undo->cursor_pos);
 169                                 it->getLyXText(bv)->updateCounters(bv, it->getLyXText(bv)->cursor.row());
 170                         }
 171                         LyXFont font;
 172                         it->update(bv, font, false);
 173 #ifdef THIS_DOES_NOT_WORK
 174                         // we need this anyway as also if the undo was inside an inset
 175                         // we have to redo the paragraph breaking
 176                         bv->text->redoParagraphs(bv, bv->text->cursor,
 177                                                                          bv->text->cursor.par());
 178 #endif
 179                 } else {
 180                         bv->text->redoParagraphs(bv, bv->text->cursor, endpar);
 181                         if (tmppar) {
 182                                 bv->text->setCursorIntern(bv, tmppar, undo->cursor_pos);
 183                                 bv->text->updateCounters(bv, bv->text->cursor.row());
 184                         }
 185                 }
 186                 result = true;
 187                 delete undo;
 188         }
 189         finishUndo();
 190         bv->text->status(bv, LyXText::NEED_MORE_REFRESH);
 191         return result;
 192 }
 193
 194
 195 void finishUndo()
 196 {
 197         // makes sure the next operation will be stored
 198         undo_finished = true;
 199 }
 200
 201
 202 void freezeUndo()
 203 {
 204         // this is dangerous and for internal use only
 205         undo_frozen = true;
 206 }
 207
 208
 209 void unFreezeUndo()
 210 {
 211         // this is dangerous and for internal use only
 212         undo_frozen = false;
 213 }
 214
 215
 216 void setUndo(BufferView * bv, Undo::undo_kind kind,
 217              Paragraph const * first, Paragraph const * behind)
 218 {
 219         if (!undo_frozen)
 220                 bv->buffer()->undostack.push(createUndo(bv, kind, first, behind));
 221         bv->buffer()->redostack.clear();
 222 }
 223
 224
 225 void setRedo(BufferView * bv, Undo::undo_kind kind,
 226              Paragraph const * first, Paragraph const * behind)
 227 {
 228         bv->buffer()->redostack.push(createUndo(bv, kind, first, behind));
 229 }
 230
 231 using lyx::pos_type;
 232
 233 Undo * createUndo(BufferView * bv, Undo::undo_kind kind,
 234                   Paragraph const * first, Paragraph const * behind)
 235 {
 236         lyx::Assert(first);
 237
 238         int before_number = -1;
 239         int behind_number = -1;
 240         int inset_id = -1;
 241
 242         if (first->previous())
 243                 before_number = first->previous()->id();
 244         if (behind)
 245                 behind_number = behind->id();
 246         if (first->inInset())
 247                 inset_id = first->inInset()->id();
 248
 249         // Undo::EDIT  and Undo::FINISH are
 250         // always finished. (no overlapping there)
 251         // overlapping only with insert and delete inside one paragraph:
 252         // Nobody wants all removed  character
 253         // appear one by one when undoing.
 254         // EDIT is special since only layout information, not the
 255         // contents of a paragaph are stored.
 256         if (!undo_finished && (kind != Undo::EDIT) && (kind != Undo::FINISH)){
 257                 // check wether storing is needed
 258                 if (!bv->buffer()->undostack.empty() &&
 259                     bv->buffer()->undostack.top()->kind == kind &&
 260                     bv->buffer()->undostack.top()->number_of_before_par ==  before_number &&
 261                     bv->buffer()->undostack.top()->number_of_behind_par ==  behind_number ){
 262                         // no undo needed
 263                         return 0;
 264                 }
 265         }
 266         // create a new Undo
 267         Paragraph * undopar;
 268
 269         Paragraph * start = const_cast<Paragraph *>(first);
 270         Paragraph * end = 0;
 271
 272         if (behind)
 273                 end = const_cast<Paragraph*>(behind->previous());
 274         else {
 275                 end = start;
 276                 while (end->next())
 277                         end = end->next();
 278         }
 279         if (start && end && (start != end->next()) &&
 280             ((before_number != behind_number) ||
 281                  ((before_number < 0) && (behind_number < 0)))) {
 282                 Paragraph * tmppar = start;
 283                 Paragraph * tmppar2 = new Paragraph(*tmppar, true);
 284                 tmppar2->id(tmppar->id());
 285
 286                 // a memory optimization: Just store the layout information
 287                 // when only edit
 288                 if (kind == Undo::EDIT) {
 289                         tmppar2->clearContents();
 290                 }
 291
 292                 undopar = tmppar2;
 293
 294                 while (tmppar != end && tmppar->next()) {
 295                         tmppar = tmppar->next();
 296                         tmppar2->next(new Paragraph(*tmppar, false));
 297                         tmppar2->next()->id(tmppar->id());
 298                         // a memory optimization: Just store the layout
 299                         // information when only edit
 300                         if (kind == Undo::EDIT) {
 301                                 tmppar2->clearContents();
 302                         }
 303                         tmppar2->next()->previous(tmppar2);
 304                         tmppar2 = tmppar2->next();
 305                 }
 306                 tmppar2->next(0);
 307         } else
 308                 undopar = 0; // nothing to replace (undo of delete maybe)
 309
 310         int cursor_par = undoCursor(bv).par()->id();
 311         int cursor_pos =  undoCursor(bv).pos();
 312
 313         Undo * undo = new Undo(kind, inset_id,
 314                                before_number, behind_number,
 315                                cursor_par, cursor_pos, undopar);
 316
 317         undo_finished = false;
 318         return undo;
 319 }
 320
 321
 322 void setCursorParUndo(BufferView * bv)
 323 {
 324         setUndo(bv, Undo::FINISH,
 325                 bv->text->cursor.par(),
 326                         bv->text->cursor.par()->next());
 327 }
 328
 329 Paragraph * firstUndoParagraph(BufferView * bv, int inset_id)
 330 {
 331         Inset * inset = bv->buffer()->getInsetFromID(inset_id);
 332         if (inset) {
 333                 Paragraph * result = inset->firstParagraph();
 334                 if (result)
 335                         return result;
 336         }
 337         return bv->text->ownerParagraph();
 338 }
 339
 340 LyXCursor const & undoCursor(BufferView * bv)
 341 {
 342         if (bv->theLockingInset())
 343                 return bv->theLockingInset()->cursor(bv);
 344         return bv->text->cursor;
 345 }