1 /* Header for composite sequence handler.
2 Copyright (C) 2001-2013 Free Software Foundation, Inc.
3 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
4 National Institute of Advanced Industrial Science and Technology (AIST)
5 Registration Number H14PRO021
6 Copyright (C) 2003, 2006
7 National Institute of Advanced Industrial Science and Technology (AIST)
8 Registration Number H13PRO009
10 This file is part of GNU Emacs.
12 GNU Emacs is free software: you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation, either version 3 of the License, or
15 (at your option) any later version.
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.
22 You should have received a copy of the GNU General Public License
23 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
25 #ifndef EMACS_COMPOSITE_H
26 #define EMACS_COMPOSITE_H
29 #ifndef COMPOSITE_INLINE
30 # define COMPOSITE_INLINE INLINE
33 /* Methods to display a sequence of components of a composition. */
34 enum composition_method
{
35 /* Compose relatively without alternate characters. */
37 /* Compose by specified composition rules. This is not used in
38 Emacs 21 but we need it to decode files saved in the older
40 COMPOSITION_WITH_RULE
,
41 /* Compose relatively with alternate characters. */
42 COMPOSITION_WITH_ALTCHARS
,
43 /* Compose by specified composition rules with alternate characters. */
44 COMPOSITION_WITH_RULE_ALTCHARS
,
45 /* This is not a method. */
49 /* Maximum number of components a single composition can have. */
50 #define MAX_COMPOSITION_COMPONENTS 16
52 /* These macros access information about a composition that
53 has `composition' property PROP. PROP is:
54 ((LENGTH . COMPONENTS) . MODIFICATION-FUNC)
56 (COMPOSITION-ID . (LENGTH COMPONENTS . MODIFICATION-FUNC))
57 They don't check validity of PROP. */
59 /* Return 1 if the composition is already registered. */
60 #define COMPOSITION_REGISTERD_P(prop) INTEGERP (XCAR (prop))
62 /* Return ID number of the already registered composition. */
63 #define COMPOSITION_ID(prop) XINT (XCAR (prop))
65 /* Return length of the composition. */
66 #define COMPOSITION_LENGTH(prop) \
67 (COMPOSITION_REGISTERD_P (prop) \
68 ? XINT (XCAR (XCDR (prop))) \
69 : XINT (XCAR (XCAR (prop))))
71 /* Return components of the composition. */
72 #define COMPOSITION_COMPONENTS(prop) \
73 (COMPOSITION_REGISTERD_P (prop) \
74 ? XCAR (XCDR (XCDR (prop))) \
77 /* Return modification function of the composition. */
78 #define COMPOSITION_MODIFICATION_FUNC(prop) \
79 (COMPOSITION_REGISTERD_P (prop) \
80 ? XCDR (XCDR (XCDR (prop))) \
81 : CONSP (prop) ? XCDR (prop) : Qnil)
83 /* Return the Nth glyph of composition specified by CMP. CMP is a
84 pointer to `struct composition'. */
85 #define COMPOSITION_GLYPH(cmp, n) \
86 XINT (XVECTOR (XVECTOR (XHASH_TABLE (composition_hash_table) \
88 ->contents[cmp->hash_index * 2]) \
89 ->contents[cmp->method == COMPOSITION_WITH_RULE_ALTCHARS \
92 /* Return the encoded composition rule to compose the Nth glyph of
93 rule-base composition specified by CMP. CMP is a pointer to
94 `struct composition'. */
95 #define COMPOSITION_RULE(cmp, n) \
96 XINT (XVECTOR (XVECTOR (XHASH_TABLE (composition_hash_table) \
98 ->contents[cmp->hash_index * 2]) \
99 ->contents[(n) * 2 - 1])
101 /* Decode encoded composition rule RULE_CODE into GREF (global
102 reference point code), NREF (new ref. point code). Don't check RULE_CODE;
103 always set GREF and NREF to valid values. By side effect,
104 RULE_CODE is modified. */
106 #define COMPOSITION_DECODE_REFS(rule_code, gref, nref) \
109 gref = (rule_code) / 12; \
110 if (gref > 12) gref = 11; \
111 nref = (rule_code) % 12; \
114 /* Like COMPOSITION_DECODE_REFS (RULE_CODE, GREF, NREF), but also
115 decode RULE_CODE into XOFF and YOFF (vertical offset). */
117 #define COMPOSITION_DECODE_RULE(rule_code, gref, nref, xoff, yoff) \
119 xoff = (rule_code) >> 16; \
120 yoff = ((rule_code) >> 8) & 0xFF; \
121 COMPOSITION_DECODE_REFS (rule_code, gref, nref); \
124 /* Nonzero if the global reference point GREF and new reference point NREF are
126 #define COMPOSITION_ENCODE_RULE_VALID(gref, nref) \
127 (UNSIGNED_CMP (gref, <, 12) && UNSIGNED_CMP (nref, <, 12))
129 /* Return encoded composition rule for the pair of global reference
130 point GREF and new reference point NREF. Arguments must be valid. */
131 #define COMPOSITION_ENCODE_RULE(gref, nref) \
132 ((gref) * 12 + (nref))
134 /* Data structure that records information about a composition
135 currently used in some buffers or strings.
137 When a composition is assigned an ID number (by
138 get_composition_id), this structure is allocated for the
139 composition and linked in composition_table[ID].
141 Identical compositions appearing at different places have the same
142 ID, and thus share the same instance of this structure. */
145 /* Number of glyphs of the composition components. */
148 /* Width, ascent, and descent pixels of the composition. */
149 short pixel_width
, ascent
, descent
;
151 short lbearing
, rbearing
;
153 /* How many columns the overall glyphs occupy on the screen. This
154 gives an approximate value for column calculation in
155 Fcurrent_column, and etc. */
156 unsigned short width
;
158 /* Method of the composition. */
159 enum composition_method method
;
161 /* Index to the composition hash table. */
162 ptrdiff_t hash_index
;
164 /* For which font we have calculated the remaining members. The
165 actual type is device dependent. */
168 /* Pointer to an array of x-offset and y-offset (by pixels) of
169 glyphs. This points to a sufficient memory space (sizeof (short) *
170 glyph_len * 2) that is allocated when the composition is
171 registered in composition_table. X-offset and Y-offset of Nth
172 glyph are (2N)th and (2N+1)th elements respectively. */
176 /* Table of pointers to the structure `composition' indexed by
178 extern struct composition
**composition_table
;
179 /* Number of the currently registered compositions. */
180 extern ptrdiff_t n_compositions
;
182 /* Mask bits for CHECK_MASK arg to update_compositions.
183 For a change in the region FROM and TO, check compositions ... */
184 #define CHECK_HEAD 1 /* adjacent to FROM */
185 #define CHECK_TAIL 2 /* adjacent to TO */
186 #define CHECK_INSIDE 4 /* between FROM and TO */
187 #define CHECK_BORDER (CHECK_HEAD | CHECK_TAIL)
188 #define CHECK_ALL (CHECK_BORDER | CHECK_INSIDE)
190 extern Lisp_Object Qcomposition
;
191 extern Lisp_Object composition_hash_table
;
192 extern ptrdiff_t get_composition_id (ptrdiff_t, ptrdiff_t, ptrdiff_t,
193 Lisp_Object
, Lisp_Object
);
194 extern bool find_composition (ptrdiff_t, ptrdiff_t, ptrdiff_t *, ptrdiff_t *,
195 Lisp_Object
*, Lisp_Object
);
196 extern void update_compositions (ptrdiff_t, ptrdiff_t, int);
197 extern void make_composition_value_copy (Lisp_Object
);
198 extern void syms_of_composite (void);
199 extern void compose_text (ptrdiff_t, ptrdiff_t, Lisp_Object
, Lisp_Object
,
202 /* Return the method of composition. */
203 COMPOSITE_INLINE
enum composition_method
204 composition_method (Lisp_Object prop
)
208 return (COMPOSITION_REGISTERD_P (prop
)
209 ? composition_table
[COMPOSITION_ID (prop
)]->method
210 : (temp
= XCDR (XCAR (prop
)),
212 ? COMPOSITION_RELATIVE
213 : (INTEGERP (temp
) || STRINGP (temp
))
214 ? COMPOSITION_WITH_ALTCHARS
215 : COMPOSITION_WITH_RULE_ALTCHARS
)));
218 /* Return 1 if the composition is valid. It is valid if
219 length of the composition equals to (END - START). */
220 COMPOSITE_INLINE
bool
221 composition_valid_p (ptrdiff_t start
, ptrdiff_t end
, Lisp_Object prop
)
226 && (COMPOSITION_REGISTERD_P (prop
)
227 ? (COMPOSITION_ID (prop
) >= 0
228 && COMPOSITION_ID (prop
) <= n_compositions
229 && CONSP (XCDR (prop
)))
230 : (temp
= XCAR (prop
),
232 && (temp
= XCDR (temp
),
238 && (end
- start
) == COMPOSITION_LENGTH (prop
));
241 /* Macros for lispy glyph-string. This is completely different from
242 struct glyph_string. */
244 #define LGSTRING_HEADER(lgs) AREF (lgs, 0)
245 #define LGSTRING_SET_HEADER(lgs, header) ASET (lgs, 0, header)
247 #define LGSTRING_FONT(lgs) AREF (LGSTRING_HEADER (lgs), 0)
248 #define LGSTRING_CHAR(lgs, i) AREF (LGSTRING_HEADER (lgs), (i) + 1)
249 #define LGSTRING_CHAR_LEN(lgs) (ASIZE (LGSTRING_HEADER (lgs)) - 1)
251 #define LGSTRING_SET_FONT(lgs, val) ASET (LGSTRING_HEADER (lgs), 0, (val))
252 #define LGSTRING_SET_CHAR(lgs, i, c) ASET (LGSTRING_HEADER (lgs), (i) + 1, (c))
254 #define LGSTRING_ID(lgs) AREF (lgs, 1)
255 #define LGSTRING_SET_ID(lgs, id) ASET (lgs, 1, id)
257 #define LGSTRING_GLYPH_LEN(lgs) (ASIZE ((lgs)) - 2)
258 #define LGSTRING_GLYPH(lgs, idx) AREF ((lgs), (idx) + 2)
259 #define LGSTRING_SET_GLYPH(lgs, idx, val) ASET ((lgs), (idx) + 2, (val))
260 COMPOSITE_INLINE Lisp_Object
*
261 lgstring_glyph_addr (Lisp_Object lgs
, ptrdiff_t idx
)
263 return aref_addr (lgs
, idx
+ 2);
266 /* Vector size of Lispy glyph. */
269 LGLYPH_IX_FROM
, LGLYPH_IX_TO
, LGLYPH_IX_CHAR
, LGLYPH_IX_CODE
,
270 LGLYPH_IX_WIDTH
, LGLYPH_IX_LBEARING
, LGLYPH_IX_RBEARING
,
271 LGLYPH_IX_ASCENT
, LGLYPH_IX_DESCENT
, LGLYPH_IX_ADJUSTMENT
,
276 #define LGLYPH_NEW() Fmake_vector (make_number (LGLYPH_SIZE), Qnil)
277 #define LGLYPH_FROM(g) XINT (AREF ((g), LGLYPH_IX_FROM))
278 #define LGLYPH_TO(g) XINT (AREF ((g), LGLYPH_IX_TO))
279 #define LGLYPH_CHAR(g) XINT (AREF ((g), LGLYPH_IX_CHAR))
280 #define LGLYPH_CODE(g) \
281 (NILP (AREF ((g), LGLYPH_IX_CODE)) \
282 ? FONT_INVALID_CODE \
283 : cons_to_unsigned (AREF (g, LGLYPH_IX_CODE), TYPE_MAXIMUM (unsigned)))
284 #define LGLYPH_WIDTH(g) XINT (AREF ((g), LGLYPH_IX_WIDTH))
285 #define LGLYPH_LBEARING(g) XINT (AREF ((g), LGLYPH_IX_LBEARING))
286 #define LGLYPH_RBEARING(g) XINT (AREF ((g), LGLYPH_IX_RBEARING))
287 #define LGLYPH_ASCENT(g) XINT (AREF ((g), LGLYPH_IX_ASCENT))
288 #define LGLYPH_DESCENT(g) XINT (AREF ((g), LGLYPH_IX_DESCENT))
289 #define LGLYPH_ADJUSTMENT(g) AREF ((g), LGLYPH_IX_ADJUSTMENT)
290 #define LGLYPH_SET_FROM(g, val) ASET ((g), LGLYPH_IX_FROM, make_number (val))
291 #define LGLYPH_SET_TO(g, val) ASET ((g), LGLYPH_IX_TO, make_number (val))
292 #define LGLYPH_SET_CHAR(g, val) ASET ((g), LGLYPH_IX_CHAR, make_number (val))
293 /* Callers must assure that VAL is not negative! */
294 #define LGLYPH_SET_CODE(g, val) \
295 ASET (g, LGLYPH_IX_CODE, \
296 val == FONT_INVALID_CODE ? Qnil : INTEGER_TO_CONS (val))
298 #define LGLYPH_SET_WIDTH(g, val) ASET ((g), LGLYPH_IX_WIDTH, make_number (val))
299 #define LGLYPH_SET_LBEARING(g, val) ASET ((g), LGLYPH_IX_LBEARING, make_number (val))
300 #define LGLYPH_SET_RBEARING(g, val) ASET ((g), LGLYPH_IX_RBEARING, make_number (val))
301 #define LGLYPH_SET_ASCENT(g, val) ASET ((g), LGLYPH_IX_ASCENT, make_number (val))
302 #define LGLYPH_SET_DESCENT(g, val) ASET ((g), LGLYPH_IX_DESCENT, make_number (val))
303 #define LGLYPH_SET_ADJUSTMENT(g, val) ASET ((g), LGLYPH_IX_ADJUSTMENT, (val))
305 #define LGLYPH_XOFF(g) (VECTORP (LGLYPH_ADJUSTMENT (g)) \
306 ? XINT (AREF (LGLYPH_ADJUSTMENT (g), 0)) : 0)
307 #define LGLYPH_YOFF(g) (VECTORP (LGLYPH_ADJUSTMENT (g)) \
308 ? XINT (AREF (LGLYPH_ADJUSTMENT (g), 1)) : 0)
309 #define LGLYPH_WADJUST(g) (VECTORP (LGLYPH_ADJUSTMENT (g)) \
310 ? XINT (AREF (LGLYPH_ADJUSTMENT (g), 2)) : 0)
312 struct composition_it
;
316 extern Lisp_Object
composition_gstring_put_cache (Lisp_Object
, ptrdiff_t);
317 extern Lisp_Object
composition_gstring_from_id (ptrdiff_t);
318 extern bool composition_gstring_p (Lisp_Object
);
319 extern int composition_gstring_width (Lisp_Object
, ptrdiff_t, ptrdiff_t,
320 struct font_metrics
*);
322 extern void composition_compute_stop_pos (struct composition_it
*,
323 ptrdiff_t, ptrdiff_t, ptrdiff_t,
325 extern bool composition_reseat_it (struct composition_it
*, ptrdiff_t,
326 ptrdiff_t, ptrdiff_t, struct window
*,
327 struct face
*, Lisp_Object
);
328 extern int composition_update_it (struct composition_it
*,
329 ptrdiff_t, ptrdiff_t, Lisp_Object
);
331 extern ptrdiff_t composition_adjust_point (ptrdiff_t, ptrdiff_t);
335 #endif /* not EMACS_COMPOSITE_H */