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