Commit | Line | Data |
---|---|---|
c2f5bfd6 | 1 | /* font.h -- Interface definition for font handling. |
114f9c96 GM |
2 | Copyright (C) 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
3 | Copyright (C) 2006, 2007, 2008, 2009, 2010 | |
c2f5bfd6 KH |
4 | National Institute of Advanced Industrial Science and Technology (AIST) |
5 | Registration Number H13PRO009 | |
6 | ||
7 | This file is part of GNU Emacs. | |
8 | ||
b9b1cc14 | 9 | GNU Emacs is free software: you can redistribute it and/or modify |
c2f5bfd6 | 10 | it under the terms of the GNU General Public License as published by |
b9b1cc14 GM |
11 | the Free Software Foundation, either version 3 of the License, or |
12 | (at your option) any later version. | |
c2f5bfd6 KH |
13 | |
14 | GNU Emacs is distributed in the hope that it will be useful, | |
15 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | GNU General Public License for more details. | |
18 | ||
19 | You should have received a copy of the GNU General Public License | |
b9b1cc14 | 20 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
c2f5bfd6 KH |
21 | |
22 | #ifndef EMACS_FONT_H | |
23 | #define EMACS_FONT_H | |
24 | ||
25 | #include "ccl.h" | |
26 | ||
27 | /* We have three types of Lisp objects related to font. | |
28 | ||
29 | FONT-SPEC | |
30 | ||
875003e5 | 31 | Pseudo vector (length FONT_SPEC_MAX) of font properties. Some |
c2f5bfd6 KH |
32 | properties can be left unspecified (i.e. nil). Emacs asks |
33 | font-drivers to find a font by FONT-SPEC. A fontset entry | |
34 | specifies requisite properties whereas a face specifies just | |
875003e5 | 35 | preferable properties. |
c2f5bfd6 KH |
36 | |
37 | FONT-ENTITY | |
38 | ||
875003e5 KH |
39 | Pseudo vector (length FONT_ENTITY_MAX) of fully instanciated |
40 | font properties that a font-driver returns upon a request of | |
c2f5bfd6 KH |
41 | FONT-SPEC. |
42 | ||
875003e5 KH |
43 | Note: Only the method `list' and `match' of a font-driver can |
44 | create this object, and should never be modified by Lisp. | |
c2f5bfd6 KH |
45 | |
46 | FONT-OBJECT | |
47 | ||
875003e5 | 48 | Pseudo vector (length FONT_OBJECT_MAX) of a opend font. |
c2f5bfd6 | 49 | |
875003e5 KH |
50 | Lisp object encapsulating "struct font". This corresponds to |
51 | an opened font. | |
52 | ||
53 | Note: Only the method `open' of a font-driver can create this | |
54 | object, and should never be modified by Lisp. */ | |
55 | ||
56 | extern Lisp_Object Qfont_spec, Qfont_entity, Qfont_object; | |
c2f5bfd6 KH |
57 | |
58 | ||
59 | struct font_driver; | |
60 | struct font; | |
e6aca9f3 | 61 | struct glyph_string; |
c2f5bfd6 KH |
62 | |
63 | /* An enumerator for each font property. This is used as an index to | |
64 | the vector of FONT-SPEC and FONT-ENTITY. | |
65 | ||
66 | Note: The order is important and should not be changed. */ | |
67 | ||
68 | enum font_property_index | |
69 | { | |
70 | /* FONT-TYPE is a symbol indicating a font backend; currently `x', | |
4a3f9f7f JB |
71 | `xft', `ftx' are available on X, `uniscribe' and `gdi' on |
72 | Windows, and `ns' under Cocoa / GNUstep. */ | |
c2f5bfd6 KH |
73 | FONT_TYPE_INDEX, |
74 | ||
75 | /* FONT-FOUNDRY is a foundry name (symbol). */ | |
76 | FONT_FOUNDRY_INDEX, | |
77 | ||
78 | /* FONT-FAMILY is a family name (symbol). */ | |
79 | FONT_FAMILY_INDEX, | |
80 | ||
81 | /* FONT-ADSTYLE is an additional style name (symbol). */ | |
82 | FONT_ADSTYLE_INDEX, | |
83 | ||
84 | /* FONT-REGISTRY is a combination of a charset-registry and | |
875003e5 | 85 | charset-encoding name (symbol). */ |
c2f5bfd6 KH |
86 | FONT_REGISTRY_INDEX, |
87 | ||
88 | /* FONT-WEIGHT is a numeric value of weight (e.g. medium, bold) of | |
875003e5 KH |
89 | the font. The lowest 8-bit is an index determining the |
90 | symbolic name, and the higher bits is the actual numeric value | |
91 | defined in `font-weight-table'. */ | |
c2f5bfd6 KH |
92 | FONT_WEIGHT_INDEX, |
93 | ||
94 | /* FONT-SLANT is a numeric value of slant (e.g. r, i, o) of the | |
875003e5 KH |
95 | font. The lowest 8-bit is an index determining the symbolic |
96 | name, and the higher bits is the actual numeric value defined | |
97 | in `font-slant-table'. */ | |
c2f5bfd6 KH |
98 | FONT_SLANT_INDEX, |
99 | ||
875003e5 KH |
100 | /* FONT-WIDTH is a numeric value of setwidth (e.g. normal) of the |
101 | font. The lowest 8-bit is an index determining the symbolic | |
102 | name, and the higher bits is the actual numeric value defined | |
103 | `font-width-table'. */ | |
c2f5bfd6 KH |
104 | FONT_WIDTH_INDEX, |
105 | ||
106 | /* FONT-SIZE is a size of the font. If integer, it is a pixel | |
107 | size. For a font-spec, the value can be float specifying a | |
875003e5 KH |
108 | point size. The value zero means that the font is |
109 | scalable. */ | |
c2f5bfd6 KH |
110 | FONT_SIZE_INDEX, |
111 | ||
875003e5 KH |
112 | /* FONT-DPI is a resolution (dot per inch) for which the font is |
113 | designed. */ | |
114 | FONT_DPI_INDEX, | |
115 | ||
116 | /* FONT-SPACING is a spacing (mono, proportional, charcell) of the | |
117 | font (integer; one of enum font_spacing). */ | |
118 | FONT_SPACING_INDEX, | |
119 | ||
120 | /* FONT-AVGWIDTH is an average width (1/10 pixel unit) of the | |
121 | font. */ | |
122 | FONT_AVGWIDTH_INDEX, | |
123 | ||
124 | #if 0 | |
125 | /* The following two members are to substitute for the above 6 | |
126 | members (FONT_WEIGHT_INDEX to FONT_AVGWIDTH_INDEX excluding | |
127 | FONT_SIZE_INDEX) if it is found that font-entities consumes too | |
128 | much memory. */ | |
129 | ||
130 | /* FONT-STYLE is a 24-bit integer containing indices for | |
131 | style-related properties WEIGHT, SLANT, and WIDTH. The lowest | |
132 | 8-bit is an indice to the weight table AREF (font_style_table, | |
133 | 0), the next 8-bit is an indice to the slant table AREF | |
134 | (font_style_table, 1), the highest 8-bit is an indice to the | |
135 | slant table AREF (font_style_table, 2). The indice 0 indicates | |
136 | that the corresponding style is not specified. This way, we | |
137 | can represent at most 255 different names for each style, which | |
138 | is surely sufficient. */ | |
139 | FONT_STYLE_INDEX, | |
140 | ||
141 | /* FONT-METRICS is a 27-bit integer containing metrics-related | |
142 | properties DPI, AVGWIDTH, SPACING. The lowest 12-bit is for | |
143 | DPI, the next 12-bit is for AVGWIDTH, the highest 3-bit is for | |
144 | SPACING. In each bit field, the highest bit indicates that the | |
145 | corresponding value is set or not. This way, we can represent | |
146 | DPI by 11-bit (0 to 2047), AVGWIDTH by 11-bit (0 to 2047), | |
147 | SPACING by 3-bit (0 for proportional, 1 for dual, 2 for mono, 3 | |
148 | for charcell), which is surely sufficient. */ | |
149 | FONT_METRICS_INDEX, | |
150 | #endif | |
151 | ||
c2f5bfd6 KH |
152 | /* In a font-spec, the value is an alist of extra information of a |
153 | font such as name, OpenType features, and language coverage. | |
875003e5 | 154 | In addition, in a font-entity, the value may contain a pair |
ebb26565 | 155 | (font-entity . INFO) where INFO is extra information to identify |
f6b4d85c | 156 | a font (font-driver dependent). */ |
c2f5bfd6 KH |
157 | FONT_EXTRA_INDEX, /* alist alist */ |
158 | ||
159 | /* This value is the length of font-spec vector. */ | |
160 | FONT_SPEC_MAX, | |
161 | ||
a7840ffb | 162 | /* The followings are used only for a font-entity and a font-object. */ |
c2f5bfd6 | 163 | |
875003e5 KH |
164 | /* List of font-objects opened from the font-entity. */ |
165 | FONT_OBJLIST_INDEX = FONT_SPEC_MAX, | |
c2f5bfd6 | 166 | |
a7840ffb KH |
167 | /* Font-entity from which the font-object is opened. */ |
168 | FONT_ENTITY_INDEX = FONT_SPEC_MAX, | |
169 | ||
c2f5bfd6 | 170 | /* This value is the length of font-entity vector. */ |
875003e5 KH |
171 | FONT_ENTITY_MAX, |
172 | ||
a7840ffb KH |
173 | /* The followings are used only for a font-object. */ |
174 | ||
875003e5 KH |
175 | /* XLFD name of the font (string). */ |
176 | FONT_NAME_INDEX = FONT_ENTITY_MAX, | |
4a3f9f7f | 177 | |
875003e5 KH |
178 | /* Full name of the font (string). It is the name extracted from |
179 | the opend font, and may be different from the above. It may be | |
180 | nil if the opened font doesn't give a name. */ | |
181 | FONT_FULLNAME_INDEX, | |
182 | ||
183 | /* File name of the font or nil if a file associated with the font | |
184 | is not available. */ | |
185 | FONT_FILE_INDEX, | |
186 | ||
25b81df4 | 187 | /* Format of the font (symbol) or nil if unknown. */ |
875003e5 KH |
188 | FONT_FORMAT_INDEX, |
189 | ||
190 | /* This value is the length of font-object vector. */ | |
191 | FONT_OBJECT_MAX | |
c2f5bfd6 KH |
192 | }; |
193 | ||
875003e5 KH |
194 | /* Return the numeric weight value of FONT. */ |
195 | #define FONT_WEIGHT_NUMERIC(font) \ | |
196 | (INTEGERP (AREF ((font), FONT_WEIGHT_INDEX)) \ | |
197 | ? (XINT (AREF ((font), FONT_WEIGHT_INDEX)) >> 8) : -1) | |
198 | /* Return the numeric slant value of FONT. */ | |
199 | #define FONT_SLANT_NUMERIC(font) \ | |
200 | (INTEGERP (AREF ((font), FONT_SLANT_INDEX)) \ | |
201 | ? (XINT (AREF ((font), FONT_SLANT_INDEX)) >> 8) : -1) | |
202 | /* Return the numeric width value of FONT. */ | |
203 | #define FONT_WIDTH_NUMERIC(font) \ | |
204 | (INTEGERP (AREF ((font), FONT_WIDTH_INDEX)) \ | |
205 | ? (XINT (AREF ((font), FONT_WIDTH_INDEX)) >> 8) : -1) | |
206 | /* Return the symbolic weight value of FONT. */ | |
207 | #define FONT_WEIGHT_SYMBOLIC(font) \ | |
208 | font_style_symbolic (font, FONT_WEIGHT_INDEX, 0) | |
209 | /* Return the symbolic slant value of FONT. */ | |
210 | #define FONT_SLANT_SYMBOLIC(font) \ | |
211 | font_style_symbolic (font, FONT_SLANT_INDEX, 0) | |
212 | /* Return the symbolic width value of FONT. */ | |
213 | #define FONT_WIDTH_SYMBOLIC(font) \ | |
214 | font_style_symbolic (font, FONT_WIDTH_INDEX, 0) | |
215 | /* Return the face-weight corresponding to the weight of FONT. */ | |
216 | #define FONT_WEIGHT_FOR_FACE(font) \ | |
217 | font_style_symbolic (font, FONT_WEIGHT_INDEX, 1) | |
218 | /* Return the face-slant corresponding to the slant of FONT. */ | |
219 | #define FONT_SLANT_FOR_FACE(font) \ | |
220 | font_style_symbolic (font, FONT_SLANT_INDEX, 1) | |
221 | /* Return the face-swidth corresponding to the slant of FONT. */ | |
222 | #define FONT_WIDTH_FOR_FACE(font) \ | |
223 | font_style_symbolic (font, FONT_WIDTH_INDEX, 1) | |
224 | ||
225 | /* Return the numeric weight value corresponding ot the symbol NAME. */ | |
226 | #define FONT_WEIGHT_NAME_NUMERIC(name) \ | |
227 | (font_style_to_value (FONT_WEIGHT_INDEX, (name), 0) >> 8) | |
228 | /* Return the numeric slant value corresponding ot the symbol NAME. */ | |
229 | #define FONT_SLANT_NAME_NUMERIC(name) \ | |
230 | (font_style_to_value (FONT_SLANT_INDEX, (name), 0) >> 8) | |
231 | /* Return the numeric width value corresponding ot the symbol NAME. */ | |
232 | #define FONT_WIDTH_NAME_NUMERIC(name) \ | |
233 | (font_style_to_value (FONT_WIDTH_INDEX, (name), 0) >> 8) | |
234 | ||
235 | /* Set the font property PROP of FONT to VAL. PROP is one of | |
236 | style-related font property index (FONT_WEIGHT/SLANT/WIDTH_INDEX). | |
237 | VAL (integer or symbol) is the numeric or symbolic style value. */ | |
238 | #define FONT_SET_STYLE(font, prop, val) \ | |
239 | ASET ((font), prop, make_number (font_style_to_value (prop, val, 1))) | |
240 | ||
241 | extern Lisp_Object QCspacing, QCdpi, QCscalable, QCotf, QClang, QCscript; | |
242 | extern Lisp_Object QCavgwidth, QCfont_entity, QCfc_unknown_spec; | |
c2f5bfd6 | 243 | |
3223c449 | 244 | /* Important character set symbols. */ |
366664ad | 245 | extern Lisp_Object Qascii_0; |
32d497b1 | 246 | extern Lisp_Object Qiso8859_1, Qiso10646_1, Qunicode_bmp, Qunicode_sip; |
3223c449 | 247 | |
cf702558 CY |
248 | /* Special ADSTYLE properties to avoid fonts used for Latin characters. */ |
249 | extern Lisp_Object Qja, Qko; | |
250 | ||
875003e5 KH |
251 | /* Structure for a font-spec. */ |
252 | ||
253 | struct font_spec | |
254 | { | |
255 | EMACS_UINT size; | |
256 | struct Lisp_Vector *next; | |
257 | Lisp_Object props[FONT_SPEC_MAX]; | |
258 | }; | |
259 | ||
260 | /* Structure for a font-entity. */ | |
261 | ||
262 | struct font_entity | |
263 | { | |
264 | EMACS_UINT size; | |
265 | struct Lisp_Vector *next; | |
266 | Lisp_Object props[FONT_ENTITY_MAX]; | |
267 | }; | |
c2f5bfd6 | 268 | |
875003e5 KH |
269 | /* A value which may appear in the member `encoding' of struct font |
270 | indicating that a font itself doesn't tell which encoding to be | |
271 | used. */ | |
272 | #define FONT_ENCODING_NOT_DECIDED 255 | |
273 | ||
274 | /* Structure for a font-object. */ | |
c2f5bfd6 KH |
275 | |
276 | struct font | |
277 | { | |
875003e5 KH |
278 | EMACS_UINT size; |
279 | struct Lisp_Vector *next; | |
280 | ||
281 | /* All Lisp_Object components must come first. | |
282 | That ensures they are all aligned normally. */ | |
c2f5bfd6 | 283 | |
875003e5 KH |
284 | Lisp_Object props[FONT_OBJECT_MAX]; |
285 | ||
286 | /* Beyond here, there should be no more Lisp_Object components. */ | |
287 | ||
288 | /* Maximum bound width over all existing characters of the font. On | |
289 | X window, this is same as (font->max_bounds.width). */ | |
290 | int max_width; | |
c2f5bfd6 KH |
291 | |
292 | /* By which pixel size the font is opened. */ | |
293 | int pixel_size; | |
294 | ||
875003e5 KH |
295 | /* Height of the font. On X window, this is the same as |
296 | (font->ascent + font->descent). */ | |
297 | int height; | |
298 | ||
299 | /* Width of the space glyph of the font. If the font doesn't have a | |
300 | SPACE glyph, the value is 0. */ | |
301 | int space_width; | |
302 | ||
303 | /* Average width of glyphs in the font. If the font itself doesn't | |
304 | have that information but has glyphs of ASCII character, the | |
305 | value is the average with of those glyphs. Otherwise, the value | |
306 | is 0. */ | |
307 | int average_width; | |
308 | ||
309 | /* Minimum glyph width (in pixels). */ | |
310 | int min_width; | |
c2f5bfd6 | 311 | |
875003e5 KH |
312 | /* Ascent and descent of the font (in pixels). */ |
313 | int ascent, descent; | |
c6666169 | 314 | |
875003e5 KH |
315 | /* Vertical pixel width of the underline. If is zero if that |
316 | information is not in the font. */ | |
317 | int underline_thickness; | |
318 | ||
319 | /* Vertical pixel position (relative to the baseline) of the | |
320 | underline. If it is positive, it is below the baseline. It is | |
321 | negative if that information is not in the font. */ | |
322 | int underline_position; | |
323 | ||
324 | /* 1 if `vertical-centering-font-regexp' matches this font name. | |
325 | In this case, we render characters at vartical center positions | |
326 | of lines. */ | |
327 | int vertical_centering; | |
328 | ||
329 | /* Encoding type of the font. The value is one of | |
330 | 0, 1, 2, or 3: | |
331 | 0: code points 0x20..0x7F or 0x2020..0x7F7F are used | |
332 | 1: code points 0xA0..0xFF or 0xA0A0..0xFFFF are used | |
333 | 2: code points 0x20A0..0x7FFF are used | |
334 | 3: code points 0xA020..0xFF7F are used | |
335 | If the member `font_encoder' is not NULL, this member is ignored. */ | |
336 | unsigned char encoding_type; | |
337 | ||
338 | /* The baseline position of a font is normally `ascent' value of the | |
339 | font. However, there exists many fonts which don't set `ascent' | |
340 | an appropriate value to be used as baseline position. This is | |
341 | typical in such ASCII fonts which are designed to be used with | |
342 | Chinese, Japanese, Korean characters. When we use mixture of | |
343 | such fonts and normal fonts (having correct `ascent' value), a | |
344 | display line gets very ugly. Since we have no way to fix it | |
345 | automatically, it is users responsibility to supply well designed | |
346 | fonts or correct `ascent' value of fonts. But, the latter | |
347 | requires heavy work (modifying all bitmap data in BDF files). | |
348 | So, Emacs accepts a private font property | |
349 | `_MULE_BASELINE_OFFSET'. If a font has this property, we | |
350 | calculate the baseline position by subtracting the value from | |
351 | `ascent'. In other words, the value indicates how many bits | |
352 | higher we should draw a character of the font than normal ASCII | |
353 | text for a better looking. | |
354 | ||
355 | We also have to consider the fact that the concept of `baseline' | |
356 | differs among scripts to which each character belongs. For | |
357 | instance, baseline should be at the bottom most position of all | |
358 | glyphs for Chinese, Japanese, and Korean. But, many of existing | |
359 | fonts for those characters doesn't have correct `ascent' values | |
360 | because they are designed to be used with ASCII fonts. To | |
361 | display characters of different language on the same line, the | |
362 | best way will be to arrange them in the middle of the line. So, | |
363 | in such a case, again, we utilize the font property | |
364 | `_MULE_BASELINE_OFFSET'. If the value is larger than `ascent' we | |
365 | calculate baseline so that a character is arranged in the middle | |
366 | of a line. */ | |
367 | int baseline_offset; | |
368 | ||
369 | /* Non zero means a character should be composed at a position | |
370 | relative to the height (or depth) of previous glyphs in the | |
371 | following cases: | |
372 | (1) The bottom of the character is higher than this value. In | |
373 | this case, the character is drawn above the previous glyphs. | |
374 | (2) The top of the character is lower than 0 (i.e. baseline | |
375 | height). In this case, the character is drawn beneath the | |
376 | previous glyphs. | |
377 | ||
378 | This value is taken from a private font property | |
379 | `_MULE_RELATIVE_COMPOSE' which is introduced by Emacs. */ | |
380 | int relative_compose; | |
381 | ||
382 | /* Non zero means an ascent value to be used for a character | |
383 | registered in char-table `use-default-ascent'. */ | |
384 | int default_ascent; | |
385 | ||
386 | /* CCL program to calculate code points of the font. */ | |
387 | struct ccl_program *font_encoder; | |
388 | ||
389 | /* Font-driver for the font. */ | |
390 | struct font_driver *driver; | |
c2f5bfd6 | 391 | |
64c9fe54 KH |
392 | /* Charset to encode a character code into a glyph code of the font. |
393 | -1 means that the font doesn't require this information to encode | |
394 | a character. */ | |
c2f5bfd6 KH |
395 | int encoding_charset; |
396 | ||
397 | /* Charset to check if a character code is supported by the font. | |
398 | -1 means that the contents of the font must be looked up to | |
64c9fe54 | 399 | determine it. */ |
e2a3f5b2 | 400 | int repertory_charset; |
c2f5bfd6 | 401 | |
c2f5bfd6 KH |
402 | /* There will be more to this structure, but they are private to a |
403 | font-driver. */ | |
404 | }; | |
405 | ||
f8657b39 KH |
406 | enum font_spacing |
407 | { | |
408 | FONT_SPACING_PROPORTIONAL = 0, | |
409 | FONT_SPACING_DUAL = 90, | |
410 | FONT_SPACING_MONO = 100, | |
411 | FONT_SPACING_CHARCELL = 110 | |
412 | }; | |
413 | ||
c2f5bfd6 KH |
414 | struct font_metrics |
415 | { | |
416 | short lbearing, rbearing, width, ascent, descent; | |
417 | }; | |
418 | ||
419 | struct font_bitmap | |
420 | { | |
5a74d0e5 | 421 | int bits_per_pixel; |
c2f5bfd6 KH |
422 | int rows; |
423 | int width; | |
424 | int pitch; | |
425 | unsigned char *buffer; | |
426 | int left; | |
427 | int top; | |
428 | int advance; | |
429 | void *extra; | |
430 | }; | |
431 | ||
432 | /* Predicates to check various font-related objects. */ | |
433 | ||
875003e5 KH |
434 | /* 1 iff X is one of font-spec, font-entity, and font-object. */ |
435 | #define FONTP(x) PSEUDOVECTORP (x, PVEC_FONT) | |
436 | /* 1 iff X is font-spec. */ | |
c2f5bfd6 | 437 | #define FONT_SPEC_P(x) \ |
875003e5 KH |
438 | (FONTP (x) && (ASIZE (x) & PSEUDOVECTOR_SIZE_MASK) == FONT_SPEC_MAX) |
439 | /* 1 iff X is font-entity. */ | |
c2f5bfd6 | 440 | #define FONT_ENTITY_P(x) \ |
875003e5 KH |
441 | (FONTP (x) && (ASIZE (x) & PSEUDOVECTOR_SIZE_MASK) == FONT_ENTITY_MAX) |
442 | /* 1 iff X is font-object. */ | |
c2f5bfd6 | 443 | #define FONT_OBJECT_P(x) \ |
875003e5 | 444 | (FONTP (x) && (ASIZE (x) & PSEUDOVECTOR_SIZE_MASK) == FONT_OBJECT_MAX) |
c2f5bfd6 | 445 | |
875003e5 | 446 | /* 1 iff ENTITY can't be loaded. */ |
4b4836de KH |
447 | #define FONT_ENTITY_NOT_LOADABLE(entity) \ |
448 | EQ (AREF (entity, FONT_OBJLIST_INDEX), Qt) | |
449 | ||
875003e5 | 450 | /* Flag ENTITY not loadable. */ |
4b4836de KH |
451 | #define FONT_ENTITY_SET_NOT_LOADABLE(entity) \ |
452 | ASET (entity, FONT_OBJLIST_INDEX, Qt) | |
453 | ||
c2f5bfd6 KH |
454 | |
455 | /* Check macros for various font-related objects. */ | |
456 | ||
457 | #define CHECK_FONT(x) \ | |
02dfeba8 | 458 | do { if (! FONTP (x)) wrong_type_argument (Qfont, x); } while (0) |
c2f5bfd6 | 459 | #define CHECK_FONT_SPEC(x) \ |
875003e5 | 460 | do { if (! FONT_SPEC_P (x)) wrong_type_argument (Qfont_spec, x); } while (0) |
c2f5bfd6 | 461 | #define CHECK_FONT_ENTITY(x) \ |
875003e5 | 462 | do { if (! FONT_ENTITY_P (x)) wrong_type_argument (Qfont_entity, x); } while (0) |
c2f5bfd6 | 463 | #define CHECK_FONT_OBJECT(x) \ |
875003e5 | 464 | do { if (! FONT_OBJECT_P (x)) wrong_type_argument (Qfont_object, x); } while (0) |
c2f5bfd6 | 465 | |
875003e5 KH |
466 | #define CHECK_FONT_GET_OBJECT(x, font) \ |
467 | do { \ | |
468 | CHECK_FONT_OBJECT (x); \ | |
469 | font = XFONT_OBJECT (x); \ | |
c2f5bfd6 KH |
470 | } while (0) |
471 | ||
875003e5 KH |
472 | #define XFONT_SPEC(p) \ |
473 | (eassert (FONT_SPEC_P(p)), (struct font_spec *) XPNTR (p)) | |
474 | #define XFONT_ENTITY(p) \ | |
475 | (eassert (FONT_ENTITY_P(p)), (struct font_entity *) XPNTR (p)) | |
476 | #define XFONT_OBJECT(p) \ | |
477 | (eassert (FONT_OBJECT_P(p)), (struct font *) XPNTR (p)) | |
478 | #define XSETFONT(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_FONT)) | |
479 | ||
480 | /* Number of pt per inch (from the TeXbook). */ | |
481 | #define PT_PER_INCH 72.27 | |
482 | ||
483 | /* Return a pixel size (integer) corresponding to POINT size (double) | |
484 | on resolution DPI. */ | |
485 | #define POINT_TO_PIXEL(POINT, DPI) ((POINT) * (DPI) / PT_PER_INCH + 0.5) | |
486 | ||
c4e8ee5e JR |
487 | /* Return a point size corresponding to POINT size (integer) |
488 | on resolution DPI. Note that though point size is a double, we expect | |
489 | it to be rounded to an int, so we add 0.5 here. If the desired value | |
490 | is tenths of points (as in xfld specs), then the pixel size should | |
491 | be multiplied BEFORE the conversion to avoid magnifying the error. */ | |
875003e5 KH |
492 | #define PIXEL_TO_POINT(PIXEL, DPI) ((PIXEL) * PT_PER_INCH / (DPI) + 0.5) |
493 | ||
f8657b39 KH |
494 | /* Ignore the difference of font pixel sizes less than or equal to |
495 | this value. */ | |
496 | #define FONT_PIXEL_SIZE_QUANTUM 1 | |
497 | ||
c2f5bfd6 | 498 | struct face; |
c2f5bfd6 KH |
499 | |
500 | #define FONT_INVALID_CODE 0xFFFFFFFF | |
501 | ||
217caa37 KH |
502 | /* Font driver. Members specified as "optional" can be NULL. */ |
503 | ||
c2f5bfd6 KH |
504 | struct font_driver |
505 | { | |
506 | /* Symbol indicating the type of the font-driver. */ | |
507 | Lisp_Object type; | |
508 | ||
f6b4d85c | 509 | /* 1 iff the font's foundry, family, and adstyle names are case |
875003e5 KH |
510 | sensitve. */ |
511 | int case_sensitive; | |
512 | ||
69ea039a | 513 | /* Return a cache of font-entities on frame F. The cache must be a |
c2f5bfd6 | 514 | cons whose cdr part is the actual cache area. */ |
383e0970 | 515 | Lisp_Object (*get_cache) (FRAME_PTR F); |
c2f5bfd6 | 516 | |
dc377380 | 517 | /* List fonts exactly matching with FONT_SPEC on FRAME. The value |
e38b9ee9 | 518 | is a list of font-entities. The font properties to be considered |
81903466 | 519 | are: :foundry, :family, :adstyle, :registry, :script, :lang, and |
e38b9ee9 KH |
520 | :otf. See the function `font-spec' for their meanings. Note |
521 | that the last three properties are stored in FONT_EXTRA_INDEX | |
522 | slot of FONT_SPEC. | |
523 | ||
524 | The returned value is a list of font-entities. Each font-entity | |
525 | has :type property whose value is the same as the above `type'. | |
526 | It also has these properties if they are available from the | |
527 | corresponding font; :foundry, :family, :adstyle, :registry, | |
528 | :weight, :slant, :width, :size, :dpi, :spacing, :avgwidth. If | |
529 | the font is scalable, :size and :avgwidth must be 0. | |
530 | ||
531 | The `open' method of the same font-backend is called with one of | |
532 | the returned font-entities. If the backend needs additional | |
533 | information to be used in `open' method, this method can add any | |
534 | Lispy value by the property :font-entity to the entities. | |
535 | ||
875003e5 KH |
536 | This and the following `match' are the only APIs that allocate |
537 | font-entities. */ | |
383e0970 | 538 | Lisp_Object (*list) (Lisp_Object frame, Lisp_Object font_spec); |
c2f5bfd6 | 539 | |
81903466 | 540 | /* Return a font-entity most closely matching with FONT_SPEC on |
e38b9ee9 | 541 | FRAME. Which font property to consider, and how to calculate the |
81903466 | 542 | closeness is determined by the font backend, thus |
e38b9ee9 KH |
543 | `face-font-selection-order' is ignored here. |
544 | ||
545 | The properties that the font-entity has is the same as `list' | |
546 | method. */ | |
383e0970 | 547 | Lisp_Object (*match) (Lisp_Object frame, Lisp_Object font_spec); |
dc377380 | 548 | |
217caa37 KH |
549 | /* Optional. |
550 | List available families. The value is a list of family names | |
551 | (symbols). */ | |
383e0970 | 552 | Lisp_Object (*list_family) (Lisp_Object frame); |
c2f5bfd6 | 553 | |
217caa37 KH |
554 | /* Optional (if FONT_EXTRA_INDEX is not Lisp_Save_Value). |
555 | Free FONT_EXTRA_INDEX field of FONT_ENTITY. */ | |
383e0970 | 556 | void (*free_entity) (Lisp_Object font_entity); |
c2f5bfd6 KH |
557 | |
558 | /* Open a font specified by FONT_ENTITY on frame F. If the font is | |
559 | scalable, open it with PIXEL_SIZE. */ | |
383e0970 J |
560 | Lisp_Object (*open) (FRAME_PTR f, Lisp_Object font_entity, |
561 | int pixel_size); | |
c2f5bfd6 KH |
562 | |
563 | /* Close FONT on frame F. */ | |
383e0970 | 564 | void (*close) (FRAME_PTR f, struct font *font); |
c2f5bfd6 | 565 | |
217caa37 KH |
566 | /* Optional (if FACE->extra is not used). |
567 | Prepare FACE for displaying characters by FONT on frame F by | |
568 | storing some data in FACE->extra. If successful, return 0. | |
569 | Otherwise, return -1. */ | |
383e0970 | 570 | int (*prepare_face) (FRAME_PTR f, struct face *face); |
c2f5bfd6 | 571 | |
217caa37 KH |
572 | /* Optional. |
573 | Done FACE for displaying characters by FACE->font on frame F. */ | |
383e0970 | 574 | void (*done_face) (FRAME_PTR f, struct face *face); |
c2f5bfd6 | 575 | |
217caa37 | 576 | /* Optional. |
50b426eb KH |
577 | If FONT (FONT-ENTITY or FONT-OBJECT) has a glyph for character C |
578 | (Unicode code point), return 1. If not, return 0. If FONT is | |
579 | FONT-ENTITY and it must be opened to check it, return -1. */ | |
383e0970 | 580 | int (*has_char) (Lisp_Object font, int c); |
c2f5bfd6 | 581 | |
217caa37 KH |
582 | /* Return a glyph code of FONT for characer C (Unicode code point). |
583 | If FONT doesn't have such a glyph, return FONT_INVALID_CODE. */ | |
383e0970 | 584 | unsigned (*encode_char) (struct font *font, int c); |
c2f5bfd6 | 585 | |
ef5e1a96 KH |
586 | /* Computate the total metrics of the NGLYPHS glyphs specified by |
587 | the font FONT and the sequence of glyph codes CODE, and store the | |
588 | result in METRICS. */ | |
383e0970 J |
589 | int (*text_extents) (struct font *font, |
590 | unsigned *code, int nglyphs, | |
591 | struct font_metrics *metrics); | |
c2f5bfd6 | 592 | |
217caa37 KH |
593 | /* Optional. |
594 | Draw glyphs between FROM and TO of S->char2b at (X Y) pixel | |
c2f5bfd6 KH |
595 | position of frame F with S->FACE and S->GC. If WITH_BACKGROUND |
596 | is nonzero, fill the background in advance. It is assured that | |
597 | WITH_BACKGROUND is zero when (FROM > 0 || TO < S->nchars). */ | |
383e0970 J |
598 | int (*draw) (struct glyph_string *s, int from, int to, |
599 | int x, int y, int with_background); | |
c2f5bfd6 | 600 | |
217caa37 KH |
601 | /* Optional. |
602 | Store bitmap data for glyph-code CODE of FONT in BITMAP. It is | |
603 | intended that this method is callled from the other font-driver | |
604 | for actual drawing. */ | |
383e0970 J |
605 | int (*get_bitmap) (struct font *font, unsigned code, |
606 | struct font_bitmap *bitmap, | |
607 | int bits_per_pixel); | |
c2f5bfd6 | 608 | |
217caa37 KH |
609 | /* Optional. |
610 | Free bitmap data in BITMAP. */ | |
383e0970 | 611 | void (*free_bitmap) (struct font *font, struct font_bitmap *bitmap); |
c2f5bfd6 | 612 | |
217caa37 KH |
613 | /* Optional. |
614 | Return an outline data for glyph-code CODE of FONT. The format | |
615 | of the outline data depends on the font-driver. */ | |
383e0970 | 616 | void *(*get_outline) (struct font *font, unsigned code); |
c2f5bfd6 | 617 | |
217caa37 KH |
618 | /* Optional. |
619 | Free OUTLINE (that is obtained by the above method). */ | |
383e0970 | 620 | void (*free_outline) (struct font *font, void *outline); |
c2f5bfd6 | 621 | |
217caa37 KH |
622 | /* Optional. |
623 | Get coordinates of the INDEXth anchor point of the glyph whose | |
c2f5bfd6 | 624 | code is CODE. Store the coordinates in *X and *Y. Return 0 if |
217caa37 | 625 | the operations was successfull. Otherwise return -1. */ |
383e0970 J |
626 | int (*anchor_point) (struct font *font, unsigned code, int index, |
627 | int *x, int *y); | |
c2f5bfd6 | 628 | |
217caa37 KH |
629 | /* Optional. |
630 | Return a list describing which scripts/languages FONT | |
c2f5bfd6 | 631 | supports by which GSUB/GPOS features of OpenType tables. */ |
383e0970 | 632 | Lisp_Object (*otf_capability) (struct font *font); |
c2f5bfd6 | 633 | |
217caa37 | 634 | /* Optional. |
b6c8772a KH |
635 | Apply FONT's OTF-FEATURES to the glyph string. |
636 | ||
637 | FEATURES specifies which OTF features to apply in this format: | |
638 | (SCRIPT LANGSYS GSUB-FEATURE GPOS-FEATURE) | |
639 | See the documentation of `font-drive-otf' for the detail. | |
c2f5bfd6 KH |
640 | |
641 | This method applies the specified features to the codes in the | |
642 | elements of GSTRING-IN (between FROMth and TOth). The output | |
643 | codes are stored in GSTRING-OUT at the IDXth element and the | |
644 | following elements. | |
645 | ||
646 | Return the number of output codes. If none of the features are | |
647 | applicable to the input data, return 0. If GSTRING-OUT is too | |
648 | short, return -1. */ | |
383e0970 J |
649 | int (*otf_drive) (struct font *font, Lisp_Object features, |
650 | Lisp_Object gstring_in, int from, int to, | |
651 | Lisp_Object gstring_out, int idx, int alternate_subst); | |
5a74d0e5 KH |
652 | |
653 | /* Optional. | |
654 | Make the font driver ready for frame F. Usually this function | |
8057d3c0 | 655 | makes some data specific to F and stores it in F by calling |
5a74d0e5 | 656 | font_put_frame_data (). */ |
383e0970 | 657 | int (*start_for_frame) (FRAME_PTR f); |
4a3f9f7f | 658 | |
5a74d0e5 KH |
659 | /* Optional. |
660 | End using the driver for frame F. Usually this function free | |
661 | some data stored for F. */ | |
383e0970 | 662 | int (*end_for_frame) (FRAME_PTR f); |
4b4836de KH |
663 | |
664 | /* Optional. | |
778686b1 | 665 | |
8057d3c0 KH |
666 | Shape text in GSTRING. See the docstring of |
667 | `composition-get-gstring' for the format of GSTRING. If the | |
668 | (N+1)th element of GSTRING is nil, input of shaping is from the | |
669 | 1st to (N)th elements. In each input glyph, FROM, TO, CHAR, and | |
670 | CODE are already set. | |
778686b1 KH |
671 | |
672 | This function updates all fields of the input glyphs. If the | |
673 | output glyphs (M) are more than the input glyphs (N), (N+1)th | |
8057d3c0 KH |
674 | through (M)th elements of GSTRING are updated possibly by making |
675 | a new glyph object and storing it in GSTRING. If (M) is greater | |
676 | than the length of GSTRING, nil should be return. In that case, | |
677 | this function is called again with the larger GSTRING. */ | |
383e0970 | 678 | Lisp_Object (*shape) (Lisp_Object lgstring); |
875003e5 KH |
679 | |
680 | /* Optional. | |
681 | ||
682 | If FONT is usable on frame F, return 0. Otherwise return -1. | |
c63715cf KH |
683 | This method is used only for debugging. If this method is NULL, |
684 | Emacs assumes that the font is usable on any frame. */ | |
383e0970 | 685 | int (*check) (FRAME_PTR F, struct font *font); |
c63715cf KH |
686 | |
687 | /* Optional. | |
688 | ||
689 | Return the number of variation glyphs of character C supported by | |
690 | FONT. VARIATIONS is an array of 256 elements. If the variation | |
691 | selector N (1..256) defines a glyph, that glyph code is stored in | |
692 | the (N-1)th element of VARIATIONS. */ | |
383e0970 J |
693 | int (*get_variation_glyphs) (struct font *font, |
694 | int c, unsigned variations[256]); | |
637fa988 | 695 | |
383e0970 | 696 | void (*filter_properties) (Lisp_Object font, Lisp_Object properties); |
d0cf45b7 JD |
697 | |
698 | /* Optional. | |
699 | ||
700 | Return non-zero if FONT_OBJECT can be used as a (cached) font | |
701 | for ENTITY on frame F. */ | |
383e0970 J |
702 | int (*cached_font_ok) (struct frame *f, |
703 | Lisp_Object font_object, | |
704 | Lisp_Object entity); | |
c2f5bfd6 KH |
705 | }; |
706 | ||
707 | ||
5a74d0e5 KH |
708 | /* Chain of font drivers. There's one global font driver list |
709 | (font_driver_list in font.c). In addition, each frame has it's own | |
710 | font driver list at FRAME_PTR->font_driver_list. */ | |
711 | ||
c2f5bfd6 KH |
712 | struct font_driver_list |
713 | { | |
5a74d0e5 KH |
714 | /* 1 iff this driver is currently used. It is igonred in the global |
715 | font driver list.*/ | |
484ca464 | 716 | int on; |
5a74d0e5 | 717 | /* Pointer to the font driver. */ |
c2f5bfd6 | 718 | struct font_driver *driver; |
5a74d0e5 | 719 | /* Pointer to the next element of the chain. */ |
c2f5bfd6 KH |
720 | struct font_driver_list *next; |
721 | }; | |
722 | ||
5a74d0e5 KH |
723 | |
724 | /* Chain of arbitrary data specific to each font driver. Each frame | |
725 | has it's own font data list at FRAME_PTR->font_data_list. */ | |
726 | ||
727 | struct font_data_list | |
728 | { | |
729 | /* Pointer to the font driver. */ | |
730 | struct font_driver *driver; | |
731 | /* Data specific to the font driver. */ | |
732 | void *data; | |
733 | /* Pointer to the next element of the chain. */ | |
734 | struct font_data_list *next; | |
735 | }; | |
736 | ||
c2f5bfd6 | 737 | EXFUN (Ffont_spec, MANY); |
875003e5 KH |
738 | EXFUN (Fcopy_font_spec, 1); |
739 | EXFUN (Fmerge_font_spec, 2); | |
4b4836de | 740 | EXFUN (Ffont_get, 2); |
875003e5 | 741 | EXFUN (Ffont_put, 3); |
8d3251f2 | 742 | EXFUN (Flist_fonts, 4); |
875003e5 | 743 | EXFUN (Ffont_family_list, 1); |
484ca464 | 744 | EXFUN (Fclear_font_cache, 0); |
f6a651cb | 745 | EXFUN (Ffont_xlfd_name, 2); |
c2f5bfd6 | 746 | |
383e0970 J |
747 | extern Lisp_Object font_make_spec (void); |
748 | extern Lisp_Object font_make_entity (void); | |
749 | extern Lisp_Object font_make_object (int, Lisp_Object, int); | |
750 | ||
751 | extern Lisp_Object find_font_encoding (Lisp_Object); | |
752 | extern int font_registry_charsets (Lisp_Object, struct charset **, | |
753 | struct charset **); | |
754 | extern int font_style_to_value (enum font_property_index prop, | |
755 | Lisp_Object name, int noerror); | |
756 | extern Lisp_Object font_style_symbolic (Lisp_Object font, | |
757 | enum font_property_index prop, | |
758 | int for_face); | |
759 | ||
760 | extern int font_match_p (Lisp_Object spec, Lisp_Object font); | |
761 | extern Lisp_Object font_list_entities (Lisp_Object frame, | |
762 | Lisp_Object spec); | |
763 | ||
764 | extern Lisp_Object font_get_name (Lisp_Object font_object); | |
765 | extern Lisp_Object font_spec_from_name (Lisp_Object font_name); | |
766 | extern Lisp_Object font_get_frame (Lisp_Object font_object); | |
767 | extern int font_has_char (FRAME_PTR, Lisp_Object, int); | |
768 | extern unsigned font_encode_char (Lisp_Object, int); | |
769 | ||
770 | extern void font_clear_prop (Lisp_Object *attrs, | |
771 | enum font_property_index prop); | |
772 | extern void font_update_lface (FRAME_PTR f, Lisp_Object *attrs); | |
773 | extern Lisp_Object font_find_for_lface (FRAME_PTR f, Lisp_Object *lface, | |
774 | Lisp_Object spec, int c); | |
775 | extern Lisp_Object font_open_for_lface (FRAME_PTR f, Lisp_Object entity, | |
776 | Lisp_Object *lface, | |
777 | Lisp_Object spec); | |
778 | extern Lisp_Object font_load_for_lface (FRAME_PTR f, Lisp_Object *lface, | |
779 | Lisp_Object spec); | |
780 | extern void font_prepare_for_face (FRAME_PTR f, struct face *face); | |
781 | extern void font_done_for_face (FRAME_PTR f, struct face *face); | |
782 | ||
783 | extern Lisp_Object font_open_by_spec (FRAME_PTR f, Lisp_Object spec); | |
784 | extern Lisp_Object font_open_by_name (FRAME_PTR f, char *name); | |
64c9fe54 | 785 | extern void font_close_object (FRAME_PTR f, Lisp_Object font_object); |
c2f5bfd6 | 786 | |
383e0970 J |
787 | extern Lisp_Object font_intern_prop (char *str, int len, int force_symbol); |
788 | extern void font_update_sort_order (int *order); | |
789 | ||
790 | extern void font_parse_family_registry (Lisp_Object family, | |
791 | Lisp_Object registry, | |
792 | Lisp_Object spec); | |
793 | extern Lisp_Object font_spec_from_family_registry (Lisp_Object family, | |
794 | Lisp_Object registry); | |
795 | ||
796 | extern int font_parse_xlfd (char *name, Lisp_Object font); | |
797 | extern int font_unparse_xlfd (Lisp_Object font, int pixel_size, | |
798 | char *name, int bytes); | |
799 | extern int font_parse_fcname (char *name, Lisp_Object font); | |
800 | extern int font_unparse_fcname (Lisp_Object font, int pixel_size, | |
801 | char *name, int bytes); | |
802 | extern int font_unparse_gtkname (Lisp_Object, struct frame *, char *, int); | |
803 | extern void register_font_driver (struct font_driver *driver, FRAME_PTR f); | |
804 | extern void free_font_driver_list (FRAME_PTR f); | |
805 | extern Lisp_Object font_update_drivers (FRAME_PTR f, Lisp_Object list); | |
806 | extern Lisp_Object font_at (int c, EMACS_INT pos, struct face *face, | |
807 | struct window *w, Lisp_Object object); | |
c7c7a80c SM |
808 | extern Lisp_Object font_range (EMACS_INT, EMACS_INT *, |
809 | struct window *, struct face *, | |
810 | Lisp_Object); | |
383e0970 | 811 | extern void font_fill_lglyph_metrics (Lisp_Object, Lisp_Object); |
c2f5bfd6 | 812 | |
383e0970 J |
813 | extern Lisp_Object font_put_extra (Lisp_Object font, Lisp_Object prop, |
814 | Lisp_Object val); | |
c2f5bfd6 | 815 | |
383e0970 J |
816 | extern int font_put_frame_data (FRAME_PTR f, |
817 | struct font_driver *driver, | |
818 | void *data); | |
819 | extern void *font_get_frame_data (FRAME_PTR f, | |
820 | struct font_driver *driver); | |
5a74d0e5 | 821 | |
c2f5bfd6 KH |
822 | #ifdef HAVE_FREETYPE |
823 | extern struct font_driver ftfont_driver; | |
824 | #endif /* HAVE_FREETYPE */ | |
825 | #ifdef HAVE_X_WINDOWS | |
826 | extern struct font_driver xfont_driver; | |
827 | extern struct font_driver ftxfont_driver; | |
828 | #ifdef HAVE_XFT | |
829 | extern struct font_driver xftfont_driver; | |
830 | #endif /* HAVE_XFT */ | |
831 | #endif /* HAVE_X_WINDOWS */ | |
832 | #ifdef WINDOWSNT | |
833 | extern struct font_driver w32font_driver; | |
97724679 | 834 | extern struct font_driver uniscribe_font_driver; |
c2f5bfd6 | 835 | #endif /* WINDOWSNT */ |
edfda783 AR |
836 | #ifdef HAVE_NS |
837 | extern struct font_driver nsfont_driver; | |
838 | #endif /* HAVE_NS */ | |
c2f5bfd6 | 839 | |
f6a651cb KH |
840 | #ifndef FONT_DEBUG |
841 | #define FONT_DEBUG | |
842 | #endif | |
843 | ||
59314caf | 844 | extern Lisp_Object Vfont_log; |
383e0970 J |
845 | extern void font_add_log (char *, Lisp_Object, Lisp_Object); |
846 | extern void font_deferred_log (char *, Lisp_Object, Lisp_Object); | |
f6a651cb | 847 | |
59314caf KH |
848 | #define FONT_ADD_LOG(ACTION, ARG, RESULT) \ |
849 | do { \ | |
850 | if (! EQ (Vfont_log, Qt)) \ | |
851 | font_add_log ((ACTION), (ARG), (RESULT)); \ | |
852 | } while (0) | |
853 | ||
854 | #define FONT_DEFERRED_LOG(ACTION, ARG, RESULT) \ | |
855 | do { \ | |
856 | if (! EQ (Vfont_log, Qt)) \ | |
857 | font_deferred_log ((ACTION), (ARG), (RESULT)); \ | |
858 | } while (0) | |
859 | ||
f6a651cb KH |
860 | #ifdef FONT_DEBUG |
861 | #define font_assert(X) do {if (!(X)) abort ();} while (0) | |
862 | #else /* not FONT_DEBUG */ | |
863 | #define font_assert(X) (void) 0 | |
864 | #endif /* not FONT_DEBUG */ | |
865 | ||
c2f5bfd6 | 866 | #endif /* not EMACS_FONT_H */ |
885b7d09 MB |
867 | |
868 | /* arch-tag: 3b7260c3-5bec-4d6b-a0db-95c1b431b1a2 | |
869 | (do not change this comment) */ |