Comment change.

[gnu-emacs] / lisp / hexl.el

diff --git a/lisp/hexl.el b/lisp/hexl.el
index 358b1f2ff39374edf3a0703ac4bac2142841c648..19de8c04f3bdc3b52de1e4be97c3ef4cc25c9f61 100644 (file)
--- a/lisp/hexl.el
+++ b/lisp/hexl.el
@@ -53,25 +53,40 @@
 ;; vars here
 ;;
 
-(defvar hexl-program "hexl"
+(defgroup hexl nil
+  "Edit a file in a hex dump format using the hexl filter."
+  :group 'data)
+
+
+(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.")
+and \"-de\" when dehexlifying a buffer."
+  :type 'string
+  :group 'hexl)
 
-(defvar hexl-iso ""
+(defcustom hexl-iso ""
   "If your emacs can handle ISO characters, this should be set to
-\"-iso\" otherwise it should be \"\".")
+\"-iso\" otherwise it should be \"\"."
+  :type 'string
+  :group 'hexl)
 
-(defvar hexl-options (format "-hex %s" hexl-iso)
-  "Options to hexl-program that suit your needs.")
+(defcustom hexl-options (format "-hex %s" hexl-iso)
+  "Options to hexl-program that suit your needs."
+  :type 'string
+  :group 'hexl)
 
-(defvar hexlify-command
+(defcustom hexlify-command
   (format "%s%s %s" exec-directory hexl-program hexl-options)
-  "The command to use to hexlify a buffer.")
+  "The command to use to hexlify a buffer."
+  :type 'string
+  :group 'hexl)
 
-(defvar dehexlify-command
+(defcustom dehexlify-command
   (format "%s%s -de %s" exec-directory hexl-program hexl-options)
-  "The command to use to unhexlify a buffer.")
+  "The command to use to unhexlify a buffer."
+  :type 'string
+  :group 'hexl)
 
 (defvar hexl-max-address 0
   "Maximum offset into hexl buffer.")
@@ -87,6 +102,8 @@ and \"-de\" when dehexlifying a buffer.")
 
 ;; routines
 
+(put 'hexl-mode 'mode-class 'special)
+
 ;;;###autoload
 (defun hexl-mode (&optional arg)
   "\\<hexl-mode-map>
@@ -163,6 +180,22 @@ You can use \\[hexl-find-file] to visit a file in hexl-mode.
   (if (eq major-mode 'hexl-mode)
       (error "You are already in hexl mode")
 
+    (let ((modified (buffer-modified-p))
+         (inhibit-read-only t)
+         (original-point (1- (point)))
+         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)))
+        (hexlify-buffer)
+        (set-buffer-modified-p modified))
+      (make-local-variable 'hexl-max-address)
+      (setq hexl-max-address max-address)
+      (hexl-goto-address original-point))
+
     ;; 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)
@@ -196,22 +229,8 @@ You can use \\[hexl-find-file] to visit a file in hexl-mode.
     (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)
-
-    (make-local-variable 'hexl-max-address)
-
-    (let ((modified (buffer-modified-p))
-         (inhibit-read-only t)
-         (original-point (1- (point))))
-      (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 hexl-max-address (+ (* (/ (1- (buffer-size)) 68) 16) 15))
-        (setq hexl-max-address (1- (buffer-size)))
-        (hexlify-buffer)
-        (set-buffer-modified-p modified)
-        (hexl-goto-address original-point)))))
+    (add-hook 'change-major-mode-hook 'hexl-maybe-dehexlify-buffer nil t))
+  (run-hooks 'hexl-mode-hook))
 
 (defun hexl-after-revert-hook ()
   (hexlify-buffer)
@@ -269,7 +288,7 @@ With arg, don't unhexlify buffer."
            (inhibit-read-only t)
            (original-point (1+ (hexl-current-address))))
        (dehexlify-buffer)
-       (remove-hook 'write-contents-hook 'hexl-save-buffer)
+       (remove-hook 'write-contents-hooks 'hexl-save-buffer)
        (set-buffer-modified-p modified)
        (goto-char original-point)))
 
@@ -292,7 +311,7 @@ Ask the user for confirmation."
            (inhibit-read-only t)
            (original-point (1+ (hexl-current-address))))
        (dehexlify-buffer)
-       (remove-hook 'write-contents-hook 'hexl-save-buffer)
+       (remove-hook 'write-contents-hooks 'hexl-save-buffer)
        (set-buffer-modified-p modified)
        (goto-char original-point))))
 
@@ -322,7 +341,7 @@ Ask the user for confirmation."
 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)
@@ -554,17 +573,29 @@ You may also type up to 3 octal digits, to insert a character with that code"
 
 ;;;###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)
+  (and buffer-undo-list
+       (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 t))
+       (binary-process-input t)
+       (buffer-undo-list t))
     (shell-command-on-region (point-min) (point-max) hexlify-command t)))
 
 (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)
+  (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 ((binary-process-output t) ; for Ms-Dos
-       (binary-process-input nil))
+       (binary-process-input nil)
+       (buffer-undo-list t))
     (shell-command-on-region (point-min) (point-max) dehexlify-command t)))
 
 (defun hexl-char-after-point ()
@@ -584,13 +615,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."
@@ -644,7 +675,7 @@ You may also type up to 3 octal digits, to insert a character with that code"
   (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.")
+       (error "Hex number out of range")
       (hexl-insert-char num arg))))
 
 (defun hexl-insert-decimal-char (arg)
@@ -652,7 +683,7 @@ You may also type up to 3 octal digits, to insert a character with that code"
   (interactive "p")
   (let ((num (string-to-int (read-string "Decimal Number: "))))
     (if (or (> num 255) (< num 0))
-       (error "Decimal number out of range.")
+       (error "Decimal number out of range")
       (hexl-insert-char num arg))))
 
 (defun hexl-insert-octal-char (arg)
@@ -660,110 +691,118 @@ You may also type up to 3 octal digits, to insert a character with that code"
   (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.")
+       (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 [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 [M-right] 'hexl-forward-short)
-    (define-key hexl-mode-map [next] 'hexl-scroll-up)
-    (define-key hexl-mode-map [prev] 'hexl-scroll-down)
-
-    (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 (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-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-sparse-keymap))
+
+  (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 [M-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-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 (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-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))
+
+(provide 'hexl)
 
 ;;; hexl.el ends here