1 ;;; keypad.el --- simplified keypad bindings
3 ;; Copyright (C) 2002 Free Software Foundation, Inc.
5 ;; Author: Kim F. Storm <storm@cua.dk>
6 ;; Keywords: keyboard convenience
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; The keypad package allows easy binding of the keypad keys to
28 ;; various commonly used sets of commands.
30 ;; With the following setup, the keypad can be used for numeric data
31 ;; entry when NumLock is off, and to give numeric prefix arguments to
32 ;; emacs commands, when NumLock on on.
34 ;; keypad-setup => Plain Numeric Keypad
35 ;; keypad-numlock-setup => Prefix numeric args
37 ;; +--------+--------+--------+
38 ;; | M-7 | M-8 | M-9 | <- numlock on
39 ;; | 7 | 8 | 9 | <- numlock off
40 ;; +--------+--------+--------+
41 ;; | M-4 | M-5 | M-6 |
43 ;; +--------+--------+--------+
44 ;; | M-1 | M-2 | M-3 |
46 ;; +--------+--------+--------+
49 ;; +-----------------+--------+
51 ;; The following keypad setup is used for navigation together with
52 ;; modes like cua-mode which uses shifted movement keys to extend the
55 ;; keypad-setup => Cursor keys
56 ;; keypad-shifted-setup => Shifted cursor keys
58 ;; +--------+--------+--------+
59 ;; | S-home | S-up | S-PgUp | <- shifted, numlock off
60 ;; | Home | up | PgUp | <- unshifted, numlock off
61 ;; +--------+--------+--------+
62 ;; | S-left |S-space |S-right |
63 ;; | left | space | right |
64 ;; +--------+--------+--------+
65 ;; | S-end | S-down | S-PgDn |
66 ;; | end | down | PgDn |
67 ;; +--------+--------+--------+
68 ;; | S-insert |S-delete|
69 ;; | insert | delete |
70 ;; +-----------------+--------+
72 ;; The following setup binds the unshifted keypad keys to plain
73 ;; numeric keys when NumLock is either on or off, but the decimal key
74 ;; produces either a . (NumLock off) or a , (NumLock on). This is
75 ;; useful for e.g. Danish users where the decimal separator is a
78 ;; keypad-setup => Plain Numeric Keypad
79 ;; keypad-numlock-setup => Numeric Keypad with Decimal key: ,
81 ;; +--------+--------+--------+
82 ;; | 7 | 8 | 9 | <- numlock on
83 ;; | 7 | 8 | 9 | <- numlock off
84 ;; +--------+--------+--------+
87 ;; +--------+--------+--------+
90 ;; +--------+--------+--------+
93 ;; +-----------------+--------+
102 (defcustom keypad-setup nil
103 "Specifies the keypad setup for unshifted keypad keys when NumLock is off.
104 When selecting the plain numeric keypad setup, the character returned by the
105 decimal key must be specified."
106 :set (lambda (symbol value)
108 (keypad-setup value nil nil value)))
109 :initialize 'custom-initialize-default
110 :link '(emacs-commentary-link "keypad.el")
112 :type '(choice (const :tag "Plain numeric keypad" numeric)
113 (character :tag "Numeric Keypad with Decimal Key"
114 :match (lambda (widget value) (integerp value))
116 (const :tag "Numeric prefix arguments" prefix)
117 (const :tag "Cursor keys" cursor)
118 (const :tag "Shifted cursor keys" S-cursor)
119 (const :tag "Remove bindings" none)
120 (other :tag "Keep existing bindings" nil))
124 (defcustom keypad-numlock-setup nil
125 "Specifies the keypad setup for unshifted keypad keys when NumLock is on.
126 When selecting the plain numeric keypad setup, the character returned by the
127 decimal key must be specified."
128 :set (lambda (symbol value)
130 (keypad-setup value t nil value)))
131 :initialize 'custom-initialize-default
132 :link '(emacs-commentary-link "keypad.el")
134 :type '(choice (const :tag "Plain numeric keypad" numeric)
135 (character :tag "Numeric Keypad with Decimal Key"
136 :match (lambda (widget value) (integerp value))
138 (const :tag "Numeric prefix arguments" prefix)
139 (const :tag "Cursor keys" cursor)
140 (const :tag "Shifted cursor keys" S-cursor)
141 (const :tag "Remove bindings" none)
142 (other :tag "Keep existing bindings" nil))
146 (defcustom keypad-shifted-setup nil
147 "Specifies the keypad setup for shifted keypad keys when NumLock is off.
148 When selecting the plain numeric keypad setup, the character returned by the
149 decimal key must be specified."
150 :set (lambda (symbol value)
152 (keypad-setup value nil t value)))
153 :initialize 'custom-initialize-default
154 :link '(emacs-commentary-link "keypad.el")
156 :type '(choice (const :tag "Plain numeric keypad" numeric)
157 (character :tag "Numeric Keypad with Decimal Key"
158 :match (lambda (widget value) (integerp value))
160 (const :tag "Numeric prefix arguments" prefix)
161 (const :tag "Cursor keys" cursor)
162 (const :tag "Shifted cursor keys" S-cursor)
163 (const :tag "Remove bindings" none)
164 (other :tag "Keep existing bindings" nil))
168 (defcustom keypad-numlock-shifted-setup nil
169 "Specifies the keypad setup for shifted keypad keys when NumLock is off.
170 When selecting the plain numeric keypad setup, the character returned by the
171 decimal key must be specified."
172 :set (lambda (symbol value)
174 (keypad-setup value t t value)))
175 :initialize 'custom-initialize-default
176 :link '(emacs-commentary-link "keypad.el")
178 :type '(choice (const :tag "Plain numeric keypad" numeric)
179 (character :tag "Numeric Keypad with Decimal Key"
180 :match (lambda (widget value) (integerp value))
182 (const :tag "Numeric prefix arguments" prefix)
183 (const :tag "Cursor keys" cursor)
184 (const :tag "Shifted cursor keys" S-cursor)
185 (const :tag "Remove bindings" none)
186 (other :tag "Keep existing bindings" nil))
191 (defun keypad-setup (setup &optional numlock shift decimal)
192 "Set keypad bindings in function-key-map according to SETUP.
193 If optional second argument NUMLOCK is non-nil, the NumLock On bindings
194 are changed. Otherwise, the NumLock Off bindings are changed.
195 If optional third argument SHIFT is non-nil, the shifted keypad
199 -------------------------------------------------------------
200 'prefix Command prefix argument, i.e. M-0 .. M-9 and M--
201 'S-cursor Bind shifted keypad keys to the shifted cursor movement keys.
202 'cursor Bind keypad keys to the cursor movement keys.
203 'numeric Plain numeric keypad, i.e. 0 .. 9 and . (or DECIMAL arg)
204 'none Removes all bindings for keypad keys in function-key-map.
206 If SETUP is 'numeric and the optional fourth argument DECIMAL is non-nil,
207 the decimal key on the keypad is mapped to DECIMAL instead of `.'"
210 ((and (not numlock) (not shift)) 'keypad-setup)
211 ((and (not numlock) shift) 'keypad-shifted-setup)
212 ((and numlock (not shift)) 'keypad-numlock-setup)
213 ((and numlock shift) 'keypad-numlock-shifted-setup)))
215 ((eq var 'keypad-setup)
216 [kp-delete kp-insert kp-end kp-down kp-next kp-left
217 kp-space kp-right kp-home kp-up kp-prior])
218 ((eq var 'keypad-shifted-setup)
219 [S-kp-decimal S-kp-0 S-kp-1 S-kp-2 S-kp-3 S-kp-4
220 S-kp-5 S-kp-6 S-kp-7 S-kp-8 S-kp-9])
221 ((eq var 'keypad-numlock-setup)
222 [kp-decimal kp-0 kp-1 kp-2 kp-3 kp-4
223 kp-5 kp-6 kp-7 kp-8 kp-9])
224 ((eq var 'keypad-numlock-shifted-setup)
225 [S-kp-delete S-kp-insert S-kp-end S-kp-down S-kp-next S-kp-left
226 S-kp-space S-kp-right S-kp-home S-kp-up S-kp-prior])))
229 ((or (eq setup 'numeric)
230 (char-valid-p setup))
231 (if (eq decimal 'numeric)
233 (vector (or decimal ?.) ?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9))
235 [?\M-- ?\M-0 ?\M-1 ?\M-2 ?\M-3 ?\M-4
236 ?\M-5 ?\M-6 ?\M-7 ?\M-8 ?\M-9])
238 [delete insert end down next left
239 space right home up prior])
240 ((eq setup 'S-cursor)
241 [S-delete S-insert S-end S-down S-next S-left
242 S-space S-right S-home S-up S-prior])
246 (signal 'error (list "Unknown keypad setup: " setup))))))
250 ;; Bind the keys in KP list to BIND list in function-key-map.
251 ;; If BIND is nil, all bindings for the keys are removed.
252 (if (not (boundp 'function-key-map))
253 (setq function-key-map (make-sparse-keymap)))
256 (define-key function-key-map (vector (aref kp i))
257 (if bind (vector (aref bind i))))
260 ;;; keypad.el ends here