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>
26 #include "empathy-utils.h"
28 #include "empathy-live-search.h"
30 G_DEFINE_TYPE (EmpathyLiveSearch, empathy_live_search, GTK_TYPE_HBOX)
32 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyLiveSearch)
36 GtkWidget *search_entry;
37 GtkWidget *hook_widget;
39 GPtrArray *stripped_words;
40 } EmpathyLiveSearchPriv;
56 static guint signals[LAST_SIGNAL];
58 static void live_search_hook_widget_destroy_cb (GtkWidget *object,
64 * Returns a stripped version of @ch, removing any case, accentuation
65 * mark, or any special mark on it.
68 stripped_char (gunichar ch)
73 utype = g_unichar_type (ch);
77 case G_UNICODE_CONTROL:
78 case G_UNICODE_FORMAT:
79 case G_UNICODE_UNASSIGNED:
80 case G_UNICODE_NON_SPACING_MARK:
81 case G_UNICODE_COMBINING_MARK:
82 case G_UNICODE_ENCLOSING_MARK:
85 case G_UNICODE_PRIVATE_USE:
86 case G_UNICODE_SURROGATE:
87 case G_UNICODE_LOWERCASE_LETTER:
88 case G_UNICODE_MODIFIER_LETTER:
89 case G_UNICODE_OTHER_LETTER:
90 case G_UNICODE_TITLECASE_LETTER:
91 case G_UNICODE_UPPERCASE_LETTER:
92 case G_UNICODE_DECIMAL_NUMBER:
93 case G_UNICODE_LETTER_NUMBER:
94 case G_UNICODE_OTHER_NUMBER:
95 case G_UNICODE_CONNECT_PUNCTUATION:
96 case G_UNICODE_DASH_PUNCTUATION:
97 case G_UNICODE_CLOSE_PUNCTUATION:
98 case G_UNICODE_FINAL_PUNCTUATION:
99 case G_UNICODE_INITIAL_PUNCTUATION:
100 case G_UNICODE_OTHER_PUNCTUATION:
101 case G_UNICODE_OPEN_PUNCTUATION:
102 case G_UNICODE_CURRENCY_SYMBOL:
103 case G_UNICODE_MODIFIER_SYMBOL:
104 case G_UNICODE_MATH_SYMBOL:
105 case G_UNICODE_OTHER_SYMBOL:
106 case G_UNICODE_LINE_SEPARATOR:
107 case G_UNICODE_PARAGRAPH_SEPARATOR:
108 case G_UNICODE_SPACE_SEPARATOR:
110 ch = g_unichar_tolower (ch);
111 g_unichar_fully_decompose (ch, FALSE, &retval, 1);
118 append_word (GPtrArray **word_array,
123 if (*word_array == NULL)
124 *word_array = g_ptr_array_new_with_free_func (g_free);
125 g_ptr_array_add (*word_array, g_string_free (*word, FALSE));
131 empathy_live_search_strip_utf8_string (const gchar *string)
133 GPtrArray *word_array = NULL;
134 GString *word = NULL;
137 if (EMP_STR_EMPTY (string))
140 for (p = string; *p != '\0'; p = g_utf8_next_char (p))
144 /* Make the char lower-case, remove its accentuation marks, and ignore it
145 * if it is just unicode marks */
146 sc = stripped_char (g_utf8_get_char (p));
150 /* If it is not alpha-num, it is separator between words */
151 if (!g_unichar_isalnum (sc))
153 append_word (&word_array, &word);
157 /* It is alpha-num, append this char to current word, or start new word */
159 word = g_string_new (NULL);
160 g_string_append_unichar (word, sc);
163 append_word (&word_array, &word);
169 live_search_match_prefix (const gchar *string,
173 const gchar *prefix_p;
174 gboolean next_word = FALSE;
176 if (prefix == NULL || prefix[0] == 0)
179 if (EMP_STR_EMPTY (string))
183 for (p = string; *p != '\0'; p = g_utf8_next_char (p))
187 /* Make the char lower-case, remove its accentuation marks, and ignore it
188 * if it is just unicode marks */
189 sc = stripped_char (g_utf8_get_char (p));
193 /* If we want to go to next word, ignore alpha-num chars */
194 if (next_word && g_unichar_isalnum (sc))
198 /* Ignore word separators */
199 if (!g_unichar_isalnum (sc))
202 /* If this char does not match prefix_p, go to next word and start again
203 * from the beginning of prefix */
204 if (sc != g_utf8_get_char (prefix_p))
211 /* prefix_p match, verify to next char. If this was the last of prefix,
212 * it means it completely machted and we are done. */
213 prefix_p = g_utf8_next_char (prefix_p);
214 if (*prefix_p == '\0')
222 empathy_live_search_match_words (const gchar *string,
230 for (i = 0; i < words->len; i++)
231 if (!live_search_match_prefix (string, g_ptr_array_index (words, i)))
238 fire_key_navigation_sig (EmpathyLiveSearch *self,
243 g_signal_emit (self, signals[KEYNAV], 0, event, &ret);
248 live_search_entry_key_pressed_cb (GtkEntry *entry,
252 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
254 /* if esc key pressed, hide the search */
255 if (event->keyval == GDK_KEY_Escape)
257 gtk_widget_hide (GTK_WIDGET (self));
261 /* emit key navigation signal, so other widgets can respond to it properly */
262 if (event->keyval == GDK_KEY_Up || event->keyval == GDK_KEY_Down
263 || event->keyval == GDK_KEY_Page_Up || event->keyval == GDK_KEY_Page_Down
264 || event->keyval == GDK_KEY_Menu)
266 return fire_key_navigation_sig (self, event);
269 if (event->keyval == GDK_KEY_Home || event->keyval == GDK_KEY_End ||
270 event->keyval == GDK_KEY_space)
272 /* If the live search is visible, the entry should catch the Home/End
273 * and space events */
274 if (!gtk_widget_get_visible (GTK_WIDGET (self)))
276 return fire_key_navigation_sig (self, event);
284 live_search_text_changed (GtkEntry *entry,
287 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
288 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
291 text = gtk_entry_get_text (entry);
293 if (EMP_STR_EMPTY (text))
294 gtk_widget_hide (GTK_WIDGET (self));
296 gtk_widget_show (GTK_WIDGET (self));
298 if (priv->stripped_words != NULL)
299 g_ptr_array_unref (priv->stripped_words);
301 priv->stripped_words = empathy_live_search_strip_utf8_string (text);
303 g_object_notify (G_OBJECT (self), "text");
307 live_search_close_pressed (GtkEntry *entry,
308 GtkEntryIconPosition icon_pos,
312 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
314 gtk_widget_hide (GTK_WIDGET (self));
318 live_search_key_press_event_cb (GtkWidget *widget,
322 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
323 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
327 /* dont forward this event to the entry, else the event is consumed by the
328 * entry and does not close the window */
329 if (!gtk_widget_get_visible (GTK_WIDGET (self)) &&
330 event->keyval == GDK_KEY_Escape)
333 /* do not show the search if CTRL and/or ALT are pressed with a key
334 * this is needed, because otherwise the CTRL + F accel would not work,
335 * because the entry consumes it */
336 if (event->state & (GDK_MOD1_MASK | GDK_CONTROL_MASK) ||
337 event->keyval == GDK_KEY_Control_L ||
338 event->keyval == GDK_KEY_Control_R)
341 /* dont forward the up/down and Page Up/Down arrow keys to the entry,
342 * they are needed for navigation in the treeview and are not needed in
343 * the search entry */
344 if (event->keyval == GDK_KEY_Up || event->keyval == GDK_KEY_Down ||
345 event->keyval == GDK_KEY_Page_Up || event->keyval == GDK_KEY_Page_Down ||
346 event->keyval == GDK_KEY_Menu)
349 if (event->keyval == GDK_KEY_Home || event->keyval == GDK_KEY_End ||
350 event->keyval == GDK_KEY_space)
352 /* Home/End and space keys have to be forwarded to the entry only if
353 * the live search is visible (to move the cursor inside the entry). */
354 if (!gtk_widget_get_visible (GTK_WIDGET (self)))
358 /* Don't forward shift keys events as focusing the search entry would
359 * cancel an in-progress editing on a cell renderer (like when renaming a
360 * group). There is no point focusing it anyway as we don't display the
361 * search entry when only a shift key is pressed. */
362 if (event->keyval == GDK_KEY_Shift_L ||
363 event->keyval == GDK_KEY_Shift_R)
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_unmap (GtkWidget *widget)
487 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (widget);
488 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
490 GTK_WIDGET_CLASS (empathy_live_search_parent_class)->unmap (widget);
492 /* unmap can happen if a parent gets hidden, in that case we want to hide
493 * the live search as well, so when it gets mapped again, the live search
495 gtk_widget_hide (widget);
497 gtk_entry_set_text (GTK_ENTRY (priv->search_entry), "");
499 if (priv->hook_widget != NULL)
500 gtk_widget_grab_focus (priv->hook_widget);
504 live_search_show (GtkWidget *widget)
506 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (widget);
507 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
509 if (!gtk_widget_has_focus (priv->search_entry))
510 gtk_widget_grab_focus (priv->search_entry);
512 GTK_WIDGET_CLASS (empathy_live_search_parent_class)->show (widget);
516 live_search_grab_focus (GtkWidget *widget)
518 EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (widget);
519 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
521 if (!gtk_widget_has_focus (priv->search_entry))
523 gtk_widget_grab_focus (priv->search_entry);
524 gtk_editable_set_position (GTK_EDITABLE (priv->search_entry), -1);
529 empathy_live_search_class_init (EmpathyLiveSearchClass *klass)
531 GObjectClass *object_class = (GObjectClass *) klass;
532 GtkWidgetClass *widget_class = (GtkWidgetClass *) klass;
533 GParamSpec *param_spec;
535 object_class->finalize = live_search_finalize;
536 object_class->dispose = live_search_dispose;
537 object_class->get_property = live_search_get_property;
538 object_class->set_property = live_search_set_property;
540 widget_class->unmap = live_search_unmap;
541 widget_class->show = live_search_show;
542 widget_class->grab_focus = live_search_grab_focus;
544 signals[ACTIVATE] = g_signal_new ("activate",
545 G_TYPE_FROM_CLASS (object_class),
549 g_cclosure_marshal_generic,
552 signals[KEYNAV] = g_signal_new ("key-navigation",
553 G_TYPE_FROM_CLASS (object_class),
556 g_signal_accumulator_true_handled, NULL,
557 g_cclosure_marshal_generic,
558 G_TYPE_BOOLEAN, 1, GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
560 param_spec = g_param_spec_object ("hook-widget", "Live Search Hook Widget",
561 "The live search catches key-press-events on this widget",
562 GTK_TYPE_WIDGET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
563 g_object_class_install_property (object_class, PROP_HOOK_WIDGET,
566 param_spec = g_param_spec_string ("text", "Live Search Text",
567 "The text of the live search entry",
568 "", G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
569 g_object_class_install_property (object_class, PROP_TEXT, param_spec);
571 g_type_class_add_private (klass, sizeof (EmpathyLiveSearchPriv));
575 empathy_live_search_init (EmpathyLiveSearch *self)
577 EmpathyLiveSearchPriv *priv =
578 G_TYPE_INSTANCE_GET_PRIVATE ((self), EMPATHY_TYPE_LIVE_SEARCH,
579 EmpathyLiveSearchPriv);
581 gtk_widget_set_no_show_all (GTK_WIDGET (self), TRUE);
583 priv->search_entry = gtk_entry_new ();
584 gtk_entry_set_icon_from_stock (GTK_ENTRY (priv->search_entry),
585 GTK_ENTRY_ICON_SECONDARY, GTK_STOCK_CLOSE);
586 gtk_entry_set_icon_activatable (GTK_ENTRY (priv->search_entry),
587 GTK_ENTRY_ICON_SECONDARY, TRUE);
588 gtk_entry_set_icon_sensitive (GTK_ENTRY (priv->search_entry),
589 GTK_ENTRY_ICON_SECONDARY, TRUE);
590 gtk_widget_show (priv->search_entry);
592 gtk_box_pack_start (GTK_BOX (self), priv->search_entry, TRUE, TRUE, 0);
594 g_signal_connect (priv->search_entry, "icon_release",
595 G_CALLBACK (live_search_close_pressed), self);
596 g_signal_connect (priv->search_entry, "changed",
597 G_CALLBACK (live_search_text_changed), self);
598 g_signal_connect (priv->search_entry, "key-press-event",
599 G_CALLBACK (live_search_entry_key_pressed_cb), self);
600 g_signal_connect (priv->search_entry, "activate",
601 G_CALLBACK (live_search_entry_activate_cb), self);
603 priv->hook_widget = NULL;
609 empathy_live_search_new (GtkWidget *hook)
611 g_return_val_if_fail (hook == NULL || GTK_IS_WIDGET (hook), NULL);
613 return g_object_new (EMPATHY_TYPE_LIVE_SEARCH,
621 empathy_live_search_get_hook_widget (EmpathyLiveSearch *self)
623 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
625 g_return_val_if_fail (EMPATHY_IS_LIVE_SEARCH (self), NULL);
627 return priv->hook_widget;
631 empathy_live_search_set_hook_widget (EmpathyLiveSearch *self,
634 EmpathyLiveSearchPriv *priv;
636 g_return_if_fail (EMPATHY_IS_LIVE_SEARCH (self));
637 g_return_if_fail (hook == NULL || GTK_IS_WIDGET (hook));
639 priv = GET_PRIV (self);
641 /* release the actual widget */
642 live_search_release_hook_widget (self);
644 /* connect handlers if new source is not null */
647 priv->hook_widget = g_object_ref (hook);
648 g_signal_connect (priv->hook_widget, "key-press-event",
649 G_CALLBACK (live_search_key_press_event_cb),
651 g_signal_connect (priv->hook_widget, "destroy",
652 G_CALLBACK (live_search_hook_widget_destroy_cb),
658 empathy_live_search_get_text (EmpathyLiveSearch *self)
660 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
662 g_return_val_if_fail (EMPATHY_IS_LIVE_SEARCH (self), NULL);
664 return gtk_entry_get_text (GTK_ENTRY (priv->search_entry));
668 empathy_live_search_set_text (EmpathyLiveSearch *self,
671 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
673 g_return_if_fail (EMPATHY_IS_LIVE_SEARCH (self));
674 g_return_if_fail (text != NULL);
676 gtk_entry_set_text (GTK_ENTRY (priv->search_entry), text);
680 * empathy_live_search_match:
681 * @self: a #EmpathyLiveSearch
682 * @string: a string where to search, must be valid UTF-8.
684 * Search if one of the words in @string string starts with the current text
687 * Searching for "aba" in "Abasto" will match, searching in "Moraba" will not,
688 * and searching in "A tool (abacus)" will do.
690 * The match is not case-sensitive, and regardless of the accentuation marks.
692 * Returns: %TRUE if a match is found, %FALSE otherwise.
696 empathy_live_search_match (EmpathyLiveSearch *self,
699 EmpathyLiveSearchPriv *priv;
701 g_return_val_if_fail (EMPATHY_IS_LIVE_SEARCH (self), FALSE);
703 priv = GET_PRIV (self);
705 return empathy_live_search_match_words (string, priv->stripped_words);
709 empathy_live_search_match_string (const gchar *string,
715 words = empathy_live_search_strip_utf8_string (prefix);
716 match = empathy_live_search_match_words (string, words);
718 g_ptr_array_unref (words);
724 empathy_live_search_get_words (EmpathyLiveSearch *self)
726 EmpathyLiveSearchPriv *priv = GET_PRIV (self);
728 return priv->stripped_words;