*** empty log message ***
[emacs.git] / lisp / hexl.el
blobaca123a0adef56dd64ae16430f540e4351d2d96f
1 ;;; hexl.el --- edit a file in a hex dump format using the hexl filter.
3 ;; Copyright (C) 1989, 1994, 1998 Free Software Foundation, Inc.
5 ;; Author: Keith Gabryelski <ag@wheaties.ai.mit.edu>
6 ;; Maintainer: FSF
7 ;; Keywords: data
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Commentary:
28 ;; This package implements a major mode for editing binary files. It uses
29 ;; a program called hexl, supplied with the GNU Emacs distribution, that
30 ;; can filter a binary into an editable format or from the format back into
31 ;; binary. For full instructions, invoke `hexl-mode' on an empty buffer and
32 ;; do `M-x describe-mode'.
34 ;; This may be useful in your .emacs:
36 ;; (autoload 'hexl-find-file "hexl"
37 ;; "Edit file FILENAME in hexl-mode." t)
38 ;;
39 ;; (define-key global-map "\C-c\C-h" 'hexl-find-file)
41 ;; NOTE: Remember to change HEXL-PROGRAM or HEXL-OPTIONS if needed.
43 ;; Currently hexl only supports big endian hex output with 16 bit
44 ;; grouping.
46 ;; -iso in `hexl-options' will allow iso characters to display in the
47 ;; ASCII region of the screen (if your emacs supports this) instead of
48 ;; changing them to dots.
50 ;;; Code:
53 ;; vars here
56 (defgroup hexl nil
57 "Edit a file in a hex dump format using the hexl filter."
58 :group 'data)
61 (defcustom hexl-program "hexl"
62 "The program that will hexlify and dehexlify its stdin.
63 `hexl-program' will always be concatenated with `hexl-options'
64 and \"-de\" when dehexlifying a buffer."
65 :type 'string
66 :group 'hexl)
68 (defcustom hexl-iso ""
69 "If your emacs can handle ISO characters, this should be set to
70 \"-iso\" otherwise it should be \"\"."
71 :type 'string
72 :group 'hexl)
74 (defcustom hexl-options (format "-hex %s" hexl-iso)
75 "Options to hexl-program that suit your needs."
76 :type 'string
77 :group 'hexl)
79 (defcustom hexlify-command
80 (format "%s %s"
81 (shell-quote-argument
82 (expand-file-name hexl-program exec-directory))
83 hexl-options)
84 "The command to use to hexlify a buffer."
85 :type 'string
86 :group 'hexl)
88 (defcustom dehexlify-command
89 (format "%s -de %s"
90 (shell-quote-argument
91 (expand-file-name hexl-program exec-directory))
92 hexl-options)
93 "The command to use to unhexlify a buffer."
94 :type 'string
95 :group 'hexl)
97 (defcustom hexl-follow-ascii t
98 "If non-nil then highlight the ASCII character corresponding to point."
99 :type 'boolean
100 :group 'hexl
101 :version "20.3")
103 (defvar hexl-max-address 0
104 "Maximum offset into hexl buffer.")
106 (defvar hexl-mode-map nil)
108 (defvar hexl-mode-old-local-map)
109 (defvar hexl-mode-old-mode-name)
110 (defvar hexl-mode-old-major-mode)
111 (defvar hexl-mode-old-write-contents-hooks)
112 (defvar hexl-mode-old-require-final-newline)
113 (defvar hexl-mode-old-syntax-table)
115 (defvar hexl-ascii-overlay nil
116 "Overlay used to highlight ASCII element corresponding to current point.")
117 (make-variable-buffer-local 'hexl-ascii-overlay)
119 ;; routines
121 (put 'hexl-mode 'mode-class 'special)
123 ;;;###autoload
124 (defun hexl-mode (&optional arg)
125 "\\<hexl-mode-map>A mode for editing binary files in hex dump format.
126 This is not an ordinary major mode; it alters some aspects
127 if the current mode's behavior, but not all; also, you can exit
128 Hexl mode and return to the previous mode using `hexl-mode-exit'.
130 This function automatically converts a buffer into the hexl format
131 using the function `hexlify-buffer'.
133 Each line in the buffer has an \"address\" (displayed in hexadecimal)
134 representing the offset into the file that the characters on this line
135 are at and 16 characters from the file (displayed as hexadecimal
136 values grouped every 16 bits) and as their ASCII values.
138 If any of the characters (displayed as ASCII characters) are
139 unprintable (control or meta characters) they will be replaced as
140 periods.
142 If `hexl-mode' is invoked with an argument the buffer is assumed to be
143 in hexl format.
145 A sample format:
147 HEX ADDR: 0001 0203 0405 0607 0809 0a0b 0c0d 0e0f ASCII-TEXT
148 -------- ---- ---- ---- ---- ---- ---- ---- ---- ----------------
149 00000000: 5468 6973 2069 7320 6865 786c 2d6d 6f64 This is hexl-mod
150 00000010: 652e 2020 4561 6368 206c 696e 6520 7265 e. Each line re
151 00000020: 7072 6573 656e 7473 2031 3620 6279 7465 presents 16 byte
152 00000030: 7320 6173 2068 6578 6164 6563 696d 616c s as hexadecimal
153 00000040: 2041 5343 4949 0a61 6e64 2070 7269 6e74 ASCII.and print
154 00000050: 6162 6c65 2041 5343 4949 2063 6861 7261 able ASCII chara
155 00000060: 6374 6572 732e 2020 416e 7920 636f 6e74 cters. Any cont
156 00000070: 726f 6c20 6f72 206e 6f6e 2d41 5343 4949 rol or non-ASCII
157 00000080: 2063 6861 7261 6374 6572 730a 6172 6520 characters.are
158 00000090: 6469 7370 6c61 7965 6420 6173 2070 6572 displayed as per
159 000000a0: 696f 6473 2069 6e20 7468 6520 7072 696e iods in the prin
160 000000b0: 7461 626c 6520 6368 6172 6163 7465 7220 table character
161 000000c0: 7265 6769 6f6e 2e0a region..
163 Movement is as simple as movement in a normal emacs text buffer. Most
164 cursor movement bindings are the same (ie. Use \\[hexl-backward-char], \\[hexl-forward-char], \\[hexl-next-line], and \\[hexl-previous-line]
165 to move the cursor left, right, down, and up).
167 Advanced cursor movement commands (ala \\[hexl-beginning-of-line], \\[hexl-end-of-line], \\[hexl-beginning-of-buffer], and \\[hexl-end-of-buffer]) are
168 also supported.
170 There are several ways to change text in hexl mode:
172 ASCII characters (character between space (0x20) and tilde (0x7E)) are
173 bound to self-insert so you can simply type the character and it will
174 insert itself (actually overstrike) into the buffer.
176 \\[hexl-quoted-insert] followed by another keystroke allows you to insert the key even if
177 it isn't bound to self-insert. An octal number can be supplied in place
178 of another key to insert the octal number's ASCII representation.
180 \\[hexl-insert-hex-char] will insert a given hexadecimal value (if it is between 0 and 0xFF)
181 into the buffer at the current point.
183 \\[hexl-insert-octal-char] will insert a given octal value (if it is between 0 and 0377)
184 into the buffer at the current point.
186 \\[hexl-insert-decimal-char] will insert a given decimal value (if it is between 0 and 255)
187 into the buffer at the current point.
189 \\[hexl-mode-exit] will exit hexl-mode.
191 Note: saving the file with any of the usual Emacs commands
192 will actually convert it back to binary format while saving.
194 You can use \\[hexl-find-file] to visit a file in Hexl mode.
196 \\[describe-bindings] for advanced commands."
197 (interactive "p")
198 (unless (eq major-mode 'hexl-mode)
199 (let ((modified (buffer-modified-p))
200 (inhibit-read-only t)
201 (original-point (1- (point)))
202 max-address)
203 (and (eobp) (not (bobp))
204 (setq original-point (1- original-point)))
205 (if (not (or (eq arg 1) (not arg)))
206 ;; if no argument then we guess at hexl-max-address
207 (setq max-address (+ (* (/ (1- (buffer-size)) 68) 16) 15))
208 (setq max-address (1- (buffer-size)))
209 (hexlify-buffer)
210 (set-buffer-modified-p modified))
211 (make-local-variable 'hexl-max-address)
212 (setq hexl-max-address max-address)
213 (hexl-goto-address original-point))
215 ;; We do not turn off the old major mode; instead we just
216 ;; override most of it. That way, we can restore it perfectly.
217 (make-local-variable 'hexl-mode-old-local-map)
218 (setq hexl-mode-old-local-map (current-local-map))
219 (use-local-map hexl-mode-map)
221 (make-local-variable 'hexl-mode-old-mode-name)
222 (setq hexl-mode-old-mode-name mode-name)
223 (setq mode-name "Hexl")
225 (make-local-variable 'hexl-mode-old-major-mode)
226 (setq hexl-mode-old-major-mode major-mode)
227 (setq major-mode 'hexl-mode)
229 (make-local-variable 'hexl-mode-old-syntax-table)
230 (setq hexl-mode-old-syntax-table (syntax-table))
231 (set-syntax-table (standard-syntax-table))
233 (make-local-variable 'hexl-mode-old-write-contents-hooks)
234 (setq hexl-mode-old-write-contents-hooks write-contents-hooks)
235 (make-local-variable 'write-contents-hooks)
236 (add-hook 'write-contents-hooks 'hexl-save-buffer)
238 (make-local-variable 'hexl-mode-old-require-final-newline)
239 (setq hexl-mode-old-require-final-newline require-final-newline)
240 (make-local-variable 'require-final-newline)
241 (setq require-final-newline nil)
243 ;; Add hooks to rehexlify or dehexlify on various events.
244 (make-local-hook 'after-revert-hook)
245 (add-hook 'after-revert-hook 'hexl-after-revert-hook nil t)
247 (make-local-hook 'change-major-mode-hook)
248 (add-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer nil t)
250 (if hexl-follow-ascii (hexl-follow-ascii 1)))
251 (run-hooks 'hexl-mode-hook))
253 (defun hexl-after-revert-hook ()
254 (setq hexl-max-address (1- (buffer-size)))
255 (hexlify-buffer)
256 (set-buffer-modified-p nil))
258 (defvar hexl-in-save-buffer nil)
260 (defun hexl-save-buffer ()
261 "Save a hexl format buffer as binary in visited file if modified."
262 (interactive)
263 (if hexl-in-save-buffer nil
264 (set-buffer-modified-p (if (buffer-modified-p)
265 (save-excursion
266 (let ((buf (generate-new-buffer " hexl"))
267 (name (buffer-name))
268 (file-name (buffer-file-name))
269 (start (point-min))
270 (end (point-max))
271 modified)
272 (set-buffer buf)
273 (insert-buffer-substring name start end)
274 (set-buffer name)
275 (dehexlify-buffer)
276 ;; Prevent infinite recursion.
277 (let ((hexl-in-save-buffer t))
278 (save-buffer))
279 (setq modified (buffer-modified-p))
280 (delete-region (point-min) (point-max))
281 (insert-buffer-substring buf start end)
282 (kill-buffer buf)
283 modified))
284 (message "(No changes need to be saved)")
285 nil))
286 ;; Return t to indicate we have saved t
289 ;;;###autoload
290 (defun hexl-find-file (filename)
291 "Edit file FILENAME in hexl-mode.
292 Switch to a buffer visiting file FILENAME, creating one in none exists."
293 (interactive "fFilename: ")
294 (find-file-literally filename)
295 (if (not (eq major-mode 'hexl-mode))
296 (hexl-mode)))
298 (defun hexl-mode-exit (&optional arg)
299 "Exit Hexl mode, returning to previous mode.
300 With arg, don't unhexlify buffer."
301 (interactive "p")
302 (if (or (eq arg 1) (not arg))
303 (let ((modified (buffer-modified-p))
304 (inhibit-read-only t)
305 (original-point (1+ (hexl-current-address))))
306 (dehexlify-buffer)
307 (remove-hook 'write-contents-hooks 'hexl-save-buffer)
308 (set-buffer-modified-p modified)
309 (goto-char original-point)))
311 (remove-hook 'after-revert-hook 'hexl-after-revert-hook t)
312 (remove-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer t)
313 (remove-hook 'post-command-hook 'hexl-follow-ascii-find t)
314 (setq hexl-ascii-overlay nil)
316 (setq write-contents-hooks hexl-mode-old-write-contents-hooks)
317 (setq require-final-newline hexl-mode-old-require-final-newline)
318 (setq mode-name hexl-mode-old-mode-name)
319 (use-local-map hexl-mode-old-local-map)
320 (set-syntax-table hexl-mode-old-syntax-table)
321 (setq major-mode hexl-mode-old-major-mode)
322 (force-mode-line-update))
324 (defun hexl-maybe-dehexlify-buffer ()
325 "Convert a hexl format buffer to binary.
326 Ask the user for confirmation."
327 (if (y-or-n-p "Convert contents back to binary format? ")
328 (let ((modified (buffer-modified-p))
329 (inhibit-read-only t)
330 (original-point (1+ (hexl-current-address))))
331 (dehexlify-buffer)
332 (remove-hook 'write-contents-hooks 'hexl-save-buffer)
333 (set-buffer-modified-p modified)
334 (goto-char original-point))))
336 (defun hexl-current-address (&optional validate)
337 "Return current hexl-address."
338 (interactive)
339 (let ((current-column (- (% (point) 68) 11))
340 (hexl-address 0))
341 (if (< current-column 0)
342 (if validate
343 (error "Point is not on a character in the file")
344 (setq current-column 0)))
345 (setq hexl-address
346 (+ (* (/ (point) 68) 16)
347 (if (>= current-column 41)
348 (- current-column 41)
349 (/ (- current-column (/ current-column 5)) 2))))
350 hexl-address))
352 (defun hexl-address-to-marker (address)
353 "Return buffer position for ADDRESS."
354 (interactive "nAddress: ")
355 (+ (* (/ address 16) 68) 11 (/ (* (% address 16) 5) 2)))
357 (defun hexl-goto-address (address)
358 "Goto hexl-mode (decimal) address ADDRESS.
359 Signal error if ADDRESS out of range."
360 (interactive "nAddress: ")
361 (if (or (< address 0) (> address hexl-max-address))
362 (error "Out of hexl region"))
363 (goto-char (hexl-address-to-marker address)))
365 (defun hexl-goto-hex-address (hex-address)
366 "Go to hexl-mode address (hex string) HEX-ADDRESS.
367 Signal error if HEX-ADDRESS is out of range."
368 (interactive "sHex Address: ")
369 (hexl-goto-address (hexl-hex-string-to-integer hex-address)))
371 (defun hexl-hex-string-to-integer (hex-string)
372 "Return decimal integer for HEX-STRING."
373 (interactive "sHex number: ")
374 (let ((hex-num 0))
375 (while (not (equal hex-string ""))
376 (setq hex-num (+ (* hex-num 16)
377 (hexl-hex-char-to-integer (string-to-char hex-string))))
378 (setq hex-string (substring hex-string 1)))
379 hex-num))
381 (defun hexl-octal-string-to-integer (octal-string)
382 "Return decimal integer for OCTAL-STRING."
383 (interactive "sOctal number: ")
384 (let ((oct-num 0))
385 (while (not (equal octal-string ""))
386 (setq oct-num (+ (* oct-num 8)
387 (hexl-oct-char-to-integer
388 (string-to-char octal-string))))
389 (setq octal-string (substring octal-string 1)))
390 oct-num))
392 ;; move point functions
394 (defun hexl-backward-char (arg)
395 "Move to left ARG bytes (right if ARG negative) in hexl-mode."
396 (interactive "p")
397 (hexl-goto-address (- (hexl-current-address) arg)))
399 (defun hexl-forward-char (arg)
400 "Move right ARG bytes (left if ARG negative) in hexl-mode."
401 (interactive "p")
402 (hexl-goto-address (+ (hexl-current-address) arg)))
404 (defun hexl-backward-short (arg)
405 "Move to left ARG shorts (right if ARG negative) in hexl-mode."
406 (interactive "p")
407 (hexl-goto-address (let ((address (hexl-current-address)))
408 (if (< arg 0)
409 (progn
410 (setq arg (- arg))
411 (while (> arg 0)
412 (if (not (equal address (logior address 3)))
413 (if (> address hexl-max-address)
414 (progn
415 (message "End of buffer.")
416 (setq address hexl-max-address))
417 (setq address (logior address 3)))
418 (if (> address hexl-max-address)
419 (progn
420 (message "End of buffer.")
421 (setq address hexl-max-address))
422 (setq address (+ address 4))))
423 (setq arg (1- arg)))
424 (if (> address hexl-max-address)
425 (progn
426 (message "End of buffer.")
427 (setq address hexl-max-address))
428 (setq address (logior address 3))))
429 (while (> arg 0)
430 (if (not (equal address (logand address -4)))
431 (setq address (logand address -4))
432 (if (not (equal address 0))
433 (setq address (- address 4))
434 (message "Beginning of buffer.")))
435 (setq arg (1- arg))))
436 address)))
438 (defun hexl-forward-short (arg)
439 "Move right ARG shorts (left if ARG negative) in hexl-mode."
440 (interactive "p")
441 (hexl-backward-short (- arg)))
443 (defun hexl-backward-word (arg)
444 "Move to left ARG words (right if ARG negative) in hexl-mode."
445 (interactive "p")
446 (hexl-goto-address (let ((address (hexl-current-address)))
447 (if (< arg 0)
448 (progn
449 (setq arg (- arg))
450 (while (> arg 0)
451 (if (not (equal address (logior address 7)))
452 (if (> address hexl-max-address)
453 (progn
454 (message "End of buffer.")
455 (setq address hexl-max-address))
456 (setq address (logior address 7)))
457 (if (> address hexl-max-address)
458 (progn
459 (message "End of buffer.")
460 (setq address hexl-max-address))
461 (setq address (+ address 8))))
462 (setq arg (1- arg)))
463 (if (> address hexl-max-address)
464 (progn
465 (message "End of buffer.")
466 (setq address hexl-max-address))
467 (setq address (logior address 7))))
468 (while (> arg 0)
469 (if (not (equal address (logand address -8)))
470 (setq address (logand address -8))
471 (if (not (equal address 0))
472 (setq address (- address 8))
473 (message "Beginning of buffer.")))
474 (setq arg (1- arg))))
475 address)))
477 (defun hexl-forward-word (arg)
478 "Move right ARG words (left if ARG negative) in hexl-mode."
479 (interactive "p")
480 (hexl-backward-word (- arg)))
482 (defun hexl-previous-line (arg)
483 "Move vertically up ARG lines [16 bytes] (down if ARG negative) in hexl-mode.
484 If there is byte at the target address move to the last byte in that line."
485 (interactive "p")
486 (hexl-next-line (- arg)))
488 (defun hexl-next-line (arg)
489 "Move vertically down ARG lines [16 bytes] (up if ARG negative) in hexl-mode.
490 If there is no byte at the target address move to the last byte in that line."
491 (interactive "p")
492 (hexl-goto-address (let ((address (+ (hexl-current-address) (* arg 16))))
493 (if (and (< arg 0) (< address 0))
494 (progn (message "Out of hexl region.")
495 (setq address
496 (% (hexl-current-address) 16)))
497 (if (and (> address hexl-max-address)
498 (< (% hexl-max-address 16) (% address 16)))
499 (setq address hexl-max-address)
500 (if (> address hexl-max-address)
501 (progn (message "Out of hexl region.")
502 (setq
503 address
504 (+ (logand hexl-max-address -16)
505 (% (hexl-current-address) 16)))))))
506 address)))
508 (defun hexl-beginning-of-buffer (arg)
509 "Move to the beginning of the hexl buffer.
510 Leaves `hexl-mark' at previous position.
511 With prefix arg N, puts point N bytes of the way from the true beginning."
512 (interactive "p")
513 (push-mark (point))
514 (hexl-goto-address (+ 0 (1- arg))))
516 (defun hexl-end-of-buffer (arg)
517 "Go to `hexl-max-address' minus ARG."
518 (interactive "p")
519 (push-mark (point))
520 (hexl-goto-address (- hexl-max-address (1- arg))))
522 (defun hexl-beginning-of-line ()
523 "Goto beginning of line in hexl mode."
524 (interactive)
525 (goto-char (+ (* (/ (point) 68) 68) 11)))
527 (defun hexl-end-of-line ()
528 "Goto end of line in hexl mode."
529 (interactive)
530 (hexl-goto-address (let ((address (logior (hexl-current-address) 15)))
531 (if (> address hexl-max-address)
532 (setq address hexl-max-address))
533 address)))
535 (defun hexl-scroll-down (arg)
536 "Scroll hexl buffer window upward ARG lines; or near full window if no ARG."
537 (interactive "P")
538 (if (null arg)
539 (setq arg (1- (window-height)))
540 (setq arg (prefix-numeric-value arg)))
541 (hexl-scroll-up (- arg)))
543 (defun hexl-scroll-up (arg)
544 "Scroll hexl buffer window upward ARG lines; or near full window if no ARG."
545 (interactive "P")
546 (if (null arg)
547 (setq arg (1- (window-height)))
548 (setq arg (prefix-numeric-value arg)))
549 (let ((movement (* arg 16))
550 (address (hexl-current-address)))
551 (if (or (> (+ address movement) hexl-max-address)
552 (< (+ address movement) 0))
553 (message "Out of hexl region.")
554 (hexl-goto-address (+ address movement))
555 (recenter 0))))
557 (defun hexl-beginning-of-1k-page ()
558 "Go to beginning of 1k boundary."
559 (interactive)
560 (hexl-goto-address (logand (hexl-current-address) -1024)))
562 (defun hexl-end-of-1k-page ()
563 "Go to end of 1k boundary."
564 (interactive)
565 (hexl-goto-address (let ((address (logior (hexl-current-address) 1023)))
566 (if (> address hexl-max-address)
567 (setq address hexl-max-address))
568 address)))
570 (defun hexl-beginning-of-512b-page ()
571 "Go to beginning of 512 byte boundary."
572 (interactive)
573 (hexl-goto-address (logand (hexl-current-address) -512)))
575 (defun hexl-end-of-512b-page ()
576 "Go to end of 512 byte boundary."
577 (interactive)
578 (hexl-goto-address (let ((address (logior (hexl-current-address) 511)))
579 (if (> address hexl-max-address)
580 (setq address hexl-max-address))
581 address)))
583 (defun hexl-quoted-insert (arg)
584 "Read next input character and insert it.
585 Useful for inserting control characters.
586 You may also type up to 3 octal digits, to insert a character with that code"
587 (interactive "p")
588 (hexl-insert-char (read-quoted-char) arg))
590 ;00000000: 0011 2233 4455 6677 8899 aabb ccdd eeff 0123456789ABCDEF
592 ;;;###autoload
593 (defun hexlify-buffer ()
594 "Convert a binary buffer to hexl format.
595 This discards the buffer's undo information."
596 (interactive)
597 (and buffer-undo-list
598 (or (y-or-n-p "Converting to hexl format discards undo info; ok? ")
599 (error "Aborted")))
600 (setq buffer-undo-list nil)
601 ;; Don't decode text in the ASCII part of `hexl' program output.
602 (let ((coding-system-for-read 'raw-text)
603 ;; If the buffer was read with EOL conversions, be sure to use the
604 ;; same conversions when passing the region to the `hexl' program.
605 (coding-system-for-write
606 (let ((eol-type (coding-system-eol-type buffer-file-coding-system)))
607 (cond ((eq eol-type 1)
608 'raw-text-dos)
609 ((eq eol-type 2)
610 'raw-text-mac)
611 ((eq eol-type 0)
612 'raw-text-unix)
613 (t 'no-conversion))))
614 (buffer-undo-list t))
615 (shell-command-on-region (point-min) (point-max) hexlify-command t)
616 (if (> (point) (hexl-address-to-marker hexl-max-address))
617 (hexl-goto-address hexl-max-address))))
619 (defun dehexlify-buffer ()
620 "Convert a hexl format buffer to binary.
621 This discards the buffer's undo information."
622 (interactive)
623 (and buffer-undo-list
624 (or (y-or-n-p "Converting from hexl format discards undo info; ok? ")
625 (error "Aborted")))
626 (setq buffer-undo-list nil)
627 (let ((coding-system-for-write 'raw-text)
628 (coding-system-for-read
629 (let ((eol-type (coding-system-eol-type buffer-file-coding-system)))
630 (cond ((eq eol-type 1)
631 'raw-text-dos)
632 ((eq eol-type 2)
633 'raw-text-mac)
634 ((eq eol-type 0)
635 'raw-text-unix)
636 (t 'no-conversion))))
637 (buffer-undo-list t))
638 (shell-command-on-region (point-min) (point-max) dehexlify-command t)))
640 (defun hexl-char-after-point ()
641 "Return char for ASCII hex digits at point."
642 (hexl-htoi (char-after (point))
643 (char-after (1+ (point)))))
645 (defun hexl-htoi (lh rh)
646 "Hex (char) LH (char) RH to integer."
647 (+ (* (hexl-hex-char-to-integer lh) 16)
648 (hexl-hex-char-to-integer rh)))
650 (defun hexl-hex-char-to-integer (character)
651 "Take a char and return its value as if it was a hex digit."
652 (if (and (>= character ?0) (<= character ?9))
653 (- character ?0)
654 (let ((ch (logior character 32)))
655 (if (and (>= ch ?a) (<= ch ?f))
656 (- ch (- ?a 10))
657 (error "Invalid hex digit `%c'" ch)))))
659 (defun hexl-oct-char-to-integer (character)
660 "Take a char and return its value as if it was a octal digit."
661 (if (and (>= character ?0) (<= character ?7))
662 (- character ?0)
663 (error "Invalid octal digit `%c'" character)))
665 (defun hexl-printable-character (ch)
666 "Return a displayable string for character CH."
667 (format "%c" (if hexl-iso
668 (if (or (< ch 32) (and (>= ch 127) (< ch 160)))
671 (if (or (< ch 32) (>= ch 127))
673 ch))))
675 (defun hexl-self-insert-command (arg)
676 "Insert this character."
677 (interactive "p")
678 (hexl-insert-char last-command-char arg))
680 (defun hexl-insert-char (ch num)
681 "Insert a character in a hexl buffer."
682 (let ((address (hexl-current-address t)))
683 (while (> num 0)
684 (let ((hex-position
685 (+ (* (/ address 16) 68)
687 (* 2 (% address 16))
688 (/ (% address 16) 2)))
689 (ascii-position
690 (+ (* (/ address 16) 68) 52 (% address 16)))
691 at-ascii-position)
692 (if (= (point) ascii-position)
693 (setq at-ascii-position t))
694 (goto-char hex-position)
695 (delete-char 2)
696 (insert (format "%02x" ch))
697 (goto-char ascii-position)
698 (delete-char 1)
699 (insert (hexl-printable-character ch))
700 (or (eq address hexl-max-address)
701 (setq address (1+ address)))
702 (hexl-goto-address address)
703 (if at-ascii-position
704 (progn
705 (beginning-of-line)
706 (forward-char 51)
707 (forward-char (% address 16)))))
708 (setq num (1- num)))))
710 ;; hex conversion
712 (defun hexl-insert-hex-char (arg)
713 "Insert a ASCII char ARG times at point for a given hexadecimal number."
714 (interactive "p")
715 (let ((num (hexl-hex-string-to-integer (read-string "Hex number: "))))
716 (if (or (> num 255) (< num 0))
717 (error "Hex number out of range")
718 (hexl-insert-char num arg))))
720 (defun hexl-insert-hex-string (str arg)
721 "Insert hexadecimal string STR at point ARG times.
722 Embedded whitespace, dashes, and periods in the string are ignored."
723 (interactive "sHex string: \np")
724 (setq str (replace-regexp-in-string "[- \t.]" "" str))
725 (let ((chars '()))
726 (let ((len (length str))
727 (idx 0))
728 (if (eq (logand len 1) 1)
729 (let ((num (hexl-hex-string-to-integer (substring str 0 1))))
730 (setq chars (cons num chars))
731 (setq idx 1)))
732 (while (< idx len)
733 (let* ((nidx (+ idx 2))
734 (num (hexl-hex-string-to-integer (substring str idx nidx))))
735 (setq chars (cons num chars))
736 (setq idx nidx))))
737 (setq chars (nreverse chars))
738 (while (> arg 0)
739 (let ((chars chars))
740 (while chars
741 (hexl-insert-char (car chars) 1)
742 (setq chars (cdr chars))))
743 (setq arg (- arg 1)))))
745 (defun hexl-insert-decimal-char (arg)
746 "Insert a ASCII char ARG times at point for a given decimal number."
747 (interactive "p")
748 (let ((num (string-to-int (read-string "Decimal Number: "))))
749 (if (or (> num 255) (< num 0))
750 (error "Decimal number out of range")
751 (hexl-insert-char num arg))))
753 (defun hexl-insert-octal-char (arg)
754 "Insert a ASCII char ARG times at point for a given octal number."
755 (interactive "p")
756 (let ((num (hexl-octal-string-to-integer (read-string "Octal Number: "))))
757 (if (or (> num 255) (< num 0))
758 (error "Decimal number out of range")
759 (hexl-insert-char num arg))))
761 (defun hexl-follow-ascii (&optional arg)
762 "Toggle following ASCII in Hexl buffers.
763 With prefix ARG, turn on following if and only if ARG is positive.
764 When following is enabled, the ASCII character corresponding to the
765 element under the point is highlighted.
766 Customize the variable `hexl-follow-ascii' to disable this feature."
767 (interactive "P")
768 (let ((on-p (if arg
769 (> (prefix-numeric-value arg) 0)
770 (not hexl-ascii-overlay))))
772 (make-local-hook 'post-command-hook)
774 (if on-p
775 ;; turn it on
776 (if (not hexl-ascii-overlay)
777 (progn
778 (setq hexl-ascii-overlay (make-overlay 1 1)
779 hexl-follow-ascii t)
780 (overlay-put hexl-ascii-overlay 'face 'highlight)
781 (add-hook 'post-command-hook 'hexl-follow-ascii-find nil t)))
782 ;; turn it off
783 (if hexl-ascii-overlay
784 (progn
785 (delete-overlay hexl-ascii-overlay)
786 (setq hexl-ascii-overlay nil
787 hexl-follow-ascii nil)
788 (remove-hook 'post-command-hook 'hexl-follow-ascii-find t)
789 )))))
791 (defun hexl-follow-ascii-find ()
792 "Find and highlight the ASCII element corresponding to current point."
793 (let ((pos (+ 51
794 (- (point) (current-column))
795 (mod (hexl-current-address) 16))))
796 (move-overlay hexl-ascii-overlay pos (1+ pos))
799 ;; startup stuff.
801 (if hexl-mode-map
803 (setq hexl-mode-map (make-sparse-keymap))
805 (define-key hexl-mode-map [left] 'hexl-backward-char)
806 (define-key hexl-mode-map [right] 'hexl-forward-char)
807 (define-key hexl-mode-map [up] 'hexl-previous-line)
808 (define-key hexl-mode-map [down] 'hexl-next-line)
809 (define-key hexl-mode-map [M-left] 'hexl-backward-short)
810 (define-key hexl-mode-map [M-right] 'hexl-forward-short)
811 (define-key hexl-mode-map [next] 'hexl-scroll-up)
812 (define-key hexl-mode-map [prior] 'hexl-scroll-down)
813 (define-key hexl-mode-map [home] 'hexl-beginning-of-buffer)
814 (define-key hexl-mode-map [deletechar] 'undefined)
815 (define-key hexl-mode-map [deleteline] 'undefined)
816 (define-key hexl-mode-map [insertline] 'undefined)
817 (define-key hexl-mode-map [S-delete] 'undefined)
818 (define-key hexl-mode-map "\177" 'undefined)
820 (define-key hexl-mode-map "\C-a" 'hexl-beginning-of-line)
821 (define-key hexl-mode-map "\C-b" 'hexl-backward-char)
822 (define-key hexl-mode-map "\C-d" 'undefined)
823 (define-key hexl-mode-map "\C-e" 'hexl-end-of-line)
824 (define-key hexl-mode-map "\C-f" 'hexl-forward-char)
826 (if (not (eq (key-binding (char-to-string help-char)) 'help-command))
827 (define-key hexl-mode-map (char-to-string help-char) 'undefined))
829 (define-key hexl-mode-map "\C-i" 'hexl-self-insert-command)
830 (define-key hexl-mode-map "\C-j" 'hexl-self-insert-command)
831 (define-key hexl-mode-map "\C-k" 'undefined)
832 (define-key hexl-mode-map "\C-m" 'hexl-self-insert-command)
833 (define-key hexl-mode-map "\C-n" 'hexl-next-line)
834 (define-key hexl-mode-map "\C-o" 'undefined)
835 (define-key hexl-mode-map "\C-p" 'hexl-previous-line)
836 (define-key hexl-mode-map "\C-q" 'hexl-quoted-insert)
837 (define-key hexl-mode-map "\C-t" 'undefined)
838 (define-key hexl-mode-map "\C-v" 'hexl-scroll-up)
839 (define-key hexl-mode-map "\C-w" 'undefined)
840 (define-key hexl-mode-map "\C-y" 'undefined)
842 (let ((ch 32))
843 (while (< ch 127)
844 (define-key hexl-mode-map (format "%c" ch) 'hexl-self-insert-command)
845 (setq ch (1+ ch))))
847 (define-key hexl-mode-map "\e\C-a" 'hexl-beginning-of-512b-page)
848 (define-key hexl-mode-map "\e\C-b" 'hexl-backward-short)
849 (define-key hexl-mode-map "\e\C-d" 'hexl-insert-decimal-char)
850 (define-key hexl-mode-map "\e\C-e" 'hexl-end-of-512b-page)
851 (define-key hexl-mode-map "\e\C-f" 'hexl-forward-short)
852 (define-key hexl-mode-map "\e\C-i" 'undefined)
853 (define-key hexl-mode-map "\e\C-j" 'undefined)
854 (define-key hexl-mode-map "\e\C-k" 'undefined)
855 (define-key hexl-mode-map "\e\C-o" 'hexl-insert-octal-char)
856 (define-key hexl-mode-map "\e\C-q" 'undefined)
857 (define-key hexl-mode-map "\e\C-t" 'undefined)
858 (define-key hexl-mode-map "\e\C-x" 'hexl-insert-hex-char)
859 (define-key hexl-mode-map "\eb" 'hexl-backward-word)
860 (define-key hexl-mode-map "\ec" 'undefined)
861 (define-key hexl-mode-map "\ed" 'undefined)
862 (define-key hexl-mode-map "\ef" 'hexl-forward-word)
863 (define-key hexl-mode-map "\eg" 'hexl-goto-hex-address)
864 (define-key hexl-mode-map "\ei" 'undefined)
865 (define-key hexl-mode-map "\ej" 'hexl-goto-address)
866 (define-key hexl-mode-map "\ek" 'undefined)
867 (define-key hexl-mode-map "\el" 'undefined)
868 (define-key hexl-mode-map "\eq" 'undefined)
869 (define-key hexl-mode-map "\es" 'undefined)
870 (define-key hexl-mode-map "\et" 'undefined)
871 (define-key hexl-mode-map "\eu" 'undefined)
872 (define-key hexl-mode-map "\ev" 'hexl-scroll-down)
873 (define-key hexl-mode-map "\ey" 'undefined)
874 (define-key hexl-mode-map "\ez" 'undefined)
875 (define-key hexl-mode-map "\e<" 'hexl-beginning-of-buffer)
876 (define-key hexl-mode-map "\e>" 'hexl-end-of-buffer)
878 (define-key hexl-mode-map "\C-c\C-c" 'hexl-mode-exit)
880 (define-key hexl-mode-map "\C-x[" 'hexl-beginning-of-1k-page)
881 (define-key hexl-mode-map "\C-x]" 'hexl-end-of-1k-page)
882 (define-key hexl-mode-map "\C-x\C-p" 'undefined)
883 (define-key hexl-mode-map "\C-x\C-s" 'hexl-save-buffer)
884 (define-key hexl-mode-map "\C-x\C-t" 'undefined))
886 (provide 'hexl)
888 ;;; hexl.el ends here