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