code.delx.au - gnu-emacs/blob - lisp/hexl.el

   1 ;;; hexl.el --- edit a file in a hex dump format using the hexl filter
   2
   3 ;; Copyright (C) 1989, 1994, 1998, 2001, 2002, 2003, 2004,
   4 ;;   2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   5
   6 ;; Author: Keith Gabryelski <ag@wheaties.ai.mit.edu>
   7 ;; Maintainer: FSF
   8 ;; Keywords: data
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Commentary:
  26
  27 ;; This package implements a major mode for editing binary files.  It uses
  28 ;; a program called hexl, supplied with the GNU Emacs distribution, that
  29 ;; can filter a binary into an editable format or from the format back into
  30 ;; binary.  For full instructions, invoke `hexl-mode' on an empty buffer and
  31 ;; do M-x `describe-mode'.
  32 ;;
  33 ;; NOTE: Remember to change `hexl-program' or `hexl-options' if needed.
  34 ;;
  35 ;; Currently hexl only supports big endian hex output with 16 bit
  36 ;; grouping.
  37 ;;
  38 ;; -iso in `hexl-options' will allow iso characters to display in the
  39 ;; ASCII region of the screen (if your Emacs supports this) instead of
  40 ;; changing them to dots.
  41
  42 ;;; Code:
  43
  44 (require 'eldoc)
  45 (eval-when-compile (require 'cl))
  46
  47 ;;
  48 ;; vars here
  49 ;;
  50
  51 (defgroup hexl nil
  52   "Edit a file in a hex dump format using the hexl filter."
  53   :group 'data)
  54
  55
  56 (defcustom hexl-program "hexl"
  57   "The program that will hexlify and dehexlify its stdin.
  58 `hexl-program' will always be concatenated with `hexl-options'
  59 and \"-de\" when dehexlifying a buffer."
  60   :type 'string
  61   :group 'hexl)
  62
  63 (defcustom hexl-iso ""
  64   "If your Emacs can handle ISO characters, this should be set to
  65 \"-iso\" otherwise it should be \"\"."
  66   :type 'string
  67   :group 'hexl)
  68
  69 (defcustom hexl-options (format "-hex %s" hexl-iso)
  70   "Space separated options to `hexl-program' that suit your needs.
  71 Quoting cannot be used, so the arguments cannot themselves contain spaces."
  72   :type 'string
  73   :group 'hexl)
  74
  75 (defcustom hexl-follow-ascii t
  76   "If non-nil then highlight the ASCII character corresponding to point."
  77   :type 'boolean
  78   :group 'hexl
  79   :version "20.3")
  80
  81 (defcustom hexl-mode-hook '(hexl-follow-line hexl-activate-ruler)
  82   "Normal hook run when entering Hexl mode."
  83   :type 'hook
  84   :options '(hexl-follow-line hexl-activate-ruler turn-on-eldoc-mode)
  85   :group 'hexl)
  86
  87 (defface hexl-address-region
  88   '((t (:inherit header-line)))
  89   "Face used in address area of hexl-mode buffer."
  90   :group 'hexl)
  91
  92 (defface hexl-ascii-region
  93   '((t (:inherit header-line)))
  94   "Face used in ascii area of hexl-mode buffer."
  95   :group 'hexl)
  96
  97 (defvar hexl-max-address 0
  98   "Maximum offset into hexl buffer.")
  99
 100 (defvar hexl-mode-map
 101   (let ((map (make-keymap)))
 102     ;; Make all self-inserting keys go through hexl-self-insert-command,
 103     ;; because we need to convert them to unibyte characters before
 104     ;; inserting them into the buffer.
 105     (define-key map [remap self-insert-command] 'hexl-self-insert-command)
 106
 107     (define-key map "\C-m" 'hexl-self-insert-command)
 108     (define-key map [left] 'hexl-backward-char)
 109     (define-key map [right] 'hexl-forward-char)
 110     (define-key map [up] 'hexl-previous-line)
 111     (define-key map [down] 'hexl-next-line)
 112     (define-key map [M-left] 'hexl-backward-short)
 113     (define-key map [?\e left] 'hexl-backward-short)
 114     (define-key map [M-right] 'hexl-forward-short)
 115     (define-key map [?\e right] 'hexl-forward-short)
 116     (define-key map [next] 'hexl-scroll-up)
 117     (define-key map [prior] 'hexl-scroll-down)
 118     (define-key map [home] 'hexl-beginning-of-line)
 119     (define-key map [end] 'hexl-end-of-line)
 120     (define-key map [C-home] 'hexl-beginning-of-buffer)
 121     (define-key map [C-end] 'hexl-end-of-buffer)
 122     (define-key map [deletechar] 'undefined)
 123     (define-key map [deleteline] 'undefined)
 124     (define-key map [insertline] 'undefined)
 125     (define-key map [S-delete] 'undefined)
 126     (define-key map "\177" 'undefined)
 127
 128     (define-key map "\C-a" 'hexl-beginning-of-line)
 129     (define-key map "\C-b" 'hexl-backward-char)
 130     (define-key map "\C-d" 'undefined)
 131     (define-key map "\C-e" 'hexl-end-of-line)
 132     (define-key map "\C-f" 'hexl-forward-char)
 133
 134     (if (not (memq (key-binding (char-to-string help-char))
 135                    '(help-command ehelp-command)))
 136         (define-key map (char-to-string help-char) 'undefined))
 137
 138     (define-key map "\C-k" 'undefined)
 139     (define-key map "\C-n" 'hexl-next-line)
 140     (define-key map "\C-o" 'undefined)
 141     (define-key map "\C-p" 'hexl-previous-line)
 142     (define-key map "\C-q" 'hexl-quoted-insert)
 143     (define-key map "\C-t" 'undefined)
 144     (define-key map "\C-v" 'hexl-scroll-up)
 145     (define-key map "\C-w" 'undefined)
 146     (define-key map "\C-y" 'undefined)
 147
 148     (fset 'hexl-ESC-prefix (copy-keymap 'ESC-prefix))
 149     (define-key map "\e" 'hexl-ESC-prefix)
 150     (define-key map "\e\C-a" 'hexl-beginning-of-512b-page)
 151     (define-key map "\e\C-b" 'hexl-backward-short)
 152     (define-key map "\e\C-d" 'hexl-insert-decimal-char)
 153     (define-key map "\e\C-e" 'hexl-end-of-512b-page)
 154     (define-key map "\e\C-f" 'hexl-forward-short)
 155     (define-key map "\e\C-i" 'undefined)
 156     (define-key map "\e\C-j" 'undefined)
 157     (define-key map "\e\C-k" 'undefined)
 158     (define-key map "\e\C-o" 'hexl-insert-octal-char)
 159     (define-key map "\e\C-q" 'undefined)
 160     (define-key map "\e\C-t" 'undefined)
 161     (define-key map "\e\C-x" 'hexl-insert-hex-char)
 162     (define-key map "\eb" 'hexl-backward-word)
 163     (define-key map "\ec" 'undefined)
 164     (define-key map "\ed" 'undefined)
 165     (define-key map "\ef" 'hexl-forward-word)
 166     (define-key map "\eg" 'hexl-goto-hex-address)
 167     (define-key map "\ei" 'undefined)
 168     (define-key map "\ej" 'hexl-goto-address)
 169     (define-key map "\ek" 'undefined)
 170     (define-key map "\el" 'undefined)
 171     (define-key map "\eq" 'undefined)
 172     (define-key map "\es" 'undefined)
 173     (define-key map "\et" 'undefined)
 174     (define-key map "\eu" 'undefined)
 175     (define-key map "\ev" 'hexl-scroll-down)
 176     (define-key map "\ey" 'undefined)
 177     (define-key map "\ez" 'undefined)
 178     (define-key map "\e<" 'hexl-beginning-of-buffer)
 179     (define-key map "\e>" 'hexl-end-of-buffer)
 180
 181     (fset 'hexl-C-c-prefix (copy-keymap mode-specific-map))
 182     (define-key map "\C-c" 'hexl-C-c-prefix)
 183     (define-key map "\C-c\C-c" 'hexl-mode-exit)
 184
 185     (fset 'hexl-C-x-prefix (copy-keymap 'Control-X-prefix))
 186     (define-key map "\C-x" 'hexl-C-x-prefix)
 187     (define-key map "\C-x[" 'hexl-beginning-of-1k-page)
 188     (define-key map "\C-x]" 'hexl-end-of-1k-page)
 189     (define-key map "\C-x\C-p" 'undefined)
 190     (define-key map "\C-x\C-s" 'hexl-save-buffer)
 191     (define-key map "\C-x\C-t" 'undefined)
 192     map))
 193
 194 ;; Variable declarations for suppressing warnings from the byte-compiler.
 195 (defvar ruler-mode)
 196 (defvar ruler-mode-ruler-function)
 197 (defvar hl-line-mode)
 198 (defvar hl-line-range-function)
 199 (defvar hl-line-face)
 200
 201 ;; Variables where the original values are stored to.
 202 (defvar hexl-mode-old-hl-line-mode)
 203 (defvar hexl-mode-old-hl-line-range-function)
 204 (defvar hexl-mode-old-hl-line-face)
 205 (defvar hexl-mode-old-local-map)
 206 (defvar hexl-mode-old-mode-name)
 207 (defvar hexl-mode-old-major-mode)
 208 (defvar hexl-mode-old-ruler-mode)
 209 (defvar hexl-mode-old-ruler-function)
 210 (defvar hexl-mode-old-isearch-search-fun-function)
 211 (defvar hexl-mode-old-require-final-newline)
 212 (defvar hexl-mode-old-syntax-table)
 213 (defvar hexl-mode-old-font-lock-keywords)
 214 (defvar hexl-mode-old-eldoc-documentation-function)
 215 (defvar hexl-mode-old-revert-buffer-function)
 216
 217 (defvar hexl-ascii-overlay nil
 218   "Overlay used to highlight ASCII element corresponding to current point.")
 219 (make-variable-buffer-local 'hexl-ascii-overlay)
 220
 221 (defvar hexl-font-lock-keywords
 222   '(("^\\([0-9a-f]+:\\).\\{40\\}  \\(.+$\\)"
 223      ;; "^\\([0-9a-f]+:\\).+  \\(.+$\\)"
 224      (1 'hexl-address-region t t)
 225      (2 'hexl-ascii-region t t)))
 226   "Font lock keywords used in `hexl-mode'.")
 227
 228 ;; routines
 229
 230 (put 'hexl-mode 'mode-class 'special)
 231
 232 ;;;###autoload
 233 (defun hexl-mode (&optional arg)
 234   "\\<hexl-mode-map>A mode for editing binary files in hex dump format.
 235 This is not an ordinary major mode; it alters some aspects
 236 of the current mode's behavior, but not all; also, you can exit
 237 Hexl mode and return to the previous mode using `hexl-mode-exit'.
 238
 239 This function automatically converts a buffer into the hexl format
 240 using the function `hexlify-buffer'.
 241
 242 Each line in the buffer has an \"address\" (displayed in hexadecimal)
 243 representing the offset into the file that the characters on this line
 244 are at and 16 characters from the file (displayed as hexadecimal
 245 values grouped every 16 bits) and as their ASCII values.
 246
 247 If any of the characters (displayed as ASCII characters) are
 248 unprintable (control or meta characters) they will be replaced as
 249 periods.
 250
 251 If `hexl-mode' is invoked with an argument the buffer is assumed to be
 252 in hexl format.
 253
 254 A sample format:
 255
 256   HEX ADDR: 0001 0203 0405 0607 0809 0a0b 0c0d 0e0f     ASCII-TEXT
 257   --------  ---- ---- ---- ---- ---- ---- ---- ----  ----------------
 258   00000000: 5468 6973 2069 7320 6865 786c 2d6d 6f64  This is hexl-mod
 259   00000010: 652e 2020 4561 6368 206c 696e 6520 7265  e.  Each line re
 260   00000020: 7072 6573 656e 7473 2031 3620 6279 7465  presents 16 byte
 261   00000030: 7320 6173 2068 6578 6164 6563 696d 616c  s as hexadecimal
 262   00000040: 2041 5343 4949 0a61 6e64 2070 7269 6e74   ASCII.and print
 263   00000050: 6162 6c65 2041 5343 4949 2063 6861 7261  able ASCII chara
 264   00000060: 6374 6572 732e 2020 416e 7920 636f 6e74  cters.  Any cont
 265   00000070: 726f 6c20 6f72 206e 6f6e 2d41 5343 4949  rol or non-ASCII
 266   00000080: 2063 6861 7261 6374 6572 730a 6172 6520   characters.are
 267   00000090: 6469 7370 6c61 7965 6420 6173 2070 6572  displayed as per
 268   000000a0: 696f 6473 2069 6e20 7468 6520 7072 696e  iods in the prin
 269   000000b0: 7461 626c 6520 6368 6172 6163 7465 7220  table character
 270   000000c0: 7265 6769 6f6e 2e0a                      region..
 271
 272 Movement is as simple as movement in a normal Emacs text buffer.  Most
 273 cursor movement bindings are the same (ie. Use \\[hexl-backward-char], \\[hexl-forward-char], \\[hexl-next-line], and \\[hexl-previous-line]
 274 to move the cursor left, right, down, and up).
 275
 276 Advanced cursor movement commands (ala \\[hexl-beginning-of-line], \\[hexl-end-of-line], \\[hexl-beginning-of-buffer], and \\[hexl-end-of-buffer]) are
 277 also supported.
 278
 279 There are several ways to change text in hexl mode:
 280
 281 ASCII characters (character between space (0x20) and tilde (0x7E)) are
 282 bound to self-insert so you can simply type the character and it will
 283 insert itself (actually overstrike) into the buffer.
 284
 285 \\[hexl-quoted-insert] followed by another keystroke allows you to insert the key even if
 286 it isn't bound to self-insert.  An octal number can be supplied in place
 287 of another key to insert the octal number's ASCII representation.
 288
 289 \\[hexl-insert-hex-char] will insert a given hexadecimal value (if it is between 0 and 0xFF)
 290 into the buffer at the current point.
 291
 292 \\[hexl-insert-octal-char] will insert a given octal value (if it is between 0 and 0377)
 293 into the buffer at the current point.
 294
 295 \\[hexl-insert-decimal-char] will insert a given decimal value (if it is between 0 and 255)
 296 into the buffer at the current point.
 297
 298 \\[hexl-mode-exit] will exit hexl-mode.
 299
 300 Note: saving the file with any of the usual Emacs commands
 301 will actually convert it back to binary format while saving.
 302
 303 You can use \\[hexl-find-file] to visit a file in Hexl mode.
 304
 305 \\[describe-bindings] for advanced commands."
 306   (interactive "p")
 307   (unless (eq major-mode 'hexl-mode)
 308     (let ((modified (buffer-modified-p))
 309           (inhibit-read-only t)
 310           (original-point (- (point) (point-min))))
 311       (and (eobp) (not (bobp))
 312            (setq original-point (1- original-point)))
 313       ;; If `hexl-mode' is invoked with an argument the buffer is assumed to
 314       ;; be in hexl format.
 315       (when (memq arg '(1 nil))
 316         ;; If the buffer's EOL type is -dos, we need to account for
 317         ;; extra CR characters added when hexlify-buffer writes the
 318         ;; buffer to a file.
 319         ;; FIXME: This doesn't take into account multibyte coding systems.
 320         (when (eq (coding-system-eol-type buffer-file-coding-system) 1)
 321           (setq original-point (+ (count-lines (point-min) (point))
 322                                   original-point))
 323           (or (bolp) (setq original-point (1- original-point))))
 324         (hexlify-buffer)
 325         (restore-buffer-modified-p modified))
 326       (set (make-local-variable 'hexl-max-address)
 327            (let* ((full-lines (/ (buffer-size) 68))
 328                   (last-line (% (buffer-size) 68))
 329                   (last-line-bytes (% last-line 52)))
 330              (+ last-line-bytes (* full-lines 16) -1)))
 331       (condition-case nil
 332           (hexl-goto-address original-point)
 333         (error nil)))
 334
 335     ;; We do not turn off the old major mode; instead we just
 336     ;; override most of it.  That way, we can restore it perfectly.
 337     (make-local-variable 'hexl-mode-old-local-map)
 338     (setq hexl-mode-old-local-map (current-local-map))
 339     (use-local-map hexl-mode-map)
 340
 341     (make-local-variable 'hexl-mode-old-mode-name)
 342     (setq hexl-mode-old-mode-name mode-name)
 343     (setq mode-name "Hexl")
 344
 345     (set (make-local-variable 'hexl-mode-old-isearch-search-fun-function)
 346          isearch-search-fun-function)
 347     (set (make-local-variable 'isearch-search-fun-function)
 348          'hexl-isearch-search-function)
 349
 350     (make-local-variable 'hexl-mode-old-major-mode)
 351     (setq hexl-mode-old-major-mode major-mode)
 352     (setq major-mode 'hexl-mode)
 353
 354     (make-local-variable 'hexl-mode-old-ruler-mode)
 355     (setq hexl-mode-old-ruler-mode
 356           (and (boundp 'ruler-mode) ruler-mode))
 357
 358     (make-local-variable 'hexl-mode-old-hl-line-mode)
 359     (setq hexl-mode-old-hl-line-mode
 360           (and (boundp 'hl-line-mode) hl-line-mode))
 361
 362     (make-local-variable 'hexl-mode-old-syntax-table)
 363     (setq hexl-mode-old-syntax-table (syntax-table))
 364     (set-syntax-table (standard-syntax-table))
 365
 366     (add-hook 'write-contents-functions 'hexl-save-buffer nil t)
 367
 368     (make-local-variable 'hexl-mode-old-require-final-newline)
 369     (setq hexl-mode-old-require-final-newline require-final-newline)
 370     (make-local-variable 'require-final-newline)
 371     (setq require-final-newline nil)
 372
 373     (make-local-variable 'hexl-mode-old-font-lock-keywords)
 374     (setq hexl-mode-old-font-lock-keywords font-lock-defaults)
 375     (setq font-lock-defaults '(hexl-font-lock-keywords t))
 376
 377     (make-local-variable 'hexl-mode-old-revert-buffer-function)
 378     (setq hexl-mode-old-revert-buffer-function revert-buffer-function)
 379     (setq revert-buffer-function 'hexl-revert-buffer-function)
 380     (add-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer nil t)
 381
 382     ;; Set a callback function for eldoc.
 383     (make-local-variable 'hexl-mode-old-eldoc-documentation-function)
 384     (setq hexl-mode-old-eldoc-documentation-function
 385           (bound-and-true-p eldoc-documentation-function))
 386
 387     (set (make-local-variable 'eldoc-documentation-function)
 388          'hexl-print-current-point-info)
 389     (eldoc-add-command-completions "hexl-")
 390     (eldoc-remove-command "hexl-save-buffer"
 391                           "hexl-current-address")
 392
 393     (if hexl-follow-ascii (hexl-follow-ascii 1)))
 394   (run-mode-hooks 'hexl-mode-hook))
 395
 396
 397 (defun hexl-isearch-search-function ()
 398   (if (and (not isearch-regexp) (not isearch-word))
 399       (lambda (string &optional bound noerror count)
 400         (funcall
 401          (if isearch-forward 're-search-forward 're-search-backward)
 402          (let ((textre
 403                 (if (> (length string) 80)
 404                     (regexp-quote string)
 405                   (mapconcat (lambda (c) (regexp-quote (string c))) string
 406                              "\\(?:\n\\(?:[:a-f0-9]+ \\)+ \\)?"))))
 407            (if (string-match "\\` ?\\([a-f0-9]+ \\)*[a-f0-9]+ ?\\'" string)
 408                (concat textre "\\|"
 409                        (mapconcat 'regexp-quote (split-string string " ")
 410                                   " \\(?: .+\n[a-f0-9]+: \\)?"))
 411              textre))
 412          bound noerror count))
 413     (let ((isearch-search-fun-function nil))
 414       (isearch-search-fun))))
 415
 416 (defvar hexl-in-save-buffer nil)
 417
 418 (defun hexl-save-buffer ()
 419   "Save a hexl format buffer as binary in visited file if modified."
 420   (interactive)
 421   (if hexl-in-save-buffer nil
 422     (restore-buffer-modified-p
 423      (if (buffer-modified-p)
 424          (let ((buf (generate-new-buffer " hexl"))
 425                (name (buffer-name))
 426                (start (point-min))
 427                (end (point-max))
 428                modified)
 429            (with-current-buffer buf
 430              (insert-buffer-substring name start end)
 431              (set-buffer name)
 432              (dehexlify-buffer)
 433              ;; Prevent infinite recursion.
 434              (let ((hexl-in-save-buffer t))
 435                (save-buffer))
 436              (setq modified (buffer-modified-p))
 437              (delete-region (point-min) (point-max))
 438              (insert-buffer-substring buf start end)
 439              (kill-buffer buf)
 440              modified))
 441        (message "(No changes need to be saved)")
 442        nil))
 443     ;; Return t to indicate we have saved t
 444     t))
 445
 446 ;;;###autoload
 447 (defun hexl-find-file (filename)
 448   "Edit file FILENAME as a binary file in hex dump format.
 449 Switch to a buffer visiting file FILENAME, creating one if none exists,
 450 and edit the file in `hexl-mode'."
 451   (interactive
 452    (list
 453     (let ((completion-ignored-extensions nil))
 454       (read-file-name "Filename: " nil nil 'ret-must-match))))
 455   ;; Ignore the user's setting of default major-mode.
 456   (letf (((default-value 'major-mode) 'fundamental-mode))
 457     (find-file-literally filename))
 458   (if (not (eq major-mode 'hexl-mode))
 459       (hexl-mode)))
 460
 461 (defun hexl-revert-buffer-function (ignore-auto noconfirm)
 462   (let ((coding-system-for-read 'no-conversion)
 463         revert-buffer-function)
 464     ;; Call the original `revert-buffer' without code conversion; also
 465     ;; prevent it from changing the major mode to normal-mode, which
 466     ;; calls `set-auto-mode'.
 467     (revert-buffer nil nil t)
 468     ;; A couple of hacks are necessary here:
 469     ;; 1. change the major-mode to one other than hexl-mode since the
 470     ;; function `hexl-mode' does nothing if the current major-mode is
 471     ;; already hexl-mode.
 472     ;; 2. reset change-major-mode-hook in case that `hexl-mode'
 473     ;; previously added hexl-maybe-dehexlify-buffer to it.
 474     (remove-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer t)
 475     (setq major-mode 'fundamental-mode)
 476     (hexl-mode)))
 477
 478 (defun hexl-mode-exit (&optional arg)
 479   "Exit Hexl mode, returning to previous mode.
 480 With arg, don't unhexlify buffer."
 481   (interactive "p")
 482   (if (or (eq arg 1) (not arg))
 483       (let ((modified (buffer-modified-p))
 484             (inhibit-read-only t)
 485             (original-point (1+ (hexl-current-address))))
 486         (dehexlify-buffer)
 487         (remove-hook 'write-contents-functions 'hexl-save-buffer t)
 488         (restore-buffer-modified-p modified)
 489         (goto-char original-point)
 490         ;; Maybe adjust point for the removed CR characters.
 491         (when (eq (coding-system-eol-type buffer-file-coding-system) 1)
 492           (setq original-point (- original-point
 493                                   (count-lines (point-min) (point))))
 494           (or (bobp) (setq original-point (1+ original-point))))
 495         (goto-char original-point)))
 496
 497   (remove-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer t)
 498   (remove-hook 'post-command-hook 'hexl-follow-ascii-find t)
 499   (setq hexl-ascii-overlay nil)
 500
 501   (if (and (boundp 'ruler-mode) ruler-mode (not hexl-mode-old-ruler-mode))
 502       (ruler-mode 0))
 503   (when (boundp 'hexl-mode-old-ruler-function)
 504     (setq ruler-mode-ruler-function hexl-mode-old-ruler-function))
 505
 506   (if (and (boundp 'hl-line-mode) hl-line-mode (not hexl-mode-old-hl-line-mode))
 507       (hl-line-mode 0))
 508   (when (boundp 'hexl-mode-old-hl-line-range-function)
 509     (setq hl-line-range-function hexl-mode-old-hl-line-range-function))
 510   (when (boundp 'hexl-mode-old-hl-line-face)
 511     (setq hl-line-face hexl-mode-old-hl-line-face))
 512
 513   (when (boundp 'hexl-mode-old-eldoc-documentation-function)
 514     (setq eldoc-documentation-function
 515           hexl-mode-old-eldoc-documentation-function))
 516
 517   (setq require-final-newline hexl-mode-old-require-final-newline)
 518   (setq mode-name hexl-mode-old-mode-name)
 519   (setq isearch-search-fun-function hexl-mode-old-isearch-search-fun-function)
 520   (use-local-map hexl-mode-old-local-map)
 521   (set-syntax-table hexl-mode-old-syntax-table)
 522   (setq font-lock-defaults hexl-mode-old-font-lock-keywords)
 523   (setq major-mode hexl-mode-old-major-mode)
 524   (setq revert-buffer-function hexl-mode-old-revert-buffer-function)
 525   (force-mode-line-update))
 526
 527 (defun hexl-maybe-dehexlify-buffer ()
 528   "Convert a hexl format buffer to binary.
 529 Ask the user for confirmation."
 530   (if (y-or-n-p "Convert contents back to binary format? ")
 531       (let ((modified (buffer-modified-p))
 532             (inhibit-read-only t)
 533             (original-point (1+ (hexl-current-address))))
 534         (dehexlify-buffer)
 535         (remove-hook 'write-contents-functions 'hexl-save-buffer t)
 536         (restore-buffer-modified-p modified)
 537         (goto-char original-point))))
 538
 539 (defun hexl-current-address (&optional validate)
 540   "Return current hexl-address."
 541   (interactive)
 542   (let ((current-column (- (% (- (point) (point-min) -1) 68) 11))
 543         (hexl-address 0))
 544     (if (< current-column 0)
 545         (if validate
 546             (error "Point is not on a character in the file")
 547           (setq current-column 0)))
 548     (setq hexl-address
 549           (+ (* (/ (- (point) (point-min) -1) 68) 16)
 550              (if (>= current-column 41)
 551                  (- current-column 41)
 552                (/ (- current-column  (/ current-column 5)) 2))))
 553     (when (called-interactively-p 'interactive)
 554       (message "Current address is %d/0x%08x" hexl-address hexl-address))
 555     hexl-address))
 556
 557 (defun hexl-print-current-point-info ()
 558   "Return current hexl-address in string.
 559 This function is intended to be used as eldoc callback."
 560   (let ((addr (hexl-current-address)))
 561     (format "Current address is %d/0x%08x" addr addr)))
 562
 563 (defun hexl-address-to-marker (address)
 564   "Return buffer position for ADDRESS."
 565   (interactive "nAddress: ")
 566   (+ (* (/ address 16) 68) 10 (point-min) (/ (* (% address 16) 5) 2)))
 567
 568 (defun hexl-goto-address (address)
 569   "Go to hexl-mode (decimal) address ADDRESS.
 570 Signal error if ADDRESS is out of range."
 571   (interactive "nAddress: ")
 572   (if (or (< address 0) (> address hexl-max-address))
 573       (error "Out of hexl region"))
 574   (goto-char (hexl-address-to-marker address)))
 575
 576 (defun hexl-goto-hex-address (hex-address)
 577   "Go to hexl-mode address (hex string) HEX-ADDRESS.
 578 Signal error if HEX-ADDRESS is out of range."
 579   (interactive "sHex Address: ")
 580   (hexl-goto-address (hexl-hex-string-to-integer hex-address)))
 581
 582 (defun hexl-hex-string-to-integer (hex-string)
 583   "Return decimal integer for HEX-STRING."
 584   (interactive "sHex number: ")
 585   (let ((hex-num 0))
 586     (while (not (equal hex-string ""))
 587       (setq hex-num (+ (* hex-num 16)
 588                        (hexl-hex-char-to-integer (string-to-char hex-string))))
 589       (setq hex-string (substring hex-string 1)))
 590     hex-num))
 591
 592 (defun hexl-octal-string-to-integer (octal-string)
 593   "Return decimal integer for OCTAL-STRING."
 594   (interactive "sOctal number: ")
 595   (let ((oct-num 0))
 596     (while (not (equal octal-string ""))
 597       (setq oct-num (+ (* oct-num 8)
 598                        (hexl-oct-char-to-integer
 599                         (string-to-char octal-string))))
 600       (setq octal-string (substring octal-string 1)))
 601     oct-num))
 602
 603 ;; move point functions
 604
 605 (defun hexl-backward-char (arg)
 606   "Move to left ARG bytes (right if ARG negative) in hexl-mode."
 607   (interactive "p")
 608   (hexl-goto-address (- (hexl-current-address) arg)))
 609
 610 (defun hexl-forward-char (arg)
 611   "Move to right ARG bytes (left if ARG negative) in hexl-mode."
 612   (interactive "p")
 613   (hexl-goto-address (+ (hexl-current-address) arg)))
 614
 615 (defun hexl-backward-short (arg)
 616   "Move to left ARG shorts (right if ARG negative) in hexl-mode."
 617   (interactive "p")
 618   (hexl-goto-address (let ((address (hexl-current-address)))
 619                        (if (< arg 0)
 620                            (progn
 621                              (setq arg (- arg))
 622                              (while (> arg 0)
 623                                (if (not (equal address (logior address 3)))
 624                                    (if (> address hexl-max-address)
 625                                        (progn
 626                                          (message "End of buffer.")
 627                                          (setq address hexl-max-address))
 628                                      (setq address (logior address 3)))
 629                                  (if (> address hexl-max-address)
 630                                      (progn
 631                                        (message "End of buffer.")
 632                                        (setq address hexl-max-address))
 633                                    (setq address (+ address 4))))
 634                                (setq arg (1- arg)))
 635                              (if (> address hexl-max-address)
 636                                  (progn
 637                                    (message "End of buffer.")
 638                                    (setq address hexl-max-address))
 639                                (setq address (logior address 3))))
 640                          (while (> arg 0)
 641                            (if (not (equal address (logand address -4)))
 642                                (setq address (logand address -4))
 643                              (if (not (equal address 0))
 644                                  (setq address (- address 4))
 645                                (message "Beginning of buffer.")))
 646                            (setq arg (1- arg))))
 647                        address)))
 648
 649 (defun hexl-forward-short (arg)
 650   "Move to right ARG shorts (left if ARG negative) in hexl-mode."
 651   (interactive "p")
 652   (hexl-backward-short (- arg)))
 653
 654 (defun hexl-backward-word (arg)
 655   "Move to left ARG words (right if ARG negative) in hexl-mode."
 656   (interactive "p")
 657   (hexl-goto-address (let ((address (hexl-current-address)))
 658                        (if (< arg 0)
 659                            (progn
 660                              (setq arg (- arg))
 661                              (while (> arg 0)
 662                                (if (not (equal address (logior address 7)))
 663                                    (if (> address hexl-max-address)
 664                                        (progn
 665                                          (message "End of buffer.")
 666                                          (setq address hexl-max-address))
 667                                      (setq address (logior address 7)))
 668                                  (if (> address hexl-max-address)
 669                                      (progn
 670                                        (message "End of buffer.")
 671                                        (setq address hexl-max-address))
 672                                    (setq address (+ address 8))))
 673                                (setq arg (1- arg)))
 674                              (if (> address hexl-max-address)
 675                                  (progn
 676                                    (message "End of buffer.")
 677                                    (setq address hexl-max-address))
 678                                (setq address (logior address 7))))
 679                          (while (> arg 0)
 680                            (if (not (equal address (logand address -8)))
 681                                (setq address (logand address -8))
 682                              (if (not (equal address 0))
 683                                  (setq address (- address 8))
 684                                (message "Beginning of buffer.")))
 685                            (setq arg (1- arg))))
 686                        address)))
 687
 688 (defun hexl-forward-word (arg)
 689   "Move to right ARG words (left if ARG negative) in hexl-mode."
 690   (interactive "p")
 691   (hexl-backward-word (- arg)))
 692
 693 (defun hexl-previous-line (arg)
 694   "Move vertically up ARG lines [16 bytes] (down if ARG negative) in hexl-mode.
 695 If there is no byte at the target address move to the last byte in that line."
 696   (interactive "p")
 697   (hexl-next-line (- arg)))
 698
 699 (defun hexl-next-line (arg)
 700   "Move vertically down ARG lines [16 bytes] (up if ARG negative) in hexl-mode.
 701 If there is no byte at the target address move to the last byte in that line."
 702   (interactive "p")
 703   (hexl-goto-address (let ((address (+ (hexl-current-address) (* arg 16))))
 704                        (if (and (< arg 0) (< address 0))
 705                                 (progn (message "Out of hexl region.")
 706                                        (setq address
 707                                              (% (hexl-current-address) 16)))
 708                          (if (and (> address hexl-max-address)
 709                                   (< (% hexl-max-address 16) (% address 16)))
 710                              (setq address hexl-max-address)
 711                            (if (> address hexl-max-address)
 712                                (progn (message "Out of hexl region.")
 713                                       (setq
 714                                        address
 715                                        (+ (logand hexl-max-address -16)
 716                                           (% (hexl-current-address) 16)))))))
 717                        address)))
 718
 719 (defun hexl-beginning-of-buffer (arg)
 720   "Move to the beginning of the hexl buffer.
 721 Leaves `hexl-mark' at previous position.
 722 With prefix arg N, puts point N bytes of the way from the true beginning."
 723   (interactive "p")
 724   (push-mark (point))
 725   (hexl-goto-address (+ 0 (1- arg))))
 726
 727 (defun hexl-end-of-buffer (arg)
 728   "Go to `hexl-max-address' minus ARG."
 729   (interactive "p")
 730   (push-mark (point))
 731   (hexl-goto-address (- hexl-max-address (1- arg))))
 732
 733 (defun hexl-beginning-of-line ()
 734   "Goto beginning of line in hexl mode."
 735   (interactive)
 736   (goto-char (+ (* (/ (point) 68) 68) 11)))
 737
 738 (defun hexl-end-of-line ()
 739   "Goto end of line in hexl mode."
 740   (interactive)
 741   (hexl-goto-address (let ((address (logior (hexl-current-address) 15)))
 742                        (if (> address hexl-max-address)
 743                            (setq address hexl-max-address))
 744                        address)))
 745
 746 (defun hexl-scroll-down (arg)
 747   "Scroll hexl buffer window upward ARG lines; or near full window if no ARG."
 748   (interactive "P")
 749   (if (null arg)
 750       (setq arg (1- (window-height)))
 751     (setq arg (prefix-numeric-value arg)))
 752   (hexl-scroll-up (- arg)))
 753
 754 (defun hexl-scroll-up (arg)
 755   "Scroll hexl buffer window upward ARG lines; or near full window if no ARG.
 756 If there's no byte at the target address, move to the first or last line."
 757   (interactive "P")
 758   (if (null arg)
 759       (setq arg (1- (window-height)))
 760     (setq arg (prefix-numeric-value arg)))
 761   (let* ((movement (* arg 16))
 762          (address (hexl-current-address))
 763          (dest (+ address movement)))
 764     (cond
 765      ;; If possible, try to stay at the same offset from the beginning
 766      ;; of the 16-byte group, even if we move to the first or last
 767      ;; group.
 768      ((and (> dest hexl-max-address)
 769            (>= (% hexl-max-address 16) (% address 16)))
 770       (setq dest (+ (logand hexl-max-address -16) (% address 16))))
 771      ((> dest hexl-max-address)
 772       (setq dest hexl-max-address))
 773      ((< dest 0)
 774       (setq dest (% address 16))))
 775     (if (/= dest (+ address movement))
 776         (message "Out of hexl region."))
 777     (hexl-goto-address dest)
 778     (recenter 0)))
 779
 780 (defun hexl-beginning-of-1k-page ()
 781   "Go to beginning of 1KB boundary."
 782   (interactive)
 783   (hexl-goto-address (logand (hexl-current-address) -1024)))
 784
 785 (defun hexl-end-of-1k-page ()
 786   "Go to end of 1KB boundary."
 787   (interactive)
 788   (hexl-goto-address (let ((address (logior (hexl-current-address) 1023)))
 789                        (if (> address hexl-max-address)
 790                            (setq address hexl-max-address))
 791                        address)))
 792
 793 (defun hexl-beginning-of-512b-page ()
 794   "Go to beginning of 512 byte boundary."
 795   (interactive)
 796   (hexl-goto-address (logand (hexl-current-address) -512)))
 797
 798 (defun hexl-end-of-512b-page ()
 799   "Go to end of 512 byte boundary."
 800   (interactive)
 801   (hexl-goto-address (let ((address (logior (hexl-current-address) 511)))
 802                        (if (> address hexl-max-address)
 803                            (setq address hexl-max-address))
 804                        address)))
 805
 806 (defun hexl-quoted-insert (arg)
 807   "Read next input character and insert it.
 808 Useful for inserting control characters and non-ASCII characters given their
 809 numerical code.
 810 You may also type octal digits, to insert a character with that code."
 811   (interactive "p")
 812   (hexl-insert-multibyte-char (read-quoted-char) arg))
 813
 814 ;00000000: 0011 2233 4455 6677 8899 aabb ccdd eeff  0123456789ABCDEF
 815
 816 ;;;###autoload
 817 (defun hexlify-buffer ()
 818   "Convert a binary buffer to hexl format.
 819 This discards the buffer's undo information."
 820   (interactive)
 821   (and (consp buffer-undo-list)
 822        (or (y-or-n-p "Converting to hexl format discards undo info; ok? ")
 823            (error "Aborted"))
 824        (setq buffer-undo-list nil))
 825   ;; Don't decode text in the ASCII part of `hexl' program output.
 826   (let ((coding-system-for-read 'raw-text)
 827         (coding-system-for-write buffer-file-coding-system)
 828         (buffer-undo-list t))
 829     (apply 'call-process-region (point-min) (point-max)
 830            (expand-file-name hexl-program exec-directory)
 831            t t nil
 832            ;; Manually encode the args, otherwise they're encoded using
 833            ;; coding-system-for-write (i.e. buffer-file-coding-system) which
 834            ;; may not be what we want (e.g. utf-16 on a non-utf-16 system).
 835            (mapcar (lambda (s)
 836                      (if (not (multibyte-string-p s)) s
 837                        (encode-coding-string s locale-coding-system)))
 838                    (split-string hexl-options)))
 839     (if (> (point) (hexl-address-to-marker hexl-max-address))
 840         (hexl-goto-address hexl-max-address))))
 841
 842 (defun dehexlify-buffer ()
 843   "Convert a hexl format buffer to binary.
 844 This discards the buffer's undo information."
 845   (interactive)
 846   (and (consp buffer-undo-list)
 847        (or (y-or-n-p "Converting from hexl format discards undo info; ok? ")
 848            (error "Aborted"))
 849        (setq buffer-undo-list nil))
 850   (let ((coding-system-for-write 'raw-text)
 851         (coding-system-for-read buffer-file-coding-system)
 852         (buffer-undo-list t))
 853     (apply 'call-process-region (point-min) (point-max)
 854            (expand-file-name hexl-program exec-directory)
 855            t t nil "-de" (split-string hexl-options))))
 856
 857 (defun hexl-char-after-point ()
 858   "Return char for ASCII hex digits at point."
 859   (hexl-htoi (char-after (point))
 860              (char-after (1+ (point)))))
 861
 862 (defun hexl-htoi (lh rh)
 863   "Hex (char) LH (char) RH to integer."
 864     (+ (* (hexl-hex-char-to-integer lh) 16)
 865        (hexl-hex-char-to-integer rh)))
 866
 867 (defun hexl-hex-char-to-integer (character)
 868   "Take a char and return its value as if it was a hex digit."
 869   (if (and (>= character ?0) (<= character ?9))
 870       (- character ?0)
 871     (let ((ch (logior character 32)))
 872       (if (and (>= ch ?a) (<= ch ?f))
 873           (- ch (- ?a 10))
 874         (error "Invalid hex digit `%c'" ch)))))
 875
 876 (defun hexl-oct-char-to-integer (character)
 877   "Take a char and return its value as if it was a octal digit."
 878   (if (and (>= character ?0) (<= character ?7))
 879       (- character ?0)
 880     (error "Invalid octal digit `%c'" character)))
 881
 882 (defun hexl-printable-character (ch)
 883   "Return a displayable string for character CH."
 884   (format "%c" (if (equal hexl-iso "")
 885                    (if (or (< ch 32) (>= ch 127))
 886                        46
 887                      ch)
 888                  (if (or (< ch 32) (and (>= ch 127) (< ch 160)))
 889                      46
 890                    ch))))
 891
 892 (defun hexl-insert-multibyte-char (ch num)
 893   "Insert a possibly multibyte character CH NUM times.
 894
 895 Non-ASCII characters are first encoded with `buffer-file-coding-system',
 896 and their encoded form is inserted byte by byte."
 897   (let ((charset (char-charset ch))
 898         (coding (if (or (null buffer-file-coding-system)
 899                         ;; coding-system-type equals t means undecided.
 900                         (eq (coding-system-type buffer-file-coding-system) t))
 901                     (default-value 'buffer-file-coding-system)
 902                   buffer-file-coding-system)))
 903     (cond ((and (> ch 0) (< ch 256))
 904            (hexl-insert-char ch num))
 905           ((eq charset 'unknown)
 906            (error
 907             "0x%x -- invalid character code; use \\[hexl-insert-hex-string]"
 908             ch))
 909           (t
 910            (let ((encoded (encode-coding-char ch coding))
 911                  (internal (string-as-unibyte (char-to-string ch)))
 912                  internal-hex)
 913              ;; If encode-coding-char returns nil, it means our character
 914              ;; cannot be safely encoded with buffer-file-coding-system.
 915              ;; In that case, we offer to insert the internal representation
 916              ;; of that character, byte by byte.
 917              (when (null encoded)
 918                (setq internal-hex
 919                      (mapconcat (function (lambda (c) (format "%x" c)))
 920                                 internal " "))
 921                (if (yes-or-no-p
 922                     (format
 923                      "Insert char 0x%x's internal representation \"%s\"? "
 924                      ch internal-hex))
 925                    (setq encoded internal)
 926                  (error
 927                   "Can't encode `0x%x' with this buffer's coding system; try \\[hexl-insert-hex-string]"
 928                   ch)))
 929              (while (> num 0)
 930                (mapc
 931                 (function (lambda (c) (hexl-insert-char c 1))) encoded)
 932                (setq num (1- num))))))))
 933
 934 (defun hexl-self-insert-command (arg)
 935   "Insert this character.
 936 Interactively, with a numeric argument, insert this character that many times.
 937
 938 Non-ASCII characters are first encoded with `buffer-file-coding-system',
 939 and their encoded form is inserted byte by byte."
 940   (interactive "p")
 941   (hexl-insert-multibyte-char last-command-event arg))
 942
 943 (defun hexl-insert-char (ch num)
 944   "Insert the character CH NUM times in a hexl buffer.
 945
 946 CH must be a unibyte character whose value is between 0 and 255."
 947   (if (or (< ch 0) (> ch 255))
 948       (error "Invalid character 0x%x -- must be in the range [0..255]" ch))
 949   (let ((address (hexl-current-address t)))
 950     (while (> num 0)
 951       (let ((hex-position
 952              (+ (* (/ address 16) 68)
 953                 10 (point-min)
 954                 (* 2 (% address 16))
 955                 (/ (% address 16) 2)))
 956             (ascii-position
 957              (+ (* (/ address 16) 68) 51 (point-min) (% address 16)))
 958             at-ascii-position)
 959         (if (= (point) ascii-position)
 960             (setq at-ascii-position t))
 961         (goto-char hex-position)
 962         (delete-char 2)
 963         (insert (format "%02x" ch))
 964         (goto-char ascii-position)
 965         (delete-char 1)
 966         (insert (hexl-printable-character ch))
 967         (or (eq address hexl-max-address)
 968             (setq address (1+ address)))
 969         (hexl-goto-address address)
 970         (if at-ascii-position
 971             (progn
 972               (beginning-of-line)
 973               (forward-char 51)
 974               (forward-char (% address 16)))))
 975       (setq num (1- num)))))
 976
 977 ;; hex conversion
 978
 979 (defun hexl-insert-hex-char (arg)
 980   "Insert a character given by its hexadecimal code ARG times at point."
 981   (interactive "p")
 982   (let ((num (hexl-hex-string-to-integer (read-string "Hex number: "))))
 983     (if (< num 0)
 984         (error "Hex number out of range")
 985       (hexl-insert-multibyte-char num arg))))
 986
 987 (defun hexl-insert-hex-string (str arg)
 988   "Insert hexadecimal string STR at point ARG times.
 989 Embedded whitespace, dashes, and periods in the string are ignored."
 990   (interactive "sHex string: \np")
 991   (setq str (replace-regexp-in-string "[- \t.]" "" str))
 992   (let ((chars '()))
 993     (let ((len (length str))
 994           (idx 0))
 995       (if (eq (logand len 1) 1)
 996           (let ((num (hexl-hex-string-to-integer (substring str 0 1))))
 997             (setq chars (cons num chars))
 998             (setq idx 1)))
 999       (while (< idx len)
1000         (let* ((nidx (+ idx 2))
1001                (num (hexl-hex-string-to-integer (substring str idx nidx))))
1002           (setq chars (cons num chars))
1003           (setq idx nidx))))
1004     (setq chars (nreverse chars))
1005     (while (> arg 0)
1006       (let ((chars chars))
1007         (while chars
1008           (hexl-insert-char (car chars) 1)
1009           (setq chars (cdr chars))))
1010       (setq arg (- arg 1)))))
1011
1012 (defun hexl-insert-decimal-char (arg)
1013   "Insert a character given by its decimal code ARG times at point."
1014   (interactive "p")
1015   (let ((num (string-to-number (read-string "Decimal Number: "))))
1016     (if (< num 0)
1017         (error "Decimal number out of range")
1018       (hexl-insert-multibyte-char num arg))))
1019
1020 (defun hexl-insert-octal-char (arg)
1021   "Insert a character given by its octal code ARG times at point."
1022   (interactive "p")
1023   (let ((num (hexl-octal-string-to-integer (read-string "Octal Number: "))))
1024     (if (< num 0)
1025         (error "Decimal number out of range")
1026       (hexl-insert-multibyte-char num arg))))
1027
1028 (defun hexl-follow-ascii (&optional arg)
1029   "Toggle following ASCII in Hexl buffers.
1030 With prefix ARG, turn on following if and only if ARG is positive.
1031 When following is enabled, the ASCII character corresponding to the
1032 element under the point is highlighted.
1033 Customize the variable `hexl-follow-ascii' to disable this feature."
1034   (interactive "P")
1035   (let ((on-p (if arg
1036                   (> (prefix-numeric-value arg) 0)
1037                (not hexl-ascii-overlay))))
1038
1039     (if on-p
1040       ;; turn it on
1041       (if (not hexl-ascii-overlay)
1042           (progn
1043             (setq hexl-ascii-overlay (make-overlay 1 1)
1044                   hexl-follow-ascii t)
1045             (overlay-put hexl-ascii-overlay 'face 'highlight)
1046             (add-hook 'post-command-hook 'hexl-follow-ascii-find nil t)))
1047       ;; turn it off
1048       (if hexl-ascii-overlay
1049           (progn
1050             (delete-overlay hexl-ascii-overlay)
1051             (setq hexl-ascii-overlay nil
1052                   hexl-follow-ascii nil)
1053             (remove-hook 'post-command-hook 'hexl-follow-ascii-find t)
1054             )))))
1055
1056 (defun hexl-activate-ruler ()
1057   "Activate `ruler-mode'."
1058   (require 'ruler-mode)
1059   (unless (boundp 'hexl-mode-old-ruler-function)
1060     (set (make-local-variable 'hexl-mode-old-ruler-function)
1061          ruler-mode-ruler-function))
1062   (set (make-local-variable 'ruler-mode-ruler-function)
1063        'hexl-mode-ruler)
1064   (ruler-mode 1))
1065
1066 (defun hexl-follow-line ()
1067   "Activate `hl-line-mode'."
1068   (require 'hl-line)
1069   (unless (boundp 'hexl-mode-old-hl-line-range-function)
1070     (set (make-local-variable 'hexl-mode-old-hl-line-range-function)
1071          hl-line-range-function))
1072   (unless (boundp 'hexl-mode-old-hl-line-face)
1073     (set (make-local-variable 'hexl-mode-old-hl-line-face)
1074          hl-line-face))
1075   (set (make-local-variable 'hl-line-range-function)
1076        'hexl-highlight-line-range)
1077   (set (make-local-variable 'hl-line-face)
1078        'highlight)
1079   (hl-line-mode 1))
1080
1081 (defun hexl-highlight-line-range ()
1082   "Return the range of address region for the point.
1083 This function is assumed to be used as callback function for `hl-line-mode'."
1084   (cons
1085    (line-beginning-position)
1086    ;; 9 stands for (length "87654321:")
1087    (+ (line-beginning-position) 9)))
1088
1089 (defun hexl-follow-ascii-find ()
1090   "Find and highlight the ASCII element corresponding to current point."
1091   (let ((pos (+ 51
1092                 (- (point) (current-column))
1093                 (mod (hexl-current-address) 16))))
1094     (move-overlay hexl-ascii-overlay pos (1+ pos))
1095     ))
1096
1097 (defun hexl-mode-ruler ()
1098   "Return a string ruler for hexl mode."
1099   (let* ((highlight (mod (hexl-current-address) 16))
1100          (s " 87654321  0011 2233 4455 6677 8899 aabb ccdd eeff  0123456789abcdef")
1101          (pos 0))
1102     (set-text-properties 0 (length s) nil s)
1103     ;; Turn spaces in the header into stretch specs so they work
1104     ;; regardless of the header-line face.
1105     (while (string-match "[ \t]+" s pos)
1106       (setq pos (match-end 0))
1107       (put-text-property (match-beginning 0) pos 'display
1108                          ;; Assume fixed-size chars
1109                          `(space :align-to ,(1- pos))
1110                          s))
1111     ;; Highlight the current column.
1112     (put-text-property (+ 11 (/ (* 5 highlight) 2))
1113                        (+ 13 (/ (* 5 highlight) 2))
1114                        'face 'highlight s)
1115     ;; Highlight the current ascii column
1116     (put-text-property (+ 13 39 highlight) (+ 13 40 highlight)
1117                        'face 'highlight s)
1118     s))
1119
1120 ;; startup stuff.
1121
1122 (easy-menu-define hexl-menu hexl-mode-map "Hexl Mode menu"
1123   `("Hexl"
1124     :help "Hexl-specific Features"
1125
1126     ["Backward short" hexl-backward-short
1127      :help "Move to left a short"]
1128     ["Forward short" hexl-forward-short
1129      :help "Move to right a short"]
1130     ["Backward word" hexl-backward-short
1131      :help "Move to left a word"]
1132     ["Forward word" hexl-forward-short
1133      :help "Move to right a word"]
1134     "-"
1135     ["Beginning of 512b page" hexl-beginning-of-512b-page
1136      :help "Go to beginning of 512 byte boundary"]
1137     ["End of 512b page" hexl-end-of-512b-page
1138      :help "Go to end of 512 byte boundary"]
1139     ["Beginning of 1K page" hexl-beginning-of-1k-page
1140      :help "Go to beginning of 1KB boundary"]
1141     ["End of 1K page" hexl-end-of-1k-page
1142      :help "Go to end of 1KB boundary"]
1143     "-"
1144     ["Go to address" hexl-goto-address
1145      :help "Go to hexl-mode (decimal) address"]
1146     ["Go to address" hexl-goto-hex-address
1147      :help "Go to hexl-mode (hex string) address"]
1148     "-"
1149     ["Insert decimal char" hexl-insert-decimal-char
1150      :help "Insert a character given by its decimal code"]
1151     ["Insert hex char" hexl-insert-hex-char
1152      :help "Insert a character given by its hexadecimal code"]
1153     ["Insert octal char" hexl-insert-octal-char
1154      :help "Insert a character given by its octal code"]
1155     "-"
1156     ["Exit hexl mode" hexl-mode-exit
1157      :help "Exit hexl mode returning to previous mode"]))
1158
1159 (provide 'hexl)
1160
1161 ;; arch-tag: d5a7aa8a-9bce-480b-bcff-6c4c7ca5ea4a
1162 ;;; hexl.el ends here