Commit | Line | Data |
---|---|---|
ca4c9455 | 1 | /* Header for composite sequence handler. |
ab422c4d | 2 | Copyright (C) 2001-2013 Free Software Foundation, Inc. |
5df4f04c | 3 | Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 |
ce03bf76 KH |
4 | National Institute of Advanced Industrial Science and Technology (AIST) |
5 | Registration Number H14PRO021 | |
028b54a0 | 6 | Copyright (C) 2003, 2006 |
9f504898 KH |
7 | National Institute of Advanced Industrial Science and Technology (AIST) |
8 | Registration Number H13PRO009 | |
ca4c9455 KH |
9 | |
10 | This file is part of GNU Emacs. | |
11 | ||
b9b1cc14 | 12 | GNU Emacs is free software: you can redistribute it and/or modify |
ca4c9455 | 13 | it under the terms of the GNU General Public License as published by |
b9b1cc14 GM |
14 | the Free Software Foundation, either version 3 of the License, or |
15 | (at your option) any later version. | |
ca4c9455 KH |
16 | |
17 | GNU Emacs is distributed in the hope that it will be useful, | |
18 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | GNU General Public License for more details. | |
21 | ||
22 | You should have received a copy of the GNU General Public License | |
b9b1cc14 | 23 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
ca4c9455 | 24 | |
15a10ef1 KH |
25 | #ifndef EMACS_COMPOSITE_H |
26 | #define EMACS_COMPOSITE_H | |
ca4c9455 | 27 | |
9d7693d7 DA |
28 | #include "font.h" |
29 | ||
f162bcc3 | 30 | INLINE_HEADER_BEGIN |
f162bcc3 | 31 | |
028b54a0 | 32 | /* Methods to display a sequence of components of a composition. */ |
ca4c9455 | 33 | enum composition_method { |
ca4c9455 KH |
34 | /* Compose relatively without alternate characters. */ |
35 | COMPOSITION_RELATIVE, | |
9f504898 KH |
36 | /* Compose by specified composition rules. This is not used in |
37 | Emacs 21 but we need it to decode files saved in the older | |
38 | versions of Emacs. */ | |
ca4c9455 KH |
39 | COMPOSITION_WITH_RULE, |
40 | /* Compose relatively with alternate characters. */ | |
41 | COMPOSITION_WITH_ALTCHARS, | |
9f504898 KH |
42 | /* Compose by specified composition rules with alternate characters. */ |
43 | COMPOSITION_WITH_RULE_ALTCHARS, | |
44 | /* This is not a method. */ | |
45 | COMPOSITION_NO | |
ca4c9455 KH |
46 | }; |
47 | ||
da6062e6 | 48 | /* Maximum number of components a single composition can have. */ |
ca4c9455 KH |
49 | #define MAX_COMPOSITION_COMPONENTS 16 |
50 | ||
98f638d6 | 51 | /* These operations access information about a composition that |
ca4c9455 KH |
52 | has `composition' property PROP. PROP is: |
53 | ((LENGTH . COMPONENTS) . MODIFICATION-FUNC) | |
54 | or | |
55 | (COMPOSITION-ID . (LENGTH COMPONENTS . MODIFICATION-FUNC)) | |
56 | They don't check validity of PROP. */ | |
57 | ||
98f638d6 | 58 | /* Return true if PROP is already registered. */ |
00382e8b | 59 | INLINE bool |
98f638d6 PE |
60 | composition_registered_p (Lisp_Object prop) |
61 | { | |
62 | return INTEGERP (XCAR (prop)); | |
63 | } | |
ca4c9455 KH |
64 | |
65 | /* Return ID number of the already registered composition. */ | |
66 | #define COMPOSITION_ID(prop) XINT (XCAR (prop)) | |
67 | ||
68 | /* Return length of the composition. */ | |
69 | #define COMPOSITION_LENGTH(prop) \ | |
98f638d6 | 70 | (composition_registered_p (prop) \ |
ca4c9455 KH |
71 | ? XINT (XCAR (XCDR (prop))) \ |
72 | : XINT (XCAR (XCAR (prop)))) | |
73 | ||
74 | /* Return components of the composition. */ | |
75 | #define COMPOSITION_COMPONENTS(prop) \ | |
98f638d6 | 76 | (composition_registered_p (prop) \ |
ca4c9455 KH |
77 | ? XCAR (XCDR (XCDR (prop))) \ |
78 | : XCDR (XCAR (prop))) | |
79 | ||
80 | /* Return modification function of the composition. */ | |
81 | #define COMPOSITION_MODIFICATION_FUNC(prop) \ | |
98f638d6 | 82 | (composition_registered_p (prop) \ |
ca4c9455 | 83 | ? XCDR (XCDR (XCDR (prop))) \ |
c1de6316 | 84 | : CONSP (prop) ? XCDR (prop) : Qnil) |
ca4c9455 | 85 | |
ca4c9455 | 86 | /* Return the Nth glyph of composition specified by CMP. CMP is a |
45b82ad0 | 87 | pointer to `struct composition'. */ |
ca4c9455 KH |
88 | #define COMPOSITION_GLYPH(cmp, n) \ |
89 | XINT (XVECTOR (XVECTOR (XHASH_TABLE (composition_hash_table) \ | |
90 | ->key_and_value) \ | |
91f2d272 PE |
91 | ->contents[cmp->hash_index * 2]) \ |
92 | ->contents[cmp->method == COMPOSITION_WITH_RULE_ALTCHARS \ | |
ca4c9455 KH |
93 | ? (n) * 2 : (n)]) |
94 | ||
95 | /* Return the encoded composition rule to compose the Nth glyph of | |
96 | rule-base composition specified by CMP. CMP is a pointer to | |
97 | `struct composition'. */ | |
98 | #define COMPOSITION_RULE(cmp, n) \ | |
99 | XINT (XVECTOR (XVECTOR (XHASH_TABLE (composition_hash_table) \ | |
100 | ->key_and_value) \ | |
91f2d272 PE |
101 | ->contents[cmp->hash_index * 2]) \ |
102 | ->contents[(n) * 2 - 1]) | |
ca4c9455 KH |
103 | |
104 | /* Decode encoded composition rule RULE_CODE into GREF (global | |
b13a45c6 | 105 | reference point code), NREF (new ref. point code). Don't check RULE_CODE; |
28d0edc7 KH |
106 | always set GREF and NREF to valid values. By side effect, |
107 | RULE_CODE is modified. */ | |
108 | ||
b13a45c6 | 109 | #define COMPOSITION_DECODE_REFS(rule_code, gref, nref) \ |
28d0edc7 | 110 | do { \ |
28d0edc7 KH |
111 | rule_code &= 0xFF; \ |
112 | gref = (rule_code) / 12; \ | |
113 | if (gref > 12) gref = 11; \ | |
114 | nref = (rule_code) % 12; \ | |
ca4c9455 KH |
115 | } while (0) |
116 | ||
b13a45c6 PE |
117 | /* Like COMPOSITION_DECODE_REFS (RULE_CODE, GREF, NREF), but also |
118 | decode RULE_CODE into XOFF and YOFF (vertical offset). */ | |
119 | ||
120 | #define COMPOSITION_DECODE_RULE(rule_code, gref, nref, xoff, yoff) \ | |
121 | do { \ | |
122 | xoff = (rule_code) >> 16; \ | |
123 | yoff = ((rule_code) >> 8) & 0xFF; \ | |
124 | COMPOSITION_DECODE_REFS (rule_code, gref, nref); \ | |
125 | } while (0) | |
126 | ||
d5efd1d1 PE |
127 | /* Nonzero if the global reference point GREF and new reference point NREF are |
128 | valid. */ | |
129 | #define COMPOSITION_ENCODE_RULE_VALID(gref, nref) \ | |
ea204efb | 130 | (UNSIGNED_CMP (gref, <, 12) && UNSIGNED_CMP (nref, <, 12)) |
d5efd1d1 | 131 | |
ca4c9455 | 132 | /* Return encoded composition rule for the pair of global reference |
d5efd1d1 | 133 | point GREF and new reference point NREF. Arguments must be valid. */ |
ca4c9455 | 134 | #define COMPOSITION_ENCODE_RULE(gref, nref) \ |
d5efd1d1 | 135 | ((gref) * 12 + (nref)) |
ca4c9455 KH |
136 | |
137 | /* Data structure that records information about a composition | |
138 | currently used in some buffers or strings. | |
139 | ||
140 | When a composition is assigned an ID number (by | |
141 | get_composition_id), this structure is allocated for the | |
177c0ea7 | 142 | composition and linked in composition_table[ID]. |
ca4c9455 KH |
143 | |
144 | Identical compositions appearing at different places have the same | |
145 | ID, and thus share the same instance of this structure. */ | |
146 | ||
147 | struct composition { | |
ca4c9455 | 148 | /* Number of glyphs of the composition components. */ |
0065d054 | 149 | int glyph_len; |
ca4c9455 | 150 | |
51e31f7a KH |
151 | /* Width, ascent, and descent pixels of the composition. */ |
152 | short pixel_width, ascent, descent; | |
153 | ||
28d0edc7 KH |
154 | short lbearing, rbearing; |
155 | ||
28cd4910 KH |
156 | /* How many columns the overall glyphs occupy on the screen. This |
157 | gives an approximate value for column calculation in | |
158 | Fcurrent_column, and etc. */ | |
159 | unsigned short width; | |
160 | ||
ca4c9455 KH |
161 | /* Method of the composition. */ |
162 | enum composition_method method; | |
163 | ||
164 | /* Index to the composition hash table. */ | |
d311d28c | 165 | ptrdiff_t hash_index; |
ca4c9455 KH |
166 | |
167 | /* For which font we have calculated the remaining members. The | |
168 | actual type is device dependent. */ | |
169 | void *font; | |
170 | ||
171 | /* Pointer to an array of x-offset and y-offset (by pixels) of | |
7bd42522 | 172 | glyphs. This points to a sufficient memory space (sizeof (short) * |
ca4c9455 KH |
173 | glyph_len * 2) that is allocated when the composition is |
174 | registered in composition_table. X-offset and Y-offset of Nth | |
175 | glyph are (2N)th and (2N+1)th elements respectively. */ | |
176 | short *offsets; | |
ca4c9455 KH |
177 | }; |
178 | ||
179 | /* Table of pointers to the structure `composition' indexed by | |
180 | COMPOSITION-ID. */ | |
181 | extern struct composition **composition_table; | |
182 | /* Number of the currently registered compositions. */ | |
ebfa62c0 | 183 | extern ptrdiff_t n_compositions; |
ca4c9455 KH |
184 | |
185 | /* Mask bits for CHECK_MASK arg to update_compositions. | |
186 | For a change in the region FROM and TO, check compositions ... */ | |
187 | #define CHECK_HEAD 1 /* adjacent to FROM */ | |
188 | #define CHECK_TAIL 2 /* adjacent to TO */ | |
189 | #define CHECK_INSIDE 4 /* between FROM and TO */ | |
190 | #define CHECK_BORDER (CHECK_HEAD | CHECK_TAIL) | |
191 | #define CHECK_ALL (CHECK_BORDER | CHECK_INSIDE) | |
192 | ||
193 | extern Lisp_Object Qcomposition; | |
194 | extern Lisp_Object composition_hash_table; | |
d311d28c | 195 | extern ptrdiff_t get_composition_id (ptrdiff_t, ptrdiff_t, ptrdiff_t, |
ebfa62c0 | 196 | Lisp_Object, Lisp_Object); |
de1339b0 PE |
197 | extern bool find_composition (ptrdiff_t, ptrdiff_t, ptrdiff_t *, ptrdiff_t *, |
198 | Lisp_Object *, Lisp_Object); | |
d311d28c | 199 | extern void update_compositions (ptrdiff_t, ptrdiff_t, int); |
383e0970 | 200 | extern void make_composition_value_copy (Lisp_Object); |
383e0970 | 201 | extern void syms_of_composite (void); |
d311d28c | 202 | extern void compose_text (ptrdiff_t, ptrdiff_t, Lisp_Object, Lisp_Object, |
383e0970 | 203 | Lisp_Object); |
ca4c9455 | 204 | |
98f638d6 PE |
205 | /* Return the method of a composition with property PROP. */ |
206 | ||
00382e8b | 207 | INLINE enum composition_method |
75c59fb3 DA |
208 | composition_method (Lisp_Object prop) |
209 | { | |
98f638d6 PE |
210 | if (composition_registered_p (prop)) |
211 | return composition_table[COMPOSITION_ID (prop)]->method; | |
212 | else | |
213 | { | |
214 | Lisp_Object temp = XCDR (XCAR (prop)); | |
215 | return (NILP (temp) | |
75c59fb3 | 216 | ? COMPOSITION_RELATIVE |
98f638d6 | 217 | : INTEGERP (temp) || STRINGP (temp) |
75c59fb3 | 218 | ? COMPOSITION_WITH_ALTCHARS |
98f638d6 PE |
219 | : COMPOSITION_WITH_RULE_ALTCHARS); |
220 | } | |
75c59fb3 DA |
221 | } |
222 | ||
98f638d6 PE |
223 | /* Given offsets START and END, return true if PROP is a valid composition |
224 | property with length END - START. */ | |
225 | ||
00382e8b | 226 | INLINE bool |
75c59fb3 DA |
227 | composition_valid_p (ptrdiff_t start, ptrdiff_t end, Lisp_Object prop) |
228 | { | |
75c59fb3 | 229 | return (CONSP (prop) |
98f638d6 | 230 | && (composition_registered_p (prop) |
75c59fb3 DA |
231 | ? (COMPOSITION_ID (prop) >= 0 |
232 | && COMPOSITION_ID (prop) <= n_compositions | |
233 | && CONSP (XCDR (prop))) | |
98f638d6 PE |
234 | : (CONSP (XCAR (prop)) |
235 | && (NILP (XCDR (XCAR (prop))) | |
236 | || STRINGP (XCDR (XCAR (prop))) | |
237 | || VECTORP (XCDR (XCAR (prop))) | |
238 | || INTEGERP (XCDR (XCAR (prop))) | |
239 | || CONSP (XCDR (XCAR (prop)))))) | |
240 | && COMPOSITION_LENGTH (prop) == end - start); | |
75c59fb3 DA |
241 | } |
242 | ||
6e8b8329 KH |
243 | /* Macros for lispy glyph-string. This is completely different from |
244 | struct glyph_string. */ | |
245 | ||
246 | #define LGSTRING_HEADER(lgs) AREF (lgs, 0) | |
247 | #define LGSTRING_SET_HEADER(lgs, header) ASET (lgs, 0, header) | |
248 | ||
249 | #define LGSTRING_FONT(lgs) AREF (LGSTRING_HEADER (lgs), 0) | |
250 | #define LGSTRING_CHAR(lgs, i) AREF (LGSTRING_HEADER (lgs), (i) + 1) | |
251 | #define LGSTRING_CHAR_LEN(lgs) (ASIZE (LGSTRING_HEADER (lgs)) - 1) | |
252 | ||
253 | #define LGSTRING_SET_FONT(lgs, val) ASET (LGSTRING_HEADER (lgs), 0, (val)) | |
254 | #define LGSTRING_SET_CHAR(lgs, i, c) ASET (LGSTRING_HEADER (lgs), (i) + 1, (c)) | |
255 | ||
256 | #define LGSTRING_ID(lgs) AREF (lgs, 1) | |
257 | #define LGSTRING_SET_ID(lgs, id) ASET (lgs, 1, id) | |
258 | ||
259 | #define LGSTRING_GLYPH_LEN(lgs) (ASIZE ((lgs)) - 2) | |
260 | #define LGSTRING_GLYPH(lgs, idx) AREF ((lgs), (idx) + 2) | |
261 | #define LGSTRING_SET_GLYPH(lgs, idx, val) ASET ((lgs), (idx) + 2, (val)) | |
00382e8b | 262 | INLINE Lisp_Object * |
4939150c PE |
263 | lgstring_glyph_addr (Lisp_Object lgs, ptrdiff_t idx) |
264 | { | |
265 | return aref_addr (lgs, idx + 2); | |
266 | } | |
6e8b8329 KH |
267 | |
268 | /* Vector size of Lispy glyph. */ | |
269 | enum lglyph_indices | |
270 | { | |
271 | LGLYPH_IX_FROM, LGLYPH_IX_TO, LGLYPH_IX_CHAR, LGLYPH_IX_CODE, | |
272 | LGLYPH_IX_WIDTH, LGLYPH_IX_LBEARING, LGLYPH_IX_RBEARING, | |
273 | LGLYPH_IX_ASCENT, LGLYPH_IX_DESCENT, LGLYPH_IX_ADJUSTMENT, | |
274 | /* Not an index. */ | |
275 | LGLYPH_SIZE | |
276 | }; | |
277 | ||
278 | #define LGLYPH_NEW() Fmake_vector (make_number (LGLYPH_SIZE), Qnil) | |
279 | #define LGLYPH_FROM(g) XINT (AREF ((g), LGLYPH_IX_FROM)) | |
280 | #define LGLYPH_TO(g) XINT (AREF ((g), LGLYPH_IX_TO)) | |
281 | #define LGLYPH_CHAR(g) XINT (AREF ((g), LGLYPH_IX_CHAR)) | |
282 | #define LGLYPH_CODE(g) \ | |
283 | (NILP (AREF ((g), LGLYPH_IX_CODE)) \ | |
284 | ? FONT_INVALID_CODE \ | |
be44ca6c | 285 | : cons_to_unsigned (AREF (g, LGLYPH_IX_CODE), TYPE_MAXIMUM (unsigned))) |
6e8b8329 KH |
286 | #define LGLYPH_WIDTH(g) XINT (AREF ((g), LGLYPH_IX_WIDTH)) |
287 | #define LGLYPH_LBEARING(g) XINT (AREF ((g), LGLYPH_IX_LBEARING)) | |
288 | #define LGLYPH_RBEARING(g) XINT (AREF ((g), LGLYPH_IX_RBEARING)) | |
289 | #define LGLYPH_ASCENT(g) XINT (AREF ((g), LGLYPH_IX_ASCENT)) | |
290 | #define LGLYPH_DESCENT(g) XINT (AREF ((g), LGLYPH_IX_DESCENT)) | |
291 | #define LGLYPH_ADJUSTMENT(g) AREF ((g), LGLYPH_IX_ADJUSTMENT) | |
292 | #define LGLYPH_SET_FROM(g, val) ASET ((g), LGLYPH_IX_FROM, make_number (val)) | |
293 | #define LGLYPH_SET_TO(g, val) ASET ((g), LGLYPH_IX_TO, make_number (val)) | |
294 | #define LGLYPH_SET_CHAR(g, val) ASET ((g), LGLYPH_IX_CHAR, make_number (val)) | |
fdcb19ca | 295 | /* Callers must assure that VAL is not negative! */ |
6e8b8329 | 296 | #define LGLYPH_SET_CODE(g, val) \ |
be44ca6c PE |
297 | ASET (g, LGLYPH_IX_CODE, \ |
298 | val == FONT_INVALID_CODE ? Qnil : INTEGER_TO_CONS (val)) | |
b13a45c6 | 299 | |
6e8b8329 KH |
300 | #define LGLYPH_SET_WIDTH(g, val) ASET ((g), LGLYPH_IX_WIDTH, make_number (val)) |
301 | #define LGLYPH_SET_LBEARING(g, val) ASET ((g), LGLYPH_IX_LBEARING, make_number (val)) | |
302 | #define LGLYPH_SET_RBEARING(g, val) ASET ((g), LGLYPH_IX_RBEARING, make_number (val)) | |
303 | #define LGLYPH_SET_ASCENT(g, val) ASET ((g), LGLYPH_IX_ASCENT, make_number (val)) | |
304 | #define LGLYPH_SET_DESCENT(g, val) ASET ((g), LGLYPH_IX_DESCENT, make_number (val)) | |
305 | #define LGLYPH_SET_ADJUSTMENT(g, val) ASET ((g), LGLYPH_IX_ADJUSTMENT, (val)) | |
306 | ||
307 | #define LGLYPH_XOFF(g) (VECTORP (LGLYPH_ADJUSTMENT (g)) \ | |
308 | ? XINT (AREF (LGLYPH_ADJUSTMENT (g), 0)) : 0) | |
309 | #define LGLYPH_YOFF(g) (VECTORP (LGLYPH_ADJUSTMENT (g)) \ | |
310 | ? XINT (AREF (LGLYPH_ADJUSTMENT (g), 1)) : 0) | |
311 | #define LGLYPH_WADJUST(g) (VECTORP (LGLYPH_ADJUSTMENT (g)) \ | |
312 | ? XINT (AREF (LGLYPH_ADJUSTMENT (g), 2)) : 0) | |
313 | ||
d311d28c | 314 | extern Lisp_Object composition_gstring_put_cache (Lisp_Object, ptrdiff_t); |
ebfa62c0 | 315 | extern Lisp_Object composition_gstring_from_id (ptrdiff_t); |
de1339b0 | 316 | extern bool composition_gstring_p (Lisp_Object); |
d311d28c | 317 | extern int composition_gstring_width (Lisp_Object, ptrdiff_t, ptrdiff_t, |
383e0970 J |
318 | struct font_metrics *); |
319 | ||
320 | extern void composition_compute_stop_pos (struct composition_it *, | |
d311d28c | 321 | ptrdiff_t, ptrdiff_t, ptrdiff_t, |
383e0970 | 322 | Lisp_Object); |
de1339b0 PE |
323 | extern bool composition_reseat_it (struct composition_it *, ptrdiff_t, |
324 | ptrdiff_t, ptrdiff_t, struct window *, | |
325 | struct face *, Lisp_Object); | |
383e0970 | 326 | extern int composition_update_it (struct composition_it *, |
d311d28c | 327 | ptrdiff_t, ptrdiff_t, Lisp_Object); |
383e0970 | 328 | |
d311d28c | 329 | extern ptrdiff_t composition_adjust_point (ptrdiff_t, ptrdiff_t); |
6e8b8329 | 330 | |
f162bcc3 PE |
331 | INLINE_HEADER_END |
332 | ||
15a10ef1 | 333 | #endif /* not EMACS_COMPOSITE_H */ |