Ticket #3694: 3694-0002-Hex-patterns-report-errors-to-the-user.patch

lib/search/hex.c

@@ -39 +39 @@
 
 /*** file scope macro definitions ****************************************************************/
 
+typedef enum
+{
+    MC_SEARCH_HEX_E_OK,
+    MC_SEARCH_HEX_E_NUM_OUT_OF_RANGE
+} mc_search_hex_parse_error_t;
+
 /*** file scope type declarations ****************************************************************/
 
 /*** file scope variables ************************************************************************/
@@ -46 +52 @@
 /*** file scope functions ************************************************************************/
 
 static GString *
-mc_search__hex_translate_to_regex (const GString * astr)
+mc_search__hex_translate_to_regex (const GString * astr, mc_search_hex_parse_error_t * error_ptr,
+                                   int *error_pos_ptr)
 {
     GString *buff;
     gchar *tmp_str, *tmp_str2;
     gsize tmp_str_len;
     gsize loop = 0;
+    mc_search_hex_parse_error_t error = MC_SEARCH_HEX_E_OK;
 
     buff = g_string_sized_new (64);
     tmp_str = g_strndup (astr->str, astr->len);
@@ -71 +79 @@
     g_strchug (tmp_str);        /* trim leadind whitespaces */
     tmp_str_len = strlen (tmp_str);
 
-    while (loop < tmp_str_len)
+    while (loop < tmp_str_len && error == MC_SEARCH_HEX_E_OK)
     {
         unsigned int val;
         int ptr;
@@ -80 +88 @@
         if (sscanf (tmp_str + loop, "%x%n", &val, &ptr))
         {
             if (val > 255)
-                loop++;
+                error = MC_SEARCH_HEX_E_NUM_OUT_OF_RANGE;
             else
             {
                 g_string_append_printf (buff, "\\x%02X", val);
@@ -109 +117 @@
 
     g_free (tmp_str);
 
+    if (error != MC_SEARCH_HEX_E_OK)
+    {
+        g_string_free (buff, TRUE);
+        if (error_ptr != NULL)
+            *error_ptr = error;
+        if (error_pos_ptr != NULL)
+            *error_pos_ptr = loop;
+        return NULL;
+    }
+
     return buff;
 }
 
@@ -119 +137 @@
                                      mc_search_cond_t * mc_search_cond)
 {
     GString *tmp;
+    mc_search_hex_parse_error_t error;
+    int error_pos;
 
     g_string_ascii_down (mc_search_cond->str);
-    tmp = mc_search__hex_translate_to_regex (mc_search_cond->str);
-    g_string_free (mc_search_cond->str, TRUE);
-    mc_search_cond->str = tmp;
+    tmp = mc_search__hex_translate_to_regex (mc_search_cond->str, &error, &error_pos);
+    if (tmp != NULL)
+    {
+        g_string_free (mc_search_cond->str, TRUE);
+        mc_search_cond->str = tmp;
+        mc_search__cond_struct_new_init_regex (charset, lc_mc_search, mc_search_cond);
+    }
+    else
+    {
+        const char *desc;
+
+        switch (error)
+        {
+        case MC_SEARCH_HEX_E_NUM_OUT_OF_RANGE:
+            desc =
+                _
+                ("Number out of range (should be in byte range, 0 <= n <= 0xFF, expressed in hex)");
+            break;
+        default:
+            desc = "";
+        }
 
-    mc_search__cond_struct_new_init_regex (charset, lc_mc_search, mc_search_cond);
+        lc_mc_search->error = MC_SEARCH_E_INPUT;
+        lc_mc_search->error_str =
+            g_strdup_printf (_("Hex pattern error at position %d:\n%s."), error_pos + 1, desc);
+    }
 }
 
 /* --------------------------------------------------------------------------------------------- */

tests/lib/search/hex_translate_to_regex.c

@@ -34 +34 @@
 {
     const char *input_value;
     const char *expected_result;
+    mc_search_hex_parse_error_t expected_error;
 } test_hex_translate_to_regex_ds[] =
 {
     {
         /* Simplest case */
         "12 34",
-        "\\x12\\x34"
+        "\\x12\\x34",
+        MC_SEARCH_HEX_E_OK
     },
     {
         /* Prefixes (0x, 0X) */
         "0x12 0X34",
-        "\\x12\\x34"
+        "\\x12\\x34",
+        MC_SEARCH_HEX_E_OK
     },
     {
         /* Prefix "0" doesn't signify octal! Numbers are always interpreted in hex. */
         "012",
-        "\\x12"
+        "\\x12",
+        MC_SEARCH_HEX_E_OK
     },
     {
         /* Extra whitespace (but not trailing one) */
         "  12  34",
-        "\\x12\\x34"
+        "\\x12\\x34",
+        MC_SEARCH_HEX_E_OK
     },
     {
         /* Min/max values */
         "0 ff",
-        "\\x00\\xFF"
+        "\\x00\\xFF",
+        MC_SEARCH_HEX_E_OK
+    },
+    {
+        /* Error: Number out of range */
+        "100",
+        NULL,
+        MC_SEARCH_HEX_E_NUM_OUT_OF_RANGE
+    },
+    {
+        /* Error: Number out of range (negative) */
+        "-1",
+        NULL,
+        MC_SEARCH_HEX_E_NUM_OUT_OF_RANGE
     },
 };
 /* *INDENT-ON* */
@@ -72 +90 @@
     /* given */
     GString *tmp = g_string_new (data->input_value);
     GString *dest_str;
+    mc_search_hex_parse_error_t error;
 
     /* when */
-    dest_str = mc_search__hex_translate_to_regex (tmp);
+    dest_str = mc_search__hex_translate_to_regex (tmp, &error, NULL);
 
     /* then */
     g_string_free (tmp, TRUE);
 
-    mctest_assert_str_eq (dest_str->str, data->expected_result);
-    g_string_free (dest_str, TRUE);
+    if (dest_str != NULL)
+    {
+        mctest_assert_str_eq (dest_str->str, data->expected_result);
+        g_string_free (dest_str, TRUE);
+    }
+    else
+    {
+        mctest_assert_int_eq (error, data->expected_error);
+    }
 }
 /* *INDENT-OFF* */
 END_PARAMETRIZED_TEST