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,
4 ;; 2005, 2006 Free Software Foundation, Inc.
6 ;; Author: Keith Gabryelski <ag@wheaties.ai.mit.edu>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
29 ;; This package implements a major mode for editing binary files. It uses
30 ;; a program called hexl, supplied with the GNU Emacs distribution, that
31 ;; can filter a binary into an editable format or from the format back into
32 ;; binary. For full instructions, invoke `hexl-mode' on an empty buffer and
33 ;; do M-x `describe-mode'.
35 ;; NOTE: Remember to change `hexl-program' or `hexl-options' if needed.
37 ;; Currently hexl only supports big endian hex output with 16 bit
40 ;; -iso in `hexl-options' will allow iso characters to display in the
41 ;; ASCII region of the screen (if your Emacs supports this) instead of
42 ;; changing them to dots.
53 "Edit a file in a hex dump format using the hexl filter."
57 (defcustom hexl-program
"hexl"
58 "The program that will hexlify and dehexlify its stdin.
59 `hexl-program' will always be concatenated with `hexl-options'
60 and \"-de\" when dehexlifying a buffer."
64 (defcustom hexl-iso
""
65 "If your Emacs can handle ISO characters, this should be set to
66 \"-iso\" otherwise it should be \"\"."
70 (defcustom hexl-options
(format "-hex %s" hexl-iso
)
71 "Space separated options to `hexl-program' that suit your needs.
72 Quoting cannot be used, so the arguments cannot themselves contain spaces."
76 (defcustom hexl-follow-ascii t
77 "If non-nil then highlight the ASCII character corresponding to point."
82 (defcustom hexl-mode-hook
'(hexl-follow-line hexl-activate-ruler
)
83 "Normal hook run when entering Hexl mode."
85 :options
'(hexl-follow-line hexl-activate-ruler turn-on-eldoc-mode
)
88 (defface hexl-address-region
89 '((t (:inherit header-line
)))
90 "Face used in address area of hexl-mode buffer."
93 (defface hexl-ascii-region
94 '((t (:inherit header-line
)))
95 "Face used in ascii area of hexl-mode buffer."
98 (defvar hexl-max-address
0
99 "Maximum offset into hexl buffer.")
101 (defvar hexl-mode-map nil
)
103 ;; Variable declarations for suppressing warnings from the byte-compiler.
105 (defvar ruler-mode-ruler-function
)
106 (defvar hl-line-mode
)
107 (defvar hl-line-range-function
)
108 (defvar hl-line-face
)
110 ;; Variables where the original values are stored to.
111 (defvar hexl-mode-old-hl-line-mode
)
112 (defvar hexl-mode-old-hl-line-range-function
)
113 (defvar hexl-mode-old-hl-line-face
)
114 (defvar hexl-mode-old-local-map
)
115 (defvar hexl-mode-old-mode-name
)
116 (defvar hexl-mode-old-major-mode
)
117 (defvar hexl-mode-old-ruler-mode
)
118 (defvar hexl-mode-old-ruler-function
)
119 (defvar hexl-mode-old-isearch-search-fun-function
)
120 (defvar hexl-mode-old-require-final-newline
)
121 (defvar hexl-mode-old-syntax-table
)
122 (defvar hexl-mode-old-font-lock-keywords
)
124 (defvar hexl-ascii-overlay nil
125 "Overlay used to highlight ASCII element corresponding to current point.")
126 (make-variable-buffer-local 'hexl-ascii-overlay
)
128 (defvar hexl-font-lock-keywords
129 '(("^\\([0-9a-f]+:\\).\\{40\\} \\(.+$\\)"
130 ;; "^\\([0-9a-f]+:\\).+ \\(.+$\\)"
131 (1 'hexl-address-region t t
)
132 (2 'hexl-ascii-region t t
)))
133 "Font lock keywords used in `hexl-mode'.")
137 (put 'hexl-mode
'mode-class
'special
)
140 (defun hexl-mode (&optional arg
)
141 "\\<hexl-mode-map>A mode for editing binary files in hex dump format.
142 This is not an ordinary major mode; it alters some aspects
143 of the current mode's behavior, but not all; also, you can exit
144 Hexl mode and return to the previous mode using `hexl-mode-exit'.
146 This function automatically converts a buffer into the hexl format
147 using the function `hexlify-buffer'.
149 Each line in the buffer has an \"address\" (displayed in hexadecimal)
150 representing the offset into the file that the characters on this line
151 are at and 16 characters from the file (displayed as hexadecimal
152 values grouped every 16 bits) and as their ASCII values.
154 If any of the characters (displayed as ASCII characters) are
155 unprintable (control or meta characters) they will be replaced as
158 If `hexl-mode' is invoked with an argument the buffer is assumed to be
163 HEX ADDR: 0001 0203 0405 0607 0809 0a0b 0c0d 0e0f ASCII-TEXT
164 -------- ---- ---- ---- ---- ---- ---- ---- ---- ----------------
165 00000000: 5468 6973 2069 7320 6865 786c 2d6d 6f64 This is hexl-mod
166 00000010: 652e 2020 4561 6368 206c 696e 6520 7265 e. Each line re
167 00000020: 7072 6573 656e 7473 2031 3620 6279 7465 presents 16 byte
168 00000030: 7320 6173 2068 6578 6164 6563 696d 616c s as hexadecimal
169 00000040: 2041 5343 4949 0a61 6e64 2070 7269 6e74 ASCII.and print
170 00000050: 6162 6c65 2041 5343 4949 2063 6861 7261 able ASCII chara
171 00000060: 6374 6572 732e 2020 416e 7920 636f 6e74 cters. Any cont
172 00000070: 726f 6c20 6f72 206e 6f6e 2d41 5343 4949 rol or non-ASCII
173 00000080: 2063 6861 7261 6374 6572 730a 6172 6520 characters.are
174 00000090: 6469 7370 6c61 7965 6420 6173 2070 6572 displayed as per
175 000000a0: 696f 6473 2069 6e20 7468 6520 7072 696e iods in the prin
176 000000b0: 7461 626c 6520 6368 6172 6163 7465 7220 table character
177 000000c0: 7265 6769 6f6e 2e0a region..
179 Movement is as simple as movement in a normal Emacs text buffer. Most
180 cursor movement bindings are the same (ie. Use \\[hexl-backward-char], \\[hexl-forward-char], \\[hexl-next-line], and \\[hexl-previous-line]
181 to move the cursor left, right, down, and up).
183 Advanced cursor movement commands (ala \\[hexl-beginning-of-line], \\[hexl-end-of-line], \\[hexl-beginning-of-buffer], and \\[hexl-end-of-buffer]) are
186 There are several ways to change text in hexl mode:
188 ASCII characters (character between space (0x20) and tilde (0x7E)) are
189 bound to self-insert so you can simply type the character and it will
190 insert itself (actually overstrike) into the buffer.
192 \\[hexl-quoted-insert] followed by another keystroke allows you to insert the key even if
193 it isn't bound to self-insert. An octal number can be supplied in place
194 of another key to insert the octal number's ASCII representation.
196 \\[hexl-insert-hex-char] will insert a given hexadecimal value (if it is between 0 and 0xFF)
197 into the buffer at the current point.
199 \\[hexl-insert-octal-char] will insert a given octal value (if it is between 0 and 0377)
200 into the buffer at the current point.
202 \\[hexl-insert-decimal-char] will insert a given decimal value (if it is between 0 and 255)
203 into the buffer at the current point.
205 \\[hexl-mode-exit] will exit hexl-mode.
207 Note: saving the file with any of the usual Emacs commands
208 will actually convert it back to binary format while saving.
210 You can use \\[hexl-find-file] to visit a file in Hexl mode.
212 \\[describe-bindings] for advanced commands."
214 (unless (eq major-mode
'hexl-mode
)
215 (let ((modified (buffer-modified-p))
216 (inhibit-read-only t
)
217 (original-point (- (point) (point-min))))
218 (and (eobp) (not (bobp))
219 (setq original-point
(1- original-point
)))
220 ;; If `hexl-mode' is invoked with an argument the buffer is assumed to
221 ;; be in hexl format.
222 (when (memq arg
'(1 nil
))
223 ;; If the buffer's EOL type is -dos, we need to account for
224 ;; extra CR characters added when hexlify-buffer writes the
226 ;; FIXME: This doesn't take into account multibyte coding systems.
227 (when (eq (coding-system-eol-type buffer-file-coding-system
) 1)
228 (setq original-point
(+ (count-lines (point-min) (point))
230 (or (bolp) (setq original-point
(1- original-point
))))
232 (restore-buffer-modified-p modified
))
233 (set (make-local-variable 'hexl-max-address
)
234 (let* ((full-lines (/ (buffer-size) 68))
235 (last-line (%
(buffer-size) 68))
236 (last-line-bytes (% last-line
52)))
237 (+ last-line-bytes
(* full-lines
16) -
1)))
239 (hexl-goto-address original-point
)
242 ;; We do not turn off the old major mode; instead we just
243 ;; override most of it. That way, we can restore it perfectly.
244 (make-local-variable 'hexl-mode-old-local-map
)
245 (setq hexl-mode-old-local-map
(current-local-map))
246 (use-local-map hexl-mode-map
)
248 (make-local-variable 'hexl-mode-old-mode-name
)
249 (setq hexl-mode-old-mode-name mode-name
)
250 (setq mode-name
"Hexl")
252 (set (make-local-variable 'hexl-mode-old-isearch-search-fun-function
)
253 isearch-search-fun-function
)
254 (set (make-local-variable 'isearch-search-fun-function
)
255 'hexl-isearch-search-function
)
257 (make-local-variable 'hexl-mode-old-major-mode
)
258 (setq hexl-mode-old-major-mode major-mode
)
259 (setq major-mode
'hexl-mode
)
261 (make-local-variable 'hexl-mode-old-ruler-mode
)
262 (setq hexl-mode-old-ruler-mode
263 (and (boundp 'ruler-mode
) ruler-mode
))
265 (make-local-variable 'hexl-mode-old-hl-line-mode
)
266 (setq hexl-mode-old-hl-line-mode
267 (and (boundp 'hl-line-mode
) hl-line-mode
))
269 (make-local-variable 'hexl-mode-old-syntax-table
)
270 (setq hexl-mode-old-syntax-table
(syntax-table))
271 (set-syntax-table (standard-syntax-table))
273 (add-hook 'write-contents-functions
'hexl-save-buffer nil t
)
275 (make-local-variable 'hexl-mode-old-require-final-newline
)
276 (setq hexl-mode-old-require-final-newline require-final-newline
)
277 (make-local-variable 'require-final-newline
)
278 (setq require-final-newline nil
)
280 (make-local-variable 'hexl-mode-old-font-lock-keywords
)
281 (setq hexl-mode-old-font-lock-keywords font-lock-defaults
)
282 (make-local-variable 'font-lock-defaults
)
283 (setq font-lock-defaults
'(hexl-font-lock-keywords t
))
285 ;; Add hooks to rehexlify or dehexlify on various events.
286 (add-hook 'after-revert-hook
'hexl-after-revert-hook nil t
)
288 (add-hook 'change-major-mode-hook
'hexl-maybe-dehexlify-buffer nil t
)
290 ;; Set a callback function for eldoc.
291 (set (make-local-variable 'eldoc-documentation-function
)
292 'hexl-print-current-point-info
)
293 (eldoc-add-command-completions "hexl-")
294 (eldoc-remove-command "hexl-save-buffer"
295 "hexl-current-address")
297 (if hexl-follow-ascii
(hexl-follow-ascii 1)))
298 (run-mode-hooks 'hexl-mode-hook
))
301 (defun hexl-isearch-search-function ()
302 (if (and (not isearch-regexp
) (not isearch-word
))
303 (lambda (string &optional bound noerror count
)
305 (if isearch-forward
're-search-forward
're-search-backward
)
307 (if (> (length string
) 80)
308 (regexp-quote string
)
309 (mapconcat (lambda (c) (regexp-quote (string c
))) string
310 "\\(?:\n\\(?:[:a-f0-9]+ \\)+ \\)?"))))
311 (if (string-match "\\` ?\\([a-f0-9]+ \\)*[a-f0-9]+ ?\\'" string
)
313 (mapconcat 'regexp-quote
(split-string string
" ")
314 " \\(?: .+\n[a-f0-9]+: \\)?"))
316 bound noerror count
))
317 (let ((isearch-search-fun-function nil
))
318 (isearch-search-fun))))
320 (defun hexl-after-revert-hook ()
321 (setq hexl-max-address
(1- (buffer-size)))
323 (set-buffer-modified-p nil
))
325 (defvar hexl-in-save-buffer nil
)
327 (defun hexl-save-buffer ()
328 "Save a hexl format buffer as binary in visited file if modified."
330 (if hexl-in-save-buffer nil
331 (restore-buffer-modified-p
332 (if (buffer-modified-p)
333 (let ((buf (generate-new-buffer " hexl"))
338 (with-current-buffer buf
339 (insert-buffer-substring name start end
)
342 ;; Prevent infinite recursion.
343 (let ((hexl-in-save-buffer t
))
345 (setq modified
(buffer-modified-p))
346 (delete-region (point-min) (point-max))
347 (insert-buffer-substring buf start end
)
350 (message "(No changes need to be saved)")
352 ;; Return t to indicate we have saved t
356 (defun hexl-find-file (filename)
357 "Edit file FILENAME as a binary file in hex dump format.
358 Switch to a buffer visiting file FILENAME, creating one if none exists,
359 and edit the file in `hexl-mode'."
362 (let ((completion-ignored-extensions nil
))
363 (read-file-name "Filename: " nil nil
'ret-must-match
))))
364 ;; Ignore the user's setting of default-major-mode.
365 (let ((default-major-mode 'fundamental-mode
))
366 (find-file-literally filename
))
367 (if (not (eq major-mode
'hexl-mode
))
370 (defun hexl-mode-exit (&optional arg
)
371 "Exit Hexl mode, returning to previous mode.
372 With arg, don't unhexlify buffer."
374 (if (or (eq arg
1) (not arg
))
375 (let ((modified (buffer-modified-p))
376 (inhibit-read-only t
)
377 (original-point (1+ (hexl-current-address))))
379 (remove-hook 'write-contents-functions
'hexl-save-buffer t
)
380 (restore-buffer-modified-p modified
)
381 (goto-char original-point
)
382 ;; Maybe adjust point for the removed CR characters.
383 (when (eq (coding-system-eol-type buffer-file-coding-system
) 1)
384 (setq original-point
(- original-point
385 (count-lines (point-min) (point))))
386 (or (bobp) (setq original-point
(1+ original-point
))))
387 (goto-char original-point
)))
389 (remove-hook 'after-revert-hook
'hexl-after-revert-hook t
)
390 (remove-hook 'change-major-mode-hook
'hexl-maybe-dehexlify-buffer t
)
391 (remove-hook 'post-command-hook
'hexl-follow-ascii-find t
)
392 (setq hexl-ascii-overlay nil
)
394 (if (and (boundp 'ruler-mode
) ruler-mode
(not hexl-mode-old-ruler-mode
))
396 (when (boundp 'hexl-mode-old-ruler-function
)
397 (setq ruler-mode-ruler-function hexl-mode-old-ruler-function
))
399 (if (and (boundp 'hl-line-mode
) hl-line-mode
(not hexl-mode-old-hl-line-mode
))
401 (when (boundp 'hexl-mode-old-hl-line-range-function
)
402 (setq hl-line-range-function hexl-mode-old-hl-line-range-function
))
403 (when (boundp hexl-mode-old-hl-line-face
)
404 (setq hl-line-face hexl-mode-old-hl-line-face
))
406 (setq require-final-newline hexl-mode-old-require-final-newline
)
407 (setq mode-name hexl-mode-old-mode-name
)
408 (setq isearch-search-fun-function hexl-mode-old-isearch-search-fun-function
)
409 (use-local-map hexl-mode-old-local-map
)
410 (set-syntax-table hexl-mode-old-syntax-table
)
411 (setq font-lock-defaults hexl-mode-old-font-lock-keywords
)
412 (setq major-mode hexl-mode-old-major-mode
)
413 (force-mode-line-update))
415 (defun hexl-maybe-dehexlify-buffer ()
416 "Convert a hexl format buffer to binary.
417 Ask the user for confirmation."
418 (if (y-or-n-p "Convert contents back to binary format? ")
419 (let ((modified (buffer-modified-p))
420 (inhibit-read-only t
)
421 (original-point (1+ (hexl-current-address))))
423 (remove-hook 'write-contents-functions
'hexl-save-buffer t
)
424 (restore-buffer-modified-p modified
)
425 (goto-char original-point
))))
427 (defun hexl-current-address (&optional validate
)
428 "Return current hexl-address."
430 (let ((current-column (- (%
(- (point) (point-min) -
1) 68) 11))
432 (if (< current-column
0)
434 (error "Point is not on a character in the file")
435 (setq current-column
0)))
437 (+ (* (/ (- (point) (point-min) -
1) 68) 16)
438 (if (>= current-column
41)
439 (- current-column
41)
440 (/ (- current-column
(/ current-column
5)) 2))))
441 (when (interactive-p)
442 (message "Current address is %d/0x%08x" hexl-address hexl-address
))
445 (defun hexl-print-current-point-info ()
446 "Return current hexl-address in string.
447 This function is intended to be used as eldoc callback."
448 (let ((addr (hexl-current-address)))
449 (format "Current address is %d/0x%08x" addr addr
)))
451 (defun hexl-address-to-marker (address)
452 "Return buffer position for ADDRESS."
453 (interactive "nAddress: ")
454 (+ (* (/ address
16) 68) 10 (point-min) (/ (* (% address
16) 5) 2)))
456 (defun hexl-goto-address (address)
457 "Goto hexl-mode (decimal) address ADDRESS.
458 Signal error if ADDRESS is out of range."
459 (interactive "nAddress: ")
460 (if (or (< address
0) (> address hexl-max-address
))
461 (error "Out of hexl region"))
462 (goto-char (hexl-address-to-marker address
)))
464 (defun hexl-goto-hex-address (hex-address)
465 "Go to hexl-mode address (hex string) HEX-ADDRESS.
466 Signal error if HEX-ADDRESS is out of range."
467 (interactive "sHex Address: ")
468 (hexl-goto-address (hexl-hex-string-to-integer hex-address
)))
470 (defun hexl-hex-string-to-integer (hex-string)
471 "Return decimal integer for HEX-STRING."
472 (interactive "sHex number: ")
474 (while (not (equal hex-string
""))
475 (setq hex-num
(+ (* hex-num
16)
476 (hexl-hex-char-to-integer (string-to-char hex-string
))))
477 (setq hex-string
(substring hex-string
1)))
480 (defun hexl-octal-string-to-integer (octal-string)
481 "Return decimal integer for OCTAL-STRING."
482 (interactive "sOctal number: ")
484 (while (not (equal octal-string
""))
485 (setq oct-num
(+ (* oct-num
8)
486 (hexl-oct-char-to-integer
487 (string-to-char octal-string
))))
488 (setq octal-string
(substring octal-string
1)))
491 ;; move point functions
493 (defun hexl-backward-char (arg)
494 "Move to left ARG bytes (right if ARG negative) in hexl-mode."
496 (hexl-goto-address (- (hexl-current-address) arg
)))
498 (defun hexl-forward-char (arg)
499 "Move to right ARG bytes (left if ARG negative) in hexl-mode."
501 (hexl-goto-address (+ (hexl-current-address) arg
)))
503 (defun hexl-backward-short (arg)
504 "Move to left ARG shorts (right if ARG negative) in hexl-mode."
506 (hexl-goto-address (let ((address (hexl-current-address)))
511 (if (not (equal address
(logior address
3)))
512 (if (> address hexl-max-address
)
514 (message "End of buffer.")
515 (setq address hexl-max-address
))
516 (setq address
(logior address
3)))
517 (if (> address hexl-max-address
)
519 (message "End of buffer.")
520 (setq address hexl-max-address
))
521 (setq address
(+ address
4))))
523 (if (> address hexl-max-address
)
525 (message "End of buffer.")
526 (setq address hexl-max-address
))
527 (setq address
(logior address
3))))
529 (if (not (equal address
(logand address -
4)))
530 (setq address
(logand address -
4))
531 (if (not (equal address
0))
532 (setq address
(- address
4))
533 (message "Beginning of buffer.")))
534 (setq arg
(1- arg
))))
537 (defun hexl-forward-short (arg)
538 "Move to right ARG shorts (left if ARG negative) in hexl-mode."
540 (hexl-backward-short (- arg
)))
542 (defun hexl-backward-word (arg)
543 "Move to left ARG words (right if ARG negative) in hexl-mode."
545 (hexl-goto-address (let ((address (hexl-current-address)))
550 (if (not (equal address
(logior address
7)))
551 (if (> address hexl-max-address
)
553 (message "End of buffer.")
554 (setq address hexl-max-address
))
555 (setq address
(logior address
7)))
556 (if (> address hexl-max-address
)
558 (message "End of buffer.")
559 (setq address hexl-max-address
))
560 (setq address
(+ address
8))))
562 (if (> address hexl-max-address
)
564 (message "End of buffer.")
565 (setq address hexl-max-address
))
566 (setq address
(logior address
7))))
568 (if (not (equal address
(logand address -
8)))
569 (setq address
(logand address -
8))
570 (if (not (equal address
0))
571 (setq address
(- address
8))
572 (message "Beginning of buffer.")))
573 (setq arg
(1- arg
))))
576 (defun hexl-forward-word (arg)
577 "Move to right ARG words (left if ARG negative) in hexl-mode."
579 (hexl-backward-word (- arg
)))
581 (defun hexl-previous-line (arg)
582 "Move vertically up ARG lines [16 bytes] (down if ARG negative) in hexl-mode.
583 If there is no byte at the target address move to the last byte in that line."
585 (hexl-next-line (- arg
)))
587 (defun hexl-next-line (arg)
588 "Move vertically down ARG lines [16 bytes] (up if ARG negative) in hexl-mode.
589 If there is no byte at the target address move to the last byte in that line."
591 (hexl-goto-address (let ((address (+ (hexl-current-address) (* arg
16))))
592 (if (and (< arg
0) (< address
0))
593 (progn (message "Out of hexl region.")
595 (%
(hexl-current-address) 16)))
596 (if (and (> address hexl-max-address
)
597 (< (% hexl-max-address
16) (% address
16)))
598 (setq address hexl-max-address
)
599 (if (> address hexl-max-address
)
600 (progn (message "Out of hexl region.")
603 (+ (logand hexl-max-address -
16)
604 (%
(hexl-current-address) 16)))))))
607 (defun hexl-beginning-of-buffer (arg)
608 "Move to the beginning of the hexl buffer.
609 Leaves `hexl-mark' at previous position.
610 With prefix arg N, puts point N bytes of the way from the true beginning."
613 (hexl-goto-address (+ 0 (1- arg
))))
615 (defun hexl-end-of-buffer (arg)
616 "Go to `hexl-max-address' minus ARG."
619 (hexl-goto-address (- hexl-max-address
(1- arg
))))
621 (defun hexl-beginning-of-line ()
622 "Goto beginning of line in hexl mode."
624 (goto-char (+ (* (/ (point) 68) 68) 11)))
626 (defun hexl-end-of-line ()
627 "Goto end of line in hexl mode."
629 (hexl-goto-address (let ((address (logior (hexl-current-address) 15)))
630 (if (> address hexl-max-address
)
631 (setq address hexl-max-address
))
634 (defun hexl-scroll-down (arg)
635 "Scroll hexl buffer window upward ARG lines; or near full window if no ARG."
638 (setq arg
(1- (window-height)))
639 (setq arg
(prefix-numeric-value arg
)))
640 (hexl-scroll-up (- arg
)))
642 (defun hexl-scroll-up (arg)
643 "Scroll hexl buffer window upward ARG lines; or near full window if no ARG.
644 If there's no byte at the target address, move to the first or last line."
647 (setq arg
(1- (window-height)))
648 (setq arg
(prefix-numeric-value arg
)))
649 (let* ((movement (* arg
16))
650 (address (hexl-current-address))
651 (dest (+ address movement
)))
653 ;; If possible, try to stay at the same offset from the beginning
654 ;; of the 16-byte group, even if we move to the first or last
656 ((and (> dest hexl-max-address
)
657 (>= (% hexl-max-address
16) (% address
16)))
658 (setq dest
(+ (logand hexl-max-address -
16) (% address
16))))
659 ((> dest hexl-max-address
)
660 (setq dest hexl-max-address
))
662 (setq dest
(% address
16))))
663 (if (/= dest
(+ address movement
))
664 (message "Out of hexl region."))
665 (hexl-goto-address dest
)
668 (defun hexl-beginning-of-1k-page ()
669 "Go to beginning of 1KB boundary."
671 (hexl-goto-address (logand (hexl-current-address) -
1024)))
673 (defun hexl-end-of-1k-page ()
674 "Go to end of 1KB boundary."
676 (hexl-goto-address (let ((address (logior (hexl-current-address) 1023)))
677 (if (> address hexl-max-address
)
678 (setq address hexl-max-address
))
681 (defun hexl-beginning-of-512b-page ()
682 "Go to beginning of 512 byte boundary."
684 (hexl-goto-address (logand (hexl-current-address) -
512)))
686 (defun hexl-end-of-512b-page ()
687 "Go to end of 512 byte boundary."
689 (hexl-goto-address (let ((address (logior (hexl-current-address) 511)))
690 (if (> address hexl-max-address
)
691 (setq address hexl-max-address
))
694 (defun hexl-quoted-insert (arg)
695 "Read next input character and insert it.
696 Useful for inserting control characters and non-ASCII characters given their
698 You may also type octal digits, to insert a character with that code."
700 (hexl-insert-multibyte-char (read-quoted-char) arg
))
702 ;00000000: 0011 2233 4455 6677 8899 aabb ccdd eeff 0123456789ABCDEF
705 (defun hexlify-buffer ()
706 "Convert a binary buffer to hexl format.
707 This discards the buffer's undo information."
709 (and buffer-undo-list
710 (or (y-or-n-p "Converting to hexl format discards undo info; ok? ")
712 (setq buffer-undo-list nil
)
713 ;; Don't decode text in the ASCII part of `hexl' program output.
714 (let ((coding-system-for-read 'raw-text
)
715 (coding-system-for-write buffer-file-coding-system
)
716 (buffer-undo-list t
))
717 (apply 'call-process-region
(point-min) (point-max)
718 (expand-file-name hexl-program exec-directory
)
720 ;; Manually encode the args, otherwise they're encoded using
721 ;; coding-system-for-write (i.e. buffer-file-coding-system) which
722 ;; may not be what we want (e.g. utf-16 on a non-utf-16 system).
724 (if (not (multibyte-string-p s
)) s
725 (encode-coding-string s locale-coding-system
)))
726 (split-string hexl-options
)))
727 (if (> (point) (hexl-address-to-marker hexl-max-address
))
728 (hexl-goto-address hexl-max-address
))))
730 (defun dehexlify-buffer ()
731 "Convert a hexl format buffer to binary.
732 This discards the buffer's undo information."
734 (and buffer-undo-list
735 (or (y-or-n-p "Converting from hexl format discards undo info; ok? ")
737 (setq buffer-undo-list nil
)
738 (let ((coding-system-for-write 'raw-text
)
739 (coding-system-for-read buffer-file-coding-system
)
740 (buffer-undo-list t
))
741 (apply 'call-process-region
(point-min) (point-max)
742 (expand-file-name hexl-program exec-directory
)
743 t t nil
"-de" (split-string hexl-options
))))
745 (defun hexl-char-after-point ()
746 "Return char for ASCII hex digits at point."
747 (hexl-htoi (char-after (point))
748 (char-after (1+ (point)))))
750 (defun hexl-htoi (lh rh
)
751 "Hex (char) LH (char) RH to integer."
752 (+ (* (hexl-hex-char-to-integer lh
) 16)
753 (hexl-hex-char-to-integer rh
)))
755 (defun hexl-hex-char-to-integer (character)
756 "Take a char and return its value as if it was a hex digit."
757 (if (and (>= character ?
0) (<= character ?
9))
759 (let ((ch (logior character
32)))
760 (if (and (>= ch ?a
) (<= ch ?f
))
762 (error "Invalid hex digit `%c'" ch
)))))
764 (defun hexl-oct-char-to-integer (character)
765 "Take a char and return its value as if it was a octal digit."
766 (if (and (>= character ?
0) (<= character ?
7))
768 (error "Invalid octal digit `%c'" character
)))
770 (defun hexl-printable-character (ch)
771 "Return a displayable string for character CH."
772 (format "%c" (if hexl-iso
773 (if (or (< ch
32) (and (>= ch
127) (< ch
160)))
776 (if (or (< ch
32) (>= ch
127))
780 (defun hexl-insert-multibyte-char (ch num
)
781 "Insert a possibly multibyte character CH NUM times.
783 Non-ASCII characters are first encoded with `buffer-file-coding-system',
784 and their encoded form is inserted byte by byte."
785 (let ((charset (char-charset ch
))
786 (coding (if (or (null buffer-file-coding-system
)
787 ;; coding-system-type equals t means undecided.
788 (eq (coding-system-type buffer-file-coding-system
) t
))
789 default-buffer-file-coding-system
790 buffer-file-coding-system
)))
791 (cond ((and (> ch
0) (< ch
256))
792 (hexl-insert-char ch num
))
793 ((eq charset
'unknown
)
795 "0x%x -- invalid character code; use \\[hexl-insert-hex-string]"
798 (let ((encoded (encode-coding-char ch coding
))
799 (internal (string-as-unibyte (char-to-string ch
)))
801 ;; If encode-coding-char returns nil, it means our character
802 ;; cannot be safely encoded with buffer-file-coding-system.
803 ;; In that case, we offer to insert the internal representation
804 ;; of that character, byte by byte.
807 (mapconcat (function (lambda (c) (format "%x" c
)))
811 "Insert char 0x%x's internal representation \"%s\"? "
813 (setq encoded internal
)
815 "Can't encode `0x%x' with this buffer's coding system; try \\[hexl-insert-hex-string]"
819 (function (lambda (c) (hexl-insert-char c
1))) encoded
)
820 (setq num
(1- num
))))))))
822 (defun hexl-self-insert-command (arg)
823 "Insert this character.
824 Interactively, with a numeric argument, insert this character that many times.
826 Non-ASCII characters are first encoded with `buffer-file-coding-system',
827 and their encoded form is inserted byte by byte."
829 (hexl-insert-multibyte-char last-command-char arg
))
831 (defun hexl-insert-char (ch num
)
832 "Insert the character CH NUM times in a hexl buffer.
834 CH must be a unibyte character whose value is between 0 and 255."
835 (if (or (< ch
0) (> ch
255))
836 (error "Invalid character 0x%x -- must be in the range [0..255]" ch
))
837 (let ((address (hexl-current-address t
)))
840 (+ (* (/ address
16) 68)
843 (/ (% address
16) 2)))
845 (+ (* (/ address
16) 68) 51 (point-min) (% address
16)))
847 (if (= (point) ascii-position
)
848 (setq at-ascii-position t
))
849 (goto-char hex-position
)
851 (insert (format "%02x" ch
))
852 (goto-char ascii-position
)
854 (insert (hexl-printable-character ch
))
855 (or (eq address hexl-max-address
)
856 (setq address
(1+ address
)))
857 (hexl-goto-address address
)
858 (if at-ascii-position
862 (forward-char (% address
16)))))
863 (setq num
(1- num
)))))
867 (defun hexl-insert-hex-char (arg)
868 "Insert a character given by its hexadecimal code ARG times at point."
870 (let ((num (hexl-hex-string-to-integer (read-string "Hex number: "))))
872 (error "Hex number out of range")
873 (hexl-insert-multibyte-char num arg
))))
875 (defun hexl-insert-hex-string (str arg
)
876 "Insert hexadecimal string STR at point ARG times.
877 Embedded whitespace, dashes, and periods in the string are ignored."
878 (interactive "sHex string: \np")
879 (setq str
(replace-regexp-in-string "[- \t.]" "" str
))
881 (let ((len (length str
))
883 (if (eq (logand len
1) 1)
884 (let ((num (hexl-hex-string-to-integer (substring str
0 1))))
885 (setq chars
(cons num chars
))
888 (let* ((nidx (+ idx
2))
889 (num (hexl-hex-string-to-integer (substring str idx nidx
))))
890 (setq chars
(cons num chars
))
892 (setq chars
(nreverse chars
))
896 (hexl-insert-char (car chars
) 1)
897 (setq chars
(cdr chars
))))
898 (setq arg
(- arg
1)))))
900 (defun hexl-insert-decimal-char (arg)
901 "Insert a character given by its decimal code ARG times at point."
903 (let ((num (string-to-number (read-string "Decimal Number: "))))
905 (error "Decimal number out of range")
906 (hexl-insert-multibyte-char num arg
))))
908 (defun hexl-insert-octal-char (arg)
909 "Insert a character given by its octal code ARG times at point."
911 (let ((num (hexl-octal-string-to-integer (read-string "Octal Number: "))))
913 (error "Decimal number out of range")
914 (hexl-insert-multibyte-char num arg
))))
916 (defun hexl-follow-ascii (&optional arg
)
917 "Toggle following ASCII in Hexl buffers.
918 With prefix ARG, turn on following if and only if ARG is positive.
919 When following is enabled, the ASCII character corresponding to the
920 element under the point is highlighted.
921 Customize the variable `hexl-follow-ascii' to disable this feature."
924 (> (prefix-numeric-value arg
) 0)
925 (not hexl-ascii-overlay
))))
929 (if (not hexl-ascii-overlay
)
931 (setq hexl-ascii-overlay
(make-overlay 1 1)
933 (overlay-put hexl-ascii-overlay
'face
'highlight
)
934 (add-hook 'post-command-hook
'hexl-follow-ascii-find nil t
)))
936 (if hexl-ascii-overlay
938 (delete-overlay hexl-ascii-overlay
)
939 (setq hexl-ascii-overlay nil
940 hexl-follow-ascii nil
)
941 (remove-hook 'post-command-hook
'hexl-follow-ascii-find t
)
944 (defun hexl-activate-ruler ()
945 "Activate `ruler-mode'."
946 (require 'ruler-mode
)
947 (unless (boundp 'hexl-mode-old-ruler-function
)
948 (set (make-local-variable 'hexl-mode-old-ruler-function
)
949 ruler-mode-ruler-function
))
950 (set (make-local-variable 'ruler-mode-ruler-function
)
954 (defun hexl-follow-line ()
955 "Activate `hl-line-mode'."
957 (unless (boundp 'hexl-mode-old-hl-line-range-function
)
958 (set (make-local-variable 'hexl-mode-old-hl-line-range-function
)
959 hl-line-range-function
))
960 (unless (boundp 'hexl-mode-old-hl-line-face
)
961 (set (make-local-variable 'hexl-mode-old-hl-line-face
)
963 (set (make-local-variable 'hl-line-range-function
)
964 'hexl-highlight-line-range
)
965 (set (make-local-variable 'hl-line-face
)
969 (defun hexl-highlight-line-range ()
970 "Return the range of address region for the point.
971 This function is assumed to be used as callback function for `hl-line-mode'."
973 (line-beginning-position)
974 ;; 9 stands for (length "87654321:")
975 (+ (line-beginning-position) 9)))
977 (defun hexl-follow-ascii-find ()
978 "Find and highlight the ASCII element corresponding to current point."
980 (- (point) (current-column))
981 (mod (hexl-current-address) 16))))
982 (move-overlay hexl-ascii-overlay pos
(1+ pos
))
985 (defun hexl-mode-ruler ()
986 "Return a string ruler for hexl mode."
987 (let* ((highlight (mod (hexl-current-address) 16))
988 (s " 87654321 0011 2233 4455 6677 8899 aabb ccdd eeff 0123456789abcdef")
990 (set-text-properties 0 (length s
) nil s
)
991 ;; Turn spaces in the header into stretch specs so they work
992 ;; regardless of the header-line face.
993 (while (string-match "[ \t]+" s pos
)
994 (setq pos
(match-end 0))
995 (put-text-property (match-beginning 0) pos
'display
996 ;; Assume fixed-size chars
997 `(space :align-to
,(1- pos
))
999 ;; Highlight the current column.
1000 (put-text-property (+ 11 (/ (* 5 highlight
) 2))
1001 (+ 13 (/ (* 5 highlight
) 2))
1003 ;; Highlight the current ascii column
1004 (put-text-property (+ 13 39 highlight
) (+ 13 40 highlight
)
1012 (setq hexl-mode-map
(make-keymap))
1013 ;; Make all self-inserting keys go through hexl-self-insert-command,
1014 ;; because we need to convert them to unibyte characters before
1015 ;; inserting them into the buffer.
1016 (define-key hexl-mode-map
[remap self-insert-command
] 'hexl-self-insert-command
)
1018 (define-key hexl-mode-map
"\C-m" 'hexl-self-insert-command
)
1019 (define-key hexl-mode-map
[left] 'hexl-backward-char)
1020 (define-key hexl-mode-map [right] 'hexl-forward-char)
1021 (define-key hexl-mode-map [up] 'hexl-previous-line)
1022 (define-key hexl-mode-map [down] 'hexl-next-line)
1023 (define-key hexl-mode-map [M-left] 'hexl-backward-short)
1024 (define-key hexl-mode-map [?\e left] 'hexl-backward-short)
1025 (define-key hexl-mode-map [M-right] 'hexl-forward-short)
1026 (define-key hexl-mode-map [?\e right] 'hexl-forward-short)
1027 (define-key hexl-mode-map [next] 'hexl-scroll-up)
1028 (define-key hexl-mode-map [prior] 'hexl-scroll-down)
1029 (define-key hexl-mode-map [home] 'hexl-beginning-of-line)
1030 (define-key hexl-mode-map [end] 'hexl-end-of-line)
1031 (define-key hexl-mode-map [C-home] 'hexl-beginning-of-buffer)
1032 (define-key hexl-mode-map [C-end] 'hexl-end-of-buffer)
1033 (define-key hexl-mode-map [deletechar] 'undefined)
1034 (define-key hexl-mode-map [deleteline] 'undefined)
1035 (define-key hexl-mode-map [insertline] 'undefined)
1036 (define-key hexl-mode-map [S-delete] 'undefined)
1037 (define-key hexl-mode-map "\177" 'undefined)
1039 (define-key hexl-mode-map "\C-a" 'hexl-beginning-of-line)
1040 (define-key hexl-mode-map "\C-b" 'hexl-backward-char)
1041 (define-key hexl-mode-map "\C-d" 'undefined)
1042 (define-key hexl-mode-map "\C-e" 'hexl-end-of-line)
1043 (define-key hexl-mode-map "\C-f" 'hexl-forward-char)
1045 (if (not (memq (key-binding (char-to-string help-char))
1046 '(help-command ehelp-command)))
1047 (define-key hexl-mode-map (char-to-string help-char) 'undefined))
1049 (define-key hexl-mode-map "\C-k" 'undefined)
1050 (define-key hexl-mode-map "\C-n" 'hexl-next-line)
1051 (define-key hexl-mode-map "\C-o" 'undefined)
1052 (define-key hexl-mode-map "\C-p" 'hexl-previous-line)
1053 (define-key hexl-mode-map "\C-q" 'hexl-quoted-insert)
1054 (define-key hexl-mode-map "\C-t" 'undefined)
1055 (define-key hexl-mode-map "\C-v" 'hexl-scroll-up)
1056 (define-key hexl-mode-map "\C-w" 'undefined)
1057 (define-key hexl-mode-map "\C-y" 'undefined)
1059 (fset 'hexl-ESC-prefix (copy-keymap 'ESC-prefix))
1060 (define-key hexl-mode-map "\e" 'hexl-ESC-prefix)
1061 (define-key hexl-mode-map "\e\C-a" 'hexl-beginning-of-512b-page)
1062 (define-key hexl-mode-map "\e\C-b" 'hexl-backward-short)
1063 (define-key hexl-mode-map "\e\C-d" 'hexl-insert-decimal-char)
1064 (define-key hexl-mode-map "\e\C-e" 'hexl-end-of-512b-page)
1065 (define-key hexl-mode-map "\e\C-f" 'hexl-forward-short)
1066 (define-key hexl-mode-map "\e\C-i" 'undefined)
1067 (define-key hexl-mode-map "\e\C-j" 'undefined)
1068 (define-key hexl-mode-map "\e\C-k" 'undefined)
1069 (define-key hexl-mode-map "\e\C-o" 'hexl-insert-octal-char)
1070 (define-key hexl-mode-map "\e\C-q" 'undefined)
1071 (define-key hexl-mode-map "\e\C-t" 'undefined)
1072 (define-key hexl-mode-map "\e\C-x" 'hexl-insert-hex-char)
1073 (define-key hexl-mode-map "\eb" 'hexl-backward-word)
1074 (define-key hexl-mode-map "\ec" 'undefined)
1075 (define-key hexl-mode-map "\ed" 'undefined)
1076 (define-key hexl-mode-map "\ef" 'hexl-forward-word)
1077 (define-key hexl-mode-map "\eg" 'hexl-goto-hex-address)
1078 (define-key hexl-mode-map "\ei" 'undefined)
1079 (define-key hexl-mode-map "\ej" 'hexl-goto-address)
1080 (define-key hexl-mode-map "\ek" 'undefined)
1081 (define-key hexl-mode-map "\el" 'undefined)
1082 (define-key hexl-mode-map "\eq" 'undefined)
1083 (define-key hexl-mode-map "\es" 'undefined)
1084 (define-key hexl-mode-map "\et" 'undefined)
1085 (define-key hexl-mode-map "\eu" 'undefined)
1086 (define-key hexl-mode-map "\ev" 'hexl-scroll-down)
1087 (define-key hexl-mode-map "\ey" 'undefined)
1088 (define-key hexl-mode-map "\ez" 'undefined)
1089 (define-key hexl-mode-map "\e<" 'hexl-beginning-of-buffer)
1090 (define-key hexl-mode-map "\e>" 'hexl-end-of-buffer)
1092 (fset 'hexl-C-c-prefix (copy-keymap mode-specific-map))
1093 (define-key hexl-mode-map "\C-c" 'hexl-C-c-prefix)
1094 (define-key hexl-mode-map "\C-c\C-c" 'hexl-mode-exit)
1096 (fset 'hexl-C-x-prefix (copy-keymap 'Control-X-prefix))
1097 (define-key hexl-mode-map "\C-x" 'hexl-C-x-prefix)
1098 (define-key hexl-mode-map "\C-x[" 'hexl-beginning-of-1k-page)
1099 (define-key hexl-mode-map "\C-x]" 'hexl-end-of-1k-page)
1100 (define-key hexl-mode-map "\C-x\C-p" 'undefined)
1101 (define-key hexl-mode-map "\C-x\C-s" 'hexl-save-buffer)
1102 (define-key hexl-mode-map "\C-x\C-t" 'undefined))
1106 ;; arch-tag: d5a7aa8a-9bce-480b-bcff-6c4c7ca5ea4a
1107 ;;; hexl.el ends here