Use AUTO_CONS instead of SCOPED_CONS, etc.
[emacs.git] / src / xfaces.c
blob73704bbba8eb1f0b2aa4606842b48204e2e0a97e
1 /* xfaces.c -- "Face" primitives.
3 Copyright (C) 1993-1994, 1998-2014 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New face implementation by Gerd Moellmann <gerd@gnu.org>. */
22 /* Faces.
24 When using Emacs with X, the display style of characters can be
25 changed by defining `faces'. Each face can specify the following
26 display attributes:
28 1. Font family name.
30 2. Font foundry name.
32 3. Relative proportionate width, aka character set width or set
33 width (swidth), e.g. `semi-compressed'.
35 4. Font height in 1/10pt.
37 5. Font weight, e.g. `bold'.
39 6. Font slant, e.g. `italic'.
41 7. Foreground color.
43 8. Background color.
45 9. Whether or not characters should be underlined, and in what color.
47 10. Whether or not characters should be displayed in inverse video.
49 11. A background stipple, a bitmap.
51 12. Whether or not characters should be overlined, and in what color.
53 13. Whether or not characters should be strike-through, and in what
54 color.
56 14. Whether or not a box should be drawn around characters, the box
57 type, and, for simple boxes, in what color.
59 15. Font-spec, or nil. This is a special attribute.
61 A font-spec is a collection of font attributes (specs).
63 When this attribute is specified, the face uses a font matching
64 with the specs as is except for what overwritten by the specs in
65 the fontset (see below). In addition, the other font-related
66 attributes (1st thru 5th) are updated from the spec.
68 On the other hand, if one of the other font-related attributes are
69 specified, the corresponding specs in this attribute is set to nil.
71 15. A face name or list of face names from which to inherit attributes.
73 16. A specified average font width, which is invisible from Lisp,
74 and is used to ensure that a font specified on the command line,
75 for example, can be matched exactly.
77 17. A fontset name. This is another special attribute.
79 A fontset is a mappings from characters to font-specs, and the
80 specs overwrite the font-spec in the 14th attribute.
83 Faces are frame-local by nature because Emacs allows to define the
84 same named face (face names are symbols) differently for different
85 frames. Each frame has an alist of face definitions for all named
86 faces. The value of a named face in such an alist is a Lisp vector
87 with the symbol `face' in slot 0, and a slot for each of the face
88 attributes mentioned above.
90 There is also a global face alist `Vface_new_frame_defaults'. Face
91 definitions from this list are used to initialize faces of newly
92 created frames.
94 A face doesn't have to specify all attributes. Those not specified
95 have a value of `unspecified'. Faces specifying all attributes but
96 the 14th are called `fully-specified'.
99 Face merging.
101 The display style of a given character in the text is determined by
102 combining several faces. This process is called `face merging'.
103 Any aspect of the display style that isn't specified by overlays or
104 text properties is taken from the `default' face. Since it is made
105 sure that the default face is always fully-specified, face merging
106 always results in a fully-specified face.
109 Face realization.
111 After all face attributes for a character have been determined by
112 merging faces of that character, that face is `realized'. The
113 realization process maps face attributes to what is physically
114 available on the system where Emacs runs. The result is a
115 `realized face' in the form of a struct face which is stored in the
116 face cache of the frame on which it was realized.
118 Face realization is done in the context of the character to display
119 because different fonts may be used for different characters. In
120 other words, for characters that have different font
121 specifications, different realized faces are needed to display
122 them.
124 Font specification is done by fontsets. See the comment in
125 fontset.c for the details. In the current implementation, all ASCII
126 characters share the same font in a fontset.
128 Faces are at first realized for ASCII characters, and, at that
129 time, assigned a specific realized fontset. Hereafter, we call
130 such a face as `ASCII face'. When a face for a multibyte character
131 is realized, it inherits (thus shares) a fontset of an ASCII face
132 that has the same attributes other than font-related ones.
134 Thus, all realized faces have a realized fontset.
137 Unibyte text.
139 Unibyte text (i.e. raw 8-bit characters) is displayed with the same
140 font as ASCII characters. That is because it is expected that
141 unibyte text users specify a font that is suitable both for ASCII
142 and raw 8-bit characters.
145 Font selection.
147 Font selection tries to find the best available matching font for a
148 given (character, face) combination.
150 If the face specifies a fontset name, that fontset determines a
151 pattern for fonts of the given character. If the face specifies a
152 font name or the other font-related attributes, a fontset is
153 realized from the default fontset. In that case, that
154 specification determines a pattern for ASCII characters and the
155 default fontset determines a pattern for multibyte characters.
157 Available fonts on the system on which Emacs runs are then matched
158 against the font pattern. The result of font selection is the best
159 match for the given face attributes in this font list.
161 Font selection can be influenced by the user.
163 1. The user can specify the relative importance he gives the face
164 attributes width, height, weight, and slant by setting
165 face-font-selection-order (faces.el) to a list of face attribute
166 names. The default is '(:width :height :weight :slant), and means
167 that font selection first tries to find a good match for the font
168 width specified by a face, then---within fonts with that
169 width---tries to find a best match for the specified font height,
170 etc.
172 2. Setting face-font-family-alternatives allows the user to
173 specify alternative font families to try if a family specified by a
174 face doesn't exist.
176 3. Setting face-font-registry-alternatives allows the user to
177 specify all alternative font registries to try for a face
178 specifying a registry.
180 4. Setting face-ignored-fonts allows the user to ignore specific
181 fonts.
184 Character composition.
186 Usually, the realization process is already finished when Emacs
187 actually reflects the desired glyph matrix on the screen. However,
188 on displaying a composition (sequence of characters to be composed
189 on the screen), a suitable font for the components of the
190 composition is selected and realized while drawing them on the
191 screen, i.e. the realization process is delayed but in principle
192 the same.
195 Initialization of basic faces.
197 The faces `default', `modeline' are considered `basic faces'.
198 When redisplay happens the first time for a newly created frame,
199 basic faces are realized for CHARSET_ASCII. Frame parameters are
200 used to fill in unspecified attributes of the default face. */
202 #include <config.h>
203 #include "sysstdio.h"
204 #include <sys/types.h>
205 #include <sys/stat.h>
207 #include "lisp.h"
208 #include "character.h"
209 #include "charset.h"
210 #include "keyboard.h"
211 #include "frame.h"
212 #include "termhooks.h"
214 #ifdef USE_MOTIF
215 #include <Xm/Xm.h>
216 #include <Xm/XmStrDefs.h>
217 #endif /* USE_MOTIF */
219 #ifdef MSDOS
220 #include "dosfns.h"
221 #endif
223 #ifdef HAVE_WINDOW_SYSTEM
224 #include TERM_HEADER
225 #include "fontset.h"
226 #ifdef HAVE_NTGUI
227 #define x_display_info w32_display_info
228 #define GCGraphicsExposures 0
229 #endif /* HAVE_NTGUI */
231 #ifdef HAVE_NS
232 #define GCGraphicsExposures 0
233 #endif /* HAVE_NS */
234 #endif /* HAVE_WINDOW_SYSTEM */
236 #include "buffer.h"
237 #include "dispextern.h"
238 #include "blockinput.h"
239 #include "window.h"
240 #include "intervals.h"
241 #include "termchar.h"
243 #include "font.h"
245 #ifdef HAVE_X_WINDOWS
247 /* Compensate for a bug in Xos.h on some systems, on which it requires
248 time.h. On some such systems, Xos.h tries to redefine struct
249 timeval and struct timezone if USG is #defined while it is
250 #included. */
252 #ifdef XOS_NEEDS_TIME_H
253 #include <time.h>
254 #undef USG
255 #include <X11/Xos.h>
256 #define USG
257 #define __TIMEVAL__
258 #if defined USG || defined __TIMEVAL__ /* Don't warn about unused macros. */
259 #endif
260 #else /* not XOS_NEEDS_TIME_H */
261 #include <X11/Xos.h>
262 #endif /* not XOS_NEEDS_TIME_H */
264 #endif /* HAVE_X_WINDOWS */
266 #include <c-ctype.h>
268 /* Non-zero if face attribute ATTR is unspecified. */
270 #define UNSPECIFIEDP(ATTR) EQ ((ATTR), Qunspecified)
272 /* Non-zero if face attribute ATTR is `ignore-defface'. */
274 #define IGNORE_DEFFACE_P(ATTR) EQ ((ATTR), QCignore_defface)
276 /* Size of hash table of realized faces in face caches (should be a
277 prime number). */
279 #define FACE_CACHE_BUCKETS_SIZE 1001
281 /* Keyword symbols used for face attribute names. */
283 Lisp_Object QCfamily, QCheight, QCweight, QCslant;
284 static Lisp_Object QCunderline;
285 static Lisp_Object QCinverse_video, QCstipple;
286 Lisp_Object QCforeground, QCbackground;
287 Lisp_Object QCwidth;
288 static Lisp_Object QCfont, QCbold, QCitalic;
289 static Lisp_Object QCreverse_video;
290 static Lisp_Object QCoverline, QCstrike_through, QCbox, QCinherit;
291 static Lisp_Object QCfontset, QCdistant_foreground;
293 /* Symbols used for attribute values. */
295 Lisp_Object Qnormal;
296 Lisp_Object Qbold;
297 static Lisp_Object Qline, Qwave;
298 Lisp_Object Qextra_light, Qlight;
299 Lisp_Object Qsemi_light, Qsemi_bold, Qextra_bold, Qultra_bold;
300 Lisp_Object Qoblique;
301 Lisp_Object Qitalic;
302 static Lisp_Object Qreleased_button, Qpressed_button;
303 static Lisp_Object QCstyle, QCcolor, QCline_width;
304 Lisp_Object Qunspecified; /* used in dosfns.c */
305 static Lisp_Object QCignore_defface;
307 char unspecified_fg[] = "unspecified-fg", unspecified_bg[] = "unspecified-bg";
309 /* The name of the function to call when the background of the frame
310 has changed, frame_set_background_mode. */
312 static Lisp_Object Qframe_set_background_mode;
314 /* Names of basic faces. */
316 Lisp_Object Qdefault, Qtool_bar, Qfringe;
317 static Lisp_Object Qregion;
318 Lisp_Object Qheader_line, Qscroll_bar, Qcursor;
319 static Lisp_Object Qborder, Qmouse, Qmenu;
320 Lisp_Object Qmode_line_inactive;
321 static Lisp_Object Qvertical_border;
322 static Lisp_Object Qwindow_divider;
323 static Lisp_Object Qwindow_divider_first_pixel;
324 static Lisp_Object Qwindow_divider_last_pixel;
326 /* The symbol `face-alias'. A symbols having that property is an
327 alias for another face. Value of the property is the name of
328 the aliased face. */
330 static Lisp_Object Qface_alias;
332 /* Alist of alternative font families. Each element is of the form
333 (FAMILY FAMILY1 FAMILY2 ...). If fonts of FAMILY can't be loaded,
334 try FAMILY1, then FAMILY2, ... */
336 Lisp_Object Vface_alternative_font_family_alist;
338 /* Alist of alternative font registries. Each element is of the form
339 (REGISTRY REGISTRY1 REGISTRY2...). If fonts of REGISTRY can't be
340 loaded, try REGISTRY1, then REGISTRY2, ... */
342 Lisp_Object Vface_alternative_font_registry_alist;
344 /* Allowed scalable fonts. A value of nil means don't allow any
345 scalable fonts. A value of t means allow the use of any scalable
346 font. Otherwise, value must be a list of regular expressions. A
347 font may be scaled if its name matches a regular expression in the
348 list. */
350 static Lisp_Object Qscalable_fonts_allowed;
352 /* The symbols `foreground-color' and `background-color' which can be
353 used as part of a `face' property. This is for compatibility with
354 Emacs 20.2. */
356 Lisp_Object Qforeground_color, Qbackground_color;
358 /* The symbols `face' and `mouse-face' used as text properties. */
360 Lisp_Object Qface;
362 /* Property for basic faces which other faces cannot inherit. */
364 static Lisp_Object Qface_no_inherit;
366 /* Error symbol for wrong_type_argument in load_pixmap. */
368 static Lisp_Object Qbitmap_spec_p;
370 /* The next ID to assign to Lisp faces. */
372 static int next_lface_id;
374 /* A vector mapping Lisp face Id's to face names. */
376 static Lisp_Object *lface_id_to_name;
377 static ptrdiff_t lface_id_to_name_size;
379 /* TTY color-related functions (defined in tty-colors.el). */
381 static Lisp_Object Qtty_color_desc, Qtty_color_by_index, Qtty_color_standard_values;
383 /* The name of the function used to compute colors on TTYs. */
385 static Lisp_Object Qtty_color_alist;
387 #ifdef HAVE_WINDOW_SYSTEM
389 /* Counter for calls to clear_face_cache. If this counter reaches
390 CLEAR_FONT_TABLE_COUNT, and a frame has more than
391 CLEAR_FONT_TABLE_NFONTS load, unused fonts are freed. */
393 static int clear_font_table_count;
394 #define CLEAR_FONT_TABLE_COUNT 100
395 #define CLEAR_FONT_TABLE_NFONTS 10
397 #endif /* HAVE_WINDOW_SYSTEM */
399 /* Non-zero means face attributes have been changed since the last
400 redisplay. Used in redisplay_internal. */
402 int face_change_count;
404 /* Non-zero means don't display bold text if a face's foreground
405 and background colors are the inverse of the default colors of the
406 display. This is a kluge to suppress `bold black' foreground text
407 which is hard to read on an LCD monitor. */
409 static int tty_suppress_bold_inverse_default_colors_p;
411 /* A list of the form `((x . y))' used to avoid consing in
412 Finternal_set_lisp_face_attribute. */
414 static Lisp_Object Vparam_value_alist;
416 /* The total number of colors currently allocated. */
418 #ifdef GLYPH_DEBUG
419 static int ncolors_allocated;
420 static int npixmaps_allocated;
421 static int ngcs;
422 #endif
424 /* Non-zero means the definition of the `menu' face for new frames has
425 been changed. */
427 static int menu_face_changed_default;
429 struct named_merge_point;
431 static struct face *realize_face (struct face_cache *, Lisp_Object *,
432 int);
433 static struct face *realize_x_face (struct face_cache *, Lisp_Object *);
434 static struct face *realize_tty_face (struct face_cache *, Lisp_Object *);
435 static bool realize_basic_faces (struct frame *);
436 static bool realize_default_face (struct frame *);
437 static void realize_named_face (struct frame *, Lisp_Object, int);
438 static struct face_cache *make_face_cache (struct frame *);
439 static void free_face_cache (struct face_cache *);
440 static int merge_face_ref (struct frame *, Lisp_Object, Lisp_Object *,
441 int, struct named_merge_point *);
442 static int color_distance (XColor *x, XColor *y);
444 #ifdef HAVE_WINDOW_SYSTEM
445 static void set_font_frame_param (Lisp_Object, Lisp_Object);
446 static void clear_face_gcs (struct face_cache *);
447 static struct face *realize_non_ascii_face (struct frame *, Lisp_Object,
448 struct face *);
449 #endif /* HAVE_WINDOW_SYSTEM */
451 /***********************************************************************
452 Utilities
453 ***********************************************************************/
455 #ifdef HAVE_X_WINDOWS
457 #ifdef DEBUG_X_COLORS
459 /* The following is a poor mans infrastructure for debugging X color
460 allocation problems on displays with PseudoColor-8. Some X servers
461 like 3.3.5 XF86_SVGA with Matrox cards apparently don't implement
462 color reference counts completely so that they don't signal an
463 error when a color is freed whose reference count is already 0.
464 Other X servers do. To help me debug this, the following code
465 implements a simple reference counting schema of its own, for a
466 single display/screen. --gerd. */
468 /* Reference counts for pixel colors. */
470 int color_count[256];
472 /* Register color PIXEL as allocated. */
474 void
475 register_color (unsigned long pixel)
477 eassert (pixel < 256);
478 ++color_count[pixel];
482 /* Register color PIXEL as deallocated. */
484 void
485 unregister_color (unsigned long pixel)
487 eassert (pixel < 256);
488 if (color_count[pixel] > 0)
489 --color_count[pixel];
490 else
491 emacs_abort ();
495 /* Register N colors from PIXELS as deallocated. */
497 void
498 unregister_colors (unsigned long *pixels, int n)
500 int i;
501 for (i = 0; i < n; ++i)
502 unregister_color (pixels[i]);
506 DEFUN ("dump-colors", Fdump_colors, Sdump_colors, 0, 0, 0,
507 doc: /* Dump currently allocated colors to stderr. */)
508 (void)
510 int i, n;
512 fputc ('\n', stderr);
514 for (i = n = 0; i < ARRAYELTS (color_count); ++i)
515 if (color_count[i])
517 fprintf (stderr, "%3d: %5d", i, color_count[i]);
518 ++n;
519 if (n % 5 == 0)
520 fputc ('\n', stderr);
521 else
522 fputc ('\t', stderr);
525 if (n % 5 != 0)
526 fputc ('\n', stderr);
527 return Qnil;
530 #endif /* DEBUG_X_COLORS */
533 /* Free colors used on frame F. PIXELS is an array of NPIXELS pixel
534 color values. Interrupt input must be blocked when this function
535 is called. */
537 void
538 x_free_colors (struct frame *f, unsigned long *pixels, int npixels)
540 int class = FRAME_DISPLAY_INFO (f)->visual->class;
542 /* If display has an immutable color map, freeing colors is not
543 necessary and some servers don't allow it. So don't do it. */
544 if (class != StaticColor && class != StaticGray && class != TrueColor)
546 #ifdef DEBUG_X_COLORS
547 unregister_colors (pixels, npixels);
548 #endif
549 XFreeColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
550 pixels, npixels, 0);
555 #ifdef USE_X_TOOLKIT
557 /* Free colors used on frame F. PIXELS is an array of NPIXELS pixel
558 color values. Interrupt input must be blocked when this function
559 is called. */
561 void
562 x_free_dpy_colors (Display *dpy, Screen *screen, Colormap cmap,
563 unsigned long *pixels, int npixels)
565 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
566 int class = dpyinfo->visual->class;
568 /* If display has an immutable color map, freeing colors is not
569 necessary and some servers don't allow it. So don't do it. */
570 if (class != StaticColor && class != StaticGray && class != TrueColor)
572 #ifdef DEBUG_X_COLORS
573 unregister_colors (pixels, npixels);
574 #endif
575 XFreeColors (dpy, cmap, pixels, npixels, 0);
578 #endif /* USE_X_TOOLKIT */
580 /* Create and return a GC for use on frame F. GC values and mask
581 are given by XGCV and MASK. */
583 static GC
584 x_create_gc (struct frame *f, unsigned long mask, XGCValues *xgcv)
586 GC gc;
587 block_input ();
588 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), mask, xgcv);
589 unblock_input ();
590 IF_DEBUG (++ngcs);
591 return gc;
595 /* Free GC which was used on frame F. */
597 static void
598 x_free_gc (struct frame *f, GC gc)
600 eassert (input_blocked_p ());
601 IF_DEBUG ((--ngcs, eassert (ngcs >= 0)));
602 XFreeGC (FRAME_X_DISPLAY (f), gc);
605 #endif /* HAVE_X_WINDOWS */
607 #ifdef HAVE_NTGUI
608 /* W32 emulation of GCs */
610 static GC
611 x_create_gc (struct frame *f, unsigned long mask, XGCValues *xgcv)
613 GC gc;
614 block_input ();
615 gc = XCreateGC (NULL, FRAME_W32_WINDOW (f), mask, xgcv);
616 unblock_input ();
617 IF_DEBUG (++ngcs);
618 return gc;
622 /* Free GC which was used on frame F. */
624 static void
625 x_free_gc (struct frame *f, GC gc)
627 IF_DEBUG ((--ngcs, eassert (ngcs >= 0)));
628 xfree (gc);
631 #endif /* HAVE_NTGUI */
633 #ifdef HAVE_NS
634 /* NS emulation of GCs */
636 static GC
637 x_create_gc (struct frame *f,
638 unsigned long mask,
639 XGCValues *xgcv)
641 GC gc = xmalloc (sizeof *gc);
642 *gc = *xgcv;
643 return gc;
646 static void
647 x_free_gc (struct frame *f, GC gc)
649 xfree (gc);
651 #endif /* HAVE_NS */
653 /***********************************************************************
654 Frames and faces
655 ***********************************************************************/
657 /* Initialize face cache and basic faces for frame F. */
659 void
660 init_frame_faces (struct frame *f)
662 /* Make a face cache, if F doesn't have one. */
663 if (FRAME_FACE_CACHE (f) == NULL)
664 FRAME_FACE_CACHE (f) = make_face_cache (f);
666 #ifdef HAVE_WINDOW_SYSTEM
667 /* Make the image cache. */
668 if (FRAME_WINDOW_P (f))
670 /* We initialize the image cache when creating the first frame
671 on a terminal, and not during terminal creation. This way,
672 `x-open-connection' on a tty won't create an image cache. */
673 if (FRAME_IMAGE_CACHE (f) == NULL)
674 FRAME_IMAGE_CACHE (f) = make_image_cache ();
675 ++FRAME_IMAGE_CACHE (f)->refcount;
677 #endif /* HAVE_WINDOW_SYSTEM */
679 /* Realize faces early (Bug#17889). */
680 if (!realize_basic_faces (f))
681 emacs_abort ();
685 /* Free face cache of frame F. Called from frame-dependent
686 resource freeing function, e.g. (x|tty)_free_frame_resources. */
688 void
689 free_frame_faces (struct frame *f)
691 struct face_cache *face_cache = FRAME_FACE_CACHE (f);
693 if (face_cache)
695 free_face_cache (face_cache);
696 FRAME_FACE_CACHE (f) = NULL;
699 #ifdef HAVE_WINDOW_SYSTEM
700 if (FRAME_WINDOW_P (f))
702 struct image_cache *image_cache = FRAME_IMAGE_CACHE (f);
703 if (image_cache)
705 --image_cache->refcount;
706 if (image_cache->refcount == 0)
707 free_image_cache (f);
710 #endif /* HAVE_WINDOW_SYSTEM */
714 /* Clear face caches, and recompute basic faces for frame F. Call
715 this after changing frame parameters on which those faces depend,
716 or when realized faces have been freed due to changing attributes
717 of named faces. */
719 void
720 recompute_basic_faces (struct frame *f)
722 if (FRAME_FACE_CACHE (f))
724 clear_face_cache (0);
725 if (!realize_basic_faces (f))
726 emacs_abort ();
731 /* Clear the face caches of all frames. CLEAR_FONTS_P non-zero means
732 try to free unused fonts, too. */
734 void
735 clear_face_cache (int clear_fonts_p)
737 #ifdef HAVE_WINDOW_SYSTEM
738 Lisp_Object tail, frame;
740 if (clear_fonts_p
741 || ++clear_font_table_count == CLEAR_FONT_TABLE_COUNT)
743 /* From time to time see if we can unload some fonts. This also
744 frees all realized faces on all frames. Fonts needed by
745 faces will be loaded again when faces are realized again. */
746 clear_font_table_count = 0;
748 FOR_EACH_FRAME (tail, frame)
750 struct frame *f = XFRAME (frame);
751 if (FRAME_WINDOW_P (f)
752 && FRAME_DISPLAY_INFO (f)->n_fonts > CLEAR_FONT_TABLE_NFONTS)
754 clear_font_cache (f);
755 free_all_realized_faces (frame);
759 else
761 /* Clear GCs of realized faces. */
762 FOR_EACH_FRAME (tail, frame)
764 struct frame *f = XFRAME (frame);
765 if (FRAME_WINDOW_P (f))
766 clear_face_gcs (FRAME_FACE_CACHE (f));
768 clear_image_caches (Qnil);
770 #endif /* HAVE_WINDOW_SYSTEM */
774 DEFUN ("clear-face-cache", Fclear_face_cache, Sclear_face_cache, 0, 1, 0,
775 doc: /* Clear face caches on all frames.
776 Optional THOROUGHLY non-nil means try to free unused fonts, too. */)
777 (Lisp_Object thoroughly)
779 clear_face_cache (!NILP (thoroughly));
780 ++face_change_count;
781 windows_or_buffers_changed = 53;
782 return Qnil;
786 /***********************************************************************
787 X Pixmaps
788 ***********************************************************************/
790 #ifdef HAVE_WINDOW_SYSTEM
792 DEFUN ("bitmap-spec-p", Fbitmap_spec_p, Sbitmap_spec_p, 1, 1, 0,
793 doc: /* Value is non-nil if OBJECT is a valid bitmap specification.
794 A bitmap specification is either a string, a file name, or a list
795 \(WIDTH HEIGHT DATA) where WIDTH is the pixel width of the bitmap,
796 HEIGHT is its height, and DATA is a string containing the bits of
797 the pixmap. Bits are stored row by row, each row occupies
798 \(WIDTH + 7)/8 bytes. */)
799 (Lisp_Object object)
801 bool pixmap_p = 0;
803 if (STRINGP (object))
804 /* If OBJECT is a string, it's a file name. */
805 pixmap_p = 1;
806 else if (CONSP (object))
808 /* Otherwise OBJECT must be (WIDTH HEIGHT DATA), WIDTH and
809 HEIGHT must be ints > 0, and DATA must be string large
810 enough to hold a bitmap of the specified size. */
811 Lisp_Object width, height, data;
813 height = width = data = Qnil;
815 if (CONSP (object))
817 width = XCAR (object);
818 object = XCDR (object);
819 if (CONSP (object))
821 height = XCAR (object);
822 object = XCDR (object);
823 if (CONSP (object))
824 data = XCAR (object);
828 if (STRINGP (data)
829 && RANGED_INTEGERP (1, width, INT_MAX)
830 && RANGED_INTEGERP (1, height, INT_MAX))
832 int bytes_per_row = ((XINT (width) + BITS_PER_CHAR - 1)
833 / BITS_PER_CHAR);
834 if (XINT (height) <= SBYTES (data) / bytes_per_row)
835 pixmap_p = 1;
839 return pixmap_p ? Qt : Qnil;
843 /* Load a bitmap according to NAME (which is either a file name or a
844 pixmap spec) for use on frame F. Value is the bitmap_id (see
845 xfns.c). If NAME is nil, return with a bitmap id of zero. If
846 bitmap cannot be loaded, display a message saying so, and return
847 zero. */
849 static ptrdiff_t
850 load_pixmap (struct frame *f, Lisp_Object name)
852 ptrdiff_t bitmap_id;
854 if (NILP (name))
855 return 0;
857 CHECK_TYPE (!NILP (Fbitmap_spec_p (name)), Qbitmap_spec_p, name);
859 block_input ();
860 if (CONSP (name))
862 /* Decode a bitmap spec into a bitmap. */
864 int h, w;
865 Lisp_Object bits;
867 w = XINT (Fcar (name));
868 h = XINT (Fcar (Fcdr (name)));
869 bits = Fcar (Fcdr (Fcdr (name)));
871 bitmap_id = x_create_bitmap_from_data (f, SSDATA (bits),
872 w, h);
874 else
876 /* It must be a string -- a file name. */
877 bitmap_id = x_create_bitmap_from_file (f, name);
879 unblock_input ();
881 if (bitmap_id < 0)
883 add_to_log ("Invalid or undefined bitmap `%s'", name, Qnil);
884 bitmap_id = 0;
886 else
888 #ifdef GLYPH_DEBUG
889 ++npixmaps_allocated;
890 #endif
893 return bitmap_id;
896 #endif /* HAVE_WINDOW_SYSTEM */
900 /***********************************************************************
901 X Colors
902 ***********************************************************************/
904 /* Parse RGB_LIST, and fill in the RGB fields of COLOR.
905 RGB_LIST should contain (at least) 3 lisp integers.
906 Return 0 if there's a problem with RGB_LIST, otherwise return 1. */
908 static int
909 parse_rgb_list (Lisp_Object rgb_list, XColor *color)
911 #define PARSE_RGB_LIST_FIELD(field) \
912 if (CONSP (rgb_list) && INTEGERP (XCAR (rgb_list))) \
914 color->field = XINT (XCAR (rgb_list)); \
915 rgb_list = XCDR (rgb_list); \
917 else \
918 return 0;
920 PARSE_RGB_LIST_FIELD (red);
921 PARSE_RGB_LIST_FIELD (green);
922 PARSE_RGB_LIST_FIELD (blue);
924 return 1;
928 /* Lookup on frame F the color described by the lisp string COLOR.
929 The resulting tty color is returned in TTY_COLOR; if STD_COLOR is
930 non-zero, then the `standard' definition of the same color is
931 returned in it. */
933 static bool
934 tty_lookup_color (struct frame *f, Lisp_Object color, XColor *tty_color,
935 XColor *std_color)
937 Lisp_Object frame, color_desc;
939 if (!STRINGP (color) || NILP (Ffboundp (Qtty_color_desc)))
940 return 0;
942 XSETFRAME (frame, f);
944 color_desc = call2 (Qtty_color_desc, color, frame);
945 if (CONSP (color_desc) && CONSP (XCDR (color_desc)))
947 Lisp_Object rgb;
949 if (! INTEGERP (XCAR (XCDR (color_desc))))
950 return 0;
952 tty_color->pixel = XINT (XCAR (XCDR (color_desc)));
954 rgb = XCDR (XCDR (color_desc));
955 if (! parse_rgb_list (rgb, tty_color))
956 return 0;
958 /* Should we fill in STD_COLOR too? */
959 if (std_color)
961 /* Default STD_COLOR to the same as TTY_COLOR. */
962 *std_color = *tty_color;
964 /* Do a quick check to see if the returned descriptor is
965 actually _exactly_ equal to COLOR, otherwise we have to
966 lookup STD_COLOR separately. If it's impossible to lookup
967 a standard color, we just give up and use TTY_COLOR. */
968 if ((!STRINGP (XCAR (color_desc))
969 || NILP (Fstring_equal (color, XCAR (color_desc))))
970 && !NILP (Ffboundp (Qtty_color_standard_values)))
972 /* Look up STD_COLOR separately. */
973 rgb = call1 (Qtty_color_standard_values, color);
974 if (! parse_rgb_list (rgb, std_color))
975 return 0;
979 return 1;
981 else if (NILP (Fsymbol_value (intern ("tty-defined-color-alist"))))
982 /* We were called early during startup, and the colors are not
983 yet set up in tty-defined-color-alist. Don't return a failure
984 indication, since this produces the annoying "Unable to
985 load color" messages in the *Messages* buffer. */
986 return 1;
987 else
988 /* tty-color-desc seems to have returned a bad value. */
989 return 0;
992 /* A version of defined_color for non-X frames. */
994 static bool
995 tty_defined_color (struct frame *f, const char *color_name,
996 XColor *color_def, bool alloc)
998 bool status = 1;
1000 /* Defaults. */
1001 color_def->pixel = FACE_TTY_DEFAULT_COLOR;
1002 color_def->red = 0;
1003 color_def->blue = 0;
1004 color_def->green = 0;
1006 if (*color_name)
1007 status = tty_lookup_color (f, build_string (color_name), color_def, NULL);
1009 if (color_def->pixel == FACE_TTY_DEFAULT_COLOR && *color_name)
1011 if (strcmp (color_name, "unspecified-fg") == 0)
1012 color_def->pixel = FACE_TTY_DEFAULT_FG_COLOR;
1013 else if (strcmp (color_name, "unspecified-bg") == 0)
1014 color_def->pixel = FACE_TTY_DEFAULT_BG_COLOR;
1017 if (color_def->pixel != FACE_TTY_DEFAULT_COLOR)
1018 status = 1;
1020 return status;
1024 /* Decide if color named COLOR_NAME is valid for the display
1025 associated with the frame F; if so, return the rgb values in
1026 COLOR_DEF. If ALLOC, allocate a new colormap cell.
1028 This does the right thing for any type of frame. */
1030 static bool
1031 defined_color (struct frame *f, const char *color_name, XColor *color_def,
1032 bool alloc)
1034 if (!FRAME_WINDOW_P (f))
1035 return tty_defined_color (f, color_name, color_def, alloc);
1036 #ifdef HAVE_X_WINDOWS
1037 else if (FRAME_X_P (f))
1038 return x_defined_color (f, color_name, color_def, alloc);
1039 #endif
1040 #ifdef HAVE_NTGUI
1041 else if (FRAME_W32_P (f))
1042 return w32_defined_color (f, color_name, color_def, alloc);
1043 #endif
1044 #ifdef HAVE_NS
1045 else if (FRAME_NS_P (f))
1046 return ns_defined_color (f, color_name, color_def, alloc, 1);
1047 #endif
1048 else
1049 emacs_abort ();
1053 /* Given the index IDX of a tty color on frame F, return its name, a
1054 Lisp string. */
1056 Lisp_Object
1057 tty_color_name (struct frame *f, int idx)
1059 if (idx >= 0 && !NILP (Ffboundp (Qtty_color_by_index)))
1061 Lisp_Object frame;
1062 Lisp_Object coldesc;
1064 XSETFRAME (frame, f);
1065 coldesc = call2 (Qtty_color_by_index, make_number (idx), frame);
1067 if (!NILP (coldesc))
1068 return XCAR (coldesc);
1070 #ifdef MSDOS
1071 /* We can have an MS-DOS frame under -nw for a short window of
1072 opportunity before internal_terminal_init is called. DTRT. */
1073 if (FRAME_MSDOS_P (f) && !inhibit_window_system)
1074 return msdos_stdcolor_name (idx);
1075 #endif
1077 if (idx == FACE_TTY_DEFAULT_FG_COLOR)
1078 return build_string (unspecified_fg);
1079 if (idx == FACE_TTY_DEFAULT_BG_COLOR)
1080 return build_string (unspecified_bg);
1082 return Qunspecified;
1086 /* Return non-zero if COLOR_NAME is a shade of gray (or white or
1087 black) on frame F.
1089 The criterion implemented here is not a terribly sophisticated one. */
1091 static int
1092 face_color_gray_p (struct frame *f, const char *color_name)
1094 XColor color;
1095 int gray_p;
1097 if (defined_color (f, color_name, &color, 0))
1098 gray_p = (/* Any color sufficiently close to black counts as gray. */
1099 (color.red < 5000 && color.green < 5000 && color.blue < 5000)
1101 ((eabs (color.red - color.green)
1102 < max (color.red, color.green) / 20)
1103 && (eabs (color.green - color.blue)
1104 < max (color.green, color.blue) / 20)
1105 && (eabs (color.blue - color.red)
1106 < max (color.blue, color.red) / 20)));
1107 else
1108 gray_p = 0;
1110 return gray_p;
1114 /* Return non-zero if color COLOR_NAME can be displayed on frame F.
1115 BACKGROUND_P non-zero means the color will be used as background
1116 color. */
1118 static int
1119 face_color_supported_p (struct frame *f, const char *color_name,
1120 int background_p)
1122 Lisp_Object frame;
1123 XColor not_used;
1125 XSETFRAME (frame, f);
1126 return
1127 #ifdef HAVE_WINDOW_SYSTEM
1128 FRAME_WINDOW_P (f)
1129 ? (!NILP (Fxw_display_color_p (frame))
1130 || xstrcasecmp (color_name, "black") == 0
1131 || xstrcasecmp (color_name, "white") == 0
1132 || (background_p
1133 && face_color_gray_p (f, color_name))
1134 || (!NILP (Fx_display_grayscale_p (frame))
1135 && face_color_gray_p (f, color_name)))
1137 #endif
1138 tty_defined_color (f, color_name, &not_used, 0);
1142 DEFUN ("color-gray-p", Fcolor_gray_p, Scolor_gray_p, 1, 2, 0,
1143 doc: /* Return non-nil if COLOR is a shade of gray (or white or black).
1144 FRAME specifies the frame and thus the display for interpreting COLOR.
1145 If FRAME is nil or omitted, use the selected frame. */)
1146 (Lisp_Object color, Lisp_Object frame)
1148 CHECK_STRING (color);
1149 return (face_color_gray_p (decode_any_frame (frame), SSDATA (color))
1150 ? Qt : Qnil);
1154 DEFUN ("color-supported-p", Fcolor_supported_p,
1155 Scolor_supported_p, 1, 3, 0,
1156 doc: /* Return non-nil if COLOR can be displayed on FRAME.
1157 BACKGROUND-P non-nil means COLOR is used as a background.
1158 Otherwise, this function tells whether it can be used as a foreground.
1159 If FRAME is nil or omitted, use the selected frame.
1160 COLOR must be a valid color name. */)
1161 (Lisp_Object color, Lisp_Object frame, Lisp_Object background_p)
1163 CHECK_STRING (color);
1164 return (face_color_supported_p (decode_any_frame (frame),
1165 SSDATA (color), !NILP (background_p))
1166 ? Qt : Qnil);
1170 static unsigned long
1171 load_color2 (struct frame *f, struct face *face, Lisp_Object name,
1172 enum lface_attribute_index target_index, XColor *color)
1174 eassert (STRINGP (name));
1175 eassert (target_index == LFACE_FOREGROUND_INDEX
1176 || target_index == LFACE_BACKGROUND_INDEX
1177 || target_index == LFACE_UNDERLINE_INDEX
1178 || target_index == LFACE_OVERLINE_INDEX
1179 || target_index == LFACE_STRIKE_THROUGH_INDEX
1180 || target_index == LFACE_BOX_INDEX);
1182 /* if the color map is full, defined_color will return a best match
1183 to the values in an existing cell. */
1184 if (!defined_color (f, SSDATA (name), color, 1))
1186 add_to_log ("Unable to load color \"%s\"", name, Qnil);
1188 switch (target_index)
1190 case LFACE_FOREGROUND_INDEX:
1191 face->foreground_defaulted_p = 1;
1192 color->pixel = FRAME_FOREGROUND_PIXEL (f);
1193 break;
1195 case LFACE_BACKGROUND_INDEX:
1196 face->background_defaulted_p = 1;
1197 color->pixel = FRAME_BACKGROUND_PIXEL (f);
1198 break;
1200 case LFACE_UNDERLINE_INDEX:
1201 face->underline_defaulted_p = 1;
1202 color->pixel = FRAME_FOREGROUND_PIXEL (f);
1203 break;
1205 case LFACE_OVERLINE_INDEX:
1206 face->overline_color_defaulted_p = 1;
1207 color->pixel = FRAME_FOREGROUND_PIXEL (f);
1208 break;
1210 case LFACE_STRIKE_THROUGH_INDEX:
1211 face->strike_through_color_defaulted_p = 1;
1212 color->pixel = FRAME_FOREGROUND_PIXEL (f);
1213 break;
1215 case LFACE_BOX_INDEX:
1216 face->box_color_defaulted_p = 1;
1217 color->pixel = FRAME_FOREGROUND_PIXEL (f);
1218 break;
1220 default:
1221 emacs_abort ();
1224 #ifdef GLYPH_DEBUG
1225 else
1226 ++ncolors_allocated;
1227 #endif
1229 return color->pixel;
1232 /* Load color with name NAME for use by face FACE on frame F.
1233 TARGET_INDEX must be one of LFACE_FOREGROUND_INDEX,
1234 LFACE_BACKGROUND_INDEX, LFACE_UNDERLINE_INDEX, LFACE_OVERLINE_INDEX,
1235 LFACE_STRIKE_THROUGH_INDEX, or LFACE_BOX_INDEX. Value is the
1236 pixel color. If color cannot be loaded, display a message, and
1237 return the foreground, background or underline color of F, but
1238 record that fact in flags of the face so that we don't try to free
1239 these colors. */
1241 unsigned long
1242 load_color (struct frame *f, struct face *face, Lisp_Object name,
1243 enum lface_attribute_index target_index)
1245 XColor color;
1246 return load_color2 (f, face, name, target_index, &color);
1250 #ifdef HAVE_WINDOW_SYSTEM
1252 #define NEAR_SAME_COLOR_THRESHOLD 30000
1254 /* Load colors for face FACE which is used on frame F. Colors are
1255 specified by slots LFACE_BACKGROUND_INDEX and LFACE_FOREGROUND_INDEX
1256 of ATTRS. If the background color specified is not supported on F,
1257 try to emulate gray colors with a stipple from Vface_default_stipple. */
1259 static void
1260 load_face_colors (struct frame *f, struct face *face,
1261 Lisp_Object attrs[LFACE_VECTOR_SIZE])
1263 Lisp_Object fg, bg, dfg;
1264 XColor xfg, xbg;
1266 bg = attrs[LFACE_BACKGROUND_INDEX];
1267 fg = attrs[LFACE_FOREGROUND_INDEX];
1269 /* Swap colors if face is inverse-video. */
1270 if (EQ (attrs[LFACE_INVERSE_INDEX], Qt))
1272 Lisp_Object tmp;
1273 tmp = fg;
1274 fg = bg;
1275 bg = tmp;
1278 /* Check for support for foreground, not for background because
1279 face_color_supported_p is smart enough to know that grays are
1280 "supported" as background because we are supposed to use stipple
1281 for them. */
1282 if (!face_color_supported_p (f, SSDATA (bg), 0)
1283 && !NILP (Fbitmap_spec_p (Vface_default_stipple)))
1285 x_destroy_bitmap (f, face->stipple);
1286 face->stipple = load_pixmap (f, Vface_default_stipple);
1289 face->background = load_color2 (f, face, bg, LFACE_BACKGROUND_INDEX, &xbg);
1290 face->foreground = load_color2 (f, face, fg, LFACE_FOREGROUND_INDEX, &xfg);
1292 dfg = attrs[LFACE_DISTANT_FOREGROUND_INDEX];
1293 if (!NILP (dfg) && !UNSPECIFIEDP (dfg)
1294 && color_distance (&xbg, &xfg) < NEAR_SAME_COLOR_THRESHOLD)
1296 if (EQ (attrs[LFACE_INVERSE_INDEX], Qt))
1297 face->background = load_color (f, face, dfg, LFACE_BACKGROUND_INDEX);
1298 else
1299 face->foreground = load_color (f, face, dfg, LFACE_FOREGROUND_INDEX);
1303 #ifdef HAVE_X_WINDOWS
1305 /* Free color PIXEL on frame F. */
1307 void
1308 unload_color (struct frame *f, unsigned long pixel)
1310 if (pixel != -1)
1312 block_input ();
1313 x_free_colors (f, &pixel, 1);
1314 unblock_input ();
1318 /* Free colors allocated for FACE. */
1320 static void
1321 free_face_colors (struct frame *f, struct face *face)
1323 /* PENDING(NS): need to do something here? */
1325 if (face->colors_copied_bitwise_p)
1326 return;
1328 block_input ();
1330 if (!face->foreground_defaulted_p)
1332 x_free_colors (f, &face->foreground, 1);
1333 IF_DEBUG (--ncolors_allocated);
1336 if (!face->background_defaulted_p)
1338 x_free_colors (f, &face->background, 1);
1339 IF_DEBUG (--ncolors_allocated);
1342 if (face->underline_p
1343 && !face->underline_defaulted_p)
1345 x_free_colors (f, &face->underline_color, 1);
1346 IF_DEBUG (--ncolors_allocated);
1349 if (face->overline_p
1350 && !face->overline_color_defaulted_p)
1352 x_free_colors (f, &face->overline_color, 1);
1353 IF_DEBUG (--ncolors_allocated);
1356 if (face->strike_through_p
1357 && !face->strike_through_color_defaulted_p)
1359 x_free_colors (f, &face->strike_through_color, 1);
1360 IF_DEBUG (--ncolors_allocated);
1363 if (face->box != FACE_NO_BOX
1364 && !face->box_color_defaulted_p)
1366 x_free_colors (f, &face->box_color, 1);
1367 IF_DEBUG (--ncolors_allocated);
1370 unblock_input ();
1373 #endif /* HAVE_X_WINDOWS */
1375 #endif /* HAVE_WINDOW_SYSTEM */
1379 /***********************************************************************
1380 XLFD Font Names
1381 ***********************************************************************/
1383 /* An enumerator for each field of an XLFD font name. */
1385 enum xlfd_field
1387 XLFD_FOUNDRY,
1388 XLFD_FAMILY,
1389 XLFD_WEIGHT,
1390 XLFD_SLANT,
1391 XLFD_SWIDTH,
1392 XLFD_ADSTYLE,
1393 XLFD_PIXEL_SIZE,
1394 XLFD_POINT_SIZE,
1395 XLFD_RESX,
1396 XLFD_RESY,
1397 XLFD_SPACING,
1398 XLFD_AVGWIDTH,
1399 XLFD_REGISTRY,
1400 XLFD_ENCODING,
1401 XLFD_LAST
1404 /* An enumerator for each possible slant value of a font. Taken from
1405 the XLFD specification. */
1407 enum xlfd_slant
1409 XLFD_SLANT_UNKNOWN,
1410 XLFD_SLANT_ROMAN,
1411 XLFD_SLANT_ITALIC,
1412 XLFD_SLANT_OBLIQUE,
1413 XLFD_SLANT_REVERSE_ITALIC,
1414 XLFD_SLANT_REVERSE_OBLIQUE,
1415 XLFD_SLANT_OTHER
1418 /* Relative font weight according to XLFD documentation. */
1420 enum xlfd_weight
1422 XLFD_WEIGHT_UNKNOWN,
1423 XLFD_WEIGHT_ULTRA_LIGHT, /* 10 */
1424 XLFD_WEIGHT_EXTRA_LIGHT, /* 20 */
1425 XLFD_WEIGHT_LIGHT, /* 30 */
1426 XLFD_WEIGHT_SEMI_LIGHT, /* 40: SemiLight, Book, ... */
1427 XLFD_WEIGHT_MEDIUM, /* 50: Medium, Normal, Regular, ... */
1428 XLFD_WEIGHT_SEMI_BOLD, /* 60: SemiBold, DemiBold, ... */
1429 XLFD_WEIGHT_BOLD, /* 70: Bold, ... */
1430 XLFD_WEIGHT_EXTRA_BOLD, /* 80: ExtraBold, Heavy, ... */
1431 XLFD_WEIGHT_ULTRA_BOLD /* 90: UltraBold, Black, ... */
1434 /* Relative proportionate width. */
1436 enum xlfd_swidth
1438 XLFD_SWIDTH_UNKNOWN,
1439 XLFD_SWIDTH_ULTRA_CONDENSED, /* 10 */
1440 XLFD_SWIDTH_EXTRA_CONDENSED, /* 20 */
1441 XLFD_SWIDTH_CONDENSED, /* 30: Condensed, Narrow, Compressed, ... */
1442 XLFD_SWIDTH_SEMI_CONDENSED, /* 40: semicondensed */
1443 XLFD_SWIDTH_MEDIUM, /* 50: Medium, Normal, Regular, ... */
1444 XLFD_SWIDTH_SEMI_EXPANDED, /* 60: SemiExpanded, DemiExpanded, ... */
1445 XLFD_SWIDTH_EXPANDED, /* 70: Expanded... */
1446 XLFD_SWIDTH_EXTRA_EXPANDED, /* 80: ExtraExpanded, Wide... */
1447 XLFD_SWIDTH_ULTRA_EXPANDED /* 90: UltraExpanded... */
1450 /* Order by which font selection chooses fonts. The default values
1451 mean `first, find a best match for the font width, then for the
1452 font height, then for weight, then for slant.' This variable can be
1453 set via set-face-font-sort-order. */
1455 static int font_sort_order[4];
1457 #ifdef HAVE_WINDOW_SYSTEM
1459 static enum font_property_index font_props_for_sorting[FONT_SIZE_INDEX];
1461 static int
1462 compare_fonts_by_sort_order (const void *v1, const void *v2)
1464 Lisp_Object const *p1 = v1;
1465 Lisp_Object const *p2 = v2;
1466 Lisp_Object font1 = *p1;
1467 Lisp_Object font2 = *p2;
1468 int i;
1470 for (i = 0; i < FONT_SIZE_INDEX; i++)
1472 enum font_property_index idx = font_props_for_sorting[i];
1473 Lisp_Object val1 = AREF (font1, idx), val2 = AREF (font2, idx);
1474 int result;
1476 if (idx <= FONT_REGISTRY_INDEX)
1478 if (STRINGP (val1))
1479 result = STRINGP (val2) ? strcmp (SSDATA (val1), SSDATA (val2)) : -1;
1480 else
1481 result = STRINGP (val2) ? 1 : 0;
1483 else
1485 if (INTEGERP (val1))
1486 result = (INTEGERP (val2) && XINT (val1) >= XINT (val2)
1487 ? XINT (val1) > XINT (val2)
1488 : -1);
1489 else
1490 result = INTEGERP (val2) ? 1 : 0;
1492 if (result)
1493 return result;
1495 return 0;
1498 DEFUN ("x-family-fonts", Fx_family_fonts, Sx_family_fonts, 0, 2, 0,
1499 doc: /* Return a list of available fonts of family FAMILY on FRAME.
1500 If FAMILY is omitted or nil, list all families.
1501 Otherwise, FAMILY must be a string, possibly containing wildcards
1502 `?' and `*'.
1503 If FRAME is omitted or nil, use the selected frame.
1504 Each element of the result is a vector [FAMILY WIDTH POINT-SIZE WEIGHT
1505 SLANT FIXED-P FULL REGISTRY-AND-ENCODING].
1506 FAMILY is the font family name. POINT-SIZE is the size of the
1507 font in 1/10 pt. WIDTH, WEIGHT, and SLANT are symbols describing the
1508 width, weight and slant of the font. These symbols are the same as for
1509 face attributes. FIXED-P is non-nil if the font is fixed-pitch.
1510 FULL is the full name of the font, and REGISTRY-AND-ENCODING is a string
1511 giving the registry and encoding of the font.
1512 The result list is sorted according to the current setting of
1513 the face font sort order. */)
1514 (Lisp_Object family, Lisp_Object frame)
1516 Lisp_Object font_spec, list, *drivers, vec;
1517 struct frame *f = decode_live_frame (frame);
1518 ptrdiff_t i, nfonts;
1519 EMACS_INT ndrivers;
1520 Lisp_Object result;
1521 USE_SAFE_ALLOCA;
1523 font_spec = Ffont_spec (0, NULL);
1524 if (!NILP (family))
1526 CHECK_STRING (family);
1527 font_parse_family_registry (family, Qnil, font_spec);
1530 list = font_list_entities (f, font_spec);
1531 if (NILP (list))
1532 return Qnil;
1534 /* Sort the font entities. */
1535 for (i = 0; i < 4; i++)
1536 switch (font_sort_order[i])
1538 case XLFD_SWIDTH:
1539 font_props_for_sorting[i] = FONT_WIDTH_INDEX; break;
1540 case XLFD_POINT_SIZE:
1541 font_props_for_sorting[i] = FONT_SIZE_INDEX; break;
1542 case XLFD_WEIGHT:
1543 font_props_for_sorting[i] = FONT_WEIGHT_INDEX; break;
1544 default:
1545 font_props_for_sorting[i] = FONT_SLANT_INDEX; break;
1547 font_props_for_sorting[i++] = FONT_FAMILY_INDEX;
1548 font_props_for_sorting[i++] = FONT_FOUNDRY_INDEX;
1549 font_props_for_sorting[i++] = FONT_ADSTYLE_INDEX;
1550 font_props_for_sorting[i++] = FONT_REGISTRY_INDEX;
1552 ndrivers = XINT (Flength (list));
1553 SAFE_ALLOCA_LISP (drivers, ndrivers);
1554 for (i = 0; i < ndrivers; i++, list = XCDR (list))
1555 drivers[i] = XCAR (list);
1556 vec = Fvconcat (ndrivers, drivers);
1557 nfonts = ASIZE (vec);
1559 qsort (XVECTOR (vec)->contents, nfonts, word_size,
1560 compare_fonts_by_sort_order);
1562 result = Qnil;
1563 for (i = nfonts - 1; i >= 0; --i)
1565 Lisp_Object font = AREF (vec, i);
1566 Lisp_Object v = make_uninit_vector (8);
1567 int point;
1568 Lisp_Object spacing;
1570 ASET (v, 0, AREF (font, FONT_FAMILY_INDEX));
1571 ASET (v, 1, FONT_WIDTH_SYMBOLIC (font));
1572 point = PIXEL_TO_POINT (XINT (AREF (font, FONT_SIZE_INDEX)) * 10,
1573 FRAME_RES_Y (f));
1574 ASET (v, 2, make_number (point));
1575 ASET (v, 3, FONT_WEIGHT_SYMBOLIC (font));
1576 ASET (v, 4, FONT_SLANT_SYMBOLIC (font));
1577 spacing = Ffont_get (font, QCspacing);
1578 ASET (v, 5, (NILP (spacing) || EQ (spacing, Qp)) ? Qnil : Qt);
1579 ASET (v, 6, Ffont_xlfd_name (font, Qnil));
1580 ASET (v, 7, AREF (font, FONT_REGISTRY_INDEX));
1582 result = Fcons (v, result);
1585 SAFE_FREE ();
1586 return result;
1589 DEFUN ("x-list-fonts", Fx_list_fonts, Sx_list_fonts, 1, 5, 0,
1590 doc: /* Return a list of the names of available fonts matching PATTERN.
1591 If optional arguments FACE and FRAME are specified, return only fonts
1592 the same size as FACE on FRAME.
1594 PATTERN should be a string containing a font name in the XLFD,
1595 Fontconfig, or GTK format. A font name given in the XLFD format may
1596 contain wildcard characters:
1597 the * character matches any substring, and
1598 the ? character matches any single character.
1599 PATTERN is case-insensitive.
1601 The return value is a list of strings, suitable as arguments to
1602 `set-face-font'.
1604 Fonts Emacs can't use may or may not be excluded
1605 even if they match PATTERN and FACE.
1606 The optional fourth argument MAXIMUM sets a limit on how many
1607 fonts to match. The first MAXIMUM fonts are reported.
1608 The optional fifth argument WIDTH, if specified, is a number of columns
1609 occupied by a character of a font. In that case, return only fonts
1610 the WIDTH times as wide as FACE on FRAME. */)
1611 (Lisp_Object pattern, Lisp_Object face, Lisp_Object frame,
1612 Lisp_Object maximum, Lisp_Object width)
1614 struct frame *f;
1615 int size, avgwidth IF_LINT (= 0);
1617 check_window_system (NULL);
1618 CHECK_STRING (pattern);
1620 if (! NILP (maximum))
1621 CHECK_NATNUM (maximum);
1623 if (!NILP (width))
1624 CHECK_NUMBER (width);
1626 /* We can't simply call decode_window_system_frame because
1627 this function may be called before any frame is created. */
1628 f = decode_live_frame (frame);
1629 if (! FRAME_WINDOW_P (f))
1631 /* Perhaps we have not yet created any frame. */
1632 f = NULL;
1633 frame = Qnil;
1634 face = Qnil;
1636 else
1637 XSETFRAME (frame, f);
1639 /* Determine the width standard for comparison with the fonts we find. */
1641 if (NILP (face))
1642 size = 0;
1643 else
1645 /* This is of limited utility since it works with character
1646 widths. Keep it for compatibility. --gerd. */
1647 int face_id = lookup_named_face (f, face, 0);
1648 struct face *width_face = (face_id < 0
1649 ? NULL
1650 : FACE_FROM_ID (f, face_id));
1652 if (width_face && width_face->font)
1654 size = width_face->font->pixel_size;
1655 avgwidth = width_face->font->average_width;
1657 else
1659 size = FRAME_FONT (f)->pixel_size;
1660 avgwidth = FRAME_FONT (f)->average_width;
1662 if (!NILP (width))
1663 avgwidth *= XINT (width);
1667 Lisp_Object font_spec;
1668 Lisp_Object args[2], tail;
1670 font_spec = font_spec_from_name (pattern);
1671 if (!FONTP (font_spec))
1672 signal_error ("Invalid font name", pattern);
1674 if (size)
1676 Ffont_put (font_spec, QCsize, make_number (size));
1677 Ffont_put (font_spec, QCavgwidth, make_number (avgwidth));
1679 args[0] = Flist_fonts (font_spec, frame, maximum, font_spec);
1680 for (tail = args[0]; CONSP (tail); tail = XCDR (tail))
1682 Lisp_Object font_entity;
1684 font_entity = XCAR (tail);
1685 if ((NILP (AREF (font_entity, FONT_SIZE_INDEX))
1686 || XINT (AREF (font_entity, FONT_SIZE_INDEX)) == 0)
1687 && ! NILP (AREF (font_spec, FONT_SIZE_INDEX)))
1689 /* This is a scalable font. For backward compatibility,
1690 we set the specified size. */
1691 font_entity = copy_font_spec (font_entity);
1692 ASET (font_entity, FONT_SIZE_INDEX,
1693 AREF (font_spec, FONT_SIZE_INDEX));
1695 XSETCAR (tail, Ffont_xlfd_name (font_entity, Qnil));
1697 if (NILP (frame))
1698 /* We don't have to check fontsets. */
1699 return args[0];
1700 args[1] = list_fontsets (f, pattern, size);
1701 return Fnconc (2, args);
1705 #endif /* HAVE_WINDOW_SYSTEM */
1708 /***********************************************************************
1709 Lisp Faces
1710 ***********************************************************************/
1712 /* Access face attributes of face LFACE, a Lisp vector. */
1714 #define LFACE_FAMILY(LFACE) AREF ((LFACE), LFACE_FAMILY_INDEX)
1715 #define LFACE_FOUNDRY(LFACE) AREF ((LFACE), LFACE_FOUNDRY_INDEX)
1716 #define LFACE_HEIGHT(LFACE) AREF ((LFACE), LFACE_HEIGHT_INDEX)
1717 #define LFACE_WEIGHT(LFACE) AREF ((LFACE), LFACE_WEIGHT_INDEX)
1718 #define LFACE_SLANT(LFACE) AREF ((LFACE), LFACE_SLANT_INDEX)
1719 #define LFACE_UNDERLINE(LFACE) AREF ((LFACE), LFACE_UNDERLINE_INDEX)
1720 #define LFACE_INVERSE(LFACE) AREF ((LFACE), LFACE_INVERSE_INDEX)
1721 #define LFACE_FOREGROUND(LFACE) AREF ((LFACE), LFACE_FOREGROUND_INDEX)
1722 #define LFACE_BACKGROUND(LFACE) AREF ((LFACE), LFACE_BACKGROUND_INDEX)
1723 #define LFACE_STIPPLE(LFACE) AREF ((LFACE), LFACE_STIPPLE_INDEX)
1724 #define LFACE_SWIDTH(LFACE) AREF ((LFACE), LFACE_SWIDTH_INDEX)
1725 #define LFACE_OVERLINE(LFACE) AREF ((LFACE), LFACE_OVERLINE_INDEX)
1726 #define LFACE_STRIKE_THROUGH(LFACE) AREF ((LFACE), LFACE_STRIKE_THROUGH_INDEX)
1727 #define LFACE_BOX(LFACE) AREF ((LFACE), LFACE_BOX_INDEX)
1728 #define LFACE_FONT(LFACE) AREF ((LFACE), LFACE_FONT_INDEX)
1729 #define LFACE_INHERIT(LFACE) AREF ((LFACE), LFACE_INHERIT_INDEX)
1730 #define LFACE_FONTSET(LFACE) AREF ((LFACE), LFACE_FONTSET_INDEX)
1731 #define LFACE_DISTANT_FOREGROUND(LFACE) \
1732 AREF ((LFACE), LFACE_DISTANT_FOREGROUND_INDEX)
1734 /* Non-zero if LFACE is a Lisp face. A Lisp face is a vector of size
1735 LFACE_VECTOR_SIZE which has the symbol `face' in slot 0. */
1737 #define LFACEP(LFACE) \
1738 (VECTORP (LFACE) \
1739 && ASIZE (LFACE) == LFACE_VECTOR_SIZE \
1740 && EQ (AREF (LFACE, 0), Qface))
1743 #ifdef GLYPH_DEBUG
1745 /* Check consistency of Lisp face attribute vector ATTRS. */
1747 static void
1748 check_lface_attrs (Lisp_Object attrs[LFACE_VECTOR_SIZE])
1750 eassert (UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
1751 || IGNORE_DEFFACE_P (attrs[LFACE_FAMILY_INDEX])
1752 || STRINGP (attrs[LFACE_FAMILY_INDEX]));
1753 eassert (UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
1754 || IGNORE_DEFFACE_P (attrs[LFACE_FOUNDRY_INDEX])
1755 || STRINGP (attrs[LFACE_FOUNDRY_INDEX]));
1756 eassert (UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
1757 || IGNORE_DEFFACE_P (attrs[LFACE_SWIDTH_INDEX])
1758 || SYMBOLP (attrs[LFACE_SWIDTH_INDEX]));
1759 eassert (UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
1760 || IGNORE_DEFFACE_P (attrs[LFACE_HEIGHT_INDEX])
1761 || INTEGERP (attrs[LFACE_HEIGHT_INDEX])
1762 || FLOATP (attrs[LFACE_HEIGHT_INDEX])
1763 || FUNCTIONP (attrs[LFACE_HEIGHT_INDEX]));
1764 eassert (UNSPECIFIEDP (attrs[LFACE_WEIGHT_INDEX])
1765 || IGNORE_DEFFACE_P (attrs[LFACE_WEIGHT_INDEX])
1766 || SYMBOLP (attrs[LFACE_WEIGHT_INDEX]));
1767 eassert (UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX])
1768 || IGNORE_DEFFACE_P (attrs[LFACE_SLANT_INDEX])
1769 || SYMBOLP (attrs[LFACE_SLANT_INDEX]));
1770 eassert (UNSPECIFIEDP (attrs[LFACE_UNDERLINE_INDEX])
1771 || IGNORE_DEFFACE_P (attrs[LFACE_UNDERLINE_INDEX])
1772 || SYMBOLP (attrs[LFACE_UNDERLINE_INDEX])
1773 || STRINGP (attrs[LFACE_UNDERLINE_INDEX])
1774 || CONSP (attrs[LFACE_UNDERLINE_INDEX]));
1775 eassert (UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
1776 || IGNORE_DEFFACE_P (attrs[LFACE_OVERLINE_INDEX])
1777 || SYMBOLP (attrs[LFACE_OVERLINE_INDEX])
1778 || STRINGP (attrs[LFACE_OVERLINE_INDEX]));
1779 eassert (UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
1780 || IGNORE_DEFFACE_P (attrs[LFACE_STRIKE_THROUGH_INDEX])
1781 || SYMBOLP (attrs[LFACE_STRIKE_THROUGH_INDEX])
1782 || STRINGP (attrs[LFACE_STRIKE_THROUGH_INDEX]));
1783 eassert (UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
1784 || IGNORE_DEFFACE_P (attrs[LFACE_BOX_INDEX])
1785 || SYMBOLP (attrs[LFACE_BOX_INDEX])
1786 || STRINGP (attrs[LFACE_BOX_INDEX])
1787 || INTEGERP (attrs[LFACE_BOX_INDEX])
1788 || CONSP (attrs[LFACE_BOX_INDEX]));
1789 eassert (UNSPECIFIEDP (attrs[LFACE_INVERSE_INDEX])
1790 || IGNORE_DEFFACE_P (attrs[LFACE_INVERSE_INDEX])
1791 || SYMBOLP (attrs[LFACE_INVERSE_INDEX]));
1792 eassert (UNSPECIFIEDP (attrs[LFACE_FOREGROUND_INDEX])
1793 || IGNORE_DEFFACE_P (attrs[LFACE_FOREGROUND_INDEX])
1794 || STRINGP (attrs[LFACE_FOREGROUND_INDEX]));
1795 eassert (UNSPECIFIEDP (attrs[LFACE_DISTANT_FOREGROUND_INDEX])
1796 || IGNORE_DEFFACE_P (attrs[LFACE_DISTANT_FOREGROUND_INDEX])
1797 || STRINGP (attrs[LFACE_DISTANT_FOREGROUND_INDEX]));
1798 eassert (UNSPECIFIEDP (attrs[LFACE_BACKGROUND_INDEX])
1799 || IGNORE_DEFFACE_P (attrs[LFACE_BACKGROUND_INDEX])
1800 || STRINGP (attrs[LFACE_BACKGROUND_INDEX]));
1801 eassert (UNSPECIFIEDP (attrs[LFACE_INHERIT_INDEX])
1802 || IGNORE_DEFFACE_P (attrs[LFACE_INHERIT_INDEX])
1803 || NILP (attrs[LFACE_INHERIT_INDEX])
1804 || SYMBOLP (attrs[LFACE_INHERIT_INDEX])
1805 || CONSP (attrs[LFACE_INHERIT_INDEX]));
1806 #ifdef HAVE_WINDOW_SYSTEM
1807 eassert (UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
1808 || IGNORE_DEFFACE_P (attrs[LFACE_STIPPLE_INDEX])
1809 || SYMBOLP (attrs[LFACE_STIPPLE_INDEX])
1810 || !NILP (Fbitmap_spec_p (attrs[LFACE_STIPPLE_INDEX])));
1811 eassert (UNSPECIFIEDP (attrs[LFACE_FONT_INDEX])
1812 || IGNORE_DEFFACE_P (attrs[LFACE_FONT_INDEX])
1813 || FONTP (attrs[LFACE_FONT_INDEX]));
1814 eassert (UNSPECIFIEDP (attrs[LFACE_FONTSET_INDEX])
1815 || STRINGP (attrs[LFACE_FONTSET_INDEX])
1816 || NILP (attrs[LFACE_FONTSET_INDEX]));
1817 #endif
1821 /* Check consistency of attributes of Lisp face LFACE (a Lisp vector). */
1823 static void
1824 check_lface (Lisp_Object lface)
1826 if (!NILP (lface))
1828 eassert (LFACEP (lface));
1829 check_lface_attrs (XVECTOR (lface)->contents);
1833 #else /* not GLYPH_DEBUG */
1835 #define check_lface_attrs(attrs) (void) 0
1836 #define check_lface(lface) (void) 0
1838 #endif /* GLYPH_DEBUG */
1842 /* Face-merge cycle checking. */
1844 enum named_merge_point_kind
1846 NAMED_MERGE_POINT_NORMAL,
1847 NAMED_MERGE_POINT_REMAP
1850 /* A `named merge point' is simply a point during face-merging where we
1851 look up a face by name. We keep a stack of which named lookups we're
1852 currently processing so that we can easily detect cycles, using a
1853 linked- list of struct named_merge_point structures, typically
1854 allocated on the stack frame of the named lookup functions which are
1855 active (so no consing is required). */
1856 struct named_merge_point
1858 Lisp_Object face_name;
1859 enum named_merge_point_kind named_merge_point_kind;
1860 struct named_merge_point *prev;
1864 /* If a face merging cycle is detected for FACE_NAME, return 0,
1865 otherwise add NEW_NAMED_MERGE_POINT, which is initialized using
1866 FACE_NAME and NAMED_MERGE_POINT_KIND, as the head of the linked list
1867 pointed to by NAMED_MERGE_POINTS, and return 1. */
1869 static int
1870 push_named_merge_point (struct named_merge_point *new_named_merge_point,
1871 Lisp_Object face_name,
1872 enum named_merge_point_kind named_merge_point_kind,
1873 struct named_merge_point **named_merge_points)
1875 struct named_merge_point *prev;
1877 for (prev = *named_merge_points; prev; prev = prev->prev)
1878 if (EQ (face_name, prev->face_name))
1880 if (prev->named_merge_point_kind == named_merge_point_kind)
1881 /* A cycle, so fail. */
1882 return 0;
1883 else if (prev->named_merge_point_kind == NAMED_MERGE_POINT_REMAP)
1884 /* A remap `hides ' any previous normal merge points
1885 (because the remap means that it's actually different face),
1886 so as we know the current merge point must be normal, we
1887 can just assume it's OK. */
1888 break;
1891 new_named_merge_point->face_name = face_name;
1892 new_named_merge_point->named_merge_point_kind = named_merge_point_kind;
1893 new_named_merge_point->prev = *named_merge_points;
1895 *named_merge_points = new_named_merge_point;
1897 return 1;
1901 /* Resolve face name FACE_NAME. If FACE_NAME is a string, intern it
1902 to make it a symbol. If FACE_NAME is an alias for another face,
1903 return that face's name.
1905 Return default face in case of errors. */
1907 static Lisp_Object
1908 resolve_face_name (Lisp_Object face_name, int signal_p)
1910 Lisp_Object orig_face;
1911 Lisp_Object tortoise, hare;
1913 if (STRINGP (face_name))
1914 face_name = intern (SSDATA (face_name));
1916 if (NILP (face_name) || !SYMBOLP (face_name))
1917 return face_name;
1919 orig_face = face_name;
1920 tortoise = hare = face_name;
1922 while (1)
1924 face_name = hare;
1925 hare = Fget (hare, Qface_alias);
1926 if (NILP (hare) || !SYMBOLP (hare))
1927 break;
1929 face_name = hare;
1930 hare = Fget (hare, Qface_alias);
1931 if (NILP (hare) || !SYMBOLP (hare))
1932 break;
1934 tortoise = Fget (tortoise, Qface_alias);
1935 if (EQ (hare, tortoise))
1937 if (signal_p)
1938 xsignal1 (Qcircular_list, orig_face);
1939 return Qdefault;
1943 return face_name;
1947 /* Return the face definition of FACE_NAME on frame F. F null means
1948 return the definition for new frames. FACE_NAME may be a string or
1949 a symbol (apparently Emacs 20.2 allowed strings as face names in
1950 face text properties; Ediff uses that). If SIGNAL_P is non-zero,
1951 signal an error if FACE_NAME is not a valid face name. If SIGNAL_P
1952 is zero, value is nil if FACE_NAME is not a valid face name. */
1953 static Lisp_Object
1954 lface_from_face_name_no_resolve (struct frame *f, Lisp_Object face_name,
1955 int signal_p)
1957 Lisp_Object lface;
1959 if (f)
1960 lface = assq_no_quit (face_name, f->face_alist);
1961 else
1962 lface = assq_no_quit (face_name, Vface_new_frame_defaults);
1964 if (CONSP (lface))
1965 lface = XCDR (lface);
1966 else if (signal_p)
1967 signal_error ("Invalid face", face_name);
1969 check_lface (lface);
1971 return lface;
1974 /* Return the face definition of FACE_NAME on frame F. F null means
1975 return the definition for new frames. FACE_NAME may be a string or
1976 a symbol (apparently Emacs 20.2 allowed strings as face names in
1977 face text properties; Ediff uses that). If FACE_NAME is an alias
1978 for another face, return that face's definition. If SIGNAL_P is
1979 non-zero, signal an error if FACE_NAME is not a valid face name.
1980 If SIGNAL_P is zero, value is nil if FACE_NAME is not a valid face
1981 name. */
1982 static Lisp_Object
1983 lface_from_face_name (struct frame *f, Lisp_Object face_name, int signal_p)
1985 face_name = resolve_face_name (face_name, signal_p);
1986 return lface_from_face_name_no_resolve (f, face_name, signal_p);
1990 /* Get face attributes of face FACE_NAME from frame-local faces on
1991 frame F. Store the resulting attributes in ATTRS which must point
1992 to a vector of Lisp_Objects of size LFACE_VECTOR_SIZE. If SIGNAL_P
1993 is non-zero, signal an error if FACE_NAME does not name a face.
1994 Otherwise, value is zero if FACE_NAME is not a face. */
1996 static int
1997 get_lface_attributes_no_remap (struct frame *f, Lisp_Object face_name,
1998 Lisp_Object attrs[LFACE_VECTOR_SIZE],
1999 int signal_p)
2001 Lisp_Object lface;
2003 lface = lface_from_face_name_no_resolve (f, face_name, signal_p);
2005 if (! NILP (lface))
2006 memcpy (attrs, XVECTOR (lface)->contents,
2007 LFACE_VECTOR_SIZE * sizeof *attrs);
2009 return !NILP (lface);
2012 /* Get face attributes of face FACE_NAME from frame-local faces on frame
2013 F. Store the resulting attributes in ATTRS which must point to a
2014 vector of Lisp_Objects of size LFACE_VECTOR_SIZE. If FACE_NAME is an
2015 alias for another face, use that face's definition. If SIGNAL_P is
2016 non-zero, signal an error if FACE_NAME does not name a face.
2017 Otherwise, value is zero if FACE_NAME is not a face. */
2019 static int
2020 get_lface_attributes (struct frame *f, Lisp_Object face_name,
2021 Lisp_Object attrs[LFACE_VECTOR_SIZE], int signal_p,
2022 struct named_merge_point *named_merge_points)
2024 Lisp_Object face_remapping;
2026 face_name = resolve_face_name (face_name, signal_p);
2028 /* See if SYMBOL has been remapped to some other face (usually this
2029 is done buffer-locally). */
2030 face_remapping = assq_no_quit (face_name, Vface_remapping_alist);
2031 if (CONSP (face_remapping))
2033 struct named_merge_point named_merge_point;
2035 if (push_named_merge_point (&named_merge_point,
2036 face_name, NAMED_MERGE_POINT_REMAP,
2037 &named_merge_points))
2039 int i;
2041 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2042 attrs[i] = Qunspecified;
2044 return merge_face_ref (f, XCDR (face_remapping), attrs,
2045 signal_p, named_merge_points);
2049 /* Default case, no remapping. */
2050 return get_lface_attributes_no_remap (f, face_name, attrs, signal_p);
2054 /* Non-zero if all attributes in face attribute vector ATTRS are
2055 specified, i.e. are non-nil. */
2057 static int
2058 lface_fully_specified_p (Lisp_Object attrs[LFACE_VECTOR_SIZE])
2060 int i;
2062 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2063 if (i != LFACE_FONT_INDEX && i != LFACE_INHERIT_INDEX
2064 && i != LFACE_DISTANT_FOREGROUND_INDEX)
2065 if ((UNSPECIFIEDP (attrs[i]) || IGNORE_DEFFACE_P (attrs[i])))
2066 break;
2068 return i == LFACE_VECTOR_SIZE;
2071 #ifdef HAVE_WINDOW_SYSTEM
2073 /* Set font-related attributes of Lisp face LFACE from FONT-OBJECT.
2074 If FORCE_P is zero, set only unspecified attributes of LFACE. The
2075 exception is `font' attribute. It is set to FONT_OBJECT regardless
2076 of FORCE_P. */
2078 static int
2079 set_lface_from_font (struct frame *f, Lisp_Object lface,
2080 Lisp_Object font_object, int force_p)
2082 Lisp_Object val;
2083 struct font *font = XFONT_OBJECT (font_object);
2085 /* Set attributes only if unspecified, otherwise face defaults for
2086 new frames would never take effect. If the font doesn't have a
2087 specific property, set a normal value for that. */
2089 if (force_p || UNSPECIFIEDP (LFACE_FAMILY (lface)))
2091 Lisp_Object family = AREF (font_object, FONT_FAMILY_INDEX);
2093 ASET (lface, LFACE_FAMILY_INDEX, SYMBOL_NAME (family));
2096 if (force_p || UNSPECIFIEDP (LFACE_FOUNDRY (lface)))
2098 Lisp_Object foundry = AREF (font_object, FONT_FOUNDRY_INDEX);
2100 ASET (lface, LFACE_FOUNDRY_INDEX, SYMBOL_NAME (foundry));
2103 if (force_p || UNSPECIFIEDP (LFACE_HEIGHT (lface)))
2105 int pt = PIXEL_TO_POINT (font->pixel_size * 10, FRAME_RES_Y (f));
2107 eassert (pt > 0);
2108 ASET (lface, LFACE_HEIGHT_INDEX, make_number (pt));
2111 if (force_p || UNSPECIFIEDP (LFACE_WEIGHT (lface)))
2113 val = FONT_WEIGHT_FOR_FACE (font_object);
2114 ASET (lface, LFACE_WEIGHT_INDEX, ! NILP (val) ? val :Qnormal);
2116 if (force_p || UNSPECIFIEDP (LFACE_SLANT (lface)))
2118 val = FONT_SLANT_FOR_FACE (font_object);
2119 ASET (lface, LFACE_SLANT_INDEX, ! NILP (val) ? val : Qnormal);
2121 if (force_p || UNSPECIFIEDP (LFACE_SWIDTH (lface)))
2123 val = FONT_WIDTH_FOR_FACE (font_object);
2124 ASET (lface, LFACE_SWIDTH_INDEX, ! NILP (val) ? val : Qnormal);
2127 ASET (lface, LFACE_FONT_INDEX, font_object);
2128 return 1;
2131 #endif /* HAVE_WINDOW_SYSTEM */
2134 /* Merges the face height FROM with the face height TO, and returns the
2135 merged height. If FROM is an invalid height, then INVALID is
2136 returned instead. FROM and TO may be either absolute face heights or
2137 `relative' heights; the returned value is always an absolute height
2138 unless both FROM and TO are relative. */
2140 static Lisp_Object
2141 merge_face_heights (Lisp_Object from, Lisp_Object to, Lisp_Object invalid)
2143 Lisp_Object result = invalid;
2145 if (INTEGERP (from))
2146 /* FROM is absolute, just use it as is. */
2147 result = from;
2148 else if (FLOATP (from))
2149 /* FROM is a scale, use it to adjust TO. */
2151 if (INTEGERP (to))
2152 /* relative X absolute => absolute */
2153 result = make_number (XFLOAT_DATA (from) * XINT (to));
2154 else if (FLOATP (to))
2155 /* relative X relative => relative */
2156 result = make_float (XFLOAT_DATA (from) * XFLOAT_DATA (to));
2157 else if (UNSPECIFIEDP (to))
2158 result = from;
2160 else if (FUNCTIONP (from))
2161 /* FROM is a function, which use to adjust TO. */
2163 /* Call function with current height as argument.
2164 From is the new height. */
2165 result = safe_call1 (from, to);
2167 /* Ensure that if TO was absolute, so is the result. */
2168 if (INTEGERP (to) && !INTEGERP (result))
2169 result = invalid;
2172 return result;
2176 /* Merge two Lisp face attribute vectors on frame F, FROM and TO, and
2177 store the resulting attributes in TO, which must be already be
2178 completely specified and contain only absolute attributes. Every
2179 specified attribute of FROM overrides the corresponding attribute of
2180 TO; relative attributes in FROM are merged with the absolute value in
2181 TO and replace it. NAMED_MERGE_POINTS is used internally to detect
2182 loops in face inheritance/remapping; it should be 0 when called from
2183 other places. */
2185 static void
2186 merge_face_vectors (struct frame *f, Lisp_Object *from, Lisp_Object *to,
2187 struct named_merge_point *named_merge_points)
2189 int i;
2190 Lisp_Object font = Qnil;
2192 /* If FROM inherits from some other faces, merge their attributes into
2193 TO before merging FROM's direct attributes. Note that an :inherit
2194 attribute of `unspecified' is the same as one of nil; we never
2195 merge :inherit attributes, so nil is more correct, but lots of
2196 other code uses `unspecified' as a generic value for face attributes. */
2197 if (!UNSPECIFIEDP (from[LFACE_INHERIT_INDEX])
2198 && !NILP (from[LFACE_INHERIT_INDEX]))
2199 merge_face_ref (f, from[LFACE_INHERIT_INDEX], to, 0, named_merge_points);
2201 if (FONT_SPEC_P (from[LFACE_FONT_INDEX]))
2203 if (!UNSPECIFIEDP (to[LFACE_FONT_INDEX]))
2204 font = merge_font_spec (from[LFACE_FONT_INDEX], to[LFACE_FONT_INDEX]);
2205 else
2206 font = copy_font_spec (from[LFACE_FONT_INDEX]);
2207 to[LFACE_FONT_INDEX] = font;
2210 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2211 if (!UNSPECIFIEDP (from[i]))
2213 if (i == LFACE_HEIGHT_INDEX && !INTEGERP (from[i]))
2215 to[i] = merge_face_heights (from[i], to[i], to[i]);
2216 font_clear_prop (to, FONT_SIZE_INDEX);
2218 else if (i != LFACE_FONT_INDEX && ! EQ (to[i], from[i]))
2220 to[i] = from[i];
2221 if (i >= LFACE_FAMILY_INDEX && i <=LFACE_SLANT_INDEX)
2222 font_clear_prop (to,
2223 (i == LFACE_FAMILY_INDEX ? FONT_FAMILY_INDEX
2224 : i == LFACE_FOUNDRY_INDEX ? FONT_FOUNDRY_INDEX
2225 : i == LFACE_SWIDTH_INDEX ? FONT_WIDTH_INDEX
2226 : i == LFACE_HEIGHT_INDEX ? FONT_SIZE_INDEX
2227 : i == LFACE_WEIGHT_INDEX ? FONT_WEIGHT_INDEX
2228 : FONT_SLANT_INDEX));
2232 /* If FROM specifies a font spec, make its contents take precedence
2233 over :family and other attributes. This is needed for face
2234 remapping using :font to work. */
2236 if (!NILP (font))
2238 if (! NILP (AREF (font, FONT_FOUNDRY_INDEX)))
2239 to[LFACE_FOUNDRY_INDEX] = SYMBOL_NAME (AREF (font, FONT_FOUNDRY_INDEX));
2240 if (! NILP (AREF (font, FONT_FAMILY_INDEX)))
2241 to[LFACE_FAMILY_INDEX] = SYMBOL_NAME (AREF (font, FONT_FAMILY_INDEX));
2242 if (! NILP (AREF (font, FONT_WEIGHT_INDEX)))
2243 to[LFACE_WEIGHT_INDEX] = FONT_WEIGHT_FOR_FACE (font);
2244 if (! NILP (AREF (font, FONT_SLANT_INDEX)))
2245 to[LFACE_SLANT_INDEX] = FONT_SLANT_FOR_FACE (font);
2246 if (! NILP (AREF (font, FONT_WIDTH_INDEX)))
2247 to[LFACE_SWIDTH_INDEX] = FONT_WIDTH_FOR_FACE (font);
2248 ASET (font, FONT_SIZE_INDEX, Qnil);
2251 /* TO is always an absolute face, which should inherit from nothing.
2252 We blindly copy the :inherit attribute above and fix it up here. */
2253 to[LFACE_INHERIT_INDEX] = Qnil;
2256 /* Merge the named face FACE_NAME on frame F, into the vector of face
2257 attributes TO. NAMED_MERGE_POINTS is used to detect loops in face
2258 inheritance. Returns true if FACE_NAME is a valid face name and
2259 merging succeeded. */
2261 static int
2262 merge_named_face (struct frame *f, Lisp_Object face_name, Lisp_Object *to,
2263 struct named_merge_point *named_merge_points)
2265 struct named_merge_point named_merge_point;
2267 if (push_named_merge_point (&named_merge_point,
2268 face_name, NAMED_MERGE_POINT_NORMAL,
2269 &named_merge_points))
2271 struct gcpro gcpro1;
2272 Lisp_Object from[LFACE_VECTOR_SIZE];
2273 int ok = get_lface_attributes (f, face_name, from, 0, named_merge_points);
2275 if (ok)
2277 GCPRO1 (named_merge_point.face_name);
2278 merge_face_vectors (f, from, to, named_merge_points);
2279 UNGCPRO;
2282 return ok;
2284 else
2285 return 0;
2289 /* Merge face attributes from the lisp `face reference' FACE_REF on
2290 frame F into the face attribute vector TO. If ERR_MSGS is non-zero,
2291 problems with FACE_REF cause an error message to be shown. Return
2292 non-zero if no errors occurred (regardless of the value of ERR_MSGS).
2293 NAMED_MERGE_POINTS is used to detect loops in face inheritance or
2294 list structure; it may be 0 for most callers.
2296 FACE_REF may be a single face specification or a list of such
2297 specifications. Each face specification can be:
2299 1. A symbol or string naming a Lisp face.
2301 2. A property list of the form (KEYWORD VALUE ...) where each
2302 KEYWORD is a face attribute name, and value is an appropriate value
2303 for that attribute.
2305 3. Conses or the form (FOREGROUND-COLOR . COLOR) or
2306 (BACKGROUND-COLOR . COLOR) where COLOR is a color name. This is
2307 for compatibility with 20.2.
2309 Face specifications earlier in lists take precedence over later
2310 specifications. */
2312 static int
2313 merge_face_ref (struct frame *f, Lisp_Object face_ref, Lisp_Object *to,
2314 int err_msgs, struct named_merge_point *named_merge_points)
2316 int ok = 1; /* Succeed without an error? */
2318 if (CONSP (face_ref))
2320 Lisp_Object first = XCAR (face_ref);
2322 if (EQ (first, Qforeground_color)
2323 || EQ (first, Qbackground_color))
2325 /* One of (FOREGROUND-COLOR . COLOR) or (BACKGROUND-COLOR
2326 . COLOR). COLOR must be a string. */
2327 Lisp_Object color_name = XCDR (face_ref);
2328 Lisp_Object color = first;
2330 if (STRINGP (color_name))
2332 if (EQ (color, Qforeground_color))
2333 to[LFACE_FOREGROUND_INDEX] = color_name;
2334 else
2335 to[LFACE_BACKGROUND_INDEX] = color_name;
2337 else
2339 if (err_msgs)
2340 add_to_log ("Invalid face color", color_name, Qnil);
2341 ok = 0;
2344 else if (SYMBOLP (first)
2345 && *SDATA (SYMBOL_NAME (first)) == ':')
2347 /* Assume this is the property list form. */
2348 while (CONSP (face_ref) && CONSP (XCDR (face_ref)))
2350 Lisp_Object keyword = XCAR (face_ref);
2351 Lisp_Object value = XCAR (XCDR (face_ref));
2352 int err = 0;
2354 /* Specifying `unspecified' is a no-op. */
2355 if (EQ (value, Qunspecified))
2357 else if (EQ (keyword, QCfamily))
2359 if (STRINGP (value))
2361 to[LFACE_FAMILY_INDEX] = value;
2362 font_clear_prop (to, FONT_FAMILY_INDEX);
2364 else
2365 err = 1;
2367 else if (EQ (keyword, QCfoundry))
2369 if (STRINGP (value))
2371 to[LFACE_FOUNDRY_INDEX] = value;
2372 font_clear_prop (to, FONT_FOUNDRY_INDEX);
2374 else
2375 err = 1;
2377 else if (EQ (keyword, QCheight))
2379 Lisp_Object new_height =
2380 merge_face_heights (value, to[LFACE_HEIGHT_INDEX], Qnil);
2382 if (! NILP (new_height))
2384 to[LFACE_HEIGHT_INDEX] = new_height;
2385 font_clear_prop (to, FONT_SIZE_INDEX);
2387 else
2388 err = 1;
2390 else if (EQ (keyword, QCweight))
2392 if (SYMBOLP (value) && FONT_WEIGHT_NAME_NUMERIC (value) >= 0)
2394 to[LFACE_WEIGHT_INDEX] = value;
2395 font_clear_prop (to, FONT_WEIGHT_INDEX);
2397 else
2398 err = 1;
2400 else if (EQ (keyword, QCslant))
2402 if (SYMBOLP (value) && FONT_SLANT_NAME_NUMERIC (value) >= 0)
2404 to[LFACE_SLANT_INDEX] = value;
2405 font_clear_prop (to, FONT_SLANT_INDEX);
2407 else
2408 err = 1;
2410 else if (EQ (keyword, QCunderline))
2412 if (EQ (value, Qt)
2413 || NILP (value)
2414 || STRINGP (value)
2415 || CONSP (value))
2416 to[LFACE_UNDERLINE_INDEX] = value;
2417 else
2418 err = 1;
2420 else if (EQ (keyword, QCoverline))
2422 if (EQ (value, Qt)
2423 || NILP (value)
2424 || STRINGP (value))
2425 to[LFACE_OVERLINE_INDEX] = value;
2426 else
2427 err = 1;
2429 else if (EQ (keyword, QCstrike_through))
2431 if (EQ (value, Qt)
2432 || NILP (value)
2433 || STRINGP (value))
2434 to[LFACE_STRIKE_THROUGH_INDEX] = value;
2435 else
2436 err = 1;
2438 else if (EQ (keyword, QCbox))
2440 if (EQ (value, Qt))
2441 value = make_number (1);
2442 if (INTEGERP (value)
2443 || STRINGP (value)
2444 || CONSP (value)
2445 || NILP (value))
2446 to[LFACE_BOX_INDEX] = value;
2447 else
2448 err = 1;
2450 else if (EQ (keyword, QCinverse_video)
2451 || EQ (keyword, QCreverse_video))
2453 if (EQ (value, Qt) || NILP (value))
2454 to[LFACE_INVERSE_INDEX] = value;
2455 else
2456 err = 1;
2458 else if (EQ (keyword, QCforeground))
2460 if (STRINGP (value))
2461 to[LFACE_FOREGROUND_INDEX] = value;
2462 else
2463 err = 1;
2465 else if (EQ (keyword, QCdistant_foreground))
2467 if (STRINGP (value))
2468 to[LFACE_DISTANT_FOREGROUND_INDEX] = value;
2469 else
2470 err = 1;
2472 else if (EQ (keyword, QCbackground))
2474 if (STRINGP (value))
2475 to[LFACE_BACKGROUND_INDEX] = value;
2476 else
2477 err = 1;
2479 else if (EQ (keyword, QCstipple))
2481 #if defined (HAVE_WINDOW_SYSTEM)
2482 Lisp_Object pixmap_p = Fbitmap_spec_p (value);
2483 if (!NILP (pixmap_p))
2484 to[LFACE_STIPPLE_INDEX] = value;
2485 else
2486 err = 1;
2487 #endif /* HAVE_WINDOW_SYSTEM */
2489 else if (EQ (keyword, QCwidth))
2491 if (SYMBOLP (value) && FONT_WIDTH_NAME_NUMERIC (value) >= 0)
2493 to[LFACE_SWIDTH_INDEX] = value;
2494 font_clear_prop (to, FONT_WIDTH_INDEX);
2496 else
2497 err = 1;
2499 else if (EQ (keyword, QCfont))
2501 if (FONTP (value))
2502 to[LFACE_FONT_INDEX] = value;
2503 else
2504 err = 1;
2506 else if (EQ (keyword, QCinherit))
2508 /* This is not really very useful; it's just like a
2509 normal face reference. */
2510 if (! merge_face_ref (f, value, to,
2511 err_msgs, named_merge_points))
2512 err = 1;
2514 else
2515 err = 1;
2517 if (err)
2519 add_to_log ("Invalid face attribute %S %S", keyword, value);
2520 ok = 0;
2523 face_ref = XCDR (XCDR (face_ref));
2526 else
2528 /* This is a list of face refs. Those at the beginning of the
2529 list take precedence over what follows, so we have to merge
2530 from the end backwards. */
2531 Lisp_Object next = XCDR (face_ref);
2533 if (! NILP (next))
2534 ok = merge_face_ref (f, next, to, err_msgs, named_merge_points);
2536 if (! merge_face_ref (f, first, to, err_msgs, named_merge_points))
2537 ok = 0;
2540 else
2542 /* FACE_REF ought to be a face name. */
2543 ok = merge_named_face (f, face_ref, to, named_merge_points);
2544 if (!ok && err_msgs)
2545 add_to_log ("Invalid face reference: %s", face_ref, Qnil);
2548 return ok;
2552 DEFUN ("internal-make-lisp-face", Finternal_make_lisp_face,
2553 Sinternal_make_lisp_face, 1, 2, 0,
2554 doc: /* Make FACE, a symbol, a Lisp face with all attributes nil.
2555 If FACE was not known as a face before, create a new one.
2556 If optional argument FRAME is specified, make a frame-local face
2557 for that frame. Otherwise operate on the global face definition.
2558 Value is a vector of face attributes. */)
2559 (Lisp_Object face, Lisp_Object frame)
2561 Lisp_Object global_lface, lface;
2562 struct frame *f;
2563 int i;
2565 CHECK_SYMBOL (face);
2566 global_lface = lface_from_face_name (NULL, face, 0);
2568 if (!NILP (frame))
2570 CHECK_LIVE_FRAME (frame);
2571 f = XFRAME (frame);
2572 lface = lface_from_face_name (f, face, 0);
2574 else
2575 f = NULL, lface = Qnil;
2577 /* Add a global definition if there is none. */
2578 if (NILP (global_lface))
2580 global_lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
2581 Qunspecified);
2582 ASET (global_lface, 0, Qface);
2583 Vface_new_frame_defaults = Fcons (Fcons (face, global_lface),
2584 Vface_new_frame_defaults);
2586 /* Assign the new Lisp face a unique ID. The mapping from Lisp
2587 face id to Lisp face is given by the vector lface_id_to_name.
2588 The mapping from Lisp face to Lisp face id is given by the
2589 property `face' of the Lisp face name. */
2590 if (next_lface_id == lface_id_to_name_size)
2591 lface_id_to_name =
2592 xpalloc (lface_id_to_name, &lface_id_to_name_size, 1, MAX_FACE_ID,
2593 sizeof *lface_id_to_name);
2595 lface_id_to_name[next_lface_id] = face;
2596 Fput (face, Qface, make_number (next_lface_id));
2597 ++next_lface_id;
2599 else if (f == NULL)
2600 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2601 ASET (global_lface, i, Qunspecified);
2603 /* Add a frame-local definition. */
2604 if (f)
2606 if (NILP (lface))
2608 lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
2609 Qunspecified);
2610 ASET (lface, 0, Qface);
2611 fset_face_alist (f, Fcons (Fcons (face, lface), f->face_alist));
2613 else
2614 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2615 ASET (lface, i, Qunspecified);
2617 else
2618 lface = global_lface;
2620 /* Changing a named face means that all realized faces depending on
2621 that face are invalid. Since we cannot tell which realized faces
2622 depend on the face, make sure they are all removed. This is done
2623 by incrementing face_change_count. The next call to
2624 init_iterator will then free realized faces. */
2625 if (NILP (Fget (face, Qface_no_inherit)))
2627 ++face_change_count;
2628 windows_or_buffers_changed = 54;
2631 eassert (LFACEP (lface));
2632 check_lface (lface);
2633 return lface;
2637 DEFUN ("internal-lisp-face-p", Finternal_lisp_face_p,
2638 Sinternal_lisp_face_p, 1, 2, 0,
2639 doc: /* Return non-nil if FACE names a face.
2640 FACE should be a symbol or string.
2641 If optional second argument FRAME is non-nil, check for the
2642 existence of a frame-local face with name FACE on that frame.
2643 Otherwise check for the existence of a global face. */)
2644 (Lisp_Object face, Lisp_Object frame)
2646 Lisp_Object lface;
2648 face = resolve_face_name (face, 1);
2650 if (!NILP (frame))
2652 CHECK_LIVE_FRAME (frame);
2653 lface = lface_from_face_name (XFRAME (frame), face, 0);
2655 else
2656 lface = lface_from_face_name (NULL, face, 0);
2658 return lface;
2662 DEFUN ("internal-copy-lisp-face", Finternal_copy_lisp_face,
2663 Sinternal_copy_lisp_face, 4, 4, 0,
2664 doc: /* Copy face FROM to TO.
2665 If FRAME is t, copy the global face definition of FROM.
2666 Otherwise, copy the frame-local definition of FROM on FRAME.
2667 If NEW-FRAME is a frame, copy that data into the frame-local
2668 definition of TO on NEW-FRAME. If NEW-FRAME is nil,
2669 FRAME controls where the data is copied to.
2671 The value is TO. */)
2672 (Lisp_Object from, Lisp_Object to, Lisp_Object frame, Lisp_Object new_frame)
2674 Lisp_Object lface, copy;
2676 CHECK_SYMBOL (from);
2677 CHECK_SYMBOL (to);
2679 if (EQ (frame, Qt))
2681 /* Copy global definition of FROM. We don't make copies of
2682 strings etc. because 20.2 didn't do it either. */
2683 lface = lface_from_face_name (NULL, from, 1);
2684 copy = Finternal_make_lisp_face (to, Qnil);
2686 else
2688 /* Copy frame-local definition of FROM. */
2689 if (NILP (new_frame))
2690 new_frame = frame;
2691 CHECK_LIVE_FRAME (frame);
2692 CHECK_LIVE_FRAME (new_frame);
2693 lface = lface_from_face_name (XFRAME (frame), from, 1);
2694 copy = Finternal_make_lisp_face (to, new_frame);
2697 vcopy (copy, 0, XVECTOR (lface)->contents, LFACE_VECTOR_SIZE);
2699 /* Changing a named face means that all realized faces depending on
2700 that face are invalid. Since we cannot tell which realized faces
2701 depend on the face, make sure they are all removed. This is done
2702 by incrementing face_change_count. The next call to
2703 init_iterator will then free realized faces. */
2704 if (NILP (Fget (to, Qface_no_inherit)))
2706 ++face_change_count;
2707 windows_or_buffers_changed = 55;
2710 return to;
2714 DEFUN ("internal-set-lisp-face-attribute", Finternal_set_lisp_face_attribute,
2715 Sinternal_set_lisp_face_attribute, 3, 4, 0,
2716 doc: /* Set attribute ATTR of FACE to VALUE.
2717 FRAME being a frame means change the face on that frame.
2718 FRAME nil means change the face of the selected frame.
2719 FRAME t means change the default for new frames.
2720 FRAME 0 means change the face on all frames, and change the default
2721 for new frames. */)
2722 (Lisp_Object face, Lisp_Object attr, Lisp_Object value, Lisp_Object frame)
2724 Lisp_Object lface;
2725 Lisp_Object old_value = Qnil;
2726 /* Set one of enum font_property_index (> 0) if ATTR is one of
2727 font-related attributes other than QCfont and QCfontset. */
2728 enum font_property_index prop_index = 0;
2730 CHECK_SYMBOL (face);
2731 CHECK_SYMBOL (attr);
2733 face = resolve_face_name (face, 1);
2735 /* If FRAME is 0, change face on all frames, and change the
2736 default for new frames. */
2737 if (INTEGERP (frame) && XINT (frame) == 0)
2739 Lisp_Object tail;
2740 Finternal_set_lisp_face_attribute (face, attr, value, Qt);
2741 FOR_EACH_FRAME (tail, frame)
2742 Finternal_set_lisp_face_attribute (face, attr, value, frame);
2743 return face;
2746 /* Set lface to the Lisp attribute vector of FACE. */
2747 if (EQ (frame, Qt))
2749 lface = lface_from_face_name (NULL, face, 1);
2751 /* When updating face-new-frame-defaults, we put :ignore-defface
2752 where the caller wants `unspecified'. This forces the frame
2753 defaults to ignore the defface value. Otherwise, the defface
2754 will take effect, which is generally not what is intended.
2755 The value of that attribute will be inherited from some other
2756 face during face merging. See internal_merge_in_global_face. */
2757 if (UNSPECIFIEDP (value))
2758 value = QCignore_defface;
2760 else
2762 if (NILP (frame))
2763 frame = selected_frame;
2765 CHECK_LIVE_FRAME (frame);
2766 lface = lface_from_face_name (XFRAME (frame), face, 0);
2768 /* If a frame-local face doesn't exist yet, create one. */
2769 if (NILP (lface))
2770 lface = Finternal_make_lisp_face (face, frame);
2773 if (EQ (attr, QCfamily))
2775 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2777 CHECK_STRING (value);
2778 if (SCHARS (value) == 0)
2779 signal_error ("Invalid face family", value);
2781 old_value = LFACE_FAMILY (lface);
2782 ASET (lface, LFACE_FAMILY_INDEX, value);
2783 prop_index = FONT_FAMILY_INDEX;
2785 else if (EQ (attr, QCfoundry))
2787 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2789 CHECK_STRING (value);
2790 if (SCHARS (value) == 0)
2791 signal_error ("Invalid face foundry", value);
2793 old_value = LFACE_FOUNDRY (lface);
2794 ASET (lface, LFACE_FOUNDRY_INDEX, value);
2795 prop_index = FONT_FOUNDRY_INDEX;
2797 else if (EQ (attr, QCheight))
2799 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2801 if (EQ (face, Qdefault))
2803 /* The default face must have an absolute size. */
2804 if (!INTEGERP (value) || XINT (value) <= 0)
2805 signal_error ("Default face height not absolute and positive",
2806 value);
2808 else
2810 /* For non-default faces, do a test merge with a random
2811 height to see if VALUE's ok. */
2812 Lisp_Object test = merge_face_heights (value,
2813 make_number (10),
2814 Qnil);
2815 if (!INTEGERP (test) || XINT (test) <= 0)
2816 signal_error ("Face height does not produce a positive integer",
2817 value);
2821 old_value = LFACE_HEIGHT (lface);
2822 ASET (lface, LFACE_HEIGHT_INDEX, value);
2823 prop_index = FONT_SIZE_INDEX;
2825 else if (EQ (attr, QCweight))
2827 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2829 CHECK_SYMBOL (value);
2830 if (FONT_WEIGHT_NAME_NUMERIC (value) < 0)
2831 signal_error ("Invalid face weight", value);
2833 old_value = LFACE_WEIGHT (lface);
2834 ASET (lface, LFACE_WEIGHT_INDEX, value);
2835 prop_index = FONT_WEIGHT_INDEX;
2837 else if (EQ (attr, QCslant))
2839 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2841 CHECK_SYMBOL (value);
2842 if (FONT_SLANT_NAME_NUMERIC (value) < 0)
2843 signal_error ("Invalid face slant", value);
2845 old_value = LFACE_SLANT (lface);
2846 ASET (lface, LFACE_SLANT_INDEX, value);
2847 prop_index = FONT_SLANT_INDEX;
2849 else if (EQ (attr, QCunderline))
2851 bool valid_p = 0;
2853 if (UNSPECIFIEDP (value) || IGNORE_DEFFACE_P (value))
2854 valid_p = 1;
2855 else if (NILP (value) || EQ (value, Qt))
2856 valid_p = 1;
2857 else if (STRINGP (value) && SCHARS (value) > 0)
2858 valid_p = 1;
2859 else if (CONSP (value))
2861 Lisp_Object key, val, list;
2863 list = value;
2864 /* FIXME? This errs on the side of acceptance. Eg it accepts:
2865 (defface foo '((t :underline 'foo) "doc")
2866 Maybe this is intentional, maybe it isn't.
2867 Non-nil symbols other than t are not documented as being valid.
2868 Eg compare with inverse-video, which explicitly rejects them.
2870 valid_p = 1;
2872 while (!NILP (CAR_SAFE(list)))
2874 key = CAR_SAFE (list);
2875 list = CDR_SAFE (list);
2876 val = CAR_SAFE (list);
2877 list = CDR_SAFE (list);
2879 if (NILP (key) || NILP (val))
2881 valid_p = 0;
2882 break;
2885 else if (EQ (key, QCcolor)
2886 && !(EQ (val, Qforeground_color)
2887 || (STRINGP (val) && SCHARS (val) > 0)))
2889 valid_p = 0;
2890 break;
2893 else if (EQ (key, QCstyle)
2894 && !(EQ (val, Qline) || EQ (val, Qwave)))
2896 valid_p = 0;
2897 break;
2902 if (!valid_p)
2903 signal_error ("Invalid face underline", value);
2905 old_value = LFACE_UNDERLINE (lface);
2906 ASET (lface, LFACE_UNDERLINE_INDEX, value);
2908 else if (EQ (attr, QCoverline))
2910 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2911 if ((SYMBOLP (value)
2912 && !EQ (value, Qt)
2913 && !EQ (value, Qnil))
2914 /* Overline color. */
2915 || (STRINGP (value)
2916 && SCHARS (value) == 0))
2917 signal_error ("Invalid face overline", value);
2919 old_value = LFACE_OVERLINE (lface);
2920 ASET (lface, LFACE_OVERLINE_INDEX, value);
2922 else if (EQ (attr, QCstrike_through))
2924 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2925 if ((SYMBOLP (value)
2926 && !EQ (value, Qt)
2927 && !EQ (value, Qnil))
2928 /* Strike-through color. */
2929 || (STRINGP (value)
2930 && SCHARS (value) == 0))
2931 signal_error ("Invalid face strike-through", value);
2933 old_value = LFACE_STRIKE_THROUGH (lface);
2934 ASET (lface, LFACE_STRIKE_THROUGH_INDEX, value);
2936 else if (EQ (attr, QCbox))
2938 bool valid_p;
2940 /* Allow t meaning a simple box of width 1 in foreground color
2941 of the face. */
2942 if (EQ (value, Qt))
2943 value = make_number (1);
2945 if (UNSPECIFIEDP (value) || IGNORE_DEFFACE_P (value))
2946 valid_p = 1;
2947 else if (NILP (value))
2948 valid_p = 1;
2949 else if (INTEGERP (value))
2950 valid_p = XINT (value) != 0;
2951 else if (STRINGP (value))
2952 valid_p = SCHARS (value) > 0;
2953 else if (CONSP (value))
2955 Lisp_Object tem;
2957 tem = value;
2958 while (CONSP (tem))
2960 Lisp_Object k, v;
2962 k = XCAR (tem);
2963 tem = XCDR (tem);
2964 if (!CONSP (tem))
2965 break;
2966 v = XCAR (tem);
2967 tem = XCDR (tem);
2969 if (EQ (k, QCline_width))
2971 if (!INTEGERP (v) || XINT (v) == 0)
2972 break;
2974 else if (EQ (k, QCcolor))
2976 if (!NILP (v) && (!STRINGP (v) || SCHARS (v) == 0))
2977 break;
2979 else if (EQ (k, QCstyle))
2981 if (!EQ (v, Qpressed_button) && !EQ (v, Qreleased_button))
2982 break;
2984 else
2985 break;
2988 valid_p = NILP (tem);
2990 else
2991 valid_p = 0;
2993 if (!valid_p)
2994 signal_error ("Invalid face box", value);
2996 old_value = LFACE_BOX (lface);
2997 ASET (lface, LFACE_BOX_INDEX, value);
2999 else if (EQ (attr, QCinverse_video)
3000 || EQ (attr, QCreverse_video))
3002 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3004 CHECK_SYMBOL (value);
3005 if (!EQ (value, Qt) && !NILP (value))
3006 signal_error ("Invalid inverse-video face attribute value", value);
3008 old_value = LFACE_INVERSE (lface);
3009 ASET (lface, LFACE_INVERSE_INDEX, value);
3011 else if (EQ (attr, QCforeground))
3013 /* Compatibility with 20.x. */
3014 if (NILP (value))
3015 value = Qunspecified;
3016 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3018 /* Don't check for valid color names here because it depends
3019 on the frame (display) whether the color will be valid
3020 when the face is realized. */
3021 CHECK_STRING (value);
3022 if (SCHARS (value) == 0)
3023 signal_error ("Empty foreground color value", value);
3025 old_value = LFACE_FOREGROUND (lface);
3026 ASET (lface, LFACE_FOREGROUND_INDEX, value);
3028 else if (EQ (attr, QCdistant_foreground))
3030 /* Compatibility with 20.x. */
3031 if (NILP (value))
3032 value = Qunspecified;
3033 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3035 /* Don't check for valid color names here because it depends
3036 on the frame (display) whether the color will be valid
3037 when the face is realized. */
3038 CHECK_STRING (value);
3039 if (SCHARS (value) == 0)
3040 signal_error ("Empty distant-foreground color value", value);
3042 old_value = LFACE_DISTANT_FOREGROUND (lface);
3043 ASET (lface, LFACE_DISTANT_FOREGROUND_INDEX, value);
3045 else if (EQ (attr, QCbackground))
3047 /* Compatibility with 20.x. */
3048 if (NILP (value))
3049 value = Qunspecified;
3050 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3052 /* Don't check for valid color names here because it depends
3053 on the frame (display) whether the color will be valid
3054 when the face is realized. */
3055 CHECK_STRING (value);
3056 if (SCHARS (value) == 0)
3057 signal_error ("Empty background color value", value);
3059 old_value = LFACE_BACKGROUND (lface);
3060 ASET (lface, LFACE_BACKGROUND_INDEX, value);
3062 else if (EQ (attr, QCstipple))
3064 #if defined (HAVE_WINDOW_SYSTEM)
3065 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value)
3066 && !NILP (value)
3067 && NILP (Fbitmap_spec_p (value)))
3068 signal_error ("Invalid stipple attribute", value);
3069 old_value = LFACE_STIPPLE (lface);
3070 ASET (lface, LFACE_STIPPLE_INDEX, value);
3071 #endif /* HAVE_WINDOW_SYSTEM */
3073 else if (EQ (attr, QCwidth))
3075 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3077 CHECK_SYMBOL (value);
3078 if (FONT_WIDTH_NAME_NUMERIC (value) < 0)
3079 signal_error ("Invalid face width", value);
3081 old_value = LFACE_SWIDTH (lface);
3082 ASET (lface, LFACE_SWIDTH_INDEX, value);
3083 prop_index = FONT_WIDTH_INDEX;
3085 else if (EQ (attr, QCfont))
3087 #ifdef HAVE_WINDOW_SYSTEM
3088 if (EQ (frame, Qt) || FRAME_WINDOW_P (XFRAME (frame)))
3090 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3092 struct frame *f;
3094 old_value = LFACE_FONT (lface);
3095 if (! FONTP (value))
3097 if (STRINGP (value))
3099 Lisp_Object name = value;
3100 int fontset = fs_query_fontset (name, 0);
3102 if (fontset >= 0)
3103 name = fontset_ascii (fontset);
3104 value = font_spec_from_name (name);
3105 if (!FONTP (value))
3106 signal_error ("Invalid font name", name);
3108 else
3109 signal_error ("Invalid font or font-spec", value);
3111 if (EQ (frame, Qt))
3112 f = XFRAME (selected_frame);
3113 else
3114 f = XFRAME (frame);
3115 if (! FONT_OBJECT_P (value))
3117 Lisp_Object *attrs = XVECTOR (lface)->contents;
3118 Lisp_Object font_object;
3120 font_object = font_load_for_lface (f, attrs, value);
3121 if (NILP (font_object))
3122 signal_error ("Font not available", value);
3123 value = font_object;
3125 set_lface_from_font (f, lface, value, 1);
3127 else
3128 ASET (lface, LFACE_FONT_INDEX, value);
3130 #endif /* HAVE_WINDOW_SYSTEM */
3132 else if (EQ (attr, QCfontset))
3134 #ifdef HAVE_WINDOW_SYSTEM
3135 if (EQ (frame, Qt) || FRAME_WINDOW_P (XFRAME (frame)))
3137 Lisp_Object tmp;
3139 old_value = LFACE_FONTSET (lface);
3140 tmp = Fquery_fontset (value, Qnil);
3141 if (NILP (tmp))
3142 signal_error ("Invalid fontset name", value);
3143 ASET (lface, LFACE_FONTSET_INDEX, value = tmp);
3145 #endif /* HAVE_WINDOW_SYSTEM */
3147 else if (EQ (attr, QCinherit))
3149 Lisp_Object tail;
3150 if (SYMBOLP (value))
3151 tail = Qnil;
3152 else
3153 for (tail = value; CONSP (tail); tail = XCDR (tail))
3154 if (!SYMBOLP (XCAR (tail)))
3155 break;
3156 if (NILP (tail))
3157 ASET (lface, LFACE_INHERIT_INDEX, value);
3158 else
3159 signal_error ("Invalid face inheritance", value);
3161 else if (EQ (attr, QCbold))
3163 old_value = LFACE_WEIGHT (lface);
3164 ASET (lface, LFACE_WEIGHT_INDEX, NILP (value) ? Qnormal : Qbold);
3165 prop_index = FONT_WEIGHT_INDEX;
3167 else if (EQ (attr, QCitalic))
3169 attr = QCslant;
3170 old_value = LFACE_SLANT (lface);
3171 ASET (lface, LFACE_SLANT_INDEX, NILP (value) ? Qnormal : Qitalic);
3172 prop_index = FONT_SLANT_INDEX;
3174 else
3175 signal_error ("Invalid face attribute name", attr);
3177 if (prop_index)
3179 /* If a font-related attribute other than QCfont and QCfontset
3180 is specified, and if the original QCfont attribute has a font
3181 (font-spec or font-object), set the corresponding property in
3182 the font to nil so that the font selector doesn't think that
3183 the attribute is mandatory. Also, clear the average
3184 width. */
3185 font_clear_prop (XVECTOR (lface)->contents, prop_index);
3188 /* Changing a named face means that all realized faces depending on
3189 that face are invalid. Since we cannot tell which realized faces
3190 depend on the face, make sure they are all removed. This is done
3191 by incrementing face_change_count. The next call to
3192 init_iterator will then free realized faces. */
3193 if (!EQ (frame, Qt)
3194 && NILP (Fget (face, Qface_no_inherit))
3195 && NILP (Fequal (old_value, value)))
3197 ++face_change_count;
3198 windows_or_buffers_changed = 56;
3201 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value)
3202 && NILP (Fequal (old_value, value)))
3204 Lisp_Object param;
3206 param = Qnil;
3208 if (EQ (face, Qdefault))
3210 #ifdef HAVE_WINDOW_SYSTEM
3211 /* Changed font-related attributes of the `default' face are
3212 reflected in changed `font' frame parameters. */
3213 if (FRAMEP (frame)
3214 && (prop_index || EQ (attr, QCfont))
3215 && lface_fully_specified_p (XVECTOR (lface)->contents))
3216 set_font_frame_param (frame, lface);
3217 else
3218 #endif /* HAVE_WINDOW_SYSTEM */
3220 if (EQ (attr, QCforeground))
3221 param = Qforeground_color;
3222 else if (EQ (attr, QCbackground))
3223 param = Qbackground_color;
3225 #ifdef HAVE_WINDOW_SYSTEM
3226 #ifndef HAVE_NTGUI
3227 else if (EQ (face, Qscroll_bar))
3229 /* Changing the colors of `scroll-bar' sets frame parameters
3230 `scroll-bar-foreground' and `scroll-bar-background'. */
3231 if (EQ (attr, QCforeground))
3232 param = Qscroll_bar_foreground;
3233 else if (EQ (attr, QCbackground))
3234 param = Qscroll_bar_background;
3236 #endif /* not HAVE_NTGUI */
3237 else if (EQ (face, Qborder))
3239 /* Changing background color of `border' sets frame parameter
3240 `border-color'. */
3241 if (EQ (attr, QCbackground))
3242 param = Qborder_color;
3244 else if (EQ (face, Qcursor))
3246 /* Changing background color of `cursor' sets frame parameter
3247 `cursor-color'. */
3248 if (EQ (attr, QCbackground))
3249 param = Qcursor_color;
3251 else if (EQ (face, Qmouse))
3253 /* Changing background color of `mouse' sets frame parameter
3254 `mouse-color'. */
3255 if (EQ (attr, QCbackground))
3256 param = Qmouse_color;
3258 #endif /* HAVE_WINDOW_SYSTEM */
3259 else if (EQ (face, Qmenu))
3261 /* Indicate that we have to update the menu bar when realizing
3262 faces on FRAME. FRAME t change the default for new frames.
3263 We do this by setting the flag in new face caches. */
3264 if (FRAMEP (frame))
3266 struct frame *f = XFRAME (frame);
3267 if (FRAME_FACE_CACHE (f) == NULL)
3268 FRAME_FACE_CACHE (f) = make_face_cache (f);
3269 FRAME_FACE_CACHE (f)->menu_face_changed_p = 1;
3271 else
3272 menu_face_changed_default = 1;
3275 if (!NILP (param))
3277 if (EQ (frame, Qt))
3278 /* Update `default-frame-alist', which is used for new frames. */
3280 store_in_alist (&Vdefault_frame_alist, param, value);
3282 else
3283 /* Update the current frame's parameters. */
3285 Lisp_Object cons;
3286 cons = XCAR (Vparam_value_alist);
3287 XSETCAR (cons, param);
3288 XSETCDR (cons, value);
3289 Fmodify_frame_parameters (frame, Vparam_value_alist);
3294 return face;
3298 /* Update the corresponding face when frame parameter PARAM on frame F
3299 has been assigned the value NEW_VALUE. */
3301 void
3302 update_face_from_frame_parameter (struct frame *f, Lisp_Object param,
3303 Lisp_Object new_value)
3305 Lisp_Object face = Qnil;
3306 Lisp_Object lface;
3308 /* If there are no faces yet, give up. This is the case when called
3309 from Fx_create_frame, and we do the necessary things later in
3310 face-set-after-frame-defaults. */
3311 if (NILP (f->face_alist))
3312 return;
3314 if (EQ (param, Qforeground_color))
3316 face = Qdefault;
3317 lface = lface_from_face_name (f, face, 1);
3318 ASET (lface, LFACE_FOREGROUND_INDEX,
3319 (STRINGP (new_value) ? new_value : Qunspecified));
3320 realize_basic_faces (f);
3322 else if (EQ (param, Qbackground_color))
3324 Lisp_Object frame;
3326 /* Changing the background color might change the background
3327 mode, so that we have to load new defface specs.
3328 Call frame-set-background-mode to do that. */
3329 XSETFRAME (frame, f);
3330 call1 (Qframe_set_background_mode, frame);
3332 face = Qdefault;
3333 lface = lface_from_face_name (f, face, 1);
3334 ASET (lface, LFACE_BACKGROUND_INDEX,
3335 (STRINGP (new_value) ? new_value : Qunspecified));
3336 realize_basic_faces (f);
3338 #ifdef HAVE_WINDOW_SYSTEM
3339 else if (EQ (param, Qborder_color))
3341 face = Qborder;
3342 lface = lface_from_face_name (f, face, 1);
3343 ASET (lface, LFACE_BACKGROUND_INDEX,
3344 (STRINGP (new_value) ? new_value : Qunspecified));
3346 else if (EQ (param, Qcursor_color))
3348 face = Qcursor;
3349 lface = lface_from_face_name (f, face, 1);
3350 ASET (lface, LFACE_BACKGROUND_INDEX,
3351 (STRINGP (new_value) ? new_value : Qunspecified));
3353 else if (EQ (param, Qmouse_color))
3355 face = Qmouse;
3356 lface = lface_from_face_name (f, face, 1);
3357 ASET (lface, LFACE_BACKGROUND_INDEX,
3358 (STRINGP (new_value) ? new_value : Qunspecified));
3360 #endif
3362 /* Changing a named face means that all realized faces depending on
3363 that face are invalid. Since we cannot tell which realized faces
3364 depend on the face, make sure they are all removed. This is done
3365 by incrementing face_change_count. The next call to
3366 init_iterator will then free realized faces. */
3367 if (!NILP (face)
3368 && NILP (Fget (face, Qface_no_inherit)))
3370 ++face_change_count;
3371 windows_or_buffers_changed = 57;
3376 #ifdef HAVE_WINDOW_SYSTEM
3378 /* Set the `font' frame parameter of FRAME determined from the
3379 font-object set in `default' face attributes LFACE. */
3381 static void
3382 set_font_frame_param (Lisp_Object frame, Lisp_Object lface)
3384 struct frame *f = XFRAME (frame);
3385 Lisp_Object font;
3387 if (FRAME_WINDOW_P (f)
3388 /* Don't do anything if the font is `unspecified'. This can
3389 happen during frame creation. */
3390 && (font = LFACE_FONT (lface),
3391 ! UNSPECIFIEDP (font)))
3393 if (FONT_SPEC_P (font))
3395 font = font_load_for_lface (f, XVECTOR (lface)->contents, font);
3396 if (NILP (font))
3397 return;
3398 ASET (lface, LFACE_FONT_INDEX, font);
3400 f->default_face_done_p = 0;
3401 AUTO_FRAME_ARG (arg, Qfont, font);
3402 Fmodify_frame_parameters (frame, arg);
3406 DEFUN ("internal-face-x-get-resource", Finternal_face_x_get_resource,
3407 Sinternal_face_x_get_resource, 2, 3, 0,
3408 doc: /* Get the value of X resource RESOURCE, class CLASS.
3409 Returned value is for the display of frame FRAME. If FRAME is not
3410 specified or nil, use selected frame. This function exists because
3411 ordinary `x-get-resource' doesn't take a frame argument. */)
3412 (Lisp_Object resource, Lisp_Object class, Lisp_Object frame)
3414 Lisp_Object value = Qnil;
3415 struct frame *f;
3417 CHECK_STRING (resource);
3418 CHECK_STRING (class);
3419 f = decode_live_frame (frame);
3420 block_input ();
3421 value = display_x_get_resource (FRAME_DISPLAY_INFO (f),
3422 resource, class, Qnil, Qnil);
3423 unblock_input ();
3424 return value;
3428 /* Return resource string VALUE as a boolean value, i.e. nil, or t.
3429 If VALUE is "on" or "true", return t. If VALUE is "off" or
3430 "false", return nil. Otherwise, if SIGNAL_P is non-zero, signal an
3431 error; if SIGNAL_P is zero, return 0. */
3433 static Lisp_Object
3434 face_boolean_x_resource_value (Lisp_Object value, int signal_p)
3436 Lisp_Object result = make_number (0);
3438 eassert (STRINGP (value));
3440 if (xstrcasecmp (SSDATA (value), "on") == 0
3441 || xstrcasecmp (SSDATA (value), "true") == 0)
3442 result = Qt;
3443 else if (xstrcasecmp (SSDATA (value), "off") == 0
3444 || xstrcasecmp (SSDATA (value), "false") == 0)
3445 result = Qnil;
3446 else if (xstrcasecmp (SSDATA (value), "unspecified") == 0)
3447 result = Qunspecified;
3448 else if (signal_p)
3449 signal_error ("Invalid face attribute value from X resource", value);
3451 return result;
3455 DEFUN ("internal-set-lisp-face-attribute-from-resource",
3456 Finternal_set_lisp_face_attribute_from_resource,
3457 Sinternal_set_lisp_face_attribute_from_resource,
3458 3, 4, 0, doc: /* */)
3459 (Lisp_Object face, Lisp_Object attr, Lisp_Object value, Lisp_Object frame)
3461 CHECK_SYMBOL (face);
3462 CHECK_SYMBOL (attr);
3463 CHECK_STRING (value);
3465 if (xstrcasecmp (SSDATA (value), "unspecified") == 0)
3466 value = Qunspecified;
3467 else if (EQ (attr, QCheight))
3469 value = Fstring_to_number (value, make_number (10));
3470 if (XINT (value) <= 0)
3471 signal_error ("Invalid face height from X resource", value);
3473 else if (EQ (attr, QCbold) || EQ (attr, QCitalic))
3474 value = face_boolean_x_resource_value (value, 1);
3475 else if (EQ (attr, QCweight) || EQ (attr, QCslant) || EQ (attr, QCwidth))
3476 value = intern (SSDATA (value));
3477 else if (EQ (attr, QCreverse_video) || EQ (attr, QCinverse_video))
3478 value = face_boolean_x_resource_value (value, 1);
3479 else if (EQ (attr, QCunderline)
3480 || EQ (attr, QCoverline)
3481 || EQ (attr, QCstrike_through))
3483 Lisp_Object boolean_value;
3485 /* If the result of face_boolean_x_resource_value is t or nil,
3486 VALUE does NOT specify a color. */
3487 boolean_value = face_boolean_x_resource_value (value, 0);
3488 if (SYMBOLP (boolean_value))
3489 value = boolean_value;
3491 else if (EQ (attr, QCbox) || EQ (attr, QCinherit))
3492 value = Fcar (Fread_from_string (value, Qnil, Qnil));
3494 return Finternal_set_lisp_face_attribute (face, attr, value, frame);
3497 #endif /* HAVE_WINDOW_SYSTEM */
3500 /***********************************************************************
3501 Menu face
3502 ***********************************************************************/
3504 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
3506 /* Make menus on frame F appear as specified by the `menu' face. */
3508 static void
3509 x_update_menu_appearance (struct frame *f)
3511 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
3512 XrmDatabase rdb;
3514 if (dpyinfo
3515 && (rdb = XrmGetDatabase (FRAME_X_DISPLAY (f)),
3516 rdb != NULL))
3518 char line[512];
3519 char *buf = line;
3520 ptrdiff_t bufsize = sizeof line;
3521 Lisp_Object lface = lface_from_face_name (f, Qmenu, 1);
3522 struct face *face = FACE_FROM_ID (f, MENU_FACE_ID);
3523 const char *myname = SSDATA (Vx_resource_name);
3524 bool changed_p = 0;
3525 #ifdef USE_MOTIF
3526 const char *popup_path = "popup_menu";
3527 #else
3528 const char *popup_path = "menu.popup";
3529 #endif
3531 if (STRINGP (LFACE_FOREGROUND (lface)))
3533 exprintf (&buf, &bufsize, line, -1, "%s.%s*foreground: %s",
3534 myname, popup_path,
3535 SDATA (LFACE_FOREGROUND (lface)));
3536 XrmPutLineResource (&rdb, line);
3537 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*foreground: %s",
3538 myname, SDATA (LFACE_FOREGROUND (lface)));
3539 XrmPutLineResource (&rdb, line);
3540 changed_p = 1;
3543 if (STRINGP (LFACE_BACKGROUND (lface)))
3545 exprintf (&buf, &bufsize, line, -1, "%s.%s*background: %s",
3546 myname, popup_path,
3547 SDATA (LFACE_BACKGROUND (lface)));
3548 XrmPutLineResource (&rdb, line);
3550 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*background: %s",
3551 myname, SDATA (LFACE_BACKGROUND (lface)));
3552 XrmPutLineResource (&rdb, line);
3553 changed_p = 1;
3556 if (face->font
3557 /* On Solaris 5.8, it's been reported that the `menu' face
3558 can be unspecified here, during startup. Why this
3559 happens remains unknown. -- cyd */
3560 && FONTP (LFACE_FONT (lface))
3561 && (!UNSPECIFIEDP (LFACE_FAMILY (lface))
3562 || !UNSPECIFIEDP (LFACE_FOUNDRY (lface))
3563 || !UNSPECIFIEDP (LFACE_SWIDTH (lface))
3564 || !UNSPECIFIEDP (LFACE_WEIGHT (lface))
3565 || !UNSPECIFIEDP (LFACE_SLANT (lface))
3566 || !UNSPECIFIEDP (LFACE_HEIGHT (lface))))
3568 Lisp_Object xlfd = Ffont_xlfd_name (LFACE_FONT (lface), Qnil);
3569 #ifdef USE_MOTIF
3570 const char *suffix = "List";
3571 Bool motif = True;
3572 #else
3573 #if defined HAVE_X_I18N
3575 const char *suffix = "Set";
3576 #else
3577 const char *suffix = "";
3578 #endif
3579 Bool motif = False;
3580 #endif
3582 if (! NILP (xlfd))
3584 #if defined HAVE_X_I18N
3585 char *fontsetname = xic_create_fontsetname (SSDATA (xlfd), motif);
3586 #else
3587 char *fontsetname = SSDATA (xlfd);
3588 #endif
3589 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*font%s: %s",
3590 myname, suffix, fontsetname);
3591 XrmPutLineResource (&rdb, line);
3593 exprintf (&buf, &bufsize, line, -1, "%s.%s*font%s: %s",
3594 myname, popup_path, suffix, fontsetname);
3595 XrmPutLineResource (&rdb, line);
3596 changed_p = 1;
3597 if (fontsetname != SSDATA (xlfd))
3598 xfree (fontsetname);
3602 if (changed_p && f->output_data.x->menubar_widget)
3603 free_frame_menubar (f);
3605 if (buf != line)
3606 xfree (buf);
3610 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
3613 DEFUN ("face-attribute-relative-p", Fface_attribute_relative_p,
3614 Sface_attribute_relative_p,
3615 2, 2, 0,
3616 doc: /* Check whether a face attribute value is relative.
3617 Specifically, this function returns t if the attribute ATTRIBUTE
3618 with the value VALUE is relative.
3620 A relative value is one that doesn't entirely override whatever is
3621 inherited from another face. For most possible attributes,
3622 the only relative value that users see is `unspecified'.
3623 However, for :height, floating point values are also relative. */)
3624 (Lisp_Object attribute, Lisp_Object value)
3626 if (EQ (value, Qunspecified) || (EQ (value, QCignore_defface)))
3627 return Qt;
3628 else if (EQ (attribute, QCheight))
3629 return INTEGERP (value) ? Qnil : Qt;
3630 else
3631 return Qnil;
3634 DEFUN ("merge-face-attribute", Fmerge_face_attribute, Smerge_face_attribute,
3635 3, 3, 0,
3636 doc: /* Return face ATTRIBUTE VALUE1 merged with VALUE2.
3637 If VALUE1 or VALUE2 are absolute (see `face-attribute-relative-p'), then
3638 the result will be absolute, otherwise it will be relative. */)
3639 (Lisp_Object attribute, Lisp_Object value1, Lisp_Object value2)
3641 if (EQ (value1, Qunspecified) || EQ (value1, QCignore_defface))
3642 return value2;
3643 else if (EQ (attribute, QCheight))
3644 return merge_face_heights (value1, value2, value1);
3645 else
3646 return value1;
3650 DEFUN ("internal-get-lisp-face-attribute", Finternal_get_lisp_face_attribute,
3651 Sinternal_get_lisp_face_attribute,
3652 2, 3, 0,
3653 doc: /* Return face attribute KEYWORD of face SYMBOL.
3654 If SYMBOL does not name a valid Lisp face or KEYWORD isn't a valid
3655 face attribute name, signal an error.
3656 If the optional argument FRAME is given, report on face SYMBOL in that
3657 frame. If FRAME is t, report on the defaults for face SYMBOL (for new
3658 frames). If FRAME is omitted or nil, use the selected frame. */)
3659 (Lisp_Object symbol, Lisp_Object keyword, Lisp_Object frame)
3661 struct frame *f = EQ (frame, Qt) ? NULL : decode_live_frame (frame);
3662 Lisp_Object lface = lface_from_face_name (f, symbol, 1), value = Qnil;
3664 CHECK_SYMBOL (symbol);
3665 CHECK_SYMBOL (keyword);
3667 if (EQ (keyword, QCfamily))
3668 value = LFACE_FAMILY (lface);
3669 else if (EQ (keyword, QCfoundry))
3670 value = LFACE_FOUNDRY (lface);
3671 else if (EQ (keyword, QCheight))
3672 value = LFACE_HEIGHT (lface);
3673 else if (EQ (keyword, QCweight))
3674 value = LFACE_WEIGHT (lface);
3675 else if (EQ (keyword, QCslant))
3676 value = LFACE_SLANT (lface);
3677 else if (EQ (keyword, QCunderline))
3678 value = LFACE_UNDERLINE (lface);
3679 else if (EQ (keyword, QCoverline))
3680 value = LFACE_OVERLINE (lface);
3681 else if (EQ (keyword, QCstrike_through))
3682 value = LFACE_STRIKE_THROUGH (lface);
3683 else if (EQ (keyword, QCbox))
3684 value = LFACE_BOX (lface);
3685 else if (EQ (keyword, QCinverse_video)
3686 || EQ (keyword, QCreverse_video))
3687 value = LFACE_INVERSE (lface);
3688 else if (EQ (keyword, QCforeground))
3689 value = LFACE_FOREGROUND (lface);
3690 else if (EQ (keyword, QCdistant_foreground))
3691 value = LFACE_DISTANT_FOREGROUND (lface);
3692 else if (EQ (keyword, QCbackground))
3693 value = LFACE_BACKGROUND (lface);
3694 else if (EQ (keyword, QCstipple))
3695 value = LFACE_STIPPLE (lface);
3696 else if (EQ (keyword, QCwidth))
3697 value = LFACE_SWIDTH (lface);
3698 else if (EQ (keyword, QCinherit))
3699 value = LFACE_INHERIT (lface);
3700 else if (EQ (keyword, QCfont))
3701 value = LFACE_FONT (lface);
3702 else if (EQ (keyword, QCfontset))
3703 value = LFACE_FONTSET (lface);
3704 else
3705 signal_error ("Invalid face attribute name", keyword);
3707 if (IGNORE_DEFFACE_P (value))
3708 return Qunspecified;
3710 return value;
3714 DEFUN ("internal-lisp-face-attribute-values",
3715 Finternal_lisp_face_attribute_values,
3716 Sinternal_lisp_face_attribute_values, 1, 1, 0,
3717 doc: /* Return a list of valid discrete values for face attribute ATTR.
3718 Value is nil if ATTR doesn't have a discrete set of valid values. */)
3719 (Lisp_Object attr)
3721 Lisp_Object result = Qnil;
3723 CHECK_SYMBOL (attr);
3725 if (EQ (attr, QCunderline) || EQ (attr, QCoverline)
3726 || EQ (attr, QCstrike_through)
3727 || EQ (attr, QCinverse_video) || EQ (attr, QCreverse_video))
3728 result = list2 (Qt, Qnil);
3730 return result;
3734 DEFUN ("internal-merge-in-global-face", Finternal_merge_in_global_face,
3735 Sinternal_merge_in_global_face, 2, 2, 0,
3736 doc: /* Add attributes from frame-default definition of FACE to FACE on FRAME.
3737 Default face attributes override any local face attributes. */)
3738 (Lisp_Object face, Lisp_Object frame)
3740 int i;
3741 Lisp_Object global_lface, local_lface, *gvec, *lvec;
3742 struct frame *f = XFRAME (frame);
3744 CHECK_LIVE_FRAME (frame);
3745 global_lface = lface_from_face_name (NULL, face, 1);
3746 local_lface = lface_from_face_name (f, face, 0);
3747 if (NILP (local_lface))
3748 local_lface = Finternal_make_lisp_face (face, frame);
3750 /* Make every specified global attribute override the local one.
3751 BEWARE!! This is only used from `face-set-after-frame-default' where
3752 the local frame is defined from default specs in `face-defface-spec'
3753 and those should be overridden by global settings. Hence the strange
3754 "global before local" priority. */
3755 lvec = XVECTOR (local_lface)->contents;
3756 gvec = XVECTOR (global_lface)->contents;
3757 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3758 if (IGNORE_DEFFACE_P (gvec[i]))
3759 ASET (local_lface, i, Qunspecified);
3760 else if (! UNSPECIFIEDP (gvec[i]))
3761 ASET (local_lface, i, AREF (global_lface, i));
3763 /* If the default face was changed, update the face cache and the
3764 `font' frame parameter. */
3765 if (EQ (face, Qdefault))
3767 struct face_cache *c = FRAME_FACE_CACHE (f);
3768 struct face *newface, *oldface = FACE_FROM_ID (f, DEFAULT_FACE_ID);
3769 Lisp_Object attrs[LFACE_VECTOR_SIZE];
3771 /* This can be NULL (e.g., in batch mode). */
3772 if (oldface)
3774 /* Ensure that the face vector is fully specified by merging
3775 the previously-cached vector. */
3776 memcpy (attrs, oldface->lface, sizeof attrs);
3777 merge_face_vectors (f, lvec, attrs, 0);
3778 vcopy (local_lface, 0, attrs, LFACE_VECTOR_SIZE);
3779 newface = realize_face (c, lvec, DEFAULT_FACE_ID);
3781 if ((! UNSPECIFIEDP (gvec[LFACE_FAMILY_INDEX])
3782 || ! UNSPECIFIEDP (gvec[LFACE_FOUNDRY_INDEX])
3783 || ! UNSPECIFIEDP (gvec[LFACE_HEIGHT_INDEX])
3784 || ! UNSPECIFIEDP (gvec[LFACE_WEIGHT_INDEX])
3785 || ! UNSPECIFIEDP (gvec[LFACE_SLANT_INDEX])
3786 || ! UNSPECIFIEDP (gvec[LFACE_SWIDTH_INDEX])
3787 || ! UNSPECIFIEDP (gvec[LFACE_FONT_INDEX]))
3788 && newface->font)
3790 Lisp_Object name = newface->font->props[FONT_NAME_INDEX];
3791 AUTO_FRAME_ARG (arg, Qfont, name);
3792 Fmodify_frame_parameters (frame, arg);
3795 if (STRINGP (gvec[LFACE_FOREGROUND_INDEX]))
3797 AUTO_FRAME_ARG (arg, Qforeground_color,
3798 gvec[LFACE_FOREGROUND_INDEX]);
3799 Fmodify_frame_parameters (frame, arg);
3802 if (STRINGP (gvec[LFACE_BACKGROUND_INDEX]))
3804 AUTO_FRAME_ARG (arg, Qbackground_color,
3805 gvec[LFACE_BACKGROUND_INDEX]);
3806 Fmodify_frame_parameters (frame, arg);
3811 return Qnil;
3815 /* The following function is implemented for compatibility with 20.2.
3816 The function is used in x-resolve-fonts when it is asked to
3817 return fonts with the same size as the font of a face. This is
3818 done in fontset.el. */
3820 DEFUN ("face-font", Fface_font, Sface_font, 1, 3, 0,
3821 doc: /* Return the font name of face FACE, or nil if it is unspecified.
3822 The font name is, by default, for ASCII characters.
3823 If the optional argument FRAME is given, report on face FACE in that frame.
3824 If FRAME is t, report on the defaults for face FACE (for new frames).
3825 The font default for a face is either nil, or a list
3826 of the form (bold), (italic) or (bold italic).
3827 If FRAME is omitted or nil, use the selected frame. And, in this case,
3828 if the optional third argument CHARACTER is given,
3829 return the font name used for CHARACTER. */)
3830 (Lisp_Object face, Lisp_Object frame, Lisp_Object character)
3832 if (EQ (frame, Qt))
3834 Lisp_Object result = Qnil;
3835 Lisp_Object lface = lface_from_face_name (NULL, face, 1);
3837 if (!UNSPECIFIEDP (LFACE_WEIGHT (lface))
3838 && !EQ (LFACE_WEIGHT (lface), Qnormal))
3839 result = Fcons (Qbold, result);
3841 if (!UNSPECIFIEDP (LFACE_SLANT (lface))
3842 && !EQ (LFACE_SLANT (lface), Qnormal))
3843 result = Fcons (Qitalic, result);
3845 return result;
3847 else
3849 struct frame *f = decode_live_frame (frame);
3850 int face_id = lookup_named_face (f, face, 1);
3851 struct face *fface = FACE_FROM_ID (f, face_id);
3853 if (! fface)
3854 return Qnil;
3855 #ifdef HAVE_WINDOW_SYSTEM
3856 if (FRAME_WINDOW_P (f) && !NILP (character))
3858 CHECK_CHARACTER (character);
3859 face_id = FACE_FOR_CHAR (f, fface, XINT (character), -1, Qnil);
3860 fface = FACE_FROM_ID (f, face_id);
3862 return (fface->font
3863 ? fface->font->props[FONT_NAME_INDEX]
3864 : Qnil);
3865 #else /* !HAVE_WINDOW_SYSTEM */
3866 return build_string (FRAME_MSDOS_P (f)
3867 ? "ms-dos"
3868 : FRAME_W32_P (f) ? "w32term"
3869 :"tty");
3870 #endif
3875 /* Compare face-attribute values v1 and v2 for equality. Value is non-zero if
3876 all attributes are `equal'. Tries to be fast because this function
3877 is called quite often. */
3879 static bool
3880 face_attr_equal_p (Lisp_Object v1, Lisp_Object v2)
3882 /* Type can differ, e.g. when one attribute is unspecified, i.e. nil,
3883 and the other is specified. */
3884 if (XTYPE (v1) != XTYPE (v2))
3885 return 0;
3887 if (EQ (v1, v2))
3888 return 1;
3890 switch (XTYPE (v1))
3892 case Lisp_String:
3893 if (SBYTES (v1) != SBYTES (v2))
3894 return 0;
3896 return memcmp (SDATA (v1), SDATA (v2), SBYTES (v1)) == 0;
3898 case_Lisp_Int:
3899 case Lisp_Symbol:
3900 return 0;
3902 default:
3903 return !NILP (Fequal (v1, v2));
3908 /* Compare face vectors V1 and V2 for equality. Value is non-zero if
3909 all attributes are `equal'. Tries to be fast because this function
3910 is called quite often. */
3912 static bool
3913 lface_equal_p (Lisp_Object *v1, Lisp_Object *v2)
3915 int i;
3916 bool equal_p = 1;
3918 for (i = 1; i < LFACE_VECTOR_SIZE && equal_p; ++i)
3919 equal_p = face_attr_equal_p (v1[i], v2[i]);
3921 return equal_p;
3925 DEFUN ("internal-lisp-face-equal-p", Finternal_lisp_face_equal_p,
3926 Sinternal_lisp_face_equal_p, 2, 3, 0,
3927 doc: /* True if FACE1 and FACE2 are equal.
3928 If the optional argument FRAME is given, report on FACE1 and FACE2 in that frame.
3929 If FRAME is t, report on the defaults for FACE1 and FACE2 (for new frames).
3930 If FRAME is omitted or nil, use the selected frame. */)
3931 (Lisp_Object face1, Lisp_Object face2, Lisp_Object frame)
3933 int equal_p;
3934 struct frame *f;
3935 Lisp_Object lface1, lface2;
3937 /* Don't use decode_window_system_frame here because this function
3938 is called before X frames exist. At that time, if FRAME is nil,
3939 selected_frame will be used which is the frame dumped with
3940 Emacs. That frame is not an X frame. */
3941 f = EQ (frame, Qt) ? NULL : decode_live_frame (frame);
3943 lface1 = lface_from_face_name (f, face1, 1);
3944 lface2 = lface_from_face_name (f, face2, 1);
3945 equal_p = lface_equal_p (XVECTOR (lface1)->contents,
3946 XVECTOR (lface2)->contents);
3947 return equal_p ? Qt : Qnil;
3951 DEFUN ("internal-lisp-face-empty-p", Finternal_lisp_face_empty_p,
3952 Sinternal_lisp_face_empty_p, 1, 2, 0,
3953 doc: /* True if FACE has no attribute specified.
3954 If the optional argument FRAME is given, report on face FACE in that frame.
3955 If FRAME is t, report on the defaults for face FACE (for new frames).
3956 If FRAME is omitted or nil, use the selected frame. */)
3957 (Lisp_Object face, Lisp_Object frame)
3959 struct frame *f = EQ (frame, Qt) ? NULL : decode_live_frame (frame);
3960 Lisp_Object lface = lface_from_face_name (f, face, 1);
3961 int i;
3963 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3964 if (!UNSPECIFIEDP (AREF (lface, i)))
3965 break;
3967 return i == LFACE_VECTOR_SIZE ? Qt : Qnil;
3971 DEFUN ("frame-face-alist", Fframe_face_alist, Sframe_face_alist,
3972 0, 1, 0,
3973 doc: /* Return an alist of frame-local faces defined on FRAME.
3974 For internal use only. */)
3975 (Lisp_Object frame)
3977 return decode_live_frame (frame)->face_alist;
3981 /* Return a hash code for Lisp string STRING with case ignored. Used
3982 below in computing a hash value for a Lisp face. */
3984 static unsigned
3985 hash_string_case_insensitive (Lisp_Object string)
3987 const unsigned char *s;
3988 unsigned hash = 0;
3989 eassert (STRINGP (string));
3990 for (s = SDATA (string); *s; ++s)
3991 hash = (hash << 1) ^ c_tolower (*s);
3992 return hash;
3996 /* Return a hash code for face attribute vector V. */
3998 static unsigned
3999 lface_hash (Lisp_Object *v)
4001 return (hash_string_case_insensitive (v[LFACE_FAMILY_INDEX])
4002 ^ hash_string_case_insensitive (v[LFACE_FOUNDRY_INDEX])
4003 ^ hash_string_case_insensitive (v[LFACE_FOREGROUND_INDEX])
4004 ^ hash_string_case_insensitive (v[LFACE_BACKGROUND_INDEX])
4005 ^ XHASH (v[LFACE_WEIGHT_INDEX])
4006 ^ XHASH (v[LFACE_SLANT_INDEX])
4007 ^ XHASH (v[LFACE_SWIDTH_INDEX])
4008 ^ XHASH (v[LFACE_HEIGHT_INDEX]));
4011 #ifdef HAVE_WINDOW_SYSTEM
4013 /* Return non-zero if LFACE1 and LFACE2 specify the same font (without
4014 considering charsets/registries). They do if they specify the same
4015 family, point size, weight, width, slant, and font. Both
4016 LFACE1 and LFACE2 must be fully-specified. */
4018 static int
4019 lface_same_font_attributes_p (Lisp_Object *lface1, Lisp_Object *lface2)
4021 eassert (lface_fully_specified_p (lface1)
4022 && lface_fully_specified_p (lface2));
4023 return (xstrcasecmp (SSDATA (lface1[LFACE_FAMILY_INDEX]),
4024 SSDATA (lface2[LFACE_FAMILY_INDEX])) == 0
4025 && xstrcasecmp (SSDATA (lface1[LFACE_FOUNDRY_INDEX]),
4026 SSDATA (lface2[LFACE_FOUNDRY_INDEX])) == 0
4027 && EQ (lface1[LFACE_HEIGHT_INDEX], lface2[LFACE_HEIGHT_INDEX])
4028 && EQ (lface1[LFACE_SWIDTH_INDEX], lface2[LFACE_SWIDTH_INDEX])
4029 && EQ (lface1[LFACE_WEIGHT_INDEX], lface2[LFACE_WEIGHT_INDEX])
4030 && EQ (lface1[LFACE_SLANT_INDEX], lface2[LFACE_SLANT_INDEX])
4031 && EQ (lface1[LFACE_FONT_INDEX], lface2[LFACE_FONT_INDEX])
4032 && (EQ (lface1[LFACE_FONTSET_INDEX], lface2[LFACE_FONTSET_INDEX])
4033 || (STRINGP (lface1[LFACE_FONTSET_INDEX])
4034 && STRINGP (lface2[LFACE_FONTSET_INDEX])
4035 && ! xstrcasecmp (SSDATA (lface1[LFACE_FONTSET_INDEX]),
4036 SSDATA (lface2[LFACE_FONTSET_INDEX]))))
4040 #endif /* HAVE_WINDOW_SYSTEM */
4042 /***********************************************************************
4043 Realized Faces
4044 ***********************************************************************/
4046 /* Allocate and return a new realized face for Lisp face attribute
4047 vector ATTR. */
4049 static struct face *
4050 make_realized_face (Lisp_Object *attr)
4052 enum { off = offsetof (struct face, id) };
4053 struct face *face = xmalloc (sizeof *face);
4055 memcpy (face->lface, attr, sizeof face->lface);
4056 memset (&face->id, 0, sizeof *face - off);
4057 face->ascii_face = face;
4059 return face;
4063 /* Free realized face FACE, including its X resources. FACE may
4064 be null. */
4066 static void
4067 free_realized_face (struct frame *f, struct face *face)
4069 if (face)
4071 #ifdef HAVE_WINDOW_SYSTEM
4072 if (FRAME_WINDOW_P (f))
4074 /* Free fontset of FACE if it is ASCII face. */
4075 if (face->fontset >= 0 && face == face->ascii_face)
4076 free_face_fontset (f, face);
4077 if (face->gc)
4079 block_input ();
4080 if (face->font)
4081 font_done_for_face (f, face);
4082 x_free_gc (f, face->gc);
4083 face->gc = 0;
4084 unblock_input ();
4086 #ifdef HAVE_X_WINDOWS
4087 free_face_colors (f, face);
4088 #endif /* HAVE_X_WINDOWS */
4089 x_destroy_bitmap (f, face->stipple);
4091 #endif /* HAVE_WINDOW_SYSTEM */
4093 xfree (face);
4097 #ifdef HAVE_WINDOW_SYSTEM
4099 /* Prepare face FACE for subsequent display on frame F. This must be called
4100 before using X resources of FACE to allocate GCs if they haven't been
4101 allocated yet or have been freed by clearing the face cache. */
4103 void
4104 prepare_face_for_display (struct frame *f, struct face *face)
4106 eassert (FRAME_WINDOW_P (f));
4108 if (face->gc == 0)
4110 XGCValues xgcv;
4111 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
4113 xgcv.foreground = face->foreground;
4114 xgcv.background = face->background;
4115 #ifdef HAVE_X_WINDOWS
4116 xgcv.graphics_exposures = False;
4117 #endif
4119 block_input ();
4120 #ifdef HAVE_X_WINDOWS
4121 if (face->stipple)
4123 xgcv.fill_style = FillOpaqueStippled;
4124 xgcv.stipple = x_bitmap_pixmap (f, face->stipple);
4125 mask |= GCFillStyle | GCStipple;
4127 #endif
4128 face->gc = x_create_gc (f, mask, &xgcv);
4129 if (face->font)
4130 font_prepare_for_face (f, face);
4131 unblock_input ();
4135 #endif /* HAVE_WINDOW_SYSTEM */
4137 /* Returns the `distance' between the colors X and Y. */
4139 static int
4140 color_distance (XColor *x, XColor *y)
4142 /* This formula is from a paper titled `Colour metric' by Thiadmer Riemersma.
4143 Quoting from that paper:
4145 This formula has results that are very close to L*u*v* (with the
4146 modified lightness curve) and, more importantly, it is a more even
4147 algorithm: it does not have a range of colors where it suddenly
4148 gives far from optimal results.
4150 See <http://www.compuphase.com/cmetric.htm> for more info. */
4152 long r = (x->red - y->red) >> 8;
4153 long g = (x->green - y->green) >> 8;
4154 long b = (x->blue - y->blue) >> 8;
4155 long r_mean = (x->red + y->red) >> 9;
4157 return
4158 (((512 + r_mean) * r * r) >> 8)
4159 + 4 * g * g
4160 + (((767 - r_mean) * b * b) >> 8);
4164 DEFUN ("color-distance", Fcolor_distance, Scolor_distance, 2, 3, 0,
4165 doc: /* Return an integer distance between COLOR1 and COLOR2 on FRAME.
4166 COLOR1 and COLOR2 may be either strings containing the color name,
4167 or lists of the form (RED GREEN BLUE).
4168 If FRAME is unspecified or nil, the current frame is used. */)
4169 (Lisp_Object color1, Lisp_Object color2, Lisp_Object frame)
4171 struct frame *f = decode_live_frame (frame);
4172 XColor cdef1, cdef2;
4174 if (!(CONSP (color1) && parse_rgb_list (color1, &cdef1))
4175 && !(STRINGP (color1) && defined_color (f, SSDATA (color1), &cdef1, 0)))
4176 signal_error ("Invalid color", color1);
4177 if (!(CONSP (color2) && parse_rgb_list (color2, &cdef2))
4178 && !(STRINGP (color2) && defined_color (f, SSDATA (color2), &cdef2, 0)))
4179 signal_error ("Invalid color", color2);
4181 return make_number (color_distance (&cdef1, &cdef2));
4185 /***********************************************************************
4186 Face Cache
4187 ***********************************************************************/
4189 /* Return a new face cache for frame F. */
4191 static struct face_cache *
4192 make_face_cache (struct frame *f)
4194 struct face_cache *c = xmalloc (sizeof *c);
4196 c->buckets = xzalloc (FACE_CACHE_BUCKETS_SIZE * sizeof *c->buckets);
4197 c->size = 50;
4198 c->used = 0;
4199 c->faces_by_id = xmalloc (c->size * sizeof *c->faces_by_id);
4200 c->f = f;
4201 c->menu_face_changed_p = menu_face_changed_default;
4202 return c;
4205 #ifdef HAVE_WINDOW_SYSTEM
4207 /* Clear out all graphics contexts for all realized faces, except for
4208 the basic faces. This should be done from time to time just to avoid
4209 keeping too many graphics contexts that are no longer needed. */
4211 static void
4212 clear_face_gcs (struct face_cache *c)
4214 if (c && FRAME_WINDOW_P (c->f))
4216 int i;
4217 for (i = BASIC_FACE_ID_SENTINEL; i < c->used; ++i)
4219 struct face *face = c->faces_by_id[i];
4220 if (face && face->gc)
4222 block_input ();
4223 if (face->font)
4224 font_done_for_face (c->f, face);
4225 x_free_gc (c->f, face->gc);
4226 face->gc = 0;
4227 unblock_input ();
4233 #endif /* HAVE_WINDOW_SYSTEM */
4235 /* Free all realized faces in face cache C, including basic faces.
4236 C may be null. If faces are freed, make sure the frame's current
4237 matrix is marked invalid, so that a display caused by an expose
4238 event doesn't try to use faces we destroyed. */
4240 static void
4241 free_realized_faces (struct face_cache *c)
4243 if (c && c->used)
4245 int i, size;
4246 struct frame *f = c->f;
4248 /* We must block input here because we can't process X events
4249 safely while only some faces are freed, or when the frame's
4250 current matrix still references freed faces. */
4251 block_input ();
4253 for (i = 0; i < c->used; ++i)
4255 free_realized_face (f, c->faces_by_id[i]);
4256 c->faces_by_id[i] = NULL;
4259 c->used = 0;
4260 size = FACE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
4261 memset (c->buckets, 0, size);
4263 /* Must do a thorough redisplay the next time. Mark current
4264 matrices as invalid because they will reference faces freed
4265 above. This function is also called when a frame is
4266 destroyed. In this case, the root window of F is nil. */
4267 if (WINDOWP (f->root_window))
4269 clear_current_matrices (f);
4270 windows_or_buffers_changed = 58;
4273 unblock_input ();
4278 /* Free all realized faces on FRAME or on all frames if FRAME is nil.
4279 This is done after attributes of a named face have been changed,
4280 because we can't tell which realized faces depend on that face. */
4282 void
4283 free_all_realized_faces (Lisp_Object frame)
4285 if (NILP (frame))
4287 Lisp_Object rest;
4288 FOR_EACH_FRAME (rest, frame)
4289 free_realized_faces (FRAME_FACE_CACHE (XFRAME (frame)));
4291 else
4292 free_realized_faces (FRAME_FACE_CACHE (XFRAME (frame)));
4296 /* Free face cache C and faces in it, including their X resources. */
4298 static void
4299 free_face_cache (struct face_cache *c)
4301 if (c)
4303 free_realized_faces (c);
4304 xfree (c->buckets);
4305 xfree (c->faces_by_id);
4306 xfree (c);
4311 /* Cache realized face FACE in face cache C. HASH is the hash value
4312 of FACE. If FACE is for ASCII characters (i.e. FACE->ascii_face ==
4313 FACE), insert the new face to the beginning of the collision list
4314 of the face hash table of C. Otherwise, add the new face to the
4315 end of the collision list. This way, lookup_face can quickly find
4316 that a requested face is not cached. */
4318 static void
4319 cache_face (struct face_cache *c, struct face *face, unsigned int hash)
4321 int i = hash % FACE_CACHE_BUCKETS_SIZE;
4323 face->hash = hash;
4325 if (face->ascii_face != face)
4327 struct face *last = c->buckets[i];
4328 if (last)
4330 while (last->next)
4331 last = last->next;
4332 last->next = face;
4333 face->prev = last;
4334 face->next = NULL;
4336 else
4338 c->buckets[i] = face;
4339 face->prev = face->next = NULL;
4342 else
4344 face->prev = NULL;
4345 face->next = c->buckets[i];
4346 if (face->next)
4347 face->next->prev = face;
4348 c->buckets[i] = face;
4351 /* Find a free slot in C->faces_by_id and use the index of the free
4352 slot as FACE->id. */
4353 for (i = 0; i < c->used; ++i)
4354 if (c->faces_by_id[i] == NULL)
4355 break;
4356 face->id = i;
4358 #ifdef GLYPH_DEBUG
4359 /* Check that FACE got a unique id. */
4361 int j, n;
4362 struct face *face1;
4364 for (j = n = 0; j < FACE_CACHE_BUCKETS_SIZE; ++j)
4365 for (face1 = c->buckets[j]; face1; face1 = face1->next)
4366 if (face1->id == i)
4367 ++n;
4369 eassert (n == 1);
4371 #endif /* GLYPH_DEBUG */
4373 /* Maybe enlarge C->faces_by_id. */
4374 if (i == c->used)
4376 if (c->used == c->size)
4377 c->faces_by_id = xpalloc (c->faces_by_id, &c->size, 1, MAX_FACE_ID,
4378 sizeof *c->faces_by_id);
4379 c->used++;
4382 c->faces_by_id[i] = face;
4386 /* Remove face FACE from cache C. */
4388 static void
4389 uncache_face (struct face_cache *c, struct face *face)
4391 int i = face->hash % FACE_CACHE_BUCKETS_SIZE;
4393 if (face->prev)
4394 face->prev->next = face->next;
4395 else
4396 c->buckets[i] = face->next;
4398 if (face->next)
4399 face->next->prev = face->prev;
4401 c->faces_by_id[face->id] = NULL;
4402 if (face->id == c->used)
4403 --c->used;
4407 /* Look up a realized face with face attributes ATTR in the face cache
4408 of frame F. The face will be used to display ASCII characters.
4409 Value is the ID of the face found. If no suitable face is found,
4410 realize a new one. */
4412 static int
4413 lookup_face (struct frame *f, Lisp_Object *attr)
4415 struct face_cache *cache = FRAME_FACE_CACHE (f);
4416 unsigned hash;
4417 int i;
4418 struct face *face;
4420 eassert (cache != NULL);
4421 check_lface_attrs (attr);
4423 /* Look up ATTR in the face cache. */
4424 hash = lface_hash (attr);
4425 i = hash % FACE_CACHE_BUCKETS_SIZE;
4427 for (face = cache->buckets[i]; face; face = face->next)
4429 if (face->ascii_face != face)
4431 /* There's no more ASCII face. */
4432 face = NULL;
4433 break;
4435 if (face->hash == hash
4436 && lface_equal_p (face->lface, attr))
4437 break;
4440 /* If not found, realize a new face. */
4441 if (face == NULL)
4442 face = realize_face (cache, attr, -1);
4444 #ifdef GLYPH_DEBUG
4445 eassert (face == FACE_FROM_ID (f, face->id));
4446 #endif /* GLYPH_DEBUG */
4448 return face->id;
4451 #ifdef HAVE_WINDOW_SYSTEM
4452 /* Look up a realized face that has the same attributes as BASE_FACE
4453 except for the font in the face cache of frame F. If FONT-OBJECT
4454 is not nil, it is an already opened font. If FONT-OBJECT is nil,
4455 the face has no font. Value is the ID of the face found. If no
4456 suitable face is found, realize a new one. */
4459 face_for_font (struct frame *f, Lisp_Object font_object, struct face *base_face)
4461 struct face_cache *cache = FRAME_FACE_CACHE (f);
4462 unsigned hash;
4463 int i;
4464 struct face *face;
4466 eassert (cache != NULL);
4467 base_face = base_face->ascii_face;
4468 hash = lface_hash (base_face->lface);
4469 i = hash % FACE_CACHE_BUCKETS_SIZE;
4471 for (face = cache->buckets[i]; face; face = face->next)
4473 if (face->ascii_face == face)
4474 continue;
4475 if (face->ascii_face == base_face
4476 && face->font == (NILP (font_object) ? NULL
4477 : XFONT_OBJECT (font_object))
4478 && lface_equal_p (face->lface, base_face->lface))
4479 return face->id;
4482 /* If not found, realize a new face. */
4483 face = realize_non_ascii_face (f, font_object, base_face);
4484 return face->id;
4486 #endif /* HAVE_WINDOW_SYSTEM */
4488 /* Return the face id of the realized face for named face SYMBOL on
4489 frame F suitable for displaying ASCII characters. Value is -1 if
4490 the face couldn't be determined, which might happen if the default
4491 face isn't realized and cannot be realized. */
4494 lookup_named_face (struct frame *f, Lisp_Object symbol, int signal_p)
4496 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4497 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
4498 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
4500 if (default_face == NULL)
4502 if (!realize_basic_faces (f))
4503 return -1;
4504 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
4505 if (default_face == NULL)
4506 emacs_abort (); /* realize_basic_faces must have set it up */
4509 if (! get_lface_attributes (f, symbol, symbol_attrs, signal_p, 0))
4510 return -1;
4512 memcpy (attrs, default_face->lface, sizeof attrs);
4513 merge_face_vectors (f, symbol_attrs, attrs, 0);
4515 return lookup_face (f, attrs);
4519 /* Return the display face-id of the basic face whose canonical face-id
4520 is FACE_ID. The return value will usually simply be FACE_ID, unless that
4521 basic face has bee remapped via Vface_remapping_alist. This function is
4522 conservative: if something goes wrong, it will simply return FACE_ID
4523 rather than signal an error. */
4526 lookup_basic_face (struct frame *f, int face_id)
4528 Lisp_Object name, mapping;
4529 int remapped_face_id;
4531 if (NILP (Vface_remapping_alist))
4532 return face_id; /* Nothing to do. */
4534 switch (face_id)
4536 case DEFAULT_FACE_ID: name = Qdefault; break;
4537 case MODE_LINE_FACE_ID: name = Qmode_line; break;
4538 case MODE_LINE_INACTIVE_FACE_ID: name = Qmode_line_inactive; break;
4539 case HEADER_LINE_FACE_ID: name = Qheader_line; break;
4540 case TOOL_BAR_FACE_ID: name = Qtool_bar; break;
4541 case FRINGE_FACE_ID: name = Qfringe; break;
4542 case SCROLL_BAR_FACE_ID: name = Qscroll_bar; break;
4543 case BORDER_FACE_ID: name = Qborder; break;
4544 case CURSOR_FACE_ID: name = Qcursor; break;
4545 case MOUSE_FACE_ID: name = Qmouse; break;
4546 case MENU_FACE_ID: name = Qmenu; break;
4548 default:
4549 emacs_abort (); /* the caller is supposed to pass us a basic face id */
4552 /* Do a quick scan through Vface_remapping_alist, and return immediately
4553 if there is no remapping for face NAME. This is just an optimization
4554 for the very common no-remapping case. */
4555 mapping = assq_no_quit (name, Vface_remapping_alist);
4556 if (NILP (mapping))
4557 return face_id; /* Give up. */
4559 /* If there is a remapping entry, lookup the face using NAME, which will
4560 handle the remapping too. */
4561 remapped_face_id = lookup_named_face (f, name, 0);
4562 if (remapped_face_id < 0)
4563 return face_id; /* Give up. */
4565 return remapped_face_id;
4569 /* Return a face for charset ASCII that is like the face with id
4570 FACE_ID on frame F, but has a font that is STEPS steps smaller.
4571 STEPS < 0 means larger. Value is the id of the face. */
4574 smaller_face (struct frame *f, int face_id, int steps)
4576 #ifdef HAVE_WINDOW_SYSTEM
4577 struct face *face;
4578 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4579 int pt, last_pt, last_height;
4580 int delta;
4581 int new_face_id;
4582 struct face *new_face;
4584 /* If not called for an X frame, just return the original face. */
4585 if (FRAME_TERMCAP_P (f))
4586 return face_id;
4588 /* Try in increments of 1/2 pt. */
4589 delta = steps < 0 ? 5 : -5;
4590 steps = eabs (steps);
4592 face = FACE_FROM_ID (f, face_id);
4593 memcpy (attrs, face->lface, sizeof attrs);
4594 pt = last_pt = XFASTINT (attrs[LFACE_HEIGHT_INDEX]);
4595 new_face_id = face_id;
4596 last_height = FONT_HEIGHT (face->font);
4598 while (steps
4599 && pt + delta > 0
4600 /* Give up if we cannot find a font within 10pt. */
4601 && eabs (last_pt - pt) < 100)
4603 /* Look up a face for a slightly smaller/larger font. */
4604 pt += delta;
4605 attrs[LFACE_HEIGHT_INDEX] = make_number (pt);
4606 new_face_id = lookup_face (f, attrs);
4607 new_face = FACE_FROM_ID (f, new_face_id);
4609 /* If height changes, count that as one step. */
4610 if ((delta < 0 && FONT_HEIGHT (new_face->font) < last_height)
4611 || (delta > 0 && FONT_HEIGHT (new_face->font) > last_height))
4613 --steps;
4614 last_height = FONT_HEIGHT (new_face->font);
4615 last_pt = pt;
4619 return new_face_id;
4621 #else /* not HAVE_WINDOW_SYSTEM */
4623 return face_id;
4625 #endif /* not HAVE_WINDOW_SYSTEM */
4629 /* Return a face for charset ASCII that is like the face with id
4630 FACE_ID on frame F, but has height HEIGHT. */
4633 face_with_height (struct frame *f, int face_id, int height)
4635 #ifdef HAVE_WINDOW_SYSTEM
4636 struct face *face;
4637 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4639 if (FRAME_TERMCAP_P (f)
4640 || height <= 0)
4641 return face_id;
4643 face = FACE_FROM_ID (f, face_id);
4644 memcpy (attrs, face->lface, sizeof attrs);
4645 attrs[LFACE_HEIGHT_INDEX] = make_number (height);
4646 font_clear_prop (attrs, FONT_SIZE_INDEX);
4647 face_id = lookup_face (f, attrs);
4648 #endif /* HAVE_WINDOW_SYSTEM */
4650 return face_id;
4654 /* Return the face id of the realized face for named face SYMBOL on
4655 frame F suitable for displaying ASCII characters, and use
4656 attributes of the face FACE_ID for attributes that aren't
4657 completely specified by SYMBOL. This is like lookup_named_face,
4658 except that the default attributes come from FACE_ID, not from the
4659 default face. FACE_ID is assumed to be already realized. */
4662 lookup_derived_face (struct frame *f, Lisp_Object symbol, int face_id,
4663 int signal_p)
4665 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4666 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
4667 struct face *default_face = FACE_FROM_ID (f, face_id);
4669 if (!default_face)
4670 emacs_abort ();
4672 if (!get_lface_attributes (f, symbol, symbol_attrs, signal_p, 0))
4673 return -1;
4675 memcpy (attrs, default_face->lface, sizeof attrs);
4676 merge_face_vectors (f, symbol_attrs, attrs, 0);
4677 return lookup_face (f, attrs);
4680 DEFUN ("face-attributes-as-vector", Fface_attributes_as_vector,
4681 Sface_attributes_as_vector, 1, 1, 0,
4682 doc: /* Return a vector of face attributes corresponding to PLIST. */)
4683 (Lisp_Object plist)
4685 Lisp_Object lface;
4686 lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
4687 Qunspecified);
4688 merge_face_ref (XFRAME (selected_frame), plist, XVECTOR (lface)->contents,
4689 1, 0);
4690 return lface;
4695 /***********************************************************************
4696 Face capability testing
4697 ***********************************************************************/
4700 /* If the distance (as returned by color_distance) between two colors is
4701 less than this, then they are considered the same, for determining
4702 whether a color is supported or not. The range of values is 0-65535. */
4704 #define TTY_SAME_COLOR_THRESHOLD 10000
4706 #ifdef HAVE_WINDOW_SYSTEM
4708 /* Return true if all the face attributes in ATTRS are supported
4709 on the window-system frame F.
4711 The definition of `supported' is somewhat heuristic, but basically means
4712 that a face containing all the attributes in ATTRS, when merged with the
4713 default face for display, can be represented in a way that's
4715 \(1) different in appearance than the default face, and
4716 \(2) `close in spirit' to what the attributes specify, if not exact. */
4718 static bool
4719 x_supports_face_attributes_p (struct frame *f,
4720 Lisp_Object attrs[LFACE_VECTOR_SIZE],
4721 struct face *def_face)
4723 Lisp_Object *def_attrs = def_face->lface;
4725 /* Check that other specified attributes are different that the default
4726 face. */
4727 if ((!UNSPECIFIEDP (attrs[LFACE_UNDERLINE_INDEX])
4728 && face_attr_equal_p (attrs[LFACE_UNDERLINE_INDEX],
4729 def_attrs[LFACE_UNDERLINE_INDEX]))
4730 || (!UNSPECIFIEDP (attrs[LFACE_INVERSE_INDEX])
4731 && face_attr_equal_p (attrs[LFACE_INVERSE_INDEX],
4732 def_attrs[LFACE_INVERSE_INDEX]))
4733 || (!UNSPECIFIEDP (attrs[LFACE_FOREGROUND_INDEX])
4734 && face_attr_equal_p (attrs[LFACE_FOREGROUND_INDEX],
4735 def_attrs[LFACE_FOREGROUND_INDEX]))
4736 || (!UNSPECIFIEDP (attrs[LFACE_DISTANT_FOREGROUND_INDEX])
4737 && face_attr_equal_p (attrs[LFACE_DISTANT_FOREGROUND_INDEX],
4738 def_attrs[LFACE_DISTANT_FOREGROUND_INDEX]))
4739 || (!UNSPECIFIEDP (attrs[LFACE_BACKGROUND_INDEX])
4740 && face_attr_equal_p (attrs[LFACE_BACKGROUND_INDEX],
4741 def_attrs[LFACE_BACKGROUND_INDEX]))
4742 || (!UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
4743 && face_attr_equal_p (attrs[LFACE_STIPPLE_INDEX],
4744 def_attrs[LFACE_STIPPLE_INDEX]))
4745 || (!UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
4746 && face_attr_equal_p (attrs[LFACE_OVERLINE_INDEX],
4747 def_attrs[LFACE_OVERLINE_INDEX]))
4748 || (!UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
4749 && face_attr_equal_p (attrs[LFACE_STRIKE_THROUGH_INDEX],
4750 def_attrs[LFACE_STRIKE_THROUGH_INDEX]))
4751 || (!UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
4752 && face_attr_equal_p (attrs[LFACE_BOX_INDEX],
4753 def_attrs[LFACE_BOX_INDEX])))
4754 return 0;
4756 /* Check font-related attributes, as those are the most commonly
4757 "unsupported" on a window-system (because of missing fonts). */
4758 if (!UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
4759 || !UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
4760 || !UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
4761 || !UNSPECIFIEDP (attrs[LFACE_WEIGHT_INDEX])
4762 || !UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX])
4763 || !UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX]))
4765 int face_id;
4766 struct face *face;
4767 Lisp_Object merged_attrs[LFACE_VECTOR_SIZE];
4768 int i;
4770 memcpy (merged_attrs, def_attrs, sizeof merged_attrs);
4772 merge_face_vectors (f, attrs, merged_attrs, 0);
4774 face_id = lookup_face (f, merged_attrs);
4775 face = FACE_FROM_ID (f, face_id);
4777 if (! face)
4778 error ("Cannot make face");
4780 /* If the font is the same, or no font is found, then not
4781 supported. */
4782 if (face->font == def_face->font
4783 || ! face->font)
4784 return 0;
4785 for (i = FONT_TYPE_INDEX; i <= FONT_SIZE_INDEX; i++)
4786 if (! EQ (face->font->props[i], def_face->font->props[i]))
4788 Lisp_Object s1, s2;
4790 if (i < FONT_FOUNDRY_INDEX || i > FONT_REGISTRY_INDEX
4791 || face->font->driver->case_sensitive)
4792 return 1;
4793 s1 = SYMBOL_NAME (face->font->props[i]);
4794 s2 = SYMBOL_NAME (def_face->font->props[i]);
4795 if (! EQ (Fcompare_strings (s1, make_number (0), Qnil,
4796 s2, make_number (0), Qnil, Qt), Qt))
4797 return 1;
4799 return 0;
4802 /* Everything checks out, this face is supported. */
4803 return 1;
4806 #endif /* HAVE_WINDOW_SYSTEM */
4808 /* Return true if all the face attributes in ATTRS are supported
4809 on the tty frame F.
4811 The definition of `supported' is somewhat heuristic, but basically means
4812 that a face containing all the attributes in ATTRS, when merged
4813 with the default face for display, can be represented in a way that's
4815 \(1) different in appearance than the default face, and
4816 \(2) `close in spirit' to what the attributes specify, if not exact.
4818 Point (2) implies that a `:weight black' attribute will be satisfied
4819 by any terminal that can display bold, and a `:foreground "yellow"' as
4820 long as the terminal can display a yellowish color, but `:slant italic'
4821 will _not_ be satisfied by the tty display code's automatic
4822 substitution of a `dim' face for italic. */
4824 static bool
4825 tty_supports_face_attributes_p (struct frame *f,
4826 Lisp_Object attrs[LFACE_VECTOR_SIZE],
4827 struct face *def_face)
4829 int weight, slant;
4830 Lisp_Object val, fg, bg;
4831 XColor fg_tty_color, fg_std_color;
4832 XColor bg_tty_color, bg_std_color;
4833 unsigned test_caps = 0;
4834 Lisp_Object *def_attrs = def_face->lface;
4836 /* First check some easy-to-check stuff; ttys support none of the
4837 following attributes, so we can just return false if any are requested
4838 (even if `nominal' values are specified, we should still return false,
4839 as that will be the same value that the default face uses). We
4840 consider :slant unsupportable on ttys, even though the face code
4841 actually `fakes' them using a dim attribute if possible. This is
4842 because the faked result is too different from what the face
4843 specifies. */
4844 if (!UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
4845 || !UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
4846 || !UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
4847 || !UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
4848 || !UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
4849 || !UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
4850 || !UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
4851 || !UNSPECIFIEDP (attrs[LFACE_BOX_INDEX]))
4852 return 0;
4854 /* Test for terminal `capabilities' (non-color character attributes). */
4856 /* font weight (bold/dim) */
4857 val = attrs[LFACE_WEIGHT_INDEX];
4858 if (!UNSPECIFIEDP (val)
4859 && (weight = FONT_WEIGHT_NAME_NUMERIC (val), weight >= 0))
4861 int def_weight = FONT_WEIGHT_NAME_NUMERIC (def_attrs[LFACE_WEIGHT_INDEX]);
4863 if (weight > 100)
4865 if (def_weight > 100)
4866 return 0; /* same as default */
4867 test_caps = TTY_CAP_BOLD;
4869 else if (weight < 100)
4871 if (def_weight < 100)
4872 return 0; /* same as default */
4873 test_caps = TTY_CAP_DIM;
4875 else if (def_weight == 100)
4876 return 0; /* same as default */
4879 /* font slant */
4880 val = attrs[LFACE_SLANT_INDEX];
4881 if (!UNSPECIFIEDP (val)
4882 && (slant = FONT_SLANT_NAME_NUMERIC (val), slant >= 0))
4884 int def_slant = FONT_SLANT_NAME_NUMERIC (def_attrs[LFACE_SLANT_INDEX]);
4885 if (slant == 100 || slant == def_slant)
4886 return 0; /* same as default */
4887 else
4888 test_caps |= TTY_CAP_ITALIC;
4891 /* underlining */
4892 val = attrs[LFACE_UNDERLINE_INDEX];
4893 if (!UNSPECIFIEDP (val))
4895 if (STRINGP (val))
4896 return 0; /* ttys can't use colored underlines */
4897 else if (EQ (CAR_SAFE (val), QCstyle) && EQ (CAR_SAFE (CDR_SAFE (val)), Qwave))
4898 return 0; /* ttys can't use wave underlines */
4899 else if (face_attr_equal_p (val, def_attrs[LFACE_UNDERLINE_INDEX]))
4900 return 0; /* same as default */
4901 else
4902 test_caps |= TTY_CAP_UNDERLINE;
4905 /* inverse video */
4906 val = attrs[LFACE_INVERSE_INDEX];
4907 if (!UNSPECIFIEDP (val))
4909 if (face_attr_equal_p (val, def_attrs[LFACE_INVERSE_INDEX]))
4910 return 0; /* same as default */
4911 else
4912 test_caps |= TTY_CAP_INVERSE;
4916 /* Color testing. */
4918 /* Check if foreground color is close enough. */
4919 fg = attrs[LFACE_FOREGROUND_INDEX];
4920 if (STRINGP (fg))
4922 Lisp_Object def_fg = def_attrs[LFACE_FOREGROUND_INDEX];
4924 if (face_attr_equal_p (fg, def_fg))
4925 return 0; /* same as default */
4926 else if (! tty_lookup_color (f, fg, &fg_tty_color, &fg_std_color))
4927 return 0; /* not a valid color */
4928 else if (color_distance (&fg_tty_color, &fg_std_color)
4929 > TTY_SAME_COLOR_THRESHOLD)
4930 return 0; /* displayed color is too different */
4931 else
4932 /* Make sure the color is really different than the default. */
4934 XColor def_fg_color;
4935 if (tty_lookup_color (f, def_fg, &def_fg_color, 0)
4936 && (color_distance (&fg_tty_color, &def_fg_color)
4937 <= TTY_SAME_COLOR_THRESHOLD))
4938 return 0;
4942 /* Check if background color is close enough. */
4943 bg = attrs[LFACE_BACKGROUND_INDEX];
4944 if (STRINGP (bg))
4946 Lisp_Object def_bg = def_attrs[LFACE_BACKGROUND_INDEX];
4948 if (face_attr_equal_p (bg, def_bg))
4949 return 0; /* same as default */
4950 else if (! tty_lookup_color (f, bg, &bg_tty_color, &bg_std_color))
4951 return 0; /* not a valid color */
4952 else if (color_distance (&bg_tty_color, &bg_std_color)
4953 > TTY_SAME_COLOR_THRESHOLD)
4954 return 0; /* displayed color is too different */
4955 else
4956 /* Make sure the color is really different than the default. */
4958 XColor def_bg_color;
4959 if (tty_lookup_color (f, def_bg, &def_bg_color, 0)
4960 && (color_distance (&bg_tty_color, &def_bg_color)
4961 <= TTY_SAME_COLOR_THRESHOLD))
4962 return 0;
4966 /* If both foreground and background are requested, see if the
4967 distance between them is OK. We just check to see if the distance
4968 between the tty's foreground and background is close enough to the
4969 distance between the standard foreground and background. */
4970 if (STRINGP (fg) && STRINGP (bg))
4972 int delta_delta
4973 = (color_distance (&fg_std_color, &bg_std_color)
4974 - color_distance (&fg_tty_color, &bg_tty_color));
4975 if (delta_delta > TTY_SAME_COLOR_THRESHOLD
4976 || delta_delta < -TTY_SAME_COLOR_THRESHOLD)
4977 return 0;
4981 /* See if the capabilities we selected above are supported, with the
4982 given colors. */
4983 return tty_capable_p (FRAME_TTY (f), test_caps);
4987 DEFUN ("display-supports-face-attributes-p",
4988 Fdisplay_supports_face_attributes_p, Sdisplay_supports_face_attributes_p,
4989 1, 2, 0,
4990 doc: /* Return non-nil if all the face attributes in ATTRIBUTES are supported.
4991 The optional argument DISPLAY can be a display name, a frame, or
4992 nil (meaning the selected frame's display).
4994 The definition of `supported' is somewhat heuristic, but basically means
4995 that a face containing all the attributes in ATTRIBUTES, when merged
4996 with the default face for display, can be represented in a way that's
4998 \(1) different in appearance than the default face, and
4999 \(2) `close in spirit' to what the attributes specify, if not exact.
5001 Point (2) implies that a `:weight black' attribute will be satisfied by
5002 any display that can display bold, and a `:foreground \"yellow\"' as long
5003 as it can display a yellowish color, but `:slant italic' will _not_ be
5004 satisfied by the tty display code's automatic substitution of a `dim'
5005 face for italic. */)
5006 (Lisp_Object attributes, Lisp_Object display)
5008 bool supports = 0;
5009 int i;
5010 Lisp_Object frame;
5011 struct frame *f;
5012 struct face *def_face;
5013 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5015 if (noninteractive || !initialized)
5016 /* We may not be able to access low-level face information in batch
5017 mode, or before being dumped, and this function is not going to
5018 be very useful in those cases anyway, so just give up. */
5019 return Qnil;
5021 if (NILP (display))
5022 frame = selected_frame;
5023 else if (FRAMEP (display))
5024 frame = display;
5025 else
5027 /* Find any frame on DISPLAY. */
5028 Lisp_Object tail;
5030 frame = Qnil;
5031 FOR_EACH_FRAME (tail, frame)
5032 if (!NILP (Fequal (Fcdr (Fassq (Qdisplay,
5033 XFRAME (frame)->param_alist)),
5034 display)))
5035 break;
5038 CHECK_LIVE_FRAME (frame);
5039 f = XFRAME (frame);
5041 for (i = 0; i < LFACE_VECTOR_SIZE; i++)
5042 attrs[i] = Qunspecified;
5043 merge_face_ref (f, attributes, attrs, 1, 0);
5045 def_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5046 if (def_face == NULL)
5048 if (! realize_basic_faces (f))
5049 error ("Cannot realize default face");
5050 def_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5051 if (def_face == NULL)
5052 emacs_abort (); /* realize_basic_faces must have set it up */
5055 /* Dispatch to the appropriate handler. */
5056 if (FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5057 supports = tty_supports_face_attributes_p (f, attrs, def_face);
5058 #ifdef HAVE_WINDOW_SYSTEM
5059 else
5060 supports = x_supports_face_attributes_p (f, attrs, def_face);
5061 #endif
5063 return supports ? Qt : Qnil;
5067 /***********************************************************************
5068 Font selection
5069 ***********************************************************************/
5071 DEFUN ("internal-set-font-selection-order",
5072 Finternal_set_font_selection_order,
5073 Sinternal_set_font_selection_order, 1, 1, 0,
5074 doc: /* Set font selection order for face font selection to ORDER.
5075 ORDER must be a list of length 4 containing the symbols `:width',
5076 `:height', `:weight', and `:slant'. Face attributes appearing
5077 first in ORDER are matched first, e.g. if `:height' appears before
5078 `:weight' in ORDER, font selection first tries to find a font with
5079 a suitable height, and then tries to match the font weight.
5080 Value is ORDER. */)
5081 (Lisp_Object order)
5083 Lisp_Object list;
5084 int i;
5085 int indices[ARRAYELTS (font_sort_order)];
5087 CHECK_LIST (order);
5088 memset (indices, 0, sizeof indices);
5089 i = 0;
5091 for (list = order;
5092 CONSP (list) && i < ARRAYELTS (indices);
5093 list = XCDR (list), ++i)
5095 Lisp_Object attr = XCAR (list);
5096 int xlfd;
5098 if (EQ (attr, QCwidth))
5099 xlfd = XLFD_SWIDTH;
5100 else if (EQ (attr, QCheight))
5101 xlfd = XLFD_POINT_SIZE;
5102 else if (EQ (attr, QCweight))
5103 xlfd = XLFD_WEIGHT;
5104 else if (EQ (attr, QCslant))
5105 xlfd = XLFD_SLANT;
5106 else
5107 break;
5109 if (indices[i] != 0)
5110 break;
5111 indices[i] = xlfd;
5114 if (!NILP (list) || i != ARRAYELTS (indices))
5115 signal_error ("Invalid font sort order", order);
5116 for (i = 0; i < ARRAYELTS (font_sort_order); ++i)
5117 if (indices[i] == 0)
5118 signal_error ("Invalid font sort order", order);
5120 if (memcmp (indices, font_sort_order, sizeof indices) != 0)
5122 memcpy (font_sort_order, indices, sizeof font_sort_order);
5123 free_all_realized_faces (Qnil);
5126 font_update_sort_order (font_sort_order);
5128 return Qnil;
5132 DEFUN ("internal-set-alternative-font-family-alist",
5133 Finternal_set_alternative_font_family_alist,
5134 Sinternal_set_alternative_font_family_alist, 1, 1, 0,
5135 doc: /* Define alternative font families to try in face font selection.
5136 ALIST is an alist of (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...) entries.
5137 Each ALTERNATIVE is tried in order if no fonts of font family FAMILY can
5138 be found. Value is ALIST. */)
5139 (Lisp_Object alist)
5141 Lisp_Object entry, tail, tail2;
5143 CHECK_LIST (alist);
5144 alist = Fcopy_sequence (alist);
5145 for (tail = alist; CONSP (tail); tail = XCDR (tail))
5147 entry = XCAR (tail);
5148 CHECK_LIST (entry);
5149 entry = Fcopy_sequence (entry);
5150 XSETCAR (tail, entry);
5151 for (tail2 = entry; CONSP (tail2); tail2 = XCDR (tail2))
5152 XSETCAR (tail2, Fintern (XCAR (tail2), Qnil));
5155 Vface_alternative_font_family_alist = alist;
5156 free_all_realized_faces (Qnil);
5157 return alist;
5161 DEFUN ("internal-set-alternative-font-registry-alist",
5162 Finternal_set_alternative_font_registry_alist,
5163 Sinternal_set_alternative_font_registry_alist, 1, 1, 0,
5164 doc: /* Define alternative font registries to try in face font selection.
5165 ALIST is an alist of (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...) entries.
5166 Each ALTERNATIVE is tried in order if no fonts of font registry REGISTRY can
5167 be found. Value is ALIST. */)
5168 (Lisp_Object alist)
5170 Lisp_Object entry, tail, tail2;
5172 CHECK_LIST (alist);
5173 alist = Fcopy_sequence (alist);
5174 for (tail = alist; CONSP (tail); tail = XCDR (tail))
5176 entry = XCAR (tail);
5177 CHECK_LIST (entry);
5178 entry = Fcopy_sequence (entry);
5179 XSETCAR (tail, entry);
5180 for (tail2 = entry; CONSP (tail2); tail2 = XCDR (tail2))
5181 XSETCAR (tail2, Fdowncase (XCAR (tail2)));
5183 Vface_alternative_font_registry_alist = alist;
5184 free_all_realized_faces (Qnil);
5185 return alist;
5189 #ifdef HAVE_WINDOW_SYSTEM
5191 /* Return the fontset id of the base fontset name or alias name given
5192 by the fontset attribute of ATTRS. Value is -1 if the fontset
5193 attribute of ATTRS doesn't name a fontset. */
5195 static int
5196 face_fontset (Lisp_Object attrs[LFACE_VECTOR_SIZE])
5198 Lisp_Object name;
5200 name = attrs[LFACE_FONTSET_INDEX];
5201 if (!STRINGP (name))
5202 return -1;
5203 return fs_query_fontset (name, 0);
5206 #endif /* HAVE_WINDOW_SYSTEM */
5210 /***********************************************************************
5211 Face Realization
5212 ***********************************************************************/
5214 /* Realize basic faces on frame F. Value is zero if frame parameters
5215 of F don't contain enough information needed to realize the default
5216 face. */
5218 static bool
5219 realize_basic_faces (struct frame *f)
5221 bool success_p = 0;
5222 ptrdiff_t count = SPECPDL_INDEX ();
5224 /* Block input here so that we won't be surprised by an X expose
5225 event, for instance, without having the faces set up. */
5226 block_input ();
5227 specbind (Qscalable_fonts_allowed, Qt);
5229 if (realize_default_face (f))
5231 realize_named_face (f, Qmode_line, MODE_LINE_FACE_ID);
5232 realize_named_face (f, Qmode_line_inactive, MODE_LINE_INACTIVE_FACE_ID);
5233 realize_named_face (f, Qtool_bar, TOOL_BAR_FACE_ID);
5234 realize_named_face (f, Qfringe, FRINGE_FACE_ID);
5235 realize_named_face (f, Qheader_line, HEADER_LINE_FACE_ID);
5236 realize_named_face (f, Qscroll_bar, SCROLL_BAR_FACE_ID);
5237 realize_named_face (f, Qborder, BORDER_FACE_ID);
5238 realize_named_face (f, Qcursor, CURSOR_FACE_ID);
5239 realize_named_face (f, Qmouse, MOUSE_FACE_ID);
5240 realize_named_face (f, Qmenu, MENU_FACE_ID);
5241 realize_named_face (f, Qvertical_border, VERTICAL_BORDER_FACE_ID);
5242 realize_named_face (f, Qwindow_divider, WINDOW_DIVIDER_FACE_ID);
5243 realize_named_face (f, Qwindow_divider_first_pixel,
5244 WINDOW_DIVIDER_FIRST_PIXEL_FACE_ID);
5245 realize_named_face (f, Qwindow_divider_last_pixel,
5246 WINDOW_DIVIDER_LAST_PIXEL_FACE_ID);
5248 /* Reflect changes in the `menu' face in menu bars. */
5249 if (FRAME_FACE_CACHE (f)->menu_face_changed_p)
5251 FRAME_FACE_CACHE (f)->menu_face_changed_p = 0;
5252 #ifdef USE_X_TOOLKIT
5253 if (FRAME_WINDOW_P (f))
5254 x_update_menu_appearance (f);
5255 #endif
5258 success_p = 1;
5261 unbind_to (count, Qnil);
5262 unblock_input ();
5263 return success_p;
5267 /* Realize the default face on frame F. If the face is not fully
5268 specified, make it fully-specified. Attributes of the default face
5269 that are not explicitly specified are taken from frame parameters. */
5271 static bool
5272 realize_default_face (struct frame *f)
5274 struct face_cache *c = FRAME_FACE_CACHE (f);
5275 Lisp_Object lface;
5276 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5277 struct face *face;
5279 /* If the `default' face is not yet known, create it. */
5280 lface = lface_from_face_name (f, Qdefault, 0);
5281 if (NILP (lface))
5283 Lisp_Object frame;
5284 XSETFRAME (frame, f);
5285 lface = Finternal_make_lisp_face (Qdefault, frame);
5288 #ifdef HAVE_WINDOW_SYSTEM
5289 if (FRAME_WINDOW_P (f))
5291 Lisp_Object font_object;
5293 XSETFONT (font_object, FRAME_FONT (f));
5294 set_lface_from_font (f, lface, font_object, f->default_face_done_p);
5295 ASET (lface, LFACE_FONTSET_INDEX, fontset_name (FRAME_FONTSET (f)));
5296 f->default_face_done_p = 1;
5298 #endif /* HAVE_WINDOW_SYSTEM */
5300 if (!FRAME_WINDOW_P (f))
5302 ASET (lface, LFACE_FAMILY_INDEX, build_string ("default"));
5303 ASET (lface, LFACE_FOUNDRY_INDEX, LFACE_FAMILY (lface));
5304 ASET (lface, LFACE_SWIDTH_INDEX, Qnormal);
5305 ASET (lface, LFACE_HEIGHT_INDEX, make_number (1));
5306 if (UNSPECIFIEDP (LFACE_WEIGHT (lface)))
5307 ASET (lface, LFACE_WEIGHT_INDEX, Qnormal);
5308 if (UNSPECIFIEDP (LFACE_SLANT (lface)))
5309 ASET (lface, LFACE_SLANT_INDEX, Qnormal);
5310 if (UNSPECIFIEDP (LFACE_FONTSET (lface)))
5311 ASET (lface, LFACE_FONTSET_INDEX, Qnil);
5314 if (UNSPECIFIEDP (LFACE_UNDERLINE (lface)))
5315 ASET (lface, LFACE_UNDERLINE_INDEX, Qnil);
5317 if (UNSPECIFIEDP (LFACE_OVERLINE (lface)))
5318 ASET (lface, LFACE_OVERLINE_INDEX, Qnil);
5320 if (UNSPECIFIEDP (LFACE_STRIKE_THROUGH (lface)))
5321 ASET (lface, LFACE_STRIKE_THROUGH_INDEX, Qnil);
5323 if (UNSPECIFIEDP (LFACE_BOX (lface)))
5324 ASET (lface, LFACE_BOX_INDEX, Qnil);
5326 if (UNSPECIFIEDP (LFACE_INVERSE (lface)))
5327 ASET (lface, LFACE_INVERSE_INDEX, Qnil);
5329 if (UNSPECIFIEDP (LFACE_FOREGROUND (lface)))
5331 /* This function is called so early that colors are not yet
5332 set in the frame parameter list. */
5333 Lisp_Object color = Fassq (Qforeground_color, f->param_alist);
5335 if (CONSP (color) && STRINGP (XCDR (color)))
5336 ASET (lface, LFACE_FOREGROUND_INDEX, XCDR (color));
5337 else if (FRAME_WINDOW_P (f))
5338 return 0;
5339 else if (FRAME_INITIAL_P (f) || FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5340 ASET (lface, LFACE_FOREGROUND_INDEX, build_string (unspecified_fg));
5341 else
5342 emacs_abort ();
5345 if (UNSPECIFIEDP (LFACE_BACKGROUND (lface)))
5347 /* This function is called so early that colors are not yet
5348 set in the frame parameter list. */
5349 Lisp_Object color = Fassq (Qbackground_color, f->param_alist);
5350 if (CONSP (color) && STRINGP (XCDR (color)))
5351 ASET (lface, LFACE_BACKGROUND_INDEX, XCDR (color));
5352 else if (FRAME_WINDOW_P (f))
5353 return 0;
5354 else if (FRAME_INITIAL_P (f) || FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5355 ASET (lface, LFACE_BACKGROUND_INDEX, build_string (unspecified_bg));
5356 else
5357 emacs_abort ();
5360 if (UNSPECIFIEDP (LFACE_STIPPLE (lface)))
5361 ASET (lface, LFACE_STIPPLE_INDEX, Qnil);
5363 /* Realize the face; it must be fully-specified now. */
5364 eassert (lface_fully_specified_p (XVECTOR (lface)->contents));
5365 check_lface (lface);
5366 memcpy (attrs, XVECTOR (lface)->contents, sizeof attrs);
5367 face = realize_face (c, attrs, DEFAULT_FACE_ID);
5369 #ifdef HAVE_WINDOW_SYSTEM
5370 #ifdef HAVE_X_WINDOWS
5371 if (FRAME_X_P (f) && face->font != FRAME_FONT (f))
5373 /* This can happen when making a frame on a display that does
5374 not support the default font. */
5375 if (!face->font)
5376 return 0;
5378 /* Otherwise, the font specified for the frame was not
5379 acceptable as a font for the default face (perhaps because
5380 auto-scaled fonts are rejected), so we must adjust the frame
5381 font. */
5382 x_set_font (f, LFACE_FONT (lface), Qnil);
5384 #endif /* HAVE_X_WINDOWS */
5385 #endif /* HAVE_WINDOW_SYSTEM */
5386 return 1;
5390 /* Realize basic faces other than the default face in face cache C.
5391 SYMBOL is the face name, ID is the face id the realized face must
5392 have. The default face must have been realized already. */
5394 static void
5395 realize_named_face (struct frame *f, Lisp_Object symbol, int id)
5397 struct face_cache *c = FRAME_FACE_CACHE (f);
5398 Lisp_Object lface = lface_from_face_name (f, symbol, 0);
5399 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5400 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
5402 /* The default face must exist and be fully specified. */
5403 get_lface_attributes_no_remap (f, Qdefault, attrs, 1);
5404 check_lface_attrs (attrs);
5405 eassert (lface_fully_specified_p (attrs));
5407 /* If SYMBOL isn't know as a face, create it. */
5408 if (NILP (lface))
5410 Lisp_Object frame;
5411 XSETFRAME (frame, f);
5412 lface = Finternal_make_lisp_face (symbol, frame);
5415 /* Merge SYMBOL's face with the default face. */
5416 get_lface_attributes_no_remap (f, symbol, symbol_attrs, 1);
5417 merge_face_vectors (f, symbol_attrs, attrs, 0);
5419 /* Realize the face. */
5420 realize_face (c, attrs, id);
5424 /* Realize the fully-specified face with attributes ATTRS in face
5425 cache CACHE for ASCII characters. If FORMER_FACE_ID is
5426 non-negative, it is an ID of face to remove before caching the new
5427 face. Value is a pointer to the newly created realized face. */
5429 static struct face *
5430 realize_face (struct face_cache *cache, Lisp_Object attrs[LFACE_VECTOR_SIZE],
5431 int former_face_id)
5433 struct face *face;
5435 /* LFACE must be fully specified. */
5436 eassert (cache != NULL);
5437 check_lface_attrs (attrs);
5439 if (former_face_id >= 0 && cache->used > former_face_id)
5441 /* Remove the former face. */
5442 struct face *former_face = cache->faces_by_id[former_face_id];
5443 uncache_face (cache, former_face);
5444 free_realized_face (cache->f, former_face);
5445 SET_FRAME_GARBAGED (cache->f);
5448 if (FRAME_WINDOW_P (cache->f))
5449 face = realize_x_face (cache, attrs);
5450 else if (FRAME_TERMCAP_P (cache->f) || FRAME_MSDOS_P (cache->f))
5451 face = realize_tty_face (cache, attrs);
5452 else if (FRAME_INITIAL_P (cache->f))
5454 /* Create a dummy face. */
5455 face = make_realized_face (attrs);
5457 else
5458 emacs_abort ();
5460 /* Insert the new face. */
5461 cache_face (cache, face, lface_hash (attrs));
5462 return face;
5466 #ifdef HAVE_WINDOW_SYSTEM
5467 /* Realize the fully-specified face that uses FONT-OBJECT and has the
5468 same attributes as BASE_FACE except for the font on frame F.
5469 FONT-OBJECT may be nil, in which case, realized a face of
5470 no-font. */
5472 static struct face *
5473 realize_non_ascii_face (struct frame *f, Lisp_Object font_object,
5474 struct face *base_face)
5476 struct face_cache *cache = FRAME_FACE_CACHE (f);
5477 struct face *face;
5479 face = xmalloc (sizeof *face);
5480 *face = *base_face;
5481 face->gc = 0;
5482 face->overstrike
5483 = (! NILP (font_object)
5484 && FONT_WEIGHT_NAME_NUMERIC (face->lface[LFACE_WEIGHT_INDEX]) > 100
5485 && FONT_WEIGHT_NUMERIC (font_object) <= 100);
5487 /* Don't try to free the colors copied bitwise from BASE_FACE. */
5488 face->colors_copied_bitwise_p = 1;
5489 face->font = NILP (font_object) ? NULL : XFONT_OBJECT (font_object);
5490 face->gc = 0;
5492 cache_face (cache, face, face->hash);
5494 return face;
5496 #endif /* HAVE_WINDOW_SYSTEM */
5499 /* Realize the fully-specified face with attributes ATTRS in face
5500 cache CACHE for ASCII characters. Do it for X frame CACHE->f. If
5501 the new face doesn't share font with the default face, a fontname
5502 is allocated from the heap and set in `font_name' of the new face,
5503 but it is not yet loaded here. Value is a pointer to the newly
5504 created realized face. */
5506 static struct face *
5507 realize_x_face (struct face_cache *cache, Lisp_Object attrs[LFACE_VECTOR_SIZE])
5509 struct face *face = NULL;
5510 #ifdef HAVE_WINDOW_SYSTEM
5511 struct face *default_face;
5512 struct frame *f;
5513 Lisp_Object stipple, underline, overline, strike_through, box;
5515 eassert (FRAME_WINDOW_P (cache->f));
5517 /* Allocate a new realized face. */
5518 face = make_realized_face (attrs);
5519 face->ascii_face = face;
5521 f = cache->f;
5523 /* Determine the font to use. Most of the time, the font will be
5524 the same as the font of the default face, so try that first. */
5525 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5526 if (default_face
5527 && lface_same_font_attributes_p (default_face->lface, attrs))
5529 face->font = default_face->font;
5530 face->fontset
5531 = make_fontset_for_ascii_face (f, default_face->fontset, face);
5533 else
5535 /* If the face attribute ATTRS specifies a fontset, use it as
5536 the base of a new realized fontset. Otherwise, use the same
5537 base fontset as of the default face. The base determines
5538 registry and encoding of a font. It may also determine
5539 foundry and family. The other fields of font name pattern
5540 are constructed from ATTRS. */
5541 int fontset = face_fontset (attrs);
5543 /* If we are realizing the default face, ATTRS should specify a
5544 fontset. In other words, if FONTSET is -1, we are not
5545 realizing the default face, thus the default face should have
5546 already been realized. */
5547 if (fontset == -1)
5549 if (default_face)
5550 fontset = default_face->fontset;
5551 if (fontset == -1)
5552 emacs_abort ();
5554 if (! FONT_OBJECT_P (attrs[LFACE_FONT_INDEX]))
5555 attrs[LFACE_FONT_INDEX]
5556 = font_load_for_lface (f, attrs, Ffont_spec (0, NULL));
5557 if (FONT_OBJECT_P (attrs[LFACE_FONT_INDEX]))
5559 face->font = XFONT_OBJECT (attrs[LFACE_FONT_INDEX]);
5560 face->fontset = make_fontset_for_ascii_face (f, fontset, face);
5562 else
5564 face->font = NULL;
5565 face->fontset = -1;
5569 if (face->font
5570 && FONT_WEIGHT_NAME_NUMERIC (attrs[LFACE_WEIGHT_INDEX]) > 100
5571 && FONT_WEIGHT_NUMERIC (attrs[LFACE_FONT_INDEX]) <= 100)
5572 face->overstrike = 1;
5574 /* Load colors, and set remaining attributes. */
5576 load_face_colors (f, face, attrs);
5578 /* Set up box. */
5579 box = attrs[LFACE_BOX_INDEX];
5580 if (STRINGP (box))
5582 /* A simple box of line width 1 drawn in color given by
5583 the string. */
5584 face->box_color = load_color (f, face, attrs[LFACE_BOX_INDEX],
5585 LFACE_BOX_INDEX);
5586 face->box = FACE_SIMPLE_BOX;
5587 face->box_line_width = 1;
5589 else if (INTEGERP (box))
5591 /* Simple box of specified line width in foreground color of the
5592 face. */
5593 eassert (XINT (box) != 0);
5594 face->box = FACE_SIMPLE_BOX;
5595 face->box_line_width = XINT (box);
5596 face->box_color = face->foreground;
5597 face->box_color_defaulted_p = 1;
5599 else if (CONSP (box))
5601 /* `(:width WIDTH :color COLOR :shadow SHADOW)'. SHADOW
5602 being one of `raised' or `sunken'. */
5603 face->box = FACE_SIMPLE_BOX;
5604 face->box_color = face->foreground;
5605 face->box_color_defaulted_p = 1;
5606 face->box_line_width = 1;
5608 while (CONSP (box))
5610 Lisp_Object keyword, value;
5612 keyword = XCAR (box);
5613 box = XCDR (box);
5615 if (!CONSP (box))
5616 break;
5617 value = XCAR (box);
5618 box = XCDR (box);
5620 if (EQ (keyword, QCline_width))
5622 if (INTEGERP (value) && XINT (value) != 0)
5623 face->box_line_width = XINT (value);
5625 else if (EQ (keyword, QCcolor))
5627 if (STRINGP (value))
5629 face->box_color = load_color (f, face, value,
5630 LFACE_BOX_INDEX);
5631 face->use_box_color_for_shadows_p = 1;
5634 else if (EQ (keyword, QCstyle))
5636 if (EQ (value, Qreleased_button))
5637 face->box = FACE_RAISED_BOX;
5638 else if (EQ (value, Qpressed_button))
5639 face->box = FACE_SUNKEN_BOX;
5644 /* Text underline, overline, strike-through. */
5646 underline = attrs[LFACE_UNDERLINE_INDEX];
5647 if (EQ (underline, Qt))
5649 /* Use default color (same as foreground color). */
5650 face->underline_p = 1;
5651 face->underline_type = FACE_UNDER_LINE;
5652 face->underline_defaulted_p = 1;
5653 face->underline_color = 0;
5655 else if (STRINGP (underline))
5657 /* Use specified color. */
5658 face->underline_p = 1;
5659 face->underline_type = FACE_UNDER_LINE;
5660 face->underline_defaulted_p = 0;
5661 face->underline_color
5662 = load_color (f, face, underline,
5663 LFACE_UNDERLINE_INDEX);
5665 else if (NILP (underline))
5667 face->underline_p = 0;
5668 face->underline_defaulted_p = 0;
5669 face->underline_color = 0;
5671 else if (CONSP (underline))
5673 /* `(:color COLOR :style STYLE)'.
5674 STYLE being one of `line' or `wave'. */
5675 face->underline_p = 1;
5676 face->underline_color = 0;
5677 face->underline_defaulted_p = 1;
5678 face->underline_type = FACE_UNDER_LINE;
5680 /* FIXME? This is also not robust about checking the precise form.
5681 See comments in Finternal_set_lisp_face_attribute. */
5682 while (CONSP (underline))
5684 Lisp_Object keyword, value;
5686 keyword = XCAR (underline);
5687 underline = XCDR (underline);
5689 if (!CONSP (underline))
5690 break;
5691 value = XCAR (underline);
5692 underline = XCDR (underline);
5694 if (EQ (keyword, QCcolor))
5696 if (EQ (value, Qforeground_color))
5698 face->underline_defaulted_p = 1;
5699 face->underline_color = 0;
5701 else if (STRINGP (value))
5703 face->underline_defaulted_p = 0;
5704 face->underline_color = load_color (f, face, value,
5705 LFACE_UNDERLINE_INDEX);
5708 else if (EQ (keyword, QCstyle))
5710 if (EQ (value, Qline))
5711 face->underline_type = FACE_UNDER_LINE;
5712 else if (EQ (value, Qwave))
5713 face->underline_type = FACE_UNDER_WAVE;
5718 overline = attrs[LFACE_OVERLINE_INDEX];
5719 if (STRINGP (overline))
5721 face->overline_color
5722 = load_color (f, face, attrs[LFACE_OVERLINE_INDEX],
5723 LFACE_OVERLINE_INDEX);
5724 face->overline_p = 1;
5726 else if (EQ (overline, Qt))
5728 face->overline_color = face->foreground;
5729 face->overline_color_defaulted_p = 1;
5730 face->overline_p = 1;
5733 strike_through = attrs[LFACE_STRIKE_THROUGH_INDEX];
5734 if (STRINGP (strike_through))
5736 face->strike_through_color
5737 = load_color (f, face, attrs[LFACE_STRIKE_THROUGH_INDEX],
5738 LFACE_STRIKE_THROUGH_INDEX);
5739 face->strike_through_p = 1;
5741 else if (EQ (strike_through, Qt))
5743 face->strike_through_color = face->foreground;
5744 face->strike_through_color_defaulted_p = 1;
5745 face->strike_through_p = 1;
5748 stipple = attrs[LFACE_STIPPLE_INDEX];
5749 if (!NILP (stipple))
5750 face->stipple = load_pixmap (f, stipple);
5751 #endif /* HAVE_WINDOW_SYSTEM */
5753 return face;
5757 /* Map a specified color of face FACE on frame F to a tty color index.
5758 IDX is either LFACE_FOREGROUND_INDEX or LFACE_BACKGROUND_INDEX, and
5759 specifies which color to map. Set *DEFAULTED to 1 if mapping to the
5760 default foreground/background colors. */
5762 static void
5763 map_tty_color (struct frame *f, struct face *face,
5764 enum lface_attribute_index idx, int *defaulted)
5766 Lisp_Object frame, color, def;
5767 int foreground_p = idx == LFACE_FOREGROUND_INDEX;
5768 unsigned long default_pixel =
5769 foreground_p ? FACE_TTY_DEFAULT_FG_COLOR : FACE_TTY_DEFAULT_BG_COLOR;
5770 unsigned long pixel = default_pixel;
5771 #ifdef MSDOS
5772 unsigned long default_other_pixel =
5773 foreground_p ? FACE_TTY_DEFAULT_BG_COLOR : FACE_TTY_DEFAULT_FG_COLOR;
5774 #endif
5776 eassert (idx == LFACE_FOREGROUND_INDEX || idx == LFACE_BACKGROUND_INDEX);
5778 XSETFRAME (frame, f);
5779 color = face->lface[idx];
5781 if (STRINGP (color)
5782 && SCHARS (color)
5783 && CONSP (Vtty_defined_color_alist)
5784 && (def = assq_no_quit (color, call1 (Qtty_color_alist, frame)),
5785 CONSP (def)))
5787 /* Associations in tty-defined-color-alist are of the form
5788 (NAME INDEX R G B). We need the INDEX part. */
5789 pixel = XINT (XCAR (XCDR (def)));
5792 if (pixel == default_pixel && STRINGP (color))
5794 pixel = load_color (f, face, color, idx);
5796 #ifdef MSDOS
5797 /* If the foreground of the default face is the default color,
5798 use the foreground color defined by the frame. */
5799 if (FRAME_MSDOS_P (f))
5801 if (pixel == default_pixel
5802 || pixel == FACE_TTY_DEFAULT_COLOR)
5804 if (foreground_p)
5805 pixel = FRAME_FOREGROUND_PIXEL (f);
5806 else
5807 pixel = FRAME_BACKGROUND_PIXEL (f);
5808 face->lface[idx] = tty_color_name (f, pixel);
5809 *defaulted = 1;
5811 else if (pixel == default_other_pixel)
5813 if (foreground_p)
5814 pixel = FRAME_BACKGROUND_PIXEL (f);
5815 else
5816 pixel = FRAME_FOREGROUND_PIXEL (f);
5817 face->lface[idx] = tty_color_name (f, pixel);
5818 *defaulted = 1;
5821 #endif /* MSDOS */
5824 if (foreground_p)
5825 face->foreground = pixel;
5826 else
5827 face->background = pixel;
5831 /* Realize the fully-specified face with attributes ATTRS in face
5832 cache CACHE for ASCII characters. Do it for TTY frame CACHE->f.
5833 Value is a pointer to the newly created realized face. */
5835 static struct face *
5836 realize_tty_face (struct face_cache *cache,
5837 Lisp_Object attrs[LFACE_VECTOR_SIZE])
5839 struct face *face;
5840 int weight, slant;
5841 int face_colors_defaulted = 0;
5842 struct frame *f = cache->f;
5844 /* Frame must be a termcap frame. */
5845 eassert (FRAME_TERMCAP_P (cache->f) || FRAME_MSDOS_P (cache->f));
5847 /* Allocate a new realized face. */
5848 face = make_realized_face (attrs);
5849 #if 0
5850 face->font_name = FRAME_MSDOS_P (cache->f) ? "ms-dos" : "tty";
5851 #endif
5853 /* Map face attributes to TTY appearances. */
5854 weight = FONT_WEIGHT_NAME_NUMERIC (attrs[LFACE_WEIGHT_INDEX]);
5855 slant = FONT_SLANT_NAME_NUMERIC (attrs[LFACE_SLANT_INDEX]);
5856 if (weight > 100)
5857 face->tty_bold_p = 1;
5858 if (slant != 100)
5859 face->tty_italic_p = 1;
5860 if (!NILP (attrs[LFACE_UNDERLINE_INDEX]))
5861 face->tty_underline_p = 1;
5862 if (!NILP (attrs[LFACE_INVERSE_INDEX]))
5863 face->tty_reverse_p = 1;
5865 /* Map color names to color indices. */
5866 map_tty_color (f, face, LFACE_FOREGROUND_INDEX, &face_colors_defaulted);
5867 map_tty_color (f, face, LFACE_BACKGROUND_INDEX, &face_colors_defaulted);
5869 /* Swap colors if face is inverse-video. If the colors are taken
5870 from the frame colors, they are already inverted, since the
5871 frame-creation function calls x-handle-reverse-video. */
5872 if (face->tty_reverse_p && !face_colors_defaulted)
5874 unsigned long tem = face->foreground;
5875 face->foreground = face->background;
5876 face->background = tem;
5879 if (tty_suppress_bold_inverse_default_colors_p
5880 && face->tty_bold_p
5881 && face->background == FACE_TTY_DEFAULT_FG_COLOR
5882 && face->foreground == FACE_TTY_DEFAULT_BG_COLOR)
5883 face->tty_bold_p = 0;
5885 return face;
5889 DEFUN ("tty-suppress-bold-inverse-default-colors",
5890 Ftty_suppress_bold_inverse_default_colors,
5891 Stty_suppress_bold_inverse_default_colors, 1, 1, 0,
5892 doc: /* Suppress/allow boldness of faces with inverse default colors.
5893 SUPPRESS non-nil means suppress it.
5894 This affects bold faces on TTYs whose foreground is the default background
5895 color of the display and whose background is the default foreground color.
5896 For such faces, the bold face attribute is ignored if this variable
5897 is non-nil. */)
5898 (Lisp_Object suppress)
5900 tty_suppress_bold_inverse_default_colors_p = !NILP (suppress);
5901 ++face_change_count;
5902 return suppress;
5907 /***********************************************************************
5908 Computing Faces
5909 ***********************************************************************/
5911 /* Return the ID of the face to use to display character CH with face
5912 property PROP on frame F in current_buffer. */
5915 compute_char_face (struct frame *f, int ch, Lisp_Object prop)
5917 int face_id;
5919 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
5920 ch = 0;
5922 if (NILP (prop))
5924 struct face *face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5925 face_id = FACE_FOR_CHAR (f, face, ch, -1, Qnil);
5927 else
5929 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5930 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5931 memcpy (attrs, default_face->lface, sizeof attrs);
5932 merge_face_ref (f, prop, attrs, 1, 0);
5933 face_id = lookup_face (f, attrs);
5936 return face_id;
5939 /* Return the face ID associated with buffer position POS for
5940 displaying ASCII characters. Return in *ENDPTR the position at
5941 which a different face is needed, as far as text properties and
5942 overlays are concerned. W is a window displaying current_buffer.
5944 REGION_BEG, REGION_END delimit the region, so it can be
5945 highlighted.
5947 LIMIT is a position not to scan beyond. That is to limit the time
5948 this function can take.
5950 If MOUSE is non-zero, use the character's mouse-face, not its face.
5952 BASE_FACE_ID, if non-negative, specifies a base face id to use
5953 instead of DEFAULT_FACE_ID.
5955 The face returned is suitable for displaying ASCII characters. */
5958 face_at_buffer_position (struct window *w, ptrdiff_t pos,
5959 ptrdiff_t *endptr, ptrdiff_t limit,
5960 int mouse, int base_face_id)
5962 struct frame *f = XFRAME (w->frame);
5963 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5964 Lisp_Object prop, position;
5965 ptrdiff_t i, noverlays;
5966 Lisp_Object *overlay_vec;
5967 ptrdiff_t endpos;
5968 Lisp_Object propname = mouse ? Qmouse_face : Qface;
5969 Lisp_Object limit1, end;
5970 struct face *default_face;
5972 /* W must display the current buffer. We could write this function
5973 to use the frame and buffer of W, but right now it doesn't. */
5974 /* eassert (XBUFFER (w->contents) == current_buffer); */
5976 XSETFASTINT (position, pos);
5978 endpos = ZV;
5980 /* Get the `face' or `mouse_face' text property at POS, and
5981 determine the next position at which the property changes. */
5982 prop = Fget_text_property (position, propname, w->contents);
5983 XSETFASTINT (limit1, (limit < endpos ? limit : endpos));
5984 end = Fnext_single_property_change (position, propname, w->contents, limit1);
5985 if (INTEGERP (end))
5986 endpos = XINT (end);
5988 /* Look at properties from overlays. */
5989 USE_SAFE_ALLOCA;
5991 ptrdiff_t next_overlay;
5993 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, &next_overlay, 0);
5994 if (next_overlay < endpos)
5995 endpos = next_overlay;
5998 *endptr = endpos;
6001 int face_id;
6003 if (base_face_id >= 0)
6004 face_id = base_face_id;
6005 else if (NILP (Vface_remapping_alist))
6006 face_id = DEFAULT_FACE_ID;
6007 else
6008 face_id = lookup_basic_face (f, DEFAULT_FACE_ID);
6010 default_face = FACE_FROM_ID (f, face_id);
6013 /* Optimize common cases where we can use the default face. */
6014 if (noverlays == 0
6015 && NILP (prop))
6017 SAFE_FREE ();
6018 return default_face->id;
6021 /* Begin with attributes from the default face. */
6022 memcpy (attrs, default_face->lface, sizeof attrs);
6024 /* Merge in attributes specified via text properties. */
6025 if (!NILP (prop))
6026 merge_face_ref (f, prop, attrs, 1, 0);
6028 /* Now merge the overlay data. */
6029 noverlays = sort_overlays (overlay_vec, noverlays, w);
6030 for (i = 0; i < noverlays; i++)
6032 Lisp_Object oend;
6033 ptrdiff_t oendpos;
6035 prop = Foverlay_get (overlay_vec[i], propname);
6036 if (!NILP (prop))
6037 merge_face_ref (f, prop, attrs, 1, 0);
6039 oend = OVERLAY_END (overlay_vec[i]);
6040 oendpos = OVERLAY_POSITION (oend);
6041 if (oendpos < endpos)
6042 endpos = oendpos;
6045 *endptr = endpos;
6047 SAFE_FREE ();
6049 /* Look up a realized face with the given face attributes,
6050 or realize a new one for ASCII characters. */
6051 return lookup_face (f, attrs);
6054 /* Return the face ID at buffer position POS for displaying ASCII
6055 characters associated with overlay strings for overlay OVERLAY.
6057 Like face_at_buffer_position except for OVERLAY. Currently it
6058 simply disregards the `face' properties of all overlays. */
6061 face_for_overlay_string (struct window *w, ptrdiff_t pos,
6062 ptrdiff_t *endptr, ptrdiff_t limit,
6063 int mouse, Lisp_Object overlay)
6065 struct frame *f = XFRAME (w->frame);
6066 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6067 Lisp_Object prop, position;
6068 ptrdiff_t endpos;
6069 Lisp_Object propname = mouse ? Qmouse_face : Qface;
6070 Lisp_Object limit1, end;
6071 struct face *default_face;
6073 /* W must display the current buffer. We could write this function
6074 to use the frame and buffer of W, but right now it doesn't. */
6075 /* eassert (XBUFFER (w->contents) == current_buffer); */
6077 XSETFASTINT (position, pos);
6079 endpos = ZV;
6081 /* Get the `face' or `mouse_face' text property at POS, and
6082 determine the next position at which the property changes. */
6083 prop = Fget_text_property (position, propname, w->contents);
6084 XSETFASTINT (limit1, (limit < endpos ? limit : endpos));
6085 end = Fnext_single_property_change (position, propname, w->contents, limit1);
6086 if (INTEGERP (end))
6087 endpos = XINT (end);
6089 *endptr = endpos;
6091 /* Optimize common case where we can use the default face. */
6092 if (NILP (prop)
6093 && NILP (Vface_remapping_alist))
6094 return DEFAULT_FACE_ID;
6096 /* Begin with attributes from the default face. */
6097 default_face = FACE_FROM_ID (f, lookup_basic_face (f, DEFAULT_FACE_ID));
6098 memcpy (attrs, default_face->lface, sizeof attrs);
6100 /* Merge in attributes specified via text properties. */
6101 if (!NILP (prop))
6102 merge_face_ref (f, prop, attrs, 1, 0);
6104 *endptr = endpos;
6106 /* Look up a realized face with the given face attributes,
6107 or realize a new one for ASCII characters. */
6108 return lookup_face (f, attrs);
6112 /* Compute the face at character position POS in Lisp string STRING on
6113 window W, for ASCII characters.
6115 If STRING is an overlay string, it comes from position BUFPOS in
6116 current_buffer, otherwise BUFPOS is zero to indicate that STRING is
6117 not an overlay string. W must display the current buffer.
6118 REGION_BEG and REGION_END give the start and end positions of the
6119 region; both are -1 if no region is visible.
6121 BASE_FACE_ID is the id of a face to merge with. For strings coming
6122 from overlays or the `display' property it is the face at BUFPOS.
6124 If MOUSE_P is non-zero, use the character's mouse-face, not its face.
6126 Set *ENDPTR to the next position where to check for faces in
6127 STRING; -1 if the face is constant from POS to the end of the
6128 string.
6130 Value is the id of the face to use. The face returned is suitable
6131 for displaying ASCII characters. */
6134 face_at_string_position (struct window *w, Lisp_Object string,
6135 ptrdiff_t pos, ptrdiff_t bufpos,
6136 ptrdiff_t *endptr, enum face_id base_face_id,
6137 int mouse_p)
6139 Lisp_Object prop, position, end, limit;
6140 struct frame *f = XFRAME (WINDOW_FRAME (w));
6141 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6142 struct face *base_face;
6143 bool multibyte_p = STRING_MULTIBYTE (string);
6144 Lisp_Object prop_name = mouse_p ? Qmouse_face : Qface;
6146 /* Get the value of the face property at the current position within
6147 STRING. Value is nil if there is no face property. */
6148 XSETFASTINT (position, pos);
6149 prop = Fget_text_property (position, prop_name, string);
6151 /* Get the next position at which to check for faces. Value of end
6152 is nil if face is constant all the way to the end of the string.
6153 Otherwise it is a string position where to check faces next.
6154 Limit is the maximum position up to which to check for property
6155 changes in Fnext_single_property_change. Strings are usually
6156 short, so set the limit to the end of the string. */
6157 XSETFASTINT (limit, SCHARS (string));
6158 end = Fnext_single_property_change (position, prop_name, string, limit);
6159 if (INTEGERP (end))
6160 *endptr = XFASTINT (end);
6161 else
6162 *endptr = -1;
6164 base_face = FACE_FROM_ID (f, base_face_id);
6165 eassert (base_face);
6167 /* Optimize the default case that there is no face property. */
6168 if (NILP (prop)
6169 && (multibyte_p
6170 /* We can't realize faces for different charsets differently
6171 if we don't have fonts, so we can stop here if not working
6172 on a window-system frame. */
6173 || !FRAME_WINDOW_P (f)
6174 || FACE_SUITABLE_FOR_ASCII_CHAR_P (base_face, 0)))
6175 return base_face->id;
6177 /* Begin with attributes from the base face. */
6178 memcpy (attrs, base_face->lface, sizeof attrs);
6180 /* Merge in attributes specified via text properties. */
6181 if (!NILP (prop))
6182 merge_face_ref (f, prop, attrs, 1, 0);
6184 /* Look up a realized face with the given face attributes,
6185 or realize a new one for ASCII characters. */
6186 return lookup_face (f, attrs);
6190 /* Merge a face into a realized face.
6192 F is frame where faces are (to be) realized.
6194 FACE_NAME is named face to merge.
6196 If FACE_NAME is nil, FACE_ID is face_id of realized face to merge.
6198 If FACE_NAME is t, FACE_ID is lface_id of face to merge.
6200 BASE_FACE_ID is realized face to merge into.
6202 Return new face id.
6206 merge_faces (struct frame *f, Lisp_Object face_name, int face_id,
6207 int base_face_id)
6209 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6210 struct face *base_face;
6212 base_face = FACE_FROM_ID (f, base_face_id);
6213 if (!base_face)
6214 return base_face_id;
6216 if (EQ (face_name, Qt))
6218 if (face_id < 0 || face_id >= lface_id_to_name_size)
6219 return base_face_id;
6220 face_name = lface_id_to_name[face_id];
6221 /* When called during make-frame, lookup_derived_face may fail
6222 if the faces are uninitialized. Don't signal an error. */
6223 face_id = lookup_derived_face (f, face_name, base_face_id, 0);
6224 return (face_id >= 0 ? face_id : base_face_id);
6227 /* Begin with attributes from the base face. */
6228 memcpy (attrs, base_face->lface, sizeof attrs);
6230 if (!NILP (face_name))
6232 if (!merge_named_face (f, face_name, attrs, 0))
6233 return base_face_id;
6235 else
6237 struct face *face;
6238 if (face_id < 0)
6239 return base_face_id;
6240 face = FACE_FROM_ID (f, face_id);
6241 if (!face)
6242 return base_face_id;
6243 merge_face_vectors (f, face->lface, attrs, 0);
6246 /* Look up a realized face with the given face attributes,
6247 or realize a new one for ASCII characters. */
6248 return lookup_face (f, attrs);
6253 #ifndef HAVE_X_WINDOWS
6254 DEFUN ("x-load-color-file", Fx_load_color_file,
6255 Sx_load_color_file, 1, 1, 0,
6256 doc: /* Create an alist of color entries from an external file.
6258 The file should define one named RGB color per line like so:
6259 R G B name
6260 where R,G,B are numbers between 0 and 255 and name is an arbitrary string. */)
6261 (Lisp_Object filename)
6263 FILE *fp;
6264 Lisp_Object cmap = Qnil;
6265 Lisp_Object abspath;
6267 CHECK_STRING (filename);
6268 abspath = Fexpand_file_name (filename, Qnil);
6270 block_input ();
6271 fp = emacs_fopen (SSDATA (abspath), "rt");
6272 if (fp)
6274 char buf[512];
6275 int red, green, blue;
6276 int num;
6278 while (fgets (buf, sizeof (buf), fp) != NULL) {
6279 if (sscanf (buf, "%u %u %u %n", &red, &green, &blue, &num) == 3)
6281 #ifdef HAVE_NTGUI
6282 int color = RGB (red, green, blue);
6283 #else
6284 int color = (red << 16) | (green << 8) | blue;
6285 #endif
6286 char *name = buf + num;
6287 ptrdiff_t len = strlen (name);
6288 len -= 0 < len && name[len - 1] == '\n';
6289 cmap = Fcons (Fcons (make_string (name, len), make_number (color)),
6290 cmap);
6293 fclose (fp);
6295 unblock_input ();
6296 return cmap;
6298 #endif
6301 /***********************************************************************
6302 Tests
6303 ***********************************************************************/
6305 #ifdef GLYPH_DEBUG
6307 /* Print the contents of the realized face FACE to stderr. */
6309 static void
6310 dump_realized_face (struct face *face)
6312 fprintf (stderr, "ID: %d\n", face->id);
6313 #ifdef HAVE_X_WINDOWS
6314 fprintf (stderr, "gc: %p\n", face->gc);
6315 #endif
6316 fprintf (stderr, "foreground: 0x%lx (%s)\n",
6317 face->foreground,
6318 SDATA (face->lface[LFACE_FOREGROUND_INDEX]));
6319 fprintf (stderr, "background: 0x%lx (%s)\n",
6320 face->background,
6321 SDATA (face->lface[LFACE_BACKGROUND_INDEX]));
6322 if (face->font)
6323 fprintf (stderr, "font_name: %s (%s)\n",
6324 SDATA (face->font->props[FONT_NAME_INDEX]),
6325 SDATA (face->lface[LFACE_FAMILY_INDEX]));
6326 #ifdef HAVE_X_WINDOWS
6327 fprintf (stderr, "font = %p\n", face->font);
6328 #endif
6329 fprintf (stderr, "fontset: %d\n", face->fontset);
6330 fprintf (stderr, "underline: %d (%s)\n",
6331 face->underline_p,
6332 SDATA (Fsymbol_name (face->lface[LFACE_UNDERLINE_INDEX])));
6333 fprintf (stderr, "hash: %d\n", face->hash);
6337 DEFUN ("dump-face", Fdump_face, Sdump_face, 0, 1, 0, doc: /* */)
6338 (Lisp_Object n)
6340 if (NILP (n))
6342 int i;
6344 fprintf (stderr, "font selection order: ");
6345 for (i = 0; i < ARRAYELTS (font_sort_order); ++i)
6346 fprintf (stderr, "%d ", font_sort_order[i]);
6347 fprintf (stderr, "\n");
6349 fprintf (stderr, "alternative fonts: ");
6350 debug_print (Vface_alternative_font_family_alist);
6351 fprintf (stderr, "\n");
6353 for (i = 0; i < FRAME_FACE_CACHE (SELECTED_FRAME ())->used; ++i)
6354 Fdump_face (make_number (i));
6356 else
6358 struct face *face;
6359 CHECK_NUMBER (n);
6360 face = FACE_FROM_ID (SELECTED_FRAME (), XINT (n));
6361 if (face == NULL)
6362 error ("Not a valid face");
6363 dump_realized_face (face);
6366 return Qnil;
6370 DEFUN ("show-face-resources", Fshow_face_resources, Sshow_face_resources,
6371 0, 0, 0, doc: /* */)
6372 (void)
6374 fprintf (stderr, "number of colors = %d\n", ncolors_allocated);
6375 fprintf (stderr, "number of pixmaps = %d\n", npixmaps_allocated);
6376 fprintf (stderr, "number of GCs = %d\n", ngcs);
6377 return Qnil;
6380 #endif /* GLYPH_DEBUG */
6384 /***********************************************************************
6385 Initialization
6386 ***********************************************************************/
6388 void
6389 syms_of_xfaces (void)
6391 DEFSYM (Qface, "face");
6392 DEFSYM (Qface_no_inherit, "face-no-inherit");
6393 DEFSYM (Qbitmap_spec_p, "bitmap-spec-p");
6394 DEFSYM (Qframe_set_background_mode, "frame-set-background-mode");
6396 /* Lisp face attribute keywords. */
6397 DEFSYM (QCfamily, ":family");
6398 DEFSYM (QCheight, ":height");
6399 DEFSYM (QCweight, ":weight");
6400 DEFSYM (QCslant, ":slant");
6401 DEFSYM (QCunderline, ":underline");
6402 DEFSYM (QCinverse_video, ":inverse-video");
6403 DEFSYM (QCreverse_video, ":reverse-video");
6404 DEFSYM (QCforeground, ":foreground");
6405 DEFSYM (QCbackground, ":background");
6406 DEFSYM (QCstipple, ":stipple");
6407 DEFSYM (QCwidth, ":width");
6408 DEFSYM (QCfont, ":font");
6409 DEFSYM (QCfontset, ":fontset");
6410 DEFSYM (QCdistant_foreground, ":distant-foreground");
6411 DEFSYM (QCbold, ":bold");
6412 DEFSYM (QCitalic, ":italic");
6413 DEFSYM (QCoverline, ":overline");
6414 DEFSYM (QCstrike_through, ":strike-through");
6415 DEFSYM (QCbox, ":box");
6416 DEFSYM (QCinherit, ":inherit");
6418 /* Symbols used for Lisp face attribute values. */
6419 DEFSYM (QCcolor, ":color");
6420 DEFSYM (QCline_width, ":line-width");
6421 DEFSYM (QCstyle, ":style");
6422 DEFSYM (Qline, "line");
6423 DEFSYM (Qwave, "wave");
6424 DEFSYM (Qreleased_button, "released-button");
6425 DEFSYM (Qpressed_button, "pressed-button");
6426 DEFSYM (Qnormal, "normal");
6427 DEFSYM (Qextra_light, "extra-light");
6428 DEFSYM (Qlight, "light");
6429 DEFSYM (Qsemi_light, "semi-light");
6430 DEFSYM (Qsemi_bold, "semi-bold");
6431 DEFSYM (Qbold, "bold");
6432 DEFSYM (Qextra_bold, "extra-bold");
6433 DEFSYM (Qultra_bold, "ultra-bold");
6434 DEFSYM (Qoblique, "oblique");
6435 DEFSYM (Qitalic, "italic");
6436 DEFSYM (Qbackground_color, "background-color");
6437 DEFSYM (Qforeground_color, "foreground-color");
6438 DEFSYM (Qunspecified, "unspecified");
6439 DEFSYM (QCignore_defface, ":ignore-defface");
6441 DEFSYM (Qface_alias, "face-alias");
6442 DEFSYM (Qdefault, "default");
6443 DEFSYM (Qtool_bar, "tool-bar");
6444 DEFSYM (Qregion, "region");
6445 DEFSYM (Qfringe, "fringe");
6446 DEFSYM (Qheader_line, "header-line");
6447 DEFSYM (Qscroll_bar, "scroll-bar");
6448 DEFSYM (Qmenu, "menu");
6449 DEFSYM (Qcursor, "cursor");
6450 DEFSYM (Qborder, "border");
6451 DEFSYM (Qmouse, "mouse");
6452 DEFSYM (Qmode_line_inactive, "mode-line-inactive");
6453 DEFSYM (Qvertical_border, "vertical-border");
6454 DEFSYM (Qwindow_divider, "window-divider");
6455 DEFSYM (Qwindow_divider_first_pixel, "window-divider-first-pixel");
6456 DEFSYM (Qwindow_divider_last_pixel, "window-divider-last-pixel");
6457 DEFSYM (Qtty_color_desc, "tty-color-desc");
6458 DEFSYM (Qtty_color_standard_values, "tty-color-standard-values");
6459 DEFSYM (Qtty_color_by_index, "tty-color-by-index");
6460 DEFSYM (Qtty_color_alist, "tty-color-alist");
6461 DEFSYM (Qscalable_fonts_allowed, "scalable-fonts-allowed");
6463 Vparam_value_alist = list1 (Fcons (Qnil, Qnil));
6464 staticpro (&Vparam_value_alist);
6465 Vface_alternative_font_family_alist = Qnil;
6466 staticpro (&Vface_alternative_font_family_alist);
6467 Vface_alternative_font_registry_alist = Qnil;
6468 staticpro (&Vface_alternative_font_registry_alist);
6470 defsubr (&Sinternal_make_lisp_face);
6471 defsubr (&Sinternal_lisp_face_p);
6472 defsubr (&Sinternal_set_lisp_face_attribute);
6473 #ifdef HAVE_WINDOW_SYSTEM
6474 defsubr (&Sinternal_set_lisp_face_attribute_from_resource);
6475 #endif
6476 defsubr (&Scolor_gray_p);
6477 defsubr (&Scolor_supported_p);
6478 #ifndef HAVE_X_WINDOWS
6479 defsubr (&Sx_load_color_file);
6480 #endif
6481 defsubr (&Sface_attribute_relative_p);
6482 defsubr (&Smerge_face_attribute);
6483 defsubr (&Sinternal_get_lisp_face_attribute);
6484 defsubr (&Sinternal_lisp_face_attribute_values);
6485 defsubr (&Sinternal_lisp_face_equal_p);
6486 defsubr (&Sinternal_lisp_face_empty_p);
6487 defsubr (&Sinternal_copy_lisp_face);
6488 defsubr (&Sinternal_merge_in_global_face);
6489 defsubr (&Sface_font);
6490 defsubr (&Sframe_face_alist);
6491 defsubr (&Sdisplay_supports_face_attributes_p);
6492 defsubr (&Scolor_distance);
6493 defsubr (&Sinternal_set_font_selection_order);
6494 defsubr (&Sinternal_set_alternative_font_family_alist);
6495 defsubr (&Sinternal_set_alternative_font_registry_alist);
6496 defsubr (&Sface_attributes_as_vector);
6497 #ifdef GLYPH_DEBUG
6498 defsubr (&Sdump_face);
6499 defsubr (&Sshow_face_resources);
6500 #endif /* GLYPH_DEBUG */
6501 defsubr (&Sclear_face_cache);
6502 defsubr (&Stty_suppress_bold_inverse_default_colors);
6504 #if defined DEBUG_X_COLORS && defined HAVE_X_WINDOWS
6505 defsubr (&Sdump_colors);
6506 #endif
6508 DEFVAR_LISP ("face-new-frame-defaults", Vface_new_frame_defaults,
6509 doc: /* List of global face definitions (for internal use only.) */);
6510 Vface_new_frame_defaults = Qnil;
6512 DEFVAR_LISP ("face-default-stipple", Vface_default_stipple,
6513 doc: /* Default stipple pattern used on monochrome displays.
6514 This stipple pattern is used on monochrome displays
6515 instead of shades of gray for a face background color.
6516 See `set-face-stipple' for possible values for this variable. */);
6517 Vface_default_stipple = build_pure_c_string ("gray3");
6519 DEFVAR_LISP ("tty-defined-color-alist", Vtty_defined_color_alist,
6520 doc: /* An alist of defined terminal colors and their RGB values.
6521 See the docstring of `tty-color-alist' for the details. */);
6522 Vtty_defined_color_alist = Qnil;
6524 DEFVAR_LISP ("scalable-fonts-allowed", Vscalable_fonts_allowed,
6525 doc: /* Allowed scalable fonts.
6526 A value of nil means don't allow any scalable fonts.
6527 A value of t means allow any scalable font.
6528 Otherwise, value must be a list of regular expressions. A font may be
6529 scaled if its name matches a regular expression in the list.
6530 Note that if value is nil, a scalable font might still be used, if no
6531 other font of the appropriate family and registry is available. */);
6532 Vscalable_fonts_allowed = Qnil;
6534 DEFVAR_LISP ("face-ignored-fonts", Vface_ignored_fonts,
6535 doc: /* List of ignored fonts.
6536 Each element is a regular expression that matches names of fonts to
6537 ignore. */);
6538 Vface_ignored_fonts = Qnil;
6540 DEFVAR_LISP ("face-remapping-alist", Vface_remapping_alist,
6541 doc: /* Alist of face remappings.
6542 Each element is of the form:
6544 (FACE . REPLACEMENT),
6546 which causes display of the face FACE to use REPLACEMENT instead.
6547 REPLACEMENT is a face specification, i.e. one of the following:
6549 (1) a face name
6550 (2) a property list of attribute/value pairs, or
6551 (3) a list in which each element has the form of (1) or (2).
6553 List values for REPLACEMENT are merged to form the final face
6554 specification, with earlier entries taking precedence, in the same as
6555 as in the `face' text property.
6557 Face-name remapping cycles are suppressed; recursive references use
6558 the underlying face instead of the remapped face. So a remapping of
6559 the form:
6561 (FACE EXTRA-FACE... FACE)
6565 (FACE (FACE-ATTR VAL ...) FACE)
6567 causes EXTRA-FACE... or (FACE-ATTR VAL ...) to be _merged_ with the
6568 existing definition of FACE. Note that this isn't necessary for the
6569 default face, since every face inherits from the default face.
6571 If this variable is made buffer-local, the face remapping takes effect
6572 only in that buffer. For instance, the mode my-mode could define a
6573 face `my-mode-default', and then in the mode setup function, do:
6575 (set (make-local-variable 'face-remapping-alist)
6576 '((default my-mode-default)))).
6578 Because Emacs normally only redraws screen areas when the underlying
6579 buffer contents change, you may need to call `redraw-display' after
6580 changing this variable for it to take effect. */);
6581 Vface_remapping_alist = Qnil;
6583 DEFVAR_LISP ("face-font-rescale-alist", Vface_font_rescale_alist,
6584 doc: /* Alist of fonts vs the rescaling factors.
6585 Each element is a cons (FONT-PATTERN . RESCALE-RATIO), where
6586 FONT-PATTERN is a font-spec or a regular expression matching a font name, and
6587 RESCALE-RATIO is a floating point number to specify how much larger
6588 \(or smaller) font we should use. For instance, if a face requests
6589 a font of 10 point, we actually use a font of 10 * RESCALE-RATIO point. */);
6590 Vface_font_rescale_alist = Qnil;
6592 #ifdef HAVE_WINDOW_SYSTEM
6593 defsubr (&Sbitmap_spec_p);
6594 defsubr (&Sx_list_fonts);
6595 defsubr (&Sinternal_face_x_get_resource);
6596 defsubr (&Sx_family_fonts);
6597 #endif