eel: Merge shell character escape functions

eel_str_escape_spaces and eel_str_escape_non_space_special_characters
are complementary to each other, as they are both used to escape special
characters for the shell. Merge them into
etc_str_escape_shell_characters to simplify usage.

Author: veractor

eel/eel-string.c

@@ -70,9 +70,9 @@ eel_str_double_underscores (const char *string)
 }
 
 char *
-eel_str_escape_spaces (const char *string)
+eel_str_escape_shell_characters (const char *string)
 {
-    int spaces;
+    int escape_characters;
     const char *p;
     char *q;
     char *escaped;
@@ -81,61 +81,53 @@ eel_str_escape_spaces (const char *string)
         return NULL;
     }
 
-    spaces = 0;
+    escape_characters = 0;
     for (p = string; *p != '\0'; p++) {
-        spaces += (*p == ' ');
-    }
+        switch (*p) {
+        case '\n':
+            escape_characters += 2;
+            break;
 
-    if (spaces == 0) {
-        return g_strdup (string);
-    }
+        case ' ':
+        case '\t':
+        case '\'':
+        case '"':
+        case '\\':
+        case '#':
+            escape_characters++;
+            break;
 
-    escaped = g_new (char, strlen (string) + spaces + 1);
-    for (p = string, q = escaped; *p != '\0'; p++, q++) {
-        /* Add an extra underscore. */
-        if (*p == ' ') {
-            *q++ = '\\';
+        default:
+            break;
         }
-        *q = *p;
-    }
-    *q = '\0';
-
-    return escaped;
-}
-
-char *
-eel_str_escape_non_space_special_characters (const char *string)
-{
-    int special_characters;
-    int newlines;
-    const char *p;
-    char *q;
-    char *escaped;
-
-    if (string == NULL) {
-        return NULL;
     }
 
-    special_characters = 0;
-    newlines = 0;
-    for (p = string; *p != '\0'; p++) {
-        special_characters += (*p == '\'') || (*p == '\"') || (*p == '\t') || (*p == '\\') || (*p == '#') ;
-        newlines += (*p == '\n');
-    }
-
-    if (special_characters + newlines == 0) {
+    if (escape_characters == 0) {
         return g_strdup (string);
     }
 
-    escaped = g_new (char, strlen (string) + special_characters + newlines * 2 + 1);
+    escaped = g_new (char, strlen (string) + escape_characters + 1);
     for (p = string, q = escaped; *p != '\0'; p++, q++) {
-        if ((*p == '\'') || (*p == '\"') || (*p == '\t') || (*p == '\\') || (*p == '#')) {
-            *q++ = '\\';
-        } else if (*p == '\n') {
-            *q++ = '\'';
-            *q++ = *p;
-            *q = '\'';
+        switch (*p) {
+        case '\n':
+            /* Quote newlines, as backslash-newline becomes nothing */
+            q[0] = '\'';
+            q[1] = '\n';
+            q[2] = '\'';
+            q += 3;
             continue;
+
+        case ' ':
+        case '\t':
+        case '\'':
+        case '"':
+        case '\\':
+        case '#':
+            *q++ = '\\';
+            break;
+
+        default:
+            break;
         }
         *q = *p;
     }

eel/eel-string.h

@@ -39,32 +39,30 @@
 /* NULL is allowed for all the str parameters to these functions. */
 
 /* Escape function for '_' character. */
-char *   eel_str_double_underscores                  (const char    *str);
-/* Escape function for spaces */
-char *   eel_str_escape_spaces                       (const char    *str);
-/* Escape function for non-space special characters in a GLib shell context. */
-char *   eel_str_escape_non_space_special_characters (const char    *str);
+char *   eel_str_double_underscores           (const char    *str);
+/* Escape function for special characters in a GLib shell context. */
+char *   eel_str_escape_shell_characters      (const char    *str);
 /* Escape function for content within double quotes in a GLib shell context. */
-char *   eel_str_escape_double_quoted_content        (const char    *str);
+char *   eel_str_escape_double_quoted_content (const char    *str);
 /* Capitalize a string */
-char *   eel_str_capitalize                          (const char    *str);
+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.
  */
-char *   eel_str_middle_truncate                     (const char    *str,
-						      guint          truncate_length);
+char *   eel_str_middle_truncate              (const char    *str,
+					       guint          truncate_length);
 
 
 /* Remove all characters after the passed-in substring. */
-char *   eel_str_strip_substring_and_after           (const char    *str,
-						      const char    *substring);
+char *   eel_str_strip_substring_and_after    (const char    *str,
+					       const char    *substring);
 
 /* Replace all occurrences of substring with replacement. */
-char *   eel_str_replace_substring                   (const char    *str,
-						      const char    *substring,
-						      const char    *replacement);
+char *   eel_str_replace_substring            (const char    *str,
+					       const char    *substring,
+					       const char    *replacement);
 
 typedef char * eel_ref_str;
 

libnemo-private/nemo-action.c

@@ -1223,9 +1223,7 @@ get_path (NemoAction *action, NemoFile *file)
         // Replace literal ' with a close ', a \', and an open '
         ret = eel_str_replace_substring (orig, "'", "'\\''");
     } else {
-        escaped = eel_str_escape_non_space_special_characters (orig);
-        ret = eel_str_escape_spaces (escaped);
-        g_free (escaped);
+        ret = eel_str_escape_shell_characters (orig);
     }
 
     g_free (orig);
@@ -1287,7 +1285,7 @@ get_device_path (NemoAction *action, NemoFile *file)
     g_return_val_if_fail (mount != NULL, NULL);
 
     GVolume *volume = g_mount_get_volume (mount);
-    gchar *ret, *escaped, *id;
+    gchar *ret, *id;
 
     id = g_volume_get_identifier (volume, G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE);
 
@@ -1297,9 +1295,7 @@ get_device_path (NemoAction *action, NemoFile *file)
         // Replace literal ' with a close ', a \', and an open '
         ret = eel_str_replace_substring (id, "'", "'\\''");
     } else {
-        escaped = eel_str_escape_non_space_special_characters (id);
-        ret = eel_str_escape_spaces (escaped);
-        g_free (escaped);
+        ret = eel_str_escape_shell_characters (id);
     }
 
     g_free (id);