Commit | Line | Data |
---|---|---|
e8af40ee | 1 | ;;; double.el --- support for keyboard remapping with double clicking |
fc429cfe | 2 | |
e91081eb | 3 | ;; Copyright (C) 1994, 1997, 1998, 2001, 2002, 2003, 2004, |
d7a0267c | 4 | ;; 2005, 2006, 2007 Free Software Foundation, Inc. |
fc429cfe | 5 | |
3efc86ef | 6 | ;; Author: Per Abrahamsen <abraham@dina.kvl.dk> |
fc429cfe | 7 | ;; Keywords: i18n |
fc429cfe | 8 | |
70d949ea RS |
9 | ;; This file is part of GNU Emacs. |
10 | ||
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
fc429cfe | 12 | ;; it under the terms of the GNU General Public License as published by |
b4aa6026 | 13 | ;; the Free Software Foundation; either version 3, or (at your option) |
fc429cfe | 14 | ;; any later version. |
70d949ea RS |
15 | |
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
fc429cfe RS |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
70d949ea | 20 | |
fc429cfe | 21 | ;; You should have received a copy of the GNU General Public License |
b578f267 | 22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
086add15 LK |
23 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 | ;; Boston, MA 02110-1301, USA. | |
fc429cfe RS |
25 | |
26 | ;;; Commentary: | |
27 | ||
28 | ;; This mode is intended for use with languages that adds a small | |
29 | ;; number of extra letters not available on the keyboard. | |
71296446 | 30 | ;; |
fc429cfe RS |
31 | ;; Examples includes Scandinavian and German with an US keyboard. |
32 | ;; | |
33 | ;; The idea is that certain keys are overloaded. When you press it | |
34 | ;; once it will insert one string, and when you press it twice the | |
35 | ;; string will be replaced by another. This can be used for mapping | |
36 | ;; keys on a US keyboard to generate characters according to the local | |
37 | ;; keyboard convention when pressed once, and according to US keyboard | |
71296446 | 38 | ;; convention when pressed twice. |
fc429cfe RS |
39 | ;; |
40 | ;; To use this mode, you must define the variable `double-map' and | |
41 | ;; then enable double mode with `M-x double-mode'. Read the | |
42 | ;; documentation for both of them. | |
43 | ;; | |
44 | ;; The default mapping is for getting Danish/Norwegian keyboard layout | |
45 | ;; using ISO Latin 1 on a US keyboard. | |
46 | ;; | |
a7acbbe4 | 47 | ;; Important node: While I would like to hear comments, bug reports, |
fc429cfe | 48 | ;; suggestions, please do @strong{not} expect me to put other mappings |
a7acbbe4 | 49 | ;; than the default into this file. There are billions and billions |
fc429cfe RS |
50 | ;; of such mappings, and just supporting the most common would |
51 | ;; increase the size of this nice small file manyfold. | |
52 | ||
fc429cfe RS |
53 | ;;; Code: |
54 | ||
7b33b170 KH |
55 | (defgroup double nil |
56 | "Remap keyboard, but get original by typing the same key twice." | |
57 | :group 'i18n) | |
58 | ||
59 | (defcustom double-map | |
fc429cfe RS |
60 | '((?\; "\346" ";") |
61 | (?\' "\370" "'") | |
62 | (?\[ "\345" "[") | |
63 | (?\: "\306" ":") | |
64 | (?\" "\330" "\"") | |
65 | (?\{ "\305" "{")) | |
66 | "Alist of key translations activated by double mode. | |
67 | ||
68 | Each entry is a list with three elements: | |
69 | 1. The key activating the translation. | |
70 | 2. The string to be inserted when the key is pressed once. | |
7b33b170 KH |
71 | 3. The string to be inserted when the key is pressed twice." |
72 | :group 'double | |
73 | :type '(repeat (list (character :tag "Key") | |
74 | (string :tag "Once") | |
75 | (string :tag "Twice")))) | |
fc429cfe | 76 | |
7b33b170 | 77 | (defcustom double-prefix-only t |
48a0ae63 | 78 | "*Non-nil means that Double mode mapping only works for prefix keys. |
8a3663f3 | 79 | That is, for any key `X' in `double-map', `X' alone will be mapped |
7b33b170 KH |
80 | but not `C-u X' or `ESC X' since the X is not the prefix key." |
81 | :group 'double | |
82 | :type 'boolean) | |
5867a409 | 83 | |
fc429cfe RS |
84 | ;;; Read Event |
85 | ||
86 | (defvar double-last-event nil) | |
87 | ;; The last key that generated a double key event. | |
88 | ||
89 | (defun double-read-event (prompt) | |
90 | ;; Read an event | |
91 | (if isearch-mode (isearch-update)) | |
92 | (if prompt | |
93 | (prog2 (message "%s%c" prompt double-last-event) | |
94 | (read-event) | |
95 | (message "")) | |
96 | (read-event))) | |
97 | ||
f55e5c6b | 98 | (global-set-key [ignore] '(lambda () (interactive))) |
fc429cfe RS |
99 | |
100 | (or (boundp 'isearch-mode-map) | |
101 | (load-library "isearch")) | |
102 | ||
71296446 | 103 | (define-key isearch-mode-map [ignore] |
fc429cfe RS |
104 | (function (lambda () (interactive) (isearch-update)))) |
105 | ||
106 | (defun double-translate-key (prompt) | |
107 | ;; Translate input events using double map. | |
108 | (let ((key last-input-char)) | |
109 | (cond (unread-command-events | |
110 | ;; Artificial event, ignore it. | |
111 | (vector key)) | |
5867a409 RS |
112 | ((and double-prefix-only |
113 | (> (length (this-command-keys)) 1)) | |
114 | ;; This is not a prefix key, ignore it. | |
115 | (vector key)) | |
fc429cfe RS |
116 | ((eq key 'magic-start) |
117 | ;; End of generated event. See if he will repeat it... | |
118 | (let ((new (double-read-event prompt)) | |
119 | (entry (assoc double-last-event double-map))) | |
18d2b950 | 120 | (force-window-update (selected-window)) |
fc429cfe | 121 | (if (eq new double-last-event) |
71296446 | 122 | (progn |
fc429cfe RS |
123 | (setq unread-command-events |
124 | (append (make-list (1- (length (nth 1 entry))) | |
f55e5c6b | 125 | 127) |
fc429cfe RS |
126 | (nth 2 entry) |
127 | '(magic-end))) | |
128 | (vector 127)) | |
129 | (setq unread-command-events (list new)) | |
f55e5c6b | 130 | [ignore]))) |
fc429cfe RS |
131 | ((eq key 'magic-end) |
132 | ;; End of double event. Ignore. | |
f55e5c6b | 133 | [ignore]) |
fc429cfe RS |
134 | (t |
135 | ;; New key. | |
136 | (let ((exp (nth 1 (assoc key double-map)))) | |
137 | (setq double-last-event key) | |
138 | (setq unread-command-events | |
139 | (append (substring exp 1) '(magic-start))) | |
140 | (vector (aref exp 0))))))) | |
141 | ||
142 | ;;; Key Translation Map | |
143 | ||
7cda860e RS |
144 | (defun double-setup (enable-flag) |
145 | (if enable-flag | |
146 | (progn | |
147 | ;; Set up key-translation-map as indicated by `double-map'. | |
ac09dc1e KL |
148 | ;; XXX I don't think key-translation-map should be made local here. -- Lorentey |
149 | (kill-local-variable 'key-translation-map) | |
150 | (make-local-variable 'key-translation-map) | |
151 | (setq key-translation-map (if (keymapp key-translation-map) | |
152 | (copy-keymap key-translation-map) | |
4ea81208 | 153 | (make-sparse-keymap))) |
7cda860e | 154 | (mapcar (function (lambda (entry) |
ac09dc1e | 155 | (define-key key-translation-map |
7cda860e RS |
156 | (vector (nth 0 entry)) |
157 | 'double-translate-key))) | |
158 | (append double-map '((magic-start) (magic-end))))) | |
ac09dc1e | 159 | (kill-local-variable 'key-translation-map))) |
fc429cfe RS |
160 | |
161 | ;;; Mode | |
162 | ||
61355f1c DL |
163 | ;;;###autoload |
164 | (defcustom double-mode nil | |
165 | "Toggle Double mode. | |
166 | Setting this variable directly does not take effect; | |
167 | use either \\[customize] or the function `double-mode'." | |
168 | :set (lambda (symbol value) | |
169 | (double-mode (if value 1 0))) | |
170 | :initialize 'custom-initialize-default | |
171 | :link '(emacs-commentary-link "double") | |
172 | :type 'boolean | |
173 | :require 'double | |
174 | :group 'double) | |
175 | (make-variable-buffer-local 'double-mode) | |
fc429cfe RS |
176 | |
177 | (or (assq 'double-mode minor-mode-alist) | |
178 | (setq minor-mode-alist | |
48a0ae63 | 179 | (cons '(double-mode " Double") minor-mode-alist))) |
fc429cfe | 180 | |
48a0ae63 RS |
181 | ;; This feature seemed useless and it confused describe-mode, |
182 | ;; so I deleted it. | |
183 | ;;;(defvar double-mode-name "Double") | |
184 | ;;;;; Name of current double mode. | |
185 | ;;; (make-variable-buffer-local 'double-mode-name) | |
fc429cfe RS |
186 | |
187 | ;;;###autoload | |
188 | (defun double-mode (arg) | |
48a0ae63 | 189 | "Toggle Double mode. |
4837b516 GM |
190 | With prefix argument ARG, turn Double mode on if ARG is positive, otherwise |
191 | turn it off. | |
fc429cfe | 192 | |
e6f1da19 KH |
193 | When Double mode is on, some keys will insert different strings |
194 | when pressed twice. See variable `double-map' for details." | |
fc429cfe RS |
195 | (interactive "P") |
196 | (if (or (and (null arg) double-mode) | |
197 | (<= (prefix-numeric-value arg) 0)) | |
198 | ;; Turn it off | |
199 | (if double-mode | |
200 | (progn | |
201 | (let ((double-map)) | |
7cda860e | 202 | (double-setup nil)) |
fc429cfe | 203 | (setq double-mode nil) |
e6f1da19 | 204 | (force-mode-line-update))) |
fc429cfe RS |
205 | ;;Turn it on |
206 | (if double-mode | |
207 | () | |
7cda860e | 208 | (double-setup t) |
fc429cfe | 209 | (setq double-mode t) |
e6f1da19 | 210 | (force-mode-line-update)))) |
fc429cfe RS |
211 | |
212 | (provide 'double) | |
213 | ||
ab5796a9 | 214 | ;;; arch-tag: 2e170036-44cb-4493-bc32-ada0a4395221 |
fc429cfe | 215 | ;;; double.el ends here |