hexl.el 38.2 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

3
;; Copyright (C) 1989, 1994, 1998, 2001, 2002, 2003, 2004 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
;; 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
32
;; do M-x `describe-mode'.
33
;;
Pavel Janík's avatar
Pavel Janík committed
34
;; NOTE: Remember to change `hexl-program' or `hexl-options' if needed.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
35 36 37 38 39 40 41 42
;;
;; 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
43 44
;;; Code:

45 46
(require 'eldoc)

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

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


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

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

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

75 76 77
(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
78 79
  :group 'hexl
  :version "20.3")
80

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
(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)

(defface hexl-address-area
  '((t (:inherit header-line)))
  "Face used in address are of hexl-mode buffer."
  :group 'hexl)

(defface hexl-ascii-area
  '((t (:inherit header-line)))
  "Face used in ascii are of hexl-mode buffer."
  :group 'hexl)

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

(defvar hexl-mode-map nil)

102 103 104 105 106
(defvar ruler-mode)
(defvar ruler-mode-ruler-function)
(defvar hl-line-mode)

(defvar hexl-mode-old-hl-line-mode)
107 108 109
(defvar hexl-mode-old-local-map)
(defvar hexl-mode-old-mode-name)
(defvar hexl-mode-old-major-mode)
110
(defvar hexl-mode-old-ruler-mode)
111
(defvar hexl-mode-old-isearch-search-fun-function)
112 113
(defvar hexl-mode-old-require-final-newline)
(defvar hexl-mode-old-syntax-table)
114
(defvar hexl-mode-old-font-lock-keywords)
115

116 117 118 119
(defvar hexl-ascii-overlay nil
  "Overlay used to highlight ASCII element corresponding to current point.")
(make-variable-buffer-local 'hexl-ascii-overlay)

120 121 122 123 124 125 126
(defvar hexl-font-lock-keywords
  '(("^\\([0-9a-f]+:\\).\\{40\\}  \\(.+$\\)"
     ;; "^\\([0-9a-f]+:\\).+  \\(.+$\\)"
     (1 'hexl-address-area t t)
     (2 'hexl-ascii-area t t)))
  "Font lock keywords used in `hexl-mode'.")

Joseph Arceneaux's avatar
Joseph Arceneaux committed
127 128
;; routines

129 130
(put 'hexl-mode 'mode-class 'special)

131
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
132
(defun hexl-mode (&optional arg)
133 134
  "\\<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
135
of the current mode's behavior, but not all; also, you can exit
136
Hexl mode and return to the previous mode using `hexl-mode-exit'.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
137 138 139 140

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

141
Each line in the buffer has an \"address\" (displayed in hexadecimal)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
142 143 144 145 146 147 148 149
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.

150 151
If `hexl-mode' is invoked with an argument the buffer is assumed to be
in hexl format.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
152 153 154 155 156 157 158 159 160 161 162 163 164

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
165
  00000080: 2063 6861 7261 6374 6572 730a 6172 6520   characters.are
Joseph Arceneaux's avatar
Joseph Arceneaux committed
166 167
  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
168
  000000b0: 7461 626c 6520 6368 6172 6163 7465 7220  table character
Joseph Arceneaux's avatar
Joseph Arceneaux committed
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
  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.

199 200
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
201

202
You can use \\[hexl-find-file] to visit a file in Hexl mode.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
203 204 205

\\[describe-bindings] for advanced commands."
  (interactive "p")
206
  (unless (eq major-mode 'hexl-mode)
207 208
    (let ((modified (buffer-modified-p))
	  (inhibit-read-only t)
209
	  (original-point (- (point) (point-min)))
210 211 212 213 214 215 216
	  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)))
217 218 219 220 221 222 223 224 225 226 227 228 229
	;; 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.
	(when (eq (coding-system-eol-type buffer-file-coding-system) 1)
	  (setq max-address (+ (count-lines (point-min) (point-max))
			       max-address))
	  ;; But if there's no newline at the last line, we are off by
	  ;; one; adjust.
	  (or (eq (char-before (point-max)) ?\n)
	      (setq max-address (1- max-address)))
	  (setq original-point (+ (count-lines (point-min) (point))
				  original-point))
	  (or (bolp) (setq original-point (1- original-point))))
230 231 232 233
        (hexlify-buffer)
        (set-buffer-modified-p modified))
      (make-local-variable 'hexl-max-address)
      (setq hexl-max-address max-address)
234 235 236
      (condition-case nil
	  (hexl-goto-address original-point)
	(error nil)))
237

238 239
    ;; 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
240 241 242 243 244 245 246 247
    (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")

248 249 250 251 252
    (set (make-local-variable 'hexl-mode-old-isearch-search-fun-function)
	 isearch-search-fun-function)
    (set (make-local-variable 'isearch-search-fun-function)
	 'hexl-isearch-search-function)

Joseph Arceneaux's avatar
Joseph Arceneaux committed
253 254 255 256
    (make-local-variable 'hexl-mode-old-major-mode)
    (setq hexl-mode-old-major-mode major-mode)
    (setq major-mode 'hexl-mode)

257 258 259 260 261 262 263 264
    (make-local-variable 'hexl-mode-old-ruler-mode)
    (setq hexl-mode-old-ruler-mode
	  (and (boundp 'ruler-mode) ruler-mode))

    (make-local-variable 'hexl-mode-old-hl-line-mode)
    (setq hexl-mode-old-hl-line-mode
	  (and (boundp 'hl-line-mode) hl-line-mode))

265 266 267 268
    (make-local-variable 'hexl-mode-old-syntax-table)
    (setq hexl-mode-old-syntax-table (syntax-table))
    (set-syntax-table (standard-syntax-table))

269
    (add-hook 'write-contents-functions 'hexl-save-buffer nil t)
270

271 272 273 274 275
    (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)

276 277 278 279 280
    (make-local-variable 'hexl-mode-old-font-lock-keywords)
    (setq hexl-mode-old-font-lock-keywords font-lock-defaults)
    (make-local-variable 'font-lock-defaults)
    (setq font-lock-defaults '(hexl-font-lock-keywords t))

281
    ;; Add hooks to rehexlify or dehexlify on various events.
282 283
    (add-hook 'after-revert-hook 'hexl-after-revert-hook nil t)

284 285
    (add-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer nil t)

286
    ;; Set a callback function for eldoc.
287
    (set (make-local-variable 'eldoc-print-current-symbol-info-function)
288 289 290 291 292
	 'hexl-print-current-point-info)
    (eldoc-add-command-completions "hexl-")
    (eldoc-remove-command "hexl-save-buffer" 
			  "hexl-current-address")

293
    (if hexl-follow-ascii (hexl-follow-ascii 1)))
294
  (run-hooks 'hexl-mode-hook))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
295

296 297 298 299 300 301 302 303 304 305 306 307 308

(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)
	 (if (> (length string) 80)
	     (regexp-quote string)
	   (mapconcat 'string string "\\(?:\n\\(?:[:a-f0-9]+ \\)+ \\)?"))
	 bound noerror count))
    (let ((isearch-search-fun-function nil))
      (isearch-search-fun))))

309
(defun hexl-after-revert-hook ()
310
  (setq hexl-max-address (1- (buffer-size)))
311 312 313
  (hexlify-buffer)
  (set-buffer-modified-p nil))

Jim Blandy's avatar
Jim Blandy committed
314 315
(defvar hexl-in-save-buffer nil)

Joseph Arceneaux's avatar
Joseph Arceneaux committed
316 317 318
(defun hexl-save-buffer ()
  "Save a hexl format buffer as binary in visited file if modified."
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
319 320 321 322 323 324 325 326 327 328 329 330 331 332
  (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.
333
				   (let ((hexl-in-save-buffer t))
Jim Blandy's avatar
Jim Blandy committed
334 335 336 337 338 339 340 341 342 343
				     (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
344

345
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
346 347 348
(defun hexl-find-file (filename)
  "Edit file FILENAME in hexl-mode.
Switch to a buffer visiting file FILENAME, creating one in none exists."
349 350 351 352
  (interactive
   (list
    (let ((completion-ignored-extensions nil))
      (read-file-name "Filename: " nil nil 'ret-must-match))))
353
  ;; Ignore the user's setting of default-major-mode.
354
  (let ((default-major-mode 'fundamental-mode))
355
    (find-file-literally filename))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
356 357 358 359
  (if (not (eq major-mode 'hexl-mode))
      (hexl-mode)))

(defun hexl-mode-exit (&optional arg)
360
  "Exit Hexl mode, returning to previous mode.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
361 362 363 364
With arg, don't unhexlify buffer."
  (interactive "p")
  (if (or (eq arg 1) (not arg))
      (let ((modified (buffer-modified-p))
365
	    (inhibit-read-only t)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
366 367
	    (original-point (1+ (hexl-current-address))))
	(dehexlify-buffer)
368
	(remove-hook 'write-contents-functions 'hexl-save-buffer t)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
369
	(set-buffer-modified-p modified)
370 371 372 373 374 375
	(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
376
	(goto-char original-point)))
377 378 379

  (remove-hook 'after-revert-hook 'hexl-after-revert-hook t)
  (remove-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer t)
380 381
  (remove-hook 'post-command-hook 'hexl-follow-ascii-find t)
  (setq hexl-ascii-overlay nil)
382

383 384 385 386
  (if (and (boundp 'ruler-mode) ruler-mode (not hexl-mode-old-ruler-mode))
      (ruler-mode 0))
  (if (and (boundp 'hl-line-mode) hl-line-mode (not hexl-mode-old-hl-line-mode))
      (hl-line-mode 0))
387
  (setq require-final-newline hexl-mode-old-require-final-newline)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
388
  (setq mode-name hexl-mode-old-mode-name)
389
  (setq isearch-search-fun-function hexl-mode-old-isearch-search-fun-function)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
390
  (use-local-map hexl-mode-old-local-map)
391
  (set-syntax-table hexl-mode-old-syntax-table)
392
  (setq font-lock-defaults hexl-mode-old-font-lock-keywords)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
393
  (setq major-mode hexl-mode-old-major-mode)
394 395 396 397 398 399 400 401 402 403
  (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)
404
	(remove-hook 'write-contents-functions 'hexl-save-buffer t)
405 406
	(set-buffer-modified-p modified)
	(goto-char original-point))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
407

408
(defun hexl-current-address (&optional validate)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
409 410
  "Return current hexl-address."
  (interactive)
411
  (let ((current-column (- (% (- (point) (point-min) -1) 68) 11))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
412
	(hexl-address 0))
413 414 415 416 417
    (if (< current-column 0)
	(if validate
	    (error "Point is not on a character in the file")
	  (setq current-column 0)))
    (setq hexl-address
418
	  (+ (* (/ (- (point) (point-min) -1) 68) 16)
419 420 421
	     (if (>= current-column 41)
		 (- current-column 41)
	       (/ (- current-column  (/ current-column 5)) 2))))
422
    (when (interactive-p)
423
      (message "Current address is %d/0x%08x" hexl-address hexl-address))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
424 425
    hexl-address))

426 427 428 429 430 431
(defun hexl-print-current-point-info ()
  "Return current hexl-address in string.
This function is indented to be used as eldoc callback."
  (let ((addr (hexl-current-address)))
    (format "Current address is %d/0x%08x" addr addr)))

Joseph Arceneaux's avatar
Joseph Arceneaux committed
432
(defun hexl-address-to-marker (address)
433
  "Return buffer position for ADDRESS."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
434
  (interactive "nAddress: ")
435
  (+ (* (/ address 16) 68) 10 (point-min) (/ (* (% address 16) 5) 2)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
436 437 438 439 440 441

(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))
442
      (error "Out of hexl region"))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
443 444 445
  (goto-char (hexl-address-to-marker address)))

(defun hexl-goto-hex-address (hex-address)
Jim Blandy's avatar
Jim Blandy committed
446
  "Go to hexl-mode address (hex string) HEX-ADDRESS.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 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 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
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
563 564
  "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
565 566 567 568
  (interactive "p")
  (hexl-next-line (- arg)))

(defun hexl-next-line (arg)
Jim Blandy's avatar
Jim Blandy committed
569 570
  "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
571
  (interactive "p")
Jim Blandy's avatar
Jim Blandy committed
572
  (hexl-goto-address (let ((address (+ (hexl-current-address) (* arg 16))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
		       (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
589 590 591
  "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
592 593 594 595 596
  (interactive "p")
  (push-mark (point))
  (hexl-goto-address (+ 0 (1- arg))))

(defun hexl-end-of-buffer (arg)
Jim Blandy's avatar
Jim Blandy committed
597
  "Go to `hexl-max-address' minus ARG."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
  (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)
624 625
  "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
626 627 628 629
  (interactive "P")
  (if (null arg)
      (setq arg (1- (window-height)))
    (setq arg (prefix-numeric-value arg)))
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
  (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
648 649

(defun hexl-beginning-of-1k-page ()
650
  "Go to beginning of 1k boundary."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
651 652 653 654
  (interactive)
  (hexl-goto-address (logand (hexl-current-address) -1024)))

(defun hexl-end-of-1k-page ()
655
  "Go to end of 1k boundary."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
656 657 658 659 660 661 662
  (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 ()
663
  "Go to beginning of 512 byte boundary."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
664 665 666 667
  (interactive)
  (hexl-goto-address (logand (hexl-current-address) -512)))

(defun hexl-end-of-512b-page ()
668
  "Go to end of 512 byte boundary."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
669 670 671 672 673 674 675 676
  (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.
677 678 679
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
680
  (interactive "p")
681
  (hexl-insert-multibyte-char (read-quoted-char) arg))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
682 683 684

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

685
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
686
(defun hexlify-buffer ()
687 688
  "Convert a binary buffer to hexl format.
This discards the buffer's undo information."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
689
  (interactive)
690 691 692 693
  (and buffer-undo-list
       (or (y-or-n-p "Converting to hexl format discards undo info; ok? ")
	   (error "Aborted")))
  (setq buffer-undo-list nil)
694 695
  ;; Don't decode text in the ASCII part of `hexl' program output.
  (let ((coding-system-for-read 'raw-text)
696
	(coding-system-for-write buffer-file-coding-system)
697
	(buffer-undo-list t))
698 699 700
    (apply 'call-process-region (point-min) (point-max)
	   (expand-file-name hexl-program exec-directory)
	   t t nil (split-string hexl-options))
701 702
    (if (> (point) (hexl-address-to-marker hexl-max-address))
	(hexl-goto-address hexl-max-address))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
703 704

(defun dehexlify-buffer ()
705 706
  "Convert a hexl format buffer to binary.
This discards the buffer's undo information."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
707
  (interactive)
708 709 710 711
  (and buffer-undo-list
       (or (y-or-n-p "Converting from hexl format discards undo info; ok? ")
	   (error "Aborted")))
  (setq buffer-undo-list nil)
712
  (let ((coding-system-for-write 'raw-text)
713
	(coding-system-for-read buffer-file-coding-system)
714
	(buffer-undo-list t))
715 716 717
    (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
718 719 720

(defun hexl-char-after-point ()
  "Return char for ASCII hex digits at point."
721 722
  (hexl-htoi (char-after (point))
	     (char-after (1+ (point)))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
723 724 725 726 727 728 729 730 731 732 733 734 735

(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
736
	(error "Invalid hex digit `%c'" ch)))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
737 738 739 740 741

(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
742
    (error "Invalid octal digit `%c'" character)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
743 744 745 746 747 748 749 750 751 752 753

(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))))

754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
(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))
		    default-buffer-file-coding-system
		  buffer-file-coding-system)))
    (cond ((and (> ch 0) (< ch 256))
	   (hexl-insert-char ch num))
	  ((eq charset 'unknown)
	   (error
769
	    "0x%x -- invalid character code; use \\[hexl-insert-hex-string]"
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
	    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
789
		  "Can't encode `0x%x' with this buffer's coding system; try \\[hexl-insert-hex-string]"
790 791 792 793 794 795
		  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
796
(defun hexl-self-insert-command (arg)
797 798 799 800 801
  "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
802
  (interactive "p")
803
  (hexl-insert-multibyte-char last-command-char arg))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
804 805

(defun hexl-insert-char (ch num)
806 807 808 809
  "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))
810
      (error "Invalid character 0x%x -- must be in the range [0..255]" ch))
811
  (let ((address (hexl-current-address t)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
812
    (while (> num 0)
813 814
      (let ((hex-position
	     (+ (* (/ address 16) 68)
815
		10 (point-min)
816 817 818
		(* 2 (% address 16))
		(/ (% address 16) 2)))
	    (ascii-position
819
	     (+ (* (/ address 16) 68) 51 (point-min) (% address 16)))
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
	    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
837 838 839 840 841
      (setq num (1- num)))))

;; hex conversion

(defun hexl-insert-hex-char (arg)
842
  "Insert a character given by its hexadecimal code ARG times at point."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
843 844
  (interactive "p")
  (let ((num (hexl-hex-string-to-integer (read-string "Hex number: "))))
845
    (if (< num 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
846
	(error "Hex number out of range")
847
      (hexl-insert-multibyte-char num arg))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
848

849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
(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
874
(defun hexl-insert-decimal-char (arg)
875
  "Insert a character given by its decimal code ARG times at point."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
876 877
  (interactive "p")
  (let ((num (string-to-int (read-string "Decimal Number: "))))
878
    (if (< num 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
879
	(error "Decimal number out of range")
880
      (hexl-insert-multibyte-char num arg))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
881 882

(defun hexl-insert-octal-char (arg)
883
  "Insert a character given by its octal code ARG times at point."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
884 885
  (interactive "p")
  (let ((num (hexl-octal-string-to-integer (read-string "Octal Number: "))))
886
    (if (< num 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
887
	(error "Decimal number out of range")
888
      (hexl-insert-multibyte-char num arg))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
889

890 891 892 893 894 895 896
(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")
897
  (let ((on-p (if arg
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
		  (> (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)
	    )))))

918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
(defun hexl-activate-ruler ()
  "Activate `ruler-mode'"
  (require 'ruler-mode)
  (set (make-local-variable 'ruler-mode-ruler-function) 
       'hexl-mode-ruler)
  (ruler-mode 1))

(defun hexl-follow-line ()
  "Activate `hl-line-mode'"
  (require 'frame)
  (require 'hl-line)
  (set (make-local-variable 'hl-line-range-function)
       'hexl-highlight-line-range)
  (set (make-local-variable 'hl-line-face) 
       'highlight)
  (hl-line-mode 1))

(defun hexl-highlight-line-range ()
  "Return the range of address area for the point.
This function is assumed to be used as call back function for `hl-line-mode'."
  (cons
   (line-beginning-position)
   ;; 9 stands for (length "87654321:")
   (+ (line-beginning-position) 9)))

943 944
(defun hexl-follow-ascii-find ()
  "Find and highlight the ASCII element corresponding to current point."
945
  (let ((pos (+ 51
946 947 948 949 950
		(- (point) (current-column))
		(mod (hexl-current-address) 16))))
    (move-overlay hexl-ascii-overlay pos (1+ pos))
    ))

951 952 953
(defun hexl-mode-ruler ()
  "Return a string ruler for hexl mode."
  (let* ((highlight (mod (hexl-current-address) 16))
954 955
	 (s " 87654321  0011 2233 4455 6677 8899 aabb ccdd eeff  0123456789abcdef")
	 (pos 0))
956 957 958 959 960 961 962
    (set-text-properties 0 (length s) nil s)
    ;; Turn spaces in the header into stretch specs so they work
    ;; regardless of the header-line face.
    (while (string-match "[ \t]+" s pos)
      (setq pos (match-end 0))
      (put-text-property (match-beginning 0) pos 'display
			 ;; Assume fixed-size chars
963
			 `(space :align-to ,(1- pos))
964 965
			 s))
    ;; Highlight the current column.
966 967
    (put-text-property (+ 11 (/ (* 5 highlight) 2))
		       (+ 13 (/ (* 5 highlight) 2))
968 969
		       'face 'highlight s)
    ;; Highlight the current ascii column
970
    (put-text-property (+ 13 39 highlight) (+ 13 40 highlight)
971
		       'face 'highlight s)
972
    s))
973

Joseph Arceneaux's avatar
Joseph Arceneaux committed
974 975 976 977
;; startup stuff.

(if hexl-mode-map
    nil
978
  (setq hexl-mode-map (make-keymap))
979 980 981
  ;; 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.
982
  (define-key hexl-mode-map [remap self-insert-command] 'hexl-self-insert-command)
983

984
  (define-key hexl-mode-map "\C-m" 'hexl-self-insert-command)
985 986 987 988 989 990 991 992
  (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)
993 994 995 996
  (define-key hexl-mode-map [home] 'hexl-beginning-of-line)
  (define-key hexl-mode-map [end] 'hexl-end-of-line)
  (define-key hexl-mode-map [C-home] 'hexl-beginning-of-buffer)
  (define-key hexl-mode-map [C-end] 'hexl-end-of-buffer)
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
  (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-k" 'undefined)
  (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)

1022 1023
  (fset 'hexl-ESC-prefix (copy-keymap 'ESC-prefix))
  (define-key hexl-mode-map "\e" 'hexl-ESC-prefix)
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
  (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-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-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-o" 'hexl-insert-octal-char)
  (define-key hexl-mode-map "\e\C-q" 'undefined)
  (define-key hexl-mode-map "\e\C-t" 'undefined)
  (define-key hexl-mode-map "\e\C-x" 'hexl-insert-hex-char)
  (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 "\ef" 'hexl-forward-word)
  (define-key hexl-mode-map "\eg" 'hexl-goto-hex-address)
  (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 "\eq" '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)

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

1059 1060
  (fset 'hexl-C-x-prefix (copy-keymap 'Control-X-prefix))
  (define-key hexl-mode-map "\C-x" 'hexl-C-x-prefix)
1061 1062 1063 1064 1065
  (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
1066

Richard M. Stallman's avatar
Richard M. Stallman committed
1067 1068
(provide 'hexl)

Miles Bader's avatar
Miles Bader committed
1069
;;; arch-tag: d5a7aa8a-9bce-480b-bcff-6c4c7ca5ea4a
Eric S. Raymond's avatar
Eric S. Raymond committed
1070
;;; hexl.el ends here