[bpt/emacs.git] / lisp / leim / quail / uni-input.el

;;; uni-input.el --- Hex Unicode input method

;; Copyright (C) 2001-2013 Free Software Foundation, Inc.
;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
;;   National Institute of Advanced Industrial Science and Technology (AIST)
;;   Registration Number H14PRO021

;; Author: Dave Love <fx@gnu.org>
;; Keywords: i18n

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; 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.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; Provides an input method for entering characters by hex unicode in
;; the form `uxxxx', similarly to the Yudit editor.

;; This is not really a Quail method, but uses some Quail functions.
;; There is probably A Better Way.

;; You can get a similar effect by using C-q with
;; `read-quoted-char-radix' set to 16.

;; Note that this only allows you to enter BMP values unless someone
;; extends it to use variable numbers of digits.

;;; Code:

(require 'quail)

(defun ucs-input-insert-char (char)
  (insert char)
  (move-overlay quail-overlay (overlay-start quail-overlay) (point)))

(defun ucs-input-method (key)
  (if (or buffer-read-only
	  (and (/= key ?U) (/= key ?u)))
      (list key)
    (quail-setup-overlays nil)
    (ucs-input-insert-char key)
    (let ((modified-p (buffer-modified-p))
	  (buffer-undo-list t)
	  (input-method-function nil)
	  (echo-keystrokes 0)
	  (help-char nil)
	  (events (list key))
	  (str "    "))
      (unwind-protect
	  (catch 'non-digit
	    (progn
	      (dotimes (i 4)
		(let ((seq (read-key-sequence nil))
		      key)
		  (if (and (stringp seq)
			   (= 1 (length seq))
			   (setq key (aref seq 0))
			   (memq key '(?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?a
					  ?b ?c ?d ?e ?f ?A ?B ?C ?D ?E ?F)))
		      (progn
			(push key events)
			(ucs-input-insert-char key))
		    (quail-delete-region)
		    (throw 'non-digit (append (reverse events)
					      (listify-key-sequence seq))))))
	      (quail-delete-region)
	      (let ((n (string-to-number (apply 'string
					    (cdr (nreverse events)))
				     16)))
		(if (characterp n)
		    (list n)))))
	(quail-delete-overlays)
	(set-buffer-modified-p modified-p)
	(run-hooks 'input-method-after-insert-chunk-hook)))))

;;;###autoload
(defun ucs-input-activate (&optional arg)
  "Activate UCS input method.
With ARG, activate UCS input method if and only if ARG is positive.

While this input method is active, the variable
`input-method-function' is bound to the function `ucs-input-method'."
  (if (and arg
	  (< (prefix-numeric-value arg) 0))
      (unwind-protect
	  (progn
	    (quail-hide-guidance)
	    (quail-delete-overlays)
	    (setq describe-current-input-method-function nil))
	(kill-local-variable 'input-method-function))
    (setq deactivate-current-input-method-function 'ucs-input-deactivate)
    (setq describe-current-input-method-function 'ucs-input-help)
    (quail-delete-overlays)
    (if (eq (selected-window) (minibuffer-window))
	(add-hook 'minibuffer-exit-hook 'quail-exit-from-minibuffer))
    (set (make-local-variable 'input-method-function)
	 'ucs-input-method)))

(defun ucs-input-deactivate ()
  "Deactivate UCS input method."
  (interactive)
  (ucs-input-activate -1))

(define-obsolete-function-alias
  'ucs-input-inactivate
  'ucs-input-deactivate "24.3")

(defun ucs-input-help ()
  (interactive)
  (with-output-to-temp-buffer "*Help*"
    (princ "\
Input method: ucs (mode line indicator:U+)

Input as Unicode: U<hex> or u<hex>, where <hex> is a four-digit hex number.")))

;; The file leim-list.el contains the following call.
;; (register-input-method "ucs" "UTF-8" 'ucs-input-activate "U+"
;; 		       "Unicode input as hex in the form Uxxxx.")

(provide 'uni-input)

;; Local Variables:
;; generated-autoload-load-name: "quail/uni-input"
;; End:

;;; uni-input.el ends here
Commit	Line	Data
7115232b DL	1	;;; uni-input.el --- Hex Unicode input method
7115232b DL	2
ab422c4d	3	;; Copyright (C) 2001-2013 Free Software Foundation, Inc.
5df4f04c	4	;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
698218a2 KH	5	;; National Institute of Advanced Industrial Science and Technology (AIST)
698218a2 KH	6	;; Registration Number H14PRO021
7115232b DL	7
	8	;; Author: Dave Love <fx@gnu.org>
	9	;; Keywords: i18n
	10
041f4d74 PJ	11	;; This file is part of GNU Emacs.
041f4d74 PJ	12
3d544458	13	;; GNU Emacs is free software: you can redistribute it and/or modify
7115232b	14	;; it under the terms of the GNU General Public License as published by
3d544458 GM	15	;; the Free Software Foundation, either version 3 of the License, or
3d544458 GM	16	;; (at your option) any later version.
7115232b	17
3d544458	18	;; GNU Emacs is distributed in the hope that it will be useful,
7115232b DL	19	;; but WITHOUT ANY WARRANTY; without even the implied warranty of
	20	;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	21	;; GNU General Public License for more details.
	22
	23	;; You should have received a copy of the GNU General Public License
3d544458	24	;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
7115232b DL	25
	26	;;; Commentary:
	27
	28	;; Provides an input method for entering characters by hex unicode in
	29	;; the form `uxxxx', similarly to the Yudit editor.
	30
	31	;; This is not really a Quail method, but uses some Quail functions.
	32	;; There is probably A Better Way.
	33
d6e5e4db DL	34	;; You can get a similar effect by using C-q with
d6e5e4db DL	35	;; `read-quoted-char-radix' set to 16.
7115232b	36
5d9c1e7a DL	37	;; Note that this only allows you to enter BMP values unless someone
	38	;; extends it to use variable numbers of digits.
	39
7115232b DL	40	;;; Code:
	41
	42	(require 'quail)
	43
ad7d24c4 KH	44	(defun ucs-input-insert-char (char)
	45	(insert char)
	46	(move-overlay quail-overlay (overlay-start quail-overlay) (point)))
	47
7115232b DL	48	(defun ucs-input-method (key)
	49	(if (or buffer-read-only
	50	(and (/= key ?U) (/= key ?u)))
	51	(list key)
	52	(quail-setup-overlays nil)
ad7d24c4	53	(ucs-input-insert-char key)
7115232b DL	54	(let ((modified-p (buffer-modified-p))
	55	(buffer-undo-list t)
	56	(input-method-function nil)
	57	(echo-keystrokes 0)
	58	(help-char nil)
	59	(events (list key))
	60	(str " "))
	61	(unwind-protect
	62	(catch 'non-digit
	63	(progn
	64	(dotimes (i 4)
	65	(let ((seq (read-key-sequence nil))
	66	key)
	67	(if (and (stringp seq)
	68	(= 1 (length seq))
	69	(setq key (aref seq 0))
	70	(memq key '(?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?a
d6e5e4db	71	?b ?c ?d ?e ?f ?A ?B ?C ?D ?E ?F)))
7115232b DL	72	(progn
7115232b DL	73	(push key events)
ad7d24c4	74	(ucs-input-insert-char key))
7115232b DL	75	(quail-delete-region)
	76	(throw 'non-digit (append (reverse events)
	77	(listify-key-sequence seq))))))
	78	(quail-delete-region)
d6e5e4db DL	79	(let ((n (string-to-number (apply 'string
	80	(cdr (nreverse events)))
	81	16)))
	82	(if (characterp n)
	83	(list n)))))
7115232b DL	84	(quail-delete-overlays)
	85	(set-buffer-modified-p modified-p)
	86	(run-hooks 'input-method-after-insert-chunk-hook)))))
	87
cb6c95a3	88	;;;###autoload
7115232b DL	89	(defun ucs-input-activate (&optional arg)
7115232b DL	90	"Activate UCS input method.
e67e483f	91	With ARG, activate UCS input method if and only if ARG is positive.
7115232b DL	92
	93	While this input method is active, the variable
	94	`input-method-function' is bound to the function `ucs-input-method'."
	95	(if (and arg
	96	(< (prefix-numeric-value arg) 0))
	97	(unwind-protect
	98	(progn
ad7d24c4	99	(quail-hide-guidance)
7115232b DL	100	(quail-delete-overlays)
	101	(setq describe-current-input-method-function nil))
	102	(kill-local-variable 'input-method-function))
72b255c7	103	(setq deactivate-current-input-method-function 'ucs-input-deactivate)
7115232b DL	104	(setq describe-current-input-method-function 'ucs-input-help)
	105	(quail-delete-overlays)
	106	(if (eq (selected-window) (minibuffer-window))
	107	(add-hook 'minibuffer-exit-hook 'quail-exit-from-minibuffer))
7115232b DL	108	(set (make-local-variable 'input-method-function)
	109	'ucs-input-method)))
	110
72b255c7 PE	111	(defun ucs-input-deactivate ()
72b255c7 PE	112	"Deactivate UCS input method."
7115232b DL	113	(interactive)
	114	(ucs-input-activate -1))
	115
72b255c7 PE	116	(define-obsolete-function-alias
72b255c7 PE	117	'ucs-input-inactivate
2a1e2476	118	'ucs-input-deactivate "24.3")
72b255c7	119
7115232b DL	120	(defun ucs-input-help ()
	121	(interactive)
	122	(with-output-to-temp-buffer "Help"
	123	(princ "\
e4208ff7	124	Input method: ucs (mode line indicator:U+)
7115232b DL	125
	126	Input as Unicode: U<hex> or u<hex>, where <hex> is a four-digit hex number.")))
	127
cb6c95a3	128	;; The file leim-list.el contains the following call.
ad7d24c4 KH	129	;; (register-input-method "ucs" "UTF-8" 'ucs-input-activate "U+"
ad7d24c4 KH	130	;; "Unicode input as hex in the form Uxxxx.")
7115232b DL	131
	132	(provide 'uni-input)
	133
cb6c95a3 GM	134	;; Local Variables:
	135	;; generated-autoload-load-name: "quail/uni-input"
	136	;; End:
	137
7115232b	138	;;; uni-input.el ends here