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