src/editor/editwidget.c

   1 /*
   2    Editor initialisation and callback handler.
   3
   4    Copyright (C) 1996, 1997, 1998, 2001, 2002, 2003, 2004, 2005, 2006,
   5    2007,2011
   6    The Free Software Foundation, Inc.
   7
   8    Written by:
   9    Paul Sheer, 1996, 1997
  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 /** \file
  28  *  \brief Source: editor initialisation and callback handler
  29  *  \author Paul Sheer
  30  *  \date 1996, 1997
  31  */
  32
  33 #include <config.h>
  34
  35 #include <stdio.h>
  36 #include <stdarg.h>
  37 #include <sys/types.h>
  38 #include <unistd.h>
  39 #include <string.h>
  40 #include <ctype.h>
  41 #include <errno.h>
  42 #include <sys/stat.h>
  43 #include <stdlib.h>
  44
  45 #include "lib/global.h"
  46
  47 #include "lib/tty/tty.h"        /* LINES, COLS */
  48 #include "lib/tty/key.h"        /* is_idle() */
  49 #include "lib/tty/color.h"      /* tty_setcolor() */
  50 #include "lib/skin.h"           /* EDITOR_NORMAL_COLOR */
  51 #include "lib/strutil.h"        /* str_term_trim() */
  52 #include "lib/util.h"           /* concat_dir_and_file() */
  53 #include "lib/widget.h"
  54 #include "lib/mcconfig.h"
  55
  56 #include "src/keybind-defaults.h"
  57 #include "src/main.h"           /* home_dir */
  58
  59 #include "edit-impl.h"
  60 #include "edit-widget.h"
  61
  62 /*** global variables ****************************************************************************/
  63
  64 /*** file scope macro definitions ****************************************************************/
  65
  66 /*** file scope type declarations ****************************************************************/
  67
  68 /*** file scope variables ************************************************************************/
  69
  70 /*** file scope functions ************************************************************************/
  71
  72 static cb_ret_t edit_callback (Widget * w, widget_msg_t msg, int parm);
  73
  74
  75 /* --------------------------------------------------------------------------------------------- */
  76
  77 static char *
  78 edit_get_shortcut (unsigned long command)
  79 {
  80     const char *ext_map;
  81     const char *shortcut = NULL;
  82
  83     shortcut = keybind_lookup_keymap_shortcut (editor_map, command);
  84     if (shortcut != NULL)
  85         return g_strdup (shortcut);
  86
  87     ext_map = keybind_lookup_keymap_shortcut (editor_map, CK_ExtendedKeyMap);
  88     if (ext_map != NULL)
  89         shortcut = keybind_lookup_keymap_shortcut (editor_x_map, command);
  90     if (shortcut != NULL)
  91         return g_strdup_printf ("%s %s", ext_map, shortcut);
  92
  93     return NULL;
  94 }
  95
  96 /* --------------------------------------------------------------------------------------------- */
  97
  98 static char *
  99 edit_get_title (const Dlg_head * h, size_t len)
 100 {
 101     const WEdit *edit = (const WEdit *) find_widget_type (h, edit_callback);
 102     const char *modified = edit->modified ? "(*) " : "    ";
 103     const char *file_label;
 104
 105     len -= 4;
 106
 107     file_label = str_term_trim (edit->filename, len - str_term_width1 (_("Edit: ")));
 108
 109     return g_strconcat (_("Edit: "), modified, file_label, (char *) NULL);
 110 }
 111
 112 /* --------------------------------------------------------------------------------------------- */
 113
 114 static int
 115 edit_event (Gpm_Event * event, void *data)
 116 {
 117     WEdit *edit = (WEdit *) data;
 118
 119     /* Unknown event type */
 120     if (!(event->type & (GPM_DOWN | GPM_DRAG | GPM_UP)))
 121         return MOU_NORMAL;
 122
 123     edit_update_curs_row (edit);
 124     edit_update_curs_col (edit);
 125
 126     /* Outside editor window */
 127     if (event->y < 1 || event->x < 1
 128         || event->x > edit->widget.cols || event->y > edit->widget.lines)
 129         return MOU_NORMAL;
 130
 131     /* Double click */
 132     if ((event->type & (GPM_DOUBLE | GPM_UP)) == (GPM_UP | GPM_DOUBLE))
 133     {
 134         edit_mark_current_word_cmd (edit);
 135         goto update;
 136     }
 137 #if 0
 138     /* Triple click */
 139     if ((event->type & (GPM_TRIPLE | GPM_UP)) == (GPM_UP | GPM_TRIPLE))
 140     {
 141         edit_mark_current_line_cmd (edit);
 142         goto update;
 143     }
 144 #endif
 145     /* Wheel events */
 146     if ((event->buttons & GPM_B_UP) && (event->type & GPM_DOWN))
 147     {
 148         edit_move_up (edit, 2, 1);
 149         goto update;
 150     }
 151     if ((event->buttons & GPM_B_DOWN) && (event->type & GPM_DOWN))
 152     {
 153         edit_move_down (edit, 2, 1);
 154         goto update;
 155     }
 156
 157     /* A lone up mustn't do anything */
 158     if (edit->mark2 != -1 && event->type & (GPM_UP | GPM_DRAG))
 159         return MOU_NORMAL;
 160
 161     if (event->type & (GPM_DOWN | GPM_UP))
 162         edit_push_key_press (edit);
 163
 164     if (!option_cursor_beyond_eol)
 165         edit->prev_col = event->x - edit->start_col - option_line_state_width - 1;
 166     else
 167     {
 168         long line_len = edit_move_forward3 (edit, edit_bol (edit, edit->curs1), 0,
 169                                             edit_eol (edit, edit->curs1));
 170
 171         if (event->x > line_len)
 172         {
 173             edit->over_col = event->x - line_len - edit->start_col - option_line_state_width - 1;
 174             edit->prev_col = line_len;
 175         }
 176         else
 177         {
 178             edit->over_col = 0;
 179             edit->prev_col = event->x - option_line_state_width - edit->start_col - 1;
 180         }
 181     }
 182
 183     --event->y;
 184     if (event->y > edit->curs_row)
 185         edit_move_down (edit, event->y - edit->curs_row, 0);
 186     else if (event->y < edit->curs_row)
 187         edit_move_up (edit, edit->curs_row - event->y, 0);
 188     else
 189         edit_move_to_prev_col (edit, edit_bol (edit, edit->curs1));
 190
 191     if (event->type & GPM_DOWN)
 192     {
 193         edit_mark_cmd (edit, 1);        /* reset */
 194         edit->highlight = 0;
 195     }
 196
 197     if (!(event->type & GPM_DRAG))
 198         edit_mark_cmd (edit, 0);
 199
 200   update:
 201     edit_find_bracket (edit);
 202     edit->force |= REDRAW_COMPLETELY;
 203     edit_update_curs_row (edit);
 204     edit_update_curs_col (edit);
 205     edit_update_screen (edit);
 206
 207     return MOU_NORMAL;
 208 }
 209
 210 /* --------------------------------------------------------------------------------------------- */
 211
 212 static cb_ret_t
 213 edit_command_execute (WEdit * edit, unsigned long command)
 214 {
 215     if (command == CK_Menu)
 216         edit_menu_cmd (edit);
 217     else
 218     {
 219         edit_execute_key_command (edit, command, -1);
 220         edit_update_screen (edit);
 221     }
 222     return MSG_HANDLED;
 223 }
 224
 225 /* --------------------------------------------------------------------------------------------- */
 226
 227 static inline void
 228 edit_set_buttonbar (WEdit * edit, WButtonBar * bb)
 229 {
 230     buttonbar_set_label (bb, 1, Q_ ("ButtonBar|Help"), editor_map, (Widget *) edit);
 231     buttonbar_set_label (bb, 2, Q_ ("ButtonBar|Save"), editor_map, (Widget *) edit);
 232     buttonbar_set_label (bb, 3, Q_ ("ButtonBar|Mark"), editor_map, (Widget *) edit);
 233     buttonbar_set_label (bb, 4, Q_ ("ButtonBar|Replac"), editor_map, (Widget *) edit);
 234     buttonbar_set_label (bb, 5, Q_ ("ButtonBar|Copy"), editor_map, (Widget *) edit);
 235     buttonbar_set_label (bb, 6, Q_ ("ButtonBar|Move"), editor_map, (Widget *) edit);
 236     buttonbar_set_label (bb, 7, Q_ ("ButtonBar|Search"), editor_map, (Widget *) edit);
 237     buttonbar_set_label (bb, 8, Q_ ("ButtonBar|Delete"), editor_map, (Widget *) edit);
 238     buttonbar_set_label (bb, 9, Q_ ("ButtonBar|PullDn"), editor_map, (Widget *) edit);
 239     buttonbar_set_label (bb, 10, Q_ ("ButtonBar|Quit"), editor_map, (Widget *) edit);
 240 }
 241
 242 /* --------------------------------------------------------------------------------------------- */
 243 /** Callback for the edit dialog */
 244
 245 static cb_ret_t
 246 edit_dialog_callback (Dlg_head * h, Widget * sender, dlg_msg_t msg, int parm, void *data)
 247 {
 248     WEdit *edit;
 249     WMenuBar *menubar;
 250     WButtonBar *buttonbar;
 251
 252     edit = (WEdit *) find_widget_type (h, edit_callback);
 253     menubar = find_menubar (h);
 254     buttonbar = find_buttonbar (h);
 255
 256     switch (msg)
 257     {
 258     case DLG_INIT:
 259         edit_set_buttonbar (edit, buttonbar);
 260         return MSG_HANDLED;
 261
 262     case DLG_DRAW:
 263         /* don't use common_dialog_repaint() -- we don't need a frame */
 264         tty_setcolor (EDITOR_NORMAL_COLOR);
 265         dlg_erase (h);
 266         return MSG_HANDLED;
 267
 268     case DLG_RESIZE:
 269         /* dlg_set_size() is surplus for this case */
 270         h->lines = LINES;
 271         h->cols = COLS;
 272         widget_set_size (&buttonbar->widget, h->lines - 1, h->x, 1, h->cols);
 273         widget_set_size (&menubar->widget, h->y, h->x, 1, h->cols);
 274         menubar_arrange (menubar);
 275         widget_set_size (&edit->widget, h->y + 1, h->x, h->lines - 2, h->cols);
 276         return MSG_HANDLED;
 277
 278     case DLG_ACTION:
 279         if (sender == (Widget *) menubar)
 280             return send_message ((Widget *) edit, WIDGET_COMMAND, parm);
 281         if (sender == (Widget *) buttonbar)
 282             return send_message ((Widget *) edit, WIDGET_COMMAND, parm);
 283         return MSG_HANDLED;
 284
 285     case DLG_VALIDATE:
 286         h->state = DLG_ACTIVE;  /* don't stop the dialog before final decision */
 287         if (edit_ok_to_exit (edit))
 288             h->state = DLG_CLOSED;
 289         return MSG_HANDLED;
 290
 291     default:
 292         return default_dlg_callback (h, sender, msg, parm, data);
 293     }
 294 }
 295
 296 /* --------------------------------------------------------------------------------------------- */
 297
 298 static cb_ret_t
 299 edit_callback (Widget * w, widget_msg_t msg, int parm)
 300 {
 301     WEdit *e = (WEdit *) w;
 302
 303     switch (msg)
 304     {
 305     case WIDGET_DRAW:
 306         e->force |= REDRAW_COMPLETELY;
 307         /* fallthrough */
 308
 309     case WIDGET_FOCUS:
 310         edit_update_screen (e);
 311         return MSG_HANDLED;
 312
 313     case WIDGET_KEY:
 314         {
 315             int cmd, ch;
 316             cb_ret_t ret = MSG_NOT_HANDLED;
 317
 318             /* The user may override the access-keys for the menu bar. */
 319             if (macro_index == -1 && edit_execute_macro (e, parm))
 320             {
 321                 edit_update_screen (e);
 322                 ret = MSG_HANDLED;
 323             }
 324             else if (edit_translate_key (e, parm, &cmd, &ch))
 325             {
 326                 edit_execute_key_command (e, cmd, ch);
 327                 edit_update_screen (e);
 328                 ret = MSG_HANDLED;
 329             }
 330             else if (edit_drop_hotkey_menu (e, parm))
 331                 ret = MSG_HANDLED;
 332
 333             return ret;
 334         }
 335
 336     case WIDGET_COMMAND:
 337         /* command from menubar or buttonbar */
 338         return edit_command_execute (e, parm);
 339
 340     case WIDGET_CURSOR:
 341         widget_move (w, e->curs_row + EDIT_TEXT_VERTICAL_OFFSET,
 342                      e->curs_col + e->start_col + e->over_col +
 343                      EDIT_TEXT_HORIZONTAL_OFFSET + option_line_state_width);
 344         return MSG_HANDLED;
 345
 346     case WIDGET_DESTROY:
 347         edit_clean (e);
 348         return MSG_HANDLED;
 349
 350     default:
 351         return default_proc (msg, parm);
 352     }
 353 }
 354
 355 /* --------------------------------------------------------------------------------------------- */
 356 /*** public functions ****************************************************************************/
 357 /* --------------------------------------------------------------------------------------------- */
 358
 359 int
 360 edit_file (const char *_file, int line)
 361 {
 362     static gboolean made_directory = FALSE;
 363     Dlg_head *edit_dlg;
 364     WEdit *wedit;
 365     WMenuBar *menubar;
 366
 367     if (!made_directory)
 368     {
 369         char *dir = concat_dir_and_file (mc_config_get_cache_path (), EDIT_DIR);
 370         made_directory = (mkdir (dir, 0700) != -1 || errno == EEXIST);
 371         g_free (dir);
 372
 373         dir = concat_dir_and_file (mc_config_get_path (), EDIT_DIR);
 374         made_directory = (mkdir (dir, 0700) != -1 || errno == EEXIST);
 375         g_free (dir);
 376
 377         dir = concat_dir_and_file (mc_config_get_data_path (), EDIT_DIR);
 378         made_directory = (mkdir (dir, 0700) != -1 || errno == EEXIST);
 379         g_free (dir);
 380     }
 381
 382     wedit = edit_init (NULL, 1, 0, LINES - 2, COLS, _file, line);
 383
 384     if (wedit == NULL)
 385         return 0;
 386
 387     /* Create a new dialog and add it widgets to it */
 388     edit_dlg =
 389         create_dlg (FALSE, 0, 0, LINES, COLS, NULL, edit_dialog_callback,
 390                     "[Internal File Editor]", NULL, DLG_WANT_TAB);
 391
 392     edit_dlg->get_shortcut = edit_get_shortcut;
 393     edit_dlg->get_title = edit_get_title;
 394
 395     menubar = menubar_new (0, 0, COLS, NULL);
 396     add_widget (edit_dlg, menubar);
 397     edit_init_menu (menubar);
 398
 399     init_widget (&wedit->widget, wedit->widget.y, wedit->widget.x,
 400                  wedit->widget.lines, wedit->widget.cols, edit_callback, edit_event);
 401     widget_want_cursor (wedit->widget, TRUE);
 402
 403     add_widget (edit_dlg, wedit);
 404
 405     add_widget (edit_dlg, buttonbar_new (TRUE));
 406
 407     run_dlg (edit_dlg);
 408
 409     if (edit_dlg->state == DLG_CLOSED)
 410         destroy_dlg (edit_dlg);
 411
 412     return 1;
 413 }
 414
 415 /* --------------------------------------------------------------------------------------------- */
 416
 417 const char *
 418 edit_get_file_name (const WEdit * edit)
 419 {
 420     return edit->filename;
 421 }
 422
 423 /* --------------------------------------------------------------------------------------------- */
 424
 425 void
 426 edit_update_screen (WEdit * e)
 427 {
 428     edit_scroll_screen_over_cursor (e);
 429
 430     edit_update_curs_col (e);
 431     edit_status (e);
 432
 433     /* pop all events for this window for internal handling */
 434     if (!is_idle ())
 435         e->force |= REDRAW_PAGE;
 436     else
 437     {
 438         if (e->force & REDRAW_COMPLETELY)
 439             e->force |= REDRAW_PAGE;
 440         edit_render_keypress (e);
 441     }
 442 }
 443
 444 /* --------------------------------------------------------------------------------------------- */