Commit | Line | Data |
---|---|---|
60370d40 | 1 | ;;; composite.el --- support character composition |
c674f351 | 2 | |
d7a0267c | 3 | ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 |
ce03bf76 KH |
4 | ;; National Institute of Advanced Industrial Science and Technology (AIST) |
5 | ;; Registration Number H14PRO021 | |
c674f351 KH |
6 | |
7 | ;; Keywords: mule, multilingual, character composition | |
8 | ||
9 | ;; This file is part of GNU Emacs. | |
10 | ||
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 | ;; it under the terms of the GNU General Public License as published by | |
a32f6e9e | 13 | ;; the Free Software Foundation; either version 3, or (at your option) |
c674f351 KH |
14 | ;; any later version. |
15 | ||
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
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. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
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. | |
c674f351 | 25 | |
60370d40 PJ |
26 | ;;; Commentary: |
27 | ||
c674f351 KH |
28 | ;;; Code: |
29 | ||
c674f351 KH |
30 | (defconst reference-point-alist |
31 | '((tl . 0) (tc . 1) (tr . 2) | |
32 | (Bl . 3) (Bc . 4) (Br . 5) | |
33 | (bl . 6) (bc . 7) (br . 8) | |
34 | (cl . 9) (cc . 10) (cr . 11) | |
35 | (top-left . 0) (top-center . 1) (top-right . 2) | |
36 | (base-left . 3) (base-center . 4) (base-right . 5) | |
37 | (bottom-left . 6) (bottom-center . 7) (bottom-right . 8) | |
38 | (center-left . 9) (center-center . 10) (center-right . 11) | |
39 | ;; For backward compatibility... | |
40 | (ml . 3) (mc . 10) (mr . 5) | |
41 | (mid-left . 3) (mid-center . 10) (mid-right . 5)) | |
42 | "Alist of symbols vs integer codes of glyph reference points. | |
43 | A glyph reference point symbol is to be used to specify a composition | |
1d1af02d | 44 | rule in COMPONENTS argument to such functions as `compose-region'. |
c674f351 KH |
45 | |
46 | Meanings of glyph reference point codes are as follows: | |
47 | ||
48 | 0----1----2 <---- ascent 0:tl or top-left | |
49 | | | 1:tc or top-center | |
50 | | | 2:tr or top-right | |
51 | | | 3:Bl or base-left 9:cl or center-left | |
52 | 9 10 11 <---- center 4:Bc or base-center 10:cc or center-center | |
53 | | | 5:Br or base-right 11:cr or center-right | |
54 | --3----4----5-- <-- baseline 6:bl or bottom-left | |
55 | | | 7:bc or bottom-center | |
56 | 6----7----8 <---- descent 8:br or bottom-right | |
57 | ||
58 | Glyph reference point symbols are to be used to specify composition | |
59 | rule of the form \(GLOBAL-REF-POINT . NEW-REF-POINT), where | |
60 | GLOBAL-REF-POINT is a reference point in the overall glyphs already | |
61 | composed, and NEW-REF-POINT is a reference point in the new glyph to | |
62 | be added. | |
63 | ||
64 | For instance, if GLOBAL-REF-POINT is `br' (bottom-right) and | |
8f625692 | 65 | NEW-REF-POINT is `tc' (top-center), the overall glyph is updated as |
c674f351 KH |
66 | follows (the point `*' corresponds to both reference points): |
67 | ||
68 | +-------+--+ <--- new ascent | |
69 | | | | | |
70 | | global| | | |
71 | | glyph | | | |
72 | -- | | |-- <--- baseline \(doesn't change) | |
73 | +----+--*--+ | |
74 | | | new | | |
75 | | |glyph| | |
76 | +----+-----+ <--- new descent | |
9c87e5c4 KH |
77 | |
78 | A composition rule may have the form \(GLOBAL-REF-POINT | |
79 | NEW-REF-POINT XOFF YOFF), where XOFF and YOFF specifies how much | |
80 | to shift NEW-REF-POINT from GLOBAL-REF-POINT. In this case, XOFF | |
81 | and YOFF are integers in the range -100..100 representing the | |
82 | shifting percentage against the font size.") | |
c674f351 | 83 | |
c674f351 | 84 | |
59a2dac0 | 85 | ;;;###autoload |
c674f351 | 86 | (defun encode-composition-rule (rule) |
59a2dac0 KH |
87 | "Encode composition rule RULE into an integer value. |
88 | RULE is a cons of global and new reference point symbols | |
2624e2ac | 89 | \(see `reference-point-alist')." |
59a2dac0 KH |
90 | |
91 | ;; This must be compatible with C macro COMPOSITION_ENCODE_RULE | |
92 | ;; defined in composite.h. | |
93 | ||
c674f351 KH |
94 | (if (and (integerp rule) (< rule 144)) |
95 | ;; Already encoded. | |
96 | rule | |
9c87e5c4 KH |
97 | (if (consp rule) |
98 | (let ((gref (car rule)) | |
99 | (nref (cdr rule)) | |
100 | xoff yoff) | |
101 | (if (consp nref) ; (GREF NREF XOFF YOFF) | |
102 | (progn | |
103 | (setq xoff (nth 1 nref) | |
104 | yoff (nth 2 nref) | |
105 | nref (car nref)) | |
106 | (or (and (>= xoff -100) (<= xoff 100) | |
107 | (>= yoff -100) (<= yoff 100)) | |
108 | (error "Invalid compostion rule: %s" rule)) | |
109 | (setq xoff (+ xoff 128) yoff (+ yoff 128))) | |
110 | ;; (GREF . NREF) | |
111 | (setq xoff 0 yoff 0)) | |
112 | (or (integerp gref) | |
113 | (setq gref (cdr (assq gref reference-point-alist)))) | |
114 | (or (integerp nref) | |
115 | (setq nref (cdr (assq nref reference-point-alist)))) | |
116 | (or (and (>= gref 0) (< gref 12) (>= nref 0) (< nref 12)) | |
117 | (error "Invalid composition rule: %S" rule)) | |
118 | (logior (lsh xoff 16) (lsh yoff 8) (+ (* gref 12) nref))) | |
119 | (error "Invalid composition rule: %S" rule)))) | |
c674f351 KH |
120 | |
121 | ;; Decode encoded composition rule RULE-CODE. The value is a cons of | |
122 | ;; global and new reference point symbols. | |
123 | ;; This must be compatible with C macro COMPOSITION_DECODE_RULE | |
124 | ;; defined in composite.h. | |
125 | ||
126 | (defun decode-composition-rule (rule-code) | |
9c87e5c4 | 127 | (or (and (natnump rule-code) (< rule-code #x1000000)) |
c674f351 | 128 | (error "Invalid encoded composition rule: %S" rule-code)) |
9c87e5c4 KH |
129 | (let ((xoff (lsh rule-code -16)) |
130 | (yoff (logand (lsh rule-code -8) #xFF)) | |
131 | gref nref) | |
132 | (setq rule-code (logand rule-code #xFF) | |
133 | gref (car (rassq (/ rule-code 12) reference-point-alist)) | |
134 | nref (car (rassq (% rule-code 12) reference-point-alist))) | |
c674f351 KH |
135 | (or (and gref (symbolp gref) nref (symbolp nref)) |
136 | (error "Invalid composition rule code: %S" rule-code)) | |
9c87e5c4 KH |
137 | (if (and (= xoff 0) (= yoff 0)) |
138 | (cons gref nref) | |
139 | (setq xoff (- xoff 128) yoff (- yoff 128)) | |
140 | (list gref xoff yoff nref)))) | |
c674f351 KH |
141 | |
142 | ;; Encode composition rules in composition components COMPONENTS. The | |
143 | ;; value is a copy of COMPONENTS, where composition rules (cons of | |
144 | ;; global and new glyph reference point symbols) are replaced with | |
145 | ;; encoded composition rules. Optional 2nd argument NOCOPY non-nil | |
146 | ;; means don't make a copy but modify COMPONENTS directly. | |
147 | ||
148 | (defun encode-composition-components (components &optional nocopy) | |
149 | (or nocopy | |
150 | (setq components (copy-sequence components))) | |
151 | (if (vectorp components) | |
152 | (let ((len (length components)) | |
153 | (i 1)) | |
154 | (while (< i len) | |
155 | (aset components i | |
156 | (encode-composition-rule (aref components i))) | |
157 | (setq i (+ i 2)))) | |
158 | (let ((tail (cdr components))) | |
159 | (while tail | |
160 | (setcar tail | |
161 | (encode-composition-rule (car tail))) | |
162 | (setq tail (nthcdr 2 tail))))) | |
163 | components) | |
164 | ||
165 | ;; Decode composition rule codes in composition components COMPONENTS. | |
166 | ;; The value is a copy of COMPONENTS, where composition rule codes are | |
167 | ;; replaced with composition rules (cons of global and new glyph | |
168 | ;; reference point symbols). Optional 2nd argument NOCOPY non-nil | |
169 | ;; means don't make a copy but modify COMPONENTS directly. | |
170 | ;; It is assumed that COMPONENTS is a vector and is for rule-base | |
171 | ;; composition, thus (2N+1)th elements are rule codes. | |
172 | ||
173 | (defun decode-composition-components (components &optional nocopy) | |
174 | (or nocopy | |
175 | (setq components (copy-sequence components))) | |
176 | (let ((len (length components)) | |
177 | (i 1)) | |
178 | (while (< i len) | |
179 | (aset components i | |
180 | (decode-composition-rule (aref components i))) | |
181 | (setq i (+ i 2)))) | |
182 | components) | |
183 | ||
c674f351 KH |
184 | (defun compose-region (start end &optional components modification-func) |
185 | "Compose characters in the current region. | |
186 | ||
c9f60860 KH |
187 | Characters are composed relatively, i.e. composed by overstricking or |
188 | stacking depending on ascent, descent and other properties. | |
189 | ||
c674f351 KH |
190 | When called from a program, expects these four arguments. |
191 | ||
192 | First two arguments START and END are positions (integers or markers) | |
193 | specifying the region. | |
194 | ||
1d1af02d DL |
195 | Optional 3rd argument COMPONENTS, if non-nil, is a character, a string |
196 | or a vector or list of integers and rules. | |
c674f351 KH |
197 | |
198 | If it is a character, it is an alternate character to display instead | |
199 | of the text in the region. | |
200 | ||
201 | If it is a string, the elements are alternate characters. | |
202 | ||
203 | If it is a vector or list, it is a sequence of alternate characters and | |
204 | composition rules, where (2N)th elements are characters and (2N+1)th | |
205 | elements are composition rules to specify how to compose (2N+2)th | |
206 | elements with previously composed N glyphs. | |
207 | ||
208 | A composition rule is a cons of global and new glyph reference point | |
209 | symbols. See the documentation of `reference-point-alist' for more | |
210 | detail. | |
211 | ||
212 | Optional 4th argument MODIFICATION-FUNC is a function to call to | |
213 | adjust the composition when it gets invalid because of a change of | |
214 | text in the composition." | |
215 | (interactive "r") | |
216 | (let ((modified-p (buffer-modified-p)) | |
09d52401 | 217 | (inhibit-read-only t)) |
c674f351 KH |
218 | (if (or (vectorp components) (listp components)) |
219 | (setq components (encode-composition-components components))) | |
220 | (compose-region-internal start end components modification-func) | |
6b61353c | 221 | (restore-buffer-modified-p modified-p))) |
c674f351 | 222 | |
c674f351 KH |
223 | (defun decompose-region (start end) |
224 | "Decompose text in the current region. | |
225 | ||
226 | When called from a program, expects two arguments, | |
227 | positions (integers or markers) specifying the region." | |
228 | (interactive "r") | |
229 | (let ((modified-p (buffer-modified-p)) | |
09d52401 | 230 | (inhibit-read-only t)) |
c674f351 | 231 | (remove-text-properties start end '(composition nil)) |
09d52401 | 232 | (restore-buffer-modified-p modified-p))) |
c674f351 | 233 | |
c674f351 KH |
234 | (defun compose-string (string &optional start end components modification-func) |
235 | "Compose characters in string STRING. | |
236 | ||
c1750694 | 237 | The return value is STRING with the `composition' property put on all |
c674f351 KH |
238 | the characters in it. |
239 | ||
240 | Optional 2nd and 3rd arguments START and END specify the range of | |
c1750694 | 241 | STRING to be composed. They default to the beginning and the end of |
c674f351 KH |
242 | STRING respectively. |
243 | ||
244 | Optional 4th argument COMPONENTS, if non-nil, is a character or a | |
245 | sequence (vector, list, or string) of integers. See the function | |
246 | `compose-region' for more detail. | |
247 | ||
248 | Optional 5th argument MODIFICATION-FUNC is a function to call to | |
249 | adjust the composition when it gets invalid because of a change of | |
250 | text in the composition." | |
251 | (if (or (vectorp components) (listp components)) | |
252 | (setq components (encode-composition-components components))) | |
253 | (or start (setq start 0)) | |
254 | (or end (setq end (length string))) | |
255 | (compose-string-internal string start end components modification-func) | |
256 | string) | |
257 | ||
c674f351 KH |
258 | (defun decompose-string (string) |
259 | "Return STRING where `composition' property is removed." | |
260 | (remove-text-properties 0 (length string) '(composition nil) string) | |
261 | string) | |
262 | ||
c674f351 KH |
263 | (defun compose-chars (&rest args) |
264 | "Return a string from arguments in which all characters are composed. | |
265 | For relative composition, arguments are characters. | |
266 | For rule-based composition, Mth \(where M is odd) arguments are | |
267 | characters, and Nth \(where N is even) arguments are composition rules. | |
268 | A composition rule is a cons of glyph reference points of the form | |
269 | \(GLOBAL-REF-POINT . NEW-REF-POINT). See the documentation of | |
270 | `reference-point-alist' for more detail." | |
271 | (let (str components) | |
272 | (if (consp (car (cdr args))) | |
273 | ;; Rule-base composition. | |
274 | (let ((len (length args)) | |
275 | (tail (encode-composition-components args 'nocopy))) | |
276 | ||
277 | (while tail | |
278 | (setq str (cons (car tail) str)) | |
279 | (setq tail (nthcdr 2 tail))) | |
280 | (setq str (concat (nreverse str)) | |
281 | components args)) | |
282 | ;; Relative composition. | |
283 | (setq str (concat args))) | |
284 | (compose-string-internal str 0 (length str) components))) | |
285 | ||
c674f351 KH |
286 | (defun find-composition (pos &optional limit string detail-p) |
287 | "Return information about a composition at or nearest to buffer position POS. | |
288 | ||
289 | If the character at POS has `composition' property, the value is a list | |
290 | of FROM, TO, and VALID-P. | |
291 | ||
292 | FROM and TO specify the range of text that has the same `composition' | |
293 | property, VALID-P is non-nil if and only if this composition is valid. | |
294 | ||
295 | If there's no composition at POS, and the optional 2nd argument LIMIT | |
296 | is non-nil, search for a composition toward LIMIT. | |
297 | ||
298 | If no composition is found, return nil. | |
299 | ||
300 | Optional 3rd argument STRING, if non-nil, is a string to look for a | |
301 | composition in; nil means the current buffer. | |
302 | ||
303 | If a valid composition is found and the optional 4th argument DETAIL-P | |
304 | is non-nil, the return value is a list of FROM, TO, COMPONENTS, | |
305 | RELATIVE-P, MOD-FUNC, and WIDTH. | |
306 | ||
307 | COMPONENTS is a vector of integers, the meaning depends on RELATIVE-P. | |
308 | ||
309 | RELATIVE-P is t if the composition method is relative, else nil. | |
310 | ||
311 | If RELATIVE-P is t, COMPONENTS is a vector of characters to be | |
312 | composed. If RELATIVE-P is nil, COMPONENTS is a vector of characters | |
313 | and composition rules as described in `compose-region'. | |
314 | ||
315 | MOD-FUNC is a modification function of the composition. | |
316 | ||
317 | WIDTH is a number of columns the composition occupies on the screen." | |
318 | (let ((result (find-composition-internal pos limit string detail-p))) | |
319 | (if (and detail-p result (nth 2 result) (not (nth 3 result))) | |
320 | ;; This is a valid rule-base composition. | |
321 | (decode-composition-components (nth 2 result) 'nocopy)) | |
322 | result)) | |
323 | ||
324 | \f | |
7141ee65 | 325 | (defun compose-chars-after (pos &optional limit object) |
c674f351 KH |
326 | "Compose characters in current buffer after position POS. |
327 | ||
328 | It looks up the char-table `composition-function-table' (which see) by | |
329 | a character after POS. If non-nil value is found, the format of the | |
330 | value should be an alist of PATTERNs vs FUNCs, where PATTERNs are | |
331 | regular expressions and FUNCs are functions. If the text after POS | |
332 | matches one of PATTERNs, call the corresponding FUNC with three | |
333 | arguments POS, TO, and PATTERN, where TO is the end position of text | |
334 | matching PATTERN, and return what FUNC returns. Otherwise, return | |
335 | nil. | |
336 | ||
337 | FUNC is responsible for composing the text properly. The return value | |
338 | is: | |
339 | nil -- if no characters were composed. | |
340 | CHARS (integer) -- if CHARS characters were composed. | |
341 | ||
342 | Optional 2nd arg LIMIT, if non-nil, limits the matching of text. | |
343 | ||
7141ee65 | 344 | Optional 3rd arg OBJECT, if non-nil, is a string that contains the |
1d1af02d | 345 | text to compose. In that case, POS and LIMIT index into the string. |
7141ee65 | 346 | |
c674f351 KH |
347 | This function is the default value of `compose-chars-after-function'." |
348 | (let ((tail (aref composition-function-table (char-after pos))) | |
349 | pattern func result) | |
350 | (when tail | |
339cebdc KH |
351 | (save-match-data |
352 | (save-excursion | |
71296446 | 353 | (while (and tail (not func)) |
339cebdc KH |
354 | (setq pattern (car (car tail)) |
355 | func (cdr (car tail))) | |
356 | (goto-char pos) | |
357 | (if (if limit | |
358 | (and (re-search-forward pattern limit t) | |
359 | (= (match-beginning 0) pos)) | |
360 | (looking-at pattern)) | |
361 | (setq result (funcall func pos (match-end 0) pattern nil)) | |
362 | (setq func nil tail (cdr tail))))))) | |
c674f351 KH |
363 | result)) |
364 | ||
c674f351 KH |
365 | (defun compose-last-chars (args) |
366 | "Compose last characters. | |
3b923ad8 KH |
367 | The argument is a parameterized event of the form |
368 | \(compose-last-chars N COMPONENTS), | |
369 | where N is the number of characters before point to compose, | |
370 | COMPONENTS, if non-nil, is the same as the argument to `compose-region' | |
371 | \(which see). If it is nil, `compose-chars-after' is called, | |
2624e2ac | 372 | and that function finds a proper rule to compose the target characters. |
c674f351 KH |
373 | This function is intended to be used from input methods. |
374 | The global keymap binds special event `compose-last-chars' to this | |
3b923ad8 | 375 | function. Input method may generate an event (compose-last-chars N COMPONENTS) |
2624e2ac | 376 | after a sequence of character events." |
c674f351 KH |
377 | (interactive "e") |
378 | (let ((chars (nth 1 args))) | |
379 | (if (and (numberp chars) | |
380 | (>= (- (point) (point-min)) chars)) | |
3b923ad8 KH |
381 | (if (nth 2 args) |
382 | (compose-region (- (point) chars) (point) (nth 2 args)) | |
383 | (compose-chars-after (- (point) chars) (point)))))) | |
c674f351 | 384 | |
68fbe650 | 385 | (global-set-key [compose-last-chars] 'compose-last-chars) |
c674f351 KH |
386 | |
387 | \f | |
68fbe650 KH |
388 | ;;; Automatic character composition. |
389 | ||
390 | (defvar composition-function-table | |
391 | (make-char-table nil) | |
392 | "Char table of functions for automatic character composition. | |
393 | For each character that has to be composed automatically with | |
394 | preceding and/or following characters, this char table contains | |
395 | a function to call to compose that character. | |
396 | ||
397 | Each function is called with two arguments, POS and STRING. | |
398 | ||
399 | If STRING is nil, POS is a position in the current buffer, and the | |
400 | function has to compose a character at POS with surrounding characters | |
401 | in the current buffer. | |
402 | ||
1d1af02d | 403 | Otherwise, STRING is a string, and POS is an index into the string. In |
68fbe650 KH |
404 | this case, the function has to compose a character at POS with |
405 | surrounding characters in the string. | |
406 | ||
407 | See also the command `toggle-auto-composition'.") | |
408 | ||
409 | ;; Copied from font-lock.el. | |
410 | (eval-when-compile | |
68fbe650 KH |
411 | ;; Borrowed from lazy-lock.el. |
412 | ;; We use this to preserve or protect things when modifying text properties. | |
413 | (defmacro save-buffer-state (varlist &rest body) | |
414 | "Bind variables according to VARLIST and eval BODY restoring buffer state." | |
ba8972b6 KH |
415 | `(let* ,(append varlist |
416 | '((modified (buffer-modified-p)) (buffer-undo-list t) | |
417 | (inhibit-read-only t) (inhibit-point-motion-hooks t) | |
418 | (inhibit-modification-hooks t) | |
419 | deactivate-mark buffer-file-name buffer-file-truename)) | |
420 | ,@body | |
421 | (unless modified | |
422 | (restore-buffer-modified-p nil)))) | |
1d1af02d | 423 | ;; Fixme: This makes bootstrapping fail with this error. |
ba8972b6 KH |
424 | ;; Symbol's function definition is void: eval-defun |
425 | ;;(def-edebug-spec save-buffer-state let) | |
426 | ) | |
68fbe650 | 427 | |
02bf0a0a KH |
428 | (put 'save-buffer-state 'lisp-indent-function 1) |
429 | ||
70810634 KH |
430 | ;; This function is called when a composition created by |
431 | ;; terminal-composition-function is partially modified. | |
432 | (defun terminal-composition-modification (from to) | |
433 | (terminal-composition-function from)) | |
434 | ||
3f0cd392 KH |
435 | (defun terminal-composition-function (pos &optional string) |
436 | "General composition function used on terminal. | |
437 | Non-spacing characters are composed with the preceding spacing | |
438 | character. All non-spacing characters has this function in | |
439 | `terminal-composition-function-table'." | |
440 | (let ((from (1- pos)) | |
441 | ch) | |
442 | (if string | |
443 | (length string) | |
444 | (setq pos (1+ pos)) | |
445 | (while (and (< pos (point-max)) | |
446 | (= (aref char-width-table (char-after pos)) 0)) | |
447 | (setq pos (1+ pos))) | |
448 | (if (and (>= from (point-min)) | |
70810634 KH |
449 | (= (aref (symbol-name (get-char-code-property |
450 | (char-after from) | |
451 | 'general-category)) 0) ?L)) | |
3f0cd392 KH |
452 | (compose-region from pos (buffer-substring from pos)) |
453 | (compose-region (1+ from) pos | |
70810634 KH |
454 | (concat " " (buffer-substring (1+ from) pos)) |
455 | 'terminal-composition-modification)) | |
3f0cd392 KH |
456 | pos))) |
457 | ||
458 | (defvar terminal-composition-function-table | |
459 | (let ((table (make-char-table nil))) | |
460 | (map-char-table | |
461 | #'(lambda (key val) | |
462 | (if (= val 0) (set-char-table-range table key | |
463 | 'terminal-composition-function))) | |
464 | char-width-table) | |
465 | table) | |
466 | "Char table of functions for automatic character composition on terminal. | |
467 | This is like `composition-function-table' but used when Emacs is running | |
468 | on a terminal.") | |
469 | ||
5bb68653 KH |
470 | (defvar auto-compose-current-font nil |
471 | "The current font-object used for characters being composed automatically.") | |
472 | ||
4fa0f779 | 473 | (defun auto-compose-chars (pos string window) |
68fbe650 | 474 | "Compose characters after the buffer position POS. |
1d1af02d | 475 | If STRING is non-nil, it is a string, and POS is an index into the string. |
68fbe650 | 476 | In that case, compose characters in the string. |
4fa0f779 | 477 | WINDOW is a window displaying the current buffer. |
68fbe650 KH |
478 | |
479 | This function is the default value of `auto-composition-function' (which see)." | |
480 | (save-buffer-state nil | |
c8e89221 KH |
481 | (save-excursion |
482 | (save-match-data | |
1b9d9876 KH |
483 | (condition-case nil |
484 | (let ((start pos) | |
485 | (limit (if string (length string) (point-max))) | |
3f0cd392 KH |
486 | (table (if (display-graphic-p) |
487 | composition-function-table | |
488 | terminal-composition-function-table)) | |
4fa0f779 | 489 | auto-compose-current-font |
1b9d9876 KH |
490 | ch func newpos) |
491 | (setq limit | |
70740f9c KH |
492 | (or (text-property-any (1+ pos) limit 'auto-composed t |
493 | string) | |
1b9d9876 KH |
494 | limit) |
495 | pos | |
496 | (catch 'tag | |
8a0e01e2 KH |
497 | (if string |
498 | (while (< pos limit) | |
499 | (setq ch (aref string pos)) | |
500 | (if (= ch ?\n) | |
501 | (throw 'tag (1+ pos))) | |
3f0cd392 | 502 | (setq func (aref table ch)) |
8a0e01e2 | 503 | (if (and (functionp func) |
4fa0f779 KH |
504 | (setq auto-compose-current-font |
505 | (and window | |
506 | (font-at pos window string))) | |
8a0e01e2 KH |
507 | (setq newpos (funcall func pos string)) |
508 | (> newpos pos)) | |
509 | (setq pos newpos) | |
510 | (setq pos (1+ pos)))) | |
511 | (while (< pos limit) | |
512 | (setq ch (char-after pos)) | |
513 | (if (= ch ?\n) | |
514 | (throw 'tag (1+ pos))) | |
3f0cd392 | 515 | (setq func (aref table ch)) |
8a0e01e2 | 516 | (if (and (functionp func) |
4fa0f779 KH |
517 | (setq auto-compose-current-font |
518 | (and window (font-at pos window))) | |
8a0e01e2 KH |
519 | (setq newpos (funcall func pos string)) |
520 | (> newpos pos)) | |
521 | (setq pos newpos) | |
522 | (setq pos (1+ pos))))) | |
523 | limit)) | |
1b9d9876 KH |
524 | (put-text-property start pos 'auto-composed t string)) |
525 | (error nil)))))) | |
68fbe650 | 526 | |
37707939 KH |
527 | (make-variable-buffer-local 'auto-composition-function) |
528 | ||
16d58d04 | 529 | ;;;###autoload |
37707939 KH |
530 | (define-minor-mode auto-composition-mode |
531 | "Toggle Auto Compostion mode. | |
532 | With arg, turn Auto Compostion mode off if and only if arg is a non-positive | |
533 | number; if arg is nil, toggle Auto Compostion mode; anything else turns Auto | |
534 | Compostion on. | |
535 | ||
536 | When Auto Composition is enabled, text characters are automatically composed | |
537 | by functions registered in `composition-function-table' (which see). | |
538 | ||
539 | You can use Global Auto Composition mode to automagically turn on | |
540 | Auto Composition mode in all buffers (this is the default)." | |
541 | nil nil nil | |
542 | (if noninteractive | |
543 | (setq auto-composition-mode nil)) | |
544 | (cond (auto-composition-mode | |
545 | (add-hook 'after-change-functions 'auto-composition-after-change nil t) | |
546 | (setq auto-composition-function 'auto-compose-chars)) | |
547 | (t | |
548 | (remove-hook 'after-change-functions 'auto-composition-after-change t) | |
549 | (setq auto-composition-function nil))) | |
550 | (save-buffer-state nil | |
551 | (save-restriction | |
552 | (widen) | |
553 | (remove-text-properties (point-min) (point-max) '(auto-composed nil)) | |
554 | (decompose-region (point-min) (point-max))))) | |
555 | ||
556 | (defun auto-composition-after-change (start end old-len) | |
2968197a KH |
557 | (save-buffer-state nil |
558 | (if (< start (point-min)) | |
559 | (setq start (point-min))) | |
560 | (if (> end (point-max)) | |
561 | (setq end (point-max))) | |
562 | (when (and auto-composition-mode (not memory-full)) | |
563 | (let (func1 func2) | |
564 | (when (and (> start (point-min)) | |
565 | (setq func2 (aref composition-function-table | |
566 | (char-after (1- start)))) | |
567 | (or (= start (point-max)) | |
568 | (not (setq func1 (aref composition-function-table | |
569 | (char-after start)))) | |
570 | (eq func1 func2))) | |
571 | (setq start (1- start) | |
572 | func1 func2) | |
573 | (while (eq func1 func2) | |
574 | (if (> start (point-min)) | |
575 | (setq start (1- start) | |
576 | func2 (aref composition-function-table | |
577 | (char-after start))) | |
578 | (setq func2 nil)))) | |
579 | (when (and (< end (point-max)) | |
580 | (setq func2 (aref composition-function-table | |
581 | (char-after end))) | |
582 | (or (= end (point-min)) | |
583 | (not (setq func1 (aref composition-function-table | |
584 | (char-after (1- end))))) | |
585 | (eq func1 func2))) | |
586 | (setq end (1+ end) | |
587 | func1 func2) | |
588 | (while (eq func1 func2) | |
589 | (if (< end (point-max)) | |
590 | (setq func2 (aref composition-function-table | |
591 | (char-after end)) | |
592 | end (1+ end)) | |
593 | (setq func2 nil)))) | |
594 | (if (< start end) | |
c02e996e | 595 | (remove-text-properties start end '(auto-composed nil))))))) |
37707939 KH |
596 | |
597 | (defun turn-on-auto-composition-if-enabled () | |
2968197a KH |
598 | (if enable-multibyte-characters |
599 | (auto-composition-mode 1))) | |
37707939 | 600 | |
16d58d04 | 601 | ;;;###autoload |
37707939 KH |
602 | (define-global-minor-mode global-auto-composition-mode |
603 | auto-composition-mode turn-on-auto-composition-if-enabled | |
604 | :extra-args (dummy) | |
605 | :initialize 'custom-initialize-safe-default | |
379ef066 | 606 | :init-value (not noninteractive) |
37707939 KH |
607 | :group 'auto-composition |
608 | :version "23.1") | |
68fbe650 KH |
609 | |
610 | (defun toggle-auto-composition (&optional arg) | |
611 | "Change whether automatic character composition is enabled in this buffer. | |
612 | With arg, enable it iff arg is positive." | |
613 | (interactive "P") | |
614 | (let ((enable (if (null arg) (not auto-composition-function) | |
615 | (> (prefix-numeric-value arg) 0)))) | |
616 | (if enable | |
617 | (kill-local-variable 'auto-composition-function) | |
618 | (make-local-variable 'auto-composition-function) | |
619 | (setq auto-composition-function nil) | |
620 | (save-buffer-state nil | |
621 | (save-restriction | |
622 | (widen) | |
623 | (decompose-region (point-min) (point-max))))) | |
624 | ||
625 | (save-buffer-state nil | |
626 | (save-restriction | |
627 | (widen) | |
c02e996e KH |
628 | (remove-text-properties (point-min) (point-max) |
629 | '(auto-composed nil)))))) | |
bd4a85b9 KH |
630 | |
631 | (defun auto-compose-region (from to) | |
632 | "Force automatic character composition on the region FROM and TO." | |
633 | (save-excursion | |
634 | (if (get-text-property from 'auto-composed) | |
635 | (setq from (next-single-property-change from 'auto-composed nil to))) | |
636 | (goto-char from) | |
637 | (let ((modified-p (buffer-modified-p)) | |
638 | (inhibit-read-only '(composition auto-composed)) | |
639 | (stop (next-single-property-change (point) 'auto-composed nil to))) | |
640 | (while (< (point) to) | |
641 | (if (= (point) stop) | |
642 | (progn | |
643 | (goto-char (next-single-property-change (point) | |
644 | 'auto-composed nil to)) | |
645 | (setq stop (next-single-property-change (point) | |
646 | 'auto-composed nil to))) | |
647 | (let ((func (aref composition-function-table (following-char))) | |
648 | (pos (point))) | |
649 | (if (functionp func) | |
650 | (goto-char (funcall func (point) nil))) | |
651 | (if (<= (point) pos) | |
652 | (forward-char 1))))) | |
653 | (put-text-property from to 'auto-composed t) | |
654 | (set-buffer-modified-p modified-p)))) | |
655 | ||
c674f351 | 656 | \f |
09d52401 SM |
657 | ;; The following codes are only for backward compatibility with Emacs |
658 | ;; 20.4 and earlier. | |
c674f351 | 659 | |
c674f351 KH |
660 | (defun decompose-composite-char (char &optional type with-composition-rule) |
661 | "Convert CHAR to string. | |
c674f351 KH |
662 | |
663 | If optional 2nd arg TYPE is non-nil, it is `string', `list', or | |
1ea62389 JB |
664 | `vector'. In this case, CHAR is converted to string, list of CHAR, or |
665 | vector of CHAR respectively. | |
666 | Optional 3rd arg WITH-COMPOSITION-RULE is ignored." | |
c674f351 KH |
667 | (cond ((or (null type) (eq type 'string)) (char-to-string char)) |
668 | ((eq type 'list) (list char)) | |
669 | (t (vector char)))) | |
670 | ||
8d787845 KH |
671 | (make-obsolete 'decompose-composite-char 'char-to-string "21.1") |
672 | ||
c674f351 | 673 | \f |
6b61353c | 674 | |
09d52401 | 675 | ;; arch-tag: ee703d77-1723-45d4-a31f-e9f0f867aa33 |
c674f351 | 676 | ;;; composite.el ends here |