[gtksourceview/wip/fix-completion-words: 3/3] CompletionWords buffer: use GtkTextRegion
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtksourceview/wip/fix-completion-words: 3/3] CompletionWords buffer: use GtkTextRegion
- Date: Sat, 8 Jun 2013 16:33:03 +0000 (UTC)
commit dcda2a0a133c5b42dd97176c1f29f6b379a8c03f
Author: Sébastien Wilmet <swilmet gnome org>
Date: Sat Jun 8 15:58:20 2013 +0200
CompletionWords buffer: use GtkTextRegion
For scanning the words (for the initial scan but also on text insertion
and text deletion), the "scan region" is now a GtkTextRegion. It
simplifies the code for maintaining the GtkTextMarks.
For modifications on the buffer, there is now a callback before the
modification, to invalidate the region (remove the words that must be
removed), and a callback after the modification, to add the region to the
scan region. There were some problems when adding the region to the scan
region before the modification (text insertion or deletion).
.../words/gtksourcecompletionwordsbuffer.c | 524 +++++++++++---------
1 files changed, 281 insertions(+), 243 deletions(-)
---
diff --git a/gtksourceview/completion-providers/words/gtksourcecompletionwordsbuffer.c
b/gtksourceview/completion-providers/words/gtksourcecompletionwordsbuffer.c
index be483de..be6ac0e 100644
--- a/gtksourceview/completion-providers/words/gtksourcecompletionwordsbuffer.c
+++ b/gtksourceview/completion-providers/words/gtksourcecompletionwordsbuffer.c
@@ -22,6 +22,7 @@
#include "gtksourcecompletionwordsbuffer.h"
#include "gtksourcecompletionwordsutils.h"
+#include "gtksourceview/gtktextregion.h"
#define GTK_SOURCE_COMPLETION_WORDS_BUFFER_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE((object),
GTK_SOURCE_TYPE_COMPLETION_WORDS_BUFFER, GtkSourceCompletionWordsBufferPrivate))
@@ -37,18 +38,12 @@ typedef struct
guint use_count;
} ProposalCache;
-typedef struct
-{
- GtkTextMark *start;
- GtkTextMark *end;
-} ScanRegion;
-
struct _GtkSourceCompletionWordsBufferPrivate
{
GtkSourceCompletionWordsLibrary *library;
GtkTextBuffer *buffer;
- GList *scan_regions;
+ GtkTextRegion *scan_region;
gulong batch_scan_id;
gulong initiate_scan_id;
@@ -77,48 +72,6 @@ proposal_cache_free (ProposalCache *cache)
g_slice_free (ProposalCache, cache);
}
-static ScanRegion *
-scan_region_new (GtkTextBuffer *buffer,
- GtkTextIter *start,
- GtkTextIter *end)
-{
- ScanRegion *region = g_slice_new (ScanRegion);
-
- region->start = g_object_ref (gtk_text_buffer_create_mark (buffer,
- NULL,
- start,
- TRUE));
-
- region->end = g_object_ref (gtk_text_buffer_create_mark (buffer,
- NULL,
- end,
- FALSE));
-
- return region;
-}
-
-static void
-scan_region_free (ScanRegion *region)
-{
- GtkTextBuffer *buffer = gtk_text_mark_get_buffer (region->start);
-
- if (!gtk_text_mark_get_deleted (region->start))
- {
- gtk_text_buffer_delete_mark (buffer, region->start);
- }
-
- g_object_unref (region->start);
-
- if (!gtk_text_mark_get_deleted (region->end))
- {
- gtk_text_buffer_delete_mark (buffer, region->end);
- }
-
- g_object_unref (region->end);
-
- g_slice_free (ScanRegion, region);
-}
-
static void
remove_proposal_cache (const gchar *key,
ProposalCache *cache,
@@ -134,7 +87,7 @@ remove_proposal_cache (const gchar *key,
}
static void
-remove_words (GtkSourceCompletionWordsBuffer *buffer)
+remove_all_words (GtkSourceCompletionWordsBuffer *buffer)
{
g_hash_table_foreach (buffer->priv->words,
(GHFunc)remove_proposal_cache,
@@ -151,14 +104,17 @@ gtk_source_completion_words_buffer_dispose (GObject *object)
if (buffer->priv->words != NULL)
{
- remove_words (buffer);
+ remove_all_words (buffer);
g_hash_table_destroy (buffer->priv->words);
buffer->priv->words = NULL;
}
- g_list_free_full (buffer->priv->scan_regions, (GDestroyNotify)scan_region_free);
- buffer->priv->scan_regions = NULL;
+ if (buffer->priv->scan_region != NULL)
+ {
+ gtk_text_region_destroy (buffer->priv->scan_region, TRUE);
+ buffer->priv->scan_region = NULL;
+ }
if (buffer->priv->batch_scan_id != 0)
{
@@ -289,67 +245,125 @@ add_words (GtkSourceCompletionWordsBuffer *buffer,
g_slist_free (words);
}
-static gboolean
-idle_scan_regions (GtkSourceCompletionWordsBuffer *buffer)
+/* Scan words in the region delimited by @start and @end. @start must be at the
+ * beginning of a line, and @end must be at the end of a line. Maximum
+ * @max_lines are scanned.
+ *
+ * Returns the number of lines scanned. @stop is set to the next line of the
+ * last scanned line.
+ */
+static guint
+scan_region (GtkSourceCompletionWordsBuffer *buffer,
+ GtkTextIter *start,
+ GtkTextIter *end,
+ guint max_lines,
+ GtkTextIter *stop)
{
- gboolean finished;
- guint num = buffer->priv->scan_batch_size;
+ guint nb_lines_scanned = 0;
+
+ g_assert (max_lines != 0);
+
+ if (!gtk_text_iter_starts_line (start))
+ {
+ g_warning ("scan region: 'start' doesn't start a line.");
+ gtk_text_iter_set_line_offset (start, 0);
+ }
- /* Scan some regions (maximum 'num' lines) */
- while (buffer->priv->scan_regions != NULL && num > 0)
+ if (!gtk_text_iter_ends_line (end))
{
- ScanRegion *region = buffer->priv->scan_regions->data;
- gboolean region_done = FALSE;
- GtkTextIter start;
- GtkTextIter end;
+ g_warning ("scan region: 'end' doesn't end a line.");
+ gtk_text_iter_forward_to_line_end (end);
+ }
- gtk_text_buffer_get_iter_at_mark (buffer->priv->buffer,
- &start,
- region->start);
+ while (nb_lines_scanned < max_lines &&
+ gtk_text_iter_compare (start, end) < 0)
+ {
+ GSList *words = scan_line (buffer, start);
- gtk_text_buffer_get_iter_at_mark (buffer->priv->buffer,
- &end,
- region->end);
+ /* add_words also frees the list */
+ add_words (buffer, words);
- while (TRUE)
- {
- GSList *words;
+ nb_lines_scanned++;
+ gtk_text_iter_forward_line (start);
+ }
- if (gtk_text_iter_compare (&start, &end) >= 0)
- {
- region_done = TRUE;
- break;
- }
+ *stop = *start;
+ return nb_lines_scanned;
+}
- if (num == 0)
- {
- break;
- }
+/* A TextRegion can contain empty subregions. So checking the number of
+ * subregions is not sufficient.
+ * When calling gtk_text_region_add() with equal iters, the subregion is not
+ * added. But when a subregion becomes empty, due to text deletion, the
+ * subregion is not removed from the TextRegion.
+ */
+static gboolean
+is_text_region_empty (GtkTextRegion *region)
+{
+ GtkTextRegionIterator region_iter;
- words = scan_line (buffer, &start);
+ gtk_text_region_get_iterator (region, ®ion_iter, 0);
- /* add_words also frees the list */
- add_words (buffer, words);
+ while (!gtk_text_region_iterator_is_end (®ion_iter))
+ {
+ GtkTextIter region_start;
+ GtkTextIter region_end;
- --num;
- gtk_text_iter_forward_line (&start);
- }
+ gtk_text_region_iterator_get_subregion (®ion_iter,
+ ®ion_start,
+ ®ion_end);
- if (region_done)
- {
- scan_region_free (region);
- buffer->priv->scan_regions = g_list_delete_link (buffer->priv->scan_regions,
- buffer->priv->scan_regions);
- }
- else
+ if (!gtk_text_iter_equal (®ion_start, ®ion_end))
{
- gtk_text_buffer_move_mark (buffer->priv->buffer,
- region->start,
- &start);
+ return FALSE;
}
+
+ gtk_text_region_iterator_next (®ion_iter);
}
- finished = buffer->priv->scan_regions == NULL;
+ return TRUE;
+}
+
+static gboolean
+idle_scan_regions (GtkSourceCompletionWordsBuffer *buffer)
+{
+ gboolean finished = FALSE;
+ guint nb_remaining_lines = buffer->priv->scan_batch_size;
+ GtkTextRegionIterator region_iter;
+ GtkTextIter start;
+ GtkTextIter stop;
+
+ gtk_text_buffer_get_start_iter (buffer->priv->buffer, &start);
+ stop = start;
+
+ gtk_text_region_get_iterator (buffer->priv->scan_region,
+ ®ion_iter,
+ 0);
+
+ while (nb_remaining_lines > 0 &&
+ !gtk_text_region_iterator_is_end (®ion_iter))
+ {
+ GtkTextIter region_start;
+ GtkTextIter region_end;
+
+ gtk_text_region_iterator_get_subregion (®ion_iter,
+ ®ion_start,
+ ®ion_end);
+
+ nb_remaining_lines -= scan_region (buffer,
+ ®ion_start,
+ ®ion_end,
+ nb_remaining_lines,
+ &stop);
+
+ gtk_text_region_iterator_next (®ion_iter);
+ }
+
+ gtk_text_region_subtract (buffer->priv->scan_region,
+ &start,
+ &stop);
+
+ finished = is_text_region_empty (buffer->priv->scan_region);
if (finished)
{
@@ -391,207 +405,213 @@ install_initiate_scan (GtkSourceCompletionWordsBuffer *buffer)
}
static void
-add_scan_region (GtkSourceCompletionWordsBuffer *buffer,
- GList *after,
- GtkTextIter *start,
- GtkTextIter *end,
- gboolean remove_first)
+remove_words_in_subregion (GtkSourceCompletionWordsBuffer *buffer,
+ GtkTextIter *start,
+ GtkTextIter *end)
{
- GList *next;
- ScanRegion *region;
+ GtkTextIter iter = *start;
- if (remove_first)
+ while (gtk_text_iter_compare (&iter, end) < 0)
{
- /* First remove all the words currently in the region */
- GtkTextIter cstart = *start;
+ GSList *words = scan_line (buffer, &iter);
+ GSList *item;
- while (gtk_text_iter_compare (&cstart, end) < 0)
+ for (item = words; item != NULL; item = g_slist_next (item))
{
- GSList *words = scan_line (buffer, &cstart);
- GSList *item;
-
- for (item = words; item; item = g_slist_next (item))
- {
- remove_word (buffer, item->data);
- g_free (item->data);
- }
-
- g_slist_free (words);
-
- if (!gtk_text_iter_forward_line (&cstart))
- {
- break;
- }
+ remove_word (buffer, item->data);
+ g_free (item->data);
}
+
+ g_slist_free (words);
+ gtk_text_iter_forward_line (&iter);
}
+}
- /* Then just add the scan region */
- region = scan_region_new (buffer->priv->buffer,
- start,
- end);
+static void
+remove_words_in_region (GtkSourceCompletionWordsBuffer *buffer,
+ GtkTextRegion *region)
+{
+ GtkTextRegionIterator region_iter;
+
+ gtk_text_region_get_iterator (region, ®ion_iter, 0);
- if (after == NULL)
+ while (!gtk_text_region_iterator_is_end (®ion_iter))
{
- buffer->priv->scan_regions = g_list_prepend (buffer->priv->scan_regions,
- region);
+ GtkTextIter subregion_start;
+ GtkTextIter subregion_end;
+
+ gtk_text_region_iterator_get_subregion (®ion_iter,
+ &subregion_start,
+ &subregion_end);
+
+ remove_words_in_subregion (buffer,
+ &subregion_start,
+ &subregion_end);
+
+ gtk_text_region_iterator_next (®ion_iter);
}
+}
+
+static GtkTextRegion *
+compute_remove_region (GtkSourceCompletionWordsBuffer *buffer,
+ GtkTextIter start,
+ GtkTextIter end)
+{
+ GtkTextRegion *remove_region = gtk_text_region_new (buffer->priv->buffer);
+ GtkTextRegionIterator region_iter;
+
+ gtk_text_region_add (remove_region, &start, &end);
- next = g_list_next (after);
+ gtk_text_region_get_iterator (buffer->priv->scan_region,
+ ®ion_iter,
+ 0);
- if (next != NULL)
+ while (!gtk_text_region_iterator_is_end (®ion_iter))
{
- buffer->priv->scan_regions =
- g_list_insert_before (buffer->priv->scan_regions,
- next,
- region);
+ GtkTextIter scan_start;
+ GtkTextIter scan_end;
+
+ gtk_text_region_iterator_get_subregion (®ion_iter,
+ &scan_start,
+ &scan_end);
+
+ gtk_text_region_subtract (remove_region,
+ &scan_start,
+ &scan_end);
+
+ gtk_text_region_iterator_next (®ion_iter);
}
- /* Add the initate scan timeout if it's not already running */
- install_initiate_scan (buffer);
+ return remove_region;
}
+/* If some lines between @start and @end are not in the scan region, remove the
+ * words in those lines.
+ */
static void
-remove_and_rescan (GtkSourceCompletionWordsBuffer *buffer,
+invalidate_region (GtkSourceCompletionWordsBuffer *buffer,
GtkTextIter *start,
GtkTextIter *end)
{
- GList *item;
- GtkTextIter startc = *start;
- GtkTextIter endc;
+ GtkTextIter start_iter = *start;
+ GtkTextIter end_iter = *end;
+ GtkTextRegion *remove_region;
- if (end)
+ if (!gtk_text_iter_starts_line (&start_iter))
{
- endc = *end;
- }
- else
- {
- endc = *start;
+ gtk_text_iter_set_line_offset (&start_iter, 0);
}
- if (!gtk_text_iter_starts_line (&startc))
+ if (!gtk_text_iter_ends_line (&end_iter))
{
- gtk_text_iter_set_line_offset (&startc, 0);
+ gtk_text_iter_forward_to_line_end (&end_iter);
}
- if (!gtk_text_iter_ends_line (&endc))
- {
- gtk_text_iter_forward_to_line_end (&endc);
- }
+ remove_region = compute_remove_region (buffer, start_iter, end_iter);
- for (item = buffer->priv->scan_regions; item; item = g_list_next (item))
- {
- ScanRegion *region = item->data;
- GtkTextIter region_start;
- GtkTextIter region_end;
-
- gtk_text_buffer_get_iter_at_mark (buffer->priv->buffer,
- ®ion_start,
- region->start);
+ remove_words_in_region (buffer, remove_region);
+ gtk_text_region_destroy (remove_region, TRUE);
+}
- gtk_text_buffer_get_iter_at_mark (buffer->priv->buffer,
- ®ion_end,
- region->end);
+static void
+add_to_scan_region (GtkSourceCompletionWordsBuffer *buffer,
+ GtkTextIter *start,
+ GtkTextIter *end)
+{
+ GtkTextIter start_iter = *start;
+ GtkTextIter end_iter = *end;
- if (gtk_text_iter_compare (&endc, ®ion_start) < 0)
- {
- /* Region is before */
- add_scan_region (buffer,
- g_list_previous (item),
- &startc,
- &endc,
- TRUE);
- return;
- }
- else if (gtk_text_iter_compare (&startc, ®ion_start) < 0)
- {
- GtkTextIter last;
- last = region_start;
- gtk_text_iter_backward_line (&last);
-
- /* Add region from before */
- add_scan_region (buffer,
- g_list_previous (item),
- &startc,
- &last,
- TRUE);
-
- startc = region_end;
- gtk_text_iter_forward_line (&startc);
- }
- else if (gtk_text_iter_compare (&startc, ®ion_end) < 0)
- {
- startc = region_end;
+ if (!gtk_text_iter_starts_line (&start_iter))
+ {
+ gtk_text_iter_set_line_offset (&start_iter, 0);
+ }
- if (!gtk_text_iter_forward_line (&startc))
- {
- return;
- }
- }
+ if (!gtk_text_iter_ends_line (&end_iter))
+ {
+ gtk_text_iter_forward_to_line_end (&end_iter);
+ }
- if (gtk_text_iter_compare (&startc, &endc) > 0)
- {
- return;
- }
+ gtk_text_region_add (buffer->priv->scan_region,
+ &start_iter,
+ &end_iter);
- if (!item->next)
- {
- add_scan_region (buffer,
- NULL,
- &startc,
- &endc,
- TRUE);
- return;
- }
- }
+ install_initiate_scan (buffer);
+}
- add_scan_region (buffer,
- NULL,
- &startc,
- &endc,
- TRUE);
+static void
+on_insert_text_before_cb (GtkTextBuffer *textbuffer,
+ GtkTextIter *location,
+ const gchar *text,
+ gint len,
+ GtkSourceCompletionWordsBuffer *buffer)
+{
+ invalidate_region (buffer, location, location);
}
static void
-on_insert_text_cb (GtkTextBuffer *textbuffer,
- GtkTextIter *location,
- const gchar *text,
- gint len,
- GtkSourceCompletionWordsBuffer *buffer)
+on_insert_text_after_cb (GtkTextBuffer *textbuffer,
+ GtkTextIter *location,
+ const gchar *text,
+ gint len,
+ GtkSourceCompletionWordsBuffer *buffer)
{
- remove_and_rescan (buffer, location, NULL);
+ GtkTextIter start_iter = *location;
+ gint nb_chars = g_utf8_strlen (text, -1);
+
+ gtk_text_iter_backward_chars (&start_iter, nb_chars);
+
+ /* If add_to_scan_region() is called before the text insertion, if the
+ * line is empty, the TextRegion is empty too and it is not added to the
+ * scan region. After the text insertion, we are sure that the
+ * TextRegion is not empty and that the words will be scanned.
+ */
+ add_to_scan_region (buffer, &start_iter, location);
}
static void
-on_delete_range_cb (GtkTextBuffer *text_buffer,
- GtkTextIter *start,
- GtkTextIter *end,
- GtkSourceCompletionWordsBuffer *buffer)
+on_delete_range_before_cb (GtkTextBuffer *text_buffer,
+ GtkTextIter *start,
+ GtkTextIter *end,
+ GtkSourceCompletionWordsBuffer *buffer)
{
GtkTextIter start_buf;
GtkTextIter end_buf;
- gtk_text_buffer_get_bounds (text_buffer,
- &start_buf,
- &end_buf);
+ gtk_text_buffer_get_bounds (text_buffer, &start_buf, &end_buf);
/* Special case removing all the text */
if (gtk_text_iter_equal (start, &start_buf) &&
gtk_text_iter_equal (end, &end_buf))
{
- remove_words (buffer);
- g_list_free_full (buffer->priv->scan_regions, (GDestroyNotify)scan_region_free);
- buffer->priv->scan_regions = NULL;
+ remove_all_words (buffer);
- add_scan_region (buffer, NULL, start, end, FALSE);
+ gtk_text_region_destroy (buffer->priv->scan_region, TRUE);
+ buffer->priv->scan_region = gtk_text_region_new (text_buffer);
}
else
{
- /* Remove all the words in the lines from start-to-end */
- remove_and_rescan (buffer, start, end);
+ invalidate_region (buffer, start, end);
}
}
static void
+on_delete_range_after_cb (GtkTextBuffer *text_buffer,
+ GtkTextIter *start,
+ GtkTextIter *end,
+ GtkSourceCompletionWordsBuffer *buffer)
+{
+ /* start = end, but add_to_scan_region() moves the iters to the start
+ * and the end of the line. If the line is empty, the TextRegion won't
+ * be added to the scan region. If we call add_to_scan_region() when the
+ * text is not already deleted, the TextRegion is not empty and will be
+ * added to the scan region, and when the TextRegion becomes empty after
+ * the text deletion, the TextRegion is not removed from the scan
+ * region. Hence two callbacks: before and after the text deletion.
+ */
+ add_to_scan_region (buffer, start, end);
+}
+
+static void
connect_buffer (GtkSourceCompletionWordsBuffer *buffer)
{
GtkTextIter start;
@@ -599,21 +619,37 @@ connect_buffer (GtkSourceCompletionWordsBuffer *buffer)
g_signal_connect_object (buffer->priv->buffer,
"insert-text",
- G_CALLBACK (on_insert_text_cb),
+ G_CALLBACK (on_insert_text_before_cb),
buffer,
0);
g_signal_connect_object (buffer->priv->buffer,
+ "insert-text",
+ G_CALLBACK (on_insert_text_after_cb),
+ buffer,
+ G_CONNECT_AFTER);
+
+ g_signal_connect_object (buffer->priv->buffer,
"delete-range",
- G_CALLBACK (on_delete_range_cb),
+ G_CALLBACK (on_delete_range_before_cb),
buffer,
0);
+ g_signal_connect_object (buffer->priv->buffer,
+ "delete-range",
+ G_CALLBACK (on_delete_range_after_cb),
+ buffer,
+ G_CONNECT_AFTER);
+
gtk_text_buffer_get_bounds (buffer->priv->buffer,
&start,
&end);
- add_scan_region (buffer, NULL, &start, &end, FALSE);
+ gtk_text_region_add (buffer->priv->scan_region,
+ &start,
+ &end);
+
+ install_initiate_scan (buffer);
}
static void
@@ -635,7 +671,7 @@ on_library_lock (GtkSourceCompletionWordsBuffer *buffer)
static void
on_library_unlock (GtkSourceCompletionWordsBuffer *buffer)
{
- if (buffer->priv->scan_regions != NULL)
+ if (gtk_text_region_subregions (buffer->priv->scan_region) > 0)
{
install_initiate_scan (buffer);
}
@@ -655,6 +691,8 @@ gtk_source_completion_words_buffer_new (GtkSourceCompletionWordsLibrary *library
ret->priv->library = g_object_ref (library);
ret->priv->buffer = g_object_ref (buffer);
+ ret->priv->scan_region = gtk_text_region_new (buffer);
+
g_signal_connect_object (ret->priv->library,
"lock",
G_CALLBACK (on_library_lock),
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
