src/viewer/search.c

   1 /*
   2    Internal file viewer for the Midnight Commander
   3    Function for search data
   4
   5    Copyright (C) 1994-2016
   6    Free Software Foundation, Inc.
   7
   8    Written by:
   9    Miguel de Icaza, 1994, 1995, 1998
  10    Janne Kukonlehto, 1994, 1995
  11    Jakub Jelinek, 1995
  12    Joseph M. Hinkle, 1996
  13    Norbert Warmuth, 1997
  14    Pavel Machek, 1998
  15    Roland Illig <roland.illig@gmx.de>, 2004, 2005
  16    Slava Zanko <slavazanko@google.com>, 2009
  17    Andrew Borodin <aborodin@vmail.ru>, 2009, 2013
  18    Ilia Maslakov <il.smind@gmail.com>, 2009
  19
  20    This file is part of the Midnight Commander.
  21
  22    The Midnight Commander is free software: you can redistribute it
  23    and/or modify it under the terms of the GNU General Public License as
  24    published by the Free Software Foundation, either version 3 of the License,
  25    or (at your option) any later version.
  26
  27    The Midnight Commander is distributed in the hope that it will be useful,
  28    but WITHOUT ANY WARRANTY; without even the implied warranty of
  29    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  30    GNU General Public License for more details.
  31
  32    You should have received a copy of the GNU General Public License
  33    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  34  */
  35
  36 #include <config.h>
  37
  38 #include "lib/global.h"
  39 #include "lib/strutil.h"
  40 #include "lib/widget.h"
  41
  42 #include "src/setup.h"
  43
  44 #include "internal.h"
  45
  46 /*** global variables ****************************************************************************/
  47
  48 /*** file scope macro definitions ****************************************************************/
  49
  50 /*** file scope type declarations ****************************************************************/
  51
  52 typedef struct
  53 {
  54     simple_status_msg_t status_msg;     /* base class */
  55
  56     gboolean first;
  57     WView *view;
  58     off_t offset;
  59 } mcview_search_status_msg_t;
  60
  61 /*** file scope variables ************************************************************************/
  62
  63 static int search_cb_char_curr_index = -1;
  64 static char search_cb_char_buffer[6];
  65
  66 /* --------------------------------------------------------------------------------------------- */
  67 /*** file scope functions ************************************************************************/
  68 /* --------------------------------------------------------------------------------------------- */
  69
  70 static int
  71 mcview_search_status_update_cb (status_msg_t * sm)
  72 {
  73     simple_status_msg_t *ssm = SIMPLE_STATUS_MSG (sm);
  74     mcview_search_status_msg_t *vsm = (mcview_search_status_msg_t *) sm;
  75     Widget *wd = WIDGET (sm->dlg);
  76     int percent = -1;
  77
  78     if (verbose)
  79         percent = mcview_calc_percent (vsm->view, vsm->offset);
  80
  81     if (percent >= 0)
  82         label_set_textv (ssm->label, _("Searching %s: %3d%%"), vsm->view->last_search_string,
  83                          percent);
  84     else
  85         label_set_textv (ssm->label, _("Searching %s"), vsm->view->last_search_string);
  86
  87     if (vsm->first)
  88     {
  89         int wd_width;
  90         Widget *lw = WIDGET (ssm->label);
  91
  92         wd_width = MAX (wd->cols, lw->cols + 6);
  93         widget_set_size (wd, wd->y, wd->x, wd->lines, wd_width);
  94         widget_set_size (lw, lw->y, wd->x + (wd->cols - lw->cols) / 2, lw->lines, lw->cols);
  95         vsm->first = FALSE;
  96     }
  97
  98     return status_msg_common_update (sm);
  99 }
 100
 101 /* --------------------------------------------------------------------------------------------- */
 102
 103 static void
 104 mcview_search_update_steps (WView * view)
 105 {
 106     off_t filesize;
 107
 108     filesize = mcview_get_filesize (view);
 109
 110     if (filesize != 0)
 111         view->update_steps = filesize / 100;
 112     else                        /* viewing a data stream, not a file */
 113         view->update_steps = 40000;
 114
 115     /* Do not update the percent display but every 20 kb */
 116     if (view->update_steps < 20000)
 117         view->update_steps = 20000;
 118 }
 119
 120 /* --------------------------------------------------------------------------------------------- */
 121
 122 static gboolean
 123 mcview_find (mcview_search_status_msg_t * ssm, off_t search_start, off_t search_end, gsize * len)
 124 {
 125     WView *view = ssm->view;
 126
 127     view->search_numNeedSkipChar = 0;
 128     search_cb_char_curr_index = -1;
 129
 130     if (mcview_search_options.backwards)
 131     {
 132         search_end = mcview_get_filesize (view);
 133         while (search_start >= 0)
 134         {
 135             view->search_nroff_seq->index = search_start;
 136             mcview_nroff_seq_info (view->search_nroff_seq);
 137
 138             if (search_end > search_start + (off_t) view->search->original_len
 139                 && mc_search_is_fixed_search_str (view->search))
 140                 search_end = search_start + view->search->original_len;
 141
 142             if (mc_search_run (view->search, (void *) ssm, search_start, search_end, len)
 143                 && view->search->normal_offset == search_start)
 144             {
 145                 if (view->text_nroff_mode)
 146                     view->search->normal_offset++;
 147                 return TRUE;
 148             }
 149
 150             search_start--;
 151         }
 152
 153         mc_search_set_error (view->search, MC_SEARCH_E_NOTFOUND, "%s", _(STR_E_NOTFOUND));
 154         return FALSE;
 155     }
 156     view->search_nroff_seq->index = search_start;
 157     mcview_nroff_seq_info (view->search_nroff_seq);
 158
 159     return mc_search_run (view->search, (void *) ssm, search_start, search_end, len);
 160 }
 161
 162 /* --------------------------------------------------------------------------------------------- */
 163
 164 static void
 165 mcview_search_show_result (WView * view, size_t match_len)
 166 {
 167     int nroff_len;
 168
 169     nroff_len =
 170         view->text_nroff_mode
 171         ? mcview__get_nroff_real_len (view, view->search->start_buffer,
 172                                       view->search->normal_offset - view->search->start_buffer) : 0;
 173     view->search_start = view->search->normal_offset + nroff_len;
 174
 175     if (!view->hex_mode)
 176         view->search_start++;
 177
 178     nroff_len =
 179         view->text_nroff_mode ? mcview__get_nroff_real_len (view, view->search_start - 1,
 180                                                             match_len) : 0;
 181     view->search_end = view->search_start + match_len + nroff_len;
 182
 183     mcview_moveto_match (view);
 184 }
 185
 186 /* --------------------------------------------------------------------------------------------- */
 187 /*** public functions ****************************************************************************/
 188 /* --------------------------------------------------------------------------------------------- */
 189
 190 mc_search_cbret_t
 191 mcview_search_cmd_callback (const void *user_data, gsize char_offset, int *current_char)
 192 {
 193     WView *view = ((const mcview_search_status_msg_t *) user_data)->view;
 194
 195     /*    view_read_continue (view, &view->search_onechar_info); *//* AB:FIXME */
 196     if (!view->text_nroff_mode)
 197     {
 198         mcview_get_byte (view, char_offset, current_char);
 199         return MC_SEARCH_CB_OK;
 200     }
 201
 202     if (view->search_numNeedSkipChar != 0)
 203     {
 204         view->search_numNeedSkipChar--;
 205         return MC_SEARCH_CB_SKIP;
 206     }
 207
 208     if (search_cb_char_curr_index == -1
 209         || search_cb_char_curr_index >= view->search_nroff_seq->char_length)
 210     {
 211         if (search_cb_char_curr_index != -1)
 212             mcview_nroff_seq_next (view->search_nroff_seq);
 213
 214         search_cb_char_curr_index = 0;
 215         if (view->search_nroff_seq->char_length > 1)
 216             g_unichar_to_utf8 (view->search_nroff_seq->current_char, search_cb_char_buffer);
 217         else
 218             search_cb_char_buffer[0] = (char) view->search_nroff_seq->current_char;
 219
 220         if (view->search_nroff_seq->type != NROFF_TYPE_NONE)
 221         {
 222             switch (view->search_nroff_seq->type)
 223             {
 224             case NROFF_TYPE_BOLD:
 225                 view->search_numNeedSkipChar = 1 + view->search_nroff_seq->char_length; /* real char length and 0x8 */
 226                 break;
 227             case NROFF_TYPE_UNDERLINE:
 228                 view->search_numNeedSkipChar = 2;       /* underline symbol and ox8 */
 229                 break;
 230             default:
 231                 break;
 232             }
 233         }
 234         return MC_SEARCH_CB_INVALID;
 235     }
 236
 237     *current_char = search_cb_char_buffer[search_cb_char_curr_index];
 238     search_cb_char_curr_index++;
 239
 240     return (*current_char != -1) ? MC_SEARCH_CB_OK : MC_SEARCH_CB_INVALID;
 241 }
 242
 243 /* --------------------------------------------------------------------------------------------- */
 244
 245 mc_search_cbret_t
 246 mcview_search_update_cmd_callback (const void *user_data, gsize char_offset)
 247 {
 248     status_msg_t *sm = STATUS_MSG (user_data);
 249     mcview_search_status_msg_t *vsm = (mcview_search_status_msg_t *) user_data;
 250     mc_search_cbret_t result = MC_SEARCH_CB_OK;
 251
 252     vsm->offset = (off_t) char_offset;
 253     if (vsm->offset >= vsm->view->update_activate)
 254     {
 255         vsm->view->update_activate += vsm->view->update_steps;
 256
 257         if (sm->update (sm) == B_CANCEL)
 258             result = MC_SEARCH_CB_ABORT;
 259     }
 260
 261     /* may be in future return from this callback will change current position in searching block. */
 262
 263     return result;
 264 }
 265
 266 /* --------------------------------------------------------------------------------------------- */
 267
 268 void
 269 mcview_do_search (WView * view, off_t want_search_start)
 270 {
 271     mcview_search_status_msg_t vsm;
 272
 273     off_t search_start = 0;
 274     off_t orig_search_start = view->search_start;
 275     gboolean found = FALSE;
 276
 277     size_t match_len;
 278
 279     view->search_start = want_search_start;
 280     /* for avoid infinite search loop we need to increase or decrease start offset of search */
 281
 282     if (view->search_start != 0)
 283     {
 284         if (!view->text_nroff_mode)
 285             search_start = view->search_start + (mcview_search_options.backwards ? -2 : 0);
 286         else
 287         {
 288             if (mcview_search_options.backwards)
 289             {
 290                 mcview_nroff_t *nroff;
 291
 292                 nroff = mcview_nroff_seq_new_num (view, view->search_start);
 293                 if (mcview_nroff_seq_prev (nroff) != -1)
 294                     search_start =
 295                         -(mcview__get_nroff_real_len (view, nroff->index - 1, 2) +
 296                           nroff->char_length + 1);
 297                 else
 298                     search_start = -2;
 299
 300                 mcview_nroff_seq_free (&nroff);
 301             }
 302             else
 303             {
 304                 search_start = mcview__get_nroff_real_len (view, view->search_start + 1, 2);
 305             }
 306             search_start += view->search_start;
 307         }
 308     }
 309
 310     if (mcview_search_options.backwards && search_start < 0)
 311         search_start = 0;
 312
 313     /* Compute the percent steps */
 314     mcview_search_update_steps (view);
 315
 316     view->update_activate = search_start;
 317
 318     vsm.first = TRUE;
 319     vsm.view = view;
 320     vsm.offset = search_start;
 321
 322     status_msg_init (STATUS_MSG (&vsm), _("Search"), 1.0, simple_status_msg_init_cb,
 323                      mcview_search_status_update_cb, NULL);
 324
 325     do
 326     {
 327         off_t growbufsize;
 328
 329         if (view->growbuf_in_use)
 330             growbufsize = mcview_growbuf_filesize (view);
 331         else
 332             growbufsize = view->search->original_len;
 333
 334         if (mcview_find (&vsm, search_start, mcview_get_filesize (view), &match_len))
 335         {
 336             mcview_search_show_result (view, match_len);
 337             found = TRUE;
 338             break;
 339         }
 340
 341         if (view->search->error_str == NULL)
 342             break;
 343
 344         search_start = growbufsize - view->search->original_len;
 345     }
 346     while (search_start > 0 && mcview_may_still_grow (view));
 347
 348     status_msg_deinit (STATUS_MSG (&vsm));
 349
 350     if (orig_search_start != 0 && !found && !mcview_search_options.backwards)
 351     {
 352         view->search_start = orig_search_start;
 353         mcview_update (view);
 354
 355         if (query_dialog
 356             (_("Search done"), _("Continue from beginning?"), D_NORMAL, 2, _("&Yes"),
 357              _("&No")) != 0)
 358             found = TRUE;
 359         else
 360         {
 361             /* continue search from beginning */
 362             view->update_activate = 0;
 363
 364             vsm.first = TRUE;
 365             vsm.view = view;
 366             vsm.offset = 0;
 367
 368             status_msg_init (STATUS_MSG (&vsm), _("Search"), 1.0, simple_status_msg_init_cb,
 369                              mcview_search_status_update_cb, NULL);
 370
 371             /* search from file begin up to initial search start position */
 372             if (mcview_find (&vsm, 0, orig_search_start, &match_len))
 373             {
 374                 mcview_search_show_result (view, match_len);
 375                 found = TRUE;
 376             }
 377
 378             status_msg_deinit (STATUS_MSG (&vsm));
 379         }
 380     }
 381
 382     if (!found && view->search->error_str != NULL)
 383     {
 384         view->search_start = orig_search_start;
 385         mcview_update (view);
 386         query_dialog (_("Search"), view->search->error_str, D_NORMAL, 1, _("&Dismiss"));
 387     }
 388     view->dirty++;
 389 }
 390
 391 /* --------------------------------------------------------------------------------------------- */