dlls/riched20/undo.c

   1 /*
   2  * RichEdit - functions dealing with editor object
   3  *
   4  * Copyright 2004 by Krzysztof Foltman
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include "editor.h"
  22
  23 WINE_DEFAULT_DEBUG_CHANNEL(richedit);
  24
  25 void ME_EmptyUndoStack(ME_TextEditor *editor)
  26 {
  27   ME_DisplayItem *p, *pNext;
  28
  29   if (editor->nUndoMode == umIgnore)
  30     return;
  31
  32   TRACE("Emptying undo stack\n");
  33
  34   p = editor->pUndoStack;
  35   editor->pUndoStack = editor->pUndoStackBottom = NULL;
  36   editor->nUndoStackSize = 0;
  37   while(p) {
  38     pNext = p->next;
  39     ME_DestroyDisplayItem(p);
  40     p = pNext;
  41   }
  42   p = editor->pRedoStack;
  43   editor->pRedoStack = NULL;
  44   while(p) {
  45     pNext = p->next;
  46     ME_DestroyDisplayItem(p);
  47     p = pNext;
  48   }
  49 }
  50
  51 ME_UndoItem *ME_AddUndoItem(ME_TextEditor *editor, ME_DIType type, const ME_DisplayItem *pdi) {
  52   if (editor->nUndoMode == umIgnore)
  53     return NULL;
  54   else if (editor->nUndoLimit == 0)
  55     return NULL;
  56   else
  57   {
  58     ME_DisplayItem *pItem = (ME_DisplayItem *)ALLOC_OBJ(ME_UndoItem);
  59     switch(type)
  60     {
  61     case diUndoEndTransaction:
  62       break;
  63     case diUndoSetParagraphFormat:
  64       assert(pdi);
  65       CopyMemory(&pItem->member.para, &pdi->member.para, sizeof(ME_Paragraph));
  66       pItem->member.para.pFmt = ALLOC_OBJ(PARAFORMAT2);
  67       CopyMemory(pItem->member.para.pFmt, pdi->member.para.pFmt, sizeof(PARAFORMAT2));
  68       break;
  69     case diUndoInsertRun:
  70       assert(pdi);
  71       CopyMemory(&pItem->member.run, &pdi->member.run, sizeof(ME_Run));
  72       pItem->member.run.strText = ME_StrDup(pItem->member.run.strText);
  73       ME_AddRefStyle(pItem->member.run.style);
  74       break;
  75     case diUndoSetCharFormat:
  76     case diUndoSetDefaultCharFormat:
  77       break;
  78     case diUndoDeleteRun:
  79     case diUndoJoinParagraphs:
  80       break;
  81     case diUndoSplitParagraph:
  82       pItem->member.para.pFmt = ALLOC_OBJ(PARAFORMAT2);
  83       pItem->member.para.pFmt->cbSize = sizeof(PARAFORMAT2);
  84       pItem->member.para.pFmt->dwMask = 0;
  85
  86       break;
  87     default:
  88       assert(0 == "AddUndoItem, unsupported item type");
  89       return NULL;
  90     }
  91     pItem->type = type;
  92     pItem->prev = NULL;
  93     if (editor->nUndoMode == umAddToUndo || editor->nUndoMode == umAddBackToUndo)
  94     {
  95       if (editor->nUndoMode == umAddToUndo)
  96         TRACE("Pushing id=%s to undo stack, deleting redo stack\n", ME_GetDITypeName(type));
  97       else
  98         TRACE("Pushing id=%s to undo stack\n", ME_GetDITypeName(type));
  99
 100       pItem->next = editor->pUndoStack;
 101       if (type == diUndoEndTransaction)
 102         editor->nUndoStackSize++;
 103       if (editor->pUndoStack)
 104         editor->pUndoStack->prev = pItem;
 105       else
 106         editor->pUndoStackBottom = pItem;
 107       editor->pUndoStack = pItem;
 108
 109       if (editor->nUndoStackSize > editor->nUndoLimit)
 110       { /* remove oldest undo from stack */
 111         ME_DisplayItem *p = editor->pUndoStackBottom;
 112         while (p->type !=diUndoEndTransaction)
 113           p = p->prev; /*find new stack bottom */
 114         editor->pUndoStackBottom = p->prev;
 115           editor->pUndoStackBottom->next = NULL;
 116         do
 117         {
 118           ME_DisplayItem *pp = p->next;
 119           ME_DestroyDisplayItem(p);
 120           p = pp;
 121         } while (p);
 122         editor->nUndoStackSize--;
 123       }
 124       /* any new operation (not redo) clears the redo stack */
 125       if (editor->nUndoMode == umAddToUndo) {
 126         ME_DisplayItem *p = editor->pRedoStack;
 127         while(p)
 128         {
 129           ME_DisplayItem *pp = p->next;
 130           ME_DestroyDisplayItem(p);
 131           p = pp;
 132         }
 133         editor->pRedoStack = NULL;
 134       }
 135     }
 136     else if (editor->nUndoMode == umAddToRedo)
 137     {
 138       TRACE("Pushing id=%s to redo stack\n", ME_GetDITypeName(type));
 139       pItem->next = editor->pRedoStack;
 140       if (editor->pRedoStack)
 141         editor->pRedoStack->prev = pItem;
 142       editor->pRedoStack = pItem;
 143     }
 144     else
 145       assert(0);
 146     return (ME_UndoItem *)pItem;
 147   }
 148 }
 149
 150 void ME_CommitUndo(ME_TextEditor *editor) {
 151   if (editor->nUndoMode == umIgnore)
 152     return;
 153
 154   assert(editor->nUndoMode == umAddToUndo);
 155
 156   /* no transactions, no need to commit */
 157   if (!editor->pUndoStack)
 158     return;
 159
 160   /* no need to commit empty transactions */
 161   if (editor->pUndoStack->type == diUndoEndTransaction)
 162     return;
 163
 164   ME_AddUndoItem(editor, diUndoEndTransaction, NULL);
 165   ME_SendSelChange(editor);
 166 }
 167
 168 static void ME_PlayUndoItem(ME_TextEditor *editor, ME_DisplayItem *pItem)
 169 {
 170   ME_UndoItem *pUItem = (ME_UndoItem *)pItem;
 171
 172   if (editor->nUndoMode == umIgnore)
 173     return;
 174   TRACE("Playing undo/redo item, id=%s\n", ME_GetDITypeName(pItem->type));
 175
 176   switch(pItem->type)
 177   {
 178   case diUndoEndTransaction:
 179     assert(0);
 180   case diUndoSetParagraphFormat:
 181   {
 182     ME_Cursor tmp;
 183     ME_CursorFromCharOfs(editor, pItem->member.para.nCharOfs, &tmp);
 184     ME_SetParaFormat(editor, ME_FindItemBack(tmp.pRun, diParagraph), pItem->member.para.pFmt);
 185     break;
 186   }
 187   case diUndoSetCharFormat:
 188   {
 189     ME_SetCharFormat(editor, pUItem->nStart, pUItem->nLen, &pItem->member.ustyle->fmt);
 190     break;
 191   }
 192   case diUndoSetDefaultCharFormat:
 193   {
 194     ME_SetDefaultCharFormat(editor, &pItem->member.ustyle->fmt);
 195     break;
 196   }
 197   case diUndoInsertRun:
 198   {
 199     ME_InsertRun(editor, pItem->member.run.nCharOfs, pItem);
 200     break;
 201   }
 202   case diUndoDeleteRun:
 203   {
 204     ME_InternalDeleteText(editor, pUItem->nStart, pUItem->nLen);
 205     break;
 206   }
 207   case diUndoJoinParagraphs:
 208   {
 209     ME_Cursor tmp;
 210     ME_CursorFromCharOfs(editor, pUItem->nStart, &tmp);
 211     /* the only thing that's needed is paragraph offset, so no need to split runs */
 212     ME_JoinParagraphs(editor, ME_GetParagraph(tmp.pRun));
 213     break;
 214   }
 215   case diUndoSplitParagraph:
 216   {
 217     ME_Cursor tmp;
 218     ME_DisplayItem *new_para;
 219     ME_CursorFromCharOfs(editor, pUItem->nStart, &tmp);
 220     if (tmp.nOffset)
 221       tmp.pRun = ME_SplitRunSimple(editor, tmp.pRun, tmp.nOffset);
 222     new_para = ME_SplitParagraph(editor, tmp.pRun, tmp.pRun->member.run.style);
 223     assert(pItem->member.para.pFmt->cbSize == sizeof(PARAFORMAT2));
 224     CopyMemory(new_para->member.para.pFmt, pItem->member.para.pFmt, sizeof(PARAFORMAT2));
 225     break;
 226   }
 227   default:
 228     assert(0 == "PlayUndoItem, unexpected type");
 229   }
 230 }
 231
 232 void ME_Undo(ME_TextEditor *editor) {
 233   ME_DisplayItem *p;
 234   ME_UndoMode nMode = editor->nUndoMode;
 235
 236   if (editor->nUndoMode == umIgnore)
 237     return;
 238   assert(nMode == umAddToUndo || nMode == umIgnore);
 239
 240   /* no undo items ? */
 241   if (!editor->pUndoStack)
 242     return;
 243
 244   /* watch out for uncommited transactions ! */
 245   assert(editor->pUndoStack->type == diUndoEndTransaction);
 246
 247   editor->nUndoMode = umAddToRedo;
 248   p = editor->pUndoStack->next;
 249   ME_DestroyDisplayItem(editor->pUndoStack);
 250   do {
 251     ME_DisplayItem *pp = p;
 252     ME_PlayUndoItem(editor, p);
 253     p = p->next;
 254     ME_DestroyDisplayItem(pp);
 255   } while(p && p->type != diUndoEndTransaction);
 256   ME_AddUndoItem(editor, diUndoEndTransaction, NULL);
 257   editor->pUndoStack = p;
 258   editor->nUndoStackSize--;
 259   if (p)
 260     p->prev = NULL;
 261   editor->nUndoMode = nMode;
 262   ME_UpdateRepaint(editor);
 263 }
 264
 265 void ME_Redo(ME_TextEditor *editor) {
 266   ME_DisplayItem *p;
 267   ME_UndoMode nMode = editor->nUndoMode;
 268
 269   assert(nMode == umAddToUndo || nMode == umIgnore);
 270
 271   if (editor->nUndoMode == umIgnore)
 272     return;
 273   /* no redo items ? */
 274   if (!editor->pRedoStack)
 275     return;
 276
 277   /* watch out for uncommited transactions ! */
 278   assert(editor->pRedoStack->type == diUndoEndTransaction);
 279
 280   editor->nUndoMode = umAddBackToUndo;
 281   p = editor->pRedoStack->next;
 282   ME_DestroyDisplayItem(editor->pRedoStack);
 283   do {
 284     ME_DisplayItem *pp = p;
 285     ME_PlayUndoItem(editor, p);
 286     p = p->next;
 287     ME_DestroyDisplayItem(pp);
 288   } while(p && p->type != diUndoEndTransaction);
 289   ME_AddUndoItem(editor, diUndoEndTransaction, NULL);
 290   editor->pRedoStack = p;
 291   if (p)
 292     p->prev = NULL;
 293   editor->nUndoMode = nMode;
 294   ME_UpdateRepaint(editor);
 295 }