double.el 6.74 KB
Newer Older
1
;;; double.el --- support for keyboard remapping with double clicking
Richard M. Stallman's avatar
Richard M. Stallman committed
2

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1994, 1997, 1998, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5

Per Abrahamsen's avatar
Per Abrahamsen committed
6
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
Richard M. Stallman's avatar
Richard M. Stallman committed
7 8
;; Keywords: i18n

Richard M. Stallman's avatar
Richard M. Stallman committed
9 10 11
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
12
;; it under the terms of the GNU General Public License as published by
13
;; the Free Software Foundation; either version 3, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
14
;; any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
15 16

;; GNU Emacs is distributed in the hope that it will be useful,
Richard M. Stallman's avatar
Richard M. Stallman committed
17 18 19
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.
Richard M. Stallman's avatar
Richard M. Stallman committed
20

Richard M. Stallman's avatar
Richard M. Stallman committed
21
;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
22
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
25 26 27 28 29

;;; Commentary:

;; This mode is intended for use with languages that adds a small
;; number of extra letters not available on the keyboard.
30
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
31 32 33 34 35 36 37
;; Examples includes Scandinavian and German with an US keyboard.
;;
;; The idea is that certain keys are overloaded.  When you press it
;; once it will insert one string, and when you press it twice the
;; string will be replaced by another.  This can be used for mapping
;; keys on a US keyboard to generate characters according to the local
;; keyboard convention when pressed once, and according to US keyboard
38
;; convention when pressed twice.
Richard M. Stallman's avatar
Richard M. Stallman committed
39 40 41 42 43 44 45 46
;;
;; To use this mode, you must define the variable `double-map' and
;; then enable double mode with `M-x double-mode'.  Read the
;; documentation for both of them.
;;
;; The default mapping is for getting Danish/Norwegian keyboard layout
;; using ISO Latin 1 on a US keyboard.
;;
Karl Heuer's avatar
Karl Heuer committed
47
;; Important node: While I would like to hear comments, bug reports,
Richard M. Stallman's avatar
Richard M. Stallman committed
48
;; suggestions, please do @strong{not} expect me to put other mappings
Karl Heuer's avatar
Karl Heuer committed
49
;; than the default into this file.  There are billions and billions
Richard M. Stallman's avatar
Richard M. Stallman committed
50 51 52 53 54
;; of such mappings, and just supporting the most common would
;; increase the size of this nice small file manyfold.

;;; Code:

55 56 57 58 59
(defgroup double nil
  "Remap keyboard, but get original by typing the same key twice."
  :group 'i18n)

(defcustom double-map
Richard M. Stallman's avatar
Richard M. Stallman committed
60 61 62 63 64 65 66 67 68 69 70
  '((?\; "\346" ";")
    (?\' "\370" "'")
    (?\[ "\345" "[")
    (?\: "\306" ":")
    (?\" "\330" "\"")
    (?\{ "\305" "{"))
  "Alist of key translations activated by double mode.

Each entry is a list with three elements:
1. The key activating the translation.
2. The string to be inserted when the key is pressed once.
71 72 73 74 75
3. The string to be inserted when the key is pressed twice."
  :group 'double
  :type '(repeat (list (character :tag "Key")
		       (string :tag "Once")
		       (string :tag "Twice"))))
Richard M. Stallman's avatar
Richard M. Stallman committed
76

77
(defcustom double-prefix-only t
78
  "*Non-nil means that Double mode mapping only works for prefix keys.
79
That is, for any key `X' in `double-map', `X' alone will be mapped
80 81 82
but not `C-u X' or `ESC X' since the X is not the prefix key."
  :group 'double
  :type 'boolean)
83

Richard M. Stallman's avatar
Richard M. Stallman committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97
;;; Read Event

(defvar double-last-event nil)
;; The last key that generated a double key event.

(defun double-read-event (prompt)
  ;; Read an event
  (if isearch-mode (isearch-update))
  (if prompt
      (prog2 (message "%s%c" prompt double-last-event)
	  (read-event)
	(message ""))
    (read-event)))

98
(global-set-key [ignore] '(lambda () (interactive)))
Richard M. Stallman's avatar
Richard M. Stallman committed
99 100 101 102

(or (boundp 'isearch-mode-map)
    (load-library "isearch"))

103
(define-key isearch-mode-map [ignore]
Richard M. Stallman's avatar
Richard M. Stallman committed
104 105 106 107 108 109 110 111
  (function (lambda () (interactive) (isearch-update))))

(defun double-translate-key (prompt)
  ;; Translate input events using double map.
  (let ((key last-input-char))
    (cond (unread-command-events
	   ;; Artificial event, ignore it.
	   (vector key))
112 113 114 115
	  ((and double-prefix-only
		(> (length (this-command-keys)) 1))
	   ;; This is not a prefix key, ignore it.
	   (vector key))
Richard M. Stallman's avatar
Richard M. Stallman committed
116 117 118 119
	  ((eq key 'magic-start)
	   ;; End of generated event.  See if he will repeat it...
	   (let ((new (double-read-event prompt))
		 (entry (assoc double-last-event double-map)))
120
	     (force-window-update (selected-window))
Richard M. Stallman's avatar
Richard M. Stallman committed
121
	     (if (eq new double-last-event)
122
		 (progn
Richard M. Stallman's avatar
Richard M. Stallman committed
123 124
		   (setq unread-command-events
			 (append (make-list (1- (length (nth 1 entry)))
125
					    127)
Richard M. Stallman's avatar
Richard M. Stallman committed
126 127 128 129
				 (nth 2 entry)
				 '(magic-end)))
		   (vector 127))
	       (setq unread-command-events (list new))
130
	       [ignore])))
Richard M. Stallman's avatar
Richard M. Stallman committed
131 132
	  ((eq key 'magic-end)
	   ;; End of double event.  Ignore.
133
	   [ignore])
Richard M. Stallman's avatar
Richard M. Stallman committed
134 135 136 137 138 139 140 141 142 143
	  (t
	   ;; New key.
	   (let ((exp (nth 1 (assoc key double-map))))
	     (setq double-last-event key)
	     (setq unread-command-events
		   (append (substring exp 1) '(magic-start)))
	     (vector (aref exp 0)))))))

;;; Key Translation Map

144 145 146 147 148 149
(defun double-setup (enable-flag)
  (if enable-flag
      (progn
	;; Set up key-translation-map as indicated by `double-map'.
	(kill-local-variable 'key-translation-map)
	(make-local-variable 'key-translation-map)
150 151 152
	(setq key-translation-map (if (keymapp key-translation-map)
				      (copy-keymap key-translation-map)
				    (make-sparse-keymap)))
153 154 155 156 157 158
	(mapcar (function (lambda (entry)
			    (define-key key-translation-map
			      (vector (nth 0 entry))
			      'double-translate-key)))
		(append double-map '((magic-start) (magic-end)))))
    (kill-local-variable 'key-translation-map)))
Richard M. Stallman's avatar
Richard M. Stallman committed
159 160 161

;;; Mode

162 163 164 165 166 167 168 169 170 171 172 173 174
;;;###autoload
(defcustom double-mode nil
  "Toggle Double mode.
Setting this variable directly does not take effect;
use either \\[customize] or the function `double-mode'."
  :set (lambda (symbol value)
	 (double-mode (if value 1 0)))
  :initialize 'custom-initialize-default
  :link '(emacs-commentary-link "double")
  :type 'boolean
  :require 'double
  :group 'double)
(make-variable-buffer-local 'double-mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
175 176 177

(or (assq 'double-mode minor-mode-alist)
    (setq minor-mode-alist
178
	  (cons '(double-mode " Double") minor-mode-alist)))
Richard M. Stallman's avatar
Richard M. Stallman committed
179

180 181 182 183 184
;; This feature seemed useless and it confused describe-mode,
;;  so I deleted it.
;;;(defvar double-mode-name "Double")
;;;;; Name of current double mode.
;;; (make-variable-buffer-local 'double-mode-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
185 186 187

;;;###autoload
(defun double-mode (arg)
188
  "Toggle Double mode.
189 190
With prefix argument ARG, turn Double mode on if ARG is positive, otherwise
turn it off.
Richard M. Stallman's avatar
Richard M. Stallman committed
191

192 193
When Double mode is on, some keys will insert different strings
when pressed twice.  See variable `double-map' for details."
Richard M. Stallman's avatar
Richard M. Stallman committed
194 195 196 197 198 199 200
  (interactive "P")
  (if (or (and (null arg) double-mode)
	  (<= (prefix-numeric-value arg) 0))
      ;; Turn it off
      (if double-mode
	  (progn
	    (let ((double-map))
201
	      (double-setup nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
202
	    (setq double-mode nil)
203
	    (force-mode-line-update)))
Richard M. Stallman's avatar
Richard M. Stallman committed
204 205 206
    ;;Turn it on
    (if double-mode
	()
207
      (double-setup t)
Richard M. Stallman's avatar
Richard M. Stallman committed
208
      (setq double-mode t)
209
      (force-mode-line-update))))
Richard M. Stallman's avatar
Richard M. Stallman committed
210 211 212

(provide 'double)

Miles Bader's avatar
Miles Bader committed
213
;;; arch-tag: 2e170036-44cb-4493-bc32-ada0a4395221
Richard M. Stallman's avatar
Richard M. Stallman committed
214
;;; double.el ends here