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

3
;; Copyright (C) 1994, 1997, 1998 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4

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

Richard M. Stallman's avatar
Richard M. Stallman committed
8 9 10
;; 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
11 12 13
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
14 15

;; GNU Emacs is distributed in the hope that it will be useful,
Richard M. Stallman's avatar
Richard M. Stallman committed
16 17 18
;; 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
19

Richard M. Stallman's avatar
Richard M. Stallman committed
20
;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
21 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
24 25 26 27 28 29 30 31 32 33 34 35 36

;;; Commentary:

;; This mode is intended for use with languages that adds a small
;; number of extra letters not available on the keyboard.
;; 
;; 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
Karl Heuer's avatar
Karl Heuer committed
37
;; convention when pressed twice. 
Richard M. Stallman's avatar
Richard M. Stallman committed
38 39 40 41 42 43 44 45
;;
;; 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
46
;; Important node: While I would like to hear comments, bug reports,
Richard M. Stallman's avatar
Richard M. Stallman committed
47
;; suggestions, please do @strong{not} expect me to put other mappings
Karl Heuer's avatar
Karl Heuer committed
48
;; than the default into this file.  There are billions and billions
Richard M. Stallman's avatar
Richard M. Stallman committed
49 50 51 52 53
;; of such mappings, and just supporting the most common would
;; increase the size of this nice small file manyfold.

;;; Code:

54 55 56 57 58
(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
59 60 61 62 63 64 65 66 67 68 69
  '((?\; "\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.
70 71 72 73 74
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
75

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

Richard M. Stallman's avatar
Richard M. Stallman committed
83 84 85 86 87 88 89 90 91 92 93 94 95 96
;;; 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)))

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

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

102
(define-key isearch-mode-map [ignore] 
Richard M. Stallman's avatar
Richard M. Stallman committed
103 104 105 106 107 108 109 110
  (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))
111 112 113 114
	  ((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
115 116 117 118 119 120 121 122
	  ((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)))
	     (if (eq new double-last-event)
		 (progn 
		   (setq unread-command-events
			 (append (make-list (1- (length (nth 1 entry)))
123
					    127)
Richard M. Stallman's avatar
Richard M. Stallman committed
124 125 126 127
				 (nth 2 entry)
				 '(magic-end)))
		   (vector 127))
	       (setq unread-command-events (list new))
128
	       [ignore])))
Richard M. Stallman's avatar
Richard M. Stallman committed
129 130
	  ((eq key 'magic-end)
	   ;; End of double event.  Ignore.
131
	   [ignore])
Richard M. Stallman's avatar
Richard M. Stallman committed
132 133 134 135 136 137 138 139 140 141
	  (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

142 143 144 145 146 147
(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)
148 149 150
	(setq key-translation-map (if (keymapp key-translation-map)
				      (copy-keymap key-translation-map)
				    (make-sparse-keymap)))
151 152 153 154 155 156
	(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
157 158 159 160 161 162 163 164 165

;;; Mode

(defvar double-mode nil)
;; Indicator for the double mode.
  (make-variable-buffer-local 'double-mode)

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

168 169 170 171 172
;; 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
173 174 175

;;;###autoload
(defun double-mode (arg)
176 177
  "Toggle Double mode.
With prefix arg, turn Double mode on iff arg is positive.
Richard M. Stallman's avatar
Richard M. Stallman committed
178

179 180
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
181 182 183 184 185 186 187
  (interactive "P")
  (if (or (and (null arg) double-mode)
	  (<= (prefix-numeric-value arg) 0))
      ;; Turn it off
      (if double-mode
	  (progn
	    (let ((double-map))
188
	      (double-setup nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
189
	    (setq double-mode nil)
190
	    (force-mode-line-update)))
Richard M. Stallman's avatar
Richard M. Stallman committed
191 192 193
    ;;Turn it on
    (if double-mode
	()
194
      (double-setup t)
Richard M. Stallman's avatar
Richard M. Stallman committed
195
      (setq double-mode t)
196
      (force-mode-line-update))))
Richard M. Stallman's avatar
Richard M. Stallman committed
197 198 199 200 201

(provide 'double)

;;; double.el ends here