eel: string: refactor middle truncation

This commit tries to make the function more readable and fixes the allocation of
the new string: the truncated string is of the same size as the source string.
This can be fixed by adding a couple of different allocations. :)
Some comments were trimmed down or removed.

2 files changed, 42 insertions, 51 deletions

diff --git a/eel/eel-string.c b/eel/eel-string.c
index df1209919..332240fb4 100644
--- a/eel/eel-string.c
+++ b/eel/eel-string.c
@@ -89,67 +89,47 @@ eel_str_capitalize (const char *string)
     return capitalized;
 }
 
-/**
- * eel_str_middle_truncate:
- * @string: the original string
- * @truncate_length: the number of characters of the truncated string (min. 3).
- *
- * Replaces a number of characters in the middle of a @string with an ellipsis
- * character, to obtain a number of characters equal to @truncate_length, if the
- * original @string is longer than that.
- *
- * Useful to ellipsise a variable substring (such as a file name) with variable
- * lengh. Do not use this for full labels, use PangoLayout instead.
- *
- * Returns: (transfer full): a newly allocated truncated string, or a copy of
- * @string if it was not longer than @truncate_length.
- **/
-char *
-eel_str_middle_truncate (const char *string,
-                         guint       truncate_length)
+gchar *
+eel_str_middle_truncate (const gchar *string,
+                         guint        truncate_length)
 {
-    char *truncated;
-    guint length;
-    guint num_left_chars;
-    guint num_right_chars;
-
-    const char delimter[] = "…";
-    const guint delimter_length = strlen (delimter);
-    const guint min_truncate_length = delimter_length + 2;
-
-    if (string == NULL)
-    {
-        return NULL;
-    }
-
-    /* It doesnt make sense to truncate strings to less than
-     * the size of the delimiter plus 2 characters (one on each
-     * side)
-     */
-    if (truncate_length < min_truncate_length)
+    const gchar ellipsis[] = "…";
+    glong ellipsis_length;
+    glong length;
+    glong num_left_chars;
+    glong num_right_chars;
+    g_autofree gchar *left_substring = NULL;
+    g_autofree gchar *right_substring = NULL;
+
+    g_return_val_if_fail (string != NULL, NULL);
+    g_return_val_if_fail (truncate_length > 0, NULL);
+    g_return_val_if_fail (truncate_length <= G_MAXLONG, NULL);
+
+    ellipsis_length = g_utf8_strlen (ellipsis, -1);
+
+    /* Our ellipsis string + one character on each side. */
+    if (truncate_length < ellipsis_length + 2)
     {
         return g_strdup (string);
     }
 
     length = g_utf8_strlen (string, -1);
 
-    /* Make sure the string is not already small enough. */
     if (length <= truncate_length)
     {
         return g_strdup (string);
     }
 
-    /* Find the 'middle' where the truncation will occur. */
-    num_left_chars = (truncate_length - delimter_length) / 2;
-    num_right_chars = truncate_length - num_left_chars - delimter_length;
+    num_left_chars = (truncate_length - ellipsis_length) / 2;
+    num_right_chars = truncate_length - num_left_chars - ellipsis_length;
 
-    truncated = g_new (char, strlen (string) + 1);
+    g_assert (num_left_chars > 0);
+    g_assert (num_right_chars > 0);
 
-    g_utf8_strncpy (truncated, string, num_left_chars);
-    strcat (truncated, delimter);
-    strcat (truncated, g_utf8_offset_to_pointer (string, length - num_right_chars));
+    left_substring = g_utf8_substring (string, 0, num_left_chars);
+    right_substring = g_utf8_substring (string, length - num_right_chars, length);
 
-    return truncated;
+    return g_strconcat (left_substring, ellipsis, right_substring, NULL);
 }
 
 char *
diff --git a/eel/eel-string.h b/eel/eel-string.h
index 5df4b6b2a..23485104a 100644
--- a/eel/eel-string.h
+++ b/eel/eel-string.h
@@ -41,12 +41,23 @@ char *   eel_str_double_underscores        (const char    *str);
 /* Capitalize a string */
 char *   eel_str_capitalize                (const char    *str);
 
-/* Middle truncate a string to a maximum of truncate_length characters.
- * The resulting string will be truncated in the middle with a "..."
- * delimiter.
+/**
+ * eel_str_middle_truncate:
+ * @string: the string to truncate
+ * @truncate_length: the length limit at which to truncate
+ *
+ * If @string is longer than @truncate_length, replaces the middle with an
+ * ellipsis so the resulting string is exactly @truncate_length characters
+ * in length. Otherwise, returns a copy of @string.
+ *
+ * Do not use to ellipsize whole labels, only substrings that appear in them,
+ * e.g. file names.
+ *
+ * Returns: @string, truncated at the middle to @truncate_length or a copy
+ * if it was not longer than @truncate_length.
  */
-char *   eel_str_middle_truncate           (const char    *str,
-					    guint          truncate_length);
+gchar   *eel_str_middle_truncate           (const gchar   *string,
+                                            guint          truncate_length);
 
 
 /* Remove all characters after the passed-in substring. */