src/editor/editcmd_dialogs.c

   1 /*
   2    Editor dialogs for high level editing commands
   3
   4    Copyright (C) 2009, 2011, 2012, 2013
   5    The Free Software Foundation, Inc.
   6
   7    Written by:
   8    Slava Zanko <slavazanko@gmail.com>, 2009
   9    Andrew Borodin, <aborodin@vmail.ru>, 2012, 2013
  10
  11    This file is part of the Midnight Commander.
  12
  13    The Midnight Commander is free software: you can redistribute it
  14    and/or modify it under the terms of the GNU General Public License as
  15    published by the Free Software Foundation, either version 3 of the License,
  16    or (at your option) any later version.
  17
  18    The Midnight Commander is distributed in the hope that it will be useful,
  19    but WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21    GNU General Public License for more details.
  22
  23    You should have received a copy of the GNU General Public License
  24    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  25  */
  26
  27 #include <config.h>
  28
  29 #include "lib/global.h"
  30 #include "lib/tty/tty.h"
  31 #include "lib/skin.h"           /* INPUT_COLOR */
  32 #include "lib/tty/key.h"
  33 #include "lib/search.h"
  34 #include "lib/strutil.h"
  35 #include "lib/widget.h"
  36 #ifdef HAVE_CHARSET
  37 #include "lib/charsets.h"
  38 #endif
  39
  40 #include "src/history.h"
  41
  42 #include "src/editor/editwidget.h"
  43 #include "src/editor/etags.h"
  44 #include "src/editor/editcmd_dialogs.h"
  45
  46 #ifdef HAVE_ASPELL
  47 #include "src/editor/spell.h"
  48 #endif
  49
  50 /*** global variables ****************************************************************************/
  51
  52 edit_search_options_t edit_search_options = {
  53     .type = MC_SEARCH_T_NORMAL,
  54     .case_sens = FALSE,
  55     .backwards = FALSE,
  56     .only_in_selection = FALSE,
  57     .whole_words = FALSE,
  58     .all_codepages = FALSE
  59 };
  60
  61 /*** file scope macro definitions ****************************************************************/
  62
  63 /*** file scope type declarations ****************************************************************/
  64
  65 /*** file scope variables ************************************************************************/
  66
  67 /*** file scope functions ************************************************************************/
  68 /* --------------------------------------------------------------------------------------------- */
  69
  70 static cb_ret_t
  71 editcmd_dialog_raw_key_query_cb (Widget * w, Widget * sender, widget_msg_t msg, int parm,
  72                                  void *data)
  73 {
  74     WDialog *h = DIALOG (w);
  75
  76     switch (msg)
  77     {
  78     case MSG_KEY:
  79         h->ret_value = parm;
  80         dlg_stop (h);
  81         return MSG_HANDLED;
  82     default:
  83         return dlg_default_callback (w, sender, msg, parm, data);
  84     }
  85 }
  86
  87 /* --------------------------------------------------------------------------------------------- */
  88 /*** public functions ****************************************************************************/
  89 /* --------------------------------------------------------------------------------------------- */
  90
  91 gboolean
  92 editcmd_dialog_search_show (WEdit * edit)
  93 {
  94     char *search_text;
  95     size_t num_of_types;
  96     gchar **list_of_types;
  97     int dialog_result;
  98
  99     list_of_types = mc_search_get_types_strings_array (&num_of_types);
 100
 101     {
 102         quick_widget_t quick_widgets[] = {
 103             /* *INDENT-OFF* */
 104             QUICK_LABELED_INPUT (N_("Enter search string:"), input_label_above, INPUT_LAST_TEXT,
 105                                  MC_HISTORY_SHARED_SEARCH, &search_text, NULL, FALSE, FALSE,
 106                                  INPUT_COMPLETE_NONE),
 107             QUICK_SEPARATOR (TRUE),
 108             QUICK_START_COLUMNS,
 109                 QUICK_RADIO (num_of_types, (const char **) list_of_types,
 110                              (int *) &edit_search_options.type, NULL),
 111             QUICK_NEXT_COLUMN,
 112                 QUICK_CHECKBOX (N_("Cas&e sensitive"), &edit_search_options.case_sens, NULL),
 113                 QUICK_CHECKBOX (N_("&Backwards"), &edit_search_options.backwards, NULL),
 114                 QUICK_CHECKBOX (N_("In se&lection"), &edit_search_options.only_in_selection, NULL),
 115                 QUICK_CHECKBOX (N_("&Whole words"), &edit_search_options.whole_words, NULL),
 116 #ifdef HAVE_CHARSET
 117                 QUICK_CHECKBOX (N_("&All charsets"), &edit_search_options.all_codepages, NULL),
 118 #endif
 119             QUICK_STOP_COLUMNS,
 120             QUICK_START_BUTTONS (TRUE, TRUE),
 121                 QUICK_BUTTON (N_("&OK"), B_ENTER, NULL, NULL),
 122                 QUICK_BUTTON (N_("&Find all"), B_USER, NULL, NULL),
 123                 QUICK_BUTTON (N_("&Cancel"), B_CANCEL, NULL, NULL),
 124             QUICK_END
 125             /* *INDENT-ON* */
 126         };
 127
 128         quick_dialog_t qdlg = {
 129             -1, -1, 58,
 130             N_("Search"), "[Input Line Keys]",
 131             quick_widgets, NULL, NULL
 132         };
 133
 134         dialog_result = quick_dialog (&qdlg);
 135     }
 136
 137     g_strfreev (list_of_types);
 138
 139     if ((dialog_result == B_CANCEL) || (search_text == NULL) || (search_text[0] == '\0'))
 140     {
 141         g_free (search_text);
 142         return FALSE;
 143     }
 144
 145     if (dialog_result == B_USER)
 146         search_create_bookmark = TRUE;
 147
 148 #ifdef HAVE_CHARSET
 149     {
 150         GString *tmp;
 151
 152         tmp = str_convert_to_input (search_text);
 153         if (tmp != NULL)
 154         {
 155             g_free (search_text);
 156             search_text = g_string_free (tmp, FALSE);
 157         }
 158     }
 159 #endif
 160
 161     g_free (edit->last_search_string);
 162     edit->last_search_string = search_text;
 163     mc_search_free (edit->search);
 164
 165 #ifdef HAVE_CHARSET
 166     edit->search = mc_search_new (edit->last_search_string, -1, cp_source);
 167 #else
 168     edit->search = mc_search_new (edit->last_search_string, -1, NULL);
 169 #endif
 170     if (edit->search != NULL)
 171     {
 172         edit->search->search_type = edit_search_options.type;
 173 #ifdef HAVE_CHARSET
 174         edit->search->is_all_charsets = edit_search_options.all_codepages;
 175 #endif
 176         edit->search->is_case_sensitive = edit_search_options.case_sens;
 177         edit->search->whole_words = edit_search_options.whole_words;
 178         edit->search->search_fn = edit_search_cmd_callback;
 179     }
 180
 181     return (edit->search != NULL);
 182 }
 183
 184 /* --------------------------------------------------------------------------------------------- */
 185
 186 void
 187 editcmd_dialog_replace_show (WEdit * edit, const char *search_default, const char *replace_default,
 188                              /*@out@ */ char **search_text, /*@out@ */ char **replace_text)
 189 {
 190     size_t num_of_types;
 191     gchar **list_of_types;
 192
 193     if ((search_default == NULL) || (*search_default == '\0'))
 194         search_default = INPUT_LAST_TEXT;
 195
 196     list_of_types = mc_search_get_types_strings_array (&num_of_types);
 197
 198     {
 199         quick_widget_t quick_widgets[] = {
 200             /* *INDENT-OFF* */
 201             QUICK_LABELED_INPUT (N_("Enter search string:"), input_label_above, search_default,
 202                                  MC_HISTORY_SHARED_SEARCH, search_text, NULL, FALSE, FALSE,
 203                                  INPUT_COMPLETE_NONE),
 204             QUICK_LABELED_INPUT (N_("Enter replacement string:"), input_label_above, replace_default,
 205                                  "replace", replace_text, NULL, FALSE, FALSE, INPUT_COMPLETE_NONE),
 206             QUICK_SEPARATOR (TRUE),
 207             QUICK_START_COLUMNS,
 208                 QUICK_RADIO (num_of_types, (const char **) list_of_types,
 209                              (int *) &edit_search_options.type, NULL),
 210             QUICK_NEXT_COLUMN,
 211                 QUICK_CHECKBOX (N_("Cas&e sensitive"), &edit_search_options.case_sens, NULL),
 212                 QUICK_CHECKBOX (N_("&Backwards"), &edit_search_options.backwards, NULL),
 213                 QUICK_CHECKBOX (N_("In se&lection"), &edit_search_options.only_in_selection, NULL),
 214                 QUICK_CHECKBOX (N_("&Whole words"), &edit_search_options.whole_words, NULL),
 215 #ifdef HAVE_CHARSET
 216                 QUICK_CHECKBOX (N_("&All charsets"), &edit_search_options.all_codepages, NULL),
 217 #endif
 218             QUICK_STOP_COLUMNS,
 219             QUICK_BUTTONS_OK_CANCEL,
 220             QUICK_END
 221             /* *INDENT-ON* */
 222         };
 223
 224         quick_dialog_t qdlg = {
 225             -1, -1, 58,
 226             N_("Replace"), "[Input Line Keys]",
 227             quick_widgets, NULL, NULL
 228         };
 229
 230         if (quick_dialog (&qdlg) != B_CANCEL)
 231             edit->replace_mode = 0;
 232         else
 233         {
 234             *replace_text = NULL;
 235             *search_text = NULL;
 236         }
 237     }
 238
 239     g_strfreev (list_of_types);
 240 }
 241
 242 /* --------------------------------------------------------------------------------------------- */
 243
 244 int
 245 editcmd_dialog_replace_prompt_show (WEdit * edit, char *from_text, char *to_text, int xpos,
 246                                     int ypos)
 247 {
 248     Widget *w = WIDGET (edit);
 249
 250     /* dialog size */
 251     int dlg_height = 10;
 252     int dlg_width;
 253
 254     char tmp[BUF_MEDIUM];
 255     char *repl_from, *repl_to;
 256     int retval;
 257
 258     if (xpos == -1)
 259         xpos = w->x + option_line_state_width + 1;
 260     if (ypos == -1)
 261         ypos = w->y + w->lines / 2;
 262     /* Sometimes menu can hide replaced text. I don't like it */
 263     if ((edit->curs_row >= ypos - 1) && (edit->curs_row <= ypos + dlg_height - 1))
 264         ypos -= dlg_height;
 265
 266     dlg_width = WIDGET (w->owner)->cols - xpos - 1;
 267
 268     g_snprintf (tmp, sizeof (tmp), "\"%s\"", from_text);
 269     repl_from = g_strdup (str_trunc (tmp, dlg_width - 7));
 270
 271     g_snprintf (tmp, sizeof (tmp), "\"%s\"", to_text);
 272     repl_to = g_strdup (str_trunc (tmp, dlg_width - 7));
 273
 274     {
 275         quick_widget_t quick_widgets[] = {
 276             /* *INDENT-OFF* */
 277             QUICK_LABEL (repl_from, NULL),
 278             QUICK_LABEL (N_("Replace with:"), NULL),
 279             QUICK_LABEL (repl_to, NULL),
 280             QUICK_START_BUTTONS (TRUE, TRUE),
 281                 QUICK_BUTTON (N_("&Replace"), B_ENTER, NULL, NULL),
 282                 QUICK_BUTTON (N_("A&ll"), B_REPLACE_ALL, NULL, NULL),
 283                 QUICK_BUTTON (N_("&Skip"), B_SKIP_REPLACE, NULL, NULL),
 284                 QUICK_BUTTON (N_("&Cancel"), B_CANCEL, NULL, NULL),
 285             QUICK_END
 286             /* *INDENT-ON* */
 287         };
 288
 289         quick_dialog_t qdlg = {
 290             ypos, xpos, -1,
 291             N_("Confirm replace"), NULL,
 292             quick_widgets, NULL, NULL
 293         };
 294
 295         retval = quick_dialog (&qdlg);
 296     }
 297
 298     g_free (repl_from);
 299     g_free (repl_to);
 300
 301     return retval;
 302 }
 303
 304 /* --------------------------------------------------------------------------------------------- */
 305 /* gets a raw key from the keyboard. Passing cancel = 1 draws
 306    a cancel button thus allowing c-c etc.  Alternatively, cancel = 0
 307    will return the next key pressed.  ctrl-a (=B_CANCEL), ctrl-g, ctrl-c,
 308    and Esc are cannot returned */
 309
 310 int
 311 editcmd_dialog_raw_key_query (const char *heading, const char *query, gboolean cancel)
 312 {
 313     int w, wq;
 314     int y = 2;
 315     WDialog *raw_dlg;
 316
 317     w = str_term_width1 (heading) + 6;
 318     wq = str_term_width1 (query);
 319     w = max (w, wq + 3 * 2 + 1 + 2);
 320
 321     raw_dlg =
 322         dlg_create (TRUE, 0, 0, cancel ? 7 : 5, w, dialog_colors, editcmd_dialog_raw_key_query_cb,
 323                     NULL, NULL, heading, DLG_CENTER | DLG_TRYUP | DLG_WANT_TAB);
 324
 325     add_widget (raw_dlg, label_new (y, 3, query));
 326     add_widget (raw_dlg, input_new (y++, 3 + wq + 1, input_get_default_colors (),
 327                                     w - (6 + wq + 1), "", 0, INPUT_COMPLETE_NONE));
 328     if (cancel)
 329     {
 330         add_widget (raw_dlg, hline_new (y++, -1, -1));
 331         /* Button w/o hotkey to allow use any key as raw or macro one */
 332         add_widget_autopos (raw_dlg, button_new (y, 1, B_CANCEL, NORMAL_BUTTON, _("Cancel"), NULL),
 333                             WPOS_KEEP_TOP | WPOS_CENTER_HORZ, NULL);
 334     }
 335
 336     w = dlg_run (raw_dlg);
 337     dlg_destroy (raw_dlg);
 338
 339     return (cancel && (w == ESC_CHAR || w == B_CANCEL)) ? 0 : w;
 340 }
 341
 342 /* --------------------------------------------------------------------------------------------- */
 343 /* let the user select its preferred completion */
 344
 345 char *
 346 editcmd_dialog_completion_show (const WEdit * edit, int max_len, GString ** compl, int num_compl)
 347 {
 348     const Widget *we = WIDGET (edit);
 349     int start_x, start_y, offset, i;
 350     char *curr = NULL;
 351     WDialog *compl_dlg;
 352     WListbox *compl_list;
 353     int compl_dlg_h;            /* completion dialog height */
 354     int compl_dlg_w;            /* completion dialog width */
 355
 356     /* calculate the dialog metrics */
 357     compl_dlg_h = num_compl + 2;
 358     compl_dlg_w = max_len + 4;
 359     start_x = we->x + edit->curs_col + edit->start_col + EDIT_TEXT_HORIZONTAL_OFFSET +
 360         (edit->fullscreen ? 0 : 1) + option_line_state_width;
 361     start_y = we->y + edit->curs_row + EDIT_TEXT_VERTICAL_OFFSET + (edit->fullscreen ? 0 : 1) + 1;
 362
 363     if (start_x < 0)
 364         start_x = 0;
 365     if (start_x < we->x + 1)
 366         start_x = we->x + 1 + option_line_state_width;
 367     if (compl_dlg_w > COLS)
 368         compl_dlg_w = COLS;
 369     if (compl_dlg_h > LINES - 2)
 370         compl_dlg_h = LINES - 2;
 371
 372     offset = start_x + compl_dlg_w - COLS;
 373     if (offset > 0)
 374         start_x -= offset;
 375     offset = start_y + compl_dlg_h - LINES;
 376     if (offset > 0)
 377         start_y -= offset;
 378
 379     /* create the dialog */
 380     compl_dlg =
 381         dlg_create (TRUE, start_y, start_x, compl_dlg_h, compl_dlg_w,
 382                     dialog_colors, NULL, NULL, "[Completion]", NULL, DLG_COMPACT);
 383
 384     /* create the listbox */
 385     compl_list = listbox_new (1, 1, compl_dlg_h - 2, compl_dlg_w - 2, FALSE, NULL);
 386
 387     /* add the dialog */
 388     add_widget (compl_dlg, compl_list);
 389
 390     /* fill the listbox with the completions */
 391     for (i = num_compl - 1; i >= 0; i--)        /* reverse order */
 392         listbox_add_item (compl_list, LISTBOX_APPEND_AT_END, 0, (char *) compl[i]->str, NULL);
 393
 394     /* pop up the dialog and apply the chosen completion */
 395     if (dlg_run (compl_dlg) == B_ENTER)
 396     {
 397         listbox_get_current (compl_list, &curr, NULL);
 398         curr = g_strdup (curr);
 399     }
 400
 401     /* destroy dialog before return */
 402     dlg_destroy (compl_dlg);
 403
 404     return curr;
 405 }
 406
 407 /* --------------------------------------------------------------------------------------------- */
 408 /* let the user select where function definition */
 409
 410 void
 411 editcmd_dialog_select_definition_show (WEdit * edit, char *match_expr, int max_len, int word_len,
 412                                        etags_hash_t * def_hash, int num_lines)
 413 {
 414
 415     int start_x, start_y, offset, i;
 416     char *curr = NULL;
 417     etags_hash_t *curr_def = NULL;
 418     WDialog *def_dlg;
 419     WListbox *def_list;
 420     int def_dlg_h;              /* dialog height */
 421     int def_dlg_w;              /* dialog width */
 422     char *label_def = NULL;
 423
 424     (void) word_len;
 425     /* calculate the dialog metrics */
 426     def_dlg_h = num_lines + 2;
 427     def_dlg_w = max_len + 4;
 428     start_x = edit->curs_col + edit->start_col - (def_dlg_w / 2) +
 429         EDIT_TEXT_HORIZONTAL_OFFSET + (edit->fullscreen ? 0 : 1) + option_line_state_width;
 430     start_y = edit->curs_row + EDIT_TEXT_VERTICAL_OFFSET + (edit->fullscreen ? 0 : 1) + 1;
 431
 432     if (start_x < 0)
 433         start_x = 0;
 434     if (def_dlg_w > COLS)
 435         def_dlg_w = COLS;
 436     if (def_dlg_h > LINES - 2)
 437         def_dlg_h = LINES - 2;
 438
 439     offset = start_x + def_dlg_w - COLS;
 440     if (offset > 0)
 441         start_x -= offset;
 442     offset = start_y + def_dlg_h - LINES;
 443     if (offset > 0)
 444         start_y -= (offset + 1);
 445
 446     /* create the dialog */
 447     def_dlg = dlg_create (TRUE, start_y, start_x, def_dlg_h, def_dlg_w,
 448                           dialog_colors, NULL, NULL, "[Definitions]", match_expr, DLG_COMPACT);
 449
 450     /* create the listbox */
 451     def_list = listbox_new (1, 1, def_dlg_h - 2, def_dlg_w - 2, FALSE, NULL);
 452
 453     /* add the dialog */
 454     add_widget (def_dlg, def_list);
 455
 456     /* fill the listbox with the completions */
 457     for (i = 0; i < num_lines; i++)
 458     {
 459         label_def =
 460             g_strdup_printf ("%s -> %s:%ld", def_hash[i].short_define, def_hash[i].filename,
 461                              def_hash[i].line);
 462         listbox_add_item (def_list, LISTBOX_APPEND_AT_END, 0, label_def, &def_hash[i]);
 463         g_free (label_def);
 464     }
 465
 466     /* pop up the dialog and apply the chosen completion */
 467     if (dlg_run (def_dlg) == B_ENTER)
 468     {
 469         char *tmp_curr_def = (char *) curr_def;
 470         int do_moveto = 0;
 471
 472         listbox_get_current (def_list, &curr, (void **) &tmp_curr_def);
 473         curr_def = (etags_hash_t *) tmp_curr_def;
 474         if (edit->modified)
 475         {
 476             if (!edit_query_dialog2
 477                 (_("Warning"),
 478                  _("Current text was modified without a file save.\n"
 479                    "Continue discards these changes."), _("C&ontinue"), _("&Cancel")))
 480             {
 481                 edit->force |= REDRAW_COMPLETELY;
 482                 do_moveto = 1;
 483             }
 484         }
 485         else
 486         {
 487             do_moveto = 1;
 488         }
 489
 490         if (curr && do_moveto)
 491         {
 492             if (edit_stack_iterator + 1 < MAX_HISTORY_MOVETO)
 493             {
 494                 vfs_path_free (edit_history_moveto[edit_stack_iterator].filename_vpath);
 495                 if (edit->dir_vpath != NULL)
 496                 {
 497                     edit_history_moveto[edit_stack_iterator].filename_vpath =
 498                         vfs_path_append_vpath_new (edit->dir_vpath, edit->filename_vpath, NULL);
 499                 }
 500                 else
 501                 {
 502                     edit_history_moveto[edit_stack_iterator].filename_vpath =
 503                         vfs_path_clone (edit->filename_vpath);
 504                 }
 505                 edit_history_moveto[edit_stack_iterator].line = edit->start_line +
 506                     edit->curs_row + 1;
 507                 edit_stack_iterator++;
 508                 vfs_path_free (edit_history_moveto[edit_stack_iterator].filename_vpath);
 509                 edit_history_moveto[edit_stack_iterator].filename_vpath =
 510                     vfs_path_from_str ((char *) curr_def->fullpath);
 511                 edit_history_moveto[edit_stack_iterator].line = curr_def->line;
 512                 edit_reload_line (edit, edit_history_moveto[edit_stack_iterator].filename_vpath,
 513                                   edit_history_moveto[edit_stack_iterator].line);
 514             }
 515         }
 516     }
 517
 518     /* clear definition hash */
 519     for (i = 0; i < MAX_DEFINITIONS; i++)
 520     {
 521         g_free (def_hash[i].filename);
 522     }
 523
 524     /* destroy dialog before return */
 525     dlg_destroy (def_dlg);
 526 }
 527
 528 /* --------------------------------------------------------------------------------------------- */