src/viewer/lib.c

   1 /*
   2    Internal file viewer for the Midnight Commander
   3    Common finctions (used from some other mcviewer 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
  40 #include <limits.h>
  41 #include <sys/types.h>
  42
  43 #include "lib/global.h"
  44 #include "lib/vfs/mc-vfs/vfs.h"
  45 #include "lib/strutil.h"
  46 #include "lib/util.h"           /* save_file_position() */
  47 #include "lib/lock.h"           /* unlock_file() */
  48
  49 #include "src/wtools.h"
  50 #include "src/main.h"
  51 #include "src/charsets.h"
  52 #include "src/selcodepage.h"
  53
  54 #include "internal.h"
  55 #include "mcviewer.h"
  56
  57 /*** global variables ****************************************************************************/
  58
  59 #define OFF_T_BITWIDTH (unsigned int) (sizeof (off_t) * CHAR_BIT - 1)
  60 const off_t INVALID_OFFSET = (off_t) -1;
  61 const off_t OFFSETTYPE_MAX = ((off_t) 1 << (OFF_T_BITWIDTH - 1)) - 1;
  62
  63 /*** file scope macro definitions ****************************************************************/
  64
  65 /*** file scope type declarations ****************************************************************/
  66
  67 /*** file scope variables ************************************************************************/
  68
  69 /*** file scope functions ************************************************************************/
  70
  71 /*** public functions ****************************************************************************/
  72
  73 /* --------------------------------------------------------------------------------------------- */
  74
  75 void
  76 mcview_toggle_magic_mode (mcview_t * view)
  77 {
  78     char *filename, *command;
  79
  80     mcview_altered_magic_flag = 1;
  81     view->magic_mode = !view->magic_mode;
  82     filename = g_strdup (view->filename);
  83     command = g_strdup (view->command);
  84
  85     mcview_done (view);
  86     mcview_init (view);
  87     mcview_load (view, command, filename, 0);
  88     g_free (filename);
  89     g_free (command);
  90     view->dpy_bbar_dirty = TRUE;
  91     view->dirty++;
  92 }
  93
  94 /* --------------------------------------------------------------------------------------------- */
  95
  96 void
  97 mcview_toggle_wrap_mode (mcview_t * view)
  98 {
  99     if (view->text_wrap_mode)
 100         view->dpy_start = mcview_bol (view, view->dpy_start, 0);
 101     view->text_wrap_mode = !view->text_wrap_mode;
 102     view->dpy_bbar_dirty = TRUE;
 103     view->dirty++;
 104 }
 105
 106 /* --------------------------------------------------------------------------------------------- */
 107
 108 void
 109 mcview_toggle_nroff_mode (mcview_t * view)
 110 {
 111     view->text_nroff_mode = !view->text_nroff_mode;
 112     mcview_altered_nroff_flag = 1;
 113     view->dpy_bbar_dirty = TRUE;
 114     view->dirty++;
 115 }
 116
 117 /* --------------------------------------------------------------------------------------------- */
 118
 119 void
 120 mcview_toggle_hex_mode (mcview_t * view)
 121 {
 122     view->hex_mode = !view->hex_mode;
 123
 124     if (view->hex_mode)
 125     {
 126         view->hex_cursor = view->dpy_start;
 127         view->dpy_start = mcview_offset_rounddown (view->dpy_start, view->bytes_per_line);
 128         widget_want_cursor (view->widget, 1);
 129     }
 130     else
 131     {
 132         view->dpy_start = view->hex_cursor;
 133         mcview_moveto_bol (view);
 134         widget_want_cursor (view->widget, 0);
 135     }
 136     mcview_altered_hex_mode = 1;
 137     view->dpy_bbar_dirty = TRUE;
 138     view->dirty++;
 139 }
 140
 141 /* --------------------------------------------------------------------------------------------- */
 142
 143 gboolean
 144 mcview_ok_to_quit (mcview_t * view)
 145 {
 146     int r;
 147
 148     if (view->change_list == NULL)
 149         return TRUE;
 150
 151     if (!midnight_shutdown)
 152     {
 153         query_set_sel (2);
 154         r = query_dialog (_("Quit"),
 155                           _("File was modified. Save with exit?"), D_NORMAL, 3,
 156                           _("&Yes"), _("&No"), _("&Cancel quit"));
 157     }
 158     else
 159     {
 160         r = query_dialog (_("Quit"),
 161                           _("Midnight Commander is being shut down.\nSave modified file?"),
 162                           D_NORMAL, 2, _("&Yes"), _("&No"));
 163         /* Esc is No */
 164         if (r == -1)
 165             r = 1;
 166     }
 167
 168     switch (r)
 169     {
 170     case 0:                    /* Yes */
 171         return mcview_hexedit_save_changes (view) || midnight_shutdown;
 172     case 1:                    /* No */
 173         mcview_hexedit_free_change_list (view);
 174         return TRUE;
 175     default:
 176         return FALSE;
 177     }
 178 }
 179
 180 /* --------------------------------------------------------------------------------------------- */
 181
 182 void
 183 mcview_init (mcview_t * view)
 184 {
 185     size_t i;
 186
 187     view->filename = NULL;
 188     view->workdir = NULL;
 189     view->command = NULL;
 190     view->search_nroff_seq = NULL;
 191
 192     mcview_set_datasource_none (view);
 193
 194     view->growbuf_in_use = FALSE;
 195     /* leave the other growbuf fields uninitialized */
 196
 197     view->hexedit_lownibble = FALSE;
 198     view->locked = FALSE;
 199     view->coord_cache = NULL;
 200
 201     view->dpy_start = 0;
 202     view->dpy_text_column = 0;
 203     view->dpy_end = 0;
 204     view->hex_cursor = 0;
 205     view->cursor_col = 0;
 206     view->cursor_row = 0;
 207     view->change_list = NULL;
 208
 209     /* {status,ruler,data}_area are left uninitialized */
 210
 211     view->dirty = 0;
 212     view->dpy_bbar_dirty = TRUE;
 213     view->bytes_per_line = 1;
 214
 215     view->search_start = 0;
 216     view->search_end = 0;
 217
 218     view->marker = 0;
 219     for (i = 0; i < sizeof (view->marks) / sizeof (view->marks[0]); i++)
 220         view->marks[i] = 0;
 221
 222     view->move_dir = 0;
 223     view->update_steps = 0;
 224     view->update_activate = 0;
 225
 226     view->saved_bookmarks = NULL;
 227 }
 228
 229 /* --------------------------------------------------------------------------------------------- */
 230
 231 void
 232 mcview_done (mcview_t * view)
 233 {
 234     /* Save current file position */
 235     if (mcview_remember_file_position && view->filename != NULL)
 236     {
 237         char *canon_fname;
 238         canon_fname = vfs_canon (view->filename);
 239         save_file_position (canon_fname, -1, 0, view->dpy_start, view->saved_bookmarks);
 240         view->saved_bookmarks = NULL;
 241         g_free (canon_fname);
 242     }
 243
 244     /* Write back the global viewer mode */
 245     mcview_default_hex_mode = view->hex_mode;
 246     mcview_default_nroff_flag = view->text_nroff_mode;
 247     mcview_default_magic_flag = view->magic_mode;
 248     mcview_global_wrap_mode = view->text_wrap_mode;
 249
 250     /* Free memory used by the viewer */
 251
 252     /* view->widget needs no destructor */
 253
 254     g_free (view->filename);
 255     view->filename = NULL;
 256     g_free (view->workdir);
 257     view->workdir = NULL;
 258     g_free (view->command);
 259     view->command = NULL;
 260
 261     mcview_close_datasource (view);
 262     /* the growing buffer is freed with the datasource */
 263
 264     coord_cache_free (view->coord_cache), view->coord_cache = NULL;
 265
 266     if (view->converter == INVALID_CONV)
 267         view->converter = str_cnv_from_term;
 268
 269     if (view->converter != str_cnv_from_term)
 270     {
 271         str_close_conv (view->converter);
 272         view->converter = str_cnv_from_term;
 273     }
 274
 275     mc_search_free (view->search);
 276     view->search = NULL;
 277     g_free (view->last_search_string);
 278     view->last_search_string = NULL;
 279     mcview_nroff_seq_free (&view->search_nroff_seq);
 280     mcview_hexedit_free_change_list (view);
 281 }
 282
 283 /* --------------------------------------------------------------------------------------------- */
 284
 285 void
 286 mcview_set_codeset (mcview_t * view)
 287 {
 288 #ifdef HAVE_CHARSET
 289     const char *cp_id = NULL;
 290
 291     view->utf8 = TRUE;
 292     cp_id = get_codepage_id (source_codepage >= 0 ? source_codepage : display_codepage);
 293     if (cp_id != NULL)
 294     {
 295         GIConv conv;
 296         conv = str_crt_conv_from (cp_id);
 297         if (conv != INVALID_CONV)
 298         {
 299             if (view->converter != str_cnv_from_term)
 300                 str_close_conv (view->converter);
 301             view->converter = conv;
 302         }
 303         view->utf8 = (gboolean) str_isutf8 (cp_id);
 304     }
 305 #else
 306     (void) view;
 307 #endif
 308 }
 309
 310 /* --------------------------------------------------------------------------------------------- */
 311
 312 void
 313 mcview_select_encoding (mcview_t * view)
 314 {
 315 #ifdef HAVE_CHARSET
 316     if (do_select_codepage ())
 317     {
 318         mcview_set_codeset (view);
 319     }
 320 #else
 321     (void) view;
 322 #endif
 323 }
 324
 325 /* --------------------------------------------------------------------------------------------- */
 326
 327 void
 328 mcview_show_error (mcview_t * view, const char *msg)
 329 {
 330     mcview_close_datasource (view);
 331     if (mcview_is_in_panel (view))
 332     {
 333         mcview_set_datasource_string (view, msg);
 334     }
 335     else
 336     {
 337         message (D_ERROR, MSG_ERROR, "%s", msg);
 338     }
 339 }
 340
 341 /* --------------------------------------------------------------------------------------------- */
 342
 343 /* returns index of the first char in the line */
 344 /* it is constant for all line characters */
 345 off_t
 346 mcview_bol (mcview_t * view, off_t current, off_t limit)
 347 {
 348     int c;
 349     off_t filesize;
 350     filesize = mcview_get_filesize (view);
 351     if (current <= 0)
 352         return 0;
 353     if (current > filesize)
 354         return filesize;
 355     if (!mcview_get_byte (view, current, &c))
 356         return current;
 357     if (c == '\n')
 358     {
 359         if (!mcview_get_byte (view, current - 1, &c))
 360             return current;
 361         if (c == '\r')
 362             current--;
 363     }
 364     while (current > 0 && current >= limit)
 365     {
 366         if (!mcview_get_byte (view, current - 1, &c))
 367             break;
 368         if (c == '\r' || c == '\n')
 369             break;
 370         current--;
 371     }
 372     return current;
 373 }
 374
 375 /* --------------------------------------------------------------------------------------------- */
 376
 377 /* returns index of last char on line + width EOL */
 378 /* mcview_eol of the current line == mcview_bol next line */
 379 off_t
 380 mcview_eol (mcview_t * view, off_t current, off_t limit)
 381 {
 382     int c, prev_ch = 0;
 383     off_t filesize;
 384     filesize = mcview_get_filesize (view);
 385     if (current < 0)
 386         return 0;
 387     if (current >= filesize)
 388         return filesize;
 389     while (current < filesize && current < limit)
 390     {
 391         if (!mcview_get_byte (view, current, &c))
 392             break;
 393         if (c == '\n')
 394         {
 395             current++;
 396             break;
 397         }
 398         else if (prev_ch == '\r')
 399         {
 400             break;
 401         }
 402         current++;
 403         prev_ch = c;
 404     }
 405     return current;
 406 }
 407
 408 /* --------------------------------------------------------------------------------------------- */
 409
 410 char *
 411 mcview_get_title (const Dlg_head * h, size_t len)
 412 {
 413     const mcview_t *view = (const mcview_t *) find_widget_type (h, mcview_callback);
 414     const char *modified = view->hexedit_mode && (view->change_list != NULL) ? "(*) " : "    ";
 415     const char *file_label;
 416
 417     len -= 4;
 418
 419     file_label = view->filename != NULL ? view->filename :
 420         view->command != NULL ? view->command : "";
 421     file_label = str_term_trim (file_label, len - str_term_width1 (_("View: ")));
 422
 423     return g_strconcat (_("View: "), modified, file_label, (char *) NULL);
 424 }
 425 /* --------------------------------------------------------------------------------------------- */
 426
 427 gboolean
 428 mcview_lock_file (mcview_t * view)
 429 {
 430     char *fullpath;
 431     gboolean ret;
 432
 433     fullpath = g_build_filename (view->workdir, view->filename, (char *) NULL);
 434     ret = lock_file (fullpath);
 435     g_free (fullpath);
 436
 437     return ret;
 438 }
 439
 440 /* --------------------------------------------------------------------------------------------- */
 441
 442 gboolean
 443 mcview_unlock_file (mcview_t * view)
 444 {
 445     char *fullpath;
 446     gboolean ret;
 447
 448     fullpath = g_build_filename (view->workdir, view->filename, (char *) NULL);
 449     ret = unlock_file (fullpath);
 450     g_free (fullpath);
 451
 452     return ret;
 453 }
 454
 455 /* --------------------------------------------------------------------------------------------- */