hexl.el 40.7 KB
Newer Older
1
;;; hexl.el --- edit a file in a hex dump format using the hexl filter -*- lexical-binding: t -*-
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1989, 1994, 1998, 2001-2011 Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Author: Keith Gabryelski <ag@wheaties.ai.mit.edu>
Richard M. Stallman's avatar
Richard M. Stallman committed
6 7
;; Maintainer: FSF
;; Keywords: data
Eric S. Raymond's avatar
Eric S. Raymond committed
8

Joseph Arceneaux's avatar
Joseph Arceneaux committed
9 10
;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Joseph Arceneaux's avatar
Joseph Arceneaux committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
15 16 17 18 19 20 21

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
23

Eric S. Raymond's avatar
Eric S. Raymond committed
24 25
;;; Commentary:

26 27 28 29
;; This package implements a major mode for editing binary files.  It uses
;; a program called hexl, supplied with the GNU Emacs distribution, that
;; can filter a binary into an editable format or from the format back into
;; binary.  For full instructions, invoke `hexl-mode' on an empty buffer and
Pavel Janík's avatar
Pavel Janík committed
30
;; do M-x `describe-mode'.
31
;;
Pavel Janík's avatar
Pavel Janík committed
32
;; NOTE: Remember to change `hexl-program' or `hexl-options' if needed.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
33 34 35 36 37
;;
;; Currently hexl only supports big endian hex output with 16 bit
;; grouping.
;;
;; -iso in `hexl-options' will allow iso characters to display in the
38
;; ASCII region of the screen (if your Emacs supports this) instead of
Joseph Arceneaux's avatar
Joseph Arceneaux committed
39 40
;; changing them to dots.

Eric S. Raymond's avatar
Eric S. Raymond committed
41 42
;;; Code:

43
(require 'eldoc)
44
(eval-when-compile (require 'cl))
45

Joseph Arceneaux's avatar
Joseph Arceneaux committed
46 47 48 49
;;
;; vars here
;;

50 51 52 53 54 55
(defgroup hexl nil
  "Edit a file in a hex dump format using the hexl filter."
  :group 'data)


(defcustom hexl-program "hexl"
56
  "The program that will hexlify and dehexlify its stdin.
Richard M. Stallman's avatar
Richard M. Stallman committed
57
`hexl-program' will always be concatenated with `hexl-options'
58 59 60
and \"-de\" when dehexlifying a buffer."
  :type 'string
  :group 'hexl)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
61

62
(defcustom hexl-iso ""
63
  "If your Emacs can handle ISO characters, this should be set to
64 65 66
\"-iso\" otherwise it should be \"\"."
  :type 'string
  :group 'hexl)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
67

68
(defcustom hexl-options (format "-hex %s" hexl-iso)
69 70
  "Space separated options to `hexl-program' that suit your needs.
Quoting cannot be used, so the arguments cannot themselves contain spaces."
71 72
  :type 'string
  :group 'hexl)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
73

74 75 76
(defcustom hexl-follow-ascii t
  "If non-nil then highlight the ASCII character corresponding to point."
  :type 'boolean
Dan Nicolaescu's avatar
Dan Nicolaescu committed
77 78
  :group 'hexl
  :version "20.3")
79

80 81 82 83 84 85
(defcustom hexl-mode-hook '(hexl-follow-line hexl-activate-ruler)
  "Normal hook run when entering Hexl mode."
  :type 'hook
  :options '(hexl-follow-line hexl-activate-ruler turn-on-eldoc-mode)
  :group 'hexl)

Masatake YAMATO's avatar
Masatake YAMATO committed
86
(defface hexl-address-region
87
  '((t (:inherit header-line)))
88
  "Face used in address area of hexl-mode buffer."
89 90
  :group 'hexl)

Masatake YAMATO's avatar
Masatake YAMATO committed
91
(defface hexl-ascii-region
92
  '((t (:inherit header-line)))
93
  "Face used in ascii area of hexl-mode buffer."
94 95
  :group 'hexl)

Joseph Arceneaux's avatar
Joseph Arceneaux committed
96 97 98
(defvar hexl-max-address 0
  "Maximum offset into hexl buffer.")

99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
(defvar hexl-mode-map
  (let ((map (make-keymap)))
    ;; Make all self-inserting keys go through hexl-self-insert-command,
    ;; because we need to convert them to unibyte characters before
    ;; inserting them into the buffer.
    (define-key map [remap self-insert-command] 'hexl-self-insert-command)

    (define-key map "\C-m" 'hexl-self-insert-command)
    (define-key map [left] 'hexl-backward-char)
    (define-key map [right] 'hexl-forward-char)
    (define-key map [up] 'hexl-previous-line)
    (define-key map [down] 'hexl-next-line)
    (define-key map [M-left] 'hexl-backward-short)
    (define-key map [?\e left] 'hexl-backward-short)
    (define-key map [M-right] 'hexl-forward-short)
    (define-key map [?\e right] 'hexl-forward-short)
    (define-key map [next] 'hexl-scroll-up)
    (define-key map [prior] 'hexl-scroll-down)
    (define-key map [home] 'hexl-beginning-of-line)
    (define-key map [end] 'hexl-end-of-line)
    (define-key map [C-home] 'hexl-beginning-of-buffer)
    (define-key map [C-end] 'hexl-end-of-buffer)
    (define-key map [deletechar] 'undefined)
    (define-key map [deleteline] 'undefined)
    (define-key map [insertline] 'undefined)
    (define-key map [S-delete] 'undefined)
    (define-key map "\177" 'undefined)

    (define-key map "\C-a" 'hexl-beginning-of-line)
    (define-key map "\C-b" 'hexl-backward-char)
    (define-key map "\C-d" 'undefined)
    (define-key map "\C-e" 'hexl-end-of-line)
    (define-key map "\C-f" 'hexl-forward-char)

    (if (not (memq (key-binding (char-to-string help-char))
		   '(help-command ehelp-command)))
	(define-key map (char-to-string help-char) 'undefined))

    (define-key map "\C-k" 'undefined)
    (define-key map "\C-n" 'hexl-next-line)
    (define-key map "\C-o" 'undefined)
    (define-key map "\C-p" 'hexl-previous-line)
    (define-key map "\C-q" 'hexl-quoted-insert)
    (define-key map "\C-t" 'undefined)
    (define-key map "\C-v" 'hexl-scroll-up)
    (define-key map "\C-w" 'undefined)
    (define-key map "\C-y" 'undefined)

    (fset 'hexl-ESC-prefix (copy-keymap 'ESC-prefix))
    (define-key map "\e" 'hexl-ESC-prefix)
    (define-key map "\e\C-a" 'hexl-beginning-of-512b-page)
    (define-key map "\e\C-b" 'hexl-backward-short)
    (define-key map "\e\C-d" 'hexl-insert-decimal-char)
    (define-key map "\e\C-e" 'hexl-end-of-512b-page)
    (define-key map "\e\C-f" 'hexl-forward-short)
    (define-key map "\e\C-i" 'undefined)
    (define-key map "\e\C-j" 'undefined)
    (define-key map "\e\C-k" 'undefined)
    (define-key map "\e\C-o" 'hexl-insert-octal-char)
    (define-key map "\e\C-q" 'undefined)
    (define-key map "\e\C-t" 'undefined)
    (define-key map "\e\C-x" 'hexl-insert-hex-char)
    (define-key map "\eb" 'hexl-backward-word)
    (define-key map "\ec" 'undefined)
    (define-key map "\ed" 'undefined)
    (define-key map "\ef" 'hexl-forward-word)
    (define-key map "\eg" 'hexl-goto-hex-address)
    (define-key map "\ei" 'undefined)
    (define-key map "\ej" 'hexl-goto-address)
    (define-key map "\ek" 'undefined)
    (define-key map "\el" 'undefined)
    (define-key map "\eq" 'undefined)
    (define-key map "\es" 'undefined)
    (define-key map "\et" 'undefined)
    (define-key map "\eu" 'undefined)
    (define-key map "\ev" 'hexl-scroll-down)
    (define-key map "\ey" 'undefined)
    (define-key map "\ez" 'undefined)
    (define-key map "\e<" 'hexl-beginning-of-buffer)
    (define-key map "\e>" 'hexl-end-of-buffer)

    (fset 'hexl-C-c-prefix (copy-keymap mode-specific-map))
    (define-key map "\C-c" 'hexl-C-c-prefix)
    (define-key map "\C-c\C-c" 'hexl-mode-exit)

    (fset 'hexl-C-x-prefix (copy-keymap 'Control-X-prefix))
    (define-key map "\C-x" 'hexl-C-x-prefix)
    (define-key map "\C-x[" 'hexl-beginning-of-1k-page)
    (define-key map "\C-x]" 'hexl-end-of-1k-page)
    (define-key map "\C-x\C-p" 'undefined)
    (define-key map "\C-x\C-s" 'hexl-save-buffer)
    (define-key map "\C-x\C-t" 'undefined)
    map))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
192

193
;; Variable declarations for suppressing warnings from the byte-compiler.
194 195 196
(defvar ruler-mode)
(defvar ruler-mode-ruler-function)
(defvar hl-line-mode)
197 198
(defvar hl-line-range-function)
(defvar hl-line-face)
199

200
;; Variables where the original values are stored to.
201 202
(defvar hexl-mode--old-var-vals ())
(make-variable-buffer-local 'hexl-mode--old-var-vals)
203

204 205 206 207
(defvar hexl-ascii-overlay nil
  "Overlay used to highlight ASCII element corresponding to current point.")
(make-variable-buffer-local 'hexl-ascii-overlay)

208 209 210
(defvar hexl-font-lock-keywords
  '(("^\\([0-9a-f]+:\\).\\{40\\}  \\(.+$\\)"
     ;; "^\\([0-9a-f]+:\\).+  \\(.+$\\)"
Masatake YAMATO's avatar
Masatake YAMATO committed
211 212
     (1 'hexl-address-region t t)
     (2 'hexl-ascii-region t t)))
213 214
  "Font lock keywords used in `hexl-mode'.")

Joseph Arceneaux's avatar
Joseph Arceneaux committed
215 216
;; routines

217 218
(put 'hexl-mode 'mode-class 'special)

219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237

(defun hexl-mode--minor-mode-p (var)
  (memq var '(ruler-mode hl-line-mode)))

(defun hexl-mode--setq-local (var val)
  ;; `var' can be either a symbol or a pair, in which case the `car'
  ;; is the getter function and the `cdr' is the corresponding setter.
  (unless (or (member var hexl-mode--old-var-vals)
              (assoc var hexl-mode--old-var-vals))
    (push (if (or (consp var) (boundp var))
              (cons var
                    (if (consp var) (funcall (car var)) (symbol-value var)))
            var)
          hexl-mode--old-var-vals))
  (cond
   ((consp var) (funcall (cdr var) val))
   ((hexl-mode--minor-mode-p var) (funcall var (if val 1 -1)))
   (t (set (make-local-variable var) val))))

238
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
239
(defun hexl-mode (&optional arg)
240 241
  "\\<hexl-mode-map>A mode for editing binary files in hex dump format.
This is not an ordinary major mode; it alters some aspects
Juanma Barranquero's avatar
Juanma Barranquero committed
242
of the current mode's behavior, but not all; also, you can exit
243
Hexl mode and return to the previous mode using `hexl-mode-exit'.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
244 245 246 247

This function automatically converts a buffer into the hexl format
using the function `hexlify-buffer'.

248
Each line in the buffer has an \"address\" (displayed in hexadecimal)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
249 250 251 252 253 254 255 256
representing the offset into the file that the characters on this line
are at and 16 characters from the file (displayed as hexadecimal
values grouped every 16 bits) and as their ASCII values.

If any of the characters (displayed as ASCII characters) are
unprintable (control or meta characters) they will be replaced as
periods.

257 258
If `hexl-mode' is invoked with an argument the buffer is assumed to be
in hexl format.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
259 260 261 262 263 264 265 266 267 268 269 270 271

A sample format:

  HEX ADDR: 0001 0203 0405 0607 0809 0a0b 0c0d 0e0f     ASCII-TEXT
  --------  ---- ---- ---- ---- ---- ---- ---- ----  ----------------
  00000000: 5468 6973 2069 7320 6865 786c 2d6d 6f64  This is hexl-mod
  00000010: 652e 2020 4561 6368 206c 696e 6520 7265  e.  Each line re
  00000020: 7072 6573 656e 7473 2031 3620 6279 7465  presents 16 byte
  00000030: 7320 6173 2068 6578 6164 6563 696d 616c  s as hexadecimal
  00000040: 2041 5343 4949 0a61 6e64 2070 7269 6e74   ASCII.and print
  00000050: 6162 6c65 2041 5343 4949 2063 6861 7261  able ASCII chara
  00000060: 6374 6572 732e 2020 416e 7920 636f 6e74  cters.  Any cont
  00000070: 726f 6c20 6f72 206e 6f6e 2d41 5343 4949  rol or non-ASCII
272
  00000080: 2063 6861 7261 6374 6572 730a 6172 6520   characters.are
Joseph Arceneaux's avatar
Joseph Arceneaux committed
273 274
  00000090: 6469 7370 6c61 7965 6420 6173 2070 6572  displayed as per
  000000a0: 696f 6473 2069 6e20 7468 6520 7072 696e  iods in the prin
275
  000000b0: 7461 626c 6520 6368 6172 6163 7465 7220  table character
Joseph Arceneaux's avatar
Joseph Arceneaux committed
276 277
  000000c0: 7265 6769 6f6e 2e0a                      region..

278
Movement is as simple as movement in a normal Emacs text buffer.  Most
Joseph Arceneaux's avatar
Joseph Arceneaux committed
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
cursor movement bindings are the same (ie. Use \\[hexl-backward-char], \\[hexl-forward-char], \\[hexl-next-line], and \\[hexl-previous-line]
to move the cursor left, right, down, and up).

Advanced cursor movement commands (ala \\[hexl-beginning-of-line], \\[hexl-end-of-line], \\[hexl-beginning-of-buffer], and \\[hexl-end-of-buffer]) are
also supported.

There are several ways to change text in hexl mode:

ASCII characters (character between space (0x20) and tilde (0x7E)) are
bound to self-insert so you can simply type the character and it will
insert itself (actually overstrike) into the buffer.

\\[hexl-quoted-insert] followed by another keystroke allows you to insert the key even if
it isn't bound to self-insert.  An octal number can be supplied in place
of another key to insert the octal number's ASCII representation.

\\[hexl-insert-hex-char] will insert a given hexadecimal value (if it is between 0 and 0xFF)
into the buffer at the current point.

\\[hexl-insert-octal-char] will insert a given octal value (if it is between 0 and 0377)
into the buffer at the current point.

\\[hexl-insert-decimal-char] will insert a given decimal value (if it is between 0 and 255)
into the buffer at the current point.

\\[hexl-mode-exit] will exit hexl-mode.

306 307
Note: saving the file with any of the usual Emacs commands
will actually convert it back to binary format while saving.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
308

309
You can use \\[hexl-find-file] to visit a file in Hexl mode.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
310 311 312

\\[describe-bindings] for advanced commands."
  (interactive "p")
313
  (unless (eq major-mode 'hexl-mode)
314 315
    (let ((modified (buffer-modified-p))
	  (inhibit-read-only t)
316
	  (original-point (- (point) (point-min))))
317 318
      (and (eobp) (not (bobp))
	   (setq original-point (1- original-point)))
319 320 321
      ;; If `hexl-mode' is invoked with an argument the buffer is assumed to
      ;; be in hexl format.
      (when (memq arg '(1 nil))
322 323 324
	;; If the buffer's EOL type is -dos, we need to account for
	;; extra CR characters added when hexlify-buffer writes the
	;; buffer to a file.
325
        ;; FIXME: This doesn't take into account multibyte coding systems.
326
	(when (eq (coding-system-eol-type buffer-file-coding-system) 1)
327
          (setq original-point (+ (count-lines (point-min) (point))
328 329
				  original-point))
	  (or (bolp) (setq original-point (1- original-point))))
330
        (hexlify-buffer)
331
        (restore-buffer-modified-p modified))
332 333 334 335 336
      (set (make-local-variable 'hexl-max-address)
           (let* ((full-lines (/ (buffer-size) 68))
                  (last-line (% (buffer-size) 68))
                  (last-line-bytes (% last-line 52)))
             (+ last-line-bytes (* full-lines 16) -1)))
337 338 339
      (condition-case nil
	  (hexl-goto-address original-point)
	(error nil)))
340

341 342
    ;; We do not turn off the old major mode; instead we just
    ;; override most of it.  That way, we can restore it perfectly.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
343

344
    (hexl-mode--setq-local '(current-local-map . use-local-map) hexl-mode-map)
345

346 347 348 349
    (hexl-mode--setq-local 'mode-name "Hexl")
    (hexl-mode--setq-local 'isearch-search-fun-function
                           'hexl-isearch-search-function)
    (hexl-mode--setq-local 'major-mode 'hexl-mode)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
350

351 352
    (hexl-mode--setq-local '(syntax-table . set-syntax-table)
                           (standard-syntax-table))
353

354
    (add-hook 'write-contents-functions 'hexl-save-buffer nil t)
355

356
    (hexl-mode--setq-local 'require-final-newline nil)
357

358

359
    (hexl-mode--setq-local 'font-lock-defaults '(hexl-font-lock-keywords t))
360

361 362
    (hexl-mode--setq-local 'revert-buffer-function
                           #'hexl-revert-buffer-function)
363 364
    (add-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer nil t)

365
    ;; Set a callback function for eldoc.
366 367
    (hexl-mode--setq-local 'eldoc-documentation-function
                           #'hexl-print-current-point-info)
368
    (eldoc-add-command-completions "hexl-")
369
    (eldoc-remove-command "hexl-save-buffer"
370 371
			  "hexl-current-address")

372
    (if hexl-follow-ascii (hexl-follow-ascii 1)))
373
  (run-mode-hooks 'hexl-mode-hook))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
374

375 376 377 378 379 380

(defun hexl-isearch-search-function ()
  (if (and (not isearch-regexp) (not isearch-word))
      (lambda (string &optional bound noerror count)
	(funcall
	 (if isearch-forward 're-search-forward 're-search-backward)
381 382 383 384 385 386 387 388 389 390
         (let ((textre
                (if (> (length string) 80)
                    (regexp-quote string)
                  (mapconcat (lambda (c) (regexp-quote (string c))) string
                             "\\(?:\n\\(?:[:a-f0-9]+ \\)+ \\)?"))))
           (if (string-match "\\` ?\\([a-f0-9]+ \\)*[a-f0-9]+ ?\\'" string)
               (concat textre "\\|"
                       (mapconcat 'regexp-quote (split-string string " ")
                                  " \\(?: .+\n[a-f0-9]+: \\)?"))
             textre))
391 392 393 394
	 bound noerror count))
    (let ((isearch-search-fun-function nil))
      (isearch-search-fun))))

Jim Blandy's avatar
Jim Blandy committed
395 396
(defvar hexl-in-save-buffer nil)

Joseph Arceneaux's avatar
Joseph Arceneaux committed
397 398 399
(defun hexl-save-buffer ()
  "Save a hexl format buffer as binary in visited file if modified."
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
400
  (if hexl-in-save-buffer nil
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
    (restore-buffer-modified-p
     (if (buffer-modified-p)
         (let ((buf (generate-new-buffer " hexl"))
               (name (buffer-name))
               (start (point-min))
               (end (point-max))
               modified)
           (with-current-buffer buf
             (insert-buffer-substring name start end)
             (set-buffer name)
             (dehexlify-buffer)
             ;; Prevent infinite recursion.
             (let ((hexl-in-save-buffer t))
               (save-buffer))
             (setq modified (buffer-modified-p))
             (delete-region (point-min) (point-max))
             (insert-buffer-substring buf start end)
             (kill-buffer buf)
             modified))
       (message "(No changes need to be saved)")
       nil))
Jim Blandy's avatar
Jim Blandy committed
422 423
    ;; Return t to indicate we have saved t
    t))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
424

425
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
426
(defun hexl-find-file (filename)
Eli Zaretskii's avatar
Eli Zaretskii committed
427 428 429
  "Edit file FILENAME as a binary file in hex dump format.
Switch to a buffer visiting file FILENAME, creating one if none exists,
and edit the file in `hexl-mode'."
430 431 432 433
  (interactive
   (list
    (let ((completion-ignored-extensions nil))
      (read-file-name "Filename: " nil nil 'ret-must-match))))
434 435
  ;; Ignore the user's setting of default major-mode.
  (letf (((default-value 'major-mode) 'fundamental-mode))
436
    (find-file-literally filename))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
437 438 439
  (if (not (eq major-mode 'hexl-mode))
      (hexl-mode)))

440
(defun hexl-revert-buffer-function (_ignore-auto _noconfirm)
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
  (let ((coding-system-for-read 'no-conversion)
	revert-buffer-function)
    ;; Call the original `revert-buffer' without code conversion; also
    ;; prevent it from changing the major mode to normal-mode, which
    ;; calls `set-auto-mode'.
    (revert-buffer nil nil t)
    ;; A couple of hacks are necessary here:
    ;; 1. change the major-mode to one other than hexl-mode since the
    ;; function `hexl-mode' does nothing if the current major-mode is
    ;; already hexl-mode.
    ;; 2. reset change-major-mode-hook in case that `hexl-mode'
    ;; previously added hexl-maybe-dehexlify-buffer to it.
    (remove-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer t)
    (setq major-mode 'fundamental-mode)
    (hexl-mode)))

Joseph Arceneaux's avatar
Joseph Arceneaux committed
457
(defun hexl-mode-exit (&optional arg)
458
  "Exit Hexl mode, returning to previous mode.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
459 460 461 462
With arg, don't unhexlify buffer."
  (interactive "p")
  (if (or (eq arg 1) (not arg))
      (let ((modified (buffer-modified-p))
463
	    (inhibit-read-only t)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
464 465
	    (original-point (1+ (hexl-current-address))))
	(dehexlify-buffer)
466
	(remove-hook 'write-contents-functions 'hexl-save-buffer t)
467
	(restore-buffer-modified-p modified)
468 469 470 471 472 473
	(goto-char original-point)
	;; Maybe adjust point for the removed CR characters.
	(when (eq (coding-system-eol-type buffer-file-coding-system) 1)
	  (setq original-point (- original-point
				  (count-lines (point-min) (point))))
	  (or (bobp) (setq original-point (1+ original-point))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
474
	(goto-char original-point)))
475 476

  (remove-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer t)
477 478
  (remove-hook 'post-command-hook 'hexl-follow-ascii-find t)
  (setq hexl-ascii-overlay nil)
479

480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
  (let ((mms ()))
    (dolist (varval hexl-mode--old-var-vals)
      (let* ((bound (consp varval))
             (var (if bound (car varval) varval))
             (val (cdr-safe varval)))
        (cond
         ((consp var) (funcall (cdr var) val))
         ((hexl-mode--minor-mode-p var) (push (cons var val) mms))
         (bound (set (make-local-variable var) val))
         (t (kill-local-variable var)))))
    (kill-local-variable 'hexl-mode--old-var-vals)
    ;; Enable/disable minor modes.  Do it after having reset the other vars,
    ;; since some of them may affect the minor modes.
    (dolist (mm mms)
      (funcall (car mm) (if (cdr mm) 1 -1))))
495

496 497 498 499 500 501 502 503 504 505
  (force-mode-line-update))

(defun hexl-maybe-dehexlify-buffer ()
  "Convert a hexl format buffer to binary.
Ask the user for confirmation."
  (if (y-or-n-p "Convert contents back to binary format? ")
      (let ((modified (buffer-modified-p))
	    (inhibit-read-only t)
	    (original-point (1+ (hexl-current-address))))
	(dehexlify-buffer)
506
	(remove-hook 'write-contents-functions 'hexl-save-buffer t)
507
	(restore-buffer-modified-p modified)
508
	(goto-char original-point))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
509

510
(defun hexl-current-address (&optional validate)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
511 512
  "Return current hexl-address."
  (interactive)
513
  (let ((current-column (- (% (- (point) (point-min) -1) 68) 11))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
514
	(hexl-address 0))
515 516 517 518 519
    (if (< current-column 0)
	(if validate
	    (error "Point is not on a character in the file")
	  (setq current-column 0)))
    (setq hexl-address
520
	  (+ (* (/ (- (point) (point-min) -1) 68) 16)
521 522 523
	     (if (>= current-column 41)
		 (- current-column 41)
	       (/ (- current-column  (/ current-column 5)) 2))))
524
    (when (called-interactively-p 'interactive)
525
      (message "Current address is %d/0x%08x" hexl-address hexl-address))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
526 527
    hexl-address))

528 529
(defun hexl-print-current-point-info ()
  "Return current hexl-address in string.
530
This function is intended to be used as eldoc callback."
531 532 533
  (let ((addr (hexl-current-address)))
    (format "Current address is %d/0x%08x" addr addr)))

Joseph Arceneaux's avatar
Joseph Arceneaux committed
534
(defun hexl-address-to-marker (address)
535
  "Return buffer position for ADDRESS."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
536
  (interactive "nAddress: ")
537
  (+ (* (/ address 16) 68) 10 (point-min) (/ (* (% address 16) 5) 2)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
538 539

(defun hexl-goto-address (address)
540
  "Go to hexl-mode (decimal) address ADDRESS.
541
Signal error if ADDRESS is out of range."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
542 543
  (interactive "nAddress: ")
  (if (or (< address 0) (> address hexl-max-address))
544
      (error "Out of hexl region"))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
545 546 547
  (goto-char (hexl-address-to-marker address)))

(defun hexl-goto-hex-address (hex-address)
Jim Blandy's avatar
Jim Blandy committed
548
  "Go to hexl-mode address (hex string) HEX-ADDRESS.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
Signal error if HEX-ADDRESS is out of range."
  (interactive "sHex Address: ")
  (hexl-goto-address (hexl-hex-string-to-integer hex-address)))

(defun hexl-hex-string-to-integer (hex-string)
  "Return decimal integer for HEX-STRING."
  (interactive "sHex number: ")
  (let ((hex-num 0))
    (while (not (equal hex-string ""))
      (setq hex-num (+ (* hex-num 16)
		       (hexl-hex-char-to-integer (string-to-char hex-string))))
      (setq hex-string (substring hex-string 1)))
    hex-num))

(defun hexl-octal-string-to-integer (octal-string)
  "Return decimal integer for OCTAL-STRING."
  (interactive "sOctal number: ")
  (let ((oct-num 0))
    (while (not (equal octal-string ""))
      (setq oct-num (+ (* oct-num 8)
		       (hexl-oct-char-to-integer
			(string-to-char octal-string))))
      (setq octal-string (substring octal-string 1)))
    oct-num))

;; move point functions

(defun hexl-backward-char (arg)
  "Move to left ARG bytes (right if ARG negative) in hexl-mode."
  (interactive "p")
  (hexl-goto-address (- (hexl-current-address) arg)))

(defun hexl-forward-char (arg)
582
  "Move to right ARG bytes (left if ARG negative) in hexl-mode."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
583 584 585 586 587 588 589 590 591 592 593
  (interactive "p")
  (hexl-goto-address (+ (hexl-current-address) arg)))

(defun hexl-backward-short (arg)
  "Move to left ARG shorts (right if ARG negative) in hexl-mode."
  (interactive "p")
  (hexl-goto-address (let ((address (hexl-current-address)))
		       (if (< arg 0)
			   (progn
			     (setq arg (- arg))
			     (while (> arg 0)
594 595 596 597 598 599 600 601
                               (setq address
                                     (if (> address hexl-max-address)
                                         (progn
                                           (message "End of buffer.")
                                           hexl-max-address)
                                       (if (equal address (logior address 3))
                                           (+ address 4)
                                         (logior address 3))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
602
			       (setq arg (1- arg)))
603 604 605 606 607 608
                             (setq address
                                   (if (> address hexl-max-address)
                                       (progn
                                         (message "End of buffer.")
                                         hexl-max-address)
                                     (logior address 3))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
609 610 611 612 613 614 615 616 617 618
			 (while (> arg 0)
			   (if (not (equal address (logand address -4)))
			       (setq address (logand address -4))
			     (if (not (equal address 0))
				 (setq address (- address 4))
			       (message "Beginning of buffer.")))
			   (setq arg (1- arg))))
		       address)))

(defun hexl-forward-short (arg)
619
  "Move to right ARG shorts (left if ARG negative) in hexl-mode."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
620 621 622 623 624 625 626 627 628 629 630
  (interactive "p")
  (hexl-backward-short (- arg)))

(defun hexl-backward-word (arg)
  "Move to left ARG words (right if ARG negative) in hexl-mode."
  (interactive "p")
  (hexl-goto-address (let ((address (hexl-current-address)))
		       (if (< arg 0)
			   (progn
			     (setq arg (- arg))
			     (while (> arg 0)
631 632 633 634 635 636 637 638
                               (setq address
                                     (if (> address hexl-max-address)
                                         (progn
                                           (message "End of buffer.")
                                           hexl-max-address)
                                       (if (equal address (logior address 7))
                                           (+ address 8)
                                         (logior address 7))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
639
			       (setq arg (1- arg)))
640 641 642 643 644 645
                             (setq address
                                   (if (> address hexl-max-address)
                                       (progn
                                         (message "End of buffer.")
                                         hexl-max-address)
                                     (logior address 7))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
646 647 648 649 650 651 652 653 654 655
			 (while (> arg 0)
			   (if (not (equal address (logand address -8)))
			       (setq address (logand address -8))
			     (if (not (equal address 0))
				 (setq address (- address 8))
			       (message "Beginning of buffer.")))
			   (setq arg (1- arg))))
		       address)))

(defun hexl-forward-word (arg)
656
  "Move to right ARG words (left if ARG negative) in hexl-mode."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
657 658 659 660
  (interactive "p")
  (hexl-backward-word (- arg)))

(defun hexl-previous-line (arg)
Jim Blandy's avatar
Jim Blandy committed
661
  "Move vertically up ARG lines [16 bytes] (down if ARG negative) in hexl-mode.
662
If there is no byte at the target address move to the last byte in that line."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
663 664 665 666
  (interactive "p")
  (hexl-next-line (- arg)))

(defun hexl-next-line (arg)
Jim Blandy's avatar
Jim Blandy committed
667 668
  "Move vertically down ARG lines [16 bytes] (up if ARG negative) in hexl-mode.
If there is no byte at the target address move to the last byte in that line."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
669
  (interactive "p")
Jim Blandy's avatar
Jim Blandy committed
670
  (hexl-goto-address (let ((address (+ (hexl-current-address) (* arg 16))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
		       (if (and (< arg 0) (< address 0))
				(progn (message "Out of hexl region.")
				       (setq address
					     (% (hexl-current-address) 16)))
			 (if (and (> address hexl-max-address)
				  (< (% hexl-max-address 16) (% address 16)))
			     (setq address hexl-max-address)
			   (if (> address hexl-max-address)
			       (progn (message "Out of hexl region.")
				      (setq
				       address
				       (+ (logand hexl-max-address -16)
					  (% (hexl-current-address) 16)))))))
		       address)))

(defun hexl-beginning-of-buffer (arg)
Jim Blandy's avatar
Jim Blandy committed
687 688 689
  "Move to the beginning of the hexl buffer.
Leaves `hexl-mark' at previous position.
With prefix arg N, puts point N bytes of the way from the true beginning."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
690 691 692 693 694
  (interactive "p")
  (push-mark (point))
  (hexl-goto-address (+ 0 (1- arg))))

(defun hexl-end-of-buffer (arg)
Jim Blandy's avatar
Jim Blandy committed
695
  "Go to `hexl-max-address' minus ARG."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
  (interactive "p")
  (push-mark (point))
  (hexl-goto-address (- hexl-max-address (1- arg))))

(defun hexl-beginning-of-line ()
  "Goto beginning of line in hexl mode."
  (interactive)
  (goto-char (+ (* (/ (point) 68) 68) 11)))

(defun hexl-end-of-line ()
  "Goto end of line in hexl mode."
  (interactive)
  (hexl-goto-address (let ((address (logior (hexl-current-address) 15)))
		       (if (> address hexl-max-address)
			   (setq address hexl-max-address))
		       address)))

(defun hexl-scroll-down (arg)
  "Scroll hexl buffer window upward ARG lines; or near full window if no ARG."
  (interactive "P")
716 717 718
  (setq arg (if (null arg)
                (1- (window-height))
              (prefix-numeric-value arg)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
719 720 721
  (hexl-scroll-up (- arg)))

(defun hexl-scroll-up (arg)
722 723
  "Scroll hexl buffer window upward ARG lines; or near full window if no ARG.
If there's no byte at the target address, move to the first or last line."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
724
  (interactive "P")
725 726 727
  (setq arg (if (null arg)
                (1- (window-height))
              (prefix-numeric-value arg)))
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
  (let* ((movement (* arg 16))
	 (address (hexl-current-address))
	 (dest (+ address movement)))
    (cond
     ;; If possible, try to stay at the same offset from the beginning
     ;; of the 16-byte group, even if we move to the first or last
     ;; group.
     ((and (> dest hexl-max-address)
	   (>= (% hexl-max-address 16) (% address 16)))
      (setq dest (+ (logand hexl-max-address -16) (% address 16))))
     ((> dest hexl-max-address)
      (setq dest hexl-max-address))
     ((< dest 0)
      (setq dest (% address 16))))
    (if (/= dest (+ address movement))
	(message "Out of hexl region."))
    (hexl-goto-address dest)
    (recenter 0)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
746 747

(defun hexl-beginning-of-1k-page ()
748
  "Go to beginning of 1KB boundary."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
749 750 751 752
  (interactive)
  (hexl-goto-address (logand (hexl-current-address) -1024)))

(defun hexl-end-of-1k-page ()
753
  "Go to end of 1KB boundary."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
754
  (interactive)
755 756
  (hexl-goto-address
   (max hexl-max-address (logior (hexl-current-address) 1023))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
757 758

(defun hexl-beginning-of-512b-page ()
759
  "Go to beginning of 512 byte boundary."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
760 761 762 763
  (interactive)
  (hexl-goto-address (logand (hexl-current-address) -512)))

(defun hexl-end-of-512b-page ()
764
  "Go to end of 512 byte boundary."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
765
  (interactive)
766 767
  (hexl-goto-address
   (max hexl-max-address (logior (hexl-current-address) 511))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
768 769 770

(defun hexl-quoted-insert (arg)
  "Read next input character and insert it.
771 772 773
Useful for inserting control characters and non-ASCII characters given their
numerical code.
You may also type octal digits, to insert a character with that code."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
774
  (interactive "p")
775
  (hexl-insert-multibyte-char (read-quoted-char) arg))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
776 777 778

;00000000: 0011 2233 4455 6677 8899 aabb ccdd eeff  0123456789ABCDEF

779
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
780
(defun hexlify-buffer ()
781 782
  "Convert a binary buffer to hexl format.
This discards the buffer's undo information."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
783
  (interactive)
784
  (and (consp buffer-undo-list)
785
       (or (y-or-n-p "Converting to hexl format discards undo info; ok? ")
786 787
	   (error "Aborted"))
       (setq buffer-undo-list nil))
788 789
  ;; Don't decode text in the ASCII part of `hexl' program output.
  (let ((coding-system-for-read 'raw-text)
790
	(coding-system-for-write buffer-file-coding-system)
791
	(buffer-undo-list t))
792 793
    (apply 'call-process-region (point-min) (point-max)
	   (expand-file-name hexl-program exec-directory)
794 795 796 797
	   t t nil
           ;; Manually encode the args, otherwise they're encoded using
           ;; coding-system-for-write (i.e. buffer-file-coding-system) which
           ;; may not be what we want (e.g. utf-16 on a non-utf-16 system).
798 799 800
           (mapcar (lambda (s)
                     (if (not (multibyte-string-p s)) s
                       (encode-coding-string s locale-coding-system)))
801
                   (split-string hexl-options)))
802 803
    (if (> (point) (hexl-address-to-marker hexl-max-address))
	(hexl-goto-address hexl-max-address))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
804 805

(defun dehexlify-buffer ()
806 807
  "Convert a hexl format buffer to binary.
This discards the buffer's undo information."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
808
  (interactive)
809
  (and (consp buffer-undo-list)
810
       (or (y-or-n-p "Converting from hexl format discards undo info; ok? ")
811 812
	   (error "Aborted"))
       (setq buffer-undo-list nil))
813
  (let ((coding-system-for-write 'raw-text)
814
	(coding-system-for-read buffer-file-coding-system)
815
	(buffer-undo-list t))
816 817 818
    (apply 'call-process-region (point-min) (point-max)
	   (expand-file-name hexl-program exec-directory)
	   t t nil "-de" (split-string hexl-options))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
819 820 821

(defun hexl-char-after-point ()
  "Return char for ASCII hex digits at point."
822 823
  (hexl-htoi (char-after (point))
	     (char-after (1+ (point)))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
824 825 826 827 828 829 830 831 832 833 834 835 836

(defun hexl-htoi (lh rh)
  "Hex (char) LH (char) RH to integer."
    (+ (* (hexl-hex-char-to-integer lh) 16)
       (hexl-hex-char-to-integer rh)))

(defun hexl-hex-char-to-integer (character)
  "Take a char and return its value as if it was a hex digit."
  (if (and (>= character ?0) (<= character ?9))
      (- character ?0)
    (let ((ch (logior character 32)))
      (if (and (>= ch ?a) (<= ch ?f))
	  (- ch (- ?a 10))
Richard M. Stallman's avatar
Richard M. Stallman committed
837
	(error "Invalid hex digit `%c'" ch)))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
838 839 840 841 842

(defun hexl-oct-char-to-integer (character)
  "Take a char and return its value as if it was a octal digit."
  (if (and (>= character ?0) (<= character ?7))
      (- character ?0)
Richard M. Stallman's avatar
Richard M. Stallman committed
843
    (error "Invalid octal digit `%c'" character)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
844 845 846

(defun hexl-printable-character (ch)
  "Return a displayable string for character CH."
847 848
  (format "%c" (if (equal hexl-iso "")
		   (if (or (< ch 32) (>= ch 127))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
849 850
		       46
		     ch)
851
		 (if (or (< ch 32) (and (>= ch 127) (< ch 160)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
852 853 854
		     46
		   ch))))

855 856 857 858 859 860 861 862 863
(defun hexl-insert-multibyte-char (ch num)
  "Insert a possibly multibyte character CH NUM times.

Non-ASCII characters are first encoded with `buffer-file-coding-system',
and their encoded form is inserted byte by byte."
  (let ((charset (char-charset ch))
	(coding (if (or (null buffer-file-coding-system)
			;; coding-system-type equals t means undecided.
			(eq (coding-system-type buffer-file-coding-system) t))
864
		    (default-value 'buffer-file-coding-system)
865 866 867 868 869
		  buffer-file-coding-system)))
    (cond ((and (> ch 0) (< ch 256))
	   (hexl-insert-char ch num))
	  ((eq charset 'unknown)
	   (error
870
	    "0x%x -- invalid character code; use \\[hexl-insert-hex-string]"
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
	    ch))
	  (t
	   (let ((encoded (encode-coding-char ch coding))
		 (internal (string-as-unibyte (char-to-string ch)))
		 internal-hex)
	     ;; If encode-coding-char returns nil, it means our character
	     ;; cannot be safely encoded with buffer-file-coding-system.
	     ;; In that case, we offer to insert the internal representation
	     ;; of that character, byte by byte.
	     (when (null encoded)
	       (setq internal-hex
		     (mapconcat (function (lambda (c) (format "%x" c)))
				internal " "))
	       (if (yes-or-no-p
		    (format
		     "Insert char 0x%x's internal representation \"%s\"? "
		     ch internal-hex))
		   (setq encoded internal)
		 (error
890
		  "Can't encode `0x%x' with this buffer's coding system; try \\[hexl-insert-hex-string]"
891 892 893 894 895 896
		  ch)))
	     (while (> num 0)
	       (mapc
		(function (lambda (c) (hexl-insert-char c 1))) encoded)
	       (setq num (1- num))))))))

Joseph Arceneaux's avatar
Joseph Arceneaux committed
897
(defun hexl-self-insert-command (arg)
898 899 900 901 902
  "Insert this character.
Interactively, with a numeric argument, insert this character that many times.

Non-ASCII characters are first encoded with `buffer-file-coding-system',
and their encoded form is inserted byte by byte."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
903
  (interactive "p")
904
  (hexl-insert-multibyte-char last-command-event arg))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
905 906

(defun hexl-insert-char (ch num)
907 908 909 910
  "Insert the character CH NUM times in a hexl buffer.

CH must be a unibyte character whose value is between 0 and 255."
  (if (or (< ch 0) (> ch 255))
911
      (error "Invalid character 0x%x -- must be in the range [0..255]" ch))
912
  (let ((address (hexl-current-address t)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
913
    (while (> num 0)
914 915
      (let ((hex-position
	     (+ (* (/ address 16) 68)
916
		10 (point-min)
917 918 919
		(* 2 (% address 16))
		(/ (% address 16) 2)))
	    (ascii-position
920
	     (+ (* (/ address 16) 68) 51 (point-min) (% address 16)))
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
	    at-ascii-position)
	(if (= (point) ascii-position)
	    (setq at-ascii-position t))
	(goto-char hex-position)
	(delete-char 2)
	(insert (format "%02x" ch))
	(goto-char ascii-position)
	(delete-char 1)
	(insert (hexl-printable-character ch))
	(or (eq address hexl-max-address)
	    (setq address (1+ address)))
	(hexl-goto-address address)
	(if at-ascii-position
	    (progn
	      (beginning-of-line)
	      (forward-char 51)
	      (forward-char (% address 16)))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
938 939 940 941 942
      (setq num (1- num)))))

;; hex conversion

(defun hexl-insert-hex-char (arg)
943
  "Insert a character given by its hexadecimal code ARG times at point."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
944 945
  (interactive "p")
  (let ((num (hexl-hex-string-to-integer (read-string "Hex number: "))))
946
    (if (< num 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
947
	(error "Hex number out of range")
948
      (hexl-insert-multibyte-char num arg))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
949

950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
(defun hexl-insert-hex-string (str arg)
  "Insert hexadecimal string STR at point ARG times.
Embedded whitespace, dashes, and periods in the string are ignored."
  (interactive "sHex string: \np")
  (setq str (replace-regexp-in-string "[- \t.]" "" str))
  (let ((chars '()))
    (let ((len (length str))
	  (idx 0))
      (if (eq (logand len 1) 1)
	  (let ((num (hexl-hex-string-to-integer (substring str 0 1))))
	    (setq chars (cons num chars))
	    (setq idx 1)))
      (while (< idx len)
	(let* ((nidx (+ idx 2))
	       (num (hexl-hex-string-to-integer (substring str idx nidx))))
	  (setq chars (cons num chars))
	  (setq idx nidx))))
    (setq chars (nreverse chars))
    (while (> arg 0)
      (let ((chars chars))
	(while chars
	  (hexl-insert-char (car chars) 1)
	  (setq chars (cdr chars))))
      (setq arg (- arg 1)))))

Joseph Arceneaux's avatar
Joseph Arceneaux committed
975
(defun hexl-insert-decimal-char (arg)
976
  "Insert a character given by its decimal code ARG times at point."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
977
  (interactive "p")
978
  (let ((num (string-to-number (read-string "Decimal Number: "))))
979
    (if (< num 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
980
	(error "Decimal number out of range")
981
      (hexl-insert-multibyte-char num arg))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
982 983

(defun hexl-insert-octal-char (arg)
984
  "Insert a character given by its octal code ARG times at point."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
985 986
  (interactive "p")
  (let ((num (hexl-octal-string-to-integer (read-string "Octal Number: "))))
987
    (if (< num 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
988
	(error "Decimal number out of range")
989
      (hexl-insert-multibyte-char num arg))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
990

991 992 993 994 995 996 997
(defun hexl-follow-ascii (&optional arg)
  "Toggle following ASCII in Hexl buffers.
With prefix ARG, turn on following if and only if ARG is positive.
When following is enabled, the ASCII character corresponding to the
element under the point is highlighted.
Customize the variable `hexl-follow-ascii' to disable this feature."
  (interactive "P")
998
  (let ((on-p (if arg
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
		  (> (prefix-numeric-value arg) 0)
	       (not hexl-ascii-overlay))))

    (if on-p
      ;; turn it on
      (if (not hexl-ascii-overlay)
	  (progn
	    (setq hexl-ascii-overlay (make-overlay 1 1)
		  hexl-follow-ascii t)
	    (overlay-put hexl-ascii-overlay 'face 'highlight)
	    (add-hook 'post-command-hook 'hexl-follow-ascii-find nil t)))
      ;; turn it off
      (if hexl-ascii-overlay
	  (progn
	    (delete-overlay hexl-ascii-overlay)
	    (setq hexl-ascii-overlay nil
		  hexl-follow-ascii nil)
	    (remove-hook 'post-command-hook 'hexl-follow-ascii-find t)
	    )))))

1019
(defun hexl-activate-ruler ()
1020
  "Activate `ruler-mode'."
1021
  (require 'ruler-mode)
1022 1023 1024
  (hexl-mode--setq-local 'ruler-mode-ruler-function
                         #'hexl-mode-ruler)
  (hexl-mode--setq-local 'ruler-mode t))
1025 1026

(defun hexl-follow-line ()
1027
  "Activate `hl-line-mode'."
1028
  (require 'hl-line)
1029 1030 1031 1032
  (hexl-mode--setq-local 'hl-line-range-function
                         #'hexl-highlight-line-range)
  (hexl-mode--setq-local 'hl-line-face 'highlight)
  (hexl-mode--setq-local 'hl-line-mode t))
1033 1034

(defun hexl-highlight-line-range ()
Masatake YAMATO's avatar
Masatake YAMATO committed
1035
  "Return the range of address region for the point.
1036
This function is assumed to be used as callback function for `hl-line-mode'."
1037 1038 1039 1040 1041
  (cons
   (line-beginning-position)
   ;; 9 stands for (length "87654321:")
   (+ (line-beginning-position) 9)))