]> git.0d.be Git - empathy.git/blob - libempathy-gtk/empathy-live-search.c
Merge branch 'gnome-3-4'
[empathy.git] / libempathy-gtk / empathy-live-search.c
1 /*
2  * Copyright (C) 2010 Collabora Ltd.
3  * Copyright (C) 2007-2010 Nokia Corporation.
4  *
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.
9  *
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.
14  *
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
18  *
19  * Authors: Felix Kaser <felix.kaser@collabora.co.uk>
20  *          Xavier Claessens <xavier.claessens@collabora.co.uk>
21  *          Claudio Saavedra <csaavedra@igalia.com>
22  */
23
24 #include <config.h>
25 #include <string.h>
26
27 #include <gtk/gtk.h>
28 #include <gdk/gdkkeysyms.h>
29
30 #include <libempathy/empathy-utils.h>
31
32 #include "empathy-live-search.h"
33
34 G_DEFINE_TYPE (EmpathyLiveSearch, empathy_live_search, GTK_TYPE_HBOX)
35
36 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyLiveSearch)
37
38 typedef struct
39 {
40   GtkWidget *search_entry;
41   GtkWidget *hook_widget;
42
43   GPtrArray *stripped_words;
44 } EmpathyLiveSearchPriv;
45
46 enum
47 {
48   PROP_0,
49   PROP_HOOK_WIDGET,
50   PROP_TEXT
51 };
52
53 enum
54 {
55   ACTIVATE,
56   KEYNAV,
57   LAST_SIGNAL
58 };
59
60 static guint signals[LAST_SIGNAL];
61
62 static void live_search_hook_widget_destroy_cb (GtkWidget *object,
63     gpointer user_data);
64
65 /**
66  * stripped_char:
67  *
68  * Returns a stripped version of @ch, removing any case, accentuation
69  * mark, or any special mark on it.
70  **/
71 static gunichar
72 stripped_char (gunichar ch)
73 {
74   gunichar retval = 0;
75   GUnicodeType utype;
76
77   utype = g_unichar_type (ch);
78
79   switch (utype)
80     {
81     case G_UNICODE_CONTROL:
82     case G_UNICODE_FORMAT:
83     case G_UNICODE_UNASSIGNED:
84     case G_UNICODE_NON_SPACING_MARK:
85     case G_UNICODE_COMBINING_MARK:
86     case G_UNICODE_ENCLOSING_MARK:
87       /* Ignore those */
88       break;
89     case G_UNICODE_PRIVATE_USE:
90     case G_UNICODE_SURROGATE:
91     case G_UNICODE_LOWERCASE_LETTER:
92     case G_UNICODE_MODIFIER_LETTER:
93     case G_UNICODE_OTHER_LETTER:
94     case G_UNICODE_TITLECASE_LETTER:
95     case G_UNICODE_UPPERCASE_LETTER:
96     case G_UNICODE_DECIMAL_NUMBER:
97     case G_UNICODE_LETTER_NUMBER:
98     case G_UNICODE_OTHER_NUMBER:
99     case G_UNICODE_CONNECT_PUNCTUATION:
100     case G_UNICODE_DASH_PUNCTUATION:
101     case G_UNICODE_CLOSE_PUNCTUATION:
102     case G_UNICODE_FINAL_PUNCTUATION:
103     case G_UNICODE_INITIAL_PUNCTUATION:
104     case G_UNICODE_OTHER_PUNCTUATION:
105     case G_UNICODE_OPEN_PUNCTUATION:
106     case G_UNICODE_CURRENCY_SYMBOL:
107     case G_UNICODE_MODIFIER_SYMBOL:
108     case G_UNICODE_MATH_SYMBOL:
109     case G_UNICODE_OTHER_SYMBOL:
110     case G_UNICODE_LINE_SEPARATOR:
111     case G_UNICODE_PARAGRAPH_SEPARATOR:
112     case G_UNICODE_SPACE_SEPARATOR:
113     default:
114       ch = g_unichar_tolower (ch);
115       g_unichar_fully_decompose (ch, FALSE, &retval, 1);
116     }
117
118   return retval;
119 }
120
121 static void
122 append_word (GPtrArray **word_array,
123     GString **word)
124 {
125   if (*word != NULL)
126     {
127       if (*word_array == NULL)
128         *word_array = g_ptr_array_new_with_free_func (g_free);
129       g_ptr_array_add (*word_array, g_string_free (*word, FALSE));
130       *word = NULL;
131     }
132 }
133
134 GPtrArray *
135 empathy_live_search_strip_utf8_string (const gchar *string)
136 {
137   GPtrArray *word_array = NULL;
138   GString *word = NULL;
139   const gchar *p;
140
141   if (EMP_STR_EMPTY (string))
142     return NULL;
143
144   for (p = string; *p != '\0'; p = g_utf8_next_char (p))
145     {
146       gunichar sc;
147
148       /* Make the char lower-case, remove its accentuation marks, and ignore it
149        * if it is just unicode marks */
150       sc = stripped_char (g_utf8_get_char (p));
151       if (sc == 0)
152         continue;
153
154       /* If it is not alpha-num, it is separator between words */
155       if (!g_unichar_isalnum (sc))
156         {
157           append_word (&word_array, &word);
158           continue;
159         }
160
161       /* It is alpha-num, append this char to current word, or start new word */
162       if (word == NULL)
163         word = g_string_new (NULL);
164       g_string_append_unichar (word, sc);
165     }
166
167   append_word (&word_array, &word);
168
169   return word_array;
170 }
171
172 static gboolean
173 live_search_match_prefix (const gchar *string,
174     const gchar *prefix)
175 {
176   const gchar *p;
177   const gchar *prefix_p;
178   gboolean next_word = FALSE;
179
180   if (prefix == NULL || prefix[0] == 0)
181     return TRUE;
182
183   if (EMP_STR_EMPTY (string))
184     return FALSE;
185
186   prefix_p = prefix;
187   for (p = string; *p != '\0'; p = g_utf8_next_char (p))
188     {
189       gunichar sc;
190
191       /* Make the char lower-case, remove its accentuation marks, and ignore it
192        * if it is just unicode marks */
193       sc = stripped_char (g_utf8_get_char (p));
194       if (sc == 0)
195         continue;
196
197       /* If we want to go to next word, ignore alpha-num chars */
198       if (next_word && g_unichar_isalnum (sc))
199         continue;
200       next_word = FALSE;
201
202       /* Ignore word separators */
203       if (!g_unichar_isalnum (sc))
204         continue;
205
206       /* If this char does not match prefix_p, go to next word and start again
207        * from the beginning of prefix */
208       if (sc != g_utf8_get_char (prefix_p))
209         {
210           next_word = TRUE;
211           prefix_p = prefix;
212           continue;
213         }
214
215       /* prefix_p match, verify to next char. If this was the last of prefix,
216        * it means it completely machted and we are done. */
217       prefix_p = g_utf8_next_char (prefix_p);
218       if (*prefix_p == '\0')
219         return TRUE;
220     }
221
222   return FALSE;
223 }
224
225 gboolean
226 empathy_live_search_match_words (const gchar *string,
227     GPtrArray *words)
228 {
229   guint i;
230
231   if (words == NULL)
232     return TRUE;
233
234   for (i = 0; i < words->len; i++)
235     if (!live_search_match_prefix (string, g_ptr_array_index (words, i)))
236       return FALSE;
237
238   return TRUE;
239 }
240
241 static gboolean
242 fire_key_navigation_sig (EmpathyLiveSearch *self,
243     GdkEventKey *event)
244 {
245   gboolean ret;
246
247   g_signal_emit (self, signals[KEYNAV], 0, event, &ret);
248   return ret;
249 }
250
251 static gboolean
252 live_search_entry_key_pressed_cb (GtkEntry *entry,
253     GdkEventKey *event,
254     gpointer user_data)
255 {
256   EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
257
258   /* if esc key pressed, hide the search */
259   if (event->keyval == GDK_KEY_Escape)
260     {
261       gtk_widget_hide (GTK_WIDGET (self));
262       return TRUE;
263     }
264
265   /* emit key navigation signal, so other widgets can respond to it properly */
266   if (event->keyval == GDK_KEY_Up || event->keyval == GDK_KEY_Down
267       || event->keyval == GDK_KEY_Page_Up || event->keyval == GDK_KEY_Page_Down)
268      {
269        return fire_key_navigation_sig (self, event);
270      }
271
272   if (event->keyval == GDK_KEY_Home || event->keyval == GDK_KEY_End ||
273       event->keyval == GDK_KEY_space)
274     {
275       /* If the live search is visible, the entry should catch the Home/End
276        * and space events */
277       if (!gtk_widget_get_visible (GTK_WIDGET (self)))
278         {
279           return fire_key_navigation_sig (self, event);
280         }
281     }
282
283   return FALSE;
284 }
285
286 static void
287 live_search_text_changed (GtkEntry *entry,
288     gpointer user_data)
289 {
290   EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
291   EmpathyLiveSearchPriv *priv = GET_PRIV (self);
292   const gchar *text;
293
294   text = gtk_entry_get_text (entry);
295
296   if (EMP_STR_EMPTY (text))
297     gtk_widget_hide (GTK_WIDGET (self));
298   else
299     gtk_widget_show (GTK_WIDGET (self));
300
301   if (priv->stripped_words != NULL)
302     g_ptr_array_unref (priv->stripped_words);
303
304   priv->stripped_words = empathy_live_search_strip_utf8_string (text);
305
306   g_object_notify (G_OBJECT (self), "text");
307 }
308
309 static void
310 live_search_close_pressed (GtkEntry *entry,
311     GtkEntryIconPosition icon_pos,
312     GdkEvent *event,
313     gpointer user_data)
314 {
315   EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
316
317   gtk_widget_hide (GTK_WIDGET (self));
318 }
319
320 static gboolean
321 live_search_key_press_event_cb (GtkWidget *widget,
322     GdkEventKey *event,
323     gpointer user_data)
324 {
325   EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
326   EmpathyLiveSearchPriv *priv = GET_PRIV (self);
327   GdkEvent *new_event;
328   gboolean ret;
329
330   /* dont forward this event to the entry, else the event is consumed by the
331    * entry and does not close the window */
332   if (!gtk_widget_get_visible (GTK_WIDGET (self)) &&
333       event->keyval == GDK_KEY_Escape)
334     return FALSE;
335
336   /* do not show the search if CTRL and/or ALT are pressed with a key
337    * this is needed, because otherwise the CTRL + F accel would not work,
338    * because the entry consumes it */
339   if (event->state & (GDK_MOD1_MASK | GDK_CONTROL_MASK) ||
340       event->keyval == GDK_KEY_Control_L ||
341       event->keyval == GDK_KEY_Control_R)
342     return FALSE;
343
344   /* dont forward the up/down and Page Up/Down arrow keys to the entry,
345    * they are needed for navigation in the treeview and are not needed in
346    * the search entry */
347    if (event->keyval == GDK_KEY_Up || event->keyval == GDK_KEY_Down ||
348        event->keyval == GDK_KEY_Page_Up || event->keyval == GDK_KEY_Page_Down)
349      return FALSE;
350
351    if (event->keyval == GDK_KEY_Home || event->keyval == GDK_KEY_End ||
352        event->keyval == GDK_KEY_space)
353      {
354        /* Home/End and space keys have to be forwarded to the entry only if
355         * the live search is visible (to move the cursor inside the entry). */
356        if (!gtk_widget_get_visible (GTK_WIDGET (self)))
357          return FALSE;
358      }
359
360    /* Don't forward shift keys events as focusing the search entry would
361     * cancel an in-progress editing on a cell renderer (like when renaming a
362     * group). There is no point focusing it anyway as we don't display the
363     * search entry when only a shift key is pressed. */
364    if (event->keyval == GDK_KEY_Shift_L ||
365        event->keyval == GDK_KEY_Shift_R)
366        return FALSE;
367
368   /* realize the widget if it is not realized yet */
369   gtk_widget_realize (priv->search_entry);
370   if (!gtk_widget_has_focus (priv->search_entry))
371     {
372       gtk_widget_grab_focus (priv->search_entry);
373       gtk_editable_set_position (GTK_EDITABLE (priv->search_entry), -1);
374     }
375
376   /* forward the event to the search entry */
377   new_event = gdk_event_copy ((GdkEvent *) event);
378   ret = gtk_widget_event (priv->search_entry, new_event);
379   gdk_event_free (new_event);
380
381   return ret;
382 }
383
384 static void
385 live_search_entry_activate_cb (GtkEntry *entry,
386     EmpathyLiveSearch *self)
387 {
388   g_signal_emit (self, signals[ACTIVATE], 0);
389 }
390
391 static void
392 live_search_release_hook_widget (EmpathyLiveSearch *self)
393 {
394   EmpathyLiveSearchPriv *priv = GET_PRIV (self);
395
396   /* remove old handlers if old source was not null */
397   if (priv->hook_widget != NULL)
398     {
399       g_signal_handlers_disconnect_by_func (priv->hook_widget,
400           live_search_key_press_event_cb, self);
401       g_signal_handlers_disconnect_by_func (priv->hook_widget,
402           live_search_hook_widget_destroy_cb, self);
403       g_object_unref (priv->hook_widget);
404       priv->hook_widget = NULL;
405     }
406 }
407
408 static void
409 live_search_hook_widget_destroy_cb (GtkWidget *object,
410     gpointer user_data)
411 {
412   EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (user_data);
413
414   /* unref the hook widget and hide search */
415   gtk_widget_hide (GTK_WIDGET (self));
416   live_search_release_hook_widget (self);
417 }
418
419 static void
420 live_search_dispose (GObject *obj)
421 {
422   EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (obj);
423
424   live_search_release_hook_widget (self);
425
426   if (G_OBJECT_CLASS (empathy_live_search_parent_class)->dispose != NULL)
427     G_OBJECT_CLASS (empathy_live_search_parent_class)->dispose (obj);
428 }
429
430 static void
431 live_search_finalize (GObject *obj)
432 {
433   EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (obj);
434   EmpathyLiveSearchPriv *priv = GET_PRIV (self);
435
436   if (priv->stripped_words != NULL)
437     g_ptr_array_unref (priv->stripped_words);
438
439   if (G_OBJECT_CLASS (empathy_live_search_parent_class)->finalize != NULL)
440     G_OBJECT_CLASS (empathy_live_search_parent_class)->finalize (obj);
441 }
442
443 static void
444 live_search_get_property (GObject *object,
445     guint param_id,
446     GValue *value,
447     GParamSpec *pspec)
448 {
449   EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (object);
450
451   switch (param_id)
452     {
453     case PROP_HOOK_WIDGET:
454       g_value_set_object (value, empathy_live_search_get_hook_widget (self));
455       break;
456     case PROP_TEXT:
457       g_value_set_string (value, empathy_live_search_get_text (self));
458       break;
459     default:
460       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
461       break;
462     }
463 }
464
465 static void
466 live_search_set_property (GObject *object,
467     guint param_id,
468     const GValue *value,
469     GParamSpec *pspec)
470 {
471   EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (object);
472
473   switch (param_id) {
474   case PROP_HOOK_WIDGET:
475     empathy_live_search_set_hook_widget (self, g_value_get_object (value));
476     break;
477   case PROP_TEXT:
478     empathy_live_search_set_text (self, g_value_get_string (value));
479     break;
480   default:
481     G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
482     break;
483   };
484 }
485
486 static void
487 live_search_unmap (GtkWidget *widget)
488 {
489   EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (widget);
490   EmpathyLiveSearchPriv *priv = GET_PRIV (self);
491
492   GTK_WIDGET_CLASS (empathy_live_search_parent_class)->unmap (widget);
493
494   /* unmap can happen if a parent gets hidden, in that case we want to hide
495    * the live search as well, so when it gets mapped again, the live search
496    * won't be shown. */
497   gtk_widget_hide (widget);
498
499   gtk_entry_set_text (GTK_ENTRY (priv->search_entry), "");
500   gtk_widget_grab_focus (priv->hook_widget);
501 }
502
503 static void
504 live_search_show (GtkWidget *widget)
505 {
506   EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (widget);
507   EmpathyLiveSearchPriv *priv = GET_PRIV (self);
508
509   if (!gtk_widget_has_focus (priv->search_entry))
510     gtk_widget_grab_focus (priv->search_entry);
511
512   GTK_WIDGET_CLASS (empathy_live_search_parent_class)->show (widget);
513 }
514
515 static void
516 live_search_grab_focus (GtkWidget *widget)
517 {
518   EmpathyLiveSearch *self = EMPATHY_LIVE_SEARCH (widget);
519   EmpathyLiveSearchPriv *priv = GET_PRIV (self);
520
521   if (!gtk_widget_has_focus (priv->search_entry))
522     {
523       gtk_widget_grab_focus (priv->search_entry);
524       gtk_editable_set_position (GTK_EDITABLE (priv->search_entry), -1);
525     }
526 }
527
528 static void
529 empathy_live_search_class_init (EmpathyLiveSearchClass *klass)
530 {
531   GObjectClass *object_class = (GObjectClass *) klass;
532   GtkWidgetClass *widget_class = (GtkWidgetClass *) klass;
533   GParamSpec *param_spec;
534
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;
539
540   widget_class->unmap = live_search_unmap;
541   widget_class->show = live_search_show;
542   widget_class->grab_focus = live_search_grab_focus;
543
544   signals[ACTIVATE] = g_signal_new ("activate",
545       G_TYPE_FROM_CLASS (object_class),
546       G_SIGNAL_RUN_LAST,
547       0,
548       NULL, NULL,
549       g_cclosure_marshal_generic,
550       G_TYPE_NONE, 0);
551
552   signals[KEYNAV] = g_signal_new ("key-navigation",
553       G_TYPE_FROM_CLASS (object_class),
554       G_SIGNAL_RUN_LAST,
555       0,
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);
559
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,
564       param_spec);
565
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);
570
571   g_type_class_add_private (klass, sizeof (EmpathyLiveSearchPriv));
572 }
573
574 static void
575 empathy_live_search_init (EmpathyLiveSearch *self)
576 {
577   EmpathyLiveSearchPriv *priv =
578     G_TYPE_INSTANCE_GET_PRIVATE ((self), EMPATHY_TYPE_LIVE_SEARCH,
579         EmpathyLiveSearchPriv);
580
581   gtk_widget_set_no_show_all (GTK_WIDGET (self), TRUE);
582
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);
591
592   gtk_box_pack_start (GTK_BOX (self), priv->search_entry, TRUE, TRUE, 0);
593
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);
602
603   priv->hook_widget = NULL;
604
605   self->priv = priv;
606 }
607
608 GtkWidget *
609 empathy_live_search_new (GtkWidget *hook)
610 {
611   g_return_val_if_fail (hook == NULL || GTK_IS_WIDGET (hook), NULL);
612
613   return g_object_new (EMPATHY_TYPE_LIVE_SEARCH,
614       "hook-widget", hook,
615       NULL);
616 }
617
618 /* public methods */
619
620 GtkWidget *
621 empathy_live_search_get_hook_widget (EmpathyLiveSearch *self)
622 {
623   EmpathyLiveSearchPriv *priv = GET_PRIV (self);
624
625   g_return_val_if_fail (EMPATHY_IS_LIVE_SEARCH (self), NULL);
626
627   return priv->hook_widget;
628 }
629
630 void
631 empathy_live_search_set_hook_widget (EmpathyLiveSearch *self,
632     GtkWidget *hook)
633 {
634   EmpathyLiveSearchPriv *priv;
635
636   g_return_if_fail (EMPATHY_IS_LIVE_SEARCH (self));
637   g_return_if_fail (hook == NULL || GTK_IS_WIDGET (hook));
638
639   priv = GET_PRIV (self);
640
641   /* release the actual widget */
642   live_search_release_hook_widget (self);
643
644   /* connect handlers if new source is not null */
645   if (hook != NULL)
646     {
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),
650           self);
651       g_signal_connect (priv->hook_widget, "destroy",
652           G_CALLBACK (live_search_hook_widget_destroy_cb),
653           self);
654     }
655 }
656
657 const gchar *
658 empathy_live_search_get_text (EmpathyLiveSearch *self)
659 {
660   EmpathyLiveSearchPriv *priv = GET_PRIV (self);
661
662   g_return_val_if_fail (EMPATHY_IS_LIVE_SEARCH (self), NULL);
663
664   return gtk_entry_get_text (GTK_ENTRY (priv->search_entry));
665 }
666
667 void
668 empathy_live_search_set_text (EmpathyLiveSearch *self,
669     const gchar *text)
670 {
671   EmpathyLiveSearchPriv *priv = GET_PRIV (self);
672
673   g_return_if_fail (EMPATHY_IS_LIVE_SEARCH (self));
674   g_return_if_fail (text != NULL);
675
676   gtk_entry_set_text (GTK_ENTRY (priv->search_entry), text);
677 }
678
679 /**
680  * empathy_live_search_match:
681  * @self: a #EmpathyLiveSearch
682  * @string: a string where to search, must be valid UTF-8.
683  *
684  * Search if one of the words in @string string starts with the current text
685  * of @self.
686  *
687  * Searching for "aba" in "Abasto" will match, searching in "Moraba" will not,
688  * and searching in "A tool (abacus)" will do.
689  *
690  * The match is not case-sensitive, and regardless of the accentuation marks.
691  *
692  * Returns: %TRUE if a match is found, %FALSE otherwise.
693  *
694  **/
695 gboolean
696 empathy_live_search_match (EmpathyLiveSearch *self,
697     const gchar *string)
698 {
699   EmpathyLiveSearchPriv *priv;
700
701   g_return_val_if_fail (EMPATHY_IS_LIVE_SEARCH (self), FALSE);
702
703   priv = GET_PRIV (self);
704
705   return empathy_live_search_match_words (string, priv->stripped_words);
706 }
707
708 gboolean
709 empathy_live_search_match_string (const gchar *string,
710     const gchar *prefix)
711 {
712   GPtrArray *words;
713   gboolean match;
714
715   words = empathy_live_search_strip_utf8_string (prefix);
716   match = empathy_live_search_match_words (string, words);
717   if (words != NULL)
718     g_ptr_array_unref (words);
719
720   return match;
721 }
722
723 GPtrArray *
724 empathy_live_search_get_words (EmpathyLiveSearch *self)
725 {
726   EmpathyLiveSearchPriv *priv = GET_PRIV (self);
727
728   return priv->stripped_words;
729 }