src/viewer/mcviewer.c

   1 /*
   2    Internal file viewer for the Midnight Commander
   3    Interface functions
   4
   5    Copyright (C) 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2002, 2003,
   6    2004, 2005, 2006, 2007, 2009 Free Software Foundation, Inc.
   7
   8    Written by: 1994, 1995, 1998 Miguel de Icaza
   9    1994, 1995 Janne Kukonlehto
  10    1995 Jakub Jelinek
  11    1996 Joseph M. Hinkle
  12    1997 Norbert Warmuth
  13    1998 Pavel Machek
  14    2004 Roland Illig <roland.illig@gmx.de>
  15    2005 Roland Illig <roland.illig@gmx.de>
  16    2009 Slava Zanko <slavazanko@google.com>
  17    2009 Andrew Borodin <aborodin@vmail.ru>
  18    2009 Ilia Maslakov <il.smind@gmail.com>
  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 2 of the
  25    License, or (at your option) any later version.
  26
  27    The Midnight Commander is distributed in the hope that it will be
  28    useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  29    of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  30    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, write to the Free Software
  34    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  35    MA 02110-1301, USA.
  36  */
  37
  38 #include <config.h>
  39 #include <errno.h>
  40 #include <fcntl.h>
  41
  42 #include "lib/global.h"
  43 #include "lib/tty/tty.h"
  44 #include "lib/vfs/mc-vfs/vfs.h"
  45 #include "lib/strutil.h"
  46
  47 #include "src/main.h"
  48 #include "src/charsets.h"
  49 #include "src/main-widgets.h"   /* the_menubar */
  50 #include "src/menu.h"           /* menubar_visible */
  51 #include "src/widget.h"
  52
  53 #include "internal.h"
  54 #include "mcviewer.h"
  55
  56 /*** global variables ****************************************************************************/
  57
  58 int mcview_default_hex_mode = 0;
  59 int mcview_default_nroff_flag = 0;
  60 int mcview_global_wrap_mode = 1;
  61 int mcview_default_magic_flag = 1;
  62
  63 int mcview_altered_hex_mode = 0;
  64 int mcview_altered_magic_flag = 0;
  65 int mcview_altered_nroff_flag = 0;
  66
  67 int mcview_remember_file_position = FALSE;
  68
  69 /* Maxlimit for skipping updates */
  70 int mcview_max_dirt_limit = 10;
  71
  72 /* Scrolling is done in pages or line increments */
  73 int mcview_mouse_move_pages = 1;
  74
  75 /* end of file will be showen from mcview_show_eof */
  76 char *mcview_show_eof = NULL;
  77
  78 /*** file scope macro definitions ****************************************************************/
  79
  80 /*** file scope type declarations ****************************************************************/
  81
  82 /*** file scope variables ************************************************************************/
  83
  84
  85 /*** file scope functions ************************************************************************/
  86
  87 /* --------------------------------------------------------------------------------------------- */
  88
  89 /* Both views */
  90 static int
  91 mcview_event (mcview_t * view, Gpm_Event * event, int *result)
  92 {
  93     screen_dimen y, x;
  94
  95     *result = MOU_NORMAL;
  96
  97     /* rest of the upper frame, the menu is invisible - call menu */
  98     if (mcview_is_in_panel (view) && (event->type & GPM_DOWN) && event->y == 1 && !menubar_visible)
  99     {
 100         event->x += view->widget.x;
 101         *result = the_menubar->widget.mouse (event, the_menubar);
 102         return 0;               /* don't draw viewer over menu */
 103     }
 104
 105     /* We are not interested in the release events */
 106     if (!(event->type & (GPM_DOWN | GPM_DRAG)))
 107         return 0;
 108
 109     /* Wheel events */
 110     if ((event->buttons & GPM_B_UP) && (event->type & GPM_DOWN))
 111     {
 112         mcview_move_up (view, 2);
 113         return 1;
 114     }
 115     if ((event->buttons & GPM_B_DOWN) && (event->type & GPM_DOWN))
 116     {
 117         mcview_move_down (view, 2);
 118         return 1;
 119     }
 120
 121     x = event->x;
 122     y = event->y;
 123
 124     /* Scrolling left and right */
 125     if (!view->text_wrap_mode)
 126     {
 127         if (x < view->data_area.width * 1 / 4)
 128         {
 129             mcview_move_left (view, 1);
 130             goto processed;
 131         }
 132         else if (x < view->data_area.width * 3 / 4)
 133         {
 134             /* ignore the click */
 135         }
 136         else
 137         {
 138             mcview_move_right (view, 1);
 139             goto processed;
 140         }
 141     }
 142
 143     /* Scrolling up and down */
 144     if (y < view->data_area.top + view->data_area.height * 1 / 3)
 145     {
 146         if (mcview_mouse_move_pages)
 147             mcview_move_up (view, view->data_area.height / 2);
 148         else
 149             mcview_move_up (view, 1);
 150         goto processed;
 151     }
 152     else if (y < view->data_area.top + view->data_area.height * 2 / 3)
 153     {
 154         /* ignore the click */
 155     }
 156     else
 157     {
 158         if (mcview_mouse_move_pages)
 159             mcview_move_down (view, view->data_area.height / 2);
 160         else
 161             mcview_move_down (view, 1);
 162         goto processed;
 163     }
 164
 165     return 0;
 166
 167   processed:
 168     *result = MOU_REPEAT;
 169     return 1;
 170 }
 171
 172 /* --------------------------------------------------------------------------------------------- */
 173
 174 /* Real view only */
 175 static int
 176 mcview_real_event (Gpm_Event * event, void *x)
 177 {
 178     mcview_t *view = (mcview_t *) x;
 179     int result;
 180
 181     if (mcview_event (view, event, &result))
 182         mcview_update (view);
 183     return result;
 184 }
 185
 186 static void
 187 mcview_set_keymap (mcview_t * view)
 188 {
 189     view->plain_map = default_viewer_keymap;
 190     if (viewer_keymap && viewer_keymap->len > 0)
 191         view->plain_map = (global_keymap_t *) viewer_keymap->data;
 192
 193     view->hex_map = default_viewer_hex_keymap;
 194     if (viewer_hex_keymap && viewer_hex_keymap->len > 0)
 195         view->hex_map = (global_keymap_t *) viewer_hex_keymap->data;
 196 }
 197
 198 /* --------------------------------------------------------------------------------------------- */
 199
 200 /*** public functions ****************************************************************************/
 201
 202 /* --------------------------------------------------------------------------------------------- */
 203
 204 mcview_t *
 205 mcview_new (int y, int x, int lines, int cols, gboolean is_panel)
 206 {
 207     mcview_t *view = g_new0 (mcview_t, 1);
 208
 209     init_widget (&view->widget, y, x, lines, cols, mcview_callback, mcview_real_event);
 210
 211     mcview_set_keymap (view);
 212
 213     view->hex_mode = FALSE;
 214     view->hexedit_mode = FALSE;
 215     view->hexview_in_text = FALSE;
 216     view->text_nroff_mode = FALSE;
 217     view->text_wrap_mode = FALSE;
 218     view->magic_mode = FALSE;
 219
 220     view->dpy_frame_size = is_panel ? 1 : 0;
 221     view->converter = str_cnv_from_term;
 222
 223     mcview_init (view);
 224
 225     if (mcview_default_hex_mode)
 226         mcview_toggle_hex_mode (view);
 227     if (mcview_default_nroff_flag)
 228         mcview_toggle_nroff_mode (view);
 229     if (mcview_global_wrap_mode)
 230         mcview_toggle_wrap_mode (view);
 231     if (mcview_default_magic_flag)
 232         mcview_toggle_magic_mode (view);
 233
 234     return view;
 235 }
 236
 237 /* --------------------------------------------------------------------------------------------- */
 238
 239 /* Real view only */
 240 mcview_ret_t
 241 mcview_viewer (const char *command, const char *file, int start_line)
 242 {
 243     gboolean succeeded;
 244     mcview_t *lc_mcview;
 245     Dlg_head *view_dlg;
 246     mcview_ret_t ret;
 247
 248     /* Create dialog and widgets, put them on the dialog */
 249     view_dlg = create_dlg (FALSE, 0, 0, LINES, COLS, NULL, mcview_dialog_callback,
 250                            "[Internal File Viewer]", NULL, DLG_WANT_TAB);
 251
 252     lc_mcview = mcview_new (0, 0, LINES - 1, COLS, FALSE);
 253     add_widget (view_dlg, lc_mcview);
 254
 255     add_widget (view_dlg, buttonbar_new (TRUE));
 256
 257     view_dlg->get_title = mcview_get_title;
 258
 259     succeeded = mcview_load (lc_mcview, command, file, start_line);
 260
 261     if (succeeded)
 262     {
 263         run_dlg (view_dlg);
 264
 265         ret = lc_mcview->move_dir == 0 ? MCVIEW_EXIT_OK :
 266               lc_mcview->move_dir > 0 ? MCVIEW_WANT_NEXT : MCVIEW_WANT_PREV;
 267     }
 268     else
 269     {
 270         view_dlg->state = DLG_CLOSED;
 271         ret = MCVIEW_EXIT_FAILURE;
 272     }
 273
 274     if (view_dlg->state == DLG_CLOSED)
 275         destroy_dlg (view_dlg);
 276
 277     return ret;
 278 }
 279
 280 /* {{{ Miscellaneous functions }}} */
 281
 282 /* --------------------------------------------------------------------------------------------- */
 283
 284 gboolean
 285 mcview_load (mcview_t * view, const char *command, const char *file, int start_line)
 286 {
 287     gboolean retval = FALSE;
 288
 289     assert (view->bytes_per_line != 0);
 290
 291     view->filename = g_strdup (file);
 292
 293     if (!mcview_is_in_panel (view))
 294         view->dpy_text_column = 0;
 295
 296     mcview_set_codeset (view);
 297
 298     if (command != NULL && (view->magic_mode || file == NULL || file[0] == '\0'))
 299         retval = mcview_load_command_output (view, command);
 300     else if (file != NULL && file[0] != '\0')
 301     {
 302         int fd = -1;
 303         char tmp[BUF_MEDIUM];
 304         struct stat st;
 305
 306         /* Open the file */
 307         fd = mc_open (file, O_RDONLY | O_NONBLOCK);
 308         if (fd == -1)
 309         {
 310             g_snprintf (tmp, sizeof (tmp), _("Cannot open \"%s\"\n%s"),
 311                         file, unix_error_string (errno));
 312             mcview_show_error (view, tmp);
 313             g_free (view->filename);
 314             view->filename = NULL;
 315             goto finish;
 316         }
 317
 318         /* Make sure we are working with a regular file */
 319         if (mc_fstat (fd, &st) == -1)
 320         {
 321             mc_close (fd);
 322             g_snprintf (tmp, sizeof (tmp), _("Cannot stat \"%s\"\n%s"),
 323                         file, unix_error_string (errno));
 324             mcview_show_error (view, tmp);
 325             g_free (view->filename);
 326             view->filename = NULL;
 327             goto finish;
 328         }
 329
 330         if (!S_ISREG (st.st_mode))
 331         {
 332             mc_close (fd);
 333             mcview_show_error (view, _("Cannot view: not a regular file"));
 334             g_free (view->filename);
 335             view->filename = NULL;
 336             goto finish;
 337         }
 338
 339         if (st.st_size == 0 || mc_lseek (fd, 0, SEEK_SET) == -1)
 340         {
 341             /* Must be one of those nice files that grow (/proc) */
 342             mcview_set_datasource_vfs_pipe (view, fd);
 343         }
 344         else
 345         {
 346             int type;
 347
 348             type = get_compression_type (fd, file);
 349
 350             if (view->magic_mode && (type != COMPRESSION_NONE))
 351             {
 352                 g_free (view->filename);
 353                 view->filename = g_strconcat (file, decompress_extension (type), (char *) NULL);
 354             }
 355             mcview_set_datasource_file (view, fd, &st);
 356         }
 357         retval = TRUE;
 358     }
 359
 360   finish:
 361     view->command = g_strdup (command);
 362     view->dpy_start = 0;
 363     view->search_start = 0;
 364     view->search_end = 0;
 365     view->dpy_text_column = 0;
 366
 367     mcview_compute_areas (view);
 368     mcview_update_bytes_per_line (view);
 369
 370     if (mcview_remember_file_position && view->filename != NULL && start_line == 0)
 371     {
 372         char *canon_fname;
 373         long line, col;
 374         off_t new_offset;
 375
 376         canon_fname = vfs_canon (view->filename);
 377         load_file_position (canon_fname, &line, &col, &new_offset);
 378         new_offset = min (new_offset, mcview_get_filesize (view));
 379         view->dpy_start = mcview_bol (view, new_offset);
 380         g_free (canon_fname);
 381     }
 382     else if (start_line > 0)
 383         mcview_moveto (view, start_line - 1, 0);
 384
 385     view->hexedit_lownibble = FALSE;
 386     view->hexview_in_text = FALSE;
 387     view->change_list = NULL;
 388     return retval;
 389 }
 390
 391 /* --------------------------------------------------------------------------------------------- */