annotate src/composite.h @ 91692:b3be38e00c57

(lisp): New variable. (EMACSLOADPATH): Use $(lisp). Add lisp/international and lisp/emacs-lisp.
author Eli Zaretskii <eliz@gnu.org>
date Sat, 09 Feb 2008 09:28:31 +0000
parents 63d4513550f9
children 29adfc9354e7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
1 /* Header for composite sequence handler.
68651
3bd95f4f2941 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 67658
diff changeset
2 Copyright (C) 2001, 2002, 2003, 2004, 2005,
79759
fc2bcd2a8aad Add 2008 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 78501
diff changeset
3 2006, 2007, 2008 Free Software Foundation, Inc.
fc2bcd2a8aad Add 2008 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 78501
diff changeset
4 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
67658
547f2b420666 Copyright fixed
Kenichi Handa <handa@m17n.org>
parents: 65486
diff changeset
5 National Institute of Advanced Industrial Science and Technology (AIST)
547f2b420666 Copyright fixed
Kenichi Handa <handa@m17n.org>
parents: 65486
diff changeset
6 Registration Number H14PRO021
90404
a7d267afebf9 (enum composition_method) [USE_FONT_BACKEND]: New
Kenichi Handa <handa@m17n.org>
parents: 90294
diff changeset
7 Copyright (C) 2003, 2006
88367
bc14316e7ce2 (enum composition_method): Order of enumeration
Kenichi Handa <handa@m17n.org>
parents: 38484
diff changeset
8 National Institute of Advanced Industrial Science and Technology (AIST)
bc14316e7ce2 (enum composition_method): Order of enumeration
Kenichi Handa <handa@m17n.org>
parents: 38484
diff changeset
9 Registration Number H13PRO009
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
10
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
11 This file is part of GNU Emacs.
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
12
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
13 GNU Emacs is free software; you can redistribute it and/or modify
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
14 it under the terms of the GNU General Public License as published by
78313
2b9404c2f01f Remove license from trivial file.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
15 the Free Software Foundation; either version 3, or (at your option)
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
16 any later version.
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
17
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
18 GNU Emacs is distributed in the hope that it will be useful,
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
21 GNU General Public License for more details.
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
22
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
23 You should have received a copy of the GNU General Public License
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
24 along with GNU Emacs; see the file COPYING. If not, write to
64084
a8fa7c632ee4 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
25 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
a8fa7c632ee4 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
26 Boston, MA 02110-1301, USA. */
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
27
29572
d88f50e982a1 (EMACS_COMPOSITE_H): Renamed from _COMPOSITE_H.
Kenichi Handa <handa@m17n.org>
parents: 26992
diff changeset
28 #ifndef EMACS_COMPOSITE_H
d88f50e982a1 (EMACS_COMPOSITE_H): Renamed from _COMPOSITE_H.
Kenichi Handa <handa@m17n.org>
parents: 26992
diff changeset
29 #define EMACS_COMPOSITE_H
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
30
90404
a7d267afebf9 (enum composition_method) [USE_FONT_BACKEND]: New
Kenichi Handa <handa@m17n.org>
parents: 90294
diff changeset
31 /* Methods to display a sequence of components of a composition. */
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
32 enum composition_method {
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
33 /* Compose relatively without alternate characters. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
34 COMPOSITION_RELATIVE,
88367
bc14316e7ce2 (enum composition_method): Order of enumeration
Kenichi Handa <handa@m17n.org>
parents: 38484
diff changeset
35 /* Compose by specified composition rules. This is not used in
bc14316e7ce2 (enum composition_method): Order of enumeration
Kenichi Handa <handa@m17n.org>
parents: 38484
diff changeset
36 Emacs 21 but we need it to decode files saved in the older
bc14316e7ce2 (enum composition_method): Order of enumeration
Kenichi Handa <handa@m17n.org>
parents: 38484
diff changeset
37 versions of Emacs. */
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
38 COMPOSITION_WITH_RULE,
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
39 /* Compose relatively with alternate characters. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
40 COMPOSITION_WITH_ALTCHARS,
88367
bc14316e7ce2 (enum composition_method): Order of enumeration
Kenichi Handa <handa@m17n.org>
parents: 38484
diff changeset
41 /* Compose by specified composition rules with alternate characters. */
bc14316e7ce2 (enum composition_method): Order of enumeration
Kenichi Handa <handa@m17n.org>
parents: 38484
diff changeset
42 COMPOSITION_WITH_RULE_ALTCHARS,
90404
a7d267afebf9 (enum composition_method) [USE_FONT_BACKEND]: New
Kenichi Handa <handa@m17n.org>
parents: 90294
diff changeset
43 /* Compose by specified lispy glyph-string. */
a7d267afebf9 (enum composition_method) [USE_FONT_BACKEND]: New
Kenichi Handa <handa@m17n.org>
parents: 90294
diff changeset
44 COMPOSITION_WITH_GLYPH_STRING,
88367
bc14316e7ce2 (enum composition_method): Order of enumeration
Kenichi Handa <handa@m17n.org>
parents: 38484
diff changeset
45 /* This is not a method. */
bc14316e7ce2 (enum composition_method): Order of enumeration
Kenichi Handa <handa@m17n.org>
parents: 38484
diff changeset
46 COMPOSITION_NO
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
47 };
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
48
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
49 /* Maximum number of compoments a single composition can have. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
50 #define MAX_COMPOSITION_COMPONENTS 16
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
51
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
52 /* These macros access information about a composition that
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
53 has `composition' property PROP. PROP is:
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
54 ((LENGTH . COMPONENTS) . MODIFICATION-FUNC)
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
55 or
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
56 (COMPOSITION-ID . (LENGTH COMPONENTS . MODIFICATION-FUNC))
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
57 They don't check validity of PROP. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
58
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
59 /* Temporary variable used only in the following macros. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
60 extern Lisp_Object composition_temp;
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
61
78501
1677cf1c2509 Replace `iff' in comments.
Glenn Morris <rgm@gnu.org>
parents: 78313
diff changeset
62 /* Return 1 if the composition is already registered. */
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
63 #define COMPOSITION_REGISTERD_P(prop) INTEGERP (XCAR (prop))
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
64
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
65 /* Return ID number of the already registered composition. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
66 #define COMPOSITION_ID(prop) XINT (XCAR (prop))
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
67
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
68 /* Return length of the composition. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
69 #define COMPOSITION_LENGTH(prop) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
70 (COMPOSITION_REGISTERD_P (prop) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
71 ? XINT (XCAR (XCDR (prop))) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
72 : XINT (XCAR (XCAR (prop))))
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
73
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
74 /* Return components of the composition. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
75 #define COMPOSITION_COMPONENTS(prop) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
76 (COMPOSITION_REGISTERD_P (prop) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
77 ? XCAR (XCDR (XCDR (prop))) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
78 : XCDR (XCAR (prop)))
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
79
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
80 /* Return modification function of the composition. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
81 #define COMPOSITION_MODIFICATION_FUNC(prop) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
82 (COMPOSITION_REGISTERD_P (prop) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
83 ? XCDR (XCDR (XCDR (prop))) \
46939
6c76daadf530 (COMPOSITION_MODIFICATION_FUNC): If PROP is not a cons, return Qnil.
Kenichi Handa <handa@m17n.org>
parents: 38484
diff changeset
84 : CONSP (prop) ? XCDR (prop) : Qnil)
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
85
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
86 /* Return the method of composition. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
87 #define COMPOSITION_METHOD(prop) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
88 (COMPOSITION_REGISTERD_P (prop) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
89 ? composition_table[COMPOSITION_ID (prop)]->method \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
90 : (composition_temp = XCDR (XCAR (prop)), \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
91 (NILP (composition_temp) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
92 ? COMPOSITION_RELATIVE \
91173
d073992bc6f3 (COMPOSITION_METHOD): Handle
Kenichi Handa <handa@m17n.org>
parents: 91005
diff changeset
93 : (INTEGERP (composition_temp) || STRINGP (composition_temp)) \
d073992bc6f3 (COMPOSITION_METHOD): Handle
Kenichi Handa <handa@m17n.org>
parents: 91005
diff changeset
94 ? COMPOSITION_WITH_ALTCHARS \
d073992bc6f3 (COMPOSITION_METHOD): Handle
Kenichi Handa <handa@m17n.org>
parents: 91005
diff changeset
95 : (VECTORP (composition_temp) \
d073992bc6f3 (COMPOSITION_METHOD): Handle
Kenichi Handa <handa@m17n.org>
parents: 91005
diff changeset
96 && ASIZE (composition_temp) >= 2 \
d073992bc6f3 (COMPOSITION_METHOD): Handle
Kenichi Handa <handa@m17n.org>
parents: 91005
diff changeset
97 && VECTORP (AREF (composition_temp, 0))) \
d073992bc6f3 (COMPOSITION_METHOD): Handle
Kenichi Handa <handa@m17n.org>
parents: 91005
diff changeset
98 ? COMPOSITION_WITH_GLYPH_STRING \
d073992bc6f3 (COMPOSITION_METHOD): Handle
Kenichi Handa <handa@m17n.org>
parents: 91005
diff changeset
99 : COMPOSITION_WITH_RULE_ALTCHARS)))
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
100
78501
1677cf1c2509 Replace `iff' in comments.
Glenn Morris <rgm@gnu.org>
parents: 78313
diff changeset
101 /* Return 1 if the composition is valid. It is valid if length of
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
102 the composition equals to (END - START). */
37240
77c7dc464611 (COMPOSITION_VALID_P): Allow integers as cdrs of
Gerd Moellmann <gerd@gnu.org>
parents: 36691
diff changeset
103 #define COMPOSITION_VALID_P(start, end, prop) \
77c7dc464611 (COMPOSITION_VALID_P): Allow integers as cdrs of
Gerd Moellmann <gerd@gnu.org>
parents: 36691
diff changeset
104 (CONSP (prop) \
77c7dc464611 (COMPOSITION_VALID_P): Allow integers as cdrs of
Gerd Moellmann <gerd@gnu.org>
parents: 36691
diff changeset
105 && (COMPOSITION_REGISTERD_P (prop) \
77c7dc464611 (COMPOSITION_VALID_P): Allow integers as cdrs of
Gerd Moellmann <gerd@gnu.org>
parents: 36691
diff changeset
106 ? (COMPOSITION_ID (prop) >= 0 \
77c7dc464611 (COMPOSITION_VALID_P): Allow integers as cdrs of
Gerd Moellmann <gerd@gnu.org>
parents: 36691
diff changeset
107 && COMPOSITION_ID (prop) <= n_compositions \
77c7dc464611 (COMPOSITION_VALID_P): Allow integers as cdrs of
Gerd Moellmann <gerd@gnu.org>
parents: 36691
diff changeset
108 && CONSP (XCDR (prop))) \
77c7dc464611 (COMPOSITION_VALID_P): Allow integers as cdrs of
Gerd Moellmann <gerd@gnu.org>
parents: 36691
diff changeset
109 : (composition_temp = XCAR (prop), \
77c7dc464611 (COMPOSITION_VALID_P): Allow integers as cdrs of
Gerd Moellmann <gerd@gnu.org>
parents: 36691
diff changeset
110 (CONSP (composition_temp) \
77c7dc464611 (COMPOSITION_VALID_P): Allow integers as cdrs of
Gerd Moellmann <gerd@gnu.org>
parents: 36691
diff changeset
111 && (composition_temp = XCDR (composition_temp), \
77c7dc464611 (COMPOSITION_VALID_P): Allow integers as cdrs of
Gerd Moellmann <gerd@gnu.org>
parents: 36691
diff changeset
112 (NILP (composition_temp) \
77c7dc464611 (COMPOSITION_VALID_P): Allow integers as cdrs of
Gerd Moellmann <gerd@gnu.org>
parents: 36691
diff changeset
113 || STRINGP (composition_temp) \
77c7dc464611 (COMPOSITION_VALID_P): Allow integers as cdrs of
Gerd Moellmann <gerd@gnu.org>
parents: 36691
diff changeset
114 || VECTORP (composition_temp) \
77c7dc464611 (COMPOSITION_VALID_P): Allow integers as cdrs of
Gerd Moellmann <gerd@gnu.org>
parents: 36691
diff changeset
115 || INTEGERP (composition_temp) \
77c7dc464611 (COMPOSITION_VALID_P): Allow integers as cdrs of
Gerd Moellmann <gerd@gnu.org>
parents: 36691
diff changeset
116 || CONSP (composition_temp)))))) \
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
117 && (end - start) == COMPOSITION_LENGTH (prop))
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
118
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
119 /* Return the Nth glyph of composition specified by CMP. CMP is a
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
120 pointer to `struct composition'. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
121 #define COMPOSITION_GLYPH(cmp, n) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
122 XINT (XVECTOR (XVECTOR (XHASH_TABLE (composition_hash_table) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
123 ->key_and_value) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
124 ->contents[cmp->hash_index * 2]) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
125 ->contents[cmp->method == COMPOSITION_WITH_RULE_ALTCHARS \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
126 ? (n) * 2 : (n)])
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
127
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
128 /* Return the encoded composition rule to compose the Nth glyph of
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
129 rule-base composition specified by CMP. CMP is a pointer to
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
130 `struct composition'. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
131 #define COMPOSITION_RULE(cmp, n) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
132 XINT (XVECTOR (XVECTOR (XHASH_TABLE (composition_hash_table) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
133 ->key_and_value) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
134 ->contents[cmp->hash_index * 2]) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
135 ->contents[(n) * 2 - 1])
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
136
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
137 /* Decode encoded composition rule RULE_CODE into GREF (global
89725
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
138 reference point code), NREF (new reference point code), XOFF
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
139 (horizontal offset) YOFF (vertical offset). Don't check RULE_CODE,
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
140 always set GREF and NREF to valid values. By side effect,
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
141 RULE_CODE is modified. */
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
142
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
143 #define COMPOSITION_DECODE_RULE(rule_code, gref, nref, xoff, yoff) \
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
144 do { \
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
145 xoff = (rule_code) >> 16; \
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
146 yoff = ((rule_code) >> 8) & 0xFF; \
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
147 rule_code &= 0xFF; \
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
148 gref = (rule_code) / 12; \
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
149 if (gref > 12) gref = 11; \
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
150 nref = (rule_code) % 12; \
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
151 } while (0)
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
152
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
153 /* Return encoded composition rule for the pair of global reference
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
154 point GREF and new reference point NREF. If arguments are invalid,
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
155 return -1. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
156 #define COMPOSITION_ENCODE_RULE(gref, nref) \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
157 ((unsigned) (gref) < 12 && (unsigned) (nref) < 12 \
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
158 ? (gref) * 12 + (nref) : -1)
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
159
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
160 /* Data structure that records information about a composition
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
161 currently used in some buffers or strings.
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
162
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
163 When a composition is assigned an ID number (by
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
164 get_composition_id), this structure is allocated for the
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46939
diff changeset
165 composition and linked in composition_table[ID].
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
166
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
167 Identical compositions appearing at different places have the same
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
168 ID, and thus share the same instance of this structure. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
169
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
170 struct composition {
36691
144162f5b2e3 (struct composition): Change types of members; glyph_len to unsigned,
Kenichi Handa <handa@m17n.org>
parents: 33239
diff changeset
171 /* Number of glyphs of the composition components. */
144162f5b2e3 (struct composition): Change types of members; glyph_len to unsigned,
Kenichi Handa <handa@m17n.org>
parents: 33239
diff changeset
172 unsigned glyph_len;
144162f5b2e3 (struct composition): Change types of members; glyph_len to unsigned,
Kenichi Handa <handa@m17n.org>
parents: 33239
diff changeset
173
144162f5b2e3 (struct composition): Change types of members; glyph_len to unsigned,
Kenichi Handa <handa@m17n.org>
parents: 33239
diff changeset
174 /* Width, ascent, and descent pixels of the composition. */
144162f5b2e3 (struct composition): Change types of members; glyph_len to unsigned,
Kenichi Handa <handa@m17n.org>
parents: 33239
diff changeset
175 short pixel_width, ascent, descent;
144162f5b2e3 (struct composition): Change types of members; glyph_len to unsigned,
Kenichi Handa <handa@m17n.org>
parents: 33239
diff changeset
176
89725
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
177 short lbearing, rbearing;
39563e1a1b64 (COMPOSITION_DECODE_RULE): New arg xoff and yoff.
Kenichi Handa <handa@m17n.org>
parents: 89513
diff changeset
178
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
179 /* How many columns the overall glyphs occupy on the screen. This
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
180 gives an approximate value for column calculation in
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
181 Fcurrent_column, and etc. */
36691
144162f5b2e3 (struct composition): Change types of members; glyph_len to unsigned,
Kenichi Handa <handa@m17n.org>
parents: 33239
diff changeset
182 unsigned short width;
26992
c7f8ea6a37bd (struct composition): Change the order of declaring
Kenichi Handa <handa@m17n.org>
parents: 26848
diff changeset
183
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
184 /* Method of the composition. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
185 enum composition_method method;
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
186
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
187 /* Index to the composition hash table. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
188 int hash_index;
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
189
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
190 /* For which font we have calculated the remaining members. The
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
191 actual type is device dependent. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
192 void *font;
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
193
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
194 /* Pointer to an array of x-offset and y-offset (by pixels) of
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
195 glyphs. This points to a sufficient memory space (sizeof (int) *
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
196 glyph_len * 2) that is allocated when the composition is
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
197 registered in composition_table. X-offset and Y-offset of Nth
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
198 glyph are (2N)th and (2N+1)th elements respectively. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
199 short *offsets;
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
200 };
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
201
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
202 /* Table of pointers to the structure `composition' indexed by
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
203 COMPOSITION-ID. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
204 extern struct composition **composition_table;
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
205 /* Number of the currently registered compositions. */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
206 extern int n_compositions;
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
207
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
208 /* Mask bits for CHECK_MASK arg to update_compositions.
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
209 For a change in the region FROM and TO, check compositions ... */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
210 #define CHECK_HEAD 1 /* adjacent to FROM */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
211 #define CHECK_TAIL 2 /* adjacent to TO */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
212 #define CHECK_INSIDE 4 /* between FROM and TO */
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
213 #define CHECK_BORDER (CHECK_HEAD | CHECK_TAIL)
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
214 #define CHECK_ALL (CHECK_BORDER | CHECK_INSIDE)
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
215
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
216 extern Lisp_Object Qcomposition;
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
217 extern Lisp_Object composition_hash_table;
89282
309b9e0cb0c8 (Qauto_composed, Vauto_composition_function,
Kenichi Handa <handa@m17n.org>
parents: 88367
diff changeset
218 extern Lisp_Object Qauto_composed;
309b9e0cb0c8 (Qauto_composed, Vauto_composition_function,
Kenichi Handa <handa@m17n.org>
parents: 88367
diff changeset
219 extern Lisp_Object Vauto_composition_function;
309b9e0cb0c8 (Qauto_composed, Vauto_composition_function,
Kenichi Handa <handa@m17n.org>
parents: 88367
diff changeset
220 extern Lisp_Object Qauto_composition_function;
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
221
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
222 extern int get_composition_id P_ ((int, int, int, Lisp_Object, Lisp_Object));
89513
24f632d28cd6 (find_composition, update_compositions): Make
Dave Love <fx@gnu.org>
parents: 89483
diff changeset
223 extern int find_composition P_ ((int, int, EMACS_INT *, EMACS_INT *, Lisp_Object *,
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
224 Lisp_Object));
89513
24f632d28cd6 (find_composition, update_compositions): Make
Dave Love <fx@gnu.org>
parents: 89483
diff changeset
225 extern void update_compositions P_ ((EMACS_INT, EMACS_INT, int));
30025
c5eb8840659f (make_composition_value_copy): Extern it.
Kenichi Handa <handa@m17n.org>
parents: 29895
diff changeset
226 extern void make_composition_value_copy P_ ((Lisp_Object));
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
227 extern void compose_region P_ ((int, int, Lisp_Object, Lisp_Object,
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
228 Lisp_Object));
38484
924488395239 (syms_of_composite): Renamed from
Gerd Moellmann <gerd@gnu.org>
parents: 37240
diff changeset
229 extern void syms_of_composite P_ ((void));
29895
025b22133cc2 (compose_text): Declare.
Dave Love <fx@gnu.org>
parents: 29572
diff changeset
230 extern void compose_text P_ ((int, int, Lisp_Object, Lisp_Object,
025b22133cc2 (compose_text): Declare.
Dave Love <fx@gnu.org>
parents: 29572
diff changeset
231 Lisp_Object));
26848
d502b027b817 New file
Kenichi Handa <handa@m17n.org>
parents:
diff changeset
232
91548
63d4513550f9 (Fcompose_region_internal, Fcompose_string_internal): Declare.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 91327
diff changeset
233 EXFUN (Fcompose_region_internal, 4);
63d4513550f9 (Fcompose_region_internal, Fcompose_string_internal): Declare.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 91327
diff changeset
234 EXFUN (Fcompose_string_internal, 5);
63d4513550f9 (Fcompose_region_internal, Fcompose_string_internal): Declare.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 91327
diff changeset
235
29572
d88f50e982a1 (EMACS_COMPOSITE_H): Renamed from _COMPOSITE_H.
Kenichi Handa <handa@m17n.org>
parents: 26992
diff changeset
236 #endif /* not EMACS_COMPOSITE_H */
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
237
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
238 /* arch-tag: 59524d89-c645-47bd-b5e6-65e861690118
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
239 (do not change this comment) */