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/tty/mouse.h"
  45 #include "lib/vfs/mc-vfs/vfs.h"
  46 #include "lib/strutil.h"
  47 #include "lib/util.h"           /* load_file_position() */
  48 #include "lib/widget.h"
  49 #include "lib/charsets.h"
  50
  51 #include "src/main.h"
  52 #include "src/layout.h"         /* menubar_visible */
  53 #include "src/main-widgets.h"   /* the_menubar */
  54
  55 #include "internal.h"
  56 #include "mcviewer.h"
  57
  58 /*** global variables ****************************************************************************/
  59
  60 int mcview_default_hex_mode = 0;
  61 int mcview_default_nroff_flag = 0;
  62 int mcview_global_wrap_mode = 1;
  63 int mcview_default_magic_flag = 1;
  64
  65 int mcview_altered_hex_mode = 0;
  66 int mcview_altered_magic_flag = 0;
  67 int mcview_altered_nroff_flag = 0;
  68
  69 int mcview_remember_file_position = FALSE;
  70
  71 /* Maxlimit for skipping updates */
  72 int mcview_max_dirt_limit = 10;
  73
  74 /* Scrolling is done in pages or line increments */
  75 int mcview_mouse_move_pages = 1;
  76
  77 /* end of file will be showen from mcview_show_eof */
  78 char *mcview_show_eof = NULL;
  79
  80 /*** file scope macro definitions ****************************************************************/
  81
  82 /*** file scope type declarations ****************************************************************/
  83
  84 /*** file scope variables ************************************************************************/
  85
  86
  87 /*** file scope functions ************************************************************************/
  88 /* --------------------------------------------------------------------------------------------- */
  89
  90 /** Both views */
  91
  92 static int
  93 mcview_event (mcview_t * view, Gpm_Event * event, int *result)
  94 {
  95     screen_dimen y, x;
  96
  97     *result = MOU_NORMAL;
  98
  99     /* rest of the upper frame, the menu is invisible - call menu */
 100     if (mcview_is_in_panel (view) && (event->type & GPM_DOWN) && event->y == 1 && !menubar_visible)
 101     {
 102         event->x += view->widget.x;
 103         *result = the_menubar->widget.mouse (event, the_menubar);
 104         return 0;               /* don't draw viewer over menu */
 105     }
 106
 107     /* We are not interested in the release events */
 108     if (!(event->type & (GPM_DOWN | GPM_DRAG)))
 109         return 0;
 110
 111     /* Wheel events */
 112     if ((event->buttons & GPM_B_UP) && (event->type & GPM_DOWN))
 113     {
 114         mcview_move_up (view, 2);
 115         return 1;
 116     }
 117     if ((event->buttons & GPM_B_DOWN) && (event->type & GPM_DOWN))
 118     {
 119         mcview_move_down (view, 2);
 120         return 1;
 121     }
 122
 123     x = event->x;
 124     y = event->y;
 125
 126     /* Scrolling left and right */
 127     if (!view->text_wrap_mode)
 128     {
 129         if (x < view->data_area.width * 1 / 4)
 130         {
 131             mcview_move_left (view, 1);
 132             goto processed;
 133         }
 134         else if (x < view->data_area.width * 3 / 4)
 135         {
 136             /* ignore the click */
 137         }
 138         else
 139         {
 140             mcview_move_right (view, 1);
 141             goto processed;
 142         }
 143     }
 144
 145     /* Scrolling up and down */
 146     if (y < view->data_area.top + view->data_area.height * 1 / 3)
 147     {
 148         if (mcview_mouse_move_pages)
 149             mcview_move_up (view, view->data_area.height / 2);
 150         else
 151             mcview_move_up (view, 1);
 152         goto processed;
 153     }
 154     else if (y < view->data_area.top + view->data_area.height * 2 / 3)
 155     {
 156         /* ignore the click */
 157     }
 158     else
 159     {
 160         if (mcview_mouse_move_pages)
 161             mcview_move_down (view, view->data_area.height / 2);
 162         else
 163             mcview_move_down (view, 1);
 164         goto processed;
 165     }
 166
 167     return 0;
 168
 169   processed:
 170     *result = MOU_REPEAT;
 171     return 1;
 172 }
 173
 174 /* --------------------------------------------------------------------------------------------- */
 175 /** Real view only */
 176
 177 static int
 178 mcview_real_event (Gpm_Event * event, void *x)
 179 {
 180     mcview_t *view = (mcview_t *) x;
 181     int result;
 182
 183     if (mcview_event (view, event, &result))
 184         mcview_update (view);
 185     return result;
 186 }
 187
 188 /* --------------------------------------------------------------------------------------------- */
 189
 190 static void
 191 mcview_set_keymap (mcview_t * view)
 192 {
 193     view->plain_map = default_viewer_keymap;
 194     if (viewer_keymap && viewer_keymap->len > 0)
 195         view->plain_map = (global_keymap_t *) viewer_keymap->data;
 196
 197     view->hex_map = default_viewer_hex_keymap;
 198     if (viewer_hex_keymap && viewer_hex_keymap->len > 0)
 199         view->hex_map = (global_keymap_t *) viewer_hex_keymap->data;
 200 }
 201
 202 /* --------------------------------------------------------------------------------------------- */
 203 /*** public functions ****************************************************************************/
 204 /* --------------------------------------------------------------------------------------------- */
 205
 206 mcview_t *
 207 mcview_new (int y, int x, int lines, int cols, gboolean is_panel)
 208 {
 209     mcview_t *view = g_new0 (mcview_t, 1);
 210
 211     init_widget (&view->widget, y, x, lines, cols, mcview_callback, mcview_real_event);
 212
 213     mcview_set_keymap (view);
 214
 215     view->hex_mode = FALSE;
 216     view->hexedit_mode = FALSE;
 217     view->locked = FALSE;
 218     view->hexview_in_text = FALSE;
 219     view->text_nroff_mode = FALSE;
 220     view->text_wrap_mode = FALSE;
 221     view->magic_mode = FALSE;
 222
 223     view->dpy_frame_size = is_panel ? 1 : 0;
 224     view->converter = str_cnv_from_term;
 225
 226     mcview_init (view);
 227
 228     if (mcview_default_hex_mode)
 229         mcview_toggle_hex_mode (view);
 230     if (mcview_default_nroff_flag)
 231         mcview_toggle_nroff_mode (view);
 232     if (mcview_global_wrap_mode)
 233         mcview_toggle_wrap_mode (view);
 234     if (mcview_default_magic_flag)
 235         mcview_toggle_magic_mode (view);
 236
 237     return view;
 238 }
 239
 240 /* --------------------------------------------------------------------------------------------- */
 241 /** Real view only */
 242
 243 mcview_ret_t
 244 mcview_viewer (const char *command, const char *file, int start_line)
 245 {
 246     gboolean succeeded;
 247     mcview_t *lc_mcview;
 248     Dlg_head *view_dlg;
 249     mcview_ret_t ret;
 250
 251     /* Create dialog and widgets, put them on the dialog */
 252     view_dlg = create_dlg (FALSE, 0, 0, LINES, COLS, NULL, mcview_dialog_callback,
 253                            "[Internal File Viewer]", NULL, DLG_WANT_TAB);
 254
 255     lc_mcview = mcview_new (0, 0, LINES - 1, COLS, FALSE);
 256     add_widget (view_dlg, lc_mcview);
 257
 258     add_widget (view_dlg, buttonbar_new (TRUE));
 259
 260     view_dlg->get_title = mcview_get_title;
 261
 262     succeeded = mcview_load (lc_mcview, command, file, start_line);
 263
 264     if (succeeded)
 265     {
 266         run_dlg (view_dlg);
 267
 268         ret = lc_mcview->move_dir == 0 ? MCVIEW_EXIT_OK :
 269             lc_mcview->move_dir > 0 ? MCVIEW_WANT_NEXT : MCVIEW_WANT_PREV;
 270     }
 271     else
 272     {
 273         view_dlg->state = DLG_CLOSED;
 274         ret = MCVIEW_EXIT_FAILURE;
 275     }
 276
 277     if (view_dlg->state == DLG_CLOSED)
 278         destroy_dlg (view_dlg);
 279
 280     return ret;
 281 }
 282
 283 /* {{{ Miscellaneous functions }}} */
 284
 285 /* --------------------------------------------------------------------------------------------- */
 286
 287 gboolean
 288 mcview_load (mcview_t * view, const char *command, const char *file, int start_line)
 289 {
 290     gboolean retval = FALSE;
 291
 292     assert (view->bytes_per_line != 0);
 293
 294     view->filename = g_strdup (file);
 295
 296     if ((view->workdir == NULL) && (file != NULL))
 297     {
 298         if (!g_path_is_absolute (file))
 299             view->workdir = g_strdup (vfs_get_current_dir ());
 300         else
 301         {
 302             /* try extract path form filename */
 303             char *dirname;
 304
 305             dirname = g_path_get_dirname (file);
 306             if (strcmp (dirname, ".") != 0)
 307                 view->workdir = dirname;
 308             else
 309             {
 310                 g_free (dirname);
 311                 view->workdir = g_strdup (vfs_get_current_dir ());
 312             }
 313         }
 314     }
 315
 316     if (!mcview_is_in_panel (view))
 317         view->dpy_text_column = 0;
 318
 319     mcview_set_codeset (view);
 320
 321     if (command != NULL && (view->magic_mode || file == NULL || file[0] == '\0'))
 322         retval = mcview_load_command_output (view, command);
 323     else if (file != NULL && file[0] != '\0')
 324     {
 325         int fd = -1;
 326         char tmp[BUF_MEDIUM];
 327         struct stat st;
 328
 329         /* Open the file */
 330         fd = mc_open (file, O_RDONLY | O_NONBLOCK);
 331         if (fd == -1)
 332         {
 333             g_snprintf (tmp, sizeof (tmp), _("Cannot open \"%s\"\n%s"),
 334                         file, unix_error_string (errno));
 335             mcview_show_error (view, tmp);
 336             g_free (view->filename);
 337             view->filename = NULL;
 338             g_free (view->workdir);
 339             view->workdir = NULL;
 340             goto finish;
 341         }
 342
 343         /* Make sure we are working with a regular file */
 344         if (mc_fstat (fd, &st) == -1)
 345         {
 346             mc_close (fd);
 347             g_snprintf (tmp, sizeof (tmp), _("Cannot stat \"%s\"\n%s"),
 348                         file, unix_error_string (errno));
 349             mcview_show_error (view, tmp);
 350             g_free (view->filename);
 351             view->filename = NULL;
 352             g_free (view->workdir);
 353             view->workdir = NULL;
 354             goto finish;
 355         }
 356
 357         if (!S_ISREG (st.st_mode))
 358         {
 359             mc_close (fd);
 360             mcview_show_error (view, _("Cannot view: not a regular file"));
 361             g_free (view->filename);
 362             view->filename = NULL;
 363             g_free (view->workdir);
 364             view->workdir = NULL;
 365             goto finish;
 366         }
 367
 368         if (st.st_size == 0 || mc_lseek (fd, 0, SEEK_SET) == -1)
 369         {
 370             /* Must be one of those nice files that grow (/proc) */
 371             mcview_set_datasource_vfs_pipe (view, fd);
 372         }
 373         else
 374         {
 375             int type;
 376
 377             type = get_compression_type (fd, file);
 378
 379             if (view->magic_mode && (type != COMPRESSION_NONE))
 380             {
 381                 g_free (view->filename);
 382                 view->filename = g_strconcat (file, decompress_extension (type), (char *) NULL);
 383             }
 384             mcview_set_datasource_file (view, fd, &st);
 385         }
 386         retval = TRUE;
 387     }
 388
 389   finish:
 390     view->command = g_strdup (command);
 391     view->dpy_start = 0;
 392     view->search_start = 0;
 393     view->search_end = 0;
 394     view->dpy_text_column = 0;
 395
 396     mcview_compute_areas (view);
 397     mcview_update_bytes_per_line (view);
 398
 399     if (mcview_remember_file_position && view->filename != NULL && start_line == 0)
 400     {
 401         char *canon_fname;
 402         long line, col;
 403         off_t new_offset;
 404
 405         canon_fname = vfs_canon (view->filename);
 406         load_file_position (canon_fname, &line, &col, &new_offset, &view->saved_bookmarks);
 407         new_offset = min (new_offset, mcview_get_filesize (view));
 408         view->dpy_start = mcview_bol (view, new_offset, 0);
 409         g_free (canon_fname);
 410     }
 411     else if (start_line > 0)
 412         mcview_moveto (view, start_line - 1, 0);
 413
 414     view->hexedit_lownibble = FALSE;
 415     view->hexview_in_text = FALSE;
 416     view->change_list = NULL;
 417     return retval;
 418 }
 419
 420 /* --------------------------------------------------------------------------------------------- */