2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2001 Hiroyuki Yamamoto
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 /* code ported from gedit */
21 /* This is for my patient girlfirend Regina */
29 #include <string.h> /* for strlen */
30 #include <stdlib.h> /* for mbstowcs */
34 #include "prefs_common.h"
36 typedef struct _UndoInfo UndoInfo;
44 gfloat window_position;
48 static void undo_free_list (GList **list_pointer);
49 static void undo_check_size (UndoMain *undostruct);
50 static gint undo_merge (GList *list,
55 static void undo_add (const gchar *text,
59 UndoMain *undostruct);
60 static gint undo_get_selection (GtkTextView *textview,
63 static void undo_insert_text_cb (GtkTextBuffer *textbuf,
67 UndoMain *undostruct);
68 static void undo_delete_text_cb (GtkTextBuffer *textbuf,
71 UndoMain *undostruct);
73 static void undo_paste_clipboard_cb (GtkTextView *textview,
74 UndoMain *undostruct);
76 void undo_undo (UndoMain *undostruct);
77 void undo_redo (UndoMain *undostruct);
80 UndoMain *undo_init(GtkWidget *text)
83 GtkTextView *textview = GTK_TEXT_VIEW(text);
84 GtkTextBuffer *textbuf = gtk_text_view_get_buffer(textview);
86 g_return_val_if_fail(text != NULL, NULL);
88 undostruct = g_new(UndoMain, 1);
89 undostruct->textview = textview;
90 undostruct->undo = NULL;
91 undostruct->redo = NULL;
92 undostruct->paste = 0;
93 undostruct->undo_state = FALSE;
94 undostruct->redo_state = FALSE;
96 g_signal_connect(G_OBJECT(textbuf), "insert-text",
97 G_CALLBACK(undo_insert_text_cb), undostruct);
98 g_signal_connect(G_OBJECT(textbuf), "delete-range",
99 G_CALLBACK(undo_delete_text_cb), undostruct);
100 g_signal_connect(G_OBJECT(textview), "paste-clipboard",
101 G_CALLBACK(undo_paste_clipboard_cb), undostruct);
106 void undo_destroy (UndoMain *undostruct)
108 undo_free_list(&undostruct->undo);
109 undo_free_list(&undostruct->redo);
113 static UndoInfo *undo_object_new(gchar *text, gint start_pos, gint end_pos,
114 UndoAction action, gfloat window_position)
117 undoinfo = g_new (UndoInfo, 1);
118 undoinfo->text = text;
119 undoinfo->start_pos = start_pos;
120 undoinfo->end_pos = end_pos;
121 undoinfo->action = action;
122 undoinfo->window_position = window_position;
126 static void undo_object_free(UndoInfo *undo)
134 * @list_pointer: list to be freed
136 * frees and undo structure list
138 static void undo_free_list(GList **list_pointer)
141 GList *cur, *list = *list_pointer;
143 if (list == NULL) return;
145 for (cur = list; cur != NULL; cur = cur->next) {
146 undo = (UndoInfo *)cur->data;
147 undo_object_free(undo);
151 *list_pointer = NULL;
154 void undo_set_change_state_func(UndoMain *undostruct, UndoChangeStateFunc func,
157 g_return_if_fail(undostruct != NULL);
159 undostruct->change_state_func = func;
160 undostruct->change_state_data = data;
165 * @compose: document to check
167 * Checks that the size of compose->undo does not excede settings->undo_levels and
168 * frees any undo level above sett->undo_level.
171 static void undo_check_size(UndoMain *undostruct)
176 if (prefs_common.undolevels < 1) return;
178 /* No need to check for the redo list size since the undo
179 list gets freed on any call to compose_undo_add */
180 length = g_list_length(undostruct->undo);
181 if (length >= prefs_common.undolevels && prefs_common.undolevels > 0) {
182 last_undo = (UndoInfo *)g_list_last(undostruct->undo)->data;
183 undostruct->undo = g_list_remove(undostruct->undo, last_undo);
184 undo_object_free(last_undo);
195 * This function tries to merge the undo object at the top of
196 * the stack with a new set of data. So when we undo for example
197 * typing, we can undo the whole word and not each letter by itself
199 * Return Value: TRUE is merge was sucessful, FALSE otherwise
201 static gint undo_merge(GList *list, guint start_pos, guint end_pos,
202 gint action, const guchar *text)
207 /* This are the cases in which we will NOT merge :
208 1. if (last_undo->mergeable == FALSE)
209 [mergeable = FALSE when the size of the undo data was not 1.
210 or if the data was size = 1 but = '\n' or if the undo object
211 has been "undone" already ]
212 2. The size of text is not 1
213 3. If the new merging data is a '\n'
214 4. If the last char of the undo_last data is a space/tab
215 and the new char is not a space/tab ( so that we undo
216 words and not chars )
217 5. If the type (action) of undo is different from the last one
220 if (list == NULL) return FALSE;
222 last_undo = list->data;
224 if (!last_undo->mergeable) return FALSE;
226 if (end_pos - start_pos != 1 ||
228 action != last_undo->action ||
229 action == UNDO_ACTION_REPLACE_INSERT ||
230 action == UNDO_ACTION_REPLACE_DELETE) {
231 last_undo->mergeable = FALSE;
235 if (action == UNDO_ACTION_DELETE) {
236 gboolean checkit = TRUE;
238 if (last_undo->start_pos != end_pos &&
239 last_undo->start_pos != start_pos) {
240 last_undo->mergeable = FALSE;
242 } else if (last_undo->start_pos == start_pos) {
243 /* Deleted with the delete key */
244 if (text[0] != ' ' && text[0] != '\t' &&
245 (last_undo->text[last_undo->end_pos - last_undo->start_pos - 1] == ' ' ||
246 last_undo->text[last_undo->end_pos - last_undo->start_pos - 1] == '\t'))
249 temp_string = g_strdup_printf("%s%s", last_undo->text, text);
250 last_undo->end_pos++;
251 g_free(last_undo->text);
252 last_undo->text = temp_string;
254 /* Deleted with the backspace key */
255 if (text[0] != ' ' && text[0] != '\t' &&
256 (last_undo->text[0] == ' ' ||
257 last_undo->text[0] == '\t'))
260 temp_string = g_strdup_printf("%s%s", text, last_undo->text);
261 last_undo->start_pos = start_pos;
262 g_free(last_undo->text);
263 last_undo->text = temp_string;
267 last_undo->mergeable = FALSE;
270 } else if (action == UNDO_ACTION_INSERT) {
271 if (last_undo->end_pos != start_pos) {
272 last_undo->mergeable = FALSE;
275 temp_string = g_strdup_printf("%s%s", last_undo->text, text);
276 g_free(last_undo->text);
277 last_undo->end_pos = end_pos;
278 last_undo->text = temp_string;
281 debug_print("Unknown action [%i] inside undo merge encountered", action);
291 * @action: either UNDO_ACTION_INSERT or UNDO_ACTION_DELETE
293 * @view: The view so that we save the scroll bar position.
295 * Adds text to the undo stack. It also performs test to limit the number
296 * of undo levels and deltes the redo list
299 static void undo_add(const gchar *text,
300 gint start_pos, gint end_pos,
301 UndoAction action, UndoMain *undostruct)
306 g_return_if_fail(text != NULL);
307 g_return_if_fail(end_pos >= start_pos);
309 undo_free_list(&undostruct->redo);
311 /* Set the redo sensitivity */
312 undostruct->change_state_func(undostruct,
313 UNDO_STATE_UNCHANGED, UNDO_STATE_FALSE,
314 undostruct->change_state_data);
316 if (undostruct->paste != 0) {
317 if (action == UNDO_ACTION_INSERT)
318 action = UNDO_ACTION_REPLACE_INSERT;
320 action = UNDO_ACTION_REPLACE_DELETE;
321 undostruct->paste = undostruct->paste + 1;
322 if (undostruct->paste == 3)
323 undostruct->paste = 0;
326 if (undo_merge(undostruct->undo, start_pos, end_pos, action, text))
329 undo_check_size(undostruct);
331 vadj = GTK_ADJUSTMENT(GTK_TEXT_VIEW(undostruct->textview)->vadjustment);
332 undoinfo = undo_object_new(g_strdup(text), start_pos, end_pos, action,
335 if (end_pos - start_pos != 1 || text[0] == '\n')
336 undoinfo->mergeable = FALSE;
338 undoinfo->mergeable = TRUE;
340 undostruct->undo = g_list_prepend(undostruct->undo, undoinfo);
342 undostruct->change_state_func(undostruct,
343 UNDO_STATE_TRUE, UNDO_STATE_UNCHANGED,
344 undostruct->change_state_data);
352 * Executes an undo request on the current document
354 void undo_undo(UndoMain *undostruct)
357 GtkTextView *textview;
358 GtkTextBuffer *buffer;
359 GtkTextIter iter, start_iter, end_iter;
362 g_return_if_fail(undostruct != NULL);
364 if (undostruct->undo == NULL) return;
366 /* The undo data we need is always at the top op the
367 stack. So, therefore, the first one */
368 undoinfo = (UndoInfo *)undostruct->undo->data;
369 g_return_if_fail(undoinfo != NULL);
370 undoinfo->mergeable = FALSE;
371 undostruct->redo = g_list_prepend(undostruct->redo, undoinfo);
372 undostruct->undo = g_list_remove(undostruct->undo, undoinfo);
374 textview = undostruct->textview;
375 buffer = gtk_text_view_get_buffer(textview);
377 undo_block(undostruct);
379 /* Check if there is a selection active */
380 mark = gtk_text_buffer_get_insert(buffer);
381 gtk_text_buffer_get_iter_at_mark(buffer, &iter, mark);
382 gtk_text_buffer_place_cursor(buffer, &iter);
384 /* Move the view (scrollbars) to the correct position */
385 gtk_adjustment_set_value
386 (GTK_ADJUSTMENT(textview->vadjustment),
387 undoinfo->window_position);
389 switch (undoinfo->action) {
390 case UNDO_ACTION_DELETE:
391 gtk_text_buffer_get_iter_at_offset(buffer, &iter, undoinfo->start_pos);
392 gtk_text_buffer_insert(buffer, &iter, undoinfo->text, -1);
394 case UNDO_ACTION_INSERT:
395 gtk_text_buffer_get_iter_at_offset(buffer, &start_iter, undoinfo->start_pos);
396 gtk_text_buffer_get_iter_at_offset(buffer, &end_iter, undoinfo->end_pos);
397 gtk_text_buffer_delete(buffer, &start_iter, &end_iter);
399 case UNDO_ACTION_REPLACE_INSERT:
400 gtk_text_buffer_get_iter_at_offset(buffer, &start_iter, undoinfo->start_pos);
401 gtk_text_buffer_get_iter_at_offset(buffer, &end_iter, undoinfo->end_pos);
402 gtk_text_buffer_delete(buffer, &start_iter, &end_iter);
403 /* "pull" another data structure from the list */
404 undoinfo = (UndoInfo *)undostruct->undo->data;
405 g_return_if_fail(undoinfo != NULL);
406 undostruct->redo = g_list_prepend(undostruct->redo, undoinfo);
407 undostruct->undo = g_list_remove(undostruct->undo, undoinfo);
408 g_return_if_fail(undoinfo->action == UNDO_ACTION_REPLACE_DELETE);
409 gtk_text_buffer_insert(buffer, &start_iter, undoinfo->text, -1);
411 case UNDO_ACTION_REPLACE_DELETE:
412 g_warning("This should not happen. UNDO_REPLACE_DELETE");
415 g_assert_not_reached();
419 undostruct->change_state_func(undostruct,
420 UNDO_STATE_UNCHANGED, UNDO_STATE_TRUE,
421 undostruct->change_state_data);
423 if (undostruct->undo == NULL)
424 undostruct->change_state_func(undostruct,
426 UNDO_STATE_UNCHANGED,
427 undostruct->change_state_data);
429 undo_unblock(undostruct);
437 * executes a redo request on the current document
439 void undo_redo(UndoMain *undostruct)
442 GtkTextView *textview;
443 GtkTextBuffer *buffer;
444 GtkTextIter iter, start_iter, end_iter;
447 g_return_if_fail(undostruct != NULL);
449 if (undostruct->redo == NULL) return;
451 redoinfo = (UndoInfo *)undostruct->redo->data;
452 g_return_if_fail (redoinfo != NULL);
453 undostruct->undo = g_list_prepend(undostruct->undo, redoinfo);
454 undostruct->redo = g_list_remove(undostruct->redo, redoinfo);
456 textview = undostruct->textview;
457 buffer = gtk_text_view_get_buffer(textview);
459 undo_block(undostruct);
461 /* Check if there is a selection active */
462 mark = gtk_text_buffer_get_insert(buffer);
463 gtk_text_buffer_get_iter_at_mark(buffer, &iter, mark);
464 gtk_text_buffer_place_cursor(buffer, &iter);
466 /* Move the view to the right position. */
467 gtk_adjustment_set_value(textview->vadjustment,
468 redoinfo->window_position);
470 switch (redoinfo->action) {
471 case UNDO_ACTION_INSERT:
472 gtk_text_buffer_get_iter_at_offset(buffer, &iter, redoinfo->start_pos);
473 gtk_text_buffer_insert(buffer, &iter, redoinfo->text, -1);
475 case UNDO_ACTION_DELETE:
476 gtk_text_buffer_get_iter_at_offset(buffer, &start_iter, redoinfo->start_pos);
477 gtk_text_buffer_get_iter_at_offset(buffer, &end_iter, redoinfo->end_pos);
478 gtk_text_buffer_delete(buffer, &start_iter, &end_iter);
480 case UNDO_ACTION_REPLACE_DELETE:
481 gtk_text_buffer_get_iter_at_offset(buffer, &start_iter, redoinfo->start_pos);
482 gtk_text_buffer_get_iter_at_offset(buffer, &end_iter, redoinfo->end_pos);
483 gtk_text_buffer_delete(buffer, &start_iter, &end_iter);
484 debug_print("UNDO_ACTION_REPLACE %s\n", redoinfo->text);
485 /* "pull" another data structure from the list */
486 redoinfo = (UndoInfo *)undostruct->redo->data;
487 g_return_if_fail(redoinfo != NULL);
488 undostruct->undo = g_list_prepend(undostruct->redo, redoinfo);
489 undostruct->redo = g_list_remove(undostruct->undo, redoinfo);
490 g_return_if_fail(redoinfo->action == UNDO_ACTION_REPLACE_DELETE);
491 gtk_text_buffer_insert(buffer, &start_iter, redoinfo->text, -1);
493 case UNDO_ACTION_REPLACE_INSERT:
494 g_warning("This should not happen. Redo: UNDO_REPLACE_INSERT");
497 g_assert_not_reached();
501 undostruct->change_state_func(undostruct,
502 UNDO_STATE_TRUE, UNDO_STATE_UNCHANGED,
503 undostruct->change_state_data);
505 if (undostruct->redo == NULL)
506 undostruct->change_state_func(undostruct,
507 UNDO_STATE_UNCHANGED,
509 undostruct->change_state_data);
511 undo_unblock(undostruct);
514 void undo_block(UndoMain *undostruct)
516 GtkTextBuffer *buffer;
518 g_return_if_fail(GTK_IS_TEXT_VIEW(undostruct->textview));
520 buffer = gtk_text_view_get_buffer(undostruct->textview);
521 g_signal_handlers_block_by_func(buffer, undo_insert_text_cb, undostruct);
522 g_signal_handlers_block_by_func(buffer, undo_delete_text_cb, undostruct);
523 g_signal_handlers_block_by_func(buffer, undo_paste_clipboard_cb,
527 void undo_unblock(UndoMain *undostruct)
529 GtkTextBuffer *buffer;
531 g_return_if_fail(GTK_IS_TEXT_VIEW(undostruct->textview));
533 buffer = gtk_text_view_get_buffer(undostruct->textview);
534 g_signal_handlers_unblock_by_func(buffer, undo_insert_text_cb, undostruct);
535 g_signal_handlers_unblock_by_func(buffer, undo_delete_text_cb, undostruct);
536 g_signal_handlers_unblock_by_func(buffer, undo_paste_clipboard_cb,
540 void undo_insert_text_cb(GtkTextBuffer *textbuf, GtkTextIter *iter,
541 gchar *new_text, gint new_text_length,
542 UndoMain *undostruct)
544 gchar *text_to_insert;
547 if (prefs_common.undolevels <= 0) return;
549 pos = gtk_text_iter_get_offset(iter);
551 Xstrndup_a(text_to_insert, new_text, new_text_length, return);
552 undo_add(text_to_insert, pos, pos + g_utf8_strlen(text_to_insert, -1),
553 UNDO_ACTION_INSERT, undostruct);
556 void undo_delete_text_cb(GtkTextBuffer *textbuf, GtkTextIter *start,
557 GtkTextIter *end, UndoMain *undostruct)
559 gchar *text_to_delete;
560 gint start_pos, end_pos;
562 if (prefs_common.undolevels <= 0) return;
564 text_to_delete = gtk_text_buffer_get_text(textbuf, start, end, FALSE);
565 if (!text_to_delete || !*text_to_delete) return;
567 start_pos = gtk_text_iter_get_offset(start);
568 end_pos = gtk_text_iter_get_offset(end);
570 undo_add(text_to_delete, start_pos, end_pos, UNDO_ACTION_DELETE,
572 g_free(text_to_delete);
575 void undo_paste_clipboard_cb(GtkTextView *textview, UndoMain *undostruct)
577 #warning GTK2 check clipboard content
579 if (editable->clipboard_text == NULL) return;
582 if (prefs_common.undolevels > 0)
583 if (undo_get_selection(textview, NULL, NULL))
584 undostruct->paste = TRUE;
588 * undo_get_selection:
589 * @text: Text to get the selection from
590 * @start: return here the start position of the selection
591 * @end: return here the end position of the selection
593 * Gets the current selection for View
595 * Return Value: TRUE if there is a selection active, FALSE if not
597 static gint undo_get_selection(GtkTextView *textview, guint *start, guint *end)
599 GtkTextBuffer *buffer;
600 GtkTextIter start_iter, end_iter;
601 guint start_pos, end_pos;
603 buffer = gtk_text_view_get_buffer(textview);
604 gtk_text_buffer_get_selection_bounds(buffer, &start_iter, &end_iter);
606 start_pos = gtk_text_iter_get_offset(&start_iter);
607 end_pos = gtk_text_iter_get_offset(&end_iter);
609 /* The user can select from end to start too. If so, swap it*/
610 if (end_pos < start_pos) {
614 start_pos = swap_pos;
623 if ((start_pos > 0 || end_pos > 0) && (start_pos != end_pos))