;;; hexl.el --- edit a file in a hex dump format using the hexl filter.
-;; Copyright (C) 1989, 1994 Free Software Foundation, Inc.
+;; Copyright (C) 1989, 1994, 1998 Free Software Foundation, Inc.
;; Author: Keith Gabryelski <ag@wheaties.ai.mit.edu>
;; Maintainer: FSF
:group 'hexl)
(defcustom hexlify-command
- (format "%s%s %s" exec-directory hexl-program hexl-options)
+ (format "%s %s"
+ (shell-quote-argument
+ (expand-file-name hexl-program exec-directory))
+ hexl-options)
"The command to use to hexlify a buffer."
:type 'string
:group 'hexl)
(defcustom dehexlify-command
- (format "%s%s -de %s" exec-directory hexl-program hexl-options)
+ (format "%s -de %s"
+ (shell-quote-argument
+ (expand-file-name hexl-program exec-directory))
+ hexl-options)
"The command to use to unhexlify a buffer."
: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")
+
(defvar hexl-max-address 0
"Maximum offset into hexl buffer.")
(defvar hexl-mode-old-require-final-newline)
(defvar hexl-mode-old-syntax-table)
+(defvar hexl-ascii-overlay nil
+ "Overlay used to highlight ASCII element corresponding to current point.")
+(make-variable-buffer-local 'hexl-ascii-overlay)
+
;; routines
(put 'hexl-mode 'mode-class 'special)
;;;###autoload
(defun hexl-mode (&optional arg)
- "\\<hexl-mode-map>
-A major mode for editing binary files in hex dump format.
+ "\\<hexl-mode-map>A mode for editing binary files in hex dump format.
+This is not an ordinary major mode; it alters some aspects
+if 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'.
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")
-
+ (unless (eq major-mode 'hexl-mode)
(let ((modified (buffer-modified-p))
(inhibit-read-only t)
(original-point (1- (point)))
(add-hook 'after-revert-hook 'hexl-after-revert-hook nil t)
(make-local-hook 'change-major-mode-hook)
- (add-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer nil t))
+ (add-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer nil t)
+
+ (if hexl-follow-ascii (hexl-follow-ascii 1)))
(run-hooks 'hexl-mode-hook))
(defun hexl-after-revert-hook ()
+ (setq hexl-max-address (1- (buffer-size)))
(hexlify-buffer)
(set-buffer-modified-p nil))
(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)
(setq write-contents-hooks hexl-mode-old-write-contents-hooks)
(setq require-final-newline hexl-mode-old-require-final-newline)
hexl-address))
(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)))
(or (y-or-n-p "Converting to hexl format discards undo info; ok? ")
(error "Aborted")))
(setq buffer-undo-list nil)
- (let ((binary-process-output nil) ; for Ms-Dos
- (binary-process-input buffer-file-type)
- (coding-system-for-write 'no-conversion)
+ ;; Don't decode text in the ASCII part of `hexl' program output.
+ (let ((coding-system-for-read 'raw-text)
+ ;; If the buffer was read with EOL conversions, be sure to use the
+ ;; same conversions when passing the region to the `hexl' program.
+ (coding-system-for-write
+ (let ((eol-type (coding-system-eol-type buffer-file-coding-system)))
+ (cond ((eq eol-type 1)
+ 'raw-text-dos)
+ ((eq eol-type 2)
+ 'raw-text-mac)
+ ((eq eol-type 0)
+ 'raw-text-unix)
+ (t 'no-conversion))))
(buffer-undo-list t))
- (shell-command-on-region (point-min) (point-max) hexlify-command t)))
+ (shell-command-on-region (point-min) (point-max) hexlify-command t)
+ (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.
(or (y-or-n-p "Converting from hexl format discards undo info; ok? ")
(error "Aborted")))
(setq buffer-undo-list nil)
- (let ((binary-process-output buffer-file-type) ; for Ms-Dos
- (binary-process-input nil)
- (coding-system-for-read 'no-conversion)
+ (let ((coding-system-for-write 'raw-text)
+ (coding-system-for-read
+ (let ((eol-type (coding-system-eol-type buffer-file-coding-system)))
+ (cond ((eq eol-type 1)
+ 'raw-text-dos)
+ ((eq eol-type 2)
+ 'raw-text-mac)
+ ((eq eol-type 0)
+ 'raw-text-unix)
+ (t 'no-conversion))))
(buffer-undo-list t))
(shell-command-on-region (point-min) (point-max) dehexlify-command t)))
(error "Hex number out of range")
(hexl-insert-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."
(interactive "p")
(error "Decimal number out of range")
(hexl-insert-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))))
+
+ (make-local-hook 'post-command-hook)
+
+ (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-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))
+ ))
+
;; startup stuff.
(if hexl-mode-map
(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)