Massive moved some dirs from $(srcdir)/src into $(srcdir)/lib
[midnight-commander.git] / lib / search / regex.c
blob149155c4c3713057f060b99b9a0aa2a01e376d91
1 /*
2 Search text engine.
3 Regex search
5 Copyright (C) 2009 The Free Software Foundation, Inc.
7 Written by:
8 Slava Zanko <slavazanko@gmail.com>, 2009.
10 This file is part of the Midnight Commander.
12 The Midnight Commander is free software; you can redistribute it
13 and/or modify it under the terms of the GNU General Public License as
14 published by the Free Software Foundation; either version 2 of the
15 License, or (at your option) any later version.
17 The Midnight Commander is distributed in the hope that it will be
18 useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
25 MA 02110-1301, USA.
28 #include <config.h>
30 #include <stdlib.h>
32 #include "../src/global.h"
33 #include "../src/search/search.h"
34 #include "../src/search/internal.h"
35 #include "../src/strutil.h"
36 #include "../src/strescape.h"
37 #include "../src/charsets.h"
39 /*** global variables ****************************************************************************/
41 /*** file scope macro definitions ****************************************************************/
43 /*** file scope type declarations ****************************************************************/
45 typedef enum {
46 REPLACE_T_NO_TRANSFORM = 0,
47 REPLACE_T_UPP_TRANSFORM_CHAR = 1,
48 REPLACE_T_LOW_TRANSFORM_CHAR = 2,
49 REPLACE_T_UPP_TRANSFORM = 4,
50 REPLACE_T_LOW_TRANSFORM = 8
51 } replace_transform_type_t;
53 /*** file scope variables ************************************************************************/
55 /*** file scope functions ************************************************************************/
57 static gboolean
58 mc_search__regex_str_append_if_special (GString * copy_to, GString * regex_str, gsize * offset)
60 char *tmp_regex_str;
61 gsize spec_chr_len;
62 const char **spec_chr;
63 const char *special_chars[] = {
64 "\\s", "\\S",
65 "\\d", "\\D",
66 "\\b", "\\B",
67 "\\w", "\\W",
68 "\\t", "\\n",
69 "\\r", "\\f",
70 "\\a", "\\e",
71 "\\x", "\\X",
72 "\\c", "\\C",
73 "\\l", "\\L",
74 "\\u", "\\U",
75 "\\E", "\\Q",
76 NULL
78 spec_chr = special_chars;
80 tmp_regex_str = &(regex_str->str[*offset]);
82 while (*spec_chr) {
83 spec_chr_len = strlen (*spec_chr);
84 if (!strncmp (tmp_regex_str, *spec_chr, spec_chr_len)) {
85 if (!strutils_is_char_escaped (regex_str->str, tmp_regex_str)) {
86 if (!strncmp ("\\x", *spec_chr, spec_chr_len)) {
87 if (*(tmp_regex_str + spec_chr_len) == '{') {
88 while ((spec_chr_len < regex_str->len - *offset)
89 && *(tmp_regex_str + spec_chr_len) != '}')
90 spec_chr_len++;
91 if (*(tmp_regex_str + spec_chr_len) == '}')
92 spec_chr_len++;
93 } else
94 spec_chr_len += 2;
96 g_string_append_len (copy_to, tmp_regex_str, spec_chr_len);
97 *offset += spec_chr_len;
98 return TRUE;
101 spec_chr++;
103 return FALSE;
107 /* --------------------------------------------------------------------------------------------- */
108 static void
109 mc_search__cond_struct_new_regex_hex_add (const char *charset, GString * str_to,
110 const char *one_char, gsize str_len)
112 GString *upp, *low;
113 gchar *tmp_str;
114 gsize loop;
116 upp = mc_search__toupper_case_str (charset, one_char, str_len);
117 low = mc_search__tolower_case_str (charset, one_char, str_len);
119 for (loop = 0; loop < upp->len; loop++) {
121 if (loop < low->len) {
122 if (upp->str[loop] == low->str[loop])
123 tmp_str = g_strdup_printf ("\\x%02X", (unsigned char) upp->str[loop]);
124 else
125 tmp_str =
126 g_strdup_printf ("[\\x%02X\\x%02X]", (unsigned char) upp->str[loop],
127 (unsigned char) low->str[loop]);
128 } else {
129 tmp_str = g_strdup_printf ("\\x%02X", (unsigned char) upp->str[loop]);
131 g_string_append (str_to, tmp_str);
132 g_free (tmp_str);
134 g_string_free (upp, TRUE);
135 g_string_free (low, TRUE);
138 /* --------------------------------------------------------------------------------------------- */
140 static void
141 mc_search__cond_struct_new_regex_accum_append (const char *charset, GString * str_to,
142 GString * str_from)
144 GString *recoded_part;
145 gchar *one_char;
146 gsize loop;
147 gboolean just_letters;
149 loop = 0;
150 recoded_part = g_string_new ("");
152 while (loop < str_from->len) {
153 one_char =
154 mc_search__get_one_symbol (charset, &(str_from->str[loop]),
155 (str_from->len - loop > 6) ? 6 : str_from->len - loop,
156 &just_letters);
157 if (!strlen (one_char)) {
158 loop++;
159 continue;
161 if (just_letters) {
162 mc_search__cond_struct_new_regex_hex_add (charset, recoded_part, one_char,
163 strlen (one_char));
164 } else {
165 g_string_append (recoded_part, one_char);
167 loop += strlen (one_char);
168 if (!strlen (one_char))
169 loop++;
170 g_free (one_char);
173 g_string_append (str_to, recoded_part->str);
174 g_string_free (recoded_part, TRUE);
175 g_string_set_size (str_from, 0);
178 /* --------------------------------------------------------------------------------------------- */
180 static GString *
181 mc_search__cond_struct_new_regex_ci_str (const char *charset, const char *str, gsize str_len)
183 GString *accumulator, *spec_char, *ret_str;
184 gsize loop;
185 GString *tmp;
186 tmp = g_string_new_len (str, str_len);
189 ret_str = g_string_new ("");
190 accumulator = g_string_new ("");
191 spec_char = g_string_new ("");
192 loop = 0;
194 while (loop <= str_len) {
195 if (mc_search__regex_str_append_if_special (spec_char, tmp, &loop)) {
196 mc_search__cond_struct_new_regex_accum_append (charset, ret_str, accumulator);
197 g_string_append_len (ret_str, spec_char->str, spec_char->len);
198 g_string_set_size (spec_char, 0);
199 continue;
202 if (tmp->str[loop] == '[' && !strutils_is_char_escaped (tmp->str, &(tmp->str[loop]))) {
203 mc_search__cond_struct_new_regex_accum_append (charset, ret_str, accumulator);
205 while (loop < str_len && !(tmp->str[loop] == ']'
206 && !strutils_is_char_escaped (tmp->str,
207 &(tmp->str[loop])))) {
208 g_string_append_c (ret_str, tmp->str[loop]);
209 loop++;
212 g_string_append_c (ret_str, tmp->str[loop]);
213 loop++;
214 continue;
217 TODO: handle [ and ]
219 g_string_append_c (accumulator, tmp->str[loop]);
220 loop++;
222 mc_search__cond_struct_new_regex_accum_append (charset, ret_str, accumulator);
224 g_string_free (accumulator, TRUE);
225 g_string_free (spec_char, TRUE);
226 g_string_free (tmp, TRUE);
227 return ret_str;
230 /* --------------------------------------------------------------------------------------------- */
232 static mc_search__found_cond_t
233 mc_search__regex_found_cond_one (mc_search_t * lc_mc_search, mc_search_regex_t * regex,
234 GString * search_str)
236 #ifdef SEARCH_TYPE_GLIB
237 GError *error = NULL;
239 if (!g_regex_match_full
240 (regex, search_str->str, -1, 0, G_REGEX_MATCH_NEWLINE_ANY, &lc_mc_search->regex_match_info,
241 &error)) {
242 g_match_info_free (lc_mc_search->regex_match_info);
243 lc_mc_search->regex_match_info = NULL;
244 if (error) {
245 lc_mc_search->error = MC_SEARCH_E_REGEX;
246 lc_mc_search->error_str = str_conv_gerror_message (error, _(" Regular expression error "));
247 g_error_free (error);
248 return COND__FOUND_ERROR;
250 return COND__NOT_FOUND;
252 lc_mc_search->num_rezults = g_match_info_get_match_count (lc_mc_search->regex_match_info);
253 #else /* SEARCH_TYPE_GLIB */
254 lc_mc_search->num_rezults = pcre_exec (regex, lc_mc_search->regex_match_info,
255 search_str->str, search_str->len - 1, 0, 0, lc_mc_search->iovector,
256 MC_SEARCH__NUM_REPLACE_ARGS);
257 if (lc_mc_search->num_rezults < 0) {
258 return COND__NOT_FOUND;
260 #endif /* SEARCH_TYPE_GLIB */
261 return COND__FOUND_OK;
265 /* --------------------------------------------------------------------------------------------- */
267 static mc_search__found_cond_t
268 mc_search__regex_found_cond (mc_search_t * lc_mc_search, GString * search_str)
270 gsize loop1;
271 mc_search_cond_t *mc_search_cond;
272 mc_search__found_cond_t ret;
274 for (loop1 = 0; loop1 < lc_mc_search->conditions->len; loop1++) {
275 mc_search_cond = (mc_search_cond_t *) g_ptr_array_index (lc_mc_search->conditions, loop1);
277 if (!mc_search_cond->regex_handle)
278 continue;
280 ret = mc_search__regex_found_cond_one (lc_mc_search, mc_search_cond->regex_handle, search_str);
282 if (ret != COND__NOT_FOUND)
283 return ret;
285 return COND__NOT_ALL_FOUND;
288 /* --------------------------------------------------------------------------------------------- */
290 static int
291 mc_search_regex__get_max_num_of_replace_tokens (const gchar * str, gsize len)
293 int max_token = 0;
294 gsize loop;
295 for (loop = 0; loop < len - 1; loop++) {
296 if (str[loop] == '\\' && (str[loop + 1] & (char) 0xf0) == 0x30 /* 0-9 */ ) {
297 if (strutils_is_char_escaped (str, &str[loop]))
298 continue;
299 if (max_token < str[loop + 1] - '0')
300 max_token = str[loop + 1] - '0';
301 continue;
303 if (str[loop] == '$' && str[loop + 1] == '{') {
304 gsize tmp_len;
305 char *tmp_str;
306 int tmp_token;
307 if (strutils_is_char_escaped (str, &str[loop]))
308 continue;
310 for (tmp_len = 0;
311 loop + tmp_len + 2 < len && (str[loop + 2 + tmp_len] & (char) 0xf0) == 0x30;
312 tmp_len++);
313 if (str[loop + 2 + tmp_len] == '}') {
314 tmp_str = g_strndup (&str[loop + 2], tmp_len);
315 tmp_token = atoi (tmp_str);
316 if (max_token < tmp_token)
317 max_token = tmp_token;
318 g_free (tmp_str);
322 return max_token;
325 /* --------------------------------------------------------------------------------------------- */
327 static char *
328 mc_search_regex__get_token_by_num (const mc_search_t * lc_mc_search, gsize lc_index)
330 int fnd_start = 0, fnd_end = 0;
332 #ifdef SEARCH_TYPE_GLIB
333 g_match_info_fetch_pos (lc_mc_search->regex_match_info, lc_index, &fnd_start, &fnd_end);
334 #else /* SEARCH_TYPE_GLIB */
335 fnd_start = lc_mc_search->iovector[lc_index * 2 + 0];
336 fnd_end = lc_mc_search->iovector[lc_index * 2 + 1];
337 #endif /* SEARCH_TYPE_GLIB */
339 if (fnd_end - fnd_start == 0)
340 return NULL;
342 return g_strndup (lc_mc_search->regex_buffer->str + fnd_start, fnd_end - fnd_start);
346 /* --------------------------------------------------------------------------------------------- */
347 static int
348 mc_search_regex__process_replace_str (const GString * replace_str, const gsize current_pos,
349 gsize * skip_len, replace_transform_type_t * replace_flags)
351 int ret = -1;
352 char *tmp_str;
353 const char *curr_str = &(replace_str->str[current_pos]);
355 if (current_pos > replace_str->len)
356 return -1;
358 *skip_len = 0;
360 if (*curr_str == '$' && *(curr_str + 1) == '{' && (*(curr_str + 2) & (char) 0xf0) == 0x30) {
361 if (strutils_is_char_escaped (replace_str->str, curr_str)) {
362 *skip_len = 1;
363 return -1;
366 for (*skip_len = 0;
367 current_pos + *skip_len + 2 < replace_str->len
368 && (*(curr_str + 2 + *skip_len) & (char) 0xf0) == 0x30; (*skip_len)++);
370 if (*(curr_str + 2 + *skip_len) != '}')
371 return -1;
373 tmp_str = g_strndup (curr_str + 2, *skip_len);
374 if (tmp_str == NULL)
375 return -1;
377 ret = atoi (tmp_str);
378 g_free (tmp_str);
380 *skip_len += 3; /* ${} */
381 return ret;
384 if (*curr_str == '\\') {
385 if (strutils_is_char_escaped (replace_str->str, curr_str)) {
386 *skip_len = 1;
387 return -1;
390 if ((*(curr_str + 1) & (char) 0xf0) == 0x30) {
391 ret = *(curr_str + 1) - '0';
392 *skip_len = 2; /* \\ and one digit */
393 return ret;
395 ret = -2;
396 *skip_len += 2;
397 switch (*(curr_str + 1)) {
398 case 'U':
399 *replace_flags |= REPLACE_T_UPP_TRANSFORM;
400 *replace_flags &= ~REPLACE_T_LOW_TRANSFORM;
401 break;
402 case 'u':
403 *replace_flags |= REPLACE_T_UPP_TRANSFORM_CHAR;
404 break;
405 case 'L':
406 *replace_flags |= REPLACE_T_LOW_TRANSFORM;
407 *replace_flags &= ~REPLACE_T_UPP_TRANSFORM;
408 break;
409 case 'l':
410 *replace_flags |= REPLACE_T_LOW_TRANSFORM_CHAR;
411 break;
412 case 'E':
413 *replace_flags = REPLACE_T_NO_TRANSFORM;
414 break;
415 default:
416 ret = -1;
417 break;
420 return ret;
422 static void
423 mc_search_regex__process_append_str (GString * dest_str, const char *from, gsize len,
424 replace_transform_type_t * replace_flags)
426 gsize loop = 0;
427 gsize char_len;
428 char *tmp_str;
429 GString *tmp_string;
431 if (len == (gsize) -1)
432 len = strlen (from);
434 if (*replace_flags == REPLACE_T_NO_TRANSFORM) {
435 g_string_append_len (dest_str, from, len);
436 return;
438 while (loop < len) {
439 tmp_str = mc_search__get_one_symbol (NULL, from + loop, len - loop, NULL);
440 char_len = strlen (tmp_str);
441 if (*replace_flags & REPLACE_T_UPP_TRANSFORM_CHAR) {
442 *replace_flags &= !REPLACE_T_UPP_TRANSFORM_CHAR;
443 tmp_string = mc_search__toupper_case_str (NULL, tmp_str, char_len);
444 g_string_append (dest_str, tmp_string->str);
445 g_string_free (tmp_string, TRUE);
447 } else if (*replace_flags & REPLACE_T_LOW_TRANSFORM_CHAR) {
448 *replace_flags &= !REPLACE_T_LOW_TRANSFORM_CHAR;
449 tmp_string = mc_search__toupper_case_str (NULL, tmp_str, char_len);
450 g_string_append (dest_str, tmp_string->str);
451 g_string_free (tmp_string, TRUE);
453 } else if (*replace_flags & REPLACE_T_UPP_TRANSFORM) {
454 tmp_string = mc_search__toupper_case_str (NULL, tmp_str, char_len);
455 g_string_append (dest_str, tmp_string->str);
456 g_string_free (tmp_string, TRUE);
458 } else if (*replace_flags & REPLACE_T_LOW_TRANSFORM) {
459 tmp_string = mc_search__tolower_case_str (NULL, tmp_str, char_len);
460 g_string_append (dest_str, tmp_string->str);
461 g_string_free (tmp_string, TRUE);
463 } else {
464 g_string_append (dest_str, tmp_str);
466 g_free (tmp_str);
467 loop += char_len;
472 /*** public functions ****************************************************************************/
474 void
475 mc_search__cond_struct_new_init_regex (const char *charset, mc_search_t * lc_mc_search,
476 mc_search_cond_t * mc_search_cond)
478 GString *tmp = NULL;
479 #ifdef SEARCH_TYPE_GLIB
480 GError *error = NULL;
481 #else /* SEARCH_TYPE_GLIB */
482 const char *error;
483 int erroffset;
484 #endif /* SEARCH_TYPE_GLIB */
486 if (!lc_mc_search->is_case_sentitive) {
487 tmp = g_string_new_len (mc_search_cond->str->str, mc_search_cond->str->len);
488 g_string_free (mc_search_cond->str, TRUE);
489 mc_search_cond->str = mc_search__cond_struct_new_regex_ci_str (charset, tmp->str, tmp->len);
490 g_string_free (tmp, TRUE);
492 #ifdef SEARCH_TYPE_GLIB
493 mc_search_cond->regex_handle =
494 g_regex_new (mc_search_cond->str->str, G_REGEX_OPTIMIZE | G_REGEX_RAW | G_REGEX_DOTALL, 0,
495 &error);
497 if (error != NULL) {
498 lc_mc_search->error = MC_SEARCH_E_REGEX_COMPILE;
499 lc_mc_search->error_str = str_conv_gerror_message (error, _(" Regular expression error "));
500 g_error_free (error);
501 return;
503 #else /* SEARCH_TYPE_GLIB */
504 mc_search_cond->regex_handle =
505 pcre_compile (mc_search_cond->str->str, PCRE_EXTRA, &error, &erroffset, NULL);
506 if (mc_search_cond->regex_handle == NULL) {
507 lc_mc_search->error = MC_SEARCH_E_REGEX_COMPILE;
508 lc_mc_search->error_str = g_strdup (error);
509 return;
511 lc_mc_search->regex_match_info = pcre_study (mc_search_cond->regex_handle, 0, &error);
512 if (lc_mc_search->regex_match_info == NULL) {
513 if (error) {
514 lc_mc_search->error = MC_SEARCH_E_REGEX_COMPILE;
515 lc_mc_search->error_str = g_strdup (error);
516 g_free (mc_search_cond->regex_handle);
517 mc_search_cond->regex_handle = NULL;
518 return;
521 #endif /* SEARCH_TYPE_GLIB */
524 /* --------------------------------------------------------------------------------------------- */
526 gboolean
527 mc_search__run_regex (mc_search_t * lc_mc_search, const void *user_data,
528 gsize start_search, gsize end_search, gsize * found_len)
530 gsize current_pos, virtual_pos;
531 int current_chr = 0;
532 gint start_pos;
533 gint end_pos;
535 if (lc_mc_search->regex_buffer != NULL)
536 g_string_free (lc_mc_search->regex_buffer, TRUE);
538 lc_mc_search->regex_buffer = g_string_new ("");
540 virtual_pos = current_pos = start_search;
541 while (virtual_pos <= end_search) {
542 g_string_set_size (lc_mc_search->regex_buffer, 0);
543 lc_mc_search->start_buffer = current_pos;
545 while (1) {
546 current_chr = mc_search__get_char (lc_mc_search, user_data, current_pos);
547 if (current_chr == MC_SEARCH_CB_ABORT)
548 break;
550 current_pos++;
552 if (current_chr == MC_SEARCH_CB_SKIP)
553 continue;
555 virtual_pos++;
557 g_string_append_c (lc_mc_search->regex_buffer, (char) current_chr);
560 if (current_chr == 0 || (char) current_chr == '\n')
561 break;
563 if (virtual_pos > end_search)
564 break;
567 switch (mc_search__regex_found_cond (lc_mc_search, lc_mc_search->regex_buffer)) {
568 case COND__FOUND_OK:
569 #ifdef SEARCH_TYPE_GLIB
570 g_match_info_fetch_pos (lc_mc_search->regex_match_info, 0, &start_pos, &end_pos);
571 #else /* SEARCH_TYPE_GLIB */
572 start_pos = lc_mc_search->iovector[0];
573 end_pos = lc_mc_search->iovector[1];
574 #endif /* SEARCH_TYPE_GLIB */
575 if (found_len)
576 *found_len = end_pos - start_pos;
577 lc_mc_search->normal_offset = lc_mc_search->start_buffer + start_pos;
578 return TRUE;
579 break;
580 case COND__NOT_ALL_FOUND:
581 break;
582 default:
583 g_string_free (lc_mc_search->regex_buffer, TRUE);
584 lc_mc_search->regex_buffer = NULL;
585 return FALSE;
586 break;
588 if (( lc_mc_search->update_fn != NULL ) &&
589 ( (lc_mc_search->update_fn) (user_data, current_pos) == MC_SEARCH_CB_ABORT))
590 current_chr = MC_SEARCH_CB_ABORT;
592 if (current_chr == MC_SEARCH_CB_ABORT)
593 break;
595 g_string_free (lc_mc_search->regex_buffer, TRUE);
596 lc_mc_search->regex_buffer = NULL;
597 lc_mc_search->error = MC_SEARCH_E_NOTFOUND;
599 if (current_chr != MC_SEARCH_CB_ABORT)
600 lc_mc_search->error_str = g_strdup (_(STR_E_NOTFOUND));
601 else
602 lc_mc_search->error_str = NULL;
604 return FALSE;
607 /* --------------------------------------------------------------------------------------------- */
608 GString *
609 mc_search_regex_prepare_replace_str (mc_search_t * lc_mc_search, GString * replace_str)
611 GString *ret;
612 gchar *tmp_str;
614 int num_replace_tokens, lc_index;
615 gsize loop;
616 gsize len = 0;
617 gchar *prev_str;
618 replace_transform_type_t replace_flags = REPLACE_T_NO_TRANSFORM;
620 num_replace_tokens =
621 mc_search_regex__get_max_num_of_replace_tokens (replace_str->str, replace_str->len);
623 if (lc_mc_search->num_rezults < 0)
624 return g_string_new_len (replace_str->str, replace_str->len);
626 if (num_replace_tokens > lc_mc_search->num_rezults - 1
627 || num_replace_tokens > MC_SEARCH__NUM_REPLACE_ARGS) {
628 lc_mc_search->error = MC_SEARCH_E_REGEX_REPLACE;
629 lc_mc_search->error_str = g_strdup (STR_E_RPL_NOT_EQ_TO_FOUND);
630 return NULL;
633 ret = g_string_new ("");
634 prev_str = replace_str->str;
635 for (loop = 0; loop < replace_str->len - 1; loop++) {
636 lc_index = mc_search_regex__process_replace_str (replace_str, loop, &len, &replace_flags);
638 if (lc_index == -1) {
639 if (len != 0) {
640 mc_search_regex__process_append_str (ret, prev_str,
641 replace_str->str - prev_str + loop,
642 &replace_flags);
643 mc_search_regex__process_append_str (ret, replace_str->str + loop + 1, len - 1,
644 &replace_flags);
645 prev_str = replace_str->str + loop + len;
646 loop += len - 1;
648 continue;
651 if (lc_index == -2) {
652 if (loop)
653 mc_search_regex__process_append_str (ret, prev_str,
654 replace_str->str - prev_str + loop,
655 &replace_flags);
656 prev_str = replace_str->str + loop + len;
657 loop += len - 1;
658 continue;
661 if (lc_index > lc_mc_search->num_rezults) {
662 g_string_free (ret, TRUE);
663 lc_mc_search->error = MC_SEARCH_E_REGEX_REPLACE;
664 lc_mc_search->error_str = g_strdup_printf (STR_E_RPL_INVALID_TOKEN, lc_index);
665 return NULL;
668 tmp_str = mc_search_regex__get_token_by_num (lc_mc_search, lc_index);
669 if (tmp_str == NULL)
670 continue;
672 if (loop)
673 mc_search_regex__process_append_str (ret, prev_str, replace_str->str - prev_str + loop,
674 &replace_flags);
675 prev_str = replace_str->str + loop + len;
677 mc_search_regex__process_append_str (ret, tmp_str, -1, &replace_flags);
678 g_free (tmp_str);
679 loop += len - 1;
681 mc_search_regex__process_append_str (ret, prev_str,
682 replace_str->str - prev_str + replace_str->len,
683 &replace_flags);
685 return ret;