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         query_set_sel (2);
 153         r = query_dialog (_("Quit"),
 154                           _("File was modified. Save with exit?"), D_NORMAL, 3,
 155                           _("&Yes"), _("&No"), _("&Cancel quit"));
 156     }
 157     else
 158     {
 159         r = query_dialog (_("Quit"),
 160                           _("Midnight Commander is being shut down.\nSave modified file?"),
 161                           D_NORMAL, 2, _("&Yes"), _("&No"));
 162         /* Esc is No */
 163         if (r == -1)
 164             r = 1;
 165     }
 166
 167     switch (r)
 168     {
 169     case 0:                    /* Yes */
 170         return mcview_hexedit_save_changes (view) || midnight_shutdown;
 171     case 1:                    /* No */
 172         mcview_hexedit_free_change_list (view);
 173         return TRUE;
 174     default:
 175         return FALSE;
 176     }
 177 }
 178
 179 /* --------------------------------------------------------------------------------------------- */
 180
 181 void
 182 mcview_init (mcview_t * view)
 183 {
 184     size_t i;
 185
 186     view->filename = NULL;
 187     view->workdir = NULL;
 188     view->command = NULL;
 189     view->search_nroff_seq = NULL;
 190
 191     mcview_set_datasource_none (view);
 192
 193     view->growbuf_in_use = FALSE;
 194     /* leave the other growbuf fields uninitialized */
 195
 196     view->hexedit_lownibble = FALSE;
 197     view->locked = FALSE;
 198     view->coord_cache = NULL;
 199
 200     view->dpy_start = 0;
 201     view->dpy_text_column = 0;
 202     view->dpy_end = 0;
 203     view->hex_cursor = 0;
 204     view->cursor_col = 0;
 205     view->cursor_row = 0;
 206     view->change_list = NULL;
 207
 208     /* {status,ruler,data}_area are left uninitialized */
 209
 210     view->dirty = 0;
 211     view->dpy_bbar_dirty = TRUE;
 212     view->bytes_per_line = 1;
 213
 214     view->search_start = 0;
 215     view->search_end = 0;
 216
 217     view->marker = 0;
 218     for (i = 0; i < sizeof (view->marks) / sizeof (view->marks[0]); i++)
 219         view->marks[i] = 0;
 220
 221     view->move_dir = 0;
 222     view->update_steps = 0;
 223     view->update_activate = 0;
 224 }
 225
 226 /* --------------------------------------------------------------------------------------------- */
 227
 228 void
 229 mcview_done (mcview_t * view)
 230 {
 231     /* Save current file position */
 232     if (mcview_remember_file_position && view->filename != NULL)
 233     {
 234         char *canon_fname;
 235         canon_fname = vfs_canon (view->filename);
 236         save_file_position (canon_fname, -1, 0, view->dpy_start);
 237         g_free (canon_fname);
 238     }
 239
 240     /* Write back the global viewer mode */
 241     mcview_default_hex_mode = view->hex_mode;
 242     mcview_default_nroff_flag = view->text_nroff_mode;
 243     mcview_default_magic_flag = view->magic_mode;
 244     mcview_global_wrap_mode = view->text_wrap_mode;
 245
 246     /* Free memory used by the viewer */
 247
 248     /* view->widget needs no destructor */
 249
 250     g_free (view->filename);
 251     view->filename = NULL;
 252     g_free (view->workdir);
 253     view->workdir = NULL;
 254     g_free (view->command);
 255     view->command = NULL;
 256
 257     mcview_close_datasource (view);
 258     /* the growing buffer is freed with the datasource */
 259
 260     coord_cache_free (view->coord_cache), view->coord_cache = NULL;
 261
 262     if (view->converter == INVALID_CONV)
 263         view->converter = str_cnv_from_term;
 264
 265     if (view->converter != str_cnv_from_term)
 266     {
 267         str_close_conv (view->converter);
 268         view->converter = str_cnv_from_term;
 269     }
 270
 271     mc_search_free (view->search);
 272     view->search = NULL;
 273     g_free (view->last_search_string);
 274     view->last_search_string = NULL;
 275     mcview_nroff_seq_free (&view->search_nroff_seq);
 276     mcview_hexedit_free_change_list (view);
 277 }
 278
 279 /* --------------------------------------------------------------------------------------------- */
 280
 281 void
 282 mcview_set_codeset (mcview_t * view)
 283 {
 284 #ifdef HAVE_CHARSET
 285     const char *cp_id = NULL;
 286
 287     view->utf8 = TRUE;
 288     cp_id = get_codepage_id (source_codepage >= 0 ? source_codepage : display_codepage);
 289     if (cp_id != NULL)
 290     {
 291         GIConv conv;
 292         conv = str_crt_conv_from (cp_id);
 293         if (conv != INVALID_CONV)
 294         {
 295             if (view->converter != str_cnv_from_term)
 296                 str_close_conv (view->converter);
 297             view->converter = conv;
 298         }
 299         view->utf8 = (gboolean) str_isutf8 (cp_id);
 300     }
 301 #else
 302     (void) view;
 303 #endif
 304 }
 305
 306 /* --------------------------------------------------------------------------------------------- */
 307
 308 void
 309 mcview_select_encoding (mcview_t * view)
 310 {
 311 #ifdef HAVE_CHARSET
 312     if (do_select_codepage ())
 313     {
 314         mcview_set_codeset (view);
 315     }
 316 #else
 317     (void) view;
 318 #endif
 319 }
 320
 321 /* --------------------------------------------------------------------------------------------- */
 322
 323 void
 324 mcview_show_error (mcview_t * view, const char *msg)
 325 {
 326     mcview_close_datasource (view);
 327     if (mcview_is_in_panel (view))
 328     {
 329         mcview_set_datasource_string (view, msg);
 330     }
 331     else
 332     {
 333         message (D_ERROR, MSG_ERROR, "%s", msg);
 334     }
 335 }
 336
 337 /* --------------------------------------------------------------------------------------------- */
 338
 339 /* returns index of the first char in the line */
 340 /* it is constant for all line characters */
 341 off_t
 342 mcview_bol (mcview_t * view, off_t current)
 343 {
 344     int c;
 345     off_t filesize;
 346     filesize = mcview_get_filesize (view);
 347     if (current <= 0)
 348         return 0;
 349     if (current > filesize)
 350         return filesize;
 351     if (!mcview_get_byte (view, current, &c))
 352         return current;
 353     if (c == '\n')
 354     {
 355         if (!mcview_get_byte (view, current - 1, &c))
 356             return current;
 357         if (c == '\r')
 358             current--;
 359     }
 360     while (current > 0)
 361     {
 362         if (!mcview_get_byte (view, current - 1, &c))
 363             break;
 364         if (c == '\r' || c == '\n')
 365             break;
 366         current--;
 367     }
 368     return current;
 369 }
 370
 371 /* --------------------------------------------------------------------------------------------- */
 372
 373 /* returns index of last char on line + width EOL */
 374 /* mcview_eol of the current line == mcview_bol next line */
 375 off_t
 376 mcview_eol (mcview_t * view, off_t current)
 377 {
 378     int c, prev_ch = 0;
 379     off_t filesize;
 380     filesize = mcview_get_filesize (view);
 381     if (current < 0)
 382         return 0;
 383     if (current >= filesize)
 384         return filesize;
 385     while (current < filesize)
 386     {
 387         if (!mcview_get_byte (view, current, &c))
 388             break;
 389         if (c == '\n')
 390         {
 391             current++;
 392             break;
 393         }
 394         else if (prev_ch == '\r')
 395         {
 396             break;
 397         }
 398         current++;
 399         prev_ch = c;
 400     }
 401     return current;
 402 }
 403
 404 /* --------------------------------------------------------------------------------------------- */
 405
 406 char *
 407 mcview_get_title (const Dlg_head * h, size_t len)
 408 {
 409     const mcview_t *view = (const mcview_t *) find_widget_type (h, mcview_callback);
 410     const char *modified = view->hexedit_mode && (view->change_list != NULL) ? "(*) " : "    ";
 411     const char *file_label;
 412
 413     len -= 4;
 414
 415     file_label = view->filename != NULL ? view->filename :
 416         view->command != NULL ? view->command : "";
 417     file_label = str_term_trim (file_label, len - str_term_width1 (_("View: ")));
 418
 419     return g_strconcat (_("View: "), modified, file_label, (char *) NULL);
 420 }
 421 /* --------------------------------------------------------------------------------------------- */
 422
 423 gboolean
 424 mcview_lock_file (mcview_t * view)
 425 {
 426     char *fullpath;
 427     gboolean ret;
 428
 429     fullpath = g_build_filename (view->workdir, view->filename, (char *) NULL);
 430     ret = lock_file (fullpath);
 431     g_free (fullpath);
 432
 433     return ret;
 434 }
 435
 436 /* --------------------------------------------------------------------------------------------- */
 437
 438 gboolean
 439 mcview_unlock_file (mcview_t * view)
 440 {
 441     char *fullpath;
 442     gboolean ret;
 443
 444     fullpath = g_build_filename (view->workdir, view->filename, (char *) NULL);
 445     ret = unlock_file (fullpath);
 446     g_free (fullpath);
 447
 448     return ret;
 449 }
 450
 451 /* --------------------------------------------------------------------------------------------- */