-;;; 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, 1994, 1998, 2001 Free Software Foundation, Inc.
;; 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.
:group 'hexl)
(defcustom hexl-options (format "-hex %s" hexl-iso)
- "Options to hexl-program that suit your needs."
- :type 'string
- :group 'hexl)
-
-(defcustom hexlify-command
- (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 -de %s"
- (shell-quote-argument
- (expand-file-name hexl-program exec-directory))
- hexl-options)
- "The command to use to unhexlify a buffer."
+ "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)
;; 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)
(set-buffer-modified-p modified))
(make-local-variable 'hexl-max-address)
(setq require-final-newline nil)
;; Add hooks to rehexlify or dehexlify on various events.
- (make-local-hook 'after-revert-hook)
(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)
(if hexl-follow-ascii (hexl-follow-ascii 1)))
(dehexlify-buffer)
(remove-hook 'write-contents-hooks 'hexl-save-buffer)
(set-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)
(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
(let ((coding-system-for-read 'raw-text)
(coding-system-for-write buffer-file-coding-system)
(buffer-undo-list t))
- (shell-command-on-region (point-min) (point-max) hexlify-command 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))))
(let ((coding-system-for-write 'raw-text)
(coding-system-for-read buffer-file-coding-system)
(buffer-undo-list t))
- (shell-command-on-region (point-min) (point-max) dehexlify-command 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."
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."
+ "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]"))
(let ((address (hexl-current-address t)))
(while (> num 0)
(let ((hex-position
;; 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))
+ (if (< num 0)
(error "Hex number out of range")
- (hexl-insert-char num arg))))
+ (hexl-insert-multibyte-char num arg))))
(defun hexl-insert-hex-string (str arg)
"Insert hexadecimal string STR at point ARG times.
(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))
+ (if (< num 0)
(error "Decimal number out of range")
- (hexl-insert-char num arg))))
+ (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))
+ (if (< num 0)
(error "Decimal number out of range")
- (hexl-insert-char num arg))))
+ (hexl-insert-multibyte-char num arg))))
(defun hexl-follow-ascii (&optional arg)
"Toggle following ASCII in Hexl buffers.
(> (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)
(if hexl-mode-map
nil
- (setq hexl-mode-map (make-sparse-keymap))
+ (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.
+ (substitute-key-definition 'self-insert-command 'hexl-self-insert-command
+ hexl-mode-map (current-global-map))
(define-key hexl-mode-map [left] 'hexl-backward-char)
(define-key hexl-mode-map [right] 'hexl-forward-char)
(if (not (eq (key-binding (char-to-string help-char)) 'help-command))
(define-key hexl-mode-map (char-to-string 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-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))))
-
+ (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<" '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)
HCoop / bpt / emacs.git / blobdiff