hexl.el 28.6 KB
Newer Older
1
;;; hexl.el --- edit a file in a hex dump format using the hexl filter.
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Karl Heuer's avatar
Karl Heuer committed
3
;; Copyright (C) 1989, 1994 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 11 12
;; This file is part of GNU Emacs.

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

;; 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
Erik Naggum's avatar
Erik Naggum committed
22 23 24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
25

Eric S. Raymond's avatar
Eric S. Raymond committed
26 27
;;; Commentary:

28 29 30 31 32 33
;; 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
;; do `M-x describe-mode'.
;;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
;; This may be useful in your .emacs:
;;
;;	(autoload 'hexl-find-file "hexl"
;;	  "Edit file FILENAME in hexl-mode." t)
;;	
;;	(define-key global-map "\C-c\C-h" 'hexl-find-file)
;;
;; NOTE: Remember to change HEXL-PROGRAM or HEXL-OPTIONS if needed.
;;
;; Currently hexl only supports big endian hex output with 16 bit
;; grouping.
;;
;; -iso in `hexl-options' will allow iso characters to display in the
;; ASCII region of the screen (if your emacs supports this) instead of
;; changing them to dots.

Eric S. Raymond's avatar
Eric S. Raymond committed
50 51
;;; Code:

Joseph Arceneaux's avatar
Joseph Arceneaux committed
52 53 54 55
;;
;; vars here
;;

56 57 58 59 60 61
(defgroup hexl nil
  "Edit a file in a hex dump format using the hexl filter."
  :group 'data)


(defcustom hexl-program "hexl"
62
  "The program that will hexlify and dehexlify its stdin.
Richard M. Stallman's avatar
Richard M. Stallman committed
63
`hexl-program' will always be concatenated with `hexl-options'
64 65 66
and \"-de\" when dehexlifying a buffer."
  :type 'string
  :group 'hexl)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
67

68
(defcustom hexl-iso ""
Joseph Arceneaux's avatar
Joseph Arceneaux committed
69
  "If your emacs can handle ISO characters, this should be set to
70 71 72
\"-iso\" otherwise it should be \"\"."
  :type 'string
  :group 'hexl)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
73

74 75 76 77
(defcustom hexl-options (format "-hex %s" hexl-iso)
  "Options to hexl-program that suit your needs."
  :type 'string
  :group 'hexl)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
78

79
(defcustom hexlify-command
80
  (format "%s%s %s" exec-directory hexl-program hexl-options)
81 82 83
  "The command to use to hexlify a buffer."
  :type 'string
  :group 'hexl)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
84

85
(defcustom dehexlify-command
86
  (format "%s%s -de %s" exec-directory hexl-program hexl-options)
87 88 89
  "The command to use to unhexlify a buffer."
  :type 'string
  :group 'hexl)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
90 91 92 93 94 95

(defvar hexl-max-address 0
  "Maximum offset into hexl buffer.")

(defvar hexl-mode-map nil)

96 97 98
(defvar hexl-mode-old-local-map)
(defvar hexl-mode-old-mode-name)
(defvar hexl-mode-old-major-mode)
99 100 101
(defvar hexl-mode-old-write-contents-hooks)
(defvar hexl-mode-old-require-final-newline)
(defvar hexl-mode-old-syntax-table)
102

Joseph Arceneaux's avatar
Joseph Arceneaux committed
103 104
;; routines

105 106
(put 'hexl-mode 'mode-class 'special)

107
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
108 109
(defun hexl-mode (&optional arg)
  "\\<hexl-mode-map>
110
A major mode for editing binary files in hex dump format.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
111 112 113 114

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

115
Each line in the buffer has an \"address\" (displayed in hexadecimal)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
116 117 118 119 120 121 122 123
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.

124 125
If `hexl-mode' is invoked with an argument the buffer is assumed to be
in hexl format.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
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

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
  00000080: 2063 6861 7261 6374 6572 730a 6172 6520   characters.are 
  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
  000000b0: 7461 626c 6520 6368 6172 6163 7465 7220  table character 
  000000c0: 7265 6769 6f6e 2e0a                      region..

Movement is as simple as movement in a normal emacs text buffer.  Most
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.

173 174
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
175 176 177 178 179 180

You can use \\[hexl-find-file] to visit a file in hexl-mode.

\\[describe-bindings] for advanced commands."
  (interactive "p")
  (if (eq major-mode 'hexl-mode)
181 182
      (error "You are already in hexl mode")

183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
    (let ((modified (buffer-modified-p))
	  (inhibit-read-only t)
	  (original-point (1- (point)))
	  max-address)
      (and (eobp) (not (bobp))
	   (setq original-point (1- original-point)))
      (if (not (or (eq arg 1) (not arg)))
	  ;; if no argument then we guess at hexl-max-address
          (setq max-address (+ (* (/ (1- (buffer-size)) 68) 16) 15))
        (setq max-address (1- (buffer-size)))
        (hexlify-buffer)
        (set-buffer-modified-p modified))
      (make-local-variable 'hexl-max-address)
      (setq hexl-max-address max-address)
      (hexl-goto-address original-point))

199 200
    ;; 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
201 202 203 204 205 206 207 208 209 210 211 212
    (make-local-variable 'hexl-mode-old-local-map)
    (setq hexl-mode-old-local-map (current-local-map))
    (use-local-map hexl-mode-map)

    (make-local-variable 'hexl-mode-old-mode-name)
    (setq hexl-mode-old-mode-name mode-name)
    (setq mode-name "Hexl")

    (make-local-variable 'hexl-mode-old-major-mode)
    (setq hexl-mode-old-major-mode major-mode)
    (setq major-mode 'hexl-mode)

213 214 215 216 217 218
    (make-local-variable 'hexl-mode-old-syntax-table)
    (setq hexl-mode-old-syntax-table (syntax-table))
    (set-syntax-table (standard-syntax-table))

    (make-local-variable 'hexl-mode-old-write-contents-hooks)
    (setq hexl-mode-old-write-contents-hooks write-contents-hooks)
219
    (make-local-variable 'write-contents-hooks)
220
    (add-hook 'write-contents-hooks 'hexl-save-buffer)
221

222 223 224 225 226 227
    (make-local-variable 'hexl-mode-old-require-final-newline)
    (setq hexl-mode-old-require-final-newline require-final-newline)
    (make-local-variable 'require-final-newline)
    (setq require-final-newline nil)

    ;; Add hooks to rehexlify or dehexlify on various events.
228 229 230
    (make-local-hook 'after-revert-hook)
    (add-hook 'after-revert-hook 'hexl-after-revert-hook nil t)

231
    (make-local-hook 'change-major-mode-hook)
232 233
    (add-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer nil t))
  (run-hooks 'hexl-mode-hook))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
234

235 236 237 238
(defun hexl-after-revert-hook ()
  (hexlify-buffer)
  (set-buffer-modified-p nil))

Jim Blandy's avatar
Jim Blandy committed
239 240
(defvar hexl-in-save-buffer nil)

Joseph Arceneaux's avatar
Joseph Arceneaux committed
241 242 243
(defun hexl-save-buffer ()
  "Save a hexl format buffer as binary in visited file if modified."
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
244 245 246 247 248 249 250 251 252 253 254 255 256 257
  (if hexl-in-save-buffer nil
    (set-buffer-modified-p (if (buffer-modified-p)
			       (save-excursion
				 (let ((buf (generate-new-buffer " hexl"))
				       (name (buffer-name))
				       (file-name (buffer-file-name))
				       (start (point-min))
				       (end (point-max))
				       modified)
				   (set-buffer buf)
				   (insert-buffer-substring name start end)
				   (set-buffer name)
				   (dehexlify-buffer)
				   ;; Prevent infinite recursion.
258
				   (let ((hexl-in-save-buffer t))
Jim Blandy's avatar
Jim Blandy committed
259 260 261 262 263 264 265 266 267 268
				     (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))
    ;; Return t to indicate we have saved t
    t))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
269

270
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
271 272 273 274
(defun hexl-find-file (filename)
  "Edit file FILENAME in hexl-mode.
Switch to a buffer visiting file FILENAME, creating one in none exists."
  (interactive "fFilename: ")
275
  (find-file-literally filename)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
276 277 278 279
  (if (not (eq major-mode 'hexl-mode))
      (hexl-mode)))

(defun hexl-mode-exit (&optional arg)
280
  "Exit Hexl mode, returning to previous mode.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
281 282 283 284
With arg, don't unhexlify buffer."
  (interactive "p")
  (if (or (eq arg 1) (not arg))
      (let ((modified (buffer-modified-p))
285
	    (inhibit-read-only t)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
286 287
	    (original-point (1+ (hexl-current-address))))
	(dehexlify-buffer)
288
	(remove-hook 'write-contents-hooks 'hexl-save-buffer)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
289 290
	(set-buffer-modified-p modified)
	(goto-char original-point)))
291 292 293 294 295 296

  (remove-hook 'after-revert-hook 'hexl-after-revert-hook t)
  (remove-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer t)

  (setq write-contents-hooks hexl-mode-old-write-contents-hooks)
  (setq require-final-newline hexl-mode-old-require-final-newline)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
297 298
  (setq mode-name hexl-mode-old-mode-name)
  (use-local-map hexl-mode-old-local-map)
299
  (set-syntax-table hexl-mode-old-syntax-table)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
300
  (setq major-mode hexl-mode-old-major-mode)
301 302 303 304 305 306 307 308 309 310
  (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)
311
	(remove-hook 'write-contents-hooks 'hexl-save-buffer)
312 313
	(set-buffer-modified-p modified)
	(goto-char original-point))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
314

315
(defun hexl-current-address (&optional validate)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
316 317 318 319
  "Return current hexl-address."
  (interactive)
  (let ((current-column (- (% (point) 68) 11)) 
	(hexl-address 0))
320 321 322 323 324 325 326 327 328
    (if (< current-column 0)
	(if validate
	    (error "Point is not on a character in the file")
	  (setq current-column 0)))
    (setq hexl-address
	  (+ (* (/ (point) 68) 16)
	     (if (>= current-column 41)
		 (- current-column 41)
	       (/ (- current-column  (/ current-column 5)) 2))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
329 330 331 332 333 334 335 336 337 338 339 340
    hexl-address))

(defun hexl-address-to-marker (address)
  "Return marker for ADDRESS."
  (interactive "nAddress: ")
  (+ (* (/ address 16) 68) 11 (/ (* (% address 16) 5) 2)))

(defun hexl-goto-address (address)
  "Goto hexl-mode (decimal) address ADDRESS.
Signal error if ADDRESS out of range."
  (interactive "nAddress: ")
  (if (or (< address 0) (> address hexl-max-address))
Richard M. Stallman's avatar
Richard M. Stallman committed
341
	  (error "Out of hexl region"))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
342 343 344
  (goto-char (hexl-address-to-marker address)))

(defun hexl-goto-hex-address (hex-address)
Jim Blandy's avatar
Jim Blandy committed
345
  "Go to hexl-mode address (hex string) HEX-ADDRESS.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
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)
  "Move right ARG bytes (left if ARG negative) in hexl-mode."
  (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)
			       (if (not (equal address (logior address 3)))
				   (if (> address hexl-max-address)
				       (progn
					 (message "End of buffer.")
					 (setq address hexl-max-address))
				     (setq address (logior address 3)))
				 (if (> address hexl-max-address)
				     (progn
				       (message "End of buffer.")
				       (setq address hexl-max-address))
				   (setq address (+ address 4))))
			       (setq arg (1- arg)))
			     (if (> address hexl-max-address)
				 (progn
				   (message "End of buffer.")
				   (setq address hexl-max-address))
			       (setq address (logior address 3))))
			 (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)
  "Move right ARG shorts (left if ARG negative) in hexl-mode."
  (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)
			       (if (not (equal address (logior address 7)))
				   (if (> address hexl-max-address)
				       (progn
					 (message "End of buffer.")
					 (setq address hexl-max-address))
				     (setq address (logior address 7)))
				 (if (> address hexl-max-address)
				     (progn
				       (message "End of buffer.")
				       (setq address hexl-max-address))
				   (setq address (+ address 8))))
			       (setq arg (1- arg)))
			     (if (> address hexl-max-address)
				 (progn
				   (message "End of buffer.")
				   (setq address hexl-max-address))
			       (setq address (logior address 7))))
			 (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)
  "Move right ARG words (left if ARG negative) in hexl-mode."
  (interactive "p")
  (hexl-backward-word (- arg)))

(defun hexl-previous-line (arg)
Jim Blandy's avatar
Jim Blandy committed
462 463
  "Move vertically up ARG lines [16 bytes] (down if ARG negative) in hexl-mode.
If there is byte at the target address move to the last byte in that line."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
464 465 466 467
  (interactive "p")
  (hexl-next-line (- arg)))

(defun hexl-next-line (arg)
Jim Blandy's avatar
Jim Blandy committed
468 469
  "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
470
  (interactive "p")
Jim Blandy's avatar
Jim Blandy committed
471
  (hexl-goto-address (let ((address (+ (hexl-current-address) (* arg 16))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
		       (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
488 489 490
  "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
491 492 493 494 495
  (interactive "p")
  (push-mark (point))
  (hexl-goto-address (+ 0 (1- arg))))

(defun hexl-end-of-buffer (arg)
Jim Blandy's avatar
Jim Blandy committed
496
  "Go to `hexl-max-address' minus ARG."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
  (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")
  (if (null arg)
      (setq arg (1- (window-height)))
    (setq arg (prefix-numeric-value arg)))
  (hexl-scroll-up (- arg)))

(defun hexl-scroll-up (arg)
  "Scroll hexl buffer window upward ARG lines; or near full window if no ARG."
  (interactive "P")
  (if (null arg)
      (setq arg (1- (window-height)))
    (setq arg (prefix-numeric-value arg)))
  (let ((movement (* arg 16))
	(address (hexl-current-address)))
    (if (or (> (+ address movement) hexl-max-address)
	    (< (+ address movement) 0))
	(message "Out of hexl region.")
      (hexl-goto-address (+ address movement))
      (recenter 0))))

(defun hexl-beginning-of-1k-page ()
537
  "Go to beginning of 1k boundary."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
538 539 540 541
  (interactive)
  (hexl-goto-address (logand (hexl-current-address) -1024)))

(defun hexl-end-of-1k-page ()
542
  "Go to end of 1k boundary."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
543 544 545 546 547 548 549
  (interactive)
  (hexl-goto-address (let ((address (logior (hexl-current-address) 1023)))
		       (if (> address hexl-max-address)
			   (setq address hexl-max-address))
		       address)))

(defun hexl-beginning-of-512b-page ()
550
  "Go to beginning of 512 byte boundary."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
551 552 553 554
  (interactive)
  (hexl-goto-address (logand (hexl-current-address) -512)))

(defun hexl-end-of-512b-page ()
555
  "Go to end of 512 byte boundary."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
  (interactive)
  (hexl-goto-address (let ((address (logior (hexl-current-address) 511)))
		       (if (> address hexl-max-address)
			   (setq address hexl-max-address))
		       address)))

(defun hexl-quoted-insert (arg)
  "Read next input character and insert it.
Useful for inserting control characters.
You may also type up to 3 octal digits, to insert a character with that code"
  (interactive "p")
  (hexl-insert-char (read-quoted-char) arg))

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

571
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
572
(defun hexlify-buffer ()
573 574
  "Convert a binary buffer to hexl format.
This discards the buffer's undo information."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
575
  (interactive)
576 577 578 579
  (and buffer-undo-list
       (or (y-or-n-p "Converting to hexl format discards undo info; ok? ")
	   (error "Aborted")))
  (setq buffer-undo-list nil)
580
  (let ((binary-process-output nil) ; for Ms-Dos
581
	(binary-process-input buffer-file-type)
582 583 584 585 586 587 588 589 590 591 592
	;; If the buffer was read with EOL conversions, be sure to use the
	;; same conversions when passing the region to the `hexl' program.
	(coding-system-for-write
	 (let ((eol-type (coding-system-eol-type buffer-file-coding-system)))
	   (cond ((eq eol-type 1)
		  'raw-text-dos)
		 ((eq eol-type 2)
		  'raw-text-mac)
		 ((eq eol-type 0)
		  'raw-text-unix)
		 (t 'no-conversion))))
593
	(buffer-undo-list t))
594
    (shell-command-on-region (point-min) (point-max) hexlify-command t)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
595 596

(defun dehexlify-buffer ()
597 598
  "Convert a hexl format buffer to binary.
This discards the buffer's undo information."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
599
  (interactive)
600 601 602 603
  (and buffer-undo-list
       (or (y-or-n-p "Converting from hexl format discards undo info; ok? ")
	   (error "Aborted")))
  (setq buffer-undo-list nil)
604
  (let ((binary-process-output buffer-file-type) ; for Ms-Dos
605
	(binary-process-input nil)
606
	(coding-system-for-read 'raw-text)
607
	(buffer-undo-list t))
608
    (shell-command-on-region (point-min) (point-max) dehexlify-command t)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
609 610 611

(defun hexl-char-after-point ()
  "Return char for ASCII hex digits at point."
612 613
  (hexl-htoi (char-after (point))
	     (char-after (1+ (point)))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
614 615 616 617 618 619 620 621 622 623 624 625 626

(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
627
	(error "Invalid hex digit `%c'" ch)))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
628 629 630 631 632

(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
633
    (error "Invalid octal digit `%c'" character)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651

(defun hexl-printable-character (ch)
  "Return a displayable string for character CH."
  (format "%c" (if hexl-iso
		   (if (or (< ch 32) (and (>= ch 127) (< ch 160)))
		       46
		     ch)
		 (if (or (< ch 32) (>= ch 127))
		     46
		   ch))))

(defun hexl-self-insert-command (arg)
  "Insert this character."
  (interactive "p")
  (hexl-insert-char last-command-char arg))

(defun hexl-insert-char (ch num)
  "Insert a character in a hexl buffer."
652
  (let ((address (hexl-current-address t)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
653
    (while (> num 0)
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
      (let ((hex-position
	     (+ (* (/ address 16) 68)
		11
		(* 2 (% address 16))
		(/ (% address 16) 2)))
	    (ascii-position
	     (+ (* (/ address 16) 68) 52 (% address 16)))
	    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
678 679 680 681 682 683 684 685 686
      (setq num (1- num)))))

;; hex conversion

(defun hexl-insert-hex-char (arg)
  "Insert a ASCII char ARG times at point for a given hexadecimal number."
  (interactive "p")
  (let ((num (hexl-hex-string-to-integer (read-string "Hex number: "))))
    (if (or (> num 255) (< num 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
687
	(error "Hex number out of range")
Joseph Arceneaux's avatar
Joseph Arceneaux committed
688 689 690 691 692 693 694
      (hexl-insert-char num arg))))

(defun hexl-insert-decimal-char (arg)
  "Insert a ASCII char ARG times at point for a given decimal number."
  (interactive "p")
  (let ((num (string-to-int (read-string "Decimal Number: "))))
    (if (or (> num 255) (< num 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
695
	(error "Decimal number out of range")
Joseph Arceneaux's avatar
Joseph Arceneaux committed
696 697 698 699 700 701 702
      (hexl-insert-char num arg))))

(defun hexl-insert-octal-char (arg)
  "Insert a ASCII char ARG times at point for a given octal number."
  (interactive "p")
  (let ((num (hexl-octal-string-to-integer (read-string "Octal Number: "))))
    (if (or (> num 255) (< num 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
703
	(error "Decimal number out of range")
Joseph Arceneaux's avatar
Joseph Arceneaux committed
704 705 706 707 708 709
      (hexl-insert-char num arg))))

;; startup stuff.

(if hexl-mode-map
    nil
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
  (setq hexl-mode-map (make-sparse-keymap))

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

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

  (if (not (eq (key-binding (char-to-string help-char)) 'help-command))
      (define-key hexl-mode-map (char-to-string help-char) 'undefined))

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

  (let ((ch 32))
    (while (< ch 127)
      (define-key hexl-mode-map (format "%c" ch) 'hexl-self-insert-command)
      (setq ch (1+ ch))))

  (define-key hexl-mode-map "\e\C-a" 'hexl-beginning-of-512b-page)
  (define-key hexl-mode-map "\e\C-b" 'hexl-backward-short)
  (define-key hexl-mode-map "\e\C-c" 'undefined)
  (define-key hexl-mode-map "\e\C-d" 'hexl-insert-decimal-char)
  (define-key hexl-mode-map "\e\C-e" 'hexl-end-of-512b-page)
  (define-key hexl-mode-map "\e\C-f" 'hexl-forward-short)
  (define-key hexl-mode-map "\e\C-g" 'undefined)
  (define-key hexl-mode-map "\e\C-h" 'undefined)
  (define-key hexl-mode-map "\e\C-i" 'undefined)
  (define-key hexl-mode-map "\e\C-j" 'undefined)
  (define-key hexl-mode-map "\e\C-k" 'undefined)
  (define-key hexl-mode-map "\e\C-l" 'undefined)
  (define-key hexl-mode-map "\e\C-m" 'undefined)
  (define-key hexl-mode-map "\e\C-n" 'undefined)
  (define-key hexl-mode-map "\e\C-o" 'hexl-insert-octal-char)
  (define-key hexl-mode-map "\e\C-p" 'undefined)
  (define-key hexl-mode-map "\e\C-q" 'undefined)
  (define-key hexl-mode-map "\e\C-r" 'undefined)
  (define-key hexl-mode-map "\e\C-s" 'undefined)
  (define-key hexl-mode-map "\e\C-t" 'undefined)
  (define-key hexl-mode-map "\e\C-u" 'undefined)

  (define-key hexl-mode-map "\e\C-w" 'undefined)
  (define-key hexl-mode-map "\e\C-x" 'hexl-insert-hex-char)
  (define-key hexl-mode-map "\e\C-y" 'undefined)

  (define-key hexl-mode-map "\ea" 'undefined)
  (define-key hexl-mode-map "\eb" 'hexl-backward-word)
  (define-key hexl-mode-map "\ec" 'undefined)
  (define-key hexl-mode-map "\ed" 'undefined)
  (define-key hexl-mode-map "\ee" 'undefined)
  (define-key hexl-mode-map "\ef" 'hexl-forward-word)
  (define-key hexl-mode-map "\eg" 'hexl-goto-hex-address)
  (define-key hexl-mode-map "\eh" 'undefined)
  (define-key hexl-mode-map "\ei" 'undefined)
  (define-key hexl-mode-map "\ej" 'hexl-goto-address)
  (define-key hexl-mode-map "\ek" 'undefined)
  (define-key hexl-mode-map "\el" 'undefined)
  (define-key hexl-mode-map "\em" 'undefined)
  (define-key hexl-mode-map "\en" 'undefined)
  (define-key hexl-mode-map "\eo" 'undefined)
  (define-key hexl-mode-map "\ep" 'undefined)
  (define-key hexl-mode-map "\eq" 'undefined)
  (define-key hexl-mode-map "\er" 'undefined)
  (define-key hexl-mode-map "\es" 'undefined)
  (define-key hexl-mode-map "\et" 'undefined)
  (define-key hexl-mode-map "\eu" 'undefined)
  (define-key hexl-mode-map "\ev" 'hexl-scroll-down)
  (define-key hexl-mode-map "\ey" 'undefined)
  (define-key hexl-mode-map "\ez" 'undefined)
  (define-key hexl-mode-map "\e<" 'hexl-beginning-of-buffer)
  (define-key hexl-mode-map "\e>" 'hexl-end-of-buffer)

  (define-key hexl-mode-map "\C-c\C-c" 'hexl-mode-exit)

  (define-key hexl-mode-map "\C-x[" 'hexl-beginning-of-1k-page)
  (define-key hexl-mode-map "\C-x]" 'hexl-end-of-1k-page)
  (define-key hexl-mode-map "\C-x\C-p" 'undefined)
  (define-key hexl-mode-map "\C-x\C-s" 'hexl-save-buffer)
  (define-key hexl-mode-map "\C-x\C-t" 'undefined))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
814

Richard M. Stallman's avatar
Richard M. Stallman committed
815 816
(provide 'hexl)

Eric S. Raymond's avatar
Eric S. Raymond committed
817
;;; hexl.el ends here