src/viewer/hex.c

   1 /*
   2    Internal file viewer for the Midnight Commander
   3    Function for hex view
   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 <errno.h>
  41 #include <fcntl.h>
  42
  43 #include "lib/global.h"
  44 #include "lib/tty/tty.h"
  45 #include "lib/skin.h"
  46 #include "src/main.h"
  47 #include "src/wtools.h"
  48 #include "src/charsets.h"
  49
  50 #include "lib/vfs/mc-vfs/vfs.h"
  51
  52 #include "internal.h"
  53
  54 /*** global variables ****************************************************************************/
  55
  56 /*** file scope macro definitions ****************************************************************/
  57
  58 /*** file scope type declarations ****************************************************************/
  59
  60 typedef enum
  61 {
  62     MARK_NORMAL,
  63     MARK_SELECTED,
  64     MARK_CURSOR,
  65     MARK_CHANGED
  66 } mark_t;
  67
  68 /*** file scope variables ************************************************************************/
  69
  70 static const char hex_char[] = "0123456789ABCDEF";
  71
  72 /*** file scope functions ************************************************************************/
  73
  74 /*** public functions ****************************************************************************/
  75
  76 /* --------------------------------------------------------------------------------------------- */
  77
  78 void
  79 mcview_display_hex (mcview_t * view)
  80 {
  81     const screen_dimen top = view->data_area.top;
  82     const screen_dimen left = view->data_area.left;
  83     const screen_dimen height = view->data_area.height;
  84     const screen_dimen width = view->data_area.width;
  85     const int ngroups = view->bytes_per_line / 4;
  86     const screen_dimen text_start = 8 + 13 * ngroups + ((width < 80) ? 0 : (ngroups - 1 + 1));
  87     /* 8 characters are used for the file offset, and every hex group
  88      * takes 13 characters. On ``big'' screens, the groups are separated
  89      * by an extra vertical line, and there is an extra space before the
  90      * text column.
  91      */
  92
  93     screen_dimen row, col;
  94     off_t from;
  95     int c;
  96     mark_t boldflag = MARK_NORMAL;
  97     struct hexedit_change_node *curr = view->change_list;
  98     size_t i;
  99     int ch = 0;
 100
 101     char hex_buff[10];          /* A temporary buffer for sprintf and mvwaddstr */
 102     int bytes;                  /* Number of bytes already printed on the line */
 103
 104     mcview_display_clean (view);
 105
 106     /* Find the first displayable changed byte */
 107     from = view->dpy_start;
 108     while (curr && (curr->offset < from))
 109     {
 110         curr = curr->next;
 111     }
 112
 113     for (row = 0; mcview_get_byte (view, from, NULL) == TRUE && row < height; row++)
 114     {
 115         col = 0;
 116
 117         /* Print the hex offset */
 118         g_snprintf (hex_buff, sizeof (hex_buff), "%08" OFFSETTYPE_PRIX " ",
 119                     (long unsigned int) from);
 120         widget_move (view, top + row, left);
 121         tty_setcolor (MARKED_COLOR);
 122         for (i = 0; col < width && hex_buff[i] != '\0'; i++)
 123         {
 124             tty_print_char (hex_buff[i]);
 125             /*              tty_print_char(hex_buff[i]); */
 126             col += 1;
 127         }
 128         tty_setcolor (NORMAL_COLOR);
 129
 130         for (bytes = 0; bytes < view->bytes_per_line; bytes++, from++)
 131         {
 132
 133 #ifdef HAVE_CHARSET
 134             if (view->utf8)
 135             {
 136                 int cw = 1;
 137                 gboolean read_res = TRUE;
 138                 ch = mcview_get_utf (view, from, &cw, &read_res);
 139                 if (!read_res)
 140                     break;
 141             }
 142 #endif
 143             if (!mcview_get_byte (view, from, &c))
 144                 break;
 145
 146             /* Save the cursor position for mcview_place_cursor() */
 147             if (from == view->hex_cursor && !view->hexview_in_text)
 148             {
 149                 view->cursor_row = row;
 150                 view->cursor_col = col;
 151             }
 152
 153             /* Determine the state of the current byte */
 154             boldflag =
 155                 (from == view->hex_cursor) ? MARK_CURSOR
 156                 : (curr != NULL && from == curr->offset) ? MARK_CHANGED
 157                 : (view->search_start <= from &&
 158                    from < view->search_end) ? MARK_SELECTED : MARK_NORMAL;
 159
 160             /* Determine the value of the current byte */
 161             if (curr != NULL && from == curr->offset)
 162             {
 163                 c = curr->value;
 164                 curr = curr->next;
 165             }
 166
 167             /* Select the color for the hex number */
 168             tty_setcolor (boldflag == MARK_NORMAL ? NORMAL_COLOR :
 169                           boldflag == MARK_SELECTED ? MARKED_COLOR :
 170                           boldflag == MARK_CHANGED ? VIEW_UNDERLINED_COLOR :
 171                           /* boldflag == MARK_CURSOR */
 172                           view->hexview_in_text ? MARKED_SELECTED_COLOR : VIEW_UNDERLINED_COLOR);
 173
 174             /* Print the hex number */
 175             widget_move (view, top + row, left + col);
 176             if (col < width)
 177             {
 178                 tty_print_char (hex_char[c / 16]);
 179                 col += 1;
 180             }
 181             if (col < width)
 182             {
 183                 tty_print_char (hex_char[c % 16]);
 184                 col += 1;
 185             }
 186
 187             /* Print the separator */
 188             tty_setcolor (NORMAL_COLOR);
 189             if (bytes != view->bytes_per_line - 1)
 190             {
 191                 if (col < width)
 192                 {
 193                     tty_print_char (' ');
 194                     col += 1;
 195                 }
 196
 197                 /* After every four bytes, print a group separator */
 198                 if (bytes % 4 == 3)
 199                 {
 200                     if (view->data_area.width >= 80 && col < width)
 201                     {
 202                         tty_print_one_vline ();
 203                         col += 1;
 204                     }
 205                     if (col < width)
 206                     {
 207                         tty_print_char (' ');
 208                         col += 1;
 209                     }
 210                 }
 211             }
 212
 213             /* Select the color for the character; this differs from the
 214              * hex color when boldflag == MARK_CURSOR */
 215             tty_setcolor (boldflag == MARK_NORMAL ? NORMAL_COLOR :
 216                           boldflag == MARK_SELECTED ? MARKED_COLOR :
 217                           boldflag == MARK_CHANGED ? VIEW_UNDERLINED_COLOR :
 218                           /* boldflag == MARK_CURSOR */
 219                           view->hexview_in_text ? VIEW_UNDERLINED_COLOR : MARKED_SELECTED_COLOR);
 220
 221 #ifdef HAVE_CHARSET
 222             if (utf8_display)
 223             {
 224                 if (!view->utf8)
 225                 {
 226                     ch = convert_from_8bit_to_utf_c ((unsigned char) ch, view->converter);
 227                 }
 228                 if (!g_unichar_isprint (ch))
 229                     ch = '.';
 230             }
 231             else
 232             {
 233                 if (view->utf8)
 234                 {
 235                     ch = convert_from_utf_to_current_c (ch, view->converter);
 236                 }
 237                 else
 238                 {
 239 #endif
 240                     ch = convert_to_display_c (ch);
 241 #ifdef HAVE_CHARSET
 242                 }
 243             }
 244 #endif
 245             c = convert_to_display_c (c);
 246             if (!g_ascii_isprint (c))
 247                 c = '.';
 248
 249             /* Print corresponding character on the text side */
 250             if (text_start + bytes < width)
 251             {
 252                 widget_move (view, top + row, left + text_start + bytes);
 253                 if (!view->utf8)
 254                 {
 255                     tty_print_char (c);
 256                 }
 257                 else
 258                 {
 259                     tty_print_anychar (ch);
 260                 }
 261             }
 262
 263             /* Save the cursor position for mcview_place_cursor() */
 264             if (from == view->hex_cursor && view->hexview_in_text)
 265             {
 266                 view->cursor_row = row;
 267                 view->cursor_col = text_start + bytes;
 268             }
 269         }
 270     }
 271
 272     /* Be polite to the other functions */
 273     tty_setcolor (NORMAL_COLOR);
 274
 275     mcview_place_cursor (view);
 276     view->dpy_end = from;
 277 }
 278
 279 /* --------------------------------------------------------------------------------------------- */
 280
 281 gboolean
 282 mcview_hexedit_save_changes (mcview_t * view)
 283 {
 284     int answer = 0;
 285
 286     if (view->change_list == NULL)
 287         return TRUE;
 288
 289     while (answer == 0)
 290     {
 291         int fp;
 292         char *text;
 293         struct hexedit_change_node *curr, *next;
 294
 295         assert (view->filename != NULL);
 296
 297         fp = mc_open (view->filename, O_WRONLY);
 298         if (fp != -1)
 299         {
 300             for (curr = view->change_list; curr != NULL; curr = next)
 301             {
 302                 next = curr->next;
 303
 304                 if (mc_lseek (fp, curr->offset, SEEK_SET) == -1
 305                     || mc_write (fp, &(curr->value), 1) != 1)
 306                     goto save_error;
 307
 308                 /* delete the saved item from the change list */
 309                 view->change_list = next;
 310                 view->dirty++;
 311                 mcview_set_byte (view, curr->offset, curr->value);
 312                 g_free (curr);
 313             }
 314
 315             if (mc_close (fp) == -1)
 316                 message (D_ERROR, _(" Save file "),
 317                             _(" Error while closing the file: \n %s \n"
 318                             " Data may have been written or not. "),
 319                             unix_error_string (errno));
 320
 321             view->dirty++;
 322             return TRUE;
 323         }
 324
 325 save_error:
 326         text = g_strdup_printf (_(" Cannot save file: \n %s "), unix_error_string (errno));
 327         (void) mc_close (fp);
 328
 329         answer = query_dialog (_(" Save file "), text, D_ERROR, 2, _("&Retry"), _("&Cancel"));
 330         g_free (text);
 331     }
 332
 333     return FALSE;
 334 }
 335
 336 /* --------------------------------------------------------------------------------------------- */
 337
 338 void
 339 mcview_toggle_hexedit_mode (mcview_t * view)
 340 {
 341     view->hexedit_mode = !view->hexedit_mode;
 342     view->dpy_bbar_dirty = TRUE;
 343     view->dirty++;
 344 }
 345
 346 /* --------------------------------------------------------------------------------------------- */
 347
 348 void
 349 mcview_hexedit_free_change_list (mcview_t * view)
 350 {
 351     struct hexedit_change_node *curr, *next;
 352
 353     for (curr = view->change_list; curr != NULL; curr = next)
 354     {
 355         next = curr->next;
 356         g_free (curr);
 357     }
 358     view->change_list = NULL;
 359     view->dirty++;
 360 }
 361
 362 /* --------------------------------------------------------------------------------------------- */
 363
 364 void
 365 mcview_enqueue_change (struct hexedit_change_node **head, struct hexedit_change_node *node)
 366 {
 367     /* chnode always either points to the head of the list or
 368      * to one of the ->next fields in the list. The value at
 369      * this location will be overwritten with the new node.   */
 370     struct hexedit_change_node **chnode = head;
 371
 372     while (*chnode != NULL && (*chnode)->offset < node->offset)
 373         chnode = &((*chnode)->next);
 374
 375     node->next = *chnode;
 376     *chnode = node;
 377 }
 378
 379 /* --------------------------------------------------------------------------------------------- */