2 * Copyright (C) 2010 Collabora Ltd.
3 * Copyright (C) 2007-2010 Nokia Corporation.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library 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 GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Authors: Felix Kaser <felix.kaser@collabora.co.uk>
20 * Xavier Claessens <xavier.claessens@collabora.co.uk>
21 * Claudio Saavedra <csaavedra@igalia.com>
28 #include <gdk/gdkkeysyms.h>
30 #include <libempathy/empathy-utils.h>
32 #include "empathy-live-search.h"
33 #include "empathy-gtk-marshal.h"
35 G_DEFINE_TYPE (EmpathyLiveSearch, empathy_live_search, GTK_TYPE_HBOX)
37 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyLiveSearch)
41 GtkWidget *search_entry;
42 GtkWidget *hook_widget;
44 GPtrArray *stripped_words;
45 } EmpathyLiveSearchPriv;
61 static guint signals[LAST_SIGNAL];
63 static void live_search_hook_widget_destroy_cb (GtkWidget *object,
69 * Returns a stripped version of @ch, removing any case, accentuation
70 * mark, or any special mark on it.
73 stripped_char (gunichar ch)
80 utype = g_unichar_type (ch);
84 case G_UNICODE_CONTROL:
85 case G_UNICODE_FORMAT:
86 case G_UNICODE_UNASSIGNED:
87 case G_UNICODE_NON_SPACING_MARK:
88 case G_UNICODE_COMBINING_MARK:
89 case G_UNICODE_ENCLOSING_MARK:
92 case G_UNICODE_PRIVATE_USE:
93 case G_UNICODE_SURROGATE:
94 case G_UNICODE_LOWERCASE_LETTER:
95 case G_UNICODE_MODIFIER_LETTER:
96 case G_UNICODE_OTHER_LETTER:
97 case G_UNICODE_TITLECASE_LETTER:
98 case G_UNICODE_UPPERCASE_LETTER:
99 case G_UNICODE_DECIMAL_NUMBER:
100 case G_UNICODE_LETTER_NUMBER:
101 case G_UNICODE_OTHER_NUMBER:
102 case G_UNICODE_CONNECT_PUNCTUATION:
103 case G_UNICODE_DASH_PUNCTUATION:
104 case G_UNICODE_CLOSE_PUNCTUATION:
105 case G_UNICODE_FINAL_PUNCTUATION:
106 case G_UNICODE_INITIAL_PUNCTUATION:
107 case G_UNICODE_OTHER_PUNCTUATION:
108 case G_UNICODE_OPEN_PUNCTUATION:
109 case G_UNICODE_CURRENCY_SYMBOL:
110 case G_UNICODE_MODIFIER_SYMBOL:
111 case G_UNICODE_MATH_SYMBOL:
112 case G_UNICODE_OTHER_SYMBOL:
113 case G_UNICODE_LINE_SEPARATOR:
114 case G_UNICODE_PARAGRAPH_SEPARATOR:
115 case G_UNICODE_SPACE_SEPARATOR:
117 ch = g_unichar_tolower (ch);
118 decomp = g_unicode_canonical_decomposition (ch, &dlen);
130 append_word (GPtrArray **word_array,
135 if (*word_array == NULL)
136 *word_array = g_ptr_array_new_with_free_func (g_free);
137 g_ptr_array_add (*word_array, g_string_free (*word, FALSE));
143 strip_utf8_string (const gchar *string)
145 GPtrArray *word_array = NULL;
146 GString *word = NULL;
149 if (EMP_STR_EMPTY (string))
152 for (p = string; *p != '\0'; p = g_utf8_next_char (p))
156 /* Make the char lower-case, remove its accentuation marks, and ignore it
157 * if it is just unicode marks */
158 sc = stripped_char (g_utf8_get_char (p));
162 /* If it is not alpha-num, it is separator between words */
163 if (!g_unichar_isalnum (sc))
165 append_word (&word_array, &word);
169 /* It is alpha-num, append this char to current word, or start new word */
171 word = g_string_new (NULL);
172 g_string_append_unichar (word, sc);
175 append_word (&word_array, &word);
181 live_search_match_prefix (const gchar *string,
185 const gchar *prefix_p;
186 gboolean next_word = FALSE;
188 if (prefix == NULL || prefix[0] == 0)
191 if (EMP_STR_EMPTY (string))
195 for (p = string; *p != '\0'; p = g_utf8_next_char (p))
199 /* Make the char lower-case, remove its accentuation marks, and ignore it
200 * if it is just unicode marks */
201 sc = stripped_char (g_utf8_get_char (p));
205 /* If we want to go to next word, ignore alpha-num chars */
206 if (next_word && g_unichar_isalnum (sc))
210 /* Ignore word separators */
211 if (!g_unichar_isalnum (sc))
214 /* If this char does not match prefix_p, go to next word and start again
215 * from the beginning of prefix */
216 if (sc != g_utf8_get_char (prefix_p))
223 /* prefix_p match, verify to next char. If this was the last of prefix,
224 * it means it completely machted and we are done. */
225 prefix_p = g_utf8_next_char (prefix_p);
226 if (*prefix_p == '\0')
234 live_search_match_words (const gchar *string,
242 for (i = 0; i < words->len; i++)
243 if (!live_search_match_prefix (string, g_ptr_array_index (words, i)))
250 live_search_entry_key_pressed_cb (GtkEntry *entry,
254 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
257 /* if esc key pressed, hide the search */
258 if (event->keyval == GDK_KEY_Escape)
260 gtk_widget_hide (GTK_WIDGET (self));
264 /* emit key navigation signal, so other widgets can respond to it properly */
265 if (event->keyval == GDK_KEY_Up || event->keyval == GDK_KEY_Down
266 || event->keyval == GDK_KEY_Left || event->keyval == GDK_KEY_Right)
268 g_signal_emit (self, signals[KEYNAV], 0, event, &ret);
276 live_search_text_changed (GtkEntry *entry,
279 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
280 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
283 text = gtk_entry_get_text (entry);
285 if (EMP_STR_EMPTY (text))
286 gtk_widget_hide (GTK_WIDGET (self));
288 gtk_widget_show (GTK_WIDGET (self));
290 if (priv->stripped_words != NULL)
291 g_ptr_array_unref (priv->stripped_words);
293 priv->stripped_words = strip_utf8_string (text);
295 g_object_notify (G_OBJECT (self), "text");
299 live_search_close_pressed (GtkEntry *entry,
300 GtkEntryIconPosition icon_pos,
304 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
306 gtk_widget_hide (GTK_WIDGET (self));
310 live_search_key_press_event_cb (GtkWidget *widget,
314 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
315 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
319 /* dont forward this event to the entry, else the event is consumed by the
320 * entry and does not close the window */
321 if (!gtk_widget_get_visible (GTK_WIDGET (self)) &&
322 event->keyval == GDK_KEY_Escape)
325 /* do not show the search if CTRL and/or ALT are pressed with a key
326 * this is needed, because otherwise the CTRL + F accel would not work,
327 * because the entry consumes it */
328 if (event->state & (GDK_MOD1_MASK | GDK_CONTROL_MASK) ||
329 event->keyval == GDK_KEY_Control_L ||
330 event->keyval == GDK_KEY_Control_R)
333 /* dont forward the up and down arrow keys to the entry, they are needed for
334 * navigation in the treeview and are not needed in the search entry */
335 if (event->keyval == GDK_KEY_Up || event->keyval == GDK_KEY_Down)
338 /* realize the widget if it is not realized yet */
339 gtk_widget_realize (priv->search_entry);
340 if (!gtk_widget_has_focus (priv->search_entry))
342 gtk_widget_grab_focus (priv->search_entry);
343 gtk_editable_set_position (GTK_EDITABLE (priv->search_entry), -1);
346 /* forward the event to the search entry */
347 new_event = gdk_event_copy ((GdkEvent *) event);
348 ret = gtk_widget_event (priv->search_entry, new_event);
349 gdk_event_free (new_event);
355 live_search_entry_activate_cb (GtkEntry *entry,
356 EmpathyLiveSearch *self)
358 g_signal_emit (self, signals[ACTIVATE], 0);
362 live_search_release_hook_widget (EmpathyLiveSearch *self)
364 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
366 /* remove old handlers if old source was not null */
367 if (priv->hook_widget != NULL)
369 g_signal_handlers_disconnect_by_func (priv->hook_widget,
370 live_search_key_press_event_cb, self);
371 g_signal_handlers_disconnect_by_func (priv->hook_widget,
372 live_search_hook_widget_destroy_cb, self);
373 g_object_unref (priv->hook_widget);
374 priv->hook_widget = NULL;
379 live_search_hook_widget_destroy_cb (GtkWidget *object,
382 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
384 /* unref the hook widget and hide search */
385 gtk_widget_hide (GTK_WIDGET (self));
386 live_search_release_hook_widget (self);
390 live_search_dispose (GObject *obj)
392 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (obj);
394 live_search_release_hook_widget (self);
396 if (G_OBJECT_CLASS (empathy_live_search_parent_class)->dispose != NULL)
397 G_OBJECT_CLASS (empathy_live_search_parent_class)->dispose (obj);
401 live_search_finalize (GObject *obj)
403 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (obj);
404 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
406 if (priv->stripped_words != NULL)
407 g_ptr_array_unref (priv->stripped_words);
409 if (G_OBJECT_CLASS (empathy_live_search_parent_class)->finalize != NULL)
410 G_OBJECT_CLASS (empathy_live_search_parent_class)->finalize (obj);
414 live_search_get_property (GObject *object,
419 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (object);
423 case PROP_HOOK_WIDGET:
424 g_value_set_object (value, empathy_live_search_get_hook_widget (self));
427 g_value_set_string (value, empathy_live_search_get_text (self));
430 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
436 live_search_set_property (GObject *object,
441 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (object);
444 case PROP_HOOK_WIDGET:
445 empathy_live_search_set_hook_widget (self, g_value_get_object (value));
448 empathy_live_search_set_text (self, g_value_get_string (value));
451 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
457 live_search_hide (GtkWidget *widget)
459 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (widget);
460 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
462 GTK_WIDGET_CLASS (empathy_live_search_parent_class)->hide (widget);
464 gtk_entry_set_text (GTK_ENTRY (priv->search_entry), "");
465 gtk_widget_grab_focus (priv->hook_widget);
469 live_search_show (GtkWidget *widget)
471 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (widget);
472 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
474 if (!gtk_widget_has_focus (priv->search_entry))
475 gtk_widget_grab_focus (priv->search_entry);
477 GTK_WIDGET_CLASS (empathy_live_search_parent_class)->show (widget);
481 live_search_grab_focus (GtkWidget *widget)
483 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (widget);
484 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
486 if (!gtk_widget_has_focus (priv->search_entry))
488 gtk_widget_grab_focus (priv->search_entry);
489 gtk_editable_set_position (GTK_EDITABLE (priv->search_entry), -1);
494 empathy_live_search_class_init (EmpathyLiveSearchClass *klass)
496 GObjectClass *object_class = (GObjectClass *) klass;
497 GtkWidgetClass *widget_class = (GtkWidgetClass *) klass;
498 GParamSpec *param_spec;
500 object_class->finalize = live_search_finalize;
501 object_class->dispose = live_search_dispose;
502 object_class->get_property = live_search_get_property;
503 object_class->set_property = live_search_set_property;
505 widget_class->hide = live_search_hide;
506 widget_class->show = live_search_show;
507 widget_class->grab_focus = live_search_grab_focus;
509 signals[ACTIVATE] = g_signal_new ("activate",
510 G_TYPE_FROM_CLASS (object_class),
514 g_cclosure_marshal_VOID__VOID,
517 signals[KEYNAV] = g_signal_new ("key-navigation",
518 G_TYPE_FROM_CLASS (object_class),
521 g_signal_accumulator_true_handled, NULL,
522 _empathy_gtk_marshal_BOOLEAN__BOXED,
523 G_TYPE_BOOLEAN, 1, GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
525 param_spec = g_param_spec_object ("hook-widget", "Live Search Hook Widget",
526 "The live search catches key-press-events on this widget",
527 GTK_TYPE_WIDGET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
528 g_object_class_install_property (object_class, PROP_HOOK_WIDGET,
531 param_spec = g_param_spec_string ("text", "Live Search Text",
532 "The text of the live search entry",
533 "", G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
534 g_object_class_install_property (object_class, PROP_TEXT, param_spec);
536 g_type_class_add_private (klass, sizeof (EmpathyLiveSearchPriv));
540 empathy_live_search_init (EmpathyLiveSearch *self)
542 EmpathyLiveSearchPriv *priv =
543 G_TYPE_INSTANCE_GET_PRIVATE ((self), EMPATHY_TYPE_LIVE_SEARCH,
544 EmpathyLiveSearchPriv);
546 gtk_widget_set_no_show_all (GTK_WIDGET (self), TRUE);
548 priv->search_entry = gtk_entry_new ();
549 gtk_entry_set_icon_from_stock (GTK_ENTRY (priv->search_entry),
550 GTK_ENTRY_ICON_SECONDARY, GTK_STOCK_CLOSE);
551 gtk_entry_set_icon_activatable (GTK_ENTRY (priv->search_entry),
552 GTK_ENTRY_ICON_SECONDARY, TRUE);
553 gtk_entry_set_icon_sensitive (GTK_ENTRY (priv->search_entry),
554 GTK_ENTRY_ICON_SECONDARY, TRUE);
555 gtk_widget_show (priv->search_entry);
557 gtk_box_pack_start (GTK_BOX (self), priv->search_entry, TRUE, TRUE, 0);
559 g_signal_connect (priv->search_entry, "icon_release",
560 G_CALLBACK (live_search_close_pressed), self);
561 g_signal_connect (priv->search_entry, "changed",
562 G_CALLBACK (live_search_text_changed), self);
563 g_signal_connect (priv->search_entry, "key-press-event",
564 G_CALLBACK (live_search_entry_key_pressed_cb), self);
565 g_signal_connect (priv->search_entry, "activate",
566 G_CALLBACK (live_search_entry_activate_cb), self);
568 priv->hook_widget = NULL;
574 empathy_live_search_new (GtkWidget *hook)
576 g_return_val_if_fail (hook == NULL || GTK_IS_WIDGET (hook), NULL);
578 return g_object_new (EMPATHY_TYPE_LIVE_SEARCH,
586 empathy_live_search_get_hook_widget (EmpathyLiveSearch *self)
588 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
590 g_return_val_if_fail (EMPATHY_IS_LIVE_SEARCH (self), NULL);
592 return priv->hook_widget;
596 empathy_live_search_set_hook_widget (EmpathyLiveSearch *self,
599 EmpathyLiveSearchPriv *priv;
601 g_return_if_fail (EMPATHY_IS_LIVE_SEARCH (self));
602 g_return_if_fail (hook == NULL || GTK_IS_WIDGET (hook));
604 priv = GET_PRIV (self);
606 /* release the actual widget */
607 live_search_release_hook_widget (self);
609 /* connect handlers if new source is not null */
612 priv->hook_widget = g_object_ref (hook);
613 g_signal_connect (priv->hook_widget, "key-press-event",
614 G_CALLBACK (live_search_key_press_event_cb),
616 g_signal_connect (priv->hook_widget, "destroy",
617 G_CALLBACK (live_search_hook_widget_destroy_cb),
623 empathy_live_search_get_text (EmpathyLiveSearch *self)
625 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
627 g_return_val_if_fail (EMPATHY_IS_LIVE_SEARCH (self), NULL);
629 return gtk_entry_get_text (GTK_ENTRY (priv->search_entry));
633 empathy_live_search_set_text (EmpathyLiveSearch *self,
636 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
638 g_return_if_fail (EMPATHY_IS_LIVE_SEARCH (self));
639 g_return_if_fail (text != NULL);
641 gtk_entry_set_text (GTK_ENTRY (priv->search_entry), text);
645 * empathy_live_search_match:
646 * @self: a #EmpathyLiveSearch
647 * @string: a string where to search, must be valid UTF-8.
649 * Search if one of the words in @string string starts with the current text
652 * Searching for "aba" in "Abasto" will match, searching in "Moraba" will not,
653 * and searching in "A tool (abacus)" will do.
655 * The match is not case-sensitive, and regardless of the accentuation marks.
657 * Returns: %TRUE if a match is found, %FALSE otherwise.
661 empathy_live_search_match (EmpathyLiveSearch *self,
664 EmpathyLiveSearchPriv *priv;
666 g_return_val_if_fail (EMPATHY_IS_LIVE_SEARCH (self), FALSE);
668 priv = GET_PRIV (self);
670 return live_search_match_words (string, priv->stripped_words);
674 empathy_live_search_match_string (const gchar *string,
680 words = strip_utf8_string (prefix);
681 match = live_search_match_words (string, words);
683 g_ptr_array_unref (words);