Mercurial > emacs
view lisp/hexl.el @ 58:035f2a0c8d64
Initial revision
author | Joseph Arceneaux <jla@gnu.org> |
---|---|
date | Fri, 27 Apr 1990 01:21:24 +0000 |
parents | 9697c13298e5 |
children | 0fa7fc093c4e |
line wrap: on
line source
;; -*-Emacs-Lisp-*- ;; hexl-mode -- Edit a file in a hex dump format. ;; Copyright (C) 1989 Free Software Foundation, Inc. ;; This file is part of GNU Emacs. ;; GNU Emacs is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation; either version 1, or (at your option) ;; any later version. ;; GNU Emacs is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs; see the file COPYING. If not, write to ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. ;; ;; By: Keith Gabryelski (ag@wheaties.ai.mit.edu) ;; ;; This may be useful in your .emacs: ;; ;; (autoload 'hexl-find-file "hexl" ;; "Edit file FILENAME in hexl-mode." t) ;; ;; (define-key global-map "\C-c\C-h" 'hexl-find-file) ;; ;; NOTE: Remember to change HEXL-PROGRAM or HEXL-OPTIONS if needed. ;; ;; Currently hexl only supports big endian hex output with 16 bit ;; grouping. ;; ;; -iso in `hexl-options' will allow iso characters to display in the ;; ASCII region of the screen (if your emacs supports this) instead of ;; changing them to dots. ;; ;; vars here ;; (defvar hexl-program "hexl" "The program that will hexlify and de-hexlify its stdin. hexl-program will always be concated with hexl-options and "-de" when dehexlfying a buffer.") (defvar hexl-iso "" "If your emacs can handle ISO characters, this should be set to \"-iso\" otherwise it should be \"\".") (defvar hexl-options (format "-hex %s" hexl-iso) "Options to hexl-program that suit your needs.") (defvar hexlify-command (format "%s %s" hexl-program hexl-options) "The command to use to hexlify a buffer. It is the concatination of `hexl-program' and `hexl-options'.") (defvar dehexlify-command (format "%s -de %s" hexl-program hexl-options) "The command to use to unhexlify a buffer. It is the concatination of `hexl-program', the option \"-de\", and `hexl-options'.") (defvar hexl-max-address 0 "Maximum offset into hexl buffer.") (defvar hexl-mode-map nil) ;; routines (defun hexl-mode (&optional arg) "\\<hexl-mode-map> A major mode for editting binary files in hex dump format. This function automatically converts a buffer into the hexl format using the function `hexlify-buffer'. Each line in the buffer has an `address' (displayed in hexadecimal) representing the offset into the file that the characters on this line are at and 16 characters from the file (displayed as hexadecimal values grouped every 16 bits) and as their ASCII values. If any of the characters (displayed as ASCII characters) are unprintable (control or meta characters) they will be replaced as periods. If hexl-mode is invoked with an argument the buffer is assumed to be in hexl-format. A sample format: HEX ADDR: 0001 0203 0405 0607 0809 0a0b 0c0d 0e0f ASCII-TEXT -------- ---- ---- ---- ---- ---- ---- ---- ---- ---------------- 00000000: 5468 6973 2069 7320 6865 786c 2d6d 6f64 This is hexl-mod 00000010: 652e 2020 4561 6368 206c 696e 6520 7265 e. Each line re 00000020: 7072 6573 656e 7473 2031 3620 6279 7465 presents 16 byte 00000030: 7320 6173 2068 6578 6164 6563 696d 616c s as hexadecimal 00000040: 2041 5343 4949 0a61 6e64 2070 7269 6e74 ASCII.and print 00000050: 6162 6c65 2041 5343 4949 2063 6861 7261 able ASCII chara 00000060: 6374 6572 732e 2020 416e 7920 636f 6e74 cters. Any cont 00000070: 726f 6c20 6f72 206e 6f6e 2d41 5343 4949 rol or non-ASCII 00000080: 2063 6861 7261 6374 6572 730a 6172 6520 characters.are 00000090: 6469 7370 6c61 7965 6420 6173 2070 6572 displayed as per 000000a0: 696f 6473 2069 6e20 7468 6520 7072 696e iods in the prin 000000b0: 7461 626c 6520 6368 6172 6163 7465 7220 table character 000000c0: 7265 6769 6f6e 2e0a region.. Movement is as simple as movement in a normal emacs text buffer. Most cursor movement bindings are the same (ie. Use \\[hexl-backward-char], \\[hexl-forward-char], \\[hexl-next-line], and \\[hexl-previous-line] to move the cursor left, right, down, and up). Advanced cursor movement commands (ala \\[hexl-beginning-of-line], \\[hexl-end-of-line], \\[hexl-beginning-of-buffer], and \\[hexl-end-of-buffer]) are also supported. There are several ways to change text in hexl mode: ASCII characters (character between space (0x20) and tilde (0x7E)) are bound to self-insert so you can simply type the character and it will insert itself (actually overstrike) into the buffer. \\[hexl-quoted-insert] followed by another keystroke allows you to insert the key even if it isn't bound to self-insert. An octal number can be supplied in place of another key to insert the octal number's ASCII representation. \\[hexl-insert-hex-char] will insert a given hexadecimal value (if it is between 0 and 0xFF) into the buffer at the current point. \\[hexl-insert-octal-char] will insert a given octal value (if it is between 0 and 0377) into the buffer at the current point. \\[hexl-insert-decimal-char] will insert a given decimal value (if it is between 0 and 255) into the buffer at the current point. \\[hexl-save-buffer] will save the buffer in is binary format. \\[hexl-mode-exit] will exit hexl-mode. Note: \\[write-file] will write the file out in HEXL FORMAT. You can use \\[hexl-find-file] to visit a file in hexl-mode. \\[describe-bindings] for advanced commands." (interactive "p") (if (eq major-mode 'hexl-mode) (error "You are already in hexl mode.") (kill-all-local-variables) (make-local-variable 'hexl-mode-old-local-map) (setq hexl-mode-old-local-map (current-local-map)) (use-local-map hexl-mode-map) (make-local-variable 'hexl-mode-old-mode-name) (setq hexl-mode-old-mode-name mode-name) (setq mode-name "Hexl") (make-local-variable 'hexl-mode-old-major-mode) (setq hexl-mode-old-major-mode major-mode) (setq major-mode 'hexl-mode) (let ((modified (buffer-modified-p)) (read-only buffer-read-only) (original-point (1- (point)))) (if (not (or (eq arg 1) (not arg))) ;; if no argument then we guess at hexl-max-address (setq hexl-max-address (+ (* (/ (1- (buffer-size)) 68) 16) 15)) (setq buffer-read-only nil) (setq hexl-max-address (1- (buffer-size))) (hexlify-buffer) (set-buffer-modified-p modified) (setq buffer-read-only read-only) (hexl-goto-address original-point))))) (defun hexl-save-buffer () "Save a hexl format buffer as binary in visited file if modified." (interactive) (set-buffer-modified-p (if (buffer-modified-p) (save-excursion (let ((buf (generate-new-buffer " hexl")) (name (buffer-name)) (file-name (buffer-file-name)) (start (point-min)) (end (point-max)) modified) (set-buffer buf) (insert-buffer-substring name start end) (set-buffer name) (dehexlify-buffer) (save-buffer) (setq modified (buffer-modified-p)) (delete-region (point-min) (point-max)) (insert-buffer-substring buf start end) (kill-buffer buf) modified)) (message "(No changes need to be saved)") nil))) (defun hexl-find-file (filename) "Edit file FILENAME in hexl-mode. Switch to a buffer visiting file FILENAME, creating one in none exists." (interactive "fFilename: ") (find-file filename) (if (not (eq major-mode 'hexl-mode)) (hexl-mode))) (defun hexl-mode-exit (&optional arg) "Exit hexl-mode returning to previous mode. With arg, don't unhexlify buffer." (interactive "p") (if (or (eq arg 1) (not arg)) (let ((modified (buffer-modified-p)) (read-only buffer-read-only) (original-point (1+ (hexl-current-address)))) (setq buffer-read-only nil) (dehexlify-buffer) (set-buffer-modified-p modified) (setq buffer-read-only read-only) (goto-char original-point))) (setq mode-name hexl-mode-old-mode-name) (use-local-map hexl-mode-old-local-map) (setq major-mode hexl-mode-old-major-mode) ;; Kludge to update mode-line (switch-to-buffer (current-buffer)) ) (defun hexl-current-address () "Return current hexl-address." (interactive) (let ((current-column (- (% (point) 68) 11)) (hexl-address 0)) (setq hexl-address (+ (* (/ (point) 68) 16) (/ (- current-column (/ current-column 5)) 2))) hexl-address)) (defun hexl-address-to-marker (address) "Return marker for ADDRESS." (interactive "nAddress: ") (+ (* (/ address 16) 68) 11 (/ (* (% address 16) 5) 2))) (defun hexl-goto-address (address) "Goto hexl-mode (decimal) address ADDRESS. Signal error if ADDRESS out of range." (interactive "nAddress: ") (if (or (< address 0) (> address hexl-max-address)) (error "Out of hexl region.")) (goto-char (hexl-address-to-marker address))) (defun hexl-goto-hex-address (hex-address) "Goto hexl-mode address (hex string) HEX-ADDRESS. Signal error if HEX-ADDRESS is out of range." (interactive "sHex Address: ") (hexl-goto-address (hexl-hex-string-to-integer hex-address))) (defun hexl-hex-string-to-integer (hex-string) "Return decimal integer for HEX-STRING." (interactive "sHex number: ") (let ((hex-num 0)) (while (not (equal hex-string "")) (setq hex-num (+ (* hex-num 16) (hexl-hex-char-to-integer (string-to-char hex-string)))) (setq hex-string (substring hex-string 1))) hex-num)) (defun hexl-octal-string-to-integer (octal-string) "Return decimal integer for OCTAL-STRING." (interactive "sOctal number: ") (let ((oct-num 0)) (while (not (equal octal-string "")) (setq oct-num (+ (* oct-num 8) (hexl-oct-char-to-integer (string-to-char octal-string)))) (setq octal-string (substring octal-string 1))) oct-num)) ;; move point functions (defun hexl-backward-char (arg) "Move to left ARG bytes (right if ARG negative) in hexl-mode." (interactive "p") (hexl-goto-address (- (hexl-current-address) arg))) (defun hexl-forward-char (arg) "Move right ARG bytes (left if ARG negative) in hexl-mode." (interactive "p") (hexl-goto-address (+ (hexl-current-address) arg))) (defun hexl-backward-short (arg) "Move to left ARG shorts (right if ARG negative) in hexl-mode." (interactive "p") (hexl-goto-address (let ((address (hexl-current-address))) (if (< arg 0) (progn (setq arg (- arg)) (while (> arg 0) (if (not (equal address (logior address 3))) (if (> address hexl-max-address) (progn (message "End of buffer.") (setq address hexl-max-address)) (setq address (logior address 3))) (if (> address hexl-max-address) (progn (message "End of buffer.") (setq address hexl-max-address)) (setq address (+ address 4)))) (setq arg (1- arg))) (if (> address hexl-max-address) (progn (message "End of buffer.") (setq address hexl-max-address)) (setq address (logior address 3)))) (while (> arg 0) (if (not (equal address (logand address -4))) (setq address (logand address -4)) (if (not (equal address 0)) (setq address (- address 4)) (message "Beginning of buffer."))) (setq arg (1- arg)))) address))) (defun hexl-forward-short (arg) "Move right ARG shorts (left if ARG negative) in hexl-mode." (interactive "p") (hexl-backward-short (- arg))) (defun hexl-backward-word (arg) "Move to left ARG words (right if ARG negative) in hexl-mode." (interactive "p") (hexl-goto-address (let ((address (hexl-current-address))) (if (< arg 0) (progn (setq arg (- arg)) (while (> arg 0) (if (not (equal address (logior address 7))) (if (> address hexl-max-address) (progn (message "End of buffer.") (setq address hexl-max-address)) (setq address (logior address 7))) (if (> address hexl-max-address) (progn (message "End of buffer.") (setq address hexl-max-address)) (setq address (+ address 8)))) (setq arg (1- arg))) (if (> address hexl-max-address) (progn (message "End of buffer.") (setq address hexl-max-address)) (setq address (logior address 7)))) (while (> arg 0) (if (not (equal address (logand address -8))) (setq address (logand address -8)) (if (not (equal address 0)) (setq address (- address 8)) (message "Beginning of buffer."))) (setq arg (1- arg)))) address))) (defun hexl-forward-word (arg) "Move right ARG words (left if ARG negative) in hexl-mode." (interactive "p") (hexl-backward-word (- arg))) (defun hexl-previous-line (arg) "Move vertically up ARG lines [16 bytes] (down if ARG negative) in hexl-mode. If there is byte at the target address move to the last byte in that line." (interactive "p") (hexl-next-line (- arg))) (defun hexl-next-line (arg) "Move vertically down ARG lines [16 bytes] (up if ARG negative) in hexl-mode. If there is no byte at the target address move to the last byte in that line." (interactive "p") (hexl-goto-address (let ((address (+ (hexl-current-address) (* arg 16)) t)) (if (and (< arg 0) (< address 0)) (progn (message "Out of hexl region.") (setq address (% (hexl-current-address) 16))) (if (and (> address hexl-max-address) (< (% hexl-max-address 16) (% address 16))) (setq address hexl-max-address) (if (> address hexl-max-address) (progn (message "Out of hexl region.") (setq address (+ (logand hexl-max-address -16) (% (hexl-current-address) 16))))))) address))) (defun hexl-beginning-of-buffer (arg) "Move to the beginning of the hexl buffer; leave hexl-mark at previous posistion. With arg N, put point N bytes of the way from the true beginning." (interactive "p") (push-mark (point)) (hexl-goto-address (+ 0 (1- arg)))) (defun hexl-end-of-buffer (arg) "Goto hexl-max-address minus ARG." (interactive "p") (push-mark (point)) (hexl-goto-address (- hexl-max-address (1- arg)))) (defun hexl-beginning-of-line () "Goto beginning of line in hexl mode." (interactive) (goto-char (+ (* (/ (point) 68) 68) 11))) (defun hexl-end-of-line () "Goto end of line in hexl mode." (interactive) (hexl-goto-address (let ((address (logior (hexl-current-address) 15))) (if (> address hexl-max-address) (setq address hexl-max-address)) address))) (defun hexl-scroll-down (arg) "Scroll hexl buffer window upward ARG lines; or near full window if no ARG." (interactive "P") (if (null arg) (setq arg (1- (window-height))) (setq arg (prefix-numeric-value arg))) (hexl-scroll-up (- arg))) (defun hexl-scroll-up (arg) "Scroll hexl buffer window upward ARG lines; or near full window if no ARG." (interactive "P") (if (null arg) (setq arg (1- (window-height))) (setq arg (prefix-numeric-value arg))) (let ((movement (* arg 16)) (address (hexl-current-address))) (if (or (> (+ address movement) hexl-max-address) (< (+ address movement) 0)) (message "Out of hexl region.") (hexl-goto-address (+ address movement)) (recenter 0)))) (defun hexl-beginning-of-1k-page () "Goto to beginning of 1k boundry." (interactive) (hexl-goto-address (logand (hexl-current-address) -1024))) (defun hexl-end-of-1k-page () "Goto to end of 1k boundry." (interactive) (hexl-goto-address (let ((address (logior (hexl-current-address) 1023))) (if (> address hexl-max-address) (setq address hexl-max-address)) address))) (defun hexl-beginning-of-512b-page () "Goto to beginning of 512 byte boundry." (interactive) (hexl-goto-address (logand (hexl-current-address) -512))) (defun hexl-end-of-512b-page () "Goto to end of 512 byte boundry." (interactive) (hexl-goto-address (let ((address (logior (hexl-current-address) 511))) (if (> address hexl-max-address) (setq address hexl-max-address)) address))) (defun hexl-quoted-insert (arg) "Read next input character and insert it. Useful for inserting control characters. You may also type up to 3 octal digits, to insert a character with that code" (interactive "p") (hexl-insert-char (read-quoted-char) arg)) ;00000000: 0011 2233 4455 6677 8899 aabb ccdd eeff 0123456789ABCDEF (defun hexlify-buffer () "Convert a binary buffer to hexl format" (interactive) (shell-command-on-region (point-min) (point-max) hexlify-command t)) (defun dehexlify-buffer () "Convert a hexl format buffer to binary." (interactive) (shell-command-on-region (point-min) (point-max) dehexlify-command t)) (defun hexl-char-after-point () "Return char for ASCII hex digits at point." (setq lh (char-after (point))) (setq rh (char-after (1+ (point)))) (hexl-htoi lh rh)) (defun hexl-htoi (lh rh) "Hex (char) LH (char) RH to integer." (+ (* (hexl-hex-char-to-integer lh) 16) (hexl-hex-char-to-integer rh))) (defun hexl-hex-char-to-integer (character) "Take a char and return its value as if it was a hex digit." (if (and (>= character ?0) (<= character ?9)) (- character ?0) (let ((ch (logior character 32))) (if (and (>= ch ?a) (<= ch ?f)) (- ch (- ?a 10)) (error (format "Invalid hex digit `%c'." ch)))))) (defun hexl-oct-char-to-integer (character) "Take a char and return its value as if it was a octal digit." (if (and (>= character ?0) (<= character ?7)) (- character ?0) (error (format "Invalid octal digit `%c'." character)))) (defun hexl-printable-character (ch) "Return a displayable string for character CH." (format "%c" (if hexl-iso (if (or (< ch 32) (and (>= ch 127) (< ch 160))) 46 ch) (if (or (< ch 32) (>= ch 127)) 46 ch)))) (defun hexl-self-insert-command (arg) "Insert this character." (interactive "p") (hexl-insert-char last-command-char arg)) (defun hexl-insert-char (ch num) "Insert a character in a hexl buffer." (let ((address (hexl-current-address))) (while (> num 0) (delete-char 2) (insert (format "%02x" ch)) (goto-char (+ (* (/ address 16) 68) 52 (% address 16))) (delete-char 1) (insert (hexl-printable-character ch)) (if (eq address hexl-max-address) (hexl-goto-address address) (hexl-goto-address (1+ address))) (setq num (1- num))))) ;; hex conversion (defun hexl-insert-hex-char (arg) "Insert a ASCII char ARG times at point for a given hexadecimal number." (interactive "p") (let ((num (hexl-hex-string-to-integer (read-string "Hex number: ")))) (if (or (> num 255) (< num 0)) (error "Hex number out of range.") (hexl-insert-char num arg)))) (defun hexl-insert-decimal-char (arg) "Insert a ASCII char ARG times at point for a given decimal number." (interactive "p") (let ((num (string-to-int (read-string "Decimal Number: ")))) (if (or (> num 255) (< num 0)) (error "Decimal number out of range.") (hexl-insert-char num arg)))) (defun hexl-insert-octal-char (arg) "Insert a ASCII char ARG times at point for a given octal number." (interactive "p") (let ((num (hexl-octal-string-to-integer (read-string "Octal Number: ")))) (if (or (> num 255) (< num 0)) (error "Decimal number out of range.") (hexl-insert-char num arg)))) ;; startup stuff. (if hexl-mode-map nil (setq hexl-mode-map (make-sparse-keymap)) (define-key hexl-mode-map "\C-a" 'hexl-beginning-of-line) (define-key hexl-mode-map "\C-b" 'hexl-backward-char) (define-key hexl-mode-map "\C-d" 'undefined) (define-key hexl-mode-map "\C-e" 'hexl-end-of-line) (define-key hexl-mode-map "\C-f" 'hexl-forward-char) (if (not (eq (key-binding "\C-h") 'help-command)) (define-key hexl-mode-map "\C-h" 'undefined)) (define-key hexl-mode-map "\C-i" 'hexl-self-insert-command) (define-key hexl-mode-map "\C-j" 'hexl-self-insert-command) (define-key hexl-mode-map "\C-k" 'undefined) (define-key hexl-mode-map "\C-m" 'hexl-self-insert-command) (define-key hexl-mode-map "\C-n" 'hexl-next-line) (define-key hexl-mode-map "\C-o" 'undefined) (define-key hexl-mode-map "\C-p" 'hexl-previous-line) (define-key hexl-mode-map "\C-q" 'hexl-quoted-insert) (define-key hexl-mode-map "\C-t" 'undefined) (define-key hexl-mode-map "\C-v" 'hexl-scroll-up) (define-key hexl-mode-map "\C-w" 'undefined) (define-key hexl-mode-map "\C-y" 'undefined) (let ((ch 32)) (while (< ch 127) (define-key hexl-mode-map (format "%c" ch) 'hexl-self-insert-command) (setq ch (1+ ch)))) (define-key hexl-mode-map "\e\C-a" 'hexl-beginning-of-512b-page) (define-key hexl-mode-map "\e\C-b" 'hexl-backward-short) (define-key hexl-mode-map "\e\C-c" 'undefined) (define-key hexl-mode-map "\e\C-d" 'hexl-insert-decimal-char) (define-key hexl-mode-map "\e\C-e" 'hexl-end-of-512b-page) (define-key hexl-mode-map "\e\C-f" 'hexl-forward-short) (define-key hexl-mode-map "\e\C-g" 'undefined) (define-key hexl-mode-map "\e\C-h" 'undefined) (define-key hexl-mode-map "\e\C-i" 'undefined) (define-key hexl-mode-map "\e\C-j" 'undefined) (define-key hexl-mode-map "\e\C-k" 'undefined) (define-key hexl-mode-map "\e\C-l" 'undefined) (define-key hexl-mode-map "\e\C-m" 'undefined) (define-key hexl-mode-map "\e\C-n" 'undefined) (define-key hexl-mode-map "\e\C-o" 'hexl-insert-octal-char) (define-key hexl-mode-map "\e\C-p" 'undefined) (define-key hexl-mode-map "\e\C-q" 'undefined) (define-key hexl-mode-map "\e\C-r" 'undefined) (define-key hexl-mode-map "\e\C-s" 'undefined) (define-key hexl-mode-map "\e\C-t" 'undefined) (define-key hexl-mode-map "\e\C-u" 'undefined) (define-key hexl-mode-map "\e\C-w" 'undefined) (define-key hexl-mode-map "\e\C-x" 'hexl-insert-hex-char) (define-key hexl-mode-map "\e\C-y" 'undefined) (define-key hexl-mode-map "\ea" 'hexl-beginning-of-1k-page) (define-key hexl-mode-map "\eb" 'hexl-backward-word) (define-key hexl-mode-map "\ec" 'undefined) (define-key hexl-mode-map "\ed" 'undefined) (define-key hexl-mode-map "\ee" 'hexl-end-of-1k-page) (define-key hexl-mode-map "\ef" 'hexl-forward-word) (define-key hexl-mode-map "\eg" 'hexl-goto-hex-address) (define-key hexl-mode-map "\eh" 'undefined) (define-key hexl-mode-map "\ei" 'undefined) (define-key hexl-mode-map "\ej" 'hexl-goto-address) (define-key hexl-mode-map "\ek" 'undefined) (define-key hexl-mode-map "\el" 'undefined) (define-key hexl-mode-map "\em" 'undefined) (define-key hexl-mode-map "\en" 'undefined) (define-key hexl-mode-map "\eo" 'undefined) (define-key hexl-mode-map "\ep" 'undefined) (define-key hexl-mode-map "\eq" 'undefined) (define-key hexl-mode-map "\er" 'undefined) (define-key hexl-mode-map "\es" 'undefined) (define-key hexl-mode-map "\et" 'undefined) (define-key hexl-mode-map "\eu" 'undefined) (define-key hexl-mode-map "\ev" 'hexl-scroll-down) (define-key hexl-mode-map "\ey" 'undefined) (define-key hexl-mode-map "\ez" 'undefined) (define-key hexl-mode-map "\e<" 'hexl-beginning-of-buffer) (define-key hexl-mode-map "\e>" 'hexl-end-of-buffer) (define-key hexl-mode-map "\C-c\C-c" 'hexl-mode-exit) (define-key hexl-mode-map "\C-x\C-p" 'undefined) (define-key hexl-mode-map "\C-x\C-s" 'hexl-save-buffer) (define-key hexl-mode-map "\C-x\C-t" 'undefined)) ;; The End.