Commit | Line | Data |
---|---|---|
a22f4c7d | 1 | ;;; hexl.el --- edit a file in a hex dump format using the hexl filter. |
e5167999 | 2 | |
8f1204db | 3 | ;; Copyright (C) 1989, 1994 Free Software Foundation, Inc. |
a2535589 | 4 | |
3a801d0c | 5 | ;; Author: Keith Gabryelski <ag@wheaties.ai.mit.edu> |
b7f66977 RS |
6 | ;; Maintainer: FSF |
7 | ;; Keywords: data | |
3a801d0c | 8 | |
a2535589 JA |
9 | ;; This file is part of GNU Emacs. |
10 | ||
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 | |
e5167999 | 13 | ;; the Free Software Foundation; either version 2, or (at your option) |
a2535589 JA |
14 | ;; any later version. |
15 | ||
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. | |
20 | ||
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 | |
23 | ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
24 | ||
e5167999 ER |
25 | ;;; Commentary: |
26 | ||
e41b2db1 ER |
27 | ;; This package implements a major mode for editing binary files. It uses |
28 | ;; a program called hexl, supplied with the GNU Emacs distribution, that | |
29 | ;; can filter a binary into an editable format or from the format back into | |
30 | ;; binary. For full instructions, invoke `hexl-mode' on an empty buffer and | |
31 | ;; do `M-x describe-mode'. | |
32 | ;; | |
a2535589 JA |
33 | ;; This may be useful in your .emacs: |
34 | ;; | |
35 | ;; (autoload 'hexl-find-file "hexl" | |
36 | ;; "Edit file FILENAME in hexl-mode." t) | |
37 | ;; | |
38 | ;; (define-key global-map "\C-c\C-h" 'hexl-find-file) | |
39 | ;; | |
40 | ;; NOTE: Remember to change HEXL-PROGRAM or HEXL-OPTIONS if needed. | |
41 | ;; | |
42 | ;; Currently hexl only supports big endian hex output with 16 bit | |
43 | ;; grouping. | |
44 | ;; | |
45 | ;; -iso in `hexl-options' will allow iso characters to display in the | |
46 | ;; ASCII region of the screen (if your emacs supports this) instead of | |
47 | ;; changing them to dots. | |
48 | ||
e5167999 ER |
49 | ;;; Code: |
50 | ||
a2535589 JA |
51 | ;; |
52 | ;; vars here | |
53 | ;; | |
54 | ||
55 | (defvar hexl-program "hexl" | |
8a1281b5 | 56 | "The program that will hexlify and de-hexlify its stdin. |
57f07931 | 57 | `hexl-program' will always be concatenated with `hexl-options' |
8a1281b5 | 58 | and \"-de\" when dehexlfying a buffer.") |
a2535589 JA |
59 | |
60 | (defvar hexl-iso "" | |
61 | "If your emacs can handle ISO characters, this should be set to | |
62 | \"-iso\" otherwise it should be \"\".") | |
63 | ||
64 | (defvar hexl-options (format "-hex %s" hexl-iso) | |
65 | "Options to hexl-program that suit your needs.") | |
66 | ||
a22f4c7d RS |
67 | (defvar hexlify-command |
68 | (format "%s%s %s" exec-directory hexl-program hexl-options) | |
57f07931 | 69 | "The command to use to hexlify a buffer.") |
a2535589 | 70 | |
a22f4c7d RS |
71 | (defvar dehexlify-command |
72 | (format "%s%s -de %s" exec-directory hexl-program hexl-options) | |
57f07931 | 73 | "The command to use to unhexlify a buffer.") |
a2535589 JA |
74 | |
75 | (defvar hexl-max-address 0 | |
76 | "Maximum offset into hexl buffer.") | |
77 | ||
78 | (defvar hexl-mode-map nil) | |
79 | ||
f39c6650 RS |
80 | (defvar hexl-mode-old-local-map) |
81 | (defvar hexl-mode-old-mode-name) | |
82 | (defvar hexl-mode-old-major-mode) | |
83 | ||
a2535589 JA |
84 | ;; routines |
85 | ||
31c75fa7 | 86 | ;;;###autoload |
a2535589 JA |
87 | (defun hexl-mode (&optional arg) |
88 | "\\<hexl-mode-map> | |
e41b2db1 | 89 | A major mode for editing binary files in hex dump format. |
a2535589 JA |
90 | |
91 | This function automatically converts a buffer into the hexl format | |
92 | using the function `hexlify-buffer'. | |
93 | ||
8a1281b5 | 94 | Each line in the buffer has an \"address\" (displayed in hexadecimal) |
a2535589 JA |
95 | representing the offset into the file that the characters on this line |
96 | are at and 16 characters from the file (displayed as hexadecimal | |
97 | values grouped every 16 bits) and as their ASCII values. | |
98 | ||
99 | If any of the characters (displayed as ASCII characters) are | |
100 | unprintable (control or meta characters) they will be replaced as | |
101 | periods. | |
102 | ||
8a1281b5 RS |
103 | If `hexl-mode' is invoked with an argument the buffer is assumed to be |
104 | in hexl format. | |
a2535589 JA |
105 | |
106 | A sample format: | |
107 | ||
108 | HEX ADDR: 0001 0203 0405 0607 0809 0a0b 0c0d 0e0f ASCII-TEXT | |
109 | -------- ---- ---- ---- ---- ---- ---- ---- ---- ---------------- | |
110 | 00000000: 5468 6973 2069 7320 6865 786c 2d6d 6f64 This is hexl-mod | |
111 | 00000010: 652e 2020 4561 6368 206c 696e 6520 7265 e. Each line re | |
112 | 00000020: 7072 6573 656e 7473 2031 3620 6279 7465 presents 16 byte | |
113 | 00000030: 7320 6173 2068 6578 6164 6563 696d 616c s as hexadecimal | |
114 | 00000040: 2041 5343 4949 0a61 6e64 2070 7269 6e74 ASCII.and print | |
115 | 00000050: 6162 6c65 2041 5343 4949 2063 6861 7261 able ASCII chara | |
116 | 00000060: 6374 6572 732e 2020 416e 7920 636f 6e74 cters. Any cont | |
117 | 00000070: 726f 6c20 6f72 206e 6f6e 2d41 5343 4949 rol or non-ASCII | |
118 | 00000080: 2063 6861 7261 6374 6572 730a 6172 6520 characters.are | |
119 | 00000090: 6469 7370 6c61 7965 6420 6173 2070 6572 displayed as per | |
120 | 000000a0: 696f 6473 2069 6e20 7468 6520 7072 696e iods in the prin | |
121 | 000000b0: 7461 626c 6520 6368 6172 6163 7465 7220 table character | |
122 | 000000c0: 7265 6769 6f6e 2e0a region.. | |
123 | ||
124 | Movement is as simple as movement in a normal emacs text buffer. Most | |
125 | cursor movement bindings are the same (ie. Use \\[hexl-backward-char], \\[hexl-forward-char], \\[hexl-next-line], and \\[hexl-previous-line] | |
126 | to move the cursor left, right, down, and up). | |
127 | ||
128 | Advanced cursor movement commands (ala \\[hexl-beginning-of-line], \\[hexl-end-of-line], \\[hexl-beginning-of-buffer], and \\[hexl-end-of-buffer]) are | |
129 | also supported. | |
130 | ||
131 | There are several ways to change text in hexl mode: | |
132 | ||
133 | ASCII characters (character between space (0x20) and tilde (0x7E)) are | |
134 | bound to self-insert so you can simply type the character and it will | |
135 | insert itself (actually overstrike) into the buffer. | |
136 | ||
137 | \\[hexl-quoted-insert] followed by another keystroke allows you to insert the key even if | |
138 | it isn't bound to self-insert. An octal number can be supplied in place | |
139 | of another key to insert the octal number's ASCII representation. | |
140 | ||
141 | \\[hexl-insert-hex-char] will insert a given hexadecimal value (if it is between 0 and 0xFF) | |
142 | into the buffer at the current point. | |
143 | ||
144 | \\[hexl-insert-octal-char] will insert a given octal value (if it is between 0 and 0377) | |
145 | into the buffer at the current point. | |
146 | ||
147 | \\[hexl-insert-decimal-char] will insert a given decimal value (if it is between 0 and 255) | |
148 | into the buffer at the current point. | |
149 | ||
a2535589 JA |
150 | \\[hexl-mode-exit] will exit hexl-mode. |
151 | ||
31c75fa7 RS |
152 | Note: saving the file with any of the usual Emacs commands |
153 | will actually convert it back to binary format while saving. | |
a2535589 JA |
154 | |
155 | You can use \\[hexl-find-file] to visit a file in hexl-mode. | |
156 | ||
157 | \\[describe-bindings] for advanced commands." | |
158 | (interactive "p") | |
159 | (if (eq major-mode 'hexl-mode) | |
160 | (error "You are already in hexl mode.") | |
161 | (kill-all-local-variables) | |
162 | (make-local-variable 'hexl-mode-old-local-map) | |
163 | (setq hexl-mode-old-local-map (current-local-map)) | |
164 | (use-local-map hexl-mode-map) | |
165 | ||
166 | (make-local-variable 'hexl-mode-old-mode-name) | |
167 | (setq hexl-mode-old-mode-name mode-name) | |
168 | (setq mode-name "Hexl") | |
169 | ||
170 | (make-local-variable 'hexl-mode-old-major-mode) | |
171 | (setq hexl-mode-old-major-mode major-mode) | |
172 | (setq major-mode 'hexl-mode) | |
173 | ||
31c75fa7 | 174 | (make-local-variable 'write-contents-hooks) |
c6fcafde | 175 | (add-hook 'write-contents-hooks 'hexl-save-buffer) |
31c75fa7 | 176 | |
c3de2bf0 RS |
177 | (make-local-hook 'after-revert-hook) |
178 | (add-hook 'after-revert-hook 'hexl-after-revert-hook nil t) | |
179 | ||
ba275b2d RS |
180 | (make-local-variable 'hexl-max-address) |
181 | ||
8eeac2ce RS |
182 | (make-local-variable 'change-major-mode-hook) |
183 | (add-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer) | |
184 | ||
a2535589 | 185 | (let ((modified (buffer-modified-p)) |
bb752f07 | 186 | (inhibit-read-only t) |
a2535589 JA |
187 | (original-point (1- (point)))) |
188 | (if (not (or (eq arg 1) (not arg))) | |
bb752f07 | 189 | ;; if no argument then we guess at hexl-max-address |
a2535589 | 190 | (setq hexl-max-address (+ (* (/ (1- (buffer-size)) 68) 16) 15)) |
a2535589 JA |
191 | (setq hexl-max-address (1- (buffer-size))) |
192 | (hexlify-buffer) | |
193 | (set-buffer-modified-p modified) | |
a2535589 JA |
194 | (hexl-goto-address original-point))))) |
195 | ||
c3de2bf0 RS |
196 | (defun hexl-after-revert-hook () |
197 | (hexlify-buffer) | |
198 | (set-buffer-modified-p nil)) | |
199 | ||
ac2e902d JB |
200 | (defvar hexl-in-save-buffer nil) |
201 | ||
a2535589 JA |
202 | (defun hexl-save-buffer () |
203 | "Save a hexl format buffer as binary in visited file if modified." | |
204 | (interactive) | |
ac2e902d JB |
205 | (if hexl-in-save-buffer nil |
206 | (set-buffer-modified-p (if (buffer-modified-p) | |
207 | (save-excursion | |
208 | (let ((buf (generate-new-buffer " hexl")) | |
209 | (name (buffer-name)) | |
210 | (file-name (buffer-file-name)) | |
211 | (start (point-min)) | |
212 | (end (point-max)) | |
213 | modified) | |
214 | (set-buffer buf) | |
215 | (insert-buffer-substring name start end) | |
216 | (set-buffer name) | |
217 | (dehexlify-buffer) | |
218 | ;; Prevent infinite recursion. | |
1fa65e2f RS |
219 | (let ((hexl-in-save-buffer t) |
220 | (buffer-file-type t)) ; for ms-dos | |
ac2e902d JB |
221 | (save-buffer)) |
222 | (setq modified (buffer-modified-p)) | |
223 | (delete-region (point-min) (point-max)) | |
224 | (insert-buffer-substring buf start end) | |
225 | (kill-buffer buf) | |
226 | modified)) | |
227 | (message "(No changes need to be saved)") | |
228 | nil)) | |
229 | ;; Return t to indicate we have saved t | |
230 | t)) | |
a2535589 | 231 | |
31c75fa7 | 232 | ;;;###autoload |
a2535589 JA |
233 | (defun hexl-find-file (filename) |
234 | "Edit file FILENAME in hexl-mode. | |
a2535589 JA |
235 | Switch to a buffer visiting file FILENAME, creating one in none exists." |
236 | (interactive "fFilename: ") | |
23fa9040 | 237 | (if (or (eq system-type 'ms-dos) (eq system-type 'windows-nt)) |
10b501e3 RS |
238 | (find-file-binary filename) |
239 | (find-file filename)) | |
a2535589 JA |
240 | (if (not (eq major-mode 'hexl-mode)) |
241 | (hexl-mode))) | |
242 | ||
243 | (defun hexl-mode-exit (&optional arg) | |
31c75fa7 | 244 | "Exit Hexl mode, returning to previous mode. |
a2535589 JA |
245 | With arg, don't unhexlify buffer." |
246 | (interactive "p") | |
247 | (if (or (eq arg 1) (not arg)) | |
248 | (let ((modified (buffer-modified-p)) | |
900014dd | 249 | (inhibit-read-only t) |
a2535589 | 250 | (original-point (1+ (hexl-current-address)))) |
a2535589 | 251 | (dehexlify-buffer) |
c6fcafde | 252 | (remove-hook 'write-contents-hook 'hexl-save-buffer) |
a2535589 | 253 | (set-buffer-modified-p modified) |
a2535589 JA |
254 | (goto-char original-point))) |
255 | (setq mode-name hexl-mode-old-mode-name) | |
256 | (use-local-map hexl-mode-old-local-map) | |
257 | (setq major-mode hexl-mode-old-major-mode) | |
8eeac2ce RS |
258 | (force-mode-line-update)) |
259 | ||
260 | (defun hexl-maybe-dehexlify-buffer () | |
261 | "Convert a hexl format buffer to binary. | |
262 | Ask the user for confirmation." | |
263 | (if (y-or-n-p "Convert contents back to binary format? ") | |
264 | (let ((modified (buffer-modified-p)) | |
265 | (inhibit-read-only t) | |
266 | (original-point (1+ (hexl-current-address)))) | |
267 | (dehexlify-buffer) | |
268 | (remove-hook 'write-contents-hook 'hexl-save-buffer) | |
269 | (set-buffer-modified-p modified) | |
270 | (goto-char original-point)))) | |
a2535589 | 271 | |
6bbb008e | 272 | (defun hexl-current-address (&optional validate) |
a2535589 JA |
273 | "Return current hexl-address." |
274 | (interactive) | |
275 | (let ((current-column (- (% (point) 68) 11)) | |
276 | (hexl-address 0)) | |
6bbb008e RS |
277 | (if (< current-column 0) |
278 | (if validate | |
279 | (error "Point is not on a character in the file") | |
280 | (setq current-column 0))) | |
281 | (setq hexl-address | |
282 | (+ (* (/ (point) 68) 16) | |
283 | (if (>= current-column 41) | |
284 | (- current-column 41) | |
285 | (/ (- current-column (/ current-column 5)) 2)))) | |
a2535589 JA |
286 | hexl-address)) |
287 | ||
288 | (defun hexl-address-to-marker (address) | |
289 | "Return marker for ADDRESS." | |
290 | (interactive "nAddress: ") | |
291 | (+ (* (/ address 16) 68) 11 (/ (* (% address 16) 5) 2))) | |
292 | ||
293 | (defun hexl-goto-address (address) | |
294 | "Goto hexl-mode (decimal) address ADDRESS. | |
295 | ||
296 | Signal error if ADDRESS out of range." | |
297 | (interactive "nAddress: ") | |
298 | (if (or (< address 0) (> address hexl-max-address)) | |
299 | (error "Out of hexl region.")) | |
300 | (goto-char (hexl-address-to-marker address))) | |
301 | ||
302 | (defun hexl-goto-hex-address (hex-address) | |
4c8c7ae9 | 303 | "Go to hexl-mode address (hex string) HEX-ADDRESS. |
a2535589 JA |
304 | |
305 | Signal error if HEX-ADDRESS is out of range." | |
306 | (interactive "sHex Address: ") | |
307 | (hexl-goto-address (hexl-hex-string-to-integer hex-address))) | |
308 | ||
309 | (defun hexl-hex-string-to-integer (hex-string) | |
310 | "Return decimal integer for HEX-STRING." | |
311 | (interactive "sHex number: ") | |
312 | (let ((hex-num 0)) | |
313 | (while (not (equal hex-string "")) | |
314 | (setq hex-num (+ (* hex-num 16) | |
315 | (hexl-hex-char-to-integer (string-to-char hex-string)))) | |
316 | (setq hex-string (substring hex-string 1))) | |
317 | hex-num)) | |
318 | ||
319 | (defun hexl-octal-string-to-integer (octal-string) | |
320 | "Return decimal integer for OCTAL-STRING." | |
321 | (interactive "sOctal number: ") | |
322 | (let ((oct-num 0)) | |
323 | (while (not (equal octal-string "")) | |
324 | (setq oct-num (+ (* oct-num 8) | |
325 | (hexl-oct-char-to-integer | |
326 | (string-to-char octal-string)))) | |
327 | (setq octal-string (substring octal-string 1))) | |
328 | oct-num)) | |
329 | ||
330 | ;; move point functions | |
331 | ||
332 | (defun hexl-backward-char (arg) | |
333 | "Move to left ARG bytes (right if ARG negative) in hexl-mode." | |
334 | (interactive "p") | |
335 | (hexl-goto-address (- (hexl-current-address) arg))) | |
336 | ||
337 | (defun hexl-forward-char (arg) | |
338 | "Move right ARG bytes (left if ARG negative) in hexl-mode." | |
339 | (interactive "p") | |
340 | (hexl-goto-address (+ (hexl-current-address) arg))) | |
341 | ||
342 | (defun hexl-backward-short (arg) | |
343 | "Move to left ARG shorts (right if ARG negative) in hexl-mode." | |
344 | (interactive "p") | |
345 | (hexl-goto-address (let ((address (hexl-current-address))) | |
346 | (if (< arg 0) | |
347 | (progn | |
348 | (setq arg (- arg)) | |
349 | (while (> arg 0) | |
350 | (if (not (equal address (logior address 3))) | |
351 | (if (> address hexl-max-address) | |
352 | (progn | |
353 | (message "End of buffer.") | |
354 | (setq address hexl-max-address)) | |
355 | (setq address (logior address 3))) | |
356 | (if (> address hexl-max-address) | |
357 | (progn | |
358 | (message "End of buffer.") | |
359 | (setq address hexl-max-address)) | |
360 | (setq address (+ address 4)))) | |
361 | (setq arg (1- arg))) | |
362 | (if (> address hexl-max-address) | |
363 | (progn | |
364 | (message "End of buffer.") | |
365 | (setq address hexl-max-address)) | |
366 | (setq address (logior address 3)))) | |
367 | (while (> arg 0) | |
368 | (if (not (equal address (logand address -4))) | |
369 | (setq address (logand address -4)) | |
370 | (if (not (equal address 0)) | |
371 | (setq address (- address 4)) | |
372 | (message "Beginning of buffer."))) | |
373 | (setq arg (1- arg)))) | |
374 | address))) | |
375 | ||
376 | (defun hexl-forward-short (arg) | |
377 | "Move right ARG shorts (left if ARG negative) in hexl-mode." | |
378 | (interactive "p") | |
379 | (hexl-backward-short (- arg))) | |
380 | ||
381 | (defun hexl-backward-word (arg) | |
382 | "Move to left ARG words (right if ARG negative) in hexl-mode." | |
383 | (interactive "p") | |
384 | (hexl-goto-address (let ((address (hexl-current-address))) | |
385 | (if (< arg 0) | |
386 | (progn | |
387 | (setq arg (- arg)) | |
388 | (while (> arg 0) | |
389 | (if (not (equal address (logior address 7))) | |
390 | (if (> address hexl-max-address) | |
391 | (progn | |
392 | (message "End of buffer.") | |
393 | (setq address hexl-max-address)) | |
394 | (setq address (logior address 7))) | |
395 | (if (> address hexl-max-address) | |
396 | (progn | |
397 | (message "End of buffer.") | |
398 | (setq address hexl-max-address)) | |
399 | (setq address (+ address 8)))) | |
400 | (setq arg (1- arg))) | |
401 | (if (> address hexl-max-address) | |
402 | (progn | |
403 | (message "End of buffer.") | |
404 | (setq address hexl-max-address)) | |
405 | (setq address (logior address 7)))) | |
406 | (while (> arg 0) | |
407 | (if (not (equal address (logand address -8))) | |
408 | (setq address (logand address -8)) | |
409 | (if (not (equal address 0)) | |
410 | (setq address (- address 8)) | |
411 | (message "Beginning of buffer."))) | |
412 | (setq arg (1- arg)))) | |
413 | address))) | |
414 | ||
415 | (defun hexl-forward-word (arg) | |
416 | "Move right ARG words (left if ARG negative) in hexl-mode." | |
417 | (interactive "p") | |
418 | (hexl-backward-word (- arg))) | |
419 | ||
420 | (defun hexl-previous-line (arg) | |
4c8c7ae9 JB |
421 | "Move vertically up ARG lines [16 bytes] (down if ARG negative) in hexl-mode. |
422 | If there is byte at the target address move to the last byte in that line." | |
a2535589 JA |
423 | (interactive "p") |
424 | (hexl-next-line (- arg))) | |
425 | ||
426 | (defun hexl-next-line (arg) | |
4c8c7ae9 JB |
427 | "Move vertically down ARG lines [16 bytes] (up if ARG negative) in hexl-mode. |
428 | If there is no byte at the target address move to the last byte in that line." | |
a2535589 | 429 | (interactive "p") |
e8a57935 | 430 | (hexl-goto-address (let ((address (+ (hexl-current-address) (* arg 16)))) |
a2535589 JA |
431 | (if (and (< arg 0) (< address 0)) |
432 | (progn (message "Out of hexl region.") | |
433 | (setq address | |
434 | (% (hexl-current-address) 16))) | |
435 | (if (and (> address hexl-max-address) | |
436 | (< (% hexl-max-address 16) (% address 16))) | |
437 | (setq address hexl-max-address) | |
438 | (if (> address hexl-max-address) | |
439 | (progn (message "Out of hexl region.") | |
440 | (setq | |
441 | address | |
442 | (+ (logand hexl-max-address -16) | |
443 | (% (hexl-current-address) 16))))))) | |
444 | address))) | |
445 | ||
446 | (defun hexl-beginning-of-buffer (arg) | |
4c8c7ae9 JB |
447 | "Move to the beginning of the hexl buffer. |
448 | Leaves `hexl-mark' at previous position. | |
449 | With prefix arg N, puts point N bytes of the way from the true beginning." | |
a2535589 JA |
450 | (interactive "p") |
451 | (push-mark (point)) | |
452 | (hexl-goto-address (+ 0 (1- arg)))) | |
453 | ||
454 | (defun hexl-end-of-buffer (arg) | |
4c8c7ae9 | 455 | "Go to `hexl-max-address' minus ARG." |
a2535589 JA |
456 | (interactive "p") |
457 | (push-mark (point)) | |
458 | (hexl-goto-address (- hexl-max-address (1- arg)))) | |
459 | ||
460 | (defun hexl-beginning-of-line () | |
461 | "Goto beginning of line in hexl mode." | |
462 | (interactive) | |
463 | (goto-char (+ (* (/ (point) 68) 68) 11))) | |
464 | ||
465 | (defun hexl-end-of-line () | |
466 | "Goto end of line in hexl mode." | |
467 | (interactive) | |
468 | (hexl-goto-address (let ((address (logior (hexl-current-address) 15))) | |
469 | (if (> address hexl-max-address) | |
470 | (setq address hexl-max-address)) | |
471 | address))) | |
472 | ||
473 | (defun hexl-scroll-down (arg) | |
474 | "Scroll hexl buffer window upward ARG lines; or near full window if no ARG." | |
475 | (interactive "P") | |
476 | (if (null arg) | |
477 | (setq arg (1- (window-height))) | |
478 | (setq arg (prefix-numeric-value arg))) | |
479 | (hexl-scroll-up (- arg))) | |
480 | ||
481 | (defun hexl-scroll-up (arg) | |
482 | "Scroll hexl buffer window upward ARG lines; or near full window if no ARG." | |
483 | (interactive "P") | |
484 | (if (null arg) | |
485 | (setq arg (1- (window-height))) | |
486 | (setq arg (prefix-numeric-value arg))) | |
487 | (let ((movement (* arg 16)) | |
488 | (address (hexl-current-address))) | |
489 | (if (or (> (+ address movement) hexl-max-address) | |
490 | (< (+ address movement) 0)) | |
491 | (message "Out of hexl region.") | |
492 | (hexl-goto-address (+ address movement)) | |
493 | (recenter 0)))) | |
494 | ||
495 | (defun hexl-beginning-of-1k-page () | |
496 | "Goto to beginning of 1k boundry." | |
497 | (interactive) | |
498 | (hexl-goto-address (logand (hexl-current-address) -1024))) | |
499 | ||
500 | (defun hexl-end-of-1k-page () | |
501 | "Goto to end of 1k boundry." | |
502 | (interactive) | |
503 | (hexl-goto-address (let ((address (logior (hexl-current-address) 1023))) | |
504 | (if (> address hexl-max-address) | |
505 | (setq address hexl-max-address)) | |
506 | address))) | |
507 | ||
508 | (defun hexl-beginning-of-512b-page () | |
509 | "Goto to beginning of 512 byte boundry." | |
510 | (interactive) | |
511 | (hexl-goto-address (logand (hexl-current-address) -512))) | |
512 | ||
513 | (defun hexl-end-of-512b-page () | |
514 | "Goto to end of 512 byte boundry." | |
515 | (interactive) | |
516 | (hexl-goto-address (let ((address (logior (hexl-current-address) 511))) | |
517 | (if (> address hexl-max-address) | |
518 | (setq address hexl-max-address)) | |
519 | address))) | |
520 | ||
521 | (defun hexl-quoted-insert (arg) | |
522 | "Read next input character and insert it. | |
523 | Useful for inserting control characters. | |
524 | You may also type up to 3 octal digits, to insert a character with that code" | |
525 | (interactive "p") | |
526 | (hexl-insert-char (read-quoted-char) arg)) | |
527 | ||
528 | ;00000000: 0011 2233 4455 6677 8899 aabb ccdd eeff 0123456789ABCDEF | |
529 | ||
f4e3d4eb | 530 | ;;;###autoload |
a2535589 | 531 | (defun hexlify-buffer () |
8eeac2ce | 532 | "Convert a binary buffer to hexl format." |
a2535589 | 533 | (interactive) |
1fa65e2f RS |
534 | (let ((binary-process-output nil) ; for Ms-Dos |
535 | (binary-process-input t)) | |
536 | (shell-command-on-region (point-min) (point-max) hexlify-command t))) | |
a2535589 JA |
537 | |
538 | (defun dehexlify-buffer () | |
539 | "Convert a hexl format buffer to binary." | |
540 | (interactive) | |
1fa65e2f RS |
541 | (let ((binary-process-output t) ; for Ms-Dos |
542 | (binary-process-input nil)) | |
10b501e3 | 543 | (shell-command-on-region (point-min) (point-max) dehexlify-command t))) |
a2535589 JA |
544 | |
545 | (defun hexl-char-after-point () | |
546 | "Return char for ASCII hex digits at point." | |
686fc9ab RS |
547 | (hexl-htoi (char-after (point)) |
548 | (char-after (1+ (point))))) | |
a2535589 JA |
549 | |
550 | (defun hexl-htoi (lh rh) | |
551 | "Hex (char) LH (char) RH to integer." | |
552 | (+ (* (hexl-hex-char-to-integer lh) 16) | |
553 | (hexl-hex-char-to-integer rh))) | |
554 | ||
555 | (defun hexl-hex-char-to-integer (character) | |
556 | "Take a char and return its value as if it was a hex digit." | |
557 | (if (and (>= character ?0) (<= character ?9)) | |
558 | (- character ?0) | |
559 | (let ((ch (logior character 32))) | |
560 | (if (and (>= ch ?a) (<= ch ?f)) | |
561 | (- ch (- ?a 10)) | |
562 | (error (format "Invalid hex digit `%c'." ch)))))) | |
563 | ||
564 | (defun hexl-oct-char-to-integer (character) | |
565 | "Take a char and return its value as if it was a octal digit." | |
566 | (if (and (>= character ?0) (<= character ?7)) | |
567 | (- character ?0) | |
568 | (error (format "Invalid octal digit `%c'." character)))) | |
569 | ||
570 | (defun hexl-printable-character (ch) | |
571 | "Return a displayable string for character CH." | |
572 | (format "%c" (if hexl-iso | |
573 | (if (or (< ch 32) (and (>= ch 127) (< ch 160))) | |
574 | 46 | |
575 | ch) | |
576 | (if (or (< ch 32) (>= ch 127)) | |
577 | 46 | |
578 | ch)))) | |
579 | ||
580 | (defun hexl-self-insert-command (arg) | |
581 | "Insert this character." | |
582 | (interactive "p") | |
583 | (hexl-insert-char last-command-char arg)) | |
584 | ||
585 | (defun hexl-insert-char (ch num) | |
586 | "Insert a character in a hexl buffer." | |
6bbb008e | 587 | (let ((address (hexl-current-address t))) |
a2535589 | 588 | (while (> num 0) |
6bbb008e RS |
589 | (let ((hex-position |
590 | (+ (* (/ address 16) 68) | |
591 | 11 | |
592 | (* 2 (% address 16)) | |
593 | (/ (% address 16) 2))) | |
594 | (ascii-position | |
595 | (+ (* (/ address 16) 68) 52 (% address 16))) | |
596 | at-ascii-position) | |
597 | (if (= (point) ascii-position) | |
598 | (setq at-ascii-position t)) | |
599 | (goto-char hex-position) | |
600 | (delete-char 2) | |
601 | (insert (format "%02x" ch)) | |
602 | (goto-char ascii-position) | |
603 | (delete-char 1) | |
604 | (insert (hexl-printable-character ch)) | |
605 | (or (eq address hexl-max-address) | |
606 | (setq address (1+ address))) | |
607 | (hexl-goto-address address) | |
608 | (if at-ascii-position | |
609 | (progn | |
610 | (beginning-of-line) | |
611 | (forward-char 51) | |
612 | (forward-char (% address 16))))) | |
a2535589 JA |
613 | (setq num (1- num))))) |
614 | ||
615 | ;; hex conversion | |
616 | ||
617 | (defun hexl-insert-hex-char (arg) | |
618 | "Insert a ASCII char ARG times at point for a given hexadecimal number." | |
619 | (interactive "p") | |
620 | (let ((num (hexl-hex-string-to-integer (read-string "Hex number: ")))) | |
621 | (if (or (> num 255) (< num 0)) | |
622 | (error "Hex number out of range.") | |
623 | (hexl-insert-char num arg)))) | |
624 | ||
625 | (defun hexl-insert-decimal-char (arg) | |
626 | "Insert a ASCII char ARG times at point for a given decimal number." | |
627 | (interactive "p") | |
628 | (let ((num (string-to-int (read-string "Decimal Number: ")))) | |
629 | (if (or (> num 255) (< num 0)) | |
630 | (error "Decimal number out of range.") | |
631 | (hexl-insert-char num arg)))) | |
632 | ||
633 | (defun hexl-insert-octal-char (arg) | |
634 | "Insert a ASCII char ARG times at point for a given octal number." | |
635 | (interactive "p") | |
636 | (let ((num (hexl-octal-string-to-integer (read-string "Octal Number: ")))) | |
637 | (if (or (> num 255) (< num 0)) | |
638 | (error "Decimal number out of range.") | |
639 | (hexl-insert-char num arg)))) | |
640 | ||
641 | ;; startup stuff. | |
642 | ||
643 | (if hexl-mode-map | |
644 | nil | |
645 | (setq hexl-mode-map (make-sparse-keymap)) | |
646 | ||
f86f73c3 KH |
647 | (define-key hexl-mode-map [left] 'hexl-backward-char) |
648 | (define-key hexl-mode-map [right] 'hexl-forward-char) | |
649 | (define-key hexl-mode-map [up] 'hexl-previous-line) | |
650 | (define-key hexl-mode-map [down] 'hexl-next-line) | |
651 | (define-key hexl-mode-map [M-left] 'hexl-backward-short) | |
652 | (define-key hexl-mode-map [M-right] 'hexl-forward-short) | |
653 | (define-key hexl-mode-map [next] 'hexl-scroll-up) | |
654 | (define-key hexl-mode-map [prev] 'hexl-scroll-down) | |
655 | ||
a2535589 JA |
656 | (define-key hexl-mode-map "\C-a" 'hexl-beginning-of-line) |
657 | (define-key hexl-mode-map "\C-b" 'hexl-backward-char) | |
658 | (define-key hexl-mode-map "\C-d" 'undefined) | |
659 | (define-key hexl-mode-map "\C-e" 'hexl-end-of-line) | |
660 | (define-key hexl-mode-map "\C-f" 'hexl-forward-char) | |
661 | ||
b9a4b501 | 662 | (if (not (eq (key-binding (char-to-string help-char)) 'help-command)) |
7e17a6aa | 663 | (define-key hexl-mode-map (char-to-string help-char) 'undefined)) |
a2535589 JA |
664 | |
665 | (define-key hexl-mode-map "\C-i" 'hexl-self-insert-command) | |
666 | (define-key hexl-mode-map "\C-j" 'hexl-self-insert-command) | |
667 | (define-key hexl-mode-map "\C-k" 'undefined) | |
668 | (define-key hexl-mode-map "\C-m" 'hexl-self-insert-command) | |
669 | (define-key hexl-mode-map "\C-n" 'hexl-next-line) | |
670 | (define-key hexl-mode-map "\C-o" 'undefined) | |
671 | (define-key hexl-mode-map "\C-p" 'hexl-previous-line) | |
672 | (define-key hexl-mode-map "\C-q" 'hexl-quoted-insert) | |
673 | (define-key hexl-mode-map "\C-t" 'undefined) | |
674 | (define-key hexl-mode-map "\C-v" 'hexl-scroll-up) | |
675 | (define-key hexl-mode-map "\C-w" 'undefined) | |
676 | (define-key hexl-mode-map "\C-y" 'undefined) | |
677 | ||
678 | (let ((ch 32)) | |
679 | (while (< ch 127) | |
680 | (define-key hexl-mode-map (format "%c" ch) 'hexl-self-insert-command) | |
681 | (setq ch (1+ ch)))) | |
682 | ||
683 | (define-key hexl-mode-map "\e\C-a" 'hexl-beginning-of-512b-page) | |
684 | (define-key hexl-mode-map "\e\C-b" 'hexl-backward-short) | |
685 | (define-key hexl-mode-map "\e\C-c" 'undefined) | |
686 | (define-key hexl-mode-map "\e\C-d" 'hexl-insert-decimal-char) | |
687 | (define-key hexl-mode-map "\e\C-e" 'hexl-end-of-512b-page) | |
688 | (define-key hexl-mode-map "\e\C-f" 'hexl-forward-short) | |
689 | (define-key hexl-mode-map "\e\C-g" 'undefined) | |
690 | (define-key hexl-mode-map "\e\C-h" 'undefined) | |
691 | (define-key hexl-mode-map "\e\C-i" 'undefined) | |
692 | (define-key hexl-mode-map "\e\C-j" 'undefined) | |
693 | (define-key hexl-mode-map "\e\C-k" 'undefined) | |
694 | (define-key hexl-mode-map "\e\C-l" 'undefined) | |
695 | (define-key hexl-mode-map "\e\C-m" 'undefined) | |
696 | (define-key hexl-mode-map "\e\C-n" 'undefined) | |
697 | (define-key hexl-mode-map "\e\C-o" 'hexl-insert-octal-char) | |
698 | (define-key hexl-mode-map "\e\C-p" 'undefined) | |
699 | (define-key hexl-mode-map "\e\C-q" 'undefined) | |
700 | (define-key hexl-mode-map "\e\C-r" 'undefined) | |
701 | (define-key hexl-mode-map "\e\C-s" 'undefined) | |
702 | (define-key hexl-mode-map "\e\C-t" 'undefined) | |
703 | (define-key hexl-mode-map "\e\C-u" 'undefined) | |
704 | ||
705 | (define-key hexl-mode-map "\e\C-w" 'undefined) | |
706 | (define-key hexl-mode-map "\e\C-x" 'hexl-insert-hex-char) | |
707 | (define-key hexl-mode-map "\e\C-y" 'undefined) | |
708 | ||
31c75fa7 | 709 | (define-key hexl-mode-map "\ea" 'undefined) |
a2535589 JA |
710 | (define-key hexl-mode-map "\eb" 'hexl-backward-word) |
711 | (define-key hexl-mode-map "\ec" 'undefined) | |
712 | (define-key hexl-mode-map "\ed" 'undefined) | |
31c75fa7 | 713 | (define-key hexl-mode-map "\ee" 'undefined) |
a2535589 JA |
714 | (define-key hexl-mode-map "\ef" 'hexl-forward-word) |
715 | (define-key hexl-mode-map "\eg" 'hexl-goto-hex-address) | |
716 | (define-key hexl-mode-map "\eh" 'undefined) | |
717 | (define-key hexl-mode-map "\ei" 'undefined) | |
718 | (define-key hexl-mode-map "\ej" 'hexl-goto-address) | |
719 | (define-key hexl-mode-map "\ek" 'undefined) | |
720 | (define-key hexl-mode-map "\el" 'undefined) | |
721 | (define-key hexl-mode-map "\em" 'undefined) | |
722 | (define-key hexl-mode-map "\en" 'undefined) | |
723 | (define-key hexl-mode-map "\eo" 'undefined) | |
724 | (define-key hexl-mode-map "\ep" 'undefined) | |
725 | (define-key hexl-mode-map "\eq" 'undefined) | |
726 | (define-key hexl-mode-map "\er" 'undefined) | |
727 | (define-key hexl-mode-map "\es" 'undefined) | |
728 | (define-key hexl-mode-map "\et" 'undefined) | |
729 | (define-key hexl-mode-map "\eu" 'undefined) | |
730 | (define-key hexl-mode-map "\ev" 'hexl-scroll-down) | |
731 | (define-key hexl-mode-map "\ey" 'undefined) | |
732 | (define-key hexl-mode-map "\ez" 'undefined) | |
733 | (define-key hexl-mode-map "\e<" 'hexl-beginning-of-buffer) | |
734 | (define-key hexl-mode-map "\e>" 'hexl-end-of-buffer) | |
735 | ||
736 | (define-key hexl-mode-map "\C-c\C-c" 'hexl-mode-exit) | |
737 | ||
31c75fa7 RS |
738 | (define-key hexl-mode-map "\C-x[" 'hexl-beginning-of-1k-page) |
739 | (define-key hexl-mode-map "\C-x]" 'hexl-end-of-1k-page) | |
a2535589 JA |
740 | (define-key hexl-mode-map "\C-x\C-p" 'undefined) |
741 | (define-key hexl-mode-map "\C-x\C-s" 'hexl-save-buffer) | |
742 | (define-key hexl-mode-map "\C-x\C-t" 'undefined)) | |
743 | ||
1a06eabd | 744 | ;;; hexl.el ends here |