]> code.delx.au - gnu-emacs/blobdiff - lisp/emulation/viper-keym.el
Merged in changes from CVS trunk.
[gnu-emacs] / lisp / emulation / viper-keym.el
index c0e7f980accf10f71e0bf98dd0728e13c8af830c..146b54b7034751225fcf95e7aa25f7fd14a63186 100644 (file)
@@ -1,6 +1,8 @@
 ;;; viper-keym.el --- Viper keymaps
 
-;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
+;; Copyright (C) 1994, 95, 96, 97, 2000, 01, 02 Free Software Foundation, Inc.
+
+;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
 
 ;; This file is part of GNU Emacs.
 
@@ -19,7 +21,9 @@
 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 ;; Boston, MA 02111-1307, USA.
 
-;; Code
+;;; Commentary:
+
+;;; Code:
 
 (provide 'viper-keym)
 
 
 (defvar viper-toggle-key "\C-z"
   "The key used to change states from emacs to Vi and back.
-In insert mode, this key also functions as Meta. 
+In insert mode, this key also functions as Meta.
 Must be set in .viper file or prior to loading Viper.
 This setting cannot be changed interactively.")
 
-(defvar viper-ESC-key "\e" 
-  "Key used to ESC. 
+(defvar viper-ESC-key "\e"
+  "Key used to ESC.
 Must be set in .viper file or prior to loading Viper.
 This setting cannot be changed interactively.")
-  
-;;; Emacs keys in other states.  
+
+;;; Emacs keys in other states.
 
 (defcustom viper-want-emacs-keys-in-insert t
   "*Set to nil if you want complete Vi compatibility in insert mode.
@@ -74,13 +78,13 @@ Full Vi compatibility is not recommended for power use of Viper."
 (defcustom viper-no-multiple-ESC  t
   "*If true, multiple ESC in Vi mode will cause bell to ring.
 This is set to t on a windowing terminal and to 'twice on a dumb
-terminal (unless the user level is 1, 2, or 5). On a dumb terminal, this
+terminal (unless the user level is 1, 2, or 5).  On a dumb terminal, this
 enables cursor keys and is generally more convenient, as terminals usually
 don't have a convenient Meta key.
 Setting viper-no-multiple-ESC to nil will allow as many multiple ESC,
 as is allowed by the major mode in effect."
   :type 'boolean
-  :group 'viper) 
+  :group 'viper)
 
 (defcustom viper-want-ctl-h-help nil
   "*If non-nil, C-h gets bound to help-command; otherwise, C-h gets the usual Vi bindings."
@@ -99,14 +103,14 @@ as is allowed by the major mode in effect."
 ;; keymap used to zap all keymaps other than function-key-map,
 ;; device-function-key-map, etc.
 (defvar viper-overriding-map (make-sparse-keymap))
-  
+
 (viper-deflocalvar viper-vi-local-user-map (make-sparse-keymap)
   "Keymap for user-defined local bindings.
 Useful for changing bindings such as ZZ in certain major modes.
 For instance, in letter-mode, one may want to bind ZZ to
-mh-send-letter. In a newsreader such as gnus, tin, or rn, ZZ could be bound
+mh-send-letter.  In a newsreader such as gnus, tin, or rn, ZZ could be bound
 to save-buffers-kill-emacs then post article, etc.")
-(put 'viper-vi-local-user-map 'permanent-local t)      
+(put 'viper-vi-local-user-map 'permanent-local t)
 
 (defvar viper-vi-global-user-map (make-sparse-keymap)
   "Keymap for user-defined global bindings.
@@ -121,12 +125,12 @@ This map is global, shared by all buffers.")
 
 (defvar viper-vi-diehard-map (make-sparse-keymap)
   "This keymap is in use when the user asks Viper to simulate Vi very closely.
-This happens when viper-expert-level is 1 or 2. See viper-set-expert-level.")
-  
+This happens when viper-expert-level is 1 or 2.  See viper-set-expert-level.")
+
 
 (viper-deflocalvar viper-insert-local-user-map (make-sparse-keymap)
   "Auxiliary map for per-buffer user-defined keybindings in Insert state.")
-(put 'viper-insert-local-user-map 'permanent-local t)  
+(put 'viper-insert-local-user-map 'permanent-local t)
 
 (defvar viper-insert-global-user-map (make-sparse-keymap)
   "Auxiliary map for global user-defined bindings in Insert state.")
@@ -136,66 +140,66 @@ This happens when viper-expert-level is 1 or 2. See viper-set-expert-level.")
 
 (defvar viper-insert-diehard-map (make-keymap)
   "Map used when user wants vi-style keys in insert mode.
-Most of the Emacs keys are suppressed. This map overshadows
-viper-insert-basic-map. Not recommended, except for novice users.")
+Most of the Emacs keys are suppressed.  This map overshadows
+viper-insert-basic-map.  Not recommended, except for novice users.")
 
 (defvar  viper-insert-kbd-map  (make-sparse-keymap)
   "This keymap keeps VI-style kbd macros for insert mode.")
 
 (defvar viper-replace-map (make-sparse-keymap)
   "Map used in Viper's replace state.")
-  
+
 (defvar viper-emacs-global-user-map (make-sparse-keymap)
   "Auxiliary map for global user-defined bindings in Emacs state.")
 
 (defvar  viper-emacs-kbd-map  (make-sparse-keymap)
   "This keymap keeps Vi-style kbd macros for emacs mode.")
-  
+
 (viper-deflocalvar viper-emacs-local-user-map  (make-sparse-keymap)
   "Auxiliary map for local user-defined bindings in Emacs state.")
-(put 'viper-emacs-local-user-map 'permanent-local t)  
+(put 'viper-emacs-local-user-map 'permanent-local t)
 
 ;; This keymap should stay empty
 (defvar viper-empty-keymap (make-sparse-keymap))
 
 ;; This was the main Vi mode in old versions of VIP which may have been
-;; extensively used by VIP users. We declare it as a global var
+;; extensively used by VIP users.  We declare it as a global var
 ;; and, after .viper is loaded, we add this keymap to viper-vi-basic-map.
 (defvar viper-mode-map (make-sparse-keymap))
 
 
 ;;; Variables used by minor modes
 
-;; Association list of the form 
+;; Association list of the form
 ;; ((major-mode . keymap) (major-mode . keymap) ...)
 ;; Viper uses these keymaps to make user-requested adjustments
 ;; to its Vi state in various major modes.")
 (defvar viper-vi-state-modifier-alist nil)
 
-;; Association list of the form 
+;; Association list of the form
 ;; ((major-mode . keymap) (major-mode . keymap) ...)
 ;; Viper uses these keymaps to make user-requested adjustments
 ;; to its Insert state in various major modes.")
 (defvar viper-insert-state-modifier-alist nil)
 
-;; Association list of the form 
+;; Association list of the form
 ;; ((major-mode . keymap) (major-mode . keymap) ...)
 ;; Viper uses these keymaps to make user-requested adjustments
 ;; to its Emacs state in various major modes.
 (defvar viper-emacs-state-modifier-alist nil)
 
 ;; Tells viper-add-local-keys to create a new viper-vi-local-user-map for new
-;; buffers. Not a user option.
+;; buffers.  Not a user option.
 (viper-deflocalvar viper-need-new-vi-local-map t "")
 (put 'viper-need-new-vi-local-map  'permanent-local t)
 
 ;; Tells viper-add-local-keys to create a new viper-insert-local-user-map for
-;; new buffers. Not a user option.
+;; new buffers.  Not a user option.
 (viper-deflocalvar viper-need-new-insert-local-map t "")
 (put 'viper-need-new-insert-local-map  'permanent-local t)
 
 ;; Tells viper-add-local-keys to create a new viper-emacs-local-user-map for
-;; new buffers. Not a user option.
+;; new buffers.  Not a user option.
 (viper-deflocalvar viper-need-new-emacs-local-map t "")
 (put 'viper-need-new-emacs-local-map  'permanent-local t)
 
@@ -236,7 +240,7 @@ viper-insert-basic-map. Not recommended, except for novice users.")
 (define-key viper-insert-basic-map "\C-d" 'viper-backward-indent)
 (define-key viper-insert-basic-map "\C-w" 'viper-delete-backward-word)
 (define-key viper-insert-basic-map "\C-t" 'viper-forward-indent)
-(define-key viper-insert-basic-map 
+(define-key viper-insert-basic-map
   (if viper-xemacs-p [(shift tab)] [S-tab]) 'viper-insert-tab)
 (define-key viper-insert-basic-map "\C-v" 'quoted-insert)
 (define-key viper-insert-basic-map "\C-?" 'viper-del-backward-char-in-insert)
@@ -260,8 +264,8 @@ viper-insert-basic-map. Not recommended, except for novice users.")
 \f
 ;; Vi keymaps
 
-(define-key viper-vi-basic-map "\C-^" 
-  (function (lambda () (interactive) (viper-ex "e#"))))
+(define-key viper-vi-basic-map "\C-^" (lambda ()
+                                       (interactive) (viper-ex nil "e#")))
 (define-key viper-vi-basic-map "\C-b" 'viper-scroll-screen-back)
 (define-key viper-vi-basic-map "\C-d" 'viper-scroll-up)
 (define-key viper-vi-basic-map "\C-e" 'viper-scroll-up-one)
@@ -272,7 +276,7 @@ viper-insert-basic-map. Not recommended, except for novice users.")
 (define-key viper-vi-basic-map "\C-s" 'viper-isearch-forward)
 (define-key viper-vi-basic-map "\C-r" 'viper-isearch-backward)
 (define-key viper-vi-basic-map "\C-c/" 'viper-toggle-search-style)
-(define-key viper-vi-basic-map "\C-cg" 'viper-info-on-file)
+(define-key viper-vi-basic-map "\C-c\C-g" 'viper-info-on-file)
 
 (define-key viper-vi-basic-map "\C-c\M-p" 'viper-prev-destructive-command)
 (define-key viper-vi-basic-map "\C-c\M-n" 'viper-next-destructive-command)
@@ -284,8 +288,8 @@ viper-insert-basic-map. Not recommended, except for novice users.")
 (define-key viper-vi-basic-map "#" 'viper-command-argument)
 (define-key viper-vi-basic-map "$" 'viper-goto-eol)
 (define-key viper-vi-basic-map "%" 'viper-paren-match)
-(define-key viper-vi-basic-map "&"
-  (function (lambda () (interactive) (viper-ex "&"))))
+(define-key viper-vi-basic-map "&" (lambda ()
+                                    (interactive) (viper-ex nil "&")))
 (define-key viper-vi-basic-map "'" 'viper-goto-mark-and-skip-white)
 (define-key viper-vi-basic-map "(" 'viper-backward-sentence)
 (define-key viper-vi-basic-map ")" 'viper-forward-sentence)
@@ -390,7 +394,7 @@ viper-insert-basic-map. Not recommended, except for novice users.")
 (define-key viper-vi-basic-map "\C-?" 'viper-backward-char)
 (define-key viper-vi-basic-map "_" 'viper-nil)
 
-;;; This is viper-vi-diehard-map. Used when viper-vi-diehard-minor-mode is on.
+;;; This is viper-vi-diehard-map.  Used when viper-vi-diehard-minor-mode is on.
 
 (define-key viper-vi-diehard-map "\C-a" 'viper-nil)
 (define-key viper-vi-diehard-map "\C-c" 'viper-nil)
@@ -416,11 +420,11 @@ viper-insert-basic-map. Not recommended, except for novice users.")
 
 \f
 ;;; Minibuffer keymap
-  
+
 
 (defvar viper-minibuffer-map (make-sparse-keymap)
   "Keymap used to modify keys when Minibuffer is in Insert state.")
-  
+
 (define-key viper-minibuffer-map "\C-m" 'viper-exit-minibuffer)
 (define-key viper-minibuffer-map "\C-j" 'viper-exit-minibuffer)
 
@@ -443,8 +447,8 @@ Useful in some modes, such as Gnus, MH, etc.")
 
 (defvar viper-comint-mode-modifier-map (make-sparse-keymap)
   "This map modifies comint mode.")
-(define-key viper-comint-mode-modifier-map "\C-m" 'comint-send-input)
-(define-key viper-comint-mode-modifier-map "\C-d" 'comint-delchar-or-maybe-eof)
+(define-key viper-comint-mode-modifier-map "\C-m" 'viper-exec-key-in-emacs)
+(define-key viper-comint-mode-modifier-map "\C-d" 'viper-exec-key-in-emacs)
 
 (defvar viper-dired-modifier-map (make-sparse-keymap)
   "This map modifies Dired behavior.")
@@ -465,7 +469,7 @@ Normally, this would be called from a hook to a major mode or
 on a per buffer basis.
 Usage:
       (viper-add-local-keys state '((key-str . func) (key-str . func)...))   "
-      
+
   (let (map)
     (cond ((eq state 'vi-state)
           (if viper-need-new-vi-local-map
@@ -482,9 +486,9 @@ Usage:
               (setq viper-emacs-local-user-map (make-sparse-keymap)))
           (setq viper-need-new-emacs-local-map nil
                 map viper-emacs-local-user-map))
-         (t 
+         (t
           (error
-           "Invalid state in viper-add-local-keys: %S. Valid states: vi-state, insert-state or emacs-state" state)))
+           "Invalid state in viper-add-local-keys: %S.  Valid states: vi-state, insert-state or emacs-state" state)))
 
     (viper-modify-keymap map alist)
     (viper-normalize-minor-mode-map-alist)
@@ -503,16 +507,16 @@ sanity."
        viper-emacs-local-user-map (make-sparse-keymap)
        viper-need-new-emacs-local-map nil)
   (viper-normalize-minor-mode-map-alist))
-    
+
 
 (defun viper-modify-major-mode (mode state keymap)
   "Modify key bindings in a major-mode in a Viper state using a keymap.
 
 If the default for a major mode is emacs-state, then modifications to this
 major mode may not take effect until the buffer switches state to Vi,
-Insert or Emacs. If this happens, add viper-change-state-to-emacs to this
-major mode's hook. If no such hook exists, you may have to put an advice on
-the function that invokes the major mode. See viper-set-hooks for hints.
+Insert or Emacs.  If this happens, add viper-change-state-to-emacs to this
+major mode's hook.  If no such hook exists, you may have to put an advice on
+the function that invokes the major mode.  See viper-set-hooks for hints.
 
 The above needs not to be done for major modes that come up in Vi or Insert
 state by default.
@@ -526,16 +530,16 @@ Arguments: (major-mode viper-state keymap)"
     (if (setq elt (assoc mode (eval alist)))
        (set alist (delq elt (eval alist))))
     (set alist (cons (cons mode keymap) (eval alist)))
-    
+
     ;; Normalization usually doesn't help here, since one needs to
     ;; normalize in the actual buffer where changes to the keymap are
-    ;; to take place. However, it doesn't hurt, and it helps whenever this
+    ;; to take place.  However, it doesn't hurt, and it helps whenever this
     ;; function is actually called from within the affected buffer.
     (viper-normalize-minor-mode-map-alist)
-    
+
     (viper-set-mode-vars-for viper-current-state)))
 
-    
+
 ;; Displays variables that control Viper's keymaps
 (defun viper-debug-keymaps ()
   (interactive)
@@ -571,7 +575,7 @@ Arguments: (major-mode viper-state keymap)"
     (princ (format "viper-insert-global-user-minor-mode:  %S\n"
                   viper-insert-global-user-minor-mode))
     (princ (format "viper-insert-kbd-minor-mode:  %S\n"
-                  viper-insert-kbd-minor-mode)) 
+                  viper-insert-kbd-minor-mode))
     (princ (format "viper-insert-state-modifier-minor-mode:  %S\n"
                   viper-insert-state-modifier-minor-mode))
     (princ (format "viper-insert-diehard-minor-mode:  %S\n"
@@ -586,7 +590,7 @@ Arguments: (major-mode viper-state keymap)"
                   viper-emacs-global-user-minor-mode))
     (princ (format "viper-emacs-state-modifier-minor-mode:  %S\n"
                   viper-emacs-state-modifier-minor-mode))
-    
+
     (princ (format "\nviper-expert-level  %S\n" viper-expert-level))
     (princ (format "viper-no-multiple-ESC  %S\n" viper-no-multiple-ESC))
     (princ (format "viper-always  %S\n" viper-always))
@@ -595,38 +599,36 @@ Arguments: (major-mode viper-state keymap)"
     (princ (format "viper-ex-style-editing  %S\n"
                   viper-ex-style-editing))
     (princ (format "viper-want-emacs-keys-in-vi  %S\n"
-                  viper-want-emacs-keys-in-vi)) 
+                  viper-want-emacs-keys-in-vi))
     (princ (format "viper-want-emacs-keys-in-insert  %S\n"
-                  viper-want-emacs-keys-in-insert)) 
+                  viper-want-emacs-keys-in-insert))
     (princ (format "viper-want-ctl-h-help  %S\n" viper-want-ctl-h-help))
-    
+
     (princ "\n\n\n")
     (princ (format "Default value for minor-mode-map-alist:  \n%S\n\n"
                   (default-value 'minor-mode-map-alist)))
     (princ (format "Actual value for minor-mode-map-alist:  \n%S\n"
                   minor-mode-map-alist))
     ))
-   
+
 
 ;;; Keymap utils
-            
-(defun viper-add-keymap (mapsrc mapdst) 
-  "Add contents of mapsrc to mapdst. It is assumed that mapsrc is sparse."
-  (if viper-xemacs-p
-      (map-keymap (function (lambda (key binding)
-                             (define-key mapdst key binding)))
-                 mapsrc)
-    (mapcar 
-     (function (lambda (p) 
-                (define-key mapdst (vector (car p)) (cdr p))
-                ))
-     (cdr mapsrc))))
-  
+
+(defun viper-add-keymap (mapsrc mapdst)
+  "Add contents of mapsrc to mapdst.  It is assumed that mapsrc is sparse."
+  (viper-cond-compile-for-xemacs-or-emacs
+   ;; xemacs
+   (map-keymap (lambda (key binding) (define-key mapdst key binding))
+              mapsrc)
+   ;; emacs
+   (mapcar (lambda (p) (define-key mapdst (vector (car p)) (cdr p)))
+          (cdr mapsrc))
+   ))
+
 (defun viper-modify-keymap (map alist)
-   "Modifies MAP with bindings specified in the ALIST. The alist has the
+   "Modifies MAP with bindings specified in the ALIST.  The alist has the
 form ((key . function) (key . function) ... )."
-   (mapcar (function (lambda (p)
-                      (define-key map (eval (car p)) (cdr p)))) 
+   (mapcar (lambda (p) (define-key map (eval (car p)) (cdr p)))
           alist))
 
 
@@ -635,4 +637,5 @@ form ((key . function) (key . function) ... )."
 ;;; End:
 
 
-;;;  viper-keym.el ends here
+;;; arch-tag: 43af4b2f-0bea-400b-889e-221ebc00acb1
+;;; viper-keym.el ends here