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 fire_key_navigation_sig (EmpathyLiveSearch *self,
255 g_signal_emit (self, signals[KEYNAV], 0, event, &ret);
260 live_search_entry_key_pressed_cb (GtkEntry *entry,
264 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
266 /* if esc key pressed, hide the search */
267 if (event->keyval == GDK_KEY_Escape)
269 gtk_widget_hide (GTK_WIDGET (self));
273 /* emit key navigation signal, so other widgets can respond to it properly */
274 if (event->keyval == GDK_KEY_Up || event->keyval == GDK_KEY_Down
275 || event->keyval == GDK_KEY_Page_Up || event->keyval == GDK_KEY_Page_Down)
277 return fire_key_navigation_sig (self, event);
280 if (event->keyval == GDK_KEY_Home || event->keyval == GDK_KEY_End)
282 /* If the live search is visible, the entry should catch the Home/End
284 if (!gtk_widget_get_visible (GTK_WIDGET (self)))
286 return fire_key_navigation_sig (self, event);
294 live_search_text_changed (GtkEntry *entry,
297 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
298 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
301 text = gtk_entry_get_text (entry);
303 if (EMP_STR_EMPTY (text))
304 gtk_widget_hide (GTK_WIDGET (self));
306 gtk_widget_show (GTK_WIDGET (self));
308 if (priv->stripped_words != NULL)
309 g_ptr_array_unref (priv->stripped_words);
311 priv->stripped_words = strip_utf8_string (text);
313 g_object_notify (G_OBJECT (self), "text");
317 live_search_close_pressed (GtkEntry *entry,
318 GtkEntryIconPosition icon_pos,
322 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
324 gtk_widget_hide (GTK_WIDGET (self));
328 live_search_key_press_event_cb (GtkWidget *widget,
332 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
333 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
337 /* dont forward this event to the entry, else the event is consumed by the
338 * entry and does not close the window */
339 if (!gtk_widget_get_visible (GTK_WIDGET (self)) &&
340 event->keyval == GDK_KEY_Escape)
343 /* do not show the search if CTRL and/or ALT are pressed with a key
344 * this is needed, because otherwise the CTRL + F accel would not work,
345 * because the entry consumes it */
346 if (event->state & (GDK_MOD1_MASK | GDK_CONTROL_MASK) ||
347 event->keyval == GDK_KEY_Control_L ||
348 event->keyval == GDK_KEY_Control_R)
351 /* dont forward the up/down and Page Up/Down arrow keys to the entry,
352 * they are needed for navigation in the treeview and are not needed in
353 * the search entry */
354 if (event->keyval == GDK_KEY_Up || event->keyval == GDK_KEY_Down ||
355 event->keyval == GDK_KEY_Page_Up || event->keyval == GDK_KEY_Page_Down)
358 if (event->keyval == GDK_KEY_Home || event->keyval == GDK_KEY_End)
360 /* Home/End keys have to be forwarded to the entry only if the live
361 * search is visible (to move the cursor inside the entry). */
362 if (!gtk_widget_get_visible (GTK_WIDGET (self)))
366 /* realize the widget if it is not realized yet */
367 gtk_widget_realize (priv->search_entry);
368 if (!gtk_widget_has_focus (priv->search_entry))
370 gtk_widget_grab_focus (priv->search_entry);
371 gtk_editable_set_position (GTK_EDITABLE (priv->search_entry), -1);
374 /* forward the event to the search entry */
375 new_event = gdk_event_copy ((GdkEvent *) event);
376 ret = gtk_widget_event (priv->search_entry, new_event);
377 gdk_event_free (new_event);
383 live_search_entry_activate_cb (GtkEntry *entry,
384 EmpathyLiveSearch *self)
386 g_signal_emit (self, signals[ACTIVATE], 0);
390 live_search_release_hook_widget (EmpathyLiveSearch *self)
392 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
394 /* remove old handlers if old source was not null */
395 if (priv->hook_widget != NULL)
397 g_signal_handlers_disconnect_by_func (priv->hook_widget,
398 live_search_key_press_event_cb, self);
399 g_signal_handlers_disconnect_by_func (priv->hook_widget,
400 live_search_hook_widget_destroy_cb, self);
401 g_object_unref (priv->hook_widget);
402 priv->hook_widget = NULL;
407 live_search_hook_widget_destroy_cb (GtkWidget *object,
410 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
412 /* unref the hook widget and hide search */
413 gtk_widget_hide (GTK_WIDGET (self));
414 live_search_release_hook_widget (self);
418 live_search_dispose (GObject *obj)
420 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (obj);
422 live_search_release_hook_widget (self);
424 if (G_OBJECT_CLASS (empathy_live_search_parent_class)->dispose != NULL)
425 G_OBJECT_CLASS (empathy_live_search_parent_class)->dispose (obj);
429 live_search_finalize (GObject *obj)
431 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (obj);
432 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
434 if (priv->stripped_words != NULL)
435 g_ptr_array_unref (priv->stripped_words);
437 if (G_OBJECT_CLASS (empathy_live_search_parent_class)->finalize != NULL)
438 G_OBJECT_CLASS (empathy_live_search_parent_class)->finalize (obj);
442 live_search_get_property (GObject *object,
447 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (object);
451 case PROP_HOOK_WIDGET:
452 g_value_set_object (value, empathy_live_search_get_hook_widget (self));
455 g_value_set_string (value, empathy_live_search_get_text (self));
458 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
464 live_search_set_property (GObject *object,
469 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (object);
472 case PROP_HOOK_WIDGET:
473 empathy_live_search_set_hook_widget (self, g_value_get_object (value));
476 empathy_live_search_set_text (self, g_value_get_string (value));
479 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
485 live_search_hide (GtkWidget *widget)
487 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (widget);
488 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
490 GTK_WIDGET_CLASS (empathy_live_search_parent_class)->hide (widget);
492 gtk_entry_set_text (GTK_ENTRY (priv->search_entry), "");
493 gtk_widget_grab_focus (priv->hook_widget);
497 live_search_show (GtkWidget *widget)
499 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (widget);
500 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
502 if (!gtk_widget_has_focus (priv->search_entry))
503 gtk_widget_grab_focus (priv->search_entry);
505 GTK_WIDGET_CLASS (empathy_live_search_parent_class)->show (widget);
509 live_search_grab_focus (GtkWidget *widget)
511 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (widget);
512 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
514 if (!gtk_widget_has_focus (priv->search_entry))
516 gtk_widget_grab_focus (priv->search_entry);
517 gtk_editable_set_position (GTK_EDITABLE (priv->search_entry), -1);
522 empathy_live_search_class_init (EmpathyLiveSearchClass *klass)
524 GObjectClass *object_class = (GObjectClass *) klass;
525 GtkWidgetClass *widget_class = (GtkWidgetClass *) klass;
526 GParamSpec *param_spec;
528 object_class->finalize = live_search_finalize;
529 object_class->dispose = live_search_dispose;
530 object_class->get_property = live_search_get_property;
531 object_class->set_property = live_search_set_property;
533 widget_class->hide = live_search_hide;
534 widget_class->show = live_search_show;
535 widget_class->grab_focus = live_search_grab_focus;
537 signals[ACTIVATE] = g_signal_new ("activate",
538 G_TYPE_FROM_CLASS (object_class),
542 g_cclosure_marshal_VOID__VOID,
545 signals[KEYNAV] = g_signal_new ("key-navigation",
546 G_TYPE_FROM_CLASS (object_class),
549 g_signal_accumulator_true_handled, NULL,
550 _empathy_gtk_marshal_BOOLEAN__BOXED,
551 G_TYPE_BOOLEAN, 1, GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
553 param_spec = g_param_spec_object ("hook-widget", "Live Search Hook Widget",
554 "The live search catches key-press-events on this widget",
555 GTK_TYPE_WIDGET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
556 g_object_class_install_property (object_class, PROP_HOOK_WIDGET,
559 param_spec = g_param_spec_string ("text", "Live Search Text",
560 "The text of the live search entry",
561 "", G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
562 g_object_class_install_property (object_class, PROP_TEXT, param_spec);
564 g_type_class_add_private (klass, sizeof (EmpathyLiveSearchPriv));
568 empathy_live_search_init (EmpathyLiveSearch *self)
570 EmpathyLiveSearchPriv *priv =
571 G_TYPE_INSTANCE_GET_PRIVATE ((self), EMPATHY_TYPE_LIVE_SEARCH,
572 EmpathyLiveSearchPriv);
574 gtk_widget_set_no_show_all (GTK_WIDGET (self), TRUE);
576 priv->search_entry = gtk_entry_new ();
577 gtk_entry_set_icon_from_stock (GTK_ENTRY (priv->search_entry),
578 GTK_ENTRY_ICON_SECONDARY, GTK_STOCK_CLOSE);
579 gtk_entry_set_icon_activatable (GTK_ENTRY (priv->search_entry),
580 GTK_ENTRY_ICON_SECONDARY, TRUE);
581 gtk_entry_set_icon_sensitive (GTK_ENTRY (priv->search_entry),
582 GTK_ENTRY_ICON_SECONDARY, TRUE);
583 gtk_widget_show (priv->search_entry);
585 gtk_box_pack_start (GTK_BOX (self), priv->search_entry, TRUE, TRUE, 0);
587 g_signal_connect (priv->search_entry, "icon_release",
588 G_CALLBACK (live_search_close_pressed), self);
589 g_signal_connect (priv->search_entry, "changed",
590 G_CALLBACK (live_search_text_changed), self);
591 g_signal_connect (priv->search_entry, "key-press-event",
592 G_CALLBACK (live_search_entry_key_pressed_cb), self);
593 g_signal_connect (priv->search_entry, "activate",
594 G_CALLBACK (live_search_entry_activate_cb), self);
596 priv->hook_widget = NULL;
602 empathy_live_search_new (GtkWidget *hook)
604 g_return_val_if_fail (hook == NULL || GTK_IS_WIDGET (hook), NULL);
606 return g_object_new (EMPATHY_TYPE_LIVE_SEARCH,
614 empathy_live_search_get_hook_widget (EmpathyLiveSearch *self)
616 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
618 g_return_val_if_fail (EMPATHY_IS_LIVE_SEARCH (self), NULL);
620 return priv->hook_widget;
624 empathy_live_search_set_hook_widget (EmpathyLiveSearch *self,
627 EmpathyLiveSearchPriv *priv;
629 g_return_if_fail (EMPATHY_IS_LIVE_SEARCH (self));
630 g_return_if_fail (hook == NULL || GTK_IS_WIDGET (hook));
632 priv = GET_PRIV (self);
634 /* release the actual widget */
635 live_search_release_hook_widget (self);
637 /* connect handlers if new source is not null */
640 priv->hook_widget = g_object_ref (hook);
641 g_signal_connect (priv->hook_widget, "key-press-event",
642 G_CALLBACK (live_search_key_press_event_cb),
644 g_signal_connect (priv->hook_widget, "destroy",
645 G_CALLBACK (live_search_hook_widget_destroy_cb),
651 empathy_live_search_get_text (EmpathyLiveSearch *self)
653 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
655 g_return_val_if_fail (EMPATHY_IS_LIVE_SEARCH (self), NULL);
657 return gtk_entry_get_text (GTK_ENTRY (priv->search_entry));
661 empathy_live_search_set_text (EmpathyLiveSearch *self,
664 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
666 g_return_if_fail (EMPATHY_IS_LIVE_SEARCH (self));
667 g_return_if_fail (text != NULL);
669 gtk_entry_set_text (GTK_ENTRY (priv->search_entry), text);
673 * empathy_live_search_match:
674 * @self: a #EmpathyLiveSearch
675 * @string: a string where to search, must be valid UTF-8.
677 * Search if one of the words in @string string starts with the current text
680 * Searching for "aba" in "Abasto" will match, searching in "Moraba" will not,
681 * and searching in "A tool (abacus)" will do.
683 * The match is not case-sensitive, and regardless of the accentuation marks.
685 * Returns: %TRUE if a match is found, %FALSE otherwise.
689 empathy_live_search_match (EmpathyLiveSearch *self,
692 EmpathyLiveSearchPriv *priv;
694 g_return_val_if_fail (EMPATHY_IS_LIVE_SEARCH (self), FALSE);
696 priv = GET_PRIV (self);
698 return live_search_match_words (string, priv->stripped_words);
702 empathy_live_search_match_string (const gchar *string,
708 words = strip_utf8_string (prefix);
709 match = live_search_match_words (string, words);
711 g_ptr_array_unref (words);