|
428
|
1 /* Face data structures.
|
|
|
2 Copyright (C) 1995 Board of Trustees, University of Illinois.
|
|
771
|
3 Copyright (C) 1995, 2002 Ben Wing
|
|
428
|
4
|
|
|
5 This file is part of XEmacs.
|
|
|
6
|
|
|
7 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
8 under the terms of the GNU General Public License as published by the
|
|
|
9 Free Software Foundation; either version 2, or (at your option) any
|
|
|
10 later version.
|
|
|
11
|
|
|
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
15 for more details.
|
|
|
16
|
|
|
17 You should have received a copy of the GNU General Public License
|
|
|
18 along with XEmacs; see the file COPYING. If not, write to
|
|
|
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
20 Boston, MA 02111-1307, USA. */
|
|
|
21
|
|
|
22 /* Synched up with: Not in FSF. */
|
|
|
23
|
|
440
|
24 #ifndef INCLUDED_faces_h_
|
|
|
25 #define INCLUDED_faces_h_
|
|
428
|
26
|
|
771
|
27 #include "charset.h" /* for NUM_LEADING_BYTES */
|
|
428
|
28
|
|
440
|
29 /* a Lisp_Face is the C object corresponding to a face. There is one
|
|
|
30 of these per face. It basically contains all of the specifiers for
|
|
|
31 the built-in face properties, plus the plist of user-specified
|
|
428
|
32 properties. */
|
|
|
33
|
|
|
34 struct Lisp_Face
|
|
|
35 {
|
|
3017
|
36 struct LCRECORD_HEADER header;
|
|
428
|
37
|
|
|
38 Lisp_Object name;
|
|
|
39 Lisp_Object doc_string;
|
|
|
40 unsigned int dirty :1; /* Set whenever a face property is changed on
|
|
|
41 a face. */
|
|
|
42
|
|
|
43 Lisp_Object foreground;
|
|
|
44 Lisp_Object background;
|
|
|
45 Lisp_Object font;
|
|
|
46
|
|
|
47 Lisp_Object display_table;
|
|
|
48 Lisp_Object background_pixmap;
|
|
|
49
|
|
|
50 Lisp_Object underline;
|
|
|
51 Lisp_Object strikethru;
|
|
|
52 Lisp_Object highlight;
|
|
|
53 Lisp_Object dim;
|
|
|
54 Lisp_Object blinking;
|
|
|
55 Lisp_Object reverse;
|
|
|
56
|
|
|
57 Lisp_Object plist;
|
|
|
58
|
|
|
59 Lisp_Object charsets_warned_about;
|
|
|
60 };
|
|
|
61
|
|
|
62 /*
|
|
|
63
|
|
|
64 A face cache element caches the results of instantiating the
|
|
|
65 properties of a face in a particular window. (Instantiation can
|
|
|
66 take a long time so this is very important.) Each window contains
|
|
|
67 an array of face cache elements (called the "face cache"), one for
|
|
|
68 each face that has been seen in the window so far.
|
|
|
69
|
|
|
70 Some tricky stuff is done to make sure the face cache does not
|
|
|
71 become inconsistent:
|
|
|
72
|
|
|
73 1) Switching buffers in a window clears the face cache for that
|
|
|
74 window, because this can change the way any property is
|
|
|
75 instantiated in the window.
|
|
|
76 2) Setting a face property causes that face to be marked as
|
|
|
77 dirty. This causes various stuff to happen to make sure
|
|
|
78 the appropriate face cache elements are invalidated.
|
|
|
79 (#### Actually this doesn't work quite right, and errs
|
|
|
80 too much on the side of invalidating unnecessary stuff.)
|
|
|
81
|
|
|
82 There are also face cache elements for "merged faces", which are the
|
|
|
83 result of merging all the faces that overlap a particular buffer
|
|
|
84 position. The merging is always done in the context of a particular
|
|
|
85 domain (specifically, a window), and the face cache element is
|
|
|
86 specific to a particular window. (Face cache elements are contained
|
|
|
87 in an array that is attached to each struct_window.) The reason that
|
|
|
88 the merging takes place in the context of a particular window has
|
|
|
89 to do with the way the merging works:
|
|
|
90
|
|
|
91 1) All extents overlying the buffer position are sorted by descending
|
|
|
92 priority.
|
|
|
93 2) The property of a particular merged face comes from the highest-
|
|
|
94 priority face that specifies a value for that particular property.
|
|
|
95 3) The way to determine whether a face specifies a value for a
|
|
|
96 particular property is to instantiate that face's property in
|
|
|
97 the window in question with the no-fallback option set, to
|
|
|
98 see if we got anything.
|
|
|
99
|
|
|
100 For Mule, things get a bit trickier because there can be multiple
|
|
|
101 fonts per face/window combination -- the charset is an argument
|
|
|
102 to specifier-instance.
|
|
|
103
|
|
|
104 We have two possible data structure representations:
|
|
|
105
|
|
|
106 1) Keep the original "one font per face cache element" representation
|
|
|
107 and use a different face cache element for each charset.
|
|
|
108 2) Allow multiple fonts to be in a single face cache element.
|
|
|
109
|
|
|
110 I've chosen to use (2) -- the data structure gets more complicated
|
|
|
111 but the algorithms for maintaining face cache elements end up
|
|
|
112 simpler.
|
|
|
113 */
|
|
|
114
|
|
|
115 #define NUM_STATIC_CACHEL_FACES 4
|
|
|
116
|
|
|
117 typedef struct face_cachel face_cachel;
|
|
|
118 struct face_cachel
|
|
|
119 {
|
|
3092
|
120 #ifdef NEW_GC
|
|
|
121 struct lrecord_header header;
|
|
|
122 #endif /* not NEW_GC */
|
|
428
|
123 /* There are two kinds of cachels; those created from a single face
|
|
|
124 and those created by merging more than one face. In the former
|
|
|
125 case, the FACE element specifies the face used. In the latter
|
|
|
126 case, the MERGED_FACES_STATIC and MERGED_FACES elements specify
|
|
|
127 the faces used for merging by giving the indices of the
|
|
|
128 corresponding single-face cachels.
|
|
|
129
|
|
|
130 Formerly we didn't bother to keep track of the faces used for
|
|
442
|
131 merging. We do now because we need to do so because there is no
|
|
428
|
132 other way to properly handle multiple charsets for Mule in the
|
|
|
133 presence of display tables short of always computing the values
|
|
|
134 for all charsets, which is very expensive. Instead, we use a
|
|
|
135 lazy scheme where we only compute the font for a particular charset
|
|
|
136 when it is needed. (The exception is the font for the ASCII charset.
|
|
|
137 We always compute it, just like the other attributes, because
|
|
|
138 many places in the C code refer to the font of the ASCII charset
|
|
|
139 and expect it to always be there.)
|
|
|
140
|
|
|
141 We store the first four faces in a static array, and use a
|
|
|
142 Dynarr for the rest. This has the advantage that the space used
|
|
|
143 is small but the Dynarr will almost never be created, so we
|
|
|
144 won't spend much time in malloc()/free().
|
|
|
145
|
|
|
146 The order of the faces here is decreasing extent priority. */
|
|
|
147 Lisp_Object face;
|
|
|
148 int merged_faces_static[NUM_STATIC_CACHEL_FACES];
|
|
|
149 int_dynarr *merged_faces;
|
|
|
150 int nfaces;
|
|
|
151
|
|
|
152 /* The values stored here are computed by calling specifier_instance()
|
|
|
153 on the appropriate specifiers. This means that we will have either
|
|
|
154 a value computed from the face itself or a value computed from the
|
|
|
155 default face. We need to distinguish the two so that merging works
|
|
|
156 properly -- a value that comes from the default face is treated
|
|
|
157 as "unspecified" during merging and is overridden by lower-priority
|
|
|
158 faces. This is what the _specified flags below are for. */
|
|
|
159
|
|
|
160 Lisp_Object foreground;
|
|
|
161 Lisp_Object background;
|
|
771
|
162 /* There are currently 128 or 129 possible charsets under Mule. For the
|
|
428
|
163 moment we just take the easy way out and allocate space for each
|
|
|
164 of them. This avoids messing with Dynarrs.
|
|
|
165
|
|
|
166 #### We should look into this and probably clean it up
|
|
3094
|
167 to use Dynarrs. This may be a big space hog as is.
|
|
|
168 sjt sez: doesn't look like it, my total face cache is 170KB.
|
|
|
169 Could be reduced to maybe 50KB. */
|
|
428
|
170 Lisp_Object font[NUM_LEADING_BYTES];
|
|
|
171
|
|
|
172 Lisp_Object display_table;
|
|
|
173 Lisp_Object background_pixmap;
|
|
|
174
|
|
|
175 unsigned int underline :1;
|
|
|
176 unsigned int strikethru :1;
|
|
|
177 unsigned int highlight :1;
|
|
|
178 unsigned int dim :1;
|
|
|
179 unsigned int blinking :1;
|
|
|
180 unsigned int reverse :1;
|
|
|
181
|
|
|
182 /* Used when merging to tell if the above field represents an actual
|
|
|
183 value of this face or a fallback value. */
|
|
|
184 /* #### Of course we should use a bit array or something. */
|
|
|
185 unsigned char font_specified[NUM_LEADING_BYTES];
|
|
|
186 unsigned int foreground_specified :1;
|
|
|
187 unsigned int background_specified :1;
|
|
|
188 unsigned int display_table_specified :1;
|
|
|
189 unsigned int background_pixmap_specified :1;
|
|
|
190
|
|
|
191 unsigned int strikethru_specified :1;
|
|
|
192 unsigned int underline_specified :1;
|
|
|
193 unsigned int highlight_specified :1;
|
|
|
194 unsigned int dim_specified :1;
|
|
|
195 unsigned int blinking_specified :1;
|
|
|
196 unsigned int reverse_specified :1;
|
|
|
197
|
|
|
198 /* The updated flag is set after we calculate the values for the
|
|
|
199 face cachel and cleared whenever a face changes, to indicate
|
|
|
200 that the values stored here might be wrong. The next time
|
|
|
201 we go to access the values, we recompute them; if any values
|
|
|
202 change, we set the DIRTY flag, which tells the output routines
|
|
|
203 that a face value has in fact changed and the sections of text
|
|
|
204 using this face need to be redrawn.
|
|
|
205
|
|
|
206 It is trickier with fonts because we don't automatically
|
|
|
207 recompute the fonts but do it only when it is necessary.
|
|
|
208 (The ASCII font is an exception, of course; see above).
|
|
|
209
|
|
|
210 In the case of fonts, we maintain a separate updated flag
|
|
|
211 for each font. Whenever we need to access the font for
|
|
|
212 a particular charset, we recalculate it if either its
|
|
|
213 value is Qunbound (meaning it's never been computed at all)
|
|
|
214 or the updated flag is not set. We set the dirty flag if
|
|
|
215 the value is not the same as before and the previous value
|
|
|
216 was not Qunbound.
|
|
|
217
|
|
|
218 #### Note that we don't yet deal with the case of the new
|
|
|
219 value being Qunbound, as could happen if no fonts of the
|
|
|
220 right sort are available on the system. In this case, the
|
|
|
221 whole program will just crash. For the moment, this is
|
|
|
222 OK (for debugging purposes) but we should fix this by
|
|
|
223 storing a "blank font" if the instantiation fails. */
|
|
|
224 unsigned int dirty :1;
|
|
|
225 unsigned int updated :1;
|
|
|
226 /* #### Of course we should use a bit array or something. */
|
|
|
227 unsigned char font_updated[NUM_LEADING_BYTES];
|
|
|
228 };
|
|
|
229
|
|
3092
|
230 #ifdef NEW_GC
|
|
|
231 typedef struct face_cachel Lisp_Face_Cachel;
|
|
|
232
|
|
|
233 DECLARE_LRECORD (face_cachel, Lisp_Face_Cachel);
|
|
|
234
|
|
|
235 #define XFACE_CACHEL(x) \
|
|
|
236 XRECORD (x, face_cachel, Lisp_Face_Cachel)
|
|
|
237 #define wrap_face_cachel(p) wrap_record (p, face_cachel)
|
|
|
238 #define FACE_CACHEL_P(x) RECORDP (x, face_cachel)
|
|
|
239 #define CHECK_FACE_CACHEL(x) CHECK_RECORD (x, face_cachel)
|
|
|
240 #define CONCHECK_FACE_CACHEL(x) CONCHECK_RECORD (x, face_cachel)
|
|
|
241 #endif /* NEW_GC */
|
|
|
242
|
|
440
|
243 DECLARE_LRECORD (face, Lisp_Face);
|
|
|
244 #define XFACE(x) XRECORD (x, face, Lisp_Face)
|
|
617
|
245 #define wrap_face(p) wrap_record (p, face)
|
|
428
|
246 #define FACEP(x) RECORDP (x, face)
|
|
|
247 #define CHECK_FACE(x) CHECK_RECORD (x, face)
|
|
|
248
|
|
|
249 Lisp_Object ensure_face_cachel_contains_charset (struct face_cachel *cachel,
|
|
|
250 Lisp_Object domain,
|
|
|
251 Lisp_Object charset);
|
|
|
252 void ensure_face_cachel_complete (struct face_cachel *cachel,
|
|
|
253 Lisp_Object domain,
|
|
|
254 unsigned char *charsets);
|
|
|
255 void update_face_cachel_data (struct face_cachel *cachel,
|
|
|
256 Lisp_Object domain,
|
|
|
257 Lisp_Object face);
|
|
|
258 void face_cachel_charset_font_metric_info (struct face_cachel *cachel,
|
|
|
259 unsigned char *charsets,
|
|
|
260 struct font_metric_info *fm);
|
|
|
261 void mark_face_cachels (face_cachel_dynarr *elements);
|
|
|
262 void mark_face_cachels_as_clean (struct window *w);
|
|
|
263 void mark_face_cachels_as_not_updated (struct window *w);
|
|
|
264 void reset_face_cachel (struct face_cachel *inst);
|
|
|
265 void reset_face_cachels (struct window *w);
|
|
|
266 face_index get_builtin_face_cache_index (struct window *w,
|
|
|
267 Lisp_Object face);
|
|
3094
|
268 /* WARNING: this interface may change. */
|
|
|
269 face_index merge_face_list_to_cache_index (struct window *w,
|
|
|
270 Lisp_Object *face_list, int count);
|
|
|
271
|
|
428
|
272 #ifdef MEMORY_USAGE_STATS
|
|
|
273 int compute_face_cachel_usage (face_cachel_dynarr *face_cachels,
|
|
|
274 struct overhead_stats *ovstats);
|
|
|
275 #endif /* MEMORY_USAGE_STATS */
|
|
|
276
|
|
|
277 EXFUN (Fface_name, 1);
|
|
|
278 EXFUN (Ffind_face, 1);
|
|
|
279 EXFUN (Fget_face, 1);
|
|
|
280
|
|
|
281 extern Lisp_Object Qstrikethru, Vbuilt_in_face_specifiers, Vdefault_face;
|
|
|
282 extern Lisp_Object Vleft_margin_face, Vpointer_face, Vright_margin_face;
|
|
432
|
283 extern Lisp_Object Vtext_cursor_face, Vvertical_divider_face;
|
|
428
|
284 extern Lisp_Object Vtoolbar_face, Vgui_element_face, Vwidget_face;
|
|
|
285
|
|
|
286 void mark_all_faces_as_clean (void);
|
|
|
287 void init_frame_faces (struct frame *f);
|
|
|
288 void init_device_faces (struct device *d);
|
|
|
289 void init_global_faces (struct device *d);
|
|
|
290 face_index get_extent_fragment_face_cache_index (struct window *w,
|
|
|
291 struct extent_fragment *ef);
|
|
|
292 void update_frame_face_values (struct frame *f);
|
|
|
293 void face_property_was_changed (Lisp_Object face, Lisp_Object property,
|
|
|
294 Lisp_Object locale);
|
|
|
295 void default_face_font_info (Lisp_Object domain, int *ascent,
|
|
|
296 int *descent, int *height, int *width,
|
|
|
297 int *proportional_p);
|
|
|
298 void default_face_height_and_width (Lisp_Object domain,
|
|
|
299 int *height, int *width);
|
|
|
300 void default_face_height_and_width_1 (Lisp_Object domain,
|
|
|
301 int *height, int *width);
|
|
|
302
|
|
|
303 #define FACE_CACHEL_FONT(cachel, charset) \
|
|
771
|
304 (cachel->font[XCHARSET_LEADING_BYTE (charset) - MIN_LEADING_BYTE])
|
|
428
|
305
|
|
|
306 #define WINDOW_FACE_CACHEL(window, index) \
|
|
|
307 Dynarr_atp ((window)->face_cachels, index)
|
|
|
308
|
|
|
309 #define FACE_CACHEL_FINDEX_UNSAFE(cachel, offset) \
|
|
|
310 ((offset) < NUM_STATIC_CACHEL_FACES \
|
|
|
311 ? (cachel)->merged_faces_static[offset] \
|
|
|
312 : Dynarr_at ((cachel)->merged_faces, (offset) - NUM_STATIC_CACHEL_FACES))
|
|
|
313
|
|
|
314 #define WINDOW_FACE_CACHEL_FACE(window, index) \
|
|
|
315 (WINDOW_FACE_CACHEL (window, index)->face)
|
|
|
316 #define WINDOW_FACE_CACHEL_FOREGROUND(window, index) \
|
|
|
317 (WINDOW_FACE_CACHEL (window, index)->foreground)
|
|
|
318 #define WINDOW_FACE_CACHEL_BACKGROUND(window, index) \
|
|
|
319 (WINDOW_FACE_CACHEL (window, index)->background)
|
|
|
320 /* #### This can be referenced by various functions,
|
|
|
321 but face_cachels isn't initialized for the stream device.
|
|
|
322 Since it doesn't need the value we just return nil here to avoid
|
|
|
323 blowing up in multiple places. */
|
|
|
324 #define WINDOW_FACE_CACHEL_FONT(window, index, charset) \
|
|
|
325 ((window)->face_cachels \
|
|
|
326 ? FACE_CACHEL_FONT (WINDOW_FACE_CACHEL (window, index), charset) \
|
|
|
327 : Qnil)
|
|
|
328 #define WINDOW_FACE_CACHEL_DISPLAY_TABLE(window, index) \
|
|
|
329 (WINDOW_FACE_CACHEL (window, index)->display_table)
|
|
|
330 #define WINDOW_FACE_CACHEL_BACKGROUND_PIXMAP(window, index) \
|
|
|
331 (WINDOW_FACE_CACHEL (window, index)->background_pixmap)
|
|
|
332 #define WINDOW_FACE_CACHEL_DIRTY(window, index) \
|
|
|
333 (WINDOW_FACE_CACHEL (window, index)->dirty)
|
|
|
334 #define WINDOW_FACE_CACHEL_UNDERLINE_P(window, index) \
|
|
|
335 (WINDOW_FACE_CACHEL (window, index)->underline)
|
|
|
336 #define WINDOW_FACE_CACHEL_HIGHLIGHT_P(window, index) \
|
|
|
337 (WINDOW_FACE_CACHEL (window, index)->highlight)
|
|
|
338 #define WINDOW_FACE_CACHEL_DIM_P(window, index) \
|
|
|
339 (WINDOW_FACE_CACHEL (window, index)->dim)
|
|
|
340 #define WINDOW_FACE_CACHEL_BLINKING_P(window, index) \
|
|
|
341 (WINDOW_FACE_CACHEL (window, index)->blinking)
|
|
|
342 #define WINDOW_FACE_CACHEL_REVERSE_P(window, index) \
|
|
|
343 (WINDOW_FACE_CACHEL (window, index)->reverse)
|
|
|
344
|
|
|
345 #define FACE_PROPERTY_SPECIFIER(face, property) Fget (face, property, Qnil)
|
|
|
346
|
|
|
347 #define FACE_PROPERTY_INSTANCE_1(face, property, domain, errb, no_fallback, depth) \
|
|
|
348 specifier_instance (FACE_PROPERTY_SPECIFIER (face, property), Qunbound, \
|
|
|
349 domain, errb, 1, no_fallback, depth)
|
|
|
350
|
|
|
351 #define FACE_PROPERTY_INSTANCE(face, property, domain, no_fallback, depth) \
|
|
793
|
352 FACE_PROPERTY_INSTANCE_1 (face, property, domain, ERROR_ME_DEBUG_WARN, \
|
|
428
|
353 no_fallback, depth)
|
|
|
354
|
|
|
355 Lisp_Object face_property_matching_instance (Lisp_Object face,
|
|
|
356 Lisp_Object property,
|
|
|
357 Lisp_Object charset,
|
|
|
358 Lisp_Object domain,
|
|
578
|
359 Error_Behavior errb,
|
|
428
|
360 int no_fallback,
|
|
|
361 Lisp_Object depth);
|
|
|
362
|
|
|
363 #define FACE_PROPERTY_SPEC_LIST(face, property, locale) \
|
|
|
364 Fspecifier_spec_list (FACE_PROPERTY_SPECIFIER (face, property), \
|
|
|
365 locale, Qnil, Qnil)
|
|
498
|
366 #define SET_FACE_PROPERTY(face, property, value, locale, tag, how_to_add) \
|
|
428
|
367 Fadd_spec_to_specifier (FACE_PROPERTY_SPECIFIER (face, property), \
|
|
498
|
368 value, locale, tag, how_to_add)
|
|
428
|
369
|
|
|
370 #define FACE_FOREGROUND(face, domain) \
|
|
|
371 FACE_PROPERTY_INSTANCE (face, Qforeground, domain, 0, Qzero)
|
|
|
372 #define FACE_BACKGROUND(face, domain) \
|
|
|
373 FACE_PROPERTY_INSTANCE (face, Qbackground, domain, 0, Qzero)
|
|
|
374 #define FACE_FONT(face, domain, charset) \
|
|
|
375 face_property_matching_instance (face, Qfont, charset, domain, \
|
|
793
|
376 ERROR_ME_DEBUG_WARN, 0, Qzero)
|
|
428
|
377 #define FACE_DISPLAY_TABLE(face, domain) \
|
|
|
378 FACE_PROPERTY_INSTANCE (face, Qdisplay_table, domain, 0, Qzero)
|
|
|
379 #define FACE_BACKGROUND_PIXMAP(face, domain) \
|
|
|
380 FACE_PROPERTY_INSTANCE (face, Qbackground_pixmap, domain, 0, Qzero)
|
|
|
381 #define FACE_UNDERLINE_P(face, domain) \
|
|
|
382 (!NILP (FACE_PROPERTY_INSTANCE (face, Qunderline, domain, 0, Qzero)))
|
|
440
|
383 #define FACE_STRIKETHRU_P(face, domain) \
|
|
|
384 (!NILP (FACE_PROPERTY_INSTANCE (face, Qstrikethru, domain, 0, Qzero)))
|
|
428
|
385 #define FACE_HIGHLIGHT_P(face, domain) \
|
|
|
386 (!NILP (FACE_PROPERTY_INSTANCE (face, Qhighlight, domain, 0, Qzero)))
|
|
|
387 #define FACE_DIM_P(face, domain) \
|
|
|
388 (!NILP (FACE_PROPERTY_INSTANCE (face, Qdim, domain, 0, Qzero)))
|
|
|
389 #define FACE_BLINKING_P(face, domain) \
|
|
|
390 (!NILP (FACE_PROPERTY_INSTANCE (face, Qblinking, domain, 0, Qzero)))
|
|
|
391 #define FACE_REVERSE_P(face, domain) \
|
|
|
392 (!NILP (FACE_PROPERTY_INSTANCE (face, Qreverse, domain, 0, Qzero)))
|
|
|
393
|
|
440
|
394 #endif /* INCLUDED_faces_h_ */
|
