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, 2011
   7    The Free Software Foundation, Inc.
   8
   9    Written by:
  10    Miguel de Icaza, 1994, 1995, 1998
  11    Janne Kukonlehto, 1994, 1995
  12    Jakub Jelinek, 1995
  13    Joseph M. Hinkle, 1996
  14    Norbert Warmuth, 1997
  15    Pavel Machek, 1998
  16    Roland Illig <roland.illig@gmx.de>, 2004, 2005
  17    Slava Zanko <slavazanko@google.com>, 2009
  18    Andrew Borodin <aborodin@vmail.ru>, 2009
  19    Ilia Maslakov <il.smind@gmail.com>, 2009
  20
  21    This file is part of the Midnight Commander.
  22
  23    The Midnight Commander is free software: you can redistribute it
  24    and/or modify it under the terms of the GNU General Public License as
  25    published by the Free Software Foundation, either version 3 of the License,
  26    or (at your option) any later version.
  27
  28    The Midnight Commander is distributed in the hope that it will be useful,
  29    but WITHOUT ANY WARRANTY; without even the implied warranty of
  30    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31    GNU General Public License for more details.
  32
  33    You should have received a copy of the GNU General Public License
  34    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  35  */
  36
  37 #include <config.h>
  38 #include <errno.h>
  39 #include <fcntl.h>
  40
  41 #include "lib/global.h"
  42 #include "lib/tty/tty.h"
  43 #include "lib/tty/mouse.h"
  44 #include "lib/vfs/vfs.h"
  45 #include "lib/strutil.h"
  46 #include "lib/util.h"           /* load_file_position() */
  47 #include "lib/widget.h"
  48 #include "lib/charsets.h"
  49
  50 #include "src/main.h"
  51
  52 #include "src/filemanager/layout.h"     /* menubar_visible */
  53 #include "src/filemanager/midnight.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 /*** public functions ****************************************************************************/
 191 /* --------------------------------------------------------------------------------------------- */
 192
 193 mcview_t *
 194 mcview_new (int y, int x, int lines, int cols, gboolean is_panel)
 195 {
 196     mcview_t *view = g_new0 (mcview_t, 1);
 197
 198     init_widget (&view->widget, y, x, lines, cols, mcview_callback, mcview_real_event);
 199
 200     view->hex_mode = FALSE;
 201     view->hexedit_mode = FALSE;
 202     view->locked = FALSE;
 203     view->hexview_in_text = FALSE;
 204     view->text_nroff_mode = FALSE;
 205     view->text_wrap_mode = FALSE;
 206     view->magic_mode = FALSE;
 207
 208     view->dpy_frame_size = is_panel ? 1 : 0;
 209     view->converter = str_cnv_from_term;
 210
 211     mcview_init (view);
 212
 213     if (mcview_default_hex_mode)
 214         mcview_toggle_hex_mode (view);
 215     if (mcview_default_nroff_flag)
 216         mcview_toggle_nroff_mode (view);
 217     if (mcview_global_wrap_mode)
 218         mcview_toggle_wrap_mode (view);
 219     if (mcview_default_magic_flag)
 220         mcview_toggle_magic_mode (view);
 221
 222     return view;
 223 }
 224
 225 /* --------------------------------------------------------------------------------------------- */
 226 /** Real view only */
 227
 228 mcview_ret_t
 229 mcview_viewer (const char *command, const char *file, int start_line)
 230 {
 231     gboolean succeeded;
 232     mcview_t *lc_mcview;
 233     Dlg_head *view_dlg;
 234     mcview_ret_t ret;
 235
 236     /* Create dialog and widgets, put them on the dialog */
 237     view_dlg = create_dlg (FALSE, 0, 0, LINES, COLS, NULL, mcview_dialog_callback,
 238                            "[Internal File Viewer]", NULL, DLG_WANT_TAB);
 239
 240     lc_mcview = mcview_new (0, 0, LINES - 1, COLS, FALSE);
 241     add_widget (view_dlg, lc_mcview);
 242
 243     add_widget (view_dlg, buttonbar_new (TRUE));
 244
 245     view_dlg->get_title = mcview_get_title;
 246
 247     succeeded = mcview_load (lc_mcview, command, file, start_line);
 248
 249     if (succeeded)
 250     {
 251         run_dlg (view_dlg);
 252
 253         ret = lc_mcview->move_dir == 0 ? MCVIEW_EXIT_OK :
 254             lc_mcview->move_dir > 0 ? MCVIEW_WANT_NEXT : MCVIEW_WANT_PREV;
 255     }
 256     else
 257     {
 258         view_dlg->state = DLG_CLOSED;
 259         ret = MCVIEW_EXIT_FAILURE;
 260     }
 261
 262     if (view_dlg->state == DLG_CLOSED)
 263         destroy_dlg (view_dlg);
 264
 265     return ret;
 266 }
 267
 268 /* {{{ Miscellaneous functions }}} */
 269
 270 /* --------------------------------------------------------------------------------------------- */
 271
 272 gboolean
 273 mcview_load (mcview_t * view, const char *command, const char *file, int start_line)
 274 {
 275     gboolean retval = FALSE;
 276
 277 #ifdef HAVE_ASSERT_H
 278     assert (view->bytes_per_line != 0);
 279 #endif
 280
 281     view->filename = g_strdup (file);
 282
 283     if ((view->workdir == NULL) && (file != NULL))
 284     {
 285         if (!g_path_is_absolute (file))
 286             view->workdir = vfs_get_current_dir ();
 287         else
 288         {
 289             /* try extract path form filename */
 290             char *dirname;
 291
 292             dirname = g_path_get_dirname (file);
 293             if (strcmp (dirname, ".") != 0)
 294                 view->workdir = dirname;
 295             else
 296             {
 297                 g_free (dirname);
 298                 view->workdir = vfs_get_current_dir ();
 299             }
 300         }
 301     }
 302
 303     if (!mcview_is_in_panel (view))
 304         view->dpy_text_column = 0;
 305
 306     mcview_set_codeset (view);
 307
 308     if (command != NULL && (view->magic_mode || file == NULL || file[0] == '\0'))
 309         retval = mcview_load_command_output (view, command);
 310     else if (file != NULL && file[0] != '\0')
 311     {
 312         int fd = -1;
 313         char tmp[BUF_MEDIUM];
 314         struct stat st;
 315
 316         /* Open the file */
 317         fd = mc_open (file, O_RDONLY | O_NONBLOCK);
 318         if (fd == -1)
 319         {
 320             g_snprintf (tmp, sizeof (tmp), _("Cannot open \"%s\"\n%s"),
 321                         file, unix_error_string (errno));
 322             mcview_show_error (view, tmp);
 323             g_free (view->filename);
 324             view->filename = NULL;
 325             g_free (view->workdir);
 326             view->workdir = NULL;
 327             goto finish;
 328         }
 329
 330         /* Make sure we are working with a regular file */
 331         if (mc_fstat (fd, &st) == -1)
 332         {
 333             mc_close (fd);
 334             g_snprintf (tmp, sizeof (tmp), _("Cannot stat \"%s\"\n%s"),
 335                         file, unix_error_string (errno));
 336             mcview_show_error (view, tmp);
 337             g_free (view->filename);
 338             view->filename = NULL;
 339             g_free (view->workdir);
 340             view->workdir = NULL;
 341             goto finish;
 342         }
 343
 344         if (!S_ISREG (st.st_mode))
 345         {
 346             mc_close (fd);
 347             mcview_show_error (view, _("Cannot view: not a regular file"));
 348             g_free (view->filename);
 349             view->filename = NULL;
 350             g_free (view->workdir);
 351             view->workdir = NULL;
 352             goto finish;
 353         }
 354
 355         if (st.st_size == 0 || mc_lseek (fd, 0, SEEK_SET) == -1)
 356         {
 357             /* Must be one of those nice files that grow (/proc) */
 358             mcview_set_datasource_vfs_pipe (view, fd);
 359         }
 360         else
 361         {
 362             int type;
 363
 364             type = get_compression_type (fd, file);
 365
 366             if (view->magic_mode && (type != COMPRESSION_NONE))
 367             {
 368                 g_free (view->filename);
 369                 view->filename = g_strconcat (file, decompress_extension (type), (char *) NULL);
 370             }
 371             mcview_set_datasource_file (view, fd, &st);
 372         }
 373         retval = TRUE;
 374     }
 375
 376   finish:
 377     view->command = g_strdup (command);
 378     view->dpy_start = 0;
 379     view->search_start = 0;
 380     view->search_end = 0;
 381     view->dpy_text_column = 0;
 382
 383     mcview_compute_areas (view);
 384     mcview_update_bytes_per_line (view);
 385
 386     if (mcview_remember_file_position && view->filename != NULL && start_line == 0)
 387     {
 388         char *canon_fname;
 389         long line, col;
 390         off_t new_offset, max_offset;
 391         vfs_path_t *vpath;
 392
 393         vpath = vfs_path_from_str (view->filename);
 394         canon_fname = vfs_path_to_str (vpath);
 395         load_file_position (canon_fname, &line, &col, &new_offset, &view->saved_bookmarks);
 396         max_offset = mcview_get_filesize (view) - 1;
 397         if (max_offset < 0)
 398             new_offset = 0;
 399         else
 400             new_offset = min (new_offset, max_offset);
 401         if (!view->hex_mode)
 402             view->dpy_start = mcview_bol (view, new_offset, 0);
 403         else
 404         {
 405             view->dpy_start = new_offset - new_offset % view->bytes_per_line;
 406             view->hex_cursor = new_offset;
 407         }
 408         g_free (canon_fname);
 409         vfs_path_free (vpath);
 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 /* --------------------------------------------------------------------------------------------- */