Keywords
-* @code{after}:: @code{:after}.
-* @code{bind-keymap} @code{bind-keymap*}:: @code{:bind-keymap}, @code{:bind-keymap*}.
-* @code{bind} @code{bind*}:: @code{:bind}, @code{:bind*}.
-* @code{commands}:: @code{:commands}.
-* @code{preface} @code{init} @code{config}:: @code{:preface}, @code{:init}, @code{:config}.
-* @code{custom}:: @code{:custom}.
-* @code{custom-face}:: @code{:custom-face}.
-* @code{defer} @code{demand}:: @code{:defer}, @code{:demand}.
-* @code{defines} @code{functions}:: @code{:defines}, @code{:functions}.
-* @code{diminish} @code{delight}:: @code{:diminish}, @code{:delight}.
-* @code{disabled}:: @code{:disabled}.
-* @code{ensure} @code{pin}:: @code{:ensure}, @code{:pin}.
-* @code{hook}:: @code{:hook}.
-* @code{if} @code{when} @code{unless}:: @code{:if}, @code{:when}, @code{:unless}.
+* @code{after}:: @code{:after}.
+* @code{bind-keymap} @code{bind-keymap*}:: @code{:bind-keymap}, @code{:bind-keymap*}.
+* @code{bind} @code{bind*}:: @code{:bind}, @code{:bind*}.
+* @code{commands}:: @code{:commands}.
+* @code{preface} @code{init} @code{config}:: @code{:preface}, @code{:init}, @code{:config}.
+* @code{custom}:: @code{:custom}.
+* @code{custom-face}:: @code{:custom-face}.
+* @code{defer} @code{demand}:: @code{:defer}, @code{:demand}.
+* @code{defines} @code{functions}:: @code{:defines}, @code{:functions}.
+* @code{diminish} @code{delight}:: @code{:diminish}, @code{:delight}.
+* @code{disabled}:: @code{:disabled}.
+* @code{ensure} @code{pin}:: @code{:ensure}, @code{:pin}.
+* @code{hook}:: @code{:hook}.
+* @code{if} @code{when} @code{unless}:: @code{:if}, @code{:when}, @code{:unless}.
* @code{load-path}:: @code{:load-path}.
-* @code{mode} @code{interpreter}:: @code{:mode}, @code{:interpreter}.
-* @code{magic} @code{magic-fallback}:: @code{:magic}, @code{:magic-fallback}.
+* @code{mode} @code{interpreter}:: @code{:mode}, @code{:interpreter}.
+* @code{magic} @code{magic-fallback}:: @code{:magic}, @code{:magic-fallback}.
* @code{no-require}:: @code{:no-require}.
-* @code{requires}:: @code{:requires}.
+* @code{requires}:: @code{:requires}.
@code{bind}, @code{bind*}
@chapter Keywords
@menu
-* @code{after}:: @code{after}.
-* @code{bind-keymap} @code{bind-keymap*}:: @code{:bind-keymap}, @code{:bind-keymap*}.
+* @code{after}:: @code{after}.
+* @code{bind-keymap} @code{bind-keymap*}:: @code{:bind-keymap}, @code{:bind-keymap*}.
* @code{bind} @code{bind*}:: @code{bind} @code{:bind*}.
-* @code{commands}:: @code{:commands}.
-* @code{preface} @code{init} @code{config}:: @code{:preface}, @code{:init}, @code{:config}.
-* @code{custom}:: @code{:custom}.
-* @code{custom-face}:: @code{:custom-face}.
-* @code{defer} @code{demand}:: @code{:defer}, @code{:demand}.
-* @code{defines} @code{functions}:: @code{:defines}, @code{:functions}.
-* @code{diminish} @code{delight}:: @code{:diminish}, @code{:delight}.
-* @code{disabled}:: @code{:disabled}.
-* @code{ensure} @code{pin}:: @code{:ensure}, @code{:pin}.
-* @code{hook}:: @code{:hook}.
-* @code{if} @code{when} @code{unless}:: @code{:if}, @code{:when}, @code{:unless}.
-* @code{load-path}:: @code{:load-path}.
-* @code{mode} @code{interpreter}:: @code{:mode}, @code{:interpreter}.
-* @code{magic} @code{magic-fallback}:: @code{:magic}, @code{:magic-fallback}.
-* @code{no-require}:: @code{:no-require}.
-* @code{requires}:: @code{:requires}.
+* @code{commands}:: @code{:commands}.
+* @code{preface} @code{init} @code{config}:: @code{:preface}, @code{:init}, @code{:config}.
+* @code{custom}:: @code{:custom}.
+* @code{custom-face}:: @code{:custom-face}.
+* @code{defer} @code{demand}:: @code{:defer}, @code{:demand}.
+* @code{defines} @code{functions}:: @code{:defines}, @code{:functions}.
+* @code{diminish} @code{delight}:: @code{:diminish}, @code{:delight}.
+* @code{disabled}:: @code{:disabled}.
+* @code{ensure} @code{pin}:: @code{:ensure}, @code{:pin}.
+* @code{hook}:: @code{:hook}.
+* @code{if} @code{when} @code{unless}:: @code{:if}, @code{:when}, @code{:unless}.
+* @code{load-path}:: @code{:load-path}.
+* @code{mode} @code{interpreter}:: @code{:mode}, @code{:interpreter}.
+* @code{magic} @code{magic-fallback}:: @code{:magic}, @code{:magic-fallback}.
+* @code{no-require}:: @code{:no-require}.
+* @code{requires}:: @code{:requires}.
@end menu
@node @code{after}
"Bind multiple chords at once.
Accepts keyword argument:
-:map - a keymap or list of keymaps into which the keybindings should be
- added
+:map - a keymap into which the keybindings should be added
The rest of the arguments are conses of keybinding string and a
function symbol (unquoted)."
"Similar to `bind-key', but overrides any mode-specific bindings."
`(bind-key ,key-name ,command override-global-map ,predicate))
-(defun bind-keys-form (args &rest keymaps)
+(defun bind-keys-form (args keymap)
"Bind multiple keys at once.
Accepts keyword arguments:
:map MAP - a keymap into which the keybindings should be
- added, or a list of such keymaps
+ added
:prefix KEY - prefix key for these bindings
:prefix-map MAP - name of the prefix map that should be created
for these bindings
The rest of the arguments are conses of keybinding string and a
function symbol (unquoted)."
- (let (maps
+ (let (map
prefix-doc
prefix-map
prefix
(while (and cont args)
(if (cond ((and (eq :map (car args))
(not prefix-map))
- (let ((arg (cadr args)))
- (setq maps (if (listp arg) arg (list arg)))))
+ (setq map (cadr args)))
((eq :prefix-docstring (car args))
(setq prefix-doc (cadr args)))
- ((eq :prefix-map (car args))
+ ((and (eq :prefix-map (car args))
+ (not (memq map '(global-map
+ override-global-map))))
(setq prefix-map (cadr args)))
((eq :repeat-docstring (car args))
(setq repeat-doc (cadr args)))
- ((eq :repeat-map (car args))
+ ((and (eq :repeat-map (car args))
+ (not (memq map '(global-map
+ override-global-map))))
(setq repeat-map (cadr args))
- (setq maps (list repeat-map)))
+ (setq map repeat-map))
((eq :continue (car args))
(setq repeat-type :continue
arg-change-func 'cdr))
(when (and menu-name (not prefix))
(error "If :menu-name is supplied, :prefix must be too"))
- (unless maps (setq maps keymaps))
- (unless maps (setq maps (list nil)))
+ (unless map (setq map keymap))
;; Process key binding arguments
(let (first next)
(setq first (list (car args))))
(setq args (cdr args))))
- (cl-labels
- ((wrap (maps bindings)
- (if (and pkg
- (cl-every
- (lambda (map)
- (and map
- (not (memq map '(global-map
- override-global-map)))))
- maps))
- `((if (mapcan 'boundp ',maps)
+ (cl-flet
+ ((wrap (map bindings)
+ (if (and map pkg (not (memq map '(global-map
+ override-global-map))))
+ `((if (boundp ',map)
,(macroexp-progn bindings)
(eval-after-load
,(if (symbolp pkg) `',pkg pkg)
',(macroexp-progn bindings))))
bindings)))
+
(append
+ (when prefix-map
+ `((defvar ,prefix-map)
+ ,@(when prefix-doc `((put ',prefix-map 'variable-documentation ,prefix-doc)))
+ ,@(if menu-name
+ `((define-prefix-command ',prefix-map nil ,menu-name))
+ `((define-prefix-command ',prefix-map)))
+ ,@(if (and map (not (eq map 'global-map)))
+ (wrap map `((bind-key ,prefix ',prefix-map ,map ,filter)))
+ `((bind-key ,prefix ',prefix-map nil ,filter)))))
(when repeat-map
`((defvar ,repeat-map (make-sparse-keymap)
,@(when repeat-doc `(,repeat-doc)))))
- (if prefix-map
- `((defvar ,prefix-map)
- ,@(when prefix-doc `((put ',prefix-map 'variable-documentation ,prefix-doc)))
- ,@(if menu-name
- `((define-prefix-command ',prefix-map nil ,menu-name))
- `((define-prefix-command ',prefix-map)))
- ,@(cl-mapcan
- (lambda (map)
- (wrap (list map)
- `((bind-key ,prefix ',prefix-map ,map ,filter))))
- maps)
- ,@(wrap maps
- (cl-mapcan
- (lambda (form)
- (let ((fun
- (and (cdr form) (list 'function (cdr form)))))
- `((bind-key ,(car form) ,fun ,prefix-map ,filter))))
- first)))
- (cl-mapcan
- (lambda (map)
- (wrap (list map)
- (cl-mapcan
- (lambda (form)
- (let ((fun (and (cdr form) (list 'function (cdr form)))))
- (if (and map (not (eq map 'global-map)))
- ;; Only needed in this branch, since when
- ;; repeat-map is non-nil, map is always
- ;; non-nil
- `(,@(when (and repeat-map
- (not (eq repeat-type :exit)))
- `((put ,fun 'repeat-map ',repeat-map)))
- (bind-key ,(car form) ,fun ,map ,filter))
- `((bind-key ,(car form) ,fun nil ,filter)))))
- first)))
- maps))
+ (wrap map
+ (cl-mapcan
+ (lambda (form)
+ (let ((fun (and (cdr form) (list 'function (cdr form)))))
+ (if prefix-map
+ `((bind-key ,(car form) ,fun ,prefix-map ,filter))
+ (if (and map (not (eq map 'global-map)))
+ ;; Only needed in this branch, since when
+ ;; repeat-map is non-nil, map is always
+ ;; non-nil
+ `(,@(when (and repeat-map (not (eq repeat-type :exit)))
+ `((put ,fun 'repeat-map ',repeat-map)))
+ (bind-key ,(car form) ,fun ,map ,filter))
+ `((bind-key ,(car form) ,fun nil ,filter))))))
+ first))
(when next
- (apply 'bind-keys-form
- `(,@(when repeat-map `(:repeat-map ,repeat-map))
- ,@(if pkg
- (cons :package (cons pkg next))
- next))
- maps)))))))
+ (bind-keys-form `(,@(when repeat-map `(:repeat-map ,repeat-map))
+ ,@(if pkg
+ (cons :package (cons pkg next))
+ next)) map)))))))
;;;###autoload
(defmacro bind-keys (&rest args)
Accepts keyword arguments:
:map MAP - a keymap into which the keybindings should be
- added, or a list of such keymaps
+ added
:prefix KEY - prefix key for these bindings
:prefix-map MAP - name of the prefix map that should be created
for these bindings
;; :prefix-docstring STRING
;; :prefix-map SYMBOL
;; :prefix STRING
- ;; :repeat-docstring STRING
+ ;; :repeat-docstring STRING
;; :repeat-map SYMBOL
;; :filter SEXP
;; :menu-name STRING
;; :package SYMBOL
- ;; :continue and :exit are used within :repeat-map
- ((or (and (eq x :map) (or (symbolp (cadr arg))
- (listp (cadr arg))))
+ ;; :continue and :exit are used within :repeat-map
+ ((or (and (eq x :map) (symbolp (cadr arg)))
(and (eq x :prefix) (stringp (cadr arg)))
(and (eq x :prefix-map) (symbolp (cadr arg)))
(and (eq x :prefix-docstring) (stringp (cadr arg)))
- (and (eq x :repeat-map) (symbolp (cadr arg)))
- (eq x :continue)
- (eq x :exit)
+ (and (eq x :repeat-map) (symbolp (cadr arg)))
+ (eq x :continue)
+ (eq x :exit)
(and (eq x :repeat-docstring) (stringp (cadr arg)))
(eq x :filter)
(and (eq x :menu-name) (stringp (cadr arg)))
(autoload #'nonexistent-mode "nonexistent" nil t))
(add-hook 'lisp-mode-hook #'nonexistent-mode)))))
-(ert-deftest bind-key/:map ()
- (match-expansion
- (bind-keys
- ("C-1" . command-1)
- ("C-2" . command-2)
- :map keymap-1
- ("C-3" . command-3)
- ("C-4" . command-4)
- :map (keymap-2 keymap-3)
- ("C-5" . command-5)
- ("C-6" . command-6))
- `(progn (bind-key "C-1" #'command-1 nil nil)
- (bind-key "C-2" #'command-2 nil nil)
- (bind-key "C-3" #'command-3 keymap-1 nil)
- (bind-key "C-4" #'command-4 keymap-1 nil)
- (bind-key "C-5" #'command-5 keymap-2 nil)
- (bind-key "C-6" #'command-6 keymap-2 nil)
- (bind-key "C-5" #'command-5 keymap-3 nil)
- (bind-key "C-6" #'command-6 keymap-3 nil))))
-
(ert-deftest bind-key/:prefix-map ()
(match-expansion
- (bind-keys ("C-1" . command-1)
- :prefix "<f1>"
- :prefix-map my/map
- ("C-2" . command-2)
- ("C-3" . command-3))
+ (bind-keys :prefix "<f1>"
+ :prefix-map my/map)
`(progn
- (bind-key "C-1" #'command-1 nil nil)
(defvar my/map)
(define-prefix-command 'my/map)
- (bind-key "<f1>" 'my/map nil nil)
- (bind-key "C-2" #'command-2 my/map nil)
- (bind-key "C-3" #'command-3 my/map nil))))
-
-(ert-deftest bind-key/:repeat-map-1 ()
- ;; NOTE: This test is pulled from the discussion in issue #964,
- ;; adjusting for the final syntax that was implemented.
- (match-expansion
- (bind-keys
- ("C-c n" . git-gutter+-next-hunk)
- ("C-c p" . git-gutter+-previous-hunk)
- ("C-c s" . git-gutter+-stage-hunks)
- ("C-c r" . git-gutter+-revert-hunk)
- :repeat-map my/git-gutter+-repeat-map
- ("n" . git-gutter+-next-hunk)
- ("p" . git-gutter+-previous-hunk)
- ("s" . git-gutter+-stage-hunks)
- ("r" . git-gutter+-revert-hunk)
- :repeat-docstring
- "Keymap to repeat git-gutter+-* commands.")
- `(progn
- (bind-key "C-c n" #'git-gutter+-next-hunk nil nil)
- (bind-key "C-c p" #'git-gutter+-previous-hunk nil nil)
- (bind-key "C-c s" #'git-gutter+-stage-hunks nil nil)
- (bind-key "C-c r" #'git-gutter+-revert-hunk nil nil)
- (defvar my/git-gutter+-repeat-map (make-sparse-keymap))
- (put #'git-gutter+-next-hunk 'repeat-map 'my/git-gutter+-repeat-map)
- (bind-key "n" #'git-gutter+-next-hunk my/git-gutter+-repeat-map nil)
- (put #'git-gutter+-previous-hunk 'repeat-map 'my/git-gutter+-repeat-map)
- (bind-key "p" #'git-gutter+-previous-hunk my/git-gutter+-repeat-map nil)
- (put #'git-gutter+-stage-hunks 'repeat-map 'my/git-gutter+-repeat-map)
- (bind-key "s" #'git-gutter+-stage-hunks my/git-gutter+-repeat-map nil)
- (put #'git-gutter+-revert-hunk 'repeat-map 'my/git-gutter+-repeat-map)
- (bind-key "r" #'git-gutter+-revert-hunk my/git-gutter+-repeat-map nil)
- (defvar my/git-gutter+-repeat-map (make-sparse-keymap) "Keymap to repeat git-gutter+-* commands."))))
-
-(ert-deftest bind-key/:repeat-map-2 ()
- (match-expansion
- (bind-keys :map m ("x" . cmd1) :repeat-map rm ("y" . cmd2))
- `(progn
- (bind-key "x" #'cmd1 m nil)
- (defvar rm (make-sparse-keymap))
- (put #'cmd2 'repeat-map 'rm)
- (bind-key "y" #'cmd2 rm nil))))
-
-(ert-deftest bind-key/:repeat-map-3 ()
- (match-expansion
- (bind-keys :repeat-map rm ("y" . cmd2) :map m ("x" . cmd1))
- `(progn
- (defvar rm (make-sparse-keymap))
- (put #'cmd2 'repeat-map 'rm)
- (bind-key "y" #'cmd2 rm nil)
- (defvar rm (make-sparse-keymap))
- (put #'cmd1 'repeat-map 'rm)
- (bind-key "x" #'cmd1 m nil))))
+ (bind-key "<f1>" 'my/map nil nil))))
+
(ert-deftest bind-key/845 ()
(defvar test-map (make-keymap))
projects / emacs.git / commitdiff