2 * @file libsexy/sexy-icon-entry.c Entry widget
4 * @Copyright (C) 2004-2006 Christian Hammond.
5 * Some of this code is from gtkspell, Copyright (C) 2002 Evan Martin.
6 * Adapted for Claws Mail (c) 2009-2012 Pawel Pekala and the Claws Mail team
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 #include <glib/gi18n.h>
33 #include <gdk/gdkkeysyms.h>
39 #include "spell_entry.h"
40 #include "prefs_common.h"
45 static void claws_spell_entry_init (ClawsSpellEntry *entry);
46 static void claws_spell_entry_editable_init (GtkEditableClass *iface);
47 static void claws_spell_entry_finalize (GObject *object);
48 #if !GTK_CHECK_VERSION(3, 0, 0)
49 static void claws_spell_entry_destroy (GtkObject *object);
50 static gint claws_spell_entry_expose (GtkWidget *widget,
51 GdkEventExpose *event);
53 static void claws_spell_entry_destroy (GtkWidget *object);
54 static gint claws_spell_entry_expose (GtkWidget *widget,
57 static gint claws_spell_entry_button_press (GtkWidget *widget,
58 GdkEventButton *event);
59 static gboolean claws_spell_entry_popup_menu (GtkWidget *widget,
60 ClawsSpellEntry *entry);
61 static void claws_spell_entry_populate_popup (ClawsSpellEntry *entry,
64 static void claws_spell_entry_changed (GtkEditable *editable,
67 struct _ClawsSpellEntryPriv
69 PangoAttrList *attr_list;
76 static GtkEntryClass *parent_class = NULL;
79 G_DEFINE_TYPE_EXTENDED(ClawsSpellEntry, claws_spell_entry, GTK_TYPE_ENTRY, 0, G_IMPLEMENT_INTERFACE(GTK_TYPE_EDITABLE, claws_spell_entry_editable_init));
82 static void claws_spell_entry_class_init(ClawsSpellEntryClass *klass)
84 GObjectClass *g_object_class;
85 #if !GTK_CHECK_VERSION(3, 0, 0)
86 GtkObjectClass *gtk_object_class;
88 GtkWidgetClass *widget_class;
90 parent_class = g_type_class_peek_parent(klass);
92 g_object_class = G_OBJECT_CLASS(klass);
93 g_object_class->finalize = claws_spell_entry_finalize;
95 #if !GTK_CHECK_VERSION(3, 0, 0)
96 gtk_object_class = GTK_OBJECT_CLASS(klass);
97 gtk_object_class->destroy = claws_spell_entry_destroy;
100 widget_class = GTK_WIDGET_CLASS(klass);
101 widget_class->button_press_event = claws_spell_entry_button_press;
102 #if !GTK_CHECK_VERSION(3, 0, 0)
103 widget_class->expose_event = claws_spell_entry_expose;
105 widget_class->draw = claws_spell_entry_expose;
106 widget_class->destroy = claws_spell_entry_destroy;
109 g_type_class_add_private(g_object_class,
110 sizeof(struct _ClawsSpellEntryPriv));
113 static void claws_spell_entry_init(ClawsSpellEntry *entry)
115 entry->gtkaspell = NULL;
117 entry->priv = g_new0(ClawsSpellEntryPriv, 1);
118 entry->priv->attr_list = pango_attr_list_new();
120 g_signal_connect(G_OBJECT(entry), "popup-menu",
121 G_CALLBACK(claws_spell_entry_popup_menu), entry);
122 g_signal_connect(G_OBJECT(entry), "populate-popup",
123 G_CALLBACK(claws_spell_entry_populate_popup), NULL);
124 g_signal_connect(G_OBJECT(entry), "changed",
125 G_CALLBACK(claws_spell_entry_changed), NULL);
128 static void claws_spell_entry_editable_init (GtkEditableClass *iface) {}
130 static void claws_spell_entry_finalize(GObject *object)
132 ClawsSpellEntry *entry = CLAWS_SPELL_ENTRY(object);
134 if (entry->priv->attr_list)
135 pango_attr_list_unref(entry->priv->attr_list);
136 if (entry->priv->words)
137 g_strfreev(entry->priv->words);
139 g_free(entry->priv->word_starts);
140 g_free(entry->priv->word_ends);
144 G_OBJECT_CLASS(parent_class)->finalize(object);
147 #if !GTK_CHECK_VERSION(3, 0, 0)
148 static void claws_spell_entry_destroy(GtkObject *object)
150 GTK_OBJECT_CLASS(parent_class)->destroy(object);
153 static void claws_spell_entry_destroy(GtkWidget *object)
155 GTK_WIDGET_CLASS(parent_class)->destroy(object);
159 GtkWidget *claws_spell_entry_new(void)
161 return GTK_WIDGET( g_object_new(CLAWS_TYPE_SPELL_ENTRY, NULL) );
164 void claws_spell_entry_set_gtkaspell(ClawsSpellEntry *entry, GtkAspell *gtkaspell)
166 cm_return_if_fail(CLAWS_IS_SPELL_ENTRY(entry));
168 entry->gtkaspell = gtkaspell;
171 static gint gtk_entry_find_position (GtkEntry *entry, gint x)
174 PangoLayoutLine *line;
181 x = x + entry->scroll_offset;
183 layout = gtk_entry_get_layout(entry);
184 text = pango_layout_get_text(layout);
185 cursor_index = g_utf8_offset_to_pointer(text, entry->current_pos) - text;
187 line = pango_layout_get_lines(layout)->data;
188 pango_layout_line_x_to_index(line, x * PANGO_SCALE, &index, &trailing);
190 if (index >= cursor_index && entry->preedit_length) {
191 if (index >= cursor_index + entry->preedit_length) {
192 index -= entry->preedit_length;
194 index = cursor_index;
199 pos = g_utf8_pointer_to_offset (text, text + index);
205 static void get_word_extents_from_position(ClawsSpellEntry *entry, gint *start,
206 gint *end, guint position)
214 if (entry->priv->words == NULL)
217 text = gtk_entry_get_text(GTK_ENTRY(entry));
218 bytes_pos = (gint) (g_utf8_offset_to_pointer(text, position) - text);
220 for (i = 0; entry->priv->words[i]; i++) {
221 if (bytes_pos >= entry->priv->word_starts[i] &&
222 bytes_pos <= entry->priv->word_ends[i]) {
223 *start = entry->priv->word_starts[i];
224 *end = entry->priv->word_ends[i];
230 static gchar *get_word(ClawsSpellEntry *entry, const int start, const int end)
238 text = gtk_entry_get_text(GTK_ENTRY(entry));
239 word = g_new0(gchar, end - start + 2);
240 g_strlcpy(word, text + start, end - start + 1);
245 static void replace_word(ClawsSpellEntry *entry, const gchar *newword)
247 gint cursor, start_pos, end_pos;
248 const gchar *text = gtk_entry_get_text(GTK_ENTRY(entry));
250 start_pos = entry->gtkaspell->start_pos;
251 end_pos = entry->gtkaspell->end_pos;
253 cursor = gtk_editable_get_position(GTK_EDITABLE(entry));
254 /* is the cursor at the end? If so, restore it there */
255 if (g_utf8_strlen(text, -1) == cursor)
257 else if(cursor < entry->priv->mark_character ||
258 cursor > entry->priv->mark_character)
259 cursor = entry->priv->mark_character;
261 gtk_editable_delete_text(GTK_EDITABLE(entry), start_pos, end_pos);
262 gtk_editable_insert_text(GTK_EDITABLE(entry), newword, strlen(newword),
264 gtk_editable_set_position(GTK_EDITABLE(entry), cursor);
268 static gboolean word_misspelled(ClawsSpellEntry *entry, int start, int end)
273 word = get_word(entry, start, end);
274 if (word == NULL || g_unichar_isdigit(word[0]))
277 ret = gtkaspell_misspelled_test(entry->gtkaspell, word);
283 static gboolean is_word_end (GtkEntry *entry, const int offset)
285 gchar *p = gtk_editable_get_chars(GTK_EDITABLE(entry), offset, offset+1);
288 ch = g_utf8_get_char(p);
295 p = gtk_editable_get_chars(GTK_EDITABLE(entry), offset+1, offset+2);
296 ch = g_utf8_get_char(p);
299 return (g_unichar_isspace(ch) || g_unichar_ispunct(ch)
300 || g_unichar_isdigit(ch));
303 return (g_unichar_isspace(ch) || g_unichar_ispunct(ch));
306 static void entry_strsplit_utf8(GtkEntry *entry, gchar ***set, gint **starts, gint **ends)
309 PangoLogAttr *log_attrs;
311 gint n_attrs, n_strings, i, j;
313 layout = gtk_entry_get_layout(GTK_ENTRY(entry));
314 text = gtk_entry_get_text(GTK_ENTRY(entry));
315 pango_layout_get_log_attrs(layout, &log_attrs, &n_attrs);
317 /* Find how many words we have */
319 for (i = 0; i < n_attrs; i++)
320 if (log_attrs[i].is_word_start)
323 *set = g_new0(gchar *, n_strings + 1);
324 *starts = g_new0(gint, n_strings);
325 *ends = g_new0(gint, n_strings);
327 /* Copy out strings */
328 for (i = 0, j = 0; i < n_attrs; i++) {
329 if (log_attrs[i].is_word_start) {
333 /* Find the end of this string */
335 while (!is_word_end(entry, cend))
338 /* Copy sub-string */
339 start = g_utf8_offset_to_pointer(text, i);
340 bytes = (gint) (g_utf8_offset_to_pointer(text, cend) - start);
341 (*set)[j] = g_new0(gchar, bytes + 1);
342 (*starts)[j] = (gint) (start - text);
343 (*ends)[j] = (gint) (start - text + bytes);
344 g_utf8_strncpy((*set)[j], start, cend - i);
346 /* Move on to the next word */
354 static void insert_misspelled_marker(ClawsSpellEntry *entry, guint start, guint end)
356 guint16 red = (guint16) (((gdouble)((prefs_common.misspelled_col &
357 0xff0000) >> 16) / 255.0) * 65535.0);
358 guint16 green = (guint16) (((gdouble)((prefs_common.misspelled_col &
359 0x00ff00) >> 8) / 255.0) * 65535.0);
360 guint16 blue = (guint16) (((gdouble) (prefs_common.misspelled_col &
361 0x0000ff) / 255.0) * 65535.0);
362 PangoAttribute *fcolor, *ucolor, *unline;
364 if(prefs_common.misspelled_col != 0) {
365 fcolor = pango_attr_foreground_new(red, green, blue);
366 fcolor->start_index = start;
367 fcolor->end_index = end;
369 pango_attr_list_insert(entry->priv->attr_list, fcolor);
371 ucolor = pango_attr_underline_color_new (65535, 0, 0);
372 unline = pango_attr_underline_new (PANGO_UNDERLINE_ERROR);
374 ucolor->start_index = start;
375 unline->start_index = start;
377 ucolor->end_index = end;
378 unline->end_index = end;
380 pango_attr_list_insert (entry->priv->attr_list, ucolor);
381 pango_attr_list_insert (entry->priv->attr_list, unline);
385 static gboolean check_word(ClawsSpellEntry *entry, int start, int end)
387 GtkAspell *gtkaspell = entry->gtkaspell;
388 PangoAttrIterator *it;
391 gchar *text = gtk_editable_get_chars(GTK_EDITABLE(entry), 0, -1);
394 /* Check to see if we've got any attributes at this position.
395 * If so, free them, since we'll readd it if the word is misspelled */
396 it = pango_attr_list_get_iterator(entry->priv->attr_list);
400 pango_attr_iterator_range(it, &s, &e);
402 GSList *attrs = pango_attr_iterator_get_attrs(it);
403 g_slist_foreach(attrs, (GFunc) pango_attribute_destroy, NULL);
406 } while (pango_attr_iterator_next(it));
407 pango_attr_iterator_destroy(it);
409 if ((misspelled = word_misspelled(entry, start, end))) {
410 insert_misspelled_marker(entry, start, end);
412 word = get_word(entry, start, end);
413 strncpy(gtkaspell->theword, (gchar *)word, GTKASPELLWORDSIZE - 1);
414 gtkaspell->theword[GTKASPELLWORDSIZE - 1] = 0;
415 gtkaspell->start_pos = g_utf8_pointer_to_offset(text, (text+start));
416 gtkaspell->end_pos = g_utf8_pointer_to_offset(text, (text+end));
417 gtkaspell_free_suggestions_list(gtkaspell);
426 void claws_spell_entry_recheck_all(ClawsSpellEntry *entry)
432 cm_return_if_fail(CLAWS_IS_SPELL_ENTRY(entry));
433 cm_return_if_fail(entry->gtkaspell != NULL);
435 if (entry->priv->words == NULL)
438 /* Remove all existing pango attributes. These will get readded as we check */
439 pango_attr_list_unref(entry->priv->attr_list);
440 entry->priv->attr_list = pango_attr_list_new();
442 /* Loop through words */
443 for (i = 0; entry->priv->words[i]; i++) {
444 length = strlen(entry->priv->words[i]);
447 check_word(entry, entry->priv->word_starts[i], entry->priv->word_ends[i]);
450 layout = gtk_entry_get_layout(GTK_ENTRY(entry));
451 pango_layout_set_attributes(layout, entry->priv->attr_list);
453 if (gtk_widget_get_realized(GTK_WIDGET(entry))) {
454 rect.x = 0; rect.y = 0;
455 rect.width = GTK_WIDGET(entry)->allocation.width;
456 rect.height = GTK_WIDGET(entry)->allocation.height;
457 gdk_window_invalidate_rect(GTK_WIDGET(entry)->window, &rect, TRUE);
461 #if !GTK_CHECK_VERSION(3, 0, 0)
462 static gint claws_spell_entry_expose(GtkWidget *widget, GdkEventExpose *event)
464 static gint claws_spell_entry_expose(GtkWidget *widget, cairo_t *cr)
467 ClawsSpellEntry *entry = CLAWS_SPELL_ENTRY(widget);
468 GtkEntry *gtk_entry = GTK_ENTRY(widget);
471 if (entry->gtkaspell != NULL) {
472 layout = gtk_entry_get_layout(gtk_entry);
473 pango_layout_set_attributes(layout, entry->priv->attr_list);
476 #if !GTK_CHECK_VERSION(3, 0, 0)
477 return GTK_WIDGET_CLASS(parent_class)->expose_event (widget, event);
479 return GTK_WIDGET_CLASS(parent_class)->draw (widget, cr);
483 static gint claws_spell_entry_button_press(GtkWidget *widget, GdkEventButton *event)
485 ClawsSpellEntry *entry = CLAWS_SPELL_ENTRY(widget);
486 GtkEntry *gtk_entry = GTK_ENTRY(widget);
489 pos = gtk_entry_find_position(gtk_entry, event->x);
490 entry->priv->mark_character = pos;
492 return GTK_WIDGET_CLASS(parent_class)->button_press_event (widget, event);
495 static gboolean claws_spell_entry_popup_menu(GtkWidget *widget, ClawsSpellEntry *entry)
497 entry->priv->mark_character = gtk_editable_get_position (GTK_EDITABLE (entry));
501 static void set_position(gpointer data, gint pos)
503 gtk_editable_set_position(GTK_EDITABLE(data), pos);
506 static gboolean find_misspelled_cb(gpointer data, gboolean forward)
508 ClawsSpellEntry *entry = (ClawsSpellEntry *)data;
509 GtkAspell *gtkaspell = entry->gtkaspell;
510 gboolean misspelled = FALSE;
511 gint cursor, minpos, maxpos, i, words_len = 0;
515 if (entry->priv->words == NULL)
518 gtkaspell->orig_pos = gtk_editable_get_position(GTK_EDITABLE(entry));
519 text = gtk_editable_get_chars(GTK_EDITABLE(entry), 0, -1);
520 cursor = g_utf8_offset_to_pointer(text, gtkaspell->orig_pos) - text;
522 if (gtk_editable_get_selection_bounds(GTK_EDITABLE(entry), &start, &end)) {
523 minpos = g_utf8_offset_to_pointer(text, start) - text;
524 maxpos = g_utf8_offset_to_pointer(text, end) - text;
526 minpos = forward ? cursor : 0;
527 maxpos = forward ? strlen(text)-1 : cursor;
531 while(entry->priv->words[words_len])
535 for(i=0; i < words_len; i++)
536 if (entry->priv->word_ends[i] > minpos &&
537 (misspelled = check_word(entry,
538 entry->priv->word_starts[i],
539 entry->priv->word_ends[i])))
542 for(i=words_len-1; i >= 0; i--)
543 if (entry->priv->word_starts[i] < maxpos &&
544 (misspelled = check_word(entry,
545 entry->priv->word_starts[i],
546 entry->priv->word_ends[i])))
553 static gboolean check_word_cb(gpointer data)
555 ClawsSpellEntry *entry = (ClawsSpellEntry *)data;
558 get_word_extents_from_position(entry, &start, &end, entry->priv->mark_character);
559 return check_word(entry, start, end);
562 static void replace_word_cb(gpointer data, const gchar *newword)
564 replace_word((ClawsSpellEntry *) data, newword);
567 static void set_menu_pos(GtkMenu *menu, gint *x, gint *y,
568 gboolean *push_in, gpointer data)
570 ClawsSpellEntry *entry = (ClawsSpellEntry *) data;
571 GtkAspell *gtkaspell = entry->gtkaspell;
572 gint pango_offset, win_x, win_y, scr_x, scr_y, text_index, entry_x;
574 GtkRequisition subject_rq;
575 PangoLayout *layout = gtk_entry_get_layout(GTK_ENTRY(entry));
576 PangoLayoutLine *line = pango_layout_get_lines(layout)->data;
578 gtk_widget_get_child_requisition(GTK_WIDGET(entry), &subject_rq);
580 /* screen -> compose window coords */
581 gdk_window_get_origin(GTK_WIDGET(gtkaspell->parent_window)->window,
584 /* compose window -> subject entry coords */
585 gtk_widget_translate_coordinates(GTK_WIDGET(entry),
586 gtkaspell->parent_window, 0, 0, &win_x, &win_y);
588 text = gtk_editable_get_chars(GTK_EDITABLE(entry), 0, -1);
589 text_index = g_utf8_offset_to_pointer(text, gtkaspell->end_pos) - text;
592 pango_offset = gtk_entry_text_index_to_layout_index(GTK_ENTRY(entry),
594 pango_layout_line_index_to_x(line, pango_offset, TRUE, &entry_x);
596 *x = scr_x + win_x + PANGO_PIXELS(entry_x) + 8;
597 *y = scr_y + win_y + subject_rq.height;
600 void claws_spell_entry_context_set(ClawsSpellEntry *entry)
602 cm_return_if_fail(CLAWS_IS_SPELL_ENTRY(entry));
603 cm_return_if_fail(entry->gtkaspell != NULL);
605 entry->gtkaspell->ctx.set_position = set_position;
606 entry->gtkaspell->ctx.set_menu_pos = set_menu_pos;
607 entry->gtkaspell->ctx.find_misspelled = find_misspelled_cb;
608 entry->gtkaspell->ctx.check_word = check_word_cb;
609 entry->gtkaspell->ctx.replace_word = replace_word_cb;
610 entry->gtkaspell->ctx.data = (gpointer) entry;
613 static void claws_spell_entry_populate_popup(ClawsSpellEntry *entry, GtkMenu *menu,
616 GtkAspell *gtkaspell = entry->gtkaspell;
620 if (gtkaspell == NULL)
623 get_word_extents_from_position(entry, &start, &end, entry->priv->mark_character);
625 if ((word = get_word(entry, start, end)) != NULL) {
626 strncpy(gtkaspell->theword, word, GTKASPELLWORDSIZE - 1);
630 gtkaspell->misspelled = word_misspelled(entry, start, end);
632 text = gtk_editable_get_chars(GTK_EDITABLE(entry), 0, -1);
633 gtkaspell->start_pos = g_utf8_pointer_to_offset(text, (text+start));
634 gtkaspell->end_pos = g_utf8_pointer_to_offset(text, (text+end));
637 claws_spell_entry_context_set(entry);
638 gtkaspell_make_context_menu(menu, gtkaspell);
641 static void claws_spell_entry_changed(GtkEditable *editable, gpointer data)
643 ClawsSpellEntry *entry = CLAWS_SPELL_ENTRY(editable);
645 if (entry->gtkaspell == NULL)
648 if (entry->priv->words) {
649 g_strfreev(entry->priv->words);
650 g_free(entry->priv->word_starts);
651 g_free(entry->priv->word_ends);
653 entry_strsplit_utf8(GTK_ENTRY(entry), &entry->priv->words,
654 &entry->priv->word_starts, &entry->priv->word_ends);
655 if(entry->gtkaspell->check_while_typing == TRUE)
656 claws_spell_entry_recheck_all(entry);
659 static void continue_check(gpointer *data)
661 ClawsSpellEntry *entry = (ClawsSpellEntry *)data;
662 GtkAspell *gtkaspell = entry->gtkaspell;
663 gint pos = gtk_editable_get_position(GTK_EDITABLE(entry));
665 if (gtkaspell->misspelled && pos < gtkaspell->end_check_pos)
666 gtkaspell->misspelled = gtkaspell_check_next_prev(gtkaspell, TRUE);
668 gtkaspell->continue_check = NULL;
671 void claws_spell_entry_check_all(ClawsSpellEntry *entry)
676 cm_return_if_fail(CLAWS_IS_SPELL_ENTRY(entry));
677 cm_return_if_fail(entry->gtkaspell != NULL);
679 if (!gtk_editable_get_selection_bounds(GTK_EDITABLE(entry), &start, &end)) {
680 text = gtk_editable_get_chars(GTK_EDITABLE(entry), 0, -1);
683 end = g_utf8_strlen(text, -1) - 1;
688 gtk_editable_set_position(GTK_EDITABLE(entry), start);
689 entry->gtkaspell->continue_check = continue_check;
690 entry->gtkaspell->end_check_pos = end;
692 claws_spell_entry_context_set(entry);
693 entry->gtkaspell->misspelled =
694 gtkaspell_check_next_prev(entry->gtkaspell, TRUE);
697 void claws_spell_entry_check_backwards(ClawsSpellEntry *entry)
699 cm_return_if_fail(CLAWS_IS_SPELL_ENTRY(entry));
700 cm_return_if_fail(entry->gtkaspell != NULL);
702 entry->gtkaspell->continue_check = NULL;
703 claws_spell_entry_context_set(entry);
704 gtkaspell_check_next_prev(entry->gtkaspell, FALSE);
707 void claws_spell_entry_check_forwards_go(ClawsSpellEntry *entry)
709 cm_return_if_fail(CLAWS_IS_SPELL_ENTRY(entry));
710 cm_return_if_fail(entry->gtkaspell != NULL);
712 entry->gtkaspell->continue_check = NULL;
713 claws_spell_entry_context_set(entry);
714 gtkaspell_check_next_prev(entry->gtkaspell, TRUE);
717 #endif /* USE_ENCHANT */