[gtksourceview/wip/undo-redo: 16/16] UndoManager: new implementation based on GQueues
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtksourceview/wip/undo-redo: 16/16] UndoManager: new implementation based on GQueues
- Date: Tue, 9 Sep 2014 21:26:11 +0000 (UTC)
commit 9ed13a8f5bf775752c6111135adafecd073cf626
Author: Sébastien Wilmet <swilmet gnome org>
Date: Sun Aug 31 17:40:40 2014 +0200
UndoManager: new implementation based on GQueues
See also the previous commit message.
Visible changes with the previous implementation:
- Word merging: before, the spaces _after_ a word were merged with the
word, now it is the spaces _before_ the word that are merged. See the
comment in action_insert_merge() for the reason.
- A group containing several actions will now never be merged with the
previous group. Before, the merging was done action by action.
- An insertion or deletion outside a begin/end user action is now
inserted into a new group for each action. With the previous
implementation, those actions were grouped into one undo/redo step.
- Different behavior for restoring the cursor position. The selection is
no longer restored. The cursor position is placed at the end of the
first action in the group. If the group contains only one action, it
simply goes to the end of the insertion or deletion. For a search and
replace, it always goes to the end of the first replaced occurrence.
If restoring the selection is desirable, the code contains #if 0
sections for storing the selection only if the selection is related to
the action. That is, for a deletion the selection bounds should have the
same offsets as the deleted text, otherwise the selection is not stored.
gtksourceview/gtksourceundomanagerdefault.c | 1203 ++++++++++++++++++++++++++-
tests/test-undo-manager.c | 90 ++-
2 files changed, 1226 insertions(+), 67 deletions(-)
---
diff --git a/gtksourceview/gtksourceundomanagerdefault.c b/gtksourceview/gtksourceundomanagerdefault.c
index f843613..9ba622d 100644
--- a/gtksourceview/gtksourceundomanagerdefault.c
+++ b/gtksourceview/gtksourceundomanagerdefault.c
@@ -24,11 +24,13 @@
*/
#include "gtksourceundomanagerdefault.h"
+#include <string.h>
#include "gtksourceundomanager.h"
+/* unlimited by default */
+#define DEFAULT_MAX_UNDO_LEVELS -1
+
typedef struct _Action Action;
-typedef struct _ActionInsert ActionInsert;
-typedef struct _ActionDelete ActionDelete;
typedef struct _ActionGroup ActionGroup;
typedef enum
@@ -37,32 +39,42 @@ typedef enum
ACTION_TYPE_DELETE
} ActionType;
-/* We use character offsets instead of GtkTextMarks because the latter require
- * too much memory in this context without giving us any advantage.
- */
-
-struct _ActionInsert
+struct _Action
{
- gint pos;
- gchar *text;
-};
+ ActionType type;
-struct _ActionDelete
-{
+ /* Character offset for the start of @text in the GtkTextBuffer. */
gint start;
+
+ /* Character offset for the end of @text in the GtkTextBuffer. */
gint end;
+
+ /* Nul-terminated text.
+ * TODO A possible memory optimization is to store the text only when
+ * needed. For an insertion that is located in the history on the undo
+ * side, the text is not needed since it is already present in the
+ * buffer. The same for a deletion on the redo side. But the last action
+ * text is needed for the merging.
+ */
gchar *text;
-};
-struct _Action
-{
- ActionType action_type;
+#if 0
+ /* Character offsets of the insert and selection bound marks.
+ * -1 if it doesn't match @start or @end. If the text cursor or the
+ * selected text is not related to the action, the selection is not
+ * stored.
+ * If not -1, when undoing or redoing an action, the insert and
+ * selection bound marks are restored to where they were.
+ */
+ gint selection_insert;
+ gint selection_bound;
+#endif
- union
- {
- ActionInsert insert;
- ActionDelete delete;
- } action;
+ /* Used only for a deletion. If forward is TRUE, the Delete key was
+ * probably used. If forward is FALSE, the Backspace key was probably
+ * used.
+ */
+ guint forward : 1;
};
struct _ActionGroup
@@ -74,6 +86,13 @@ struct _ActionGroup
* gtk_text_buffer_end_user_action().
*/
GQueue *actions;
+
+ /* If force_not_mergeable is FALSE, there are dynamic checks to see if
+ * the action group is mergeable. For example if the saved_location is
+ * just after the action group, the action group is not mergeable, so
+ * the saved_location isn't lost.
+ */
+ guint force_not_mergeable : 1;
};
struct _GtkSourceUndoManagerDefaultPrivate
@@ -116,6 +135,19 @@ struct _GtkSourceUndoManagerDefaultPrivate
guint can_undo : 1;
guint can_redo : 1;
+
+ /* Whether we are between a begin-user-action and a end-user-action.
+ * Some operations, like undo and redo, are not allowed during a user
+ * action (it would screw up the history).
+ * At the beginning of a user action, a new action group is created. At
+ * the end of the user action, we try to merge the group with the
+ * previous one. So when an insertion or deletion occurs when
+ * running_user_action is TRUE, we don't need to create a new group. But
+ * when running_user_action is FALSE, we need to put the insertion or
+ * deletion into a new group and try to merge it directly with the
+ * previous group.
+ */
+ guint running_user_action : 1;
};
enum
@@ -127,6 +159,9 @@ enum
static void gtk_source_undo_manager_iface_init (GtkSourceUndoManagerIface *iface);
+static gboolean action_merge (Action *action,
+ Action *new_action);
+
G_DEFINE_TYPE_WITH_CODE (GtkSourceUndoManagerDefault,
gtk_source_undo_manager_default,
G_TYPE_OBJECT,
@@ -134,8 +169,796 @@ G_DEFINE_TYPE_WITH_CODE (GtkSourceUndoManagerDefault,
G_IMPLEMENT_INTERFACE (GTK_SOURCE_TYPE_UNDO_MANAGER,
gtk_source_undo_manager_iface_init))
+/* Utilities functions */
+
+static Action *
+action_new (void)
+{
+ Action *action;
+
+ action = g_slice_new0 (Action);
+
+#if 0
+ action->selection_insert = -1;
+ action->selection_bound = -1;
+#endif
+
+ return action;
+}
+
+static void
+action_free (Action *action)
+{
+ if (action != NULL)
+ {
+ g_free (action->text);
+ g_slice_free (Action, action);
+ }
+}
+
+static ActionGroup *
+action_group_new (void)
+{
+ ActionGroup *group;
+
+ group = g_slice_new (ActionGroup);
+ group->actions = g_queue_new ();
+ group->force_not_mergeable = FALSE;
+
+ return group;
+}
+
+static void
+action_group_free (ActionGroup *group)
+{
+ if (group != NULL)
+ {
+ g_queue_free_full (group->actions, (GDestroyNotify) action_free);
+ g_slice_free (ActionGroup, group);
+ }
+}
+
+static void
+update_can_undo_can_redo (GtkSourceUndoManagerDefault *manager)
+{
+ gboolean can_undo;
+ gboolean can_redo;
+
+ if (manager->priv->running_user_action)
+ {
+ can_undo = FALSE;
+ can_redo = FALSE;
+ }
+ else if (manager->priv->location != NULL)
+ {
+ can_undo = manager->priv->location->prev != NULL;
+ can_redo = TRUE;
+ }
+ else
+ {
+ can_undo = manager->priv->action_groups->tail != NULL;
+ can_redo = FALSE;
+ }
+
+ if (manager->priv->can_undo != can_undo)
+ {
+ manager->priv->can_undo = can_undo;
+ gtk_source_undo_manager_can_undo_changed (GTK_SOURCE_UNDO_MANAGER (manager));
+ }
+
+ if (manager->priv->can_redo != can_redo)
+ {
+ manager->priv->can_redo = can_redo;
+ gtk_source_undo_manager_can_redo_changed (GTK_SOURCE_UNDO_MANAGER (manager));
+ }
+}
+
+static void
+clear_all (GtkSourceUndoManagerDefault *manager)
+{
+ GList *l;
+
+ if (manager->priv->has_saved_location &&
+ manager->priv->saved_location != manager->priv->location)
+ {
+ manager->priv->has_saved_location = FALSE;
+ }
+
+ for (l = manager->priv->action_groups->head; l != NULL; l = l->next)
+ {
+ ActionGroup *group = l->data;
+ action_group_free (group);
+ }
+
+ g_queue_clear (manager->priv->action_groups);
+ manager->priv->location = NULL;
+ manager->priv->saved_location = NULL;
+
+ update_can_undo_can_redo (manager);
+}
+
+static void
+remove_last_action_group (GtkSourceUndoManagerDefault *manager)
+{
+ ActionGroup *group;
+
+ if (manager->priv->action_groups->length == 0)
+ {
+ return;
+ }
+
+ if (manager->priv->location == manager->priv->action_groups->tail)
+ {
+ manager->priv->location = NULL;
+ }
+
+ if (manager->priv->has_saved_location)
+ {
+ if (manager->priv->saved_location == NULL)
+ {
+ manager->priv->has_saved_location = FALSE;
+ }
+ else if (manager->priv->saved_location == manager->priv->action_groups->tail)
+ {
+ manager->priv->saved_location = NULL;
+ }
+ }
+
+ group = g_queue_pop_tail (manager->priv->action_groups);
+ action_group_free (group);
+}
+
+static void
+remove_first_action_group (GtkSourceUndoManagerDefault *manager)
+{
+ GList *first_node;
+ ActionGroup *group;
+
+ first_node = manager->priv->action_groups->head;
+
+ if (first_node == NULL)
+ {
+ return;
+ }
+
+ if (manager->priv->location == first_node)
+ {
+ manager->priv->location = first_node->next;
+ }
+
+ if (manager->priv->has_saved_location &&
+ manager->priv->saved_location == first_node)
+ {
+ manager->priv->has_saved_location = FALSE;
+ }
+
+ group = g_queue_pop_head (manager->priv->action_groups);
+ action_group_free (group);
+}
+
+static void
+check_history_size (GtkSourceUndoManagerDefault *manager)
+{
+ if (manager->priv->max_undo_levels == -1)
+ {
+ return;
+ }
+
+ if (manager->priv->max_undo_levels == 0)
+ {
+ clear_all (manager);
+ return;
+ }
+
+ while (manager->priv->action_groups->length > manager->priv->max_undo_levels)
+ {
+ /* Strip redo action groups first. */
+ if (manager->priv->location != NULL)
+ {
+ remove_last_action_group (manager);
+ }
+ else
+ {
+ remove_first_action_group (manager);
+ }
+ }
+
+ update_can_undo_can_redo (manager);
+}
+
+static void
+insert_new_action_group (GtkSourceUndoManagerDefault *manager)
+{
+ ActionGroup *group = action_group_new ();
+
+ if (manager->priv->location != NULL)
+ {
+ g_queue_insert_before (manager->priv->action_groups,
+ manager->priv->location,
+ group);
+ }
+ else
+ {
+ g_queue_push_tail (manager->priv->action_groups,
+ group);
+ }
+
+ if (manager->priv->has_saved_location &&
+ manager->priv->saved_location == manager->priv->location)
+ {
+ if (manager->priv->saved_location != NULL)
+ {
+ manager->priv->saved_location = manager->priv->saved_location->prev;
+ }
+ else
+ {
+ manager->priv->saved_location = manager->priv->action_groups->tail;
+ }
+
+ g_assert (manager->priv->saved_location != NULL);
+ g_assert (manager->priv->saved_location->data == group);
+ }
+}
+
+static void
+remove_redo_action_groups (GtkSourceUndoManagerDefault *manager)
+{
+ while (manager->priv->location != NULL)
+ {
+ remove_last_action_group (manager);
+ }
+}
+
+/* Try to merge @new_group into @group. Returns TRUE if merged. It is up to the
+ * caller to free @new_group.
+ */
+static gboolean
+action_group_merge (ActionGroup *group,
+ ActionGroup *new_group)
+{
+ Action *action;
+ Action *new_action;
+
+ if (group->force_not_mergeable ||
+ new_group->force_not_mergeable ||
+ group->actions->length > 1 ||
+ new_group->actions->length > 1)
+ {
+ return FALSE;
+ }
+
+ if (new_group->actions->length == 0)
+ {
+ return TRUE;
+ }
+
+ action = g_queue_peek_head (group->actions);
+ new_action = g_queue_peek_head (new_group->actions);
+
+ return action_merge (action, new_action);
+}
+
+/* Try to merge the current action group with the previous one. The "current
+ * action group" is the node on the left of location.
+ */
+static void
+try_merge_current_action_group (GtkSourceUndoManagerDefault *manager)
+{
+ GList *new_node = NULL;
+ GList *prev_node = NULL;
+ ActionGroup *new_group = NULL;
+ ActionGroup *prev_group = NULL;
+
+ if (manager->priv->location != NULL)
+ {
+ new_node = manager->priv->location->prev;
+ }
+ else
+ {
+ new_node = manager->priv->action_groups->tail;
+ }
+
+ g_assert (new_node != NULL);
+
+ prev_node = new_node->prev;
+
+ if (prev_node == NULL)
+ {
+ goto end;
+ }
+
+ new_group = new_node->data;
+ prev_group = prev_node->data;
+
+ /* If the previous group is empty, it means that it was not correctly
+ * merged.
+ */
+ g_assert_cmpuint (prev_group->actions->length, >, 0);
+
+ /* If the saved_location is between the two nodes, the two nodes cannot
+ * be merged. Except if the new node is empty.
+ */
+ if (manager->priv->has_saved_location &&
+ manager->priv->saved_location == new_node &&
+ new_group->actions->length > 0)
+ {
+ goto end;
+ }
+
+ if (action_group_merge (prev_group, new_group))
+ {
+ if (manager->priv->has_saved_location &&
+ manager->priv->saved_location == new_node)
+ {
+ manager->priv->saved_location = new_node->next;
+ }
+
+ /* Of course, no need to update location, since new_node is on
+ * the left of location.
+ */
+ g_assert (manager->priv->location != new_node);
+
+ action_group_free (new_group);
+ g_queue_delete_link (manager->priv->action_groups, new_node);
+ return;
+ }
+
+end:
+ /* "Archive" prev_group. It will never be mergeable again. If the user
+ * does some undo's to return to this location, a new action won't be
+ * merged with an "archived" action group.
+ */
+ if (prev_group != NULL)
+ {
+ prev_group->force_not_mergeable = TRUE;
+ }
+
+ check_history_size (manager);
+ update_can_undo_can_redo (manager);
+}
+
+static void
+insert_action (GtkSourceUndoManagerDefault *manager,
+ Action *new_action)
+{
+ ActionGroup *group;
+
+ g_assert (new_action != NULL);
+
+ remove_redo_action_groups (manager);
+ g_assert (manager->priv->location == NULL);
+
+ if (!manager->priv->running_user_action)
+ {
+ insert_new_action_group (manager);
+ }
+
+ group = g_queue_peek_tail (manager->priv->action_groups);
+ g_assert (group != NULL);
+
+ /* Inside a group, don't try to merge the actions. It is needed to keep
+ * them separate so when undoing or redoing, the cursor position is set
+ * at the right place.
+ * For example with the search and replace, we replace all occurrences
+ * of 'a' by '' (i.e. delete all a's). The text "aaba" becomes "b". On
+ * undo, the cursor position should be placed at "a|aba", not "aa|ba"
+ * (but it's a detail).
+ */
+ g_queue_push_tail (group->actions, new_action);
+
+ /* An action is mergeable only for an insertion or deletion of a single
+ * character. If the text contains several characters, the new_action
+ * can for example come from a copy/paste.
+ */
+ if (new_action->end - new_action->start > 1 ||
+ g_str_equal (new_action->text, "\n"))
+ {
+ group->force_not_mergeable = TRUE;
+ }
+
+ if (!manager->priv->running_user_action)
+ {
+ try_merge_current_action_group (manager);
+ }
+}
+
+static void
+delete_text (GtkTextBuffer *buffer,
+ gint start,
+ gint end)
+{
+ GtkTextIter start_iter;
+ GtkTextIter end_iter;
+
+ gtk_text_buffer_get_iter_at_offset (buffer, &start_iter, start);
+ gtk_text_buffer_get_iter_at_offset (buffer, &end_iter, end);
+
+ gtk_text_buffer_begin_user_action (buffer);
+ gtk_text_buffer_delete (buffer, &start_iter, &end_iter);
+ gtk_text_buffer_end_user_action (buffer);
+}
+
+static void
+insert_text (GtkTextBuffer *buffer,
+ gint offset,
+ const gchar *text)
+{
+ GtkTextIter iter;
+
+ gtk_text_buffer_get_iter_at_offset (buffer, &iter, offset);
+
+ gtk_text_buffer_begin_user_action (buffer);
+ gtk_text_buffer_insert (buffer, &iter, text, -1);
+ gtk_text_buffer_end_user_action (buffer);
+}
+
+static gunichar
+get_last_char (const gchar *text)
+{
+ gchar *pos;
+
+ pos = g_utf8_find_prev_char (text, text + strlen (text));
+
+ if (pos == NULL)
+ {
+ return '\0';
+ }
+
+ return g_utf8_get_char (pos);
+}
+
+/* ActionInsert implementation */
+
+static void
+action_insert_undo (GtkTextBuffer *buffer,
+ Action *action)
+{
+ g_assert_cmpint (action->type, ==, ACTION_TYPE_INSERT);
+
+ delete_text (buffer, action->start, action->end);
+}
+
+static void
+action_insert_redo (GtkTextBuffer *buffer,
+ Action *action)
+{
+ g_assert_cmpint (action->type, ==, ACTION_TYPE_INSERT);
+
+ insert_text (buffer, action->start, action->text);
+}
+
+static gboolean
+action_insert_merge (Action *action,
+ Action *new_action)
+{
+ gint new_text_length;
+ gunichar new_char;
+ gunichar last_char;
+ gchar *merged_text;
+
+ g_assert_cmpint (action->type, ==, ACTION_TYPE_INSERT);
+ g_assert_cmpint (new_action->type, ==, ACTION_TYPE_INSERT);
+
+ new_text_length = new_action->end - new_action->start;
+ g_assert_cmpint (new_text_length, ==, 1);
+
+ new_char = g_utf8_get_char (new_action->text);
+ g_assert (new_char != '\n');
+
+ if (action->end != new_action->start)
+ {
+ return FALSE;
+ }
+
+ last_char = get_last_char (action->text);
+
+ /* If I type character by character the text "hello world", there will
+ * be two actions: "hello" and " world". If I click on undo, only
+ * "hello" remains, not the space. The space makes sense only when
+ * a second word is present.
+ * Note that the spaces or tabs at the beginning of a line (for code
+ * indentation) are removed with the first word of the line. For example
+ * if I type character by character " return FALSE;", there are two
+ * actions: " return" and " FALSE;". If I undo two times, maybe I still
+ * want the indentation. But with auto-indent, when we press Enter to
+ * create a newline, the indentation is part of the action that adds the
+ * newline, i.e. we have the three actions "\n ", "return" and
+ * " FALSE;".
+ */
+ if ((new_char == ' ' || new_char == '\t') &&
+ (last_char != ' ' && last_char != '\t'))
+ {
+ return FALSE;
+ }
+
+ merged_text = g_strdup_printf ("%s%s", action->text, new_action->text);
+
+ g_free (action->text);
+ action->text = merged_text;
+
+ action->end = new_action->end;
+
+ return TRUE;
+}
+
+static void
+action_insert_set_cursor_position (GtkTextBuffer *buffer,
+ Action *action,
+ gboolean undo)
+{
+ GtkTextIter iter;
+
+ g_assert_cmpint (action->type, ==, ACTION_TYPE_INSERT);
+
+ if (undo)
+ {
+ gtk_text_buffer_get_iter_at_offset (buffer, &iter, action->start);
+ }
+ else /* redo */
+ {
+ gtk_text_buffer_get_iter_at_offset (buffer, &iter, action->end);
+ }
+
+ gtk_text_buffer_place_cursor (buffer, &iter);
+}
+
+/* ActionDelete implementation */
+
+static void
+action_delete_undo (GtkTextBuffer *buffer,
+ Action *action)
+{
+ g_assert_cmpint (action->type, ==, ACTION_TYPE_DELETE);
+
+ insert_text (buffer, action->start, action->text);
+}
+
+static void
+action_delete_redo (GtkTextBuffer *buffer,
+ Action *action)
+{
+ g_assert_cmpint (action->type, ==, ACTION_TYPE_DELETE);
+
+ delete_text (buffer, action->start, action->end);
+}
+
+static gboolean
+action_delete_merge (Action *action,
+ Action *new_action)
+{
+ gint new_text_length;
+ gunichar new_char;
+
+ g_assert_cmpint (action->type, ==, ACTION_TYPE_DELETE);
+ g_assert_cmpint (new_action->type, ==, ACTION_TYPE_DELETE);
+
+ new_text_length = new_action->end - new_action->start;
+ g_assert_cmpint (new_text_length, ==, 1);
+
+ new_char = g_utf8_get_char (new_action->text);
+ g_assert (new_char != '\n');
+
+ /* A Backspace can not be merged with a Delete.
+ * Two Backspaces or two Deletes must follow each other.
+ * In "abc", if the cursor is at offset 2 and I press the Backspace key,
+ * then move the cursor after 'c' and press Backspace again, the two
+ * deletes won't be merged, since there was a cursor movement in
+ * between.
+ */
+ if ((action->forward != new_action->forward) ||
+ (action->forward && action->start != new_action->start) ||
+ (!action->forward && action->start != new_action->end))
+ {
+ return FALSE;
+ }
+
+ /* forward, Delete key pressed several times */
+ if (action->start == new_action->start)
+ {
+ gunichar last_char;
+ gchar *merged_text;
+
+ last_char = get_last_char (action->text);
+
+ /* Same as action_insert_merge(). */
+ if ((new_char == ' ' || new_char == '\t') &&
+ (last_char != ' ' && last_char != '\t'))
+ {
+ return FALSE;
+ }
+
+ merged_text = g_strdup_printf ("%s%s", action->text, new_action->text);
+
+ g_free (action->text);
+ action->text = merged_text;
+
+ action->end += new_text_length;
+
+ return TRUE;
+ }
+
+ /* backward, Backspace key pressed several times */
+ if (action->start == new_action->end)
+ {
+ gunichar last_char;
+ gchar *merged_text;
+
+ /* The last char deleted, but since it's with the Backspace key,
+ * it's the first char in action->text.
+ */
+ last_char = g_utf8_get_char (action->text);
+
+ /* Same as action_insert_merge(). */
+ if ((new_char != ' ' && new_char != '\t') &&
+ (last_char == ' ' || last_char == '\t'))
+ {
+ return FALSE;
+ }
+
+ merged_text = g_strdup_printf ("%s%s", new_action->text, action->text);
+
+ g_free (action->text);
+ action->text = merged_text;
+
+ action->start = new_action->start;
+
+ return TRUE;
+ }
+
+ g_assert_not_reached ();
+ return FALSE;
+}
+
+static void
+action_delete_set_cursor_position (GtkTextBuffer *buffer,
+ Action *action,
+ gboolean undo)
+{
+ GtkTextIter iter;
+
+ g_assert_cmpint (action->type, ==, ACTION_TYPE_DELETE);
+
+ if (undo)
+ {
+ gtk_text_buffer_get_iter_at_offset (buffer, &iter, action->end);
+ }
+ else /* redo */
+ {
+ gtk_text_buffer_get_iter_at_offset (buffer, &iter, action->start);
+ }
+
+ gtk_text_buffer_place_cursor (buffer, &iter);
+}
+
+/* Action interface.
+ * The Action struct can be seen as an interface. All the explicit case analysis
+ * on the action type are grouped in this code section. This can easily be
+ * modified as an object-oriented architecture with polymorphism.
+ */
+
+static void
+action_undo (GtkTextBuffer *buffer,
+ Action *action)
+{
+ g_assert (action != NULL);
+
+ switch (action->type)
+ {
+ case ACTION_TYPE_INSERT:
+ action_insert_undo (buffer, action);
+ break;
+
+ case ACTION_TYPE_DELETE:
+ action_delete_undo (buffer, action);
+ break;
+
+ default:
+ g_return_if_reached ();
+ break;
+ }
+}
+
+static void
+action_redo (GtkTextBuffer *buffer,
+ Action *action)
+{
+ g_assert (action != NULL);
+
+ switch (action->type)
+ {
+ case ACTION_TYPE_INSERT:
+ action_insert_redo (buffer, action);
+ break;
+
+ case ACTION_TYPE_DELETE:
+ action_delete_redo (buffer, action);
+ break;
+
+ default:
+ g_return_if_reached ();
+ break;
+ }
+}
+
+/* Try to merge @new_action into @action. Returns TRUE if merged. It is up to
+ * the caller to free @new_action if needed.
+ */
+static gboolean
+action_merge (Action *action,
+ Action *new_action)
+{
+ g_assert (action != NULL);
+ g_assert (new_action != NULL);
+
+ if (action->type != new_action->type)
+ {
+ return FALSE;
+ }
+
+ switch (action->type)
+ {
+ case ACTION_TYPE_INSERT:
+ return action_insert_merge (action, new_action);
+
+ case ACTION_TYPE_DELETE:
+ return action_delete_merge (action, new_action);
+
+ default:
+ g_return_val_if_reached (FALSE);
+ break;
+ }
+}
+
+/* Set the cursor position according to @action.
+ * If @undo is TRUE, @action has just been undone. If @undo is FALSE, @action
+ * has just been redone.
+ */
+static void
+action_set_cursor_position (GtkTextBuffer *buffer,
+ Action *action,
+ gboolean undo)
+{
+ g_assert (action != NULL);
+
+ switch (action->type)
+ {
+ case ACTION_TYPE_INSERT:
+ action_insert_set_cursor_position (buffer, action, undo);
+ break;
+
+ case ACTION_TYPE_DELETE:
+ action_delete_set_cursor_position (buffer, action, undo);
+ break;
+
+ default:
+ g_return_if_reached ();
+ break;
+ }
+}
+
/* Buffer signal handlers */
+#if 0
+static void
+set_selection_bounds (GtkTextBuffer *buffer,
+ Action *action)
+{
+ GtkTextMark *insert_mark;
+ GtkTextMark *selection_mark;
+ GtkTextIter insert_iter;
+ GtkTextIter selection_iter;
+
+ insert_mark = gtk_text_buffer_get_insert (buffer);
+ selection_mark = gtk_text_buffer_get_selection_bound (buffer);
+
+ gtk_text_buffer_get_iter_at_mark (buffer, &insert_iter, insert_mark);
+ gtk_text_buffer_get_iter_at_mark (buffer, &selection_iter, selection_mark);
+
+ action->selection_insert = gtk_text_iter_get_offset (&insert_iter);
+ action->selection_bound = gtk_text_iter_get_offset (&selection_iter);
+}
+#endif
+
static void
insert_text_cb (GtkTextBuffer *buffer,
GtkTextIter *location,
@@ -143,6 +966,31 @@ insert_text_cb (GtkTextBuffer *buffer,
gint length,
GtkSourceUndoManagerDefault *manager)
{
+ Action *action = action_new ();
+
+ action->type = ACTION_TYPE_INSERT;
+ action->start = gtk_text_iter_get_offset (location);
+ action->text = g_strndup (text, length);
+ action->end = action->start + g_utf8_strlen (action->text, -1);
+
+#if 0
+ set_selection_bounds (buffer, action);
+
+ if (action->selection_insert != action->selection_bound ||
+ action->selection_insert != action->start)
+ {
+ action->selection_insert = -1;
+ action->selection_bound = -1;
+ }
+ else
+ {
+ /* The insertion occurred at the cursor. */
+ g_assert_cmpint (action->selection_insert, ==, action->start);
+ g_assert_cmpint (action->selection_bound, ==, action->start);
+ }
+#endif
+
+ insert_action (manager, action);
}
static void
@@ -151,18 +999,147 @@ delete_range_cb (GtkTextBuffer *buffer,
GtkTextIter *end,
GtkSourceUndoManagerDefault *manager)
{
+ Action *action = action_new ();
+ GtkTextIter cursor_pos;
+
+ action->type = ACTION_TYPE_DELETE;
+ action->start = gtk_text_iter_get_offset (start);
+ action->end = gtk_text_iter_get_offset (end);
+ action->text = gtk_text_buffer_get_slice (buffer, start, end, TRUE);
+
+ g_assert_cmpint (action->start, <, action->end);
+
+ gtk_text_buffer_get_iter_at_mark (buffer, &cursor_pos,
+ gtk_text_buffer_get_insert (buffer));
+
+ action->forward = gtk_text_iter_equal (&cursor_pos, start);
+
+#if 0
+ set_selection_bounds (buffer, action);
+
+ if ((action->selection_insert != action->start &&
+ action->selection_insert != action->end) ||
+ (action->selection_bound != action->start &&
+ action->selection_bound != action->end))
+ {
+ action->selection_insert = -1;
+ action->selection_bound = -1;
+ }
+#endif
+
+ insert_action (manager, action);
}
static void
begin_user_action_cb (GtkTextBuffer *buffer,
GtkSourceUndoManagerDefault *manager)
{
+ insert_new_action_group (manager);
+
+ manager->priv->running_user_action = TRUE;
+ update_can_undo_can_redo (manager);
+}
+
+static void
+end_user_action_cb (GtkTextBuffer *buffer,
+ GtkSourceUndoManagerDefault *manager)
+{
+ try_merge_current_action_group (manager);
+
+ manager->priv->running_user_action = FALSE;
+ update_can_undo_can_redo (manager);
}
static void
modified_changed_cb (GtkTextBuffer *buffer,
GtkSourceUndoManagerDefault *manager)
{
+ if (gtk_text_buffer_get_modified (buffer))
+ {
+ /* It can happen for example when the file on disk has been
+ * deleted.
+ */
+ if (manager->priv->has_saved_location &&
+ manager->priv->saved_location == manager->priv->location)
+ {
+ manager->priv->has_saved_location = FALSE;
+ }
+ }
+
+ /* saved */
+ else
+ {
+ manager->priv->saved_location = manager->priv->location;
+ manager->priv->has_saved_location = TRUE;
+
+ /* Saving a buffer during a user action is allowed, the user
+ * action is split.
+ * FIXME and/or a warning should be printed?
+ */
+ if (manager->priv->running_user_action)
+ {
+ try_merge_current_action_group (manager);
+ insert_new_action_group (manager);
+ }
+ }
+}
+
+static void
+block_signal_handlers (GtkSourceUndoManagerDefault *manager)
+{
+ if (manager->priv->buffer == NULL)
+ {
+ return;
+ }
+
+ g_signal_handlers_block_by_func (manager->priv->buffer,
+ insert_text_cb,
+ manager);
+
+ g_signal_handlers_block_by_func (manager->priv->buffer,
+ delete_range_cb,
+ manager);
+
+ g_signal_handlers_block_by_func (manager->priv->buffer,
+ begin_user_action_cb,
+ manager);
+
+ g_signal_handlers_block_by_func (manager->priv->buffer,
+ end_user_action_cb,
+ manager);
+
+ g_signal_handlers_block_by_func (manager->priv->buffer,
+ modified_changed_cb,
+ manager);
+}
+
+static void
+unblock_signal_handlers (GtkSourceUndoManagerDefault *manager)
+{
+ if (manager->priv->buffer == NULL)
+ {
+ return;
+ }
+
+ g_signal_handlers_unblock_by_func (manager->priv->buffer,
+ insert_text_cb,
+ manager);
+
+ g_signal_handlers_unblock_by_func (manager->priv->buffer,
+ delete_range_cb,
+ manager);
+
+ g_signal_handlers_unblock_by_func (manager->priv->buffer,
+ begin_user_action_cb,
+ manager);
+
+ g_signal_handlers_unblock_by_func (manager->priv->buffer,
+ end_user_action_cb,
+ manager);
+
+ g_signal_handlers_unblock_by_func (manager->priv->buffer,
+ modified_changed_cb,
+ manager);
}
static void
@@ -200,10 +1177,18 @@ set_buffer (GtkSourceUndoManagerDefault *manager,
0);
g_signal_connect_object (buffer,
+ "end-user-action",
+ G_CALLBACK (end_user_action_cb),
+ manager,
+ 0);
+
+ g_signal_connect_object (buffer,
"modified-changed",
G_CALLBACK (modified_changed_cb),
manager,
0);
+
+ modified_changed_cb (manager->priv->buffer, manager);
}
/* GObject construction, destruction and properties */
@@ -275,6 +1260,11 @@ gtk_source_undo_manager_default_dispose (GObject *object)
static void
gtk_source_undo_manager_default_finalize (GObject *object)
{
+ GtkSourceUndoManagerDefault *manager = GTK_SOURCE_UNDO_MANAGER_DEFAULT (object);
+
+ g_queue_free_full (manager->priv->action_groups,
+ (GDestroyNotify) action_group_free);
+
G_OBJECT_CLASS (gtk_source_undo_manager_default_parent_class)->finalize (object);
}
@@ -303,48 +1293,181 @@ gtk_source_undo_manager_default_class_init (GtkSourceUndoManagerDefaultClass *kl
"Number of undo levels for the buffer",
-1,
G_MAXINT,
- -1, /* unlimited by default */
- G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
+ DEFAULT_MAX_UNDO_LEVELS,
+ G_PARAM_READWRITE));
}
static void
gtk_source_undo_manager_default_init (GtkSourceUndoManagerDefault *manager)
{
manager->priv = gtk_source_undo_manager_default_get_instance_private (manager);
+
+ manager->priv->action_groups = g_queue_new ();
+ manager->priv->max_undo_levels = DEFAULT_MAX_UNDO_LEVELS;
}
/* Interface implementation */
static gboolean
-gtk_source_undo_manager_can_undo_impl (GtkSourceUndoManager *manager)
+gtk_source_undo_manager_can_undo_impl (GtkSourceUndoManager *undo_manager)
{
- return GTK_SOURCE_UNDO_MANAGER_DEFAULT (manager)->priv->can_undo;
+ GtkSourceUndoManagerDefault *manager = GTK_SOURCE_UNDO_MANAGER_DEFAULT (undo_manager);
+ return manager->priv->can_undo;
}
static gboolean
-gtk_source_undo_manager_can_redo_impl (GtkSourceUndoManager *manager)
+gtk_source_undo_manager_can_redo_impl (GtkSourceUndoManager *undo_manager)
{
- return GTK_SOURCE_UNDO_MANAGER_DEFAULT (manager)->priv->can_redo;
+ GtkSourceUndoManagerDefault *manager = GTK_SOURCE_UNDO_MANAGER_DEFAULT (undo_manager);
+ return manager->priv->can_redo;
}
static void
-gtk_source_undo_manager_undo_impl (GtkSourceUndoManager *manager)
+restore_modified_state (GtkSourceUndoManagerDefault *manager,
+ GList *old_location,
+ GList *new_location)
{
+ if (manager->priv->has_saved_location)
+ {
+ if (old_location == manager->priv->saved_location)
+ {
+ gtk_text_buffer_set_modified (manager->priv->buffer, TRUE);
+ }
+ else if (new_location == manager->priv->saved_location)
+ {
+ gtk_text_buffer_set_modified (manager->priv->buffer, FALSE);
+ }
+ }
}
static void
-gtk_source_undo_manager_redo_impl (GtkSourceUndoManager *manager)
+gtk_source_undo_manager_undo_impl (GtkSourceUndoManager *undo_manager)
{
+ GtkSourceUndoManagerDefault *manager = GTK_SOURCE_UNDO_MANAGER_DEFAULT (undo_manager);
+ GList *old_location;
+ GList *new_location;
+ ActionGroup *group;
+ Action *action;
+ GList *l;
+
+ g_return_if_fail (manager->priv->can_undo);
+
+ old_location = manager->priv->location;
+
+ if (old_location != NULL)
+ {
+ new_location = manager->priv->location->prev;
+ }
+ else
+ {
+ new_location = manager->priv->action_groups->tail;
+ }
+
+ g_assert (new_location != NULL);
+ group = new_location->data;
+
+ /* Empty groups are inserted at the beginning of a user action, but
+ * during a user action can_undo is FALSE.
+ */
+ g_assert_cmpuint (group->actions->length, >, 0);
+
+ block_signal_handlers (manager);
+
+ for (l = group->actions->tail; l != NULL; l = l->prev)
+ {
+ action = l->data;
+ action_undo (manager->priv->buffer, action);
+ }
+
+ restore_modified_state (manager, old_location, new_location);
+
+ /* After an undo, place the cursor at the first action in the group. For
+ * a search and replace, it will be the first occurrence in the buffer.
+ */
+ action = g_queue_peek_head (group->actions);
+ action_set_cursor_position (manager->priv->buffer, action, TRUE);
+
+ unblock_signal_handlers (manager);
+
+ manager->priv->location = new_location;
+ update_can_undo_can_redo (manager);
+}
+
+static void
+gtk_source_undo_manager_redo_impl (GtkSourceUndoManager *undo_manager)
+{
+ GtkSourceUndoManagerDefault *manager = GTK_SOURCE_UNDO_MANAGER_DEFAULT (undo_manager);
+ GList *old_location;
+ GList *new_location;
+ ActionGroup *group;
+ GList *l;
+
+ g_return_if_fail (manager->priv->can_redo);
+
+ old_location = manager->priv->location;
+ g_assert (old_location != NULL);
+
+ new_location = old_location->next;
+
+ group = old_location->data;
+
+ block_signal_handlers (manager);
+
+ for (l = group->actions->head; l != NULL; l = l->next)
+ {
+ Action *action = l->data;
+ action_redo (manager->priv->buffer, action);
+
+ /* For a redo, place the cursor at the first action in the
+ * group. For an undo the first action is also chosen, so when
+ * undoing/redoing a search and replace, the cursor position
+ * stays at the first occurrence and the user can see the
+ * replacement easily.
+ * For a redo, if we choose the last action in the group, when
+ * undoing/redoing a search and replace, the cursor position
+ * will jump between the first occurrence and the last
+ * occurrence. Staying at the same place is probably better.
+ */
+ if (l == group->actions->head)
+ {
+ action_set_cursor_position (manager->priv->buffer, action, FALSE);
+ }
+ }
+
+ restore_modified_state (manager, old_location, new_location);
+
+ unblock_signal_handlers (manager);
+
+ manager->priv->location = new_location;
+ update_can_undo_can_redo (manager);
}
static void
-gtk_source_undo_manager_begin_not_undoable_action_impl (GtkSourceUndoManager *manager)
+gtk_source_undo_manager_begin_not_undoable_action_impl (GtkSourceUndoManager *undo_manager)
{
+ GtkSourceUndoManagerDefault *manager = GTK_SOURCE_UNDO_MANAGER_DEFAULT (undo_manager);
+ manager->priv->running_not_undoable_actions++;
+
+ if (manager->priv->running_not_undoable_actions == 1)
+ {
+ block_signal_handlers (manager);
+ }
}
static void
-gtk_source_undo_manager_end_not_undoable_action_impl (GtkSourceUndoManager *manager)
+gtk_source_undo_manager_end_not_undoable_action_impl (GtkSourceUndoManager *undo_manager)
{
+ GtkSourceUndoManagerDefault *manager = GTK_SOURCE_UNDO_MANAGER_DEFAULT (undo_manager);
+
+ g_return_if_fail (manager->priv->running_not_undoable_actions > 0);
+
+ manager->priv->running_not_undoable_actions--;
+
+ if (manager->priv->running_not_undoable_actions == 0)
+ {
+ unblock_signal_handlers (manager);
+ clear_all (manager);
+ }
}
static void
@@ -366,4 +1489,22 @@ gtk_source_undo_manager_default_set_max_undo_levels (GtkSourceUndoManagerDefault
{
g_return_if_fail (GTK_SOURCE_IS_UNDO_MANAGER_DEFAULT (manager));
g_return_if_fail (max_undo_levels >= -1);
+
+ if (manager->priv->max_undo_levels != max_undo_levels)
+ {
+ if (max_undo_levels == 0)
+ {
+ /* disable the undo manager */
+ block_signal_handlers (manager);
+ }
+ else if (manager->priv->max_undo_levels == 0)
+ {
+ unblock_signal_handlers (manager);
+ }
+
+ manager->priv->max_undo_levels = max_undo_levels;
+ check_history_size (manager);
+
+ g_object_notify (G_OBJECT (manager), "max-undo-levels");
+ }
}
diff --git a/tests/test-undo-manager.c b/tests/test-undo-manager.c
index 0051987..d79d514 100644
--- a/tests/test-undo-manager.c
+++ b/tests/test-undo-manager.c
@@ -49,20 +49,43 @@ delete_first_line (GtkSourceBuffer *buffer)
gtk_text_buffer_end_user_action (GTK_TEXT_BUFFER (buffer));
}
+/* If forward is FALSE, the Backspace key is simulated. If forward is TRUE, the
+ * Delete key is simulated.
+ */
static void
-delete_char_at_offset (GtkSourceBuffer *buffer,
- gint offset)
+delete_char_at_offset (GtkSourceBuffer *source_buffer,
+ gint offset,
+ gboolean forward)
{
+ GtkTextBuffer *buffer = GTK_TEXT_BUFFER (source_buffer);
GtkTextIter start;
GtkTextIter end;
- gtk_text_buffer_get_iter_at_offset (GTK_TEXT_BUFFER (buffer), &start, offset);
+ gtk_text_buffer_get_iter_at_offset (buffer, &start, offset);
end = start;
gtk_text_iter_forward_char (&end);
- gtk_text_buffer_begin_user_action (GTK_TEXT_BUFFER (buffer));
- gtk_text_buffer_delete (GTK_TEXT_BUFFER (buffer), &start, &end);
- gtk_text_buffer_end_user_action (GTK_TEXT_BUFFER (buffer));
+ if (forward)
+ {
+ gtk_text_buffer_place_cursor (buffer, &start);
+ }
+ else
+ {
+ GtkTextIter start_copy;
+
+ gtk_text_buffer_place_cursor (buffer, &end);
+
+ /* Swap start and end so that start > end, to test if in the
+ * delete-range callback start and end are reordered.
+ */
+ start_copy = start;
+ start = end;
+ end = start_copy;
+ }
+
+ gtk_text_buffer_begin_user_action (buffer);
+ gtk_text_buffer_delete (buffer, &start, &end);
+ gtk_text_buffer_end_user_action (buffer);
}
static gchar *
@@ -111,7 +134,7 @@ check_max_undo_levels (GtkSourceBuffer *buffer,
{
gtk_text_buffer_begin_user_action (GTK_TEXT_BUFFER (buffer));
insert_text (buffer, "foobar\n");
- delete_char_at_offset (buffer, 0);
+ delete_char_at_offset (buffer, 0, FALSE);
gtk_text_buffer_end_user_action (GTK_TEXT_BUFFER (buffer));
}
else
@@ -198,14 +221,7 @@ test_max_undo_levels (void)
{
GtkSourceBuffer *buffer = gtk_source_buffer_new (NULL);
- /* FIXME max_undo_levels of 0 doesn't work as expected (i.e. undo/redo
- * disabled).
- */
-#if 0
gint min = 0;
-#else
- gint min = 1;
-#endif
gint max = 5;
gint i;
@@ -300,10 +316,12 @@ test_not_undoable_action (void)
/* Behavior _during_ a not undoable action */
- /* FIXME: the API doesn't explain what should be the behaviors in the
- * following situations (also for nested).
+ /* The API doesn't explain what should be the behaviors in the
+ * following situations (also for nested). So it is just "undefinied
+ * behavior", and it can change in the future.
* What is certain is that after the last end_not_undoable_action() (if
- * the calls are nested), it is not possible to undo or redo.
+ * the calls are nested), the history is cleared and it is not possible
+ * to undo or redo.
*/
insert_text (buffer, "foo\n");
insert_text (buffer, "bar\n");
@@ -435,7 +453,7 @@ test_merge_actions (void)
insert_text (buffer, "a");
contents_history = g_list_append (contents_history, get_contents (buffer));
- delete_char_at_offset (buffer, 0);
+ delete_char_at_offset (buffer, 0, FALSE);
contents_history = g_list_append (contents_history, get_contents (buffer));
check_contents_history (buffer, contents_history);
@@ -446,8 +464,8 @@ test_merge_actions (void)
check_contents_history (buffer, contents_history);
/* Mergeable deletes */
- delete_char_at_offset (buffer, 1);
- delete_char_at_offset (buffer, 0);
+ delete_char_at_offset (buffer, 1, FALSE);
+ delete_char_at_offset (buffer, 0, FALSE);
contents_history = g_list_append (contents_history, get_contents (buffer));
check_contents_history (buffer, contents_history);
@@ -455,31 +473,31 @@ test_merge_actions (void)
insert_text (buffer, "def");
contents_history = g_list_append (contents_history, get_contents (buffer));
- delete_char_at_offset (buffer, 2);
+ delete_char_at_offset (buffer, 2, FALSE);
contents_history = g_list_append (contents_history, get_contents (buffer));
- delete_char_at_offset (buffer, 0);
- delete_char_at_offset (buffer, 0);
+ delete_char_at_offset (buffer, 0, TRUE);
+ delete_char_at_offset (buffer, 0, TRUE);
contents_history = g_list_append (contents_history, get_contents (buffer));
check_contents_history (buffer, contents_history);
/* Insert two words */
insert_text (buffer, "g");
insert_text (buffer, "h");
- insert_text (buffer, " ");
contents_history = g_list_append (contents_history, get_contents (buffer));
+ insert_text (buffer, " ");
insert_text (buffer, "i");
contents_history = g_list_append (contents_history, get_contents (buffer));
check_contents_history (buffer, contents_history);
/* Delete the two words (with backspace) */
- delete_char_at_offset (buffer, 3);
- delete_char_at_offset (buffer, 2);
+ delete_char_at_offset (buffer, 3, FALSE);
+ delete_char_at_offset (buffer, 2, FALSE);
contents_history = g_list_append (contents_history, get_contents (buffer));
- delete_char_at_offset (buffer, 1);
- delete_char_at_offset (buffer, 0);
+ delete_char_at_offset (buffer, 1, FALSE);
+ delete_char_at_offset (buffer, 0, FALSE);
contents_history = g_list_append (contents_history, get_contents (buffer));
check_contents_history (buffer, contents_history);
@@ -487,12 +505,12 @@ test_merge_actions (void)
insert_text (buffer, "jk l");
contents_history = g_list_append (contents_history, get_contents (buffer));
- delete_char_at_offset (buffer, 0);
- delete_char_at_offset (buffer, 0);
- delete_char_at_offset (buffer, 0);
+ delete_char_at_offset (buffer, 0, TRUE);
+ delete_char_at_offset (buffer, 0, TRUE);
contents_history = g_list_append (contents_history, get_contents (buffer));
- delete_char_at_offset (buffer, 0);
+ delete_char_at_offset (buffer, 0, TRUE);
+ delete_char_at_offset (buffer, 0, TRUE);
contents_history = g_list_append (contents_history, get_contents (buffer));
check_contents_history (buffer, contents_history);
@@ -532,8 +550,8 @@ test_several_user_actions (void)
/* Non-contiguous deletions (removes the 'a' and 'b' just inserted). */
gtk_text_buffer_begin_user_action (text_buffer);
- delete_char_at_offset (source_buffer, 2);
- delete_char_at_offset (source_buffer, 0);
+ delete_char_at_offset (source_buffer, 2, FALSE);
+ delete_char_at_offset (source_buffer, 0, FALSE);
gtk_text_buffer_end_user_action (text_buffer);
contents_history = g_list_append (contents_history, get_contents (source_buffer));
@@ -551,8 +569,8 @@ test_several_user_actions (void)
/* Mixed insertions/deletions */
gtk_text_buffer_begin_user_action (text_buffer);
gtk_text_buffer_set_text (text_buffer, "ahbello\n", -1);
- delete_char_at_offset (source_buffer, 2);
- delete_char_at_offset (source_buffer, 0);
+ delete_char_at_offset (source_buffer, 2, FALSE);
+ delete_char_at_offset (source_buffer, 0, FALSE);
insert_text (source_buffer, "world\n");
gtk_text_buffer_end_user_action (text_buffer);
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
