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, 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
  39 #include <limits.h>
  40 #include <sys/types.h>
  41
  42 #include "lib/global.h"
  43 #include "lib/vfs/vfs.h"
  44 #include "lib/strutil.h"
  45 #include "lib/util.h"           /* save_file_position() */
  46 #include "lib/lock.h"           /* unlock_file() */
  47 #include "lib/widget.h"
  48 #include "lib/charsets.h"
  49
  50 #include "src/main.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
  71 /* --------------------------------------------------------------------------------------------- */
  72 /*** public functions ****************************************************************************/
  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 = mcview_bol (view, view->hex_cursor, 0);
 133         view->hex_cursor = view->dpy_start;
 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 (!mc_global.widget.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) || mc_global.widget.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         vfs_path_t *vpath;
 239         vpath = vfs_path_from_str (view->filename);
 240         canon_fname = vfs_path_to_str (vpath);
 241         save_file_position (canon_fname, -1, 0,
 242                             view->hex_mode ? view->hex_cursor : view->dpy_start,
 243                             view->saved_bookmarks);
 244         view->saved_bookmarks = NULL;
 245         g_free (canon_fname);
 246         vfs_path_free (vpath);
 247     }
 248
 249     /* Write back the global viewer mode */
 250     mcview_default_hex_mode = view->hex_mode;
 251     mcview_default_nroff_flag = view->text_nroff_mode;
 252     mcview_default_magic_flag = view->magic_mode;
 253     mcview_global_wrap_mode = view->text_wrap_mode;
 254
 255     /* Free memory used by the viewer */
 256
 257     /* view->widget needs no destructor */
 258
 259     g_free (view->filename);
 260     view->filename = NULL;
 261     g_free (view->workdir);
 262     view->workdir = NULL;
 263     g_free (view->command);
 264     view->command = NULL;
 265
 266     mcview_close_datasource (view);
 267     /* the growing buffer is freed with the datasource */
 268
 269     coord_cache_free (view->coord_cache), view->coord_cache = NULL;
 270
 271     if (view->converter == INVALID_CONV)
 272         view->converter = str_cnv_from_term;
 273
 274     if (view->converter != str_cnv_from_term)
 275     {
 276         str_close_conv (view->converter);
 277         view->converter = str_cnv_from_term;
 278     }
 279
 280     mc_search_free (view->search);
 281     view->search = NULL;
 282     g_free (view->last_search_string);
 283     view->last_search_string = NULL;
 284     mcview_nroff_seq_free (&view->search_nroff_seq);
 285     mcview_hexedit_free_change_list (view);
 286 }
 287
 288 /* --------------------------------------------------------------------------------------------- */
 289
 290 void
 291 mcview_set_codeset (mcview_t * view)
 292 {
 293 #ifdef HAVE_CHARSET
 294     const char *cp_id = NULL;
 295
 296     view->utf8 = TRUE;
 297     cp_id =
 298         get_codepage_id (mc_global.source_codepage >=
 299                          0 ? mc_global.source_codepage : mc_global.display_codepage);
 300     if (cp_id != NULL)
 301     {
 302         GIConv conv;
 303         conv = str_crt_conv_from (cp_id);
 304         if (conv != INVALID_CONV)
 305         {
 306             if (view->converter != str_cnv_from_term)
 307                 str_close_conv (view->converter);
 308             view->converter = conv;
 309         }
 310         view->utf8 = (gboolean) str_isutf8 (cp_id);
 311     }
 312 #else
 313     (void) view;
 314 #endif
 315 }
 316
 317 /* --------------------------------------------------------------------------------------------- */
 318
 319 void
 320 mcview_select_encoding (mcview_t * view)
 321 {
 322 #ifdef HAVE_CHARSET
 323     if (do_select_codepage ())
 324         mcview_set_codeset (view);
 325 #else
 326     (void) view;
 327 #endif
 328 }
 329
 330 /* --------------------------------------------------------------------------------------------- */
 331
 332 void
 333 mcview_show_error (mcview_t * view, const char *msg)
 334 {
 335     mcview_close_datasource (view);
 336     if (mcview_is_in_panel (view))
 337     {
 338         mcview_set_datasource_string (view, msg);
 339     }
 340     else
 341     {
 342         message (D_ERROR, MSG_ERROR, "%s", msg);
 343     }
 344 }
 345
 346 /* --------------------------------------------------------------------------------------------- */
 347 /** returns index of the first char in the line
 348  * it is constant for all line characters
 349  */
 350
 351 off_t
 352 mcview_bol (mcview_t * view, off_t current, off_t limit)
 353 {
 354     int c;
 355     off_t filesize;
 356     filesize = mcview_get_filesize (view);
 357     if (current <= 0)
 358         return 0;
 359     if (current > filesize)
 360         return filesize;
 361     if (!mcview_get_byte (view, current, &c))
 362         return current;
 363     if (c == '\n')
 364     {
 365         if (!mcview_get_byte (view, current - 1, &c))
 366             return current;
 367         if (c == '\r')
 368             current--;
 369     }
 370     while (current > 0 && current >= limit)
 371     {
 372         if (!mcview_get_byte (view, current - 1, &c))
 373             break;
 374         if (c == '\r' || c == '\n')
 375             break;
 376         current--;
 377     }
 378     return current;
 379 }
 380
 381 /* --------------------------------------------------------------------------------------------- */
 382 /** returns index of last char on line + width EOL
 383  * mcview_eol of the current line == mcview_bol next line
 384  */
 385
 386 off_t
 387 mcview_eol (mcview_t * view, off_t current, off_t limit)
 388 {
 389     int c, prev_ch = 0;
 390     off_t filesize;
 391     filesize = mcview_get_filesize (view);
 392     if (current < 0)
 393         return 0;
 394     if (current >= filesize)
 395         return filesize;
 396     while (current < filesize && current < limit)
 397     {
 398         if (!mcview_get_byte (view, current, &c))
 399             break;
 400         if (c == '\n')
 401         {
 402             current++;
 403             break;
 404         }
 405         else if (prev_ch == '\r')
 406         {
 407             break;
 408         }
 409         current++;
 410         prev_ch = c;
 411     }
 412     return current;
 413 }
 414
 415 /* --------------------------------------------------------------------------------------------- */
 416
 417 char *
 418 mcview_get_title (const Dlg_head * h, size_t len)
 419 {
 420     const mcview_t *view = (const mcview_t *) find_widget_type (h, mcview_callback);
 421     const char *modified = view->hexedit_mode && (view->change_list != NULL) ? "(*) " : "    ";
 422     const char *file_label;
 423
 424     len -= 4;
 425
 426     file_label = view->filename != NULL ? view->filename :
 427         view->command != NULL ? view->command : "";
 428     file_label = str_term_trim (file_label, len - str_term_width1 (_("View: ")));
 429
 430     return g_strconcat (_("View: "), modified, file_label, (char *) NULL);
 431 }
 432
 433 /* --------------------------------------------------------------------------------------------- */
 434
 435 gboolean
 436 mcview_lock_file (mcview_t * view)
 437 {
 438     char *fullpath;
 439     gboolean ret;
 440
 441     fullpath = mc_build_filename (view->workdir, view->filename, (char *) NULL);
 442     ret = lock_file (fullpath);
 443     g_free (fullpath);
 444
 445     return ret;
 446 }
 447
 448 /* --------------------------------------------------------------------------------------------- */
 449
 450 gboolean
 451 mcview_unlock_file (mcview_t * view)
 452 {
 453     char *fullpath;
 454     gboolean ret;
 455
 456     fullpath = mc_build_filename (view->workdir, view->filename, (char *) NULL);
 457     ret = unlock_file (fullpath);
 458     g_free (fullpath);
 459
 460     return ret;
 461 }
 462
 463 /* --------------------------------------------------------------------------------------------- */