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