X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/ac2e902d45169e9d54a5e3a7e389da1777a99a62..95797ede756b9aa12fbbd5a64949071cd428032a:/lisp/hexl.el diff --git a/lisp/hexl.el b/lisp/hexl.el index aa4b5c6214..1e724aa418 100644 --- a/lisp/hexl.el +++ b/lisp/hexl.el @@ -1,8 +1,11 @@ -;;; hexl.el --- edit a file in a hex dump format using the hexl filter. +;;; hexl.el --- edit a file in a hex dump format using the hexl filter -;; Copyright (C) 1989 Free Software Foundation, Inc. +;; Copyright (C) 1989, 1994, 1998, 2001, 2002, 2003, 2004, +;; 2005, 2006 Free Software Foundation, Inc. ;; Author: Keith Gabryelski +;; Maintainer: FSF +;; Keywords: data ;; This file is part of GNU Emacs. @@ -17,8 +20,9 @@ ;; 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. +;; along with GNU Emacs; see the file COPYING. If not, write to the +;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +;; Boston, MA 02110-1301, USA. ;;; Commentary: @@ -26,61 +30,111 @@ ;; a program called hexl, supplied with the GNU Emacs distribution, that ;; can filter a binary into an editable format or from the format back into ;; binary. For full instructions, invoke `hexl-mode' on an empty buffer and -;; do `M-x describe-mode'. +;; do M-x `describe-mode'. ;; -;; 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. +;; 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 +;; ASCII region of the screen (if your Emacs supports this) instead of ;; changing them to dots. ;;; Code: +(require 'eldoc) + ;; ;; vars here ;; -(defvar hexl-program "hexl" - "The program that will hexlify and de-hexlify its stdin. -`hexl-program' will always be concatenated 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 \"\".") +(defgroup hexl nil + "Edit a file in a hex dump format using the hexl filter." + :group 'data) -(defvar hexl-options (format "-hex %s" hexl-iso) - "Options to hexl-program that suit your needs.") -(defvar hexlify-command - (format "%s%s %s" exec-directory hexl-program hexl-options) - "The command to use to hexlify a buffer.") - -(defvar dehexlify-command - (format "%s%s -de %s" exec-directory hexl-program hexl-options) - "The command to use to unhexlify a buffer.") +(defcustom hexl-program "hexl" + "The program that will hexlify and dehexlify its stdin. +`hexl-program' will always be concatenated with `hexl-options' +and \"-de\" when dehexlifying a buffer." + :type 'string + :group 'hexl) + +(defcustom hexl-iso "" + "If your Emacs can handle ISO characters, this should be set to +\"-iso\" otherwise it should be \"\"." + :type 'string + :group 'hexl) + +(defcustom hexl-options (format "-hex %s" hexl-iso) + "Space separated options to `hexl-program' that suit your needs. +Quoting cannot be used, so the arguments cannot themselves contain spaces." + :type 'string + :group 'hexl) + +(defcustom hexl-follow-ascii t + "If non-nil then highlight the ASCII character corresponding to point." + :type 'boolean + :group 'hexl + :version "20.3") + +(defcustom hexl-mode-hook '(hexl-follow-line hexl-activate-ruler) + "Normal hook run when entering Hexl mode." + :type 'hook + :options '(hexl-follow-line hexl-activate-ruler turn-on-eldoc-mode) + :group 'hexl) + +(defface hexl-address-region + '((t (:inherit header-line))) + "Face used in address are of hexl-mode buffer." + :group 'hexl) + +(defface hexl-ascii-region + '((t (:inherit header-line))) + "Face used in ascii are of hexl-mode buffer." + :group 'hexl) (defvar hexl-max-address 0 "Maximum offset into hexl buffer.") (defvar hexl-mode-map nil) +(defvar ruler-mode) +(defvar ruler-mode-ruler-function) +(defvar hl-line-mode) + +(defvar hexl-mode-old-hl-line-mode) +(defvar hexl-mode-old-local-map) +(defvar hexl-mode-old-mode-name) +(defvar hexl-mode-old-major-mode) +(defvar hexl-mode-old-ruler-mode) +(defvar hexl-mode-old-isearch-search-fun-function) +(defvar hexl-mode-old-require-final-newline) +(defvar hexl-mode-old-syntax-table) +(defvar hexl-mode-old-font-lock-keywords) + +(defvar hexl-ascii-overlay nil + "Overlay used to highlight ASCII element corresponding to current point.") +(make-variable-buffer-local 'hexl-ascii-overlay) + +(defvar hexl-font-lock-keywords + '(("^\\([0-9a-f]+:\\).\\{40\\} \\(.+$\\)" + ;; "^\\([0-9a-f]+:\\).+ \\(.+$\\)" + (1 'hexl-address-region t t) + (2 'hexl-ascii-region t t))) + "Font lock keywords used in `hexl-mode'.") + ;; routines +(put 'hexl-mode 'mode-class 'special) + ;;;###autoload (defun hexl-mode (&optional arg) - "\\ -A major mode for editing binary files in hex dump format. + "\\A mode for editing binary files in hex dump format. +This is not an ordinary major mode; it alters some aspects +of the current mode's behavior, but not all; also, you can exit +Hexl mode and return to the previous mode using `hexl-mode-exit'. This function automatically converts a buffer into the hexl format using the function `hexlify-buffer'. @@ -109,10 +163,10 @@ A sample format: 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 + 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 + 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 @@ -146,13 +200,44 @@ into the buffer at the current point. Note: saving the file with any of the usual Emacs commands will actually convert it back to binary format while saving. -You can use \\[hexl-find-file] to visit a file in hexl-mode. +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) + (unless (eq major-mode 'hexl-mode) + (let ((modified (buffer-modified-p)) + (inhibit-read-only t) + (original-point (- (point) (point-min))) + max-address) + (and (eobp) (not (bobp)) + (setq original-point (1- original-point))) + (if (not (or (eq arg 1) (not arg))) + ;; if no argument then we guess at hexl-max-address + (setq max-address (+ (* (/ (1- (buffer-size)) 68) 16) 15)) + (setq max-address (1- (buffer-size))) + ;; If the buffer's EOL type is -dos, we need to account for + ;; extra CR characters added when hexlify-buffer writes the + ;; buffer to a file. + (when (eq (coding-system-eol-type buffer-file-coding-system) 1) + (setq max-address (+ (count-lines (point-min) (point-max)) + max-address)) + ;; But if there's no newline at the last line, we are off by + ;; one; adjust. + (or (eq (char-before (point-max)) ?\n) + (setq max-address (1- max-address))) + (setq original-point (+ (count-lines (point-min) (point)) + original-point)) + (or (bolp) (setq original-point (1- original-point)))) + (hexlify-buffer) + (restore-buffer-modified-p modified)) + (make-local-variable 'hexl-max-address) + (setq hexl-max-address max-address) + (condition-case nil + (hexl-goto-address original-point) + (error nil))) + + ;; We do not turn off the old major mode; instead we just + ;; override most of it. That way, we can restore it perfectly. (make-local-variable 'hexl-mode-old-local-map) (setq hexl-mode-old-local-map (current-local-map)) (use-local-map hexl-mode-map) @@ -161,26 +246,78 @@ You can use \\[hexl-find-file] to visit a file in hexl-mode. (setq hexl-mode-old-mode-name mode-name) (setq mode-name "Hexl") + (set (make-local-variable 'hexl-mode-old-isearch-search-fun-function) + isearch-search-fun-function) + (set (make-local-variable 'isearch-search-fun-function) + 'hexl-isearch-search-function) + (make-local-variable 'hexl-mode-old-major-mode) (setq hexl-mode-old-major-mode major-mode) (setq major-mode 'hexl-mode) - (make-local-variable 'write-contents-hooks) - (setq write-contents-hooks - (cons 'hexl-save-buffer write-contents-hooks)) - - (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))))) + (make-local-variable 'hexl-mode-old-ruler-mode) + (setq hexl-mode-old-ruler-mode + (and (boundp 'ruler-mode) ruler-mode)) + + (make-local-variable 'hexl-mode-old-hl-line-mode) + (setq hexl-mode-old-hl-line-mode + (and (boundp 'hl-line-mode) hl-line-mode)) + + (make-local-variable 'hexl-mode-old-syntax-table) + (setq hexl-mode-old-syntax-table (syntax-table)) + (set-syntax-table (standard-syntax-table)) + + (add-hook 'write-contents-functions 'hexl-save-buffer nil t) + + (make-local-variable 'hexl-mode-old-require-final-newline) + (setq hexl-mode-old-require-final-newline require-final-newline) + (make-local-variable 'require-final-newline) + (setq require-final-newline nil) + + (make-local-variable 'hexl-mode-old-font-lock-keywords) + (setq hexl-mode-old-font-lock-keywords font-lock-defaults) + (make-local-variable 'font-lock-defaults) + (setq font-lock-defaults '(hexl-font-lock-keywords t)) + + ;; Add hooks to rehexlify or dehexlify on various events. + (add-hook 'after-revert-hook 'hexl-after-revert-hook nil t) + + (add-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer nil t) + + ;; Set a callback function for eldoc. + (set (make-local-variable 'eldoc-documentation-function) + 'hexl-print-current-point-info) + (eldoc-add-command-completions "hexl-") + (eldoc-remove-command "hexl-save-buffer" + "hexl-current-address") + + (if hexl-follow-ascii (hexl-follow-ascii 1))) + (run-mode-hooks 'hexl-mode-hook)) + + +(defun hexl-isearch-search-function () + (if (and (not isearch-regexp) (not isearch-word)) + (lambda (string &optional bound noerror count) + (funcall + (if isearch-forward 're-search-forward 're-search-backward) + (let ((textre + (if (> (length string) 80) + (regexp-quote string) + (mapconcat (lambda (c) (regexp-quote (string c))) string + "\\(?:\n\\(?:[:a-f0-9]+ \\)+ \\)?")))) + (if (string-match "\\` ?\\([a-f0-9]+ \\)*[a-f0-9]+ ?\\'" string) + (concat textre "\\|" + (mapconcat 'regexp-quote (split-string string " ") + " \\(?: .+\n[a-f0-9]+: \\)?")) + textre)) + bound noerror count)) + (let ((isearch-search-fun-function nil)) + (isearch-search-fun)))) + +(defun hexl-after-revert-hook () + (setq hexl-max-address (1- (buffer-size))) + (hexlify-buffer) + (set-buffer-modified-p nil)) (defvar hexl-in-save-buffer nil) @@ -188,37 +325,41 @@ You can use \\[hexl-find-file] to visit a file in hexl-mode. "Save a hexl format buffer as binary in visited file if modified." (interactive) (if hexl-in-save-buffer nil - (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) - ;; Prevent infinite recursion. - (let ((hexl-in-save-buffer t)) - (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)) + (restore-buffer-modified-p + (if (buffer-modified-p) + (let ((buf (generate-new-buffer " hexl")) + (name (buffer-name)) + (start (point-min)) + (end (point-max)) + modified) + (with-current-buffer buf + (insert-buffer-substring name start end) + (set-buffer name) + (dehexlify-buffer) + ;; Prevent infinite recursion. + (let ((hexl-in-save-buffer t)) + (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)) ;; Return t to indicate we have saved t t)) ;;;###autoload (defun hexl-find-file (filename) - "Edit file FILENAME in hexl-mode. + "Edit file FILENAME in `hexl-mode'. Switch to a buffer visiting file FILENAME, creating one in none exists." - (interactive "fFilename: ") - (find-file filename) + (interactive + (list + (let ((completion-ignored-extensions nil)) + (read-file-name "Filename: " nil nil 'ret-must-match)))) + ;; Ignore the user's setting of default-major-mode. + (let ((default-major-mode 'fundamental-mode)) + (find-file-literally filename)) (if (not (eq major-mode 'hexl-mode)) (hexl-mode))) @@ -228,46 +369,88 @@ 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) + (inhibit-read-only t) (original-point (1+ (hexl-current-address)))) - (setq buffer-read-only nil) (dehexlify-buffer) - (set-buffer-modified-p modified) - (setq buffer-read-only read-only) + (remove-hook 'write-contents-functions 'hexl-save-buffer t) + (restore-buffer-modified-p modified) + (goto-char original-point) + ;; Maybe adjust point for the removed CR characters. + (when (eq (coding-system-eol-type buffer-file-coding-system) 1) + (setq original-point (- original-point + (count-lines (point-min) (point)))) + (or (bobp) (setq original-point (1+ original-point)))) (goto-char original-point))) + + (remove-hook 'after-revert-hook 'hexl-after-revert-hook t) + (remove-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer t) + (remove-hook 'post-command-hook 'hexl-follow-ascii-find t) + (setq hexl-ascii-overlay nil) + + (if (and (boundp 'ruler-mode) ruler-mode (not hexl-mode-old-ruler-mode)) + (ruler-mode 0)) + (if (and (boundp 'hl-line-mode) hl-line-mode (not hexl-mode-old-hl-line-mode)) + (hl-line-mode 0)) + (setq require-final-newline hexl-mode-old-require-final-newline) (setq mode-name hexl-mode-old-mode-name) + (setq isearch-search-fun-function hexl-mode-old-isearch-search-fun-function) (use-local-map hexl-mode-old-local-map) + (set-syntax-table hexl-mode-old-syntax-table) + (setq font-lock-defaults hexl-mode-old-font-lock-keywords) (setq major-mode hexl-mode-old-major-mode) -;; Kludge to update mode-line - (switch-to-buffer (current-buffer)) -) + (force-mode-line-update)) + +(defun hexl-maybe-dehexlify-buffer () + "Convert a hexl format buffer to binary. +Ask the user for confirmation." + (if (y-or-n-p "Convert contents back to binary format? ") + (let ((modified (buffer-modified-p)) + (inhibit-read-only t) + (original-point (1+ (hexl-current-address)))) + (dehexlify-buffer) + (remove-hook 'write-contents-functions 'hexl-save-buffer t) + (restore-buffer-modified-p modified) + (goto-char original-point)))) -(defun hexl-current-address () +(defun hexl-current-address (&optional validate) "Return current hexl-address." (interactive) - (let ((current-column (- (% (point) 68) 11)) + (let ((current-column (- (% (- (point) (point-min) -1) 68) 11)) (hexl-address 0)) - (setq hexl-address (+ (* (/ (point) 68) 16) - (/ (- current-column (/ current-column 5)) 2))) + (if (< current-column 0) + (if validate + (error "Point is not on a character in the file") + (setq current-column 0))) + (setq hexl-address + (+ (* (/ (- (point) (point-min) -1) 68) 16) + (if (>= current-column 41) + (- current-column 41) + (/ (- current-column (/ current-column 5)) 2)))) + (when (interactive-p) + (message "Current address is %d/0x%08x" hexl-address hexl-address)) hexl-address)) +(defun hexl-print-current-point-info () + "Return current hexl-address in string. +This function is intended to be used as eldoc callback." + (let ((addr (hexl-current-address))) + (format "Current address is %d/0x%08x" addr addr))) + (defun hexl-address-to-marker (address) - "Return marker for ADDRESS." + "Return buffer position for ADDRESS." (interactive "nAddress: ") - (+ (* (/ address 16) 68) 11 (/ (* (% address 16) 5) 2))) + (+ (* (/ address 16) 68) 10 (point-min) (/ (* (% 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.")) + (error "Out of hexl region")) (goto-char (hexl-address-to-marker address))) (defun hexl-goto-hex-address (hex-address) "Go to 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))) @@ -445,26 +628,38 @@ With prefix arg N, puts point N bytes of the way from the true beginning." (hexl-scroll-up (- arg))) (defun hexl-scroll-up (arg) - "Scroll hexl buffer window upward ARG lines; or near full window if no ARG." + "Scroll hexl buffer window upward ARG lines; or near full window if no ARG. +If there's no byte at the target address, move to the first or last line." (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)))) + (let* ((movement (* arg 16)) + (address (hexl-current-address)) + (dest (+ address movement))) + (cond + ;; If possible, try to stay at the same offset from the beginning + ;; of the 16-byte group, even if we move to the first or last + ;; group. + ((and (> dest hexl-max-address) + (>= (% hexl-max-address 16) (% address 16))) + (setq dest (+ (logand hexl-max-address -16) (% address 16)))) + ((> dest hexl-max-address) + (setq dest hexl-max-address)) + ((< dest 0) + (setq dest (% address 16)))) + (if (/= dest (+ address movement)) + (message "Out of hexl region.")) + (hexl-goto-address dest) + (recenter 0))) (defun hexl-beginning-of-1k-page () - "Goto to beginning of 1k boundry." + "Go to beginning of 1k boundary." (interactive) (hexl-goto-address (logand (hexl-current-address) -1024))) (defun hexl-end-of-1k-page () - "Goto to end of 1k boundry." + "Go to end of 1k boundary." (interactive) (hexl-goto-address (let ((address (logior (hexl-current-address) 1023))) (if (> address hexl-max-address) @@ -472,12 +667,12 @@ With prefix arg N, puts point N bytes of the way from the true beginning." address))) (defun hexl-beginning-of-512b-page () - "Goto to beginning of 512 byte boundry." + "Go to beginning of 512 byte boundary." (interactive) (hexl-goto-address (logand (hexl-current-address) -512))) (defun hexl-end-of-512b-page () - "Goto to end of 512 byte boundry." + "Go to end of 512 byte boundary." (interactive) (hexl-goto-address (let ((address (logior (hexl-current-address) 511))) (if (> address hexl-max-address) @@ -486,22 +681,47 @@ With prefix arg N, puts point N bytes of the way from the true beginning." (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" +Useful for inserting control characters and non-ASCII characters given their +numerical code. +You may also type octal digits, to insert a character with that code." (interactive "p") - (hexl-insert-char (read-quoted-char) arg)) + (hexl-insert-multibyte-char (read-quoted-char) arg)) ;00000000: 0011 2233 4455 6677 8899 aabb ccdd eeff 0123456789ABCDEF +;;;###autoload (defun hexlify-buffer () - "Convert a binary buffer to hexl format" + "Convert a binary buffer to hexl format. +This discards the buffer's undo information." (interactive) - (shell-command-on-region (point-min) (point-max) hexlify-command t)) + (and buffer-undo-list + (or (y-or-n-p "Converting to hexl format discards undo info; ok? ") + (error "Aborted"))) + (setq buffer-undo-list nil) + ;; Don't decode text in the ASCII part of `hexl' program output. + (let ((coding-system-for-read 'raw-text) + (coding-system-for-write buffer-file-coding-system) + (buffer-undo-list t)) + (apply 'call-process-region (point-min) (point-max) + (expand-file-name hexl-program exec-directory) + t t nil (split-string hexl-options)) + (if (> (point) (hexl-address-to-marker hexl-max-address)) + (hexl-goto-address hexl-max-address)))) (defun dehexlify-buffer () - "Convert a hexl format buffer to binary." + "Convert a hexl format buffer to binary. +This discards the buffer's undo information." (interactive) - (shell-command-on-region (point-min) (point-max) dehexlify-command t)) + (and buffer-undo-list + (or (y-or-n-p "Converting from hexl format discards undo info; ok? ") + (error "Aborted"))) + (setq buffer-undo-list nil) + (let ((coding-system-for-write 'raw-text) + (coding-system-for-read buffer-file-coding-system) + (buffer-undo-list t)) + (apply 'call-process-region (point-min) (point-max) + (expand-file-name hexl-program exec-directory) + t t nil "-de" (split-string hexl-options)))) (defun hexl-char-after-point () "Return char for ASCII hex digits at point." @@ -520,13 +740,13 @@ You may also type up to 3 octal digits, to insert a character with that code" (let ((ch (logior character 32))) (if (and (>= ch ?a) (<= ch ?f)) (- ch (- ?a 10)) - (error (format "Invalid hex digit `%c'." ch)))))) + (error "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)))) + (error "Invalid octal digit `%c'" character))) (defun hexl-printable-character (ch) "Return a displayable string for character CH." @@ -538,144 +758,324 @@ You may also type up to 3 octal digits, to insert a character with that code" 46 ch)))) +(defun hexl-insert-multibyte-char (ch num) + "Insert a possibly multibyte character CH NUM times. + +Non-ASCII characters are first encoded with `buffer-file-coding-system', +and their encoded form is inserted byte by byte." + (let ((charset (char-charset ch)) + (coding (if (or (null buffer-file-coding-system) + ;; coding-system-type equals t means undecided. + (eq (coding-system-type buffer-file-coding-system) t)) + default-buffer-file-coding-system + buffer-file-coding-system))) + (cond ((and (> ch 0) (< ch 256)) + (hexl-insert-char ch num)) + ((eq charset 'unknown) + (error + "0x%x -- invalid character code; use \\[hexl-insert-hex-string]" + ch)) + (t + (let ((encoded (encode-coding-char ch coding)) + (internal (string-as-unibyte (char-to-string ch))) + internal-hex) + ;; If encode-coding-char returns nil, it means our character + ;; cannot be safely encoded with buffer-file-coding-system. + ;; In that case, we offer to insert the internal representation + ;; of that character, byte by byte. + (when (null encoded) + (setq internal-hex + (mapconcat (function (lambda (c) (format "%x" c))) + internal " ")) + (if (yes-or-no-p + (format + "Insert char 0x%x's internal representation \"%s\"? " + ch internal-hex)) + (setq encoded internal) + (error + "Can't encode `0x%x' with this buffer's coding system; try \\[hexl-insert-hex-string]" + ch))) + (while (> num 0) + (mapc + (function (lambda (c) (hexl-insert-char c 1))) encoded) + (setq num (1- num)))))))) + (defun hexl-self-insert-command (arg) - "Insert this character." + "Insert this character. +Interactively, with a numeric argument, insert this character that many times. + +Non-ASCII characters are first encoded with `buffer-file-coding-system', +and their encoded form is inserted byte by byte." (interactive "p") - (hexl-insert-char last-command-char arg)) + (hexl-insert-multibyte-char last-command-char arg)) (defun hexl-insert-char (ch num) - "Insert a character in a hexl buffer." - (let ((address (hexl-current-address))) + "Insert the character CH NUM times in a hexl buffer. + +CH must be a unibyte character whose value is between 0 and 255." + (if (or (< ch 0) (> ch 255)) + (error "Invalid character 0x%x -- must be in the range [0..255]" ch)) + (let ((address (hexl-current-address t))) (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))) + (let ((hex-position + (+ (* (/ address 16) 68) + 10 (point-min) + (* 2 (% address 16)) + (/ (% address 16) 2))) + (ascii-position + (+ (* (/ address 16) 68) 51 (point-min) (% address 16))) + at-ascii-position) + (if (= (point) ascii-position) + (setq at-ascii-position t)) + (goto-char hex-position) + (delete-char 2) + (insert (format "%02x" ch)) + (goto-char ascii-position) + (delete-char 1) + (insert (hexl-printable-character ch)) + (or (eq address hexl-max-address) + (setq address (1+ address))) + (hexl-goto-address address) + (if at-ascii-position + (progn + (beginning-of-line) + (forward-char 51) + (forward-char (% address 16))))) (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." + "Insert a character given by its hexadecimal code ARG times at point." (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)))) + (if (< num 0) + (error "Hex number out of range") + (hexl-insert-multibyte-char num arg)))) + +(defun hexl-insert-hex-string (str arg) + "Insert hexadecimal string STR at point ARG times. +Embedded whitespace, dashes, and periods in the string are ignored." + (interactive "sHex string: \np") + (setq str (replace-regexp-in-string "[- \t.]" "" str)) + (let ((chars '())) + (let ((len (length str)) + (idx 0)) + (if (eq (logand len 1) 1) + (let ((num (hexl-hex-string-to-integer (substring str 0 1)))) + (setq chars (cons num chars)) + (setq idx 1))) + (while (< idx len) + (let* ((nidx (+ idx 2)) + (num (hexl-hex-string-to-integer (substring str idx nidx)))) + (setq chars (cons num chars)) + (setq idx nidx)))) + (setq chars (nreverse chars)) + (while (> arg 0) + (let ((chars chars)) + (while chars + (hexl-insert-char (car chars) 1) + (setq chars (cdr chars)))) + (setq arg (- arg 1))))) (defun hexl-insert-decimal-char (arg) - "Insert a ASCII char ARG times at point for a given decimal number." + "Insert a character given by its decimal code ARG times at point." (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)))) + (let ((num (string-to-number (read-string "Decimal Number: ")))) + (if (< num 0) + (error "Decimal number out of range") + (hexl-insert-multibyte-char num arg)))) (defun hexl-insert-octal-char (arg) - "Insert a ASCII char ARG times at point for a given octal number." + "Insert a character given by its octal code ARG times at point." (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)))) + (if (< num 0) + (error "Decimal number out of range") + (hexl-insert-multibyte-char num arg)))) + +(defun hexl-follow-ascii (&optional arg) + "Toggle following ASCII in Hexl buffers. +With prefix ARG, turn on following if and only if ARG is positive. +When following is enabled, the ASCII character corresponding to the +element under the point is highlighted. +Customize the variable `hexl-follow-ascii' to disable this feature." + (interactive "P") + (let ((on-p (if arg + (> (prefix-numeric-value arg) 0) + (not hexl-ascii-overlay)))) + + (if on-p + ;; turn it on + (if (not hexl-ascii-overlay) + (progn + (setq hexl-ascii-overlay (make-overlay 1 1) + hexl-follow-ascii t) + (overlay-put hexl-ascii-overlay 'face 'highlight) + (add-hook 'post-command-hook 'hexl-follow-ascii-find nil t))) + ;; turn it off + (if hexl-ascii-overlay + (progn + (delete-overlay hexl-ascii-overlay) + (setq hexl-ascii-overlay nil + hexl-follow-ascii nil) + (remove-hook 'post-command-hook 'hexl-follow-ascii-find t) + ))))) + +(defun hexl-activate-ruler () + "Activate `ruler-mode'." + (require 'ruler-mode) + (set (make-local-variable 'ruler-mode-ruler-function) + 'hexl-mode-ruler) + (ruler-mode 1)) + +(defun hexl-follow-line () + "Activate `hl-line-mode'." + (require 'frame) + (require 'hl-line) + (with-no-warnings + (set (make-local-variable 'hl-line-range-function) + 'hexl-highlight-line-range) + (set (make-local-variable 'hl-line-face) + 'highlight)) + (hl-line-mode 1)) + +(defun hexl-highlight-line-range () + "Return the range of address region for the point. +This function is assumed to be used as call back function for `hl-line-mode'." + (cons + (line-beginning-position) + ;; 9 stands for (length "87654321:") + (+ (line-beginning-position) 9))) + +(defun hexl-follow-ascii-find () + "Find and highlight the ASCII element corresponding to current point." + (let ((pos (+ 51 + (- (point) (current-column)) + (mod (hexl-current-address) 16)))) + (move-overlay hexl-ascii-overlay pos (1+ pos)) + )) + +(defun hexl-mode-ruler () + "Return a string ruler for hexl mode." + (let* ((highlight (mod (hexl-current-address) 16)) + (s " 87654321 0011 2233 4455 6677 8899 aabb ccdd eeff 0123456789abcdef") + (pos 0)) + (set-text-properties 0 (length s) nil s) + ;; Turn spaces in the header into stretch specs so they work + ;; regardless of the header-line face. + (while (string-match "[ \t]+" s pos) + (setq pos (match-end 0)) + (put-text-property (match-beginning 0) pos 'display + ;; Assume fixed-size chars + `(space :align-to ,(1- pos)) + s)) + ;; Highlight the current column. + (put-text-property (+ 11 (/ (* 5 highlight) 2)) + (+ 13 (/ (* 5 highlight) 2)) + 'face 'highlight s) + ;; Highlight the current ascii column + (put-text-property (+ 13 39 highlight) (+ 13 40 highlight) + 'face 'highlight s) + s)) ;; 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 (char-to-string help-char)) 'help-command)) - (define-key hexl-mode-map help-char '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" 'undefined) - (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" 'undefined) - (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[" 'hexl-beginning-of-1k-page) - (define-key hexl-mode-map "\C-x]" 'hexl-end-of-1k-page) - (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)) - + (setq hexl-mode-map (make-keymap)) + ;; Make all self-inserting keys go through hexl-self-insert-command, + ;; because we need to convert them to unibyte characters before + ;; inserting them into the buffer. + (define-key hexl-mode-map [remap self-insert-command] 'hexl-self-insert-command) + + (define-key hexl-mode-map "\C-m" 'hexl-self-insert-command) + (define-key hexl-mode-map [left] 'hexl-backward-char) + (define-key hexl-mode-map [right] 'hexl-forward-char) + (define-key hexl-mode-map [up] 'hexl-previous-line) + (define-key hexl-mode-map [down] 'hexl-next-line) + (define-key hexl-mode-map [M-left] 'hexl-backward-short) + (define-key hexl-mode-map [?\e left] 'hexl-backward-short) + (define-key hexl-mode-map [M-right] 'hexl-forward-short) + (define-key hexl-mode-map [?\e right] 'hexl-forward-short) + (define-key hexl-mode-map [next] 'hexl-scroll-up) + (define-key hexl-mode-map [prior] 'hexl-scroll-down) + (define-key hexl-mode-map [home] 'hexl-beginning-of-line) + (define-key hexl-mode-map [end] 'hexl-end-of-line) + (define-key hexl-mode-map [C-home] 'hexl-beginning-of-buffer) + (define-key hexl-mode-map [C-end] 'hexl-end-of-buffer) + (define-key hexl-mode-map [deletechar] 'undefined) + (define-key hexl-mode-map [deleteline] 'undefined) + (define-key hexl-mode-map [insertline] 'undefined) + (define-key hexl-mode-map [S-delete] 'undefined) + (define-key hexl-mode-map "\177" 'undefined) + + (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 (memq (key-binding (char-to-string help-char)) + '(help-command ehelp-command))) + (define-key hexl-mode-map (char-to-string help-char) 'undefined)) + + (define-key hexl-mode-map "\C-k" 'undefined) + (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) + + (fset 'hexl-ESC-prefix (copy-keymap 'ESC-prefix)) + (define-key hexl-mode-map "\e" 'hexl-ESC-prefix) + (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-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-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-o" 'hexl-insert-octal-char) + (define-key hexl-mode-map "\e\C-q" 'undefined) + (define-key hexl-mode-map "\e\C-t" 'undefined) + (define-key hexl-mode-map "\e\C-x" 'hexl-insert-hex-char) + (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 "\ef" 'hexl-forward-word) + (define-key hexl-mode-map "\eg" 'hexl-goto-hex-address) + (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 "\eq" '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) + + (fset 'hexl-C-c-prefix (copy-keymap mode-specific-map)) + (define-key hexl-mode-map "\C-c" 'hexl-C-c-prefix) + (define-key hexl-mode-map "\C-c\C-c" 'hexl-mode-exit) + + (fset 'hexl-C-x-prefix (copy-keymap 'Control-X-prefix)) + (define-key hexl-mode-map "\C-x" 'hexl-C-x-prefix) + (define-key hexl-mode-map "\C-x[" 'hexl-beginning-of-1k-page) + (define-key hexl-mode-map "\C-x]" 'hexl-end-of-1k-page) + (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)) + +(provide 'hexl) + +;; arch-tag: d5a7aa8a-9bce-480b-bcff-6c4c7ca5ea4a ;;; hexl.el ends here