GNOME Goal: Update icon names

[empathy.git] / libempathy-gtk / empathy-smiley-manager.c

diff --git a/libempathy-gtk/empathy-smiley-manager.c b/libempathy-gtk/empathy-smiley-manager.c
index 846b2b72be01ab0756babf67d5c6a4abf8836a2b..2e8ef3aa58140f057f77bf38f3a64375b8916959 100644 (file)
--- a/libempathy-gtk/empathy-smiley-manager.c
+++ b/libempathy-gtk/empathy-smiley-manager.c
@@ -20,13 +20,11 @@
  *          Xavier Claessens <xclaesse@gmail.com>
  */
 
-#include <config.h>
-
-#include <string.h>
-
-#include <libempathy/empathy-utils.h>
+#include "config.h"
 #include "empathy-smiley-manager.h"
+
 #include "empathy-ui-utils.h"
+#include "empathy-utils.h"
 
 typedef struct _SmileyManagerTree SmileyManagerTree;
 
@@ -39,7 +37,7 @@ typedef struct {
 struct _SmileyManagerTree {
        gunichar     c;
        GdkPixbuf   *pixbuf;
-       const gchar *path;
+       gchar       *path;
        GSList      *childrens;
 };
 
@@ -78,6 +76,7 @@ smiley_manager_tree_free (SmileyManagerTree *tree)
                g_object_unref (tree->pixbuf);
        }
        g_slist_free (tree->childrens);
+       g_free (tree->path);
        g_slice_free (SmileyManagerTree, tree);
 }
 
@@ -209,13 +208,13 @@ smiley_manager_tree_insert (SmileyManagerTree *tree,
        }
 
        child->pixbuf = g_object_ref (pixbuf);
-       child->path = path;
+       child->path = g_strdup (path);
 }
 
 static void
 smiley_manager_add_valist (EmpathySmileyManager *manager,
                           GdkPixbuf            *pixbuf,
-                          gchar                *path,
+                          const gchar          *path,
                           const gchar          *first_str,
                           va_list               var_args)
 {
@@ -227,7 +226,6 @@ smiley_manager_add_valist (EmpathySmileyManager *manager,
                smiley_manager_tree_insert (priv->tree, pixbuf, str, path);
        }
 
-       /* We give the ownership of path to the smiley */
        g_object_set_data_full (G_OBJECT (pixbuf), "smiley_str",
                                g_strdup (first_str), g_free);
        smiley = smiley_new (pixbuf, first_str);
@@ -256,6 +254,7 @@ empathy_smiley_manager_add (EmpathySmileyManager *manager,
                smiley_manager_add_valist (manager, pixbuf, path, first_str, var_args);
                va_end (var_args);
                g_object_unref (pixbuf);
+               g_free (path);
        }
 }
 
@@ -267,7 +266,7 @@ empathy_smiley_manager_load (EmpathySmileyManager *manager)
        /* From fd.o icon-naming spec */
        empathy_smiley_manager_add (manager, "face-angel",      "O:-)",  "O:)",  NULL);
        empathy_smiley_manager_add (manager, "face-angry",      "X-(",   ":@",   NULL);
-       empathy_smiley_manager_add (manager, "face-cool",       "B-)",   "B)",   NULL);
+       empathy_smiley_manager_add (manager, "face-cool",       "B-)",   NULL);
        empathy_smiley_manager_add (manager, "face-crying",     ":'(",           NULL);
        empathy_smiley_manager_add (manager, "face-devilish",   ">:-)",  ">:)",  NULL);
        empathy_smiley_manager_add (manager, "face-embarrassed",":-[",   ":[",   ":-$", ":$", NULL);
@@ -327,12 +326,22 @@ empathy_smiley_manager_parse_len (EmpathySmileyManager *manager,
        g_return_val_if_fail (EMPATHY_IS_SMILEY_MANAGER (manager), NULL);
        g_return_val_if_fail (text != NULL, NULL);
 
+       /* If len is negative, parse the string until we find '\0' */
        if (len < 0) {
                len = G_MAXSSIZE;
        }
 
+       /* Parse the len first bytes of text to find smileys. Each time a smiley
+        * is detected, append a EmpathySmileyHit struct to the returned list,
+        * containing the smiley pixbuf and the position of the text to be
+        * replaced by it.
+        * cur_str is a pointer in the text showing the current position
+        * of the parsing. It is always at the begining of an UTF-8 character,
+        * because we support unicode smileys! For example we could want to
+        * replace ™ by an image. */
+
        for (cur_str = text;
-            *cur_str && cur_str - text < len;
+            *cur_str != '\0' && cur_str - text < len;
             cur_str = g_utf8_next_char (cur_str)) {
                SmileyManagerTree *child;
                gunichar           c;
@@ -340,19 +349,27 @@ empathy_smiley_manager_parse_len (EmpathySmileyManager *manager,
                c = g_utf8_get_char (cur_str);
                child = smiley_manager_tree_find_child (cur_tree, c);
 
+               /* If we have a child it means c is part of a smiley */
                if (child) {
                        if (cur_tree == priv->tree) {
+                               /* c is the first char of some smileys, keep
+                                * the begining position */
                                start = cur_str;
                        }
                        cur_tree = child;
                        continue;
                }
 
+               /* c is not part of a smiley. let's check if we found a smiley
+                * before it. */
                if (cur_tree->pixbuf != NULL) {
+                       /* found! */
                        hit = smiley_hit_new (cur_tree, start - text,
                                              cur_str - text);
                        hits = g_slist_prepend (hits, hit);
 
+                       /* c was not part of this smiley, check if a new smiley
+                        * start with it. */
                        cur_tree = smiley_manager_tree_find_child (priv->tree, c);
                        if (cur_tree) {
                                start = cur_str;
@@ -360,11 +377,23 @@ empathy_smiley_manager_parse_len (EmpathySmileyManager *manager,
                                cur_tree = priv->tree;
                        }
                } else if (cur_tree != priv->tree) {
+                       /* We searched a smiley starting at 'start' but we ended
+                        * with no smiley. Look again starting from next char.
+                        *
+                        * For example ">:)" and ":(" are both valid smileys,
+                        * when parsing text ">:(" we first see '>' which could
+                        * be the start of a smiley. 'start' variable is set to
+                        * that position and we parse next char which is ':' and
+                        * is still potential smiley. Then we see '(' which is
+                        * NOT part of the smiley, ">:(" does not exist, so we
+                        * have to start again from ':' to find ":(" which is
+                        * correct smiley. */
                        cur_str = start;
                        cur_tree = priv->tree;
                }
        }
 
+       /* Check if last char of the text was the end of a smiley */
        if (cur_tree->pixbuf != NULL) {
                hit = smiley_hit_new (cur_tree, start - text, cur_str - text);
                hits = g_slist_prepend (hits, hit);