Remove duplicate #include directives.
[emacs/old-mirror.git] / src / xfaces.c
blob0c627d7f9ee7449ac76bd53f904051d3d3bb744b
1 /* xfaces.c -- "Face" primitives.
3 Copyright (C) 1993-1994, 1998-2013 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 <stdio.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 HAVE_X_WINDOWS
215 #include "xterm.h"
216 #ifdef USE_MOTIF
217 #include <Xm/Xm.h>
218 #include <Xm/XmStrDefs.h>
219 #endif /* USE_MOTIF */
220 #endif /* HAVE_X_WINDOWS */
222 #ifdef MSDOS
223 #include "dosfns.h"
224 #endif
226 #ifdef HAVE_WINDOW_SYSTEM
227 #include TERM_HEADER
228 #include "fontset.h"
229 #ifdef HAVE_NTGUI
230 #undef FRAME_X_DISPLAY_INFO
231 #define FRAME_X_DISPLAY_INFO FRAME_W32_DISPLAY_INFO
232 #define x_display_info w32_display_info
233 #define GCGraphicsExposures 0
234 #endif /* HAVE_NTGUI */
236 #ifdef HAVE_NS
237 #undef FRAME_X_DISPLAY_INFO
238 #define FRAME_X_DISPLAY_INFO FRAME_NS_DISPLAY_INFO
239 #define x_display_info ns_display_info
240 #define GCGraphicsExposures 0
241 #endif /* HAVE_NS */
242 #endif /* HAVE_WINDOW_SYSTEM */
244 #include "buffer.h"
245 #include "dispextern.h"
246 #include "blockinput.h"
247 #include "window.h"
248 #include "intervals.h"
249 #include "termchar.h"
251 #include "font.h"
253 #ifdef HAVE_X_WINDOWS
255 /* Compensate for a bug in Xos.h on some systems, on which it requires
256 time.h. On some such systems, Xos.h tries to redefine struct
257 timeval and struct timezone if USG is #defined while it is
258 #included. */
260 #ifdef XOS_NEEDS_TIME_H
261 #include <time.h>
262 #undef USG
263 #include <X11/Xos.h>
264 #define USG
265 #define __TIMEVAL__
266 #if defined USG || defined __TIMEVAL__ /* Don't warn about unused macros. */
267 #endif
268 #else /* not XOS_NEEDS_TIME_H */
269 #include <X11/Xos.h>
270 #endif /* not XOS_NEEDS_TIME_H */
272 #endif /* HAVE_X_WINDOWS */
274 #include <c-ctype.h>
276 /* Number of pt per inch (from the TeXbook). */
278 #define PT_PER_INCH 72.27
280 /* Non-zero if face attribute ATTR is unspecified. */
282 #define UNSPECIFIEDP(ATTR) EQ ((ATTR), Qunspecified)
284 /* Non-zero if face attribute ATTR is `ignore-defface'. */
286 #define IGNORE_DEFFACE_P(ATTR) EQ ((ATTR), QCignore_defface)
288 /* Value is the number of elements of VECTOR. */
290 #define DIM(VECTOR) (sizeof (VECTOR) / sizeof *(VECTOR))
292 /* Size of hash table of realized faces in face caches (should be a
293 prime number). */
295 #define FACE_CACHE_BUCKETS_SIZE 1001
297 /* Keyword symbols used for face attribute names. */
299 Lisp_Object QCfamily, QCheight, QCweight, QCslant;
300 static Lisp_Object QCunderline;
301 static Lisp_Object QCinverse_video, QCstipple;
302 Lisp_Object QCforeground, QCbackground;
303 Lisp_Object QCwidth;
304 static Lisp_Object QCfont, QCbold, QCitalic;
305 static Lisp_Object QCreverse_video;
306 static Lisp_Object QCoverline, QCstrike_through, QCbox, QCinherit;
307 static Lisp_Object QCfontset;
309 /* Symbols used for attribute values. */
311 Lisp_Object Qnormal;
312 Lisp_Object Qbold;
313 static Lisp_Object Qline, Qwave;
314 Lisp_Object Qextra_light, Qlight;
315 Lisp_Object Qsemi_light, Qsemi_bold, Qextra_bold, Qultra_bold;
316 Lisp_Object Qoblique;
317 Lisp_Object Qitalic;
318 static Lisp_Object Qreleased_button, Qpressed_button;
319 static Lisp_Object QCstyle, QCcolor, QCline_width;
320 Lisp_Object Qunspecified; /* used in dosfns.c */
321 static Lisp_Object QCignore_defface;
323 char unspecified_fg[] = "unspecified-fg", unspecified_bg[] = "unspecified-bg";
325 /* The name of the function to call when the background of the frame
326 has changed, frame_set_background_mode. */
328 static Lisp_Object Qframe_set_background_mode;
330 /* Names of basic faces. */
332 Lisp_Object Qdefault, Qtool_bar, Qfringe;
333 static Lisp_Object Qregion;
334 Lisp_Object Qheader_line, Qscroll_bar, Qcursor;
335 static Lisp_Object Qborder, Qmouse, Qmenu;
336 Lisp_Object Qmode_line_inactive;
337 static Lisp_Object Qvertical_border;
339 /* The symbol `face-alias'. A symbols having that property is an
340 alias for another face. Value of the property is the name of
341 the aliased face. */
343 static Lisp_Object Qface_alias;
345 /* Alist of alternative font families. Each element is of the form
346 (FAMILY FAMILY1 FAMILY2 ...). If fonts of FAMILY can't be loaded,
347 try FAMILY1, then FAMILY2, ... */
349 Lisp_Object Vface_alternative_font_family_alist;
351 /* Alist of alternative font registries. Each element is of the form
352 (REGISTRY REGISTRY1 REGISTRY2...). If fonts of REGISTRY can't be
353 loaded, try REGISTRY1, then REGISTRY2, ... */
355 Lisp_Object Vface_alternative_font_registry_alist;
357 /* Allowed scalable fonts. A value of nil means don't allow any
358 scalable fonts. A value of t means allow the use of any scalable
359 font. Otherwise, value must be a list of regular expressions. A
360 font may be scaled if its name matches a regular expression in the
361 list. */
363 static Lisp_Object Qscalable_fonts_allowed;
365 /* The symbols `foreground-color' and `background-color' which can be
366 used as part of a `face' property. This is for compatibility with
367 Emacs 20.2. */
369 Lisp_Object Qforeground_color, Qbackground_color;
371 /* The symbols `face' and `mouse-face' used as text properties. */
373 Lisp_Object Qface;
375 /* Property for basic faces which other faces cannot inherit. */
377 static Lisp_Object Qface_no_inherit;
379 /* Error symbol for wrong_type_argument in load_pixmap. */
381 static Lisp_Object Qbitmap_spec_p;
383 /* The next ID to assign to Lisp faces. */
385 static int next_lface_id;
387 /* A vector mapping Lisp face Id's to face names. */
389 static Lisp_Object *lface_id_to_name;
390 static ptrdiff_t lface_id_to_name_size;
392 /* TTY color-related functions (defined in tty-colors.el). */
394 static Lisp_Object Qtty_color_desc, Qtty_color_by_index, Qtty_color_standard_values;
396 /* The name of the function used to compute colors on TTYs. */
398 static Lisp_Object Qtty_color_alist;
400 /* Counter for calls to clear_face_cache. If this counter reaches
401 CLEAR_FONT_TABLE_COUNT, and a frame has more than
402 CLEAR_FONT_TABLE_NFONTS load, unused fonts are freed. */
404 static int clear_font_table_count;
405 #define CLEAR_FONT_TABLE_COUNT 100
406 #define CLEAR_FONT_TABLE_NFONTS 10
408 /* Non-zero means face attributes have been changed since the last
409 redisplay. Used in redisplay_internal. */
411 int face_change_count;
413 /* Non-zero means don't display bold text if a face's foreground
414 and background colors are the inverse of the default colors of the
415 display. This is a kluge to suppress `bold black' foreground text
416 which is hard to read on an LCD monitor. */
418 static int tty_suppress_bold_inverse_default_colors_p;
420 /* A list of the form `((x . y))' used to avoid consing in
421 Finternal_set_lisp_face_attribute. */
423 static Lisp_Object Vparam_value_alist;
425 /* The total number of colors currently allocated. */
427 #ifdef GLYPH_DEBUG
428 static int ncolors_allocated;
429 static int npixmaps_allocated;
430 static int ngcs;
431 #endif
433 /* Non-zero means the definition of the `menu' face for new frames has
434 been changed. */
436 static int menu_face_changed_default;
439 /* Function prototypes. */
441 struct table_entry;
442 struct named_merge_point;
444 static void set_font_frame_param (Lisp_Object, Lisp_Object);
445 static struct face *realize_face (struct face_cache *, Lisp_Object *,
446 int);
447 static struct face *realize_non_ascii_face (struct frame *, Lisp_Object,
448 struct face *);
449 static struct face *realize_x_face (struct face_cache *, Lisp_Object *);
450 static struct face *realize_tty_face (struct face_cache *, Lisp_Object *);
451 static int realize_basic_faces (struct frame *);
452 static int realize_default_face (struct frame *);
453 static void realize_named_face (struct frame *, Lisp_Object, int);
454 static struct face_cache *make_face_cache (struct frame *);
455 static void clear_face_gcs (struct face_cache *);
456 static void free_face_cache (struct face_cache *);
457 static int merge_face_ref (struct frame *, Lisp_Object, Lisp_Object *,
458 int, struct named_merge_point *);
461 /***********************************************************************
462 Utilities
463 ***********************************************************************/
465 #ifdef HAVE_X_WINDOWS
467 #ifdef DEBUG_X_COLORS
469 /* The following is a poor mans infrastructure for debugging X color
470 allocation problems on displays with PseudoColor-8. Some X servers
471 like 3.3.5 XF86_SVGA with Matrox cards apparently don't implement
472 color reference counts completely so that they don't signal an
473 error when a color is freed whose reference count is already 0.
474 Other X servers do. To help me debug this, the following code
475 implements a simple reference counting schema of its own, for a
476 single display/screen. --gerd. */
478 /* Reference counts for pixel colors. */
480 int color_count[256];
482 /* Register color PIXEL as allocated. */
484 void
485 register_color (unsigned long pixel)
487 eassert (pixel < 256);
488 ++color_count[pixel];
492 /* Register color PIXEL as deallocated. */
494 void
495 unregister_color (unsigned long pixel)
497 eassert (pixel < 256);
498 if (color_count[pixel] > 0)
499 --color_count[pixel];
500 else
501 emacs_abort ();
505 /* Register N colors from PIXELS as deallocated. */
507 void
508 unregister_colors (unsigned long *pixels, int n)
510 int i;
511 for (i = 0; i < n; ++i)
512 unregister_color (pixels[i]);
516 DEFUN ("dump-colors", Fdump_colors, Sdump_colors, 0, 0, 0,
517 doc: /* Dump currently allocated colors to stderr. */)
518 (void)
520 int i, n;
522 fputc ('\n', stderr);
524 for (i = n = 0; i < sizeof color_count / sizeof color_count[0]; ++i)
525 if (color_count[i])
527 fprintf (stderr, "%3d: %5d", i, color_count[i]);
528 ++n;
529 if (n % 5 == 0)
530 fputc ('\n', stderr);
531 else
532 fputc ('\t', stderr);
535 if (n % 5 != 0)
536 fputc ('\n', stderr);
537 return Qnil;
540 #endif /* DEBUG_X_COLORS */
543 /* Free colors used on frame F. PIXELS is an array of NPIXELS pixel
544 color values. Interrupt input must be blocked when this function
545 is called. */
547 void
548 x_free_colors (struct frame *f, long unsigned int *pixels, int npixels)
550 int class = FRAME_X_DISPLAY_INFO (f)->visual->class;
552 /* If display has an immutable color map, freeing colors is not
553 necessary and some servers don't allow it. So don't do it. */
554 if (class != StaticColor && class != StaticGray && class != TrueColor)
556 #ifdef DEBUG_X_COLORS
557 unregister_colors (pixels, npixels);
558 #endif
559 XFreeColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
560 pixels, npixels, 0);
565 #ifdef USE_X_TOOLKIT
567 /* Free colors used on frame F. PIXELS is an array of NPIXELS pixel
568 color values. Interrupt input must be blocked when this function
569 is called. */
571 void
572 x_free_dpy_colors (Display *dpy, Screen *screen, Colormap cmap,
573 long unsigned int *pixels, int npixels)
575 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
576 int class = dpyinfo->visual->class;
578 /* If display has an immutable color map, freeing colors is not
579 necessary and some servers don't allow it. So don't do it. */
580 if (class != StaticColor && class != StaticGray && class != TrueColor)
582 #ifdef DEBUG_X_COLORS
583 unregister_colors (pixels, npixels);
584 #endif
585 XFreeColors (dpy, cmap, pixels, npixels, 0);
588 #endif /* USE_X_TOOLKIT */
590 /* Create and return a GC for use on frame F. GC values and mask
591 are given by XGCV and MASK. */
593 static GC
594 x_create_gc (struct frame *f, long unsigned int mask, XGCValues *xgcv)
596 GC gc;
597 block_input ();
598 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), mask, xgcv);
599 unblock_input ();
600 IF_DEBUG (++ngcs);
601 return gc;
605 /* Free GC which was used on frame F. */
607 static void
608 x_free_gc (struct frame *f, GC gc)
610 eassert (input_blocked_p ());
611 IF_DEBUG (eassert (--ngcs >= 0));
612 XFreeGC (FRAME_X_DISPLAY (f), gc);
615 #endif /* HAVE_X_WINDOWS */
617 #ifdef HAVE_NTGUI
618 /* W32 emulation of GCs */
620 static GC
621 x_create_gc (struct frame *f, unsigned long mask, XGCValues *xgcv)
623 GC gc;
624 block_input ();
625 gc = XCreateGC (NULL, FRAME_W32_WINDOW (f), mask, xgcv);
626 unblock_input ();
627 IF_DEBUG (++ngcs);
628 return gc;
632 /* Free GC which was used on frame F. */
634 static void
635 x_free_gc (struct frame *f, GC gc)
637 IF_DEBUG (eassert (--ngcs >= 0));
638 xfree (gc);
641 #endif /* HAVE_NTGUI */
643 #ifdef HAVE_NS
644 /* NS emulation of GCs */
646 static GC
647 x_create_gc (struct frame *f,
648 unsigned long mask,
649 XGCValues *xgcv)
651 GC gc = xmalloc (sizeof *gc);
652 *gc = *xgcv;
653 return gc;
656 static void
657 x_free_gc (struct frame *f, GC gc)
659 xfree (gc);
661 #endif /* HAVE_NS */
663 /***********************************************************************
664 Frames and faces
665 ***********************************************************************/
667 /* Initialize face cache and basic faces for frame F. */
669 void
670 init_frame_faces (struct frame *f)
672 /* Make a face cache, if F doesn't have one. */
673 if (FRAME_FACE_CACHE (f) == NULL)
674 FRAME_FACE_CACHE (f) = make_face_cache (f);
676 #ifdef HAVE_WINDOW_SYSTEM
677 /* Make the image cache. */
678 if (FRAME_WINDOW_P (f))
680 /* We initialize the image cache when creating the first frame
681 on a terminal, and not during terminal creation. This way,
682 `x-open-connection' on a tty won't create an image cache. */
683 if (FRAME_IMAGE_CACHE (f) == NULL)
684 FRAME_IMAGE_CACHE (f) = make_image_cache ();
685 ++FRAME_IMAGE_CACHE (f)->refcount;
687 #endif /* HAVE_WINDOW_SYSTEM */
689 /* Realize basic faces. Must have enough information in frame
690 parameters to realize basic faces at this point. */
691 #ifdef HAVE_X_WINDOWS
692 if (!FRAME_X_P (f) || FRAME_X_WINDOW (f))
693 #endif
694 #ifdef HAVE_NTGUI
695 if (!FRAME_WINDOW_P (f) || FRAME_W32_WINDOW (f))
696 #endif
697 #ifdef HAVE_NS
698 if (!FRAME_NS_P (f) || FRAME_NS_WINDOW (f))
699 #endif
700 if (!realize_basic_faces (f))
701 emacs_abort ();
705 /* Free face cache of frame F. Called from delete_frame. */
707 void
708 free_frame_faces (struct frame *f)
710 struct face_cache *face_cache = FRAME_FACE_CACHE (f);
712 if (face_cache)
714 free_face_cache (face_cache);
715 FRAME_FACE_CACHE (f) = NULL;
718 #ifdef HAVE_WINDOW_SYSTEM
719 if (FRAME_WINDOW_P (f))
721 struct image_cache *image_cache = FRAME_IMAGE_CACHE (f);
722 if (image_cache)
724 --image_cache->refcount;
725 if (image_cache->refcount == 0)
726 free_image_cache (f);
729 #endif /* HAVE_WINDOW_SYSTEM */
733 /* Clear face caches, and recompute basic faces for frame F. Call
734 this after changing frame parameters on which those faces depend,
735 or when realized faces have been freed due to changing attributes
736 of named faces. */
738 void
739 recompute_basic_faces (struct frame *f)
741 if (FRAME_FACE_CACHE (f))
743 clear_face_cache (0);
744 if (!realize_basic_faces (f))
745 emacs_abort ();
750 /* Clear the face caches of all frames. CLEAR_FONTS_P non-zero means
751 try to free unused fonts, too. */
753 void
754 clear_face_cache (int clear_fonts_p)
756 #ifdef HAVE_WINDOW_SYSTEM
757 Lisp_Object tail, frame;
759 if (clear_fonts_p
760 || ++clear_font_table_count == CLEAR_FONT_TABLE_COUNT)
762 #if 0
763 /* Not yet implemented. */
764 clear_font_cache (frame);
765 #endif
767 /* From time to time see if we can unload some fonts. This also
768 frees all realized faces on all frames. Fonts needed by
769 faces will be loaded again when faces are realized again. */
770 clear_font_table_count = 0;
772 FOR_EACH_FRAME (tail, frame)
774 struct frame *f = XFRAME (frame);
775 if (FRAME_WINDOW_P (f)
776 && FRAME_X_DISPLAY_INFO (f)->n_fonts > CLEAR_FONT_TABLE_NFONTS)
777 free_all_realized_faces (frame);
780 else
782 /* Clear GCs of realized faces. */
783 FOR_EACH_FRAME (tail, frame)
785 struct frame *f = XFRAME (frame);
786 if (FRAME_WINDOW_P (f))
787 clear_face_gcs (FRAME_FACE_CACHE (f));
789 clear_image_caches (Qnil);
791 #endif /* HAVE_WINDOW_SYSTEM */
795 DEFUN ("clear-face-cache", Fclear_face_cache, Sclear_face_cache, 0, 1, 0,
796 doc: /* Clear face caches on all frames.
797 Optional THOROUGHLY non-nil means try to free unused fonts, too. */)
798 (Lisp_Object thoroughly)
800 clear_face_cache (!NILP (thoroughly));
801 ++face_change_count;
802 ++windows_or_buffers_changed;
803 return Qnil;
807 /***********************************************************************
808 X Pixmaps
809 ***********************************************************************/
811 #ifdef HAVE_WINDOW_SYSTEM
813 DEFUN ("bitmap-spec-p", Fbitmap_spec_p, Sbitmap_spec_p, 1, 1, 0,
814 doc: /* Value is non-nil if OBJECT is a valid bitmap specification.
815 A bitmap specification is either a string, a file name, or a list
816 \(WIDTH HEIGHT DATA) where WIDTH is the pixel width of the bitmap,
817 HEIGHT is its height, and DATA is a string containing the bits of
818 the pixmap. Bits are stored row by row, each row occupies
819 \(WIDTH + 7)/8 bytes. */)
820 (Lisp_Object object)
822 int pixmap_p = 0;
824 if (STRINGP (object))
825 /* If OBJECT is a string, it's a file name. */
826 pixmap_p = 1;
827 else if (CONSP (object))
829 /* Otherwise OBJECT must be (WIDTH HEIGHT DATA), WIDTH and
830 HEIGHT must be ints > 0, and DATA must be string large
831 enough to hold a bitmap of the specified size. */
832 Lisp_Object width, height, data;
834 height = width = data = Qnil;
836 if (CONSP (object))
838 width = XCAR (object);
839 object = XCDR (object);
840 if (CONSP (object))
842 height = XCAR (object);
843 object = XCDR (object);
844 if (CONSP (object))
845 data = XCAR (object);
849 if (STRINGP (data)
850 && RANGED_INTEGERP (1, width, INT_MAX)
851 && RANGED_INTEGERP (1, height, INT_MAX))
853 int bytes_per_row = ((XINT (width) + BITS_PER_CHAR - 1)
854 / BITS_PER_CHAR);
855 if (XINT (height) <= SBYTES (data) / bytes_per_row)
856 pixmap_p = 1;
860 return pixmap_p ? Qt : Qnil;
864 /* Load a bitmap according to NAME (which is either a file name or a
865 pixmap spec) for use on frame F. Value is the bitmap_id (see
866 xfns.c). If NAME is nil, return with a bitmap id of zero. If
867 bitmap cannot be loaded, display a message saying so, and return
868 zero. Store the bitmap width in *W_PTR and its height in *H_PTR,
869 if these pointers are not null. */
871 static ptrdiff_t
872 load_pixmap (FRAME_PTR f, Lisp_Object name, unsigned int *w_ptr,
873 unsigned int *h_ptr)
875 ptrdiff_t bitmap_id;
877 if (NILP (name))
878 return 0;
880 CHECK_TYPE (!NILP (Fbitmap_spec_p (name)), Qbitmap_spec_p, name);
882 block_input ();
883 if (CONSP (name))
885 /* Decode a bitmap spec into a bitmap. */
887 int h, w;
888 Lisp_Object bits;
890 w = XINT (Fcar (name));
891 h = XINT (Fcar (Fcdr (name)));
892 bits = Fcar (Fcdr (Fcdr (name)));
894 bitmap_id = x_create_bitmap_from_data (f, SSDATA (bits),
895 w, h);
897 else
899 /* It must be a string -- a file name. */
900 bitmap_id = x_create_bitmap_from_file (f, name);
902 unblock_input ();
904 if (bitmap_id < 0)
906 add_to_log ("Invalid or undefined bitmap `%s'", name, Qnil);
907 bitmap_id = 0;
909 if (w_ptr)
910 *w_ptr = 0;
911 if (h_ptr)
912 *h_ptr = 0;
914 else
916 #ifdef GLYPH_DEBUG
917 ++npixmaps_allocated;
918 #endif
919 if (w_ptr)
920 *w_ptr = x_bitmap_width (f, bitmap_id);
922 if (h_ptr)
923 *h_ptr = x_bitmap_height (f, bitmap_id);
926 return bitmap_id;
929 #endif /* HAVE_WINDOW_SYSTEM */
933 /***********************************************************************
934 X Colors
935 ***********************************************************************/
937 /* Parse RGB_LIST, and fill in the RGB fields of COLOR.
938 RGB_LIST should contain (at least) 3 lisp integers.
939 Return 0 if there's a problem with RGB_LIST, otherwise return 1. */
941 static int
942 parse_rgb_list (Lisp_Object rgb_list, XColor *color)
944 #define PARSE_RGB_LIST_FIELD(field) \
945 if (CONSP (rgb_list) && INTEGERP (XCAR (rgb_list))) \
947 color->field = XINT (XCAR (rgb_list)); \
948 rgb_list = XCDR (rgb_list); \
950 else \
951 return 0;
953 PARSE_RGB_LIST_FIELD (red);
954 PARSE_RGB_LIST_FIELD (green);
955 PARSE_RGB_LIST_FIELD (blue);
957 return 1;
961 /* Lookup on frame F the color described by the lisp string COLOR.
962 The resulting tty color is returned in TTY_COLOR; if STD_COLOR is
963 non-zero, then the `standard' definition of the same color is
964 returned in it. */
966 static bool
967 tty_lookup_color (struct frame *f, Lisp_Object color, XColor *tty_color,
968 XColor *std_color)
970 Lisp_Object frame, color_desc;
972 if (!STRINGP (color) || NILP (Ffboundp (Qtty_color_desc)))
973 return 0;
975 XSETFRAME (frame, f);
977 color_desc = call2 (Qtty_color_desc, color, frame);
978 if (CONSP (color_desc) && CONSP (XCDR (color_desc)))
980 Lisp_Object rgb;
982 if (! INTEGERP (XCAR (XCDR (color_desc))))
983 return 0;
985 tty_color->pixel = XINT (XCAR (XCDR (color_desc)));
987 rgb = XCDR (XCDR (color_desc));
988 if (! parse_rgb_list (rgb, tty_color))
989 return 0;
991 /* Should we fill in STD_COLOR too? */
992 if (std_color)
994 /* Default STD_COLOR to the same as TTY_COLOR. */
995 *std_color = *tty_color;
997 /* Do a quick check to see if the returned descriptor is
998 actually _exactly_ equal to COLOR, otherwise we have to
999 lookup STD_COLOR separately. If it's impossible to lookup
1000 a standard color, we just give up and use TTY_COLOR. */
1001 if ((!STRINGP (XCAR (color_desc))
1002 || NILP (Fstring_equal (color, XCAR (color_desc))))
1003 && !NILP (Ffboundp (Qtty_color_standard_values)))
1005 /* Look up STD_COLOR separately. */
1006 rgb = call1 (Qtty_color_standard_values, color);
1007 if (! parse_rgb_list (rgb, std_color))
1008 return 0;
1012 return 1;
1014 else if (NILP (Fsymbol_value (intern ("tty-defined-color-alist"))))
1015 /* We were called early during startup, and the colors are not
1016 yet set up in tty-defined-color-alist. Don't return a failure
1017 indication, since this produces the annoying "Unable to
1018 load color" messages in the *Messages* buffer. */
1019 return 1;
1020 else
1021 /* tty-color-desc seems to have returned a bad value. */
1022 return 0;
1025 /* A version of defined_color for non-X frames. */
1027 static bool
1028 tty_defined_color (struct frame *f, const char *color_name,
1029 XColor *color_def, bool alloc)
1031 bool status = 1;
1033 /* Defaults. */
1034 color_def->pixel = FACE_TTY_DEFAULT_COLOR;
1035 color_def->red = 0;
1036 color_def->blue = 0;
1037 color_def->green = 0;
1039 if (*color_name)
1040 status = tty_lookup_color (f, build_string (color_name), color_def, NULL);
1042 if (color_def->pixel == FACE_TTY_DEFAULT_COLOR && *color_name)
1044 if (strcmp (color_name, "unspecified-fg") == 0)
1045 color_def->pixel = FACE_TTY_DEFAULT_FG_COLOR;
1046 else if (strcmp (color_name, "unspecified-bg") == 0)
1047 color_def->pixel = FACE_TTY_DEFAULT_BG_COLOR;
1050 if (color_def->pixel != FACE_TTY_DEFAULT_COLOR)
1051 status = 1;
1053 return status;
1057 /* Decide if color named COLOR_NAME is valid for the display
1058 associated with the frame F; if so, return the rgb values in
1059 COLOR_DEF. If ALLOC, allocate a new colormap cell.
1061 This does the right thing for any type of frame. */
1063 static bool
1064 defined_color (struct frame *f, const char *color_name, XColor *color_def,
1065 bool alloc)
1067 if (!FRAME_WINDOW_P (f))
1068 return tty_defined_color (f, color_name, color_def, alloc);
1069 #ifdef HAVE_X_WINDOWS
1070 else if (FRAME_X_P (f))
1071 return x_defined_color (f, color_name, color_def, alloc);
1072 #endif
1073 #ifdef HAVE_NTGUI
1074 else if (FRAME_W32_P (f))
1075 return w32_defined_color (f, color_name, color_def, alloc);
1076 #endif
1077 #ifdef HAVE_NS
1078 else if (FRAME_NS_P (f))
1079 return ns_defined_color (f, color_name, color_def, alloc, 1);
1080 #endif
1081 else
1082 emacs_abort ();
1086 /* Given the index IDX of a tty color on frame F, return its name, a
1087 Lisp string. */
1089 Lisp_Object
1090 tty_color_name (struct frame *f, int idx)
1092 if (idx >= 0 && !NILP (Ffboundp (Qtty_color_by_index)))
1094 Lisp_Object frame;
1095 Lisp_Object coldesc;
1097 XSETFRAME (frame, f);
1098 coldesc = call2 (Qtty_color_by_index, make_number (idx), frame);
1100 if (!NILP (coldesc))
1101 return XCAR (coldesc);
1103 #ifdef MSDOS
1104 /* We can have an MSDOG frame under -nw for a short window of
1105 opportunity before internal_terminal_init is called. DTRT. */
1106 if (FRAME_MSDOS_P (f) && !inhibit_window_system)
1107 return msdos_stdcolor_name (idx);
1108 #endif
1110 if (idx == FACE_TTY_DEFAULT_FG_COLOR)
1111 return build_string (unspecified_fg);
1112 if (idx == FACE_TTY_DEFAULT_BG_COLOR)
1113 return build_string (unspecified_bg);
1115 return Qunspecified;
1119 /* Return non-zero if COLOR_NAME is a shade of gray (or white or
1120 black) on frame F.
1122 The criterion implemented here is not a terribly sophisticated one. */
1124 static int
1125 face_color_gray_p (struct frame *f, const char *color_name)
1127 XColor color;
1128 int gray_p;
1130 if (defined_color (f, color_name, &color, 0))
1131 gray_p = (/* Any color sufficiently close to black counts as gray. */
1132 (color.red < 5000 && color.green < 5000 && color.blue < 5000)
1134 ((eabs (color.red - color.green)
1135 < max (color.red, color.green) / 20)
1136 && (eabs (color.green - color.blue)
1137 < max (color.green, color.blue) / 20)
1138 && (eabs (color.blue - color.red)
1139 < max (color.blue, color.red) / 20)));
1140 else
1141 gray_p = 0;
1143 return gray_p;
1147 /* Return non-zero if color COLOR_NAME can be displayed on frame F.
1148 BACKGROUND_P non-zero means the color will be used as background
1149 color. */
1151 static int
1152 face_color_supported_p (struct frame *f, const char *color_name,
1153 int background_p)
1155 Lisp_Object frame;
1156 XColor not_used;
1158 XSETFRAME (frame, f);
1159 return
1160 #ifdef HAVE_WINDOW_SYSTEM
1161 FRAME_WINDOW_P (f)
1162 ? (!NILP (Fxw_display_color_p (frame))
1163 || xstrcasecmp (color_name, "black") == 0
1164 || xstrcasecmp (color_name, "white") == 0
1165 || (background_p
1166 && face_color_gray_p (f, color_name))
1167 || (!NILP (Fx_display_grayscale_p (frame))
1168 && face_color_gray_p (f, color_name)))
1170 #endif
1171 tty_defined_color (f, color_name, &not_used, 0);
1175 DEFUN ("color-gray-p", Fcolor_gray_p, Scolor_gray_p, 1, 2, 0,
1176 doc: /* Return non-nil if COLOR is a shade of gray (or white or black).
1177 FRAME specifies the frame and thus the display for interpreting COLOR.
1178 If FRAME is nil or omitted, use the selected frame. */)
1179 (Lisp_Object color, Lisp_Object frame)
1181 CHECK_STRING (color);
1182 return (face_color_gray_p (decode_any_frame (frame), SSDATA (color))
1183 ? Qt : Qnil);
1187 DEFUN ("color-supported-p", Fcolor_supported_p,
1188 Scolor_supported_p, 1, 3, 0,
1189 doc: /* Return non-nil if COLOR can be displayed on FRAME.
1190 BACKGROUND-P non-nil means COLOR is used as a background.
1191 Otherwise, this function tells whether it can be used as a foreground.
1192 If FRAME is nil or omitted, use the selected frame.
1193 COLOR must be a valid color name. */)
1194 (Lisp_Object color, Lisp_Object frame, Lisp_Object background_p)
1196 CHECK_STRING (color);
1197 return (face_color_supported_p (decode_any_frame (frame),
1198 SSDATA (color), !NILP (background_p))
1199 ? Qt : Qnil);
1203 /* Load color with name NAME for use by face FACE on frame F.
1204 TARGET_INDEX must be one of LFACE_FOREGROUND_INDEX,
1205 LFACE_BACKGROUND_INDEX, LFACE_UNDERLINE_INDEX, LFACE_OVERLINE_INDEX,
1206 LFACE_STRIKE_THROUGH_INDEX, or LFACE_BOX_INDEX. Value is the
1207 pixel color. If color cannot be loaded, display a message, and
1208 return the foreground, background or underline color of F, but
1209 record that fact in flags of the face so that we don't try to free
1210 these colors. */
1212 unsigned long
1213 load_color (struct frame *f, struct face *face, Lisp_Object name,
1214 enum lface_attribute_index target_index)
1216 XColor color;
1218 eassert (STRINGP (name));
1219 eassert (target_index == LFACE_FOREGROUND_INDEX
1220 || target_index == LFACE_BACKGROUND_INDEX
1221 || target_index == LFACE_UNDERLINE_INDEX
1222 || target_index == LFACE_OVERLINE_INDEX
1223 || target_index == LFACE_STRIKE_THROUGH_INDEX
1224 || target_index == LFACE_BOX_INDEX);
1226 /* if the color map is full, defined_color will return a best match
1227 to the values in an existing cell. */
1228 if (!defined_color (f, SSDATA (name), &color, 1))
1230 add_to_log ("Unable to load color \"%s\"", name, Qnil);
1232 switch (target_index)
1234 case LFACE_FOREGROUND_INDEX:
1235 face->foreground_defaulted_p = 1;
1236 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1237 break;
1239 case LFACE_BACKGROUND_INDEX:
1240 face->background_defaulted_p = 1;
1241 color.pixel = FRAME_BACKGROUND_PIXEL (f);
1242 break;
1244 case LFACE_UNDERLINE_INDEX:
1245 face->underline_defaulted_p = 1;
1246 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1247 break;
1249 case LFACE_OVERLINE_INDEX:
1250 face->overline_color_defaulted_p = 1;
1251 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1252 break;
1254 case LFACE_STRIKE_THROUGH_INDEX:
1255 face->strike_through_color_defaulted_p = 1;
1256 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1257 break;
1259 case LFACE_BOX_INDEX:
1260 face->box_color_defaulted_p = 1;
1261 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1262 break;
1264 default:
1265 emacs_abort ();
1268 #ifdef GLYPH_DEBUG
1269 else
1270 ++ncolors_allocated;
1271 #endif
1273 return color.pixel;
1277 #ifdef HAVE_WINDOW_SYSTEM
1279 /* Load colors for face FACE which is used on frame F. Colors are
1280 specified by slots LFACE_BACKGROUND_INDEX and LFACE_FOREGROUND_INDEX
1281 of ATTRS. If the background color specified is not supported on F,
1282 try to emulate gray colors with a stipple from Vface_default_stipple. */
1284 static void
1285 load_face_colors (struct frame *f, struct face *face,
1286 Lisp_Object attrs[LFACE_VECTOR_SIZE])
1288 Lisp_Object fg, bg;
1290 bg = attrs[LFACE_BACKGROUND_INDEX];
1291 fg = attrs[LFACE_FOREGROUND_INDEX];
1293 /* Swap colors if face is inverse-video. */
1294 if (EQ (attrs[LFACE_INVERSE_INDEX], Qt))
1296 Lisp_Object tmp;
1297 tmp = fg;
1298 fg = bg;
1299 bg = tmp;
1302 /* Check for support for foreground, not for background because
1303 face_color_supported_p is smart enough to know that grays are
1304 "supported" as background because we are supposed to use stipple
1305 for them. */
1306 if (!face_color_supported_p (f, SSDATA (bg), 0)
1307 && !NILP (Fbitmap_spec_p (Vface_default_stipple)))
1309 x_destroy_bitmap (f, face->stipple);
1310 face->stipple = load_pixmap (f, Vface_default_stipple,
1311 &face->pixmap_w, &face->pixmap_h);
1314 face->background = load_color (f, face, bg, LFACE_BACKGROUND_INDEX);
1315 face->foreground = load_color (f, face, fg, LFACE_FOREGROUND_INDEX);
1319 /* Free color PIXEL on frame F. */
1321 void
1322 unload_color (struct frame *f, long unsigned int pixel)
1324 #ifdef HAVE_X_WINDOWS
1325 if (pixel != -1)
1327 block_input ();
1328 x_free_colors (f, &pixel, 1);
1329 unblock_input ();
1331 #endif
1335 /* Free colors allocated for FACE. */
1337 static void
1338 free_face_colors (struct frame *f, struct face *face)
1340 /* PENDING(NS): need to do something here? */
1341 #ifdef HAVE_X_WINDOWS
1342 if (face->colors_copied_bitwise_p)
1343 return;
1345 block_input ();
1347 if (!face->foreground_defaulted_p)
1349 x_free_colors (f, &face->foreground, 1);
1350 IF_DEBUG (--ncolors_allocated);
1353 if (!face->background_defaulted_p)
1355 x_free_colors (f, &face->background, 1);
1356 IF_DEBUG (--ncolors_allocated);
1359 if (face->underline_p
1360 && !face->underline_defaulted_p)
1362 x_free_colors (f, &face->underline_color, 1);
1363 IF_DEBUG (--ncolors_allocated);
1366 if (face->overline_p
1367 && !face->overline_color_defaulted_p)
1369 x_free_colors (f, &face->overline_color, 1);
1370 IF_DEBUG (--ncolors_allocated);
1373 if (face->strike_through_p
1374 && !face->strike_through_color_defaulted_p)
1376 x_free_colors (f, &face->strike_through_color, 1);
1377 IF_DEBUG (--ncolors_allocated);
1380 if (face->box != FACE_NO_BOX
1381 && !face->box_color_defaulted_p)
1383 x_free_colors (f, &face->box_color, 1);
1384 IF_DEBUG (--ncolors_allocated);
1387 unblock_input ();
1388 #endif /* HAVE_X_WINDOWS */
1391 #endif /* HAVE_WINDOW_SYSTEM */
1395 /***********************************************************************
1396 XLFD Font Names
1397 ***********************************************************************/
1399 /* An enumerator for each field of an XLFD font name. */
1401 enum xlfd_field
1403 XLFD_FOUNDRY,
1404 XLFD_FAMILY,
1405 XLFD_WEIGHT,
1406 XLFD_SLANT,
1407 XLFD_SWIDTH,
1408 XLFD_ADSTYLE,
1409 XLFD_PIXEL_SIZE,
1410 XLFD_POINT_SIZE,
1411 XLFD_RESX,
1412 XLFD_RESY,
1413 XLFD_SPACING,
1414 XLFD_AVGWIDTH,
1415 XLFD_REGISTRY,
1416 XLFD_ENCODING,
1417 XLFD_LAST
1420 /* An enumerator for each possible slant value of a font. Taken from
1421 the XLFD specification. */
1423 enum xlfd_slant
1425 XLFD_SLANT_UNKNOWN,
1426 XLFD_SLANT_ROMAN,
1427 XLFD_SLANT_ITALIC,
1428 XLFD_SLANT_OBLIQUE,
1429 XLFD_SLANT_REVERSE_ITALIC,
1430 XLFD_SLANT_REVERSE_OBLIQUE,
1431 XLFD_SLANT_OTHER
1434 /* Relative font weight according to XLFD documentation. */
1436 enum xlfd_weight
1438 XLFD_WEIGHT_UNKNOWN,
1439 XLFD_WEIGHT_ULTRA_LIGHT, /* 10 */
1440 XLFD_WEIGHT_EXTRA_LIGHT, /* 20 */
1441 XLFD_WEIGHT_LIGHT, /* 30 */
1442 XLFD_WEIGHT_SEMI_LIGHT, /* 40: SemiLight, Book, ... */
1443 XLFD_WEIGHT_MEDIUM, /* 50: Medium, Normal, Regular, ... */
1444 XLFD_WEIGHT_SEMI_BOLD, /* 60: SemiBold, DemiBold, ... */
1445 XLFD_WEIGHT_BOLD, /* 70: Bold, ... */
1446 XLFD_WEIGHT_EXTRA_BOLD, /* 80: ExtraBold, Heavy, ... */
1447 XLFD_WEIGHT_ULTRA_BOLD /* 90: UltraBold, Black, ... */
1450 /* Relative proportionate width. */
1452 enum xlfd_swidth
1454 XLFD_SWIDTH_UNKNOWN,
1455 XLFD_SWIDTH_ULTRA_CONDENSED, /* 10 */
1456 XLFD_SWIDTH_EXTRA_CONDENSED, /* 20 */
1457 XLFD_SWIDTH_CONDENSED, /* 30: Condensed, Narrow, Compressed, ... */
1458 XLFD_SWIDTH_SEMI_CONDENSED, /* 40: semicondensed */
1459 XLFD_SWIDTH_MEDIUM, /* 50: Medium, Normal, Regular, ... */
1460 XLFD_SWIDTH_SEMI_EXPANDED, /* 60: SemiExpanded, DemiExpanded, ... */
1461 XLFD_SWIDTH_EXPANDED, /* 70: Expanded... */
1462 XLFD_SWIDTH_EXTRA_EXPANDED, /* 80: ExtraExpanded, Wide... */
1463 XLFD_SWIDTH_ULTRA_EXPANDED /* 90: UltraExpanded... */
1466 /* Order by which font selection chooses fonts. The default values
1467 mean `first, find a best match for the font width, then for the
1468 font height, then for weight, then for slant.' This variable can be
1469 set via set-face-font-sort-order. */
1471 static int font_sort_order[4];
1473 #ifdef HAVE_WINDOW_SYSTEM
1475 static enum font_property_index font_props_for_sorting[FONT_SIZE_INDEX];
1477 static int
1478 compare_fonts_by_sort_order (const void *v1, const void *v2)
1480 Lisp_Object const *p1 = v1;
1481 Lisp_Object const *p2 = v2;
1482 Lisp_Object font1 = *p1;
1483 Lisp_Object font2 = *p2;
1484 int i;
1486 for (i = 0; i < FONT_SIZE_INDEX; i++)
1488 enum font_property_index idx = font_props_for_sorting[i];
1489 Lisp_Object val1 = AREF (font1, idx), val2 = AREF (font2, idx);
1490 int result;
1492 if (idx <= FONT_REGISTRY_INDEX)
1494 if (STRINGP (val1))
1495 result = STRINGP (val2) ? strcmp (SSDATA (val1), SSDATA (val2)) : -1;
1496 else
1497 result = STRINGP (val2) ? 1 : 0;
1499 else
1501 if (INTEGERP (val1))
1502 result = (INTEGERP (val2) && XINT (val1) >= XINT (val2)
1503 ? XINT (val1) > XINT (val2)
1504 : -1);
1505 else
1506 result = INTEGERP (val2) ? 1 : 0;
1508 if (result)
1509 return result;
1511 return 0;
1514 DEFUN ("x-family-fonts", Fx_family_fonts, Sx_family_fonts, 0, 2, 0,
1515 doc: /* Return a list of available fonts of family FAMILY on FRAME.
1516 If FAMILY is omitted or nil, list all families.
1517 Otherwise, FAMILY must be a string, possibly containing wildcards
1518 `?' and `*'.
1519 If FRAME is omitted or nil, use the selected frame.
1520 Each element of the result is a vector [FAMILY WIDTH POINT-SIZE WEIGHT
1521 SLANT FIXED-P FULL REGISTRY-AND-ENCODING].
1522 FAMILY is the font family name. POINT-SIZE is the size of the
1523 font in 1/10 pt. WIDTH, WEIGHT, and SLANT are symbols describing the
1524 width, weight and slant of the font. These symbols are the same as for
1525 face attributes. FIXED-P is non-nil if the font is fixed-pitch.
1526 FULL is the full name of the font, and REGISTRY-AND-ENCODING is a string
1527 giving the registry and encoding of the font.
1528 The result list is sorted according to the current setting of
1529 the face font sort order. */)
1530 (Lisp_Object family, Lisp_Object frame)
1532 Lisp_Object font_spec, list, *drivers, vec;
1533 ptrdiff_t i, nfonts;
1534 EMACS_INT ndrivers;
1535 Lisp_Object result;
1536 USE_SAFE_ALLOCA;
1538 if (NILP (frame))
1539 frame = selected_frame;
1540 CHECK_LIVE_FRAME (frame);
1542 font_spec = Ffont_spec (0, NULL);
1543 if (!NILP (family))
1545 CHECK_STRING (family);
1546 font_parse_family_registry (family, Qnil, font_spec);
1549 list = font_list_entities (frame, font_spec);
1550 if (NILP (list))
1551 return Qnil;
1553 /* Sort the font entities. */
1554 for (i = 0; i < 4; i++)
1555 switch (font_sort_order[i])
1557 case XLFD_SWIDTH:
1558 font_props_for_sorting[i] = FONT_WIDTH_INDEX; break;
1559 case XLFD_POINT_SIZE:
1560 font_props_for_sorting[i] = FONT_SIZE_INDEX; break;
1561 case XLFD_WEIGHT:
1562 font_props_for_sorting[i] = FONT_WEIGHT_INDEX; break;
1563 default:
1564 font_props_for_sorting[i] = FONT_SLANT_INDEX; break;
1566 font_props_for_sorting[i++] = FONT_FAMILY_INDEX;
1567 font_props_for_sorting[i++] = FONT_FOUNDRY_INDEX;
1568 font_props_for_sorting[i++] = FONT_ADSTYLE_INDEX;
1569 font_props_for_sorting[i++] = FONT_REGISTRY_INDEX;
1571 ndrivers = XINT (Flength (list));
1572 SAFE_ALLOCA_LISP (drivers, ndrivers);
1573 for (i = 0; i < ndrivers; i++, list = XCDR (list))
1574 drivers[i] = XCAR (list);
1575 vec = Fvconcat (ndrivers, drivers);
1576 nfonts = ASIZE (vec);
1578 qsort (XVECTOR (vec)->contents, nfonts, word_size,
1579 compare_fonts_by_sort_order);
1581 result = Qnil;
1582 for (i = nfonts - 1; i >= 0; --i)
1584 Lisp_Object font = AREF (vec, i);
1585 Lisp_Object v = make_uninit_vector (8);
1586 int point;
1587 Lisp_Object spacing;
1589 ASET (v, 0, AREF (font, FONT_FAMILY_INDEX));
1590 ASET (v, 1, FONT_WIDTH_SYMBOLIC (font));
1591 point = PIXEL_TO_POINT (XINT (AREF (font, FONT_SIZE_INDEX)) * 10,
1592 FRAME_RES_Y (XFRAME (frame)));
1593 ASET (v, 2, make_number (point));
1594 ASET (v, 3, FONT_WEIGHT_SYMBOLIC (font));
1595 ASET (v, 4, FONT_SLANT_SYMBOLIC (font));
1596 spacing = Ffont_get (font, QCspacing);
1597 ASET (v, 5, (NILP (spacing) || EQ (spacing, Qp)) ? Qnil : Qt);
1598 ASET (v, 6, Ffont_xlfd_name (font, Qnil));
1599 ASET (v, 7, AREF (font, FONT_REGISTRY_INDEX));
1601 result = Fcons (v, result);
1604 SAFE_FREE ();
1605 return result;
1608 DEFUN ("x-list-fonts", Fx_list_fonts, Sx_list_fonts, 1, 5, 0,
1609 doc: /* Return a list of the names of available fonts matching PATTERN.
1610 If optional arguments FACE and FRAME are specified, return only fonts
1611 the same size as FACE on FRAME.
1613 PATTERN should be a string containing a font name in the XLFD,
1614 Fontconfig, or GTK format. A font name given in the XLFD format may
1615 contain wildcard characters:
1616 the * character matches any substring, and
1617 the ? character matches any single character.
1618 PATTERN is case-insensitive.
1620 The return value is a list of strings, suitable as arguments to
1621 `set-face-font'.
1623 Fonts Emacs can't use may or may not be excluded
1624 even if they match PATTERN and FACE.
1625 The optional fourth argument MAXIMUM sets a limit on how many
1626 fonts to match. The first MAXIMUM fonts are reported.
1627 The optional fifth argument WIDTH, if specified, is a number of columns
1628 occupied by a character of a font. In that case, return only fonts
1629 the WIDTH times as wide as FACE on FRAME. */)
1630 (Lisp_Object pattern, Lisp_Object face, Lisp_Object frame,
1631 Lisp_Object maximum, Lisp_Object width)
1633 struct frame *f;
1634 int size, avgwidth IF_LINT (= 0);
1636 check_window_system (NULL);
1637 CHECK_STRING (pattern);
1639 if (! NILP (maximum))
1640 CHECK_NATNUM (maximum);
1642 if (!NILP (width))
1643 CHECK_NUMBER (width);
1645 /* We can't simply call decode_window_system_frame because
1646 this function may be called before any frame is created. */
1647 f = decode_live_frame (frame);
1648 if (! FRAME_WINDOW_P (f))
1650 /* Perhaps we have not yet created any frame. */
1651 f = NULL;
1652 frame = Qnil;
1653 face = Qnil;
1655 else
1656 XSETFRAME (frame, f);
1658 /* Determine the width standard for comparison with the fonts we find. */
1660 if (NILP (face))
1661 size = 0;
1662 else
1664 /* This is of limited utility since it works with character
1665 widths. Keep it for compatibility. --gerd. */
1666 int face_id = lookup_named_face (f, face, 0);
1667 struct face *width_face = (face_id < 0
1668 ? NULL
1669 : FACE_FROM_ID (f, face_id));
1671 if (width_face && width_face->font)
1673 size = width_face->font->pixel_size;
1674 avgwidth = width_face->font->average_width;
1676 else
1678 size = FRAME_FONT (f)->pixel_size;
1679 avgwidth = FRAME_FONT (f)->average_width;
1681 if (!NILP (width))
1682 avgwidth *= XINT (width);
1686 Lisp_Object font_spec;
1687 Lisp_Object args[2], tail;
1689 font_spec = font_spec_from_name (pattern);
1690 if (!FONTP (font_spec))
1691 signal_error ("Invalid font name", pattern);
1693 if (size)
1695 Ffont_put (font_spec, QCsize, make_number (size));
1696 Ffont_put (font_spec, QCavgwidth, make_number (avgwidth));
1698 args[0] = Flist_fonts (font_spec, frame, maximum, font_spec);
1699 for (tail = args[0]; CONSP (tail); tail = XCDR (tail))
1701 Lisp_Object font_entity;
1703 font_entity = XCAR (tail);
1704 if ((NILP (AREF (font_entity, FONT_SIZE_INDEX))
1705 || XINT (AREF (font_entity, FONT_SIZE_INDEX)) == 0)
1706 && ! NILP (AREF (font_spec, FONT_SIZE_INDEX)))
1708 /* This is a scalable font. For backward compatibility,
1709 we set the specified size. */
1710 font_entity = copy_font_spec (font_entity);
1711 ASET (font_entity, FONT_SIZE_INDEX,
1712 AREF (font_spec, FONT_SIZE_INDEX));
1714 XSETCAR (tail, Ffont_xlfd_name (font_entity, Qnil));
1716 if (NILP (frame))
1717 /* We don't have to check fontsets. */
1718 return args[0];
1719 args[1] = list_fontsets (f, pattern, size);
1720 return Fnconc (2, args);
1724 #endif /* HAVE_WINDOW_SYSTEM */
1727 /***********************************************************************
1728 Lisp Faces
1729 ***********************************************************************/
1731 /* Access face attributes of face LFACE, a Lisp vector. */
1733 #define LFACE_FAMILY(LFACE) AREF ((LFACE), LFACE_FAMILY_INDEX)
1734 #define LFACE_FOUNDRY(LFACE) AREF ((LFACE), LFACE_FOUNDRY_INDEX)
1735 #define LFACE_HEIGHT(LFACE) AREF ((LFACE), LFACE_HEIGHT_INDEX)
1736 #define LFACE_WEIGHT(LFACE) AREF ((LFACE), LFACE_WEIGHT_INDEX)
1737 #define LFACE_SLANT(LFACE) AREF ((LFACE), LFACE_SLANT_INDEX)
1738 #define LFACE_UNDERLINE(LFACE) AREF ((LFACE), LFACE_UNDERLINE_INDEX)
1739 #define LFACE_INVERSE(LFACE) AREF ((LFACE), LFACE_INVERSE_INDEX)
1740 #define LFACE_FOREGROUND(LFACE) AREF ((LFACE), LFACE_FOREGROUND_INDEX)
1741 #define LFACE_BACKGROUND(LFACE) AREF ((LFACE), LFACE_BACKGROUND_INDEX)
1742 #define LFACE_STIPPLE(LFACE) AREF ((LFACE), LFACE_STIPPLE_INDEX)
1743 #define LFACE_SWIDTH(LFACE) AREF ((LFACE), LFACE_SWIDTH_INDEX)
1744 #define LFACE_OVERLINE(LFACE) AREF ((LFACE), LFACE_OVERLINE_INDEX)
1745 #define LFACE_STRIKE_THROUGH(LFACE) AREF ((LFACE), LFACE_STRIKE_THROUGH_INDEX)
1746 #define LFACE_BOX(LFACE) AREF ((LFACE), LFACE_BOX_INDEX)
1747 #define LFACE_FONT(LFACE) AREF ((LFACE), LFACE_FONT_INDEX)
1748 #define LFACE_INHERIT(LFACE) AREF ((LFACE), LFACE_INHERIT_INDEX)
1749 #define LFACE_FONTSET(LFACE) AREF ((LFACE), LFACE_FONTSET_INDEX)
1751 /* Non-zero if LFACE is a Lisp face. A Lisp face is a vector of size
1752 LFACE_VECTOR_SIZE which has the symbol `face' in slot 0. */
1754 #define LFACEP(LFACE) \
1755 (VECTORP (LFACE) \
1756 && ASIZE (LFACE) == LFACE_VECTOR_SIZE \
1757 && EQ (AREF (LFACE, 0), Qface))
1760 #ifdef GLYPH_DEBUG
1762 /* Check consistency of Lisp face attribute vector ATTRS. */
1764 static void
1765 check_lface_attrs (Lisp_Object attrs[LFACE_VECTOR_SIZE])
1767 eassert (UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
1768 || IGNORE_DEFFACE_P (attrs[LFACE_FAMILY_INDEX])
1769 || STRINGP (attrs[LFACE_FAMILY_INDEX]));
1770 eassert (UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
1771 || IGNORE_DEFFACE_P (attrs[LFACE_FOUNDRY_INDEX])
1772 || STRINGP (attrs[LFACE_FOUNDRY_INDEX]));
1773 eassert (UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
1774 || IGNORE_DEFFACE_P (attrs[LFACE_SWIDTH_INDEX])
1775 || SYMBOLP (attrs[LFACE_SWIDTH_INDEX]));
1776 eassert (UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
1777 || IGNORE_DEFFACE_P (attrs[LFACE_HEIGHT_INDEX])
1778 || INTEGERP (attrs[LFACE_HEIGHT_INDEX])
1779 || FLOATP (attrs[LFACE_HEIGHT_INDEX])
1780 || FUNCTIONP (attrs[LFACE_HEIGHT_INDEX]));
1781 eassert (UNSPECIFIEDP (attrs[LFACE_WEIGHT_INDEX])
1782 || IGNORE_DEFFACE_P (attrs[LFACE_WEIGHT_INDEX])
1783 || SYMBOLP (attrs[LFACE_WEIGHT_INDEX]));
1784 eassert (UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX])
1785 || IGNORE_DEFFACE_P (attrs[LFACE_SLANT_INDEX])
1786 || SYMBOLP (attrs[LFACE_SLANT_INDEX]));
1787 eassert (UNSPECIFIEDP (attrs[LFACE_UNDERLINE_INDEX])
1788 || IGNORE_DEFFACE_P (attrs[LFACE_UNDERLINE_INDEX])
1789 || SYMBOLP (attrs[LFACE_UNDERLINE_INDEX])
1790 || STRINGP (attrs[LFACE_UNDERLINE_INDEX])
1791 || CONSP (attrs[LFACE_UNDERLINE_INDEX]));
1792 eassert (UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
1793 || IGNORE_DEFFACE_P (attrs[LFACE_OVERLINE_INDEX])
1794 || SYMBOLP (attrs[LFACE_OVERLINE_INDEX])
1795 || STRINGP (attrs[LFACE_OVERLINE_INDEX]));
1796 eassert (UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
1797 || IGNORE_DEFFACE_P (attrs[LFACE_STRIKE_THROUGH_INDEX])
1798 || SYMBOLP (attrs[LFACE_STRIKE_THROUGH_INDEX])
1799 || STRINGP (attrs[LFACE_STRIKE_THROUGH_INDEX]));
1800 eassert (UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
1801 || IGNORE_DEFFACE_P (attrs[LFACE_BOX_INDEX])
1802 || SYMBOLP (attrs[LFACE_BOX_INDEX])
1803 || STRINGP (attrs[LFACE_BOX_INDEX])
1804 || INTEGERP (attrs[LFACE_BOX_INDEX])
1805 || CONSP (attrs[LFACE_BOX_INDEX]));
1806 eassert (UNSPECIFIEDP (attrs[LFACE_INVERSE_INDEX])
1807 || IGNORE_DEFFACE_P (attrs[LFACE_INVERSE_INDEX])
1808 || SYMBOLP (attrs[LFACE_INVERSE_INDEX]));
1809 eassert (UNSPECIFIEDP (attrs[LFACE_FOREGROUND_INDEX])
1810 || IGNORE_DEFFACE_P (attrs[LFACE_FOREGROUND_INDEX])
1811 || STRINGP (attrs[LFACE_FOREGROUND_INDEX]));
1812 eassert (UNSPECIFIEDP (attrs[LFACE_BACKGROUND_INDEX])
1813 || IGNORE_DEFFACE_P (attrs[LFACE_BACKGROUND_INDEX])
1814 || STRINGP (attrs[LFACE_BACKGROUND_INDEX]));
1815 eassert (UNSPECIFIEDP (attrs[LFACE_INHERIT_INDEX])
1816 || IGNORE_DEFFACE_P (attrs[LFACE_INHERIT_INDEX])
1817 || NILP (attrs[LFACE_INHERIT_INDEX])
1818 || SYMBOLP (attrs[LFACE_INHERIT_INDEX])
1819 || CONSP (attrs[LFACE_INHERIT_INDEX]));
1820 #ifdef HAVE_WINDOW_SYSTEM
1821 eassert (UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
1822 || IGNORE_DEFFACE_P (attrs[LFACE_STIPPLE_INDEX])
1823 || SYMBOLP (attrs[LFACE_STIPPLE_INDEX])
1824 || !NILP (Fbitmap_spec_p (attrs[LFACE_STIPPLE_INDEX])));
1825 eassert (UNSPECIFIEDP (attrs[LFACE_FONT_INDEX])
1826 || IGNORE_DEFFACE_P (attrs[LFACE_FONT_INDEX])
1827 || FONTP (attrs[LFACE_FONT_INDEX]));
1828 eassert (UNSPECIFIEDP (attrs[LFACE_FONTSET_INDEX])
1829 || STRINGP (attrs[LFACE_FONTSET_INDEX])
1830 || NILP (attrs[LFACE_FONTSET_INDEX]));
1831 #endif
1835 /* Check consistency of attributes of Lisp face LFACE (a Lisp vector). */
1837 static void
1838 check_lface (Lisp_Object lface)
1840 if (!NILP (lface))
1842 eassert (LFACEP (lface));
1843 check_lface_attrs (XVECTOR (lface)->contents);
1847 #else /* not GLYPH_DEBUG */
1849 #define check_lface_attrs(attrs) (void) 0
1850 #define check_lface(lface) (void) 0
1852 #endif /* GLYPH_DEBUG */
1856 /* Face-merge cycle checking. */
1858 enum named_merge_point_kind
1860 NAMED_MERGE_POINT_NORMAL,
1861 NAMED_MERGE_POINT_REMAP
1864 /* A `named merge point' is simply a point during face-merging where we
1865 look up a face by name. We keep a stack of which named lookups we're
1866 currently processing so that we can easily detect cycles, using a
1867 linked- list of struct named_merge_point structures, typically
1868 allocated on the stack frame of the named lookup functions which are
1869 active (so no consing is required). */
1870 struct named_merge_point
1872 Lisp_Object face_name;
1873 enum named_merge_point_kind named_merge_point_kind;
1874 struct named_merge_point *prev;
1878 /* If a face merging cycle is detected for FACE_NAME, return 0,
1879 otherwise add NEW_NAMED_MERGE_POINT, which is initialized using
1880 FACE_NAME and NAMED_MERGE_POINT_KIND, as the head of the linked list
1881 pointed to by NAMED_MERGE_POINTS, and return 1. */
1883 static int
1884 push_named_merge_point (struct named_merge_point *new_named_merge_point,
1885 Lisp_Object face_name,
1886 enum named_merge_point_kind named_merge_point_kind,
1887 struct named_merge_point **named_merge_points)
1889 struct named_merge_point *prev;
1891 for (prev = *named_merge_points; prev; prev = prev->prev)
1892 if (EQ (face_name, prev->face_name))
1894 if (prev->named_merge_point_kind == named_merge_point_kind)
1895 /* A cycle, so fail. */
1896 return 0;
1897 else if (prev->named_merge_point_kind == NAMED_MERGE_POINT_REMAP)
1898 /* A remap `hides ' any previous normal merge points
1899 (because the remap means that it's actually different face),
1900 so as we know the current merge point must be normal, we
1901 can just assume it's OK. */
1902 break;
1905 new_named_merge_point->face_name = face_name;
1906 new_named_merge_point->named_merge_point_kind = named_merge_point_kind;
1907 new_named_merge_point->prev = *named_merge_points;
1909 *named_merge_points = new_named_merge_point;
1911 return 1;
1915 /* Resolve face name FACE_NAME. If FACE_NAME is a string, intern it
1916 to make it a symbol. If FACE_NAME is an alias for another face,
1917 return that face's name.
1919 Return default face in case of errors. */
1921 static Lisp_Object
1922 resolve_face_name (Lisp_Object face_name, int signal_p)
1924 Lisp_Object orig_face;
1925 Lisp_Object tortoise, hare;
1927 if (STRINGP (face_name))
1928 face_name = intern (SSDATA (face_name));
1930 if (NILP (face_name) || !SYMBOLP (face_name))
1931 return face_name;
1933 orig_face = face_name;
1934 tortoise = hare = face_name;
1936 while (1)
1938 face_name = hare;
1939 hare = Fget (hare, Qface_alias);
1940 if (NILP (hare) || !SYMBOLP (hare))
1941 break;
1943 face_name = hare;
1944 hare = Fget (hare, Qface_alias);
1945 if (NILP (hare) || !SYMBOLP (hare))
1946 break;
1948 tortoise = Fget (tortoise, Qface_alias);
1949 if (EQ (hare, tortoise))
1951 if (signal_p)
1952 xsignal1 (Qcircular_list, orig_face);
1953 return Qdefault;
1957 return face_name;
1961 /* Return the face definition of FACE_NAME on frame F. F null means
1962 return the definition for new frames. FACE_NAME may be a string or
1963 a symbol (apparently Emacs 20.2 allowed strings as face names in
1964 face text properties; Ediff uses that). If SIGNAL_P is non-zero,
1965 signal an error if FACE_NAME is not a valid face name. If SIGNAL_P
1966 is zero, value is nil if FACE_NAME is not a valid face name. */
1967 static Lisp_Object
1968 lface_from_face_name_no_resolve (struct frame *f, Lisp_Object face_name,
1969 int signal_p)
1971 Lisp_Object lface;
1973 if (f)
1974 lface = assq_no_quit (face_name, f->face_alist);
1975 else
1976 lface = assq_no_quit (face_name, Vface_new_frame_defaults);
1978 if (CONSP (lface))
1979 lface = XCDR (lface);
1980 else if (signal_p)
1981 signal_error ("Invalid face", face_name);
1983 check_lface (lface);
1985 return lface;
1988 /* Return the face definition of FACE_NAME on frame F. F null means
1989 return the definition for new frames. FACE_NAME may be a string or
1990 a symbol (apparently Emacs 20.2 allowed strings as face names in
1991 face text properties; Ediff uses that). If FACE_NAME is an alias
1992 for another face, return that face's definition. If SIGNAL_P is
1993 non-zero, signal an error if FACE_NAME is not a valid face name.
1994 If SIGNAL_P is zero, value is nil if FACE_NAME is not a valid face
1995 name. */
1996 static Lisp_Object
1997 lface_from_face_name (struct frame *f, Lisp_Object face_name, int signal_p)
1999 face_name = resolve_face_name (face_name, signal_p);
2000 return lface_from_face_name_no_resolve (f, face_name, signal_p);
2004 /* Get face attributes of face FACE_NAME from frame-local faces on
2005 frame F. Store the resulting attributes in ATTRS which must point
2006 to a vector of Lisp_Objects of size LFACE_VECTOR_SIZE. If SIGNAL_P
2007 is non-zero, signal an error if FACE_NAME does not name a face.
2008 Otherwise, value is zero if FACE_NAME is not a face. */
2010 static int
2011 get_lface_attributes_no_remap (struct frame *f, Lisp_Object face_name,
2012 Lisp_Object attrs[LFACE_VECTOR_SIZE],
2013 int signal_p)
2015 Lisp_Object lface;
2017 lface = lface_from_face_name_no_resolve (f, face_name, signal_p);
2019 if (! NILP (lface))
2020 memcpy (attrs, XVECTOR (lface)->contents,
2021 LFACE_VECTOR_SIZE * sizeof *attrs);
2023 return !NILP (lface);
2026 /* Get face attributes of face FACE_NAME from frame-local faces on frame
2027 F. Store the resulting attributes in ATTRS which must point to a
2028 vector of Lisp_Objects of size LFACE_VECTOR_SIZE. If FACE_NAME is an
2029 alias for another face, use that face's definition. If SIGNAL_P is
2030 non-zero, signal an error if FACE_NAME does not name a face.
2031 Otherwise, value is zero if FACE_NAME is not a face. */
2033 static int
2034 get_lface_attributes (struct frame *f, Lisp_Object face_name,
2035 Lisp_Object attrs[LFACE_VECTOR_SIZE], int signal_p,
2036 struct named_merge_point *named_merge_points)
2038 Lisp_Object face_remapping;
2040 face_name = resolve_face_name (face_name, signal_p);
2042 /* See if SYMBOL has been remapped to some other face (usually this
2043 is done buffer-locally). */
2044 face_remapping = assq_no_quit (face_name, Vface_remapping_alist);
2045 if (CONSP (face_remapping))
2047 struct named_merge_point named_merge_point;
2049 if (push_named_merge_point (&named_merge_point,
2050 face_name, NAMED_MERGE_POINT_REMAP,
2051 &named_merge_points))
2053 int i;
2055 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2056 attrs[i] = Qunspecified;
2058 return merge_face_ref (f, XCDR (face_remapping), attrs,
2059 signal_p, named_merge_points);
2063 /* Default case, no remapping. */
2064 return get_lface_attributes_no_remap (f, face_name, attrs, signal_p);
2068 /* Non-zero if all attributes in face attribute vector ATTRS are
2069 specified, i.e. are non-nil. */
2071 static int
2072 lface_fully_specified_p (Lisp_Object attrs[LFACE_VECTOR_SIZE])
2074 int i;
2076 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2077 if (i != LFACE_FONT_INDEX && i != LFACE_INHERIT_INDEX)
2078 if ((UNSPECIFIEDP (attrs[i]) || IGNORE_DEFFACE_P (attrs[i])))
2079 break;
2081 return i == LFACE_VECTOR_SIZE;
2084 #ifdef HAVE_WINDOW_SYSTEM
2086 /* Set font-related attributes of Lisp face LFACE from FONT-OBJECT.
2087 If FORCE_P is zero, set only unspecified attributes of LFACE. The
2088 exception is `font' attribute. It is set to FONT_OBJECT regardless
2089 of FORCE_P. */
2091 static int
2092 set_lface_from_font (struct frame *f, Lisp_Object lface,
2093 Lisp_Object font_object, int force_p)
2095 Lisp_Object val;
2096 struct font *font = XFONT_OBJECT (font_object);
2098 /* Set attributes only if unspecified, otherwise face defaults for
2099 new frames would never take effect. If the font doesn't have a
2100 specific property, set a normal value for that. */
2102 if (force_p || UNSPECIFIEDP (LFACE_FAMILY (lface)))
2104 Lisp_Object family = AREF (font_object, FONT_FAMILY_INDEX);
2106 ASET (lface, LFACE_FAMILY_INDEX, SYMBOL_NAME (family));
2109 if (force_p || UNSPECIFIEDP (LFACE_FOUNDRY (lface)))
2111 Lisp_Object foundry = AREF (font_object, FONT_FOUNDRY_INDEX);
2113 ASET (lface, LFACE_FOUNDRY_INDEX, SYMBOL_NAME (foundry));
2116 if (force_p || UNSPECIFIEDP (LFACE_HEIGHT (lface)))
2118 int pt = PIXEL_TO_POINT (font->pixel_size * 10, FRAME_RES_Y (f));
2120 eassert (pt > 0);
2121 ASET (lface, LFACE_HEIGHT_INDEX, make_number (pt));
2124 if (force_p || UNSPECIFIEDP (LFACE_WEIGHT (lface)))
2126 val = FONT_WEIGHT_FOR_FACE (font_object);
2127 ASET (lface, LFACE_WEIGHT_INDEX, ! NILP (val) ? val :Qnormal);
2129 if (force_p || UNSPECIFIEDP (LFACE_SLANT (lface)))
2131 val = FONT_SLANT_FOR_FACE (font_object);
2132 ASET (lface, LFACE_SLANT_INDEX, ! NILP (val) ? val : Qnormal);
2134 if (force_p || UNSPECIFIEDP (LFACE_SWIDTH (lface)))
2136 val = FONT_WIDTH_FOR_FACE (font_object);
2137 ASET (lface, LFACE_SWIDTH_INDEX, ! NILP (val) ? val : Qnormal);
2140 ASET (lface, LFACE_FONT_INDEX, font_object);
2141 return 1;
2144 #endif /* HAVE_WINDOW_SYSTEM */
2147 /* Merges the face height FROM with the face height TO, and returns the
2148 merged height. If FROM is an invalid height, then INVALID is
2149 returned instead. FROM and TO may be either absolute face heights or
2150 `relative' heights; the returned value is always an absolute height
2151 unless both FROM and TO are relative. */
2153 static Lisp_Object
2154 merge_face_heights (Lisp_Object from, Lisp_Object to, Lisp_Object invalid)
2156 Lisp_Object result = invalid;
2158 if (INTEGERP (from))
2159 /* FROM is absolute, just use it as is. */
2160 result = from;
2161 else if (FLOATP (from))
2162 /* FROM is a scale, use it to adjust TO. */
2164 if (INTEGERP (to))
2165 /* relative X absolute => absolute */
2166 result = make_number (XFLOAT_DATA (from) * XINT (to));
2167 else if (FLOATP (to))
2168 /* relative X relative => relative */
2169 result = make_float (XFLOAT_DATA (from) * XFLOAT_DATA (to));
2170 else if (UNSPECIFIEDP (to))
2171 result = from;
2173 else if (FUNCTIONP (from))
2174 /* FROM is a function, which use to adjust TO. */
2176 /* Call function with current height as argument.
2177 From is the new height. */
2178 result = safe_call1 (from, to);
2180 /* Ensure that if TO was absolute, so is the result. */
2181 if (INTEGERP (to) && !INTEGERP (result))
2182 result = invalid;
2185 return result;
2189 /* Merge two Lisp face attribute vectors on frame F, FROM and TO, and
2190 store the resulting attributes in TO, which must be already be
2191 completely specified and contain only absolute attributes. Every
2192 specified attribute of FROM overrides the corresponding attribute of
2193 TO; relative attributes in FROM are merged with the absolute value in
2194 TO and replace it. NAMED_MERGE_POINTS is used internally to detect
2195 loops in face inheritance/remapping; it should be 0 when called from
2196 other places. */
2198 static void
2199 merge_face_vectors (struct frame *f, Lisp_Object *from, Lisp_Object *to,
2200 struct named_merge_point *named_merge_points)
2202 int i;
2203 Lisp_Object font = Qnil;
2205 /* If FROM inherits from some other faces, merge their attributes into
2206 TO before merging FROM's direct attributes. Note that an :inherit
2207 attribute of `unspecified' is the same as one of nil; we never
2208 merge :inherit attributes, so nil is more correct, but lots of
2209 other code uses `unspecified' as a generic value for face attributes. */
2210 if (!UNSPECIFIEDP (from[LFACE_INHERIT_INDEX])
2211 && !NILP (from[LFACE_INHERIT_INDEX]))
2212 merge_face_ref (f, from[LFACE_INHERIT_INDEX], to, 0, named_merge_points);
2214 if (FONT_SPEC_P (from[LFACE_FONT_INDEX]))
2216 if (!UNSPECIFIEDP (to[LFACE_FONT_INDEX]))
2217 font = merge_font_spec (from[LFACE_FONT_INDEX], to[LFACE_FONT_INDEX]);
2218 else
2219 font = copy_font_spec (from[LFACE_FONT_INDEX]);
2220 to[LFACE_FONT_INDEX] = font;
2223 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2224 if (!UNSPECIFIEDP (from[i]))
2226 if (i == LFACE_HEIGHT_INDEX && !INTEGERP (from[i]))
2228 to[i] = merge_face_heights (from[i], to[i], to[i]);
2229 font_clear_prop (to, FONT_SIZE_INDEX);
2231 else if (i != LFACE_FONT_INDEX && ! EQ (to[i], from[i]))
2233 to[i] = from[i];
2234 if (i >= LFACE_FAMILY_INDEX && i <=LFACE_SLANT_INDEX)
2235 font_clear_prop (to,
2236 (i == LFACE_FAMILY_INDEX ? FONT_FAMILY_INDEX
2237 : i == LFACE_FOUNDRY_INDEX ? FONT_FOUNDRY_INDEX
2238 : i == LFACE_SWIDTH_INDEX ? FONT_WIDTH_INDEX
2239 : i == LFACE_HEIGHT_INDEX ? FONT_SIZE_INDEX
2240 : i == LFACE_WEIGHT_INDEX ? FONT_WEIGHT_INDEX
2241 : FONT_SLANT_INDEX));
2245 /* If FROM specifies a font spec, make its contents take precedence
2246 over :family and other attributes. This is needed for face
2247 remapping using :font to work. */
2249 if (!NILP (font))
2251 if (! NILP (AREF (font, FONT_FOUNDRY_INDEX)))
2252 to[LFACE_FOUNDRY_INDEX] = SYMBOL_NAME (AREF (font, FONT_FOUNDRY_INDEX));
2253 if (! NILP (AREF (font, FONT_FAMILY_INDEX)))
2254 to[LFACE_FAMILY_INDEX] = SYMBOL_NAME (AREF (font, FONT_FAMILY_INDEX));
2255 if (! NILP (AREF (font, FONT_WEIGHT_INDEX)))
2256 to[LFACE_WEIGHT_INDEX] = FONT_WEIGHT_FOR_FACE (font);
2257 if (! NILP (AREF (font, FONT_SLANT_INDEX)))
2258 to[LFACE_SLANT_INDEX] = FONT_SLANT_FOR_FACE (font);
2259 if (! NILP (AREF (font, FONT_WIDTH_INDEX)))
2260 to[LFACE_SWIDTH_INDEX] = FONT_WIDTH_FOR_FACE (font);
2261 ASET (font, FONT_SIZE_INDEX, Qnil);
2264 /* TO is always an absolute face, which should inherit from nothing.
2265 We blindly copy the :inherit attribute above and fix it up here. */
2266 to[LFACE_INHERIT_INDEX] = Qnil;
2269 /* Merge the named face FACE_NAME on frame F, into the vector of face
2270 attributes TO. NAMED_MERGE_POINTS is used to detect loops in face
2271 inheritance. Returns true if FACE_NAME is a valid face name and
2272 merging succeeded. */
2274 static int
2275 merge_named_face (struct frame *f, Lisp_Object face_name, Lisp_Object *to,
2276 struct named_merge_point *named_merge_points)
2278 struct named_merge_point named_merge_point;
2280 if (push_named_merge_point (&named_merge_point,
2281 face_name, NAMED_MERGE_POINT_NORMAL,
2282 &named_merge_points))
2284 struct gcpro gcpro1;
2285 Lisp_Object from[LFACE_VECTOR_SIZE];
2286 int ok = get_lface_attributes (f, face_name, from, 0, named_merge_points);
2288 if (ok)
2290 GCPRO1 (named_merge_point.face_name);
2291 merge_face_vectors (f, from, to, named_merge_points);
2292 UNGCPRO;
2295 return ok;
2297 else
2298 return 0;
2302 /* Merge face attributes from the lisp `face reference' FACE_REF on
2303 frame F into the face attribute vector TO. If ERR_MSGS is non-zero,
2304 problems with FACE_REF cause an error message to be shown. Return
2305 non-zero if no errors occurred (regardless of the value of ERR_MSGS).
2306 NAMED_MERGE_POINTS is used to detect loops in face inheritance or
2307 list structure; it may be 0 for most callers.
2309 FACE_REF may be a single face specification or a list of such
2310 specifications. Each face specification can be:
2312 1. A symbol or string naming a Lisp face.
2314 2. A property list of the form (KEYWORD VALUE ...) where each
2315 KEYWORD is a face attribute name, and value is an appropriate value
2316 for that attribute.
2318 3. Conses or the form (FOREGROUND-COLOR . COLOR) or
2319 (BACKGROUND-COLOR . COLOR) where COLOR is a color name. This is
2320 for compatibility with 20.2.
2322 Face specifications earlier in lists take precedence over later
2323 specifications. */
2325 static int
2326 merge_face_ref (struct frame *f, Lisp_Object face_ref, Lisp_Object *to,
2327 int err_msgs, struct named_merge_point *named_merge_points)
2329 int ok = 1; /* Succeed without an error? */
2331 if (CONSP (face_ref))
2333 Lisp_Object first = XCAR (face_ref);
2335 if (EQ (first, Qforeground_color)
2336 || EQ (first, Qbackground_color))
2338 /* One of (FOREGROUND-COLOR . COLOR) or (BACKGROUND-COLOR
2339 . COLOR). COLOR must be a string. */
2340 Lisp_Object color_name = XCDR (face_ref);
2341 Lisp_Object color = first;
2343 if (STRINGP (color_name))
2345 if (EQ (color, Qforeground_color))
2346 to[LFACE_FOREGROUND_INDEX] = color_name;
2347 else
2348 to[LFACE_BACKGROUND_INDEX] = color_name;
2350 else
2352 if (err_msgs)
2353 add_to_log ("Invalid face color", color_name, Qnil);
2354 ok = 0;
2357 else if (SYMBOLP (first)
2358 && *SDATA (SYMBOL_NAME (first)) == ':')
2360 /* Assume this is the property list form. */
2361 while (CONSP (face_ref) && CONSP (XCDR (face_ref)))
2363 Lisp_Object keyword = XCAR (face_ref);
2364 Lisp_Object value = XCAR (XCDR (face_ref));
2365 int err = 0;
2367 /* Specifying `unspecified' is a no-op. */
2368 if (EQ (value, Qunspecified))
2370 else if (EQ (keyword, QCfamily))
2372 if (STRINGP (value))
2374 to[LFACE_FAMILY_INDEX] = value;
2375 font_clear_prop (to, FONT_FAMILY_INDEX);
2377 else
2378 err = 1;
2380 else if (EQ (keyword, QCfoundry))
2382 if (STRINGP (value))
2384 to[LFACE_FOUNDRY_INDEX] = value;
2385 font_clear_prop (to, FONT_FOUNDRY_INDEX);
2387 else
2388 err = 1;
2390 else if (EQ (keyword, QCheight))
2392 Lisp_Object new_height =
2393 merge_face_heights (value, to[LFACE_HEIGHT_INDEX], Qnil);
2395 if (! NILP (new_height))
2397 to[LFACE_HEIGHT_INDEX] = new_height;
2398 font_clear_prop (to, FONT_SIZE_INDEX);
2400 else
2401 err = 1;
2403 else if (EQ (keyword, QCweight))
2405 if (SYMBOLP (value) && FONT_WEIGHT_NAME_NUMERIC (value) >= 0)
2407 to[LFACE_WEIGHT_INDEX] = value;
2408 font_clear_prop (to, FONT_WEIGHT_INDEX);
2410 else
2411 err = 1;
2413 else if (EQ (keyword, QCslant))
2415 if (SYMBOLP (value) && FONT_SLANT_NAME_NUMERIC (value) >= 0)
2417 to[LFACE_SLANT_INDEX] = value;
2418 font_clear_prop (to, FONT_SLANT_INDEX);
2420 else
2421 err = 1;
2423 else if (EQ (keyword, QCunderline))
2425 if (EQ (value, Qt)
2426 || NILP (value)
2427 || STRINGP (value)
2428 || CONSP (value))
2429 to[LFACE_UNDERLINE_INDEX] = value;
2430 else
2431 err = 1;
2433 else if (EQ (keyword, QCoverline))
2435 if (EQ (value, Qt)
2436 || NILP (value)
2437 || STRINGP (value))
2438 to[LFACE_OVERLINE_INDEX] = value;
2439 else
2440 err = 1;
2442 else if (EQ (keyword, QCstrike_through))
2444 if (EQ (value, Qt)
2445 || NILP (value)
2446 || STRINGP (value))
2447 to[LFACE_STRIKE_THROUGH_INDEX] = value;
2448 else
2449 err = 1;
2451 else if (EQ (keyword, QCbox))
2453 if (EQ (value, Qt))
2454 value = make_number (1);
2455 if (INTEGERP (value)
2456 || STRINGP (value)
2457 || CONSP (value)
2458 || NILP (value))
2459 to[LFACE_BOX_INDEX] = value;
2460 else
2461 err = 1;
2463 else if (EQ (keyword, QCinverse_video)
2464 || EQ (keyword, QCreverse_video))
2466 if (EQ (value, Qt) || NILP (value))
2467 to[LFACE_INVERSE_INDEX] = value;
2468 else
2469 err = 1;
2471 else if (EQ (keyword, QCforeground))
2473 if (STRINGP (value))
2474 to[LFACE_FOREGROUND_INDEX] = value;
2475 else
2476 err = 1;
2478 else if (EQ (keyword, QCbackground))
2480 if (STRINGP (value))
2481 to[LFACE_BACKGROUND_INDEX] = value;
2482 else
2483 err = 1;
2485 else if (EQ (keyword, QCstipple))
2487 #if defined (HAVE_WINDOW_SYSTEM)
2488 Lisp_Object pixmap_p = Fbitmap_spec_p (value);
2489 if (!NILP (pixmap_p))
2490 to[LFACE_STIPPLE_INDEX] = value;
2491 else
2492 err = 1;
2493 #endif /* HAVE_WINDOW_SYSTEM */
2495 else if (EQ (keyword, QCwidth))
2497 if (SYMBOLP (value) && FONT_WIDTH_NAME_NUMERIC (value) >= 0)
2499 to[LFACE_SWIDTH_INDEX] = value;
2500 font_clear_prop (to, FONT_WIDTH_INDEX);
2502 else
2503 err = 1;
2505 else if (EQ (keyword, QCfont))
2507 if (FONTP (value))
2508 to[LFACE_FONT_INDEX] = value;
2509 else
2510 err = 1;
2512 else if (EQ (keyword, QCinherit))
2514 /* This is not really very useful; it's just like a
2515 normal face reference. */
2516 if (! merge_face_ref (f, value, to,
2517 err_msgs, named_merge_points))
2518 err = 1;
2520 else
2521 err = 1;
2523 if (err)
2525 add_to_log ("Invalid face attribute %S %S", keyword, value);
2526 ok = 0;
2529 face_ref = XCDR (XCDR (face_ref));
2532 else
2534 /* This is a list of face refs. Those at the beginning of the
2535 list take precedence over what follows, so we have to merge
2536 from the end backwards. */
2537 Lisp_Object next = XCDR (face_ref);
2539 if (! NILP (next))
2540 ok = merge_face_ref (f, next, to, err_msgs, named_merge_points);
2542 if (! merge_face_ref (f, first, to, err_msgs, named_merge_points))
2543 ok = 0;
2546 else
2548 /* FACE_REF ought to be a face name. */
2549 ok = merge_named_face (f, face_ref, to, named_merge_points);
2550 if (!ok && err_msgs)
2551 add_to_log ("Invalid face reference: %s", face_ref, Qnil);
2554 return ok;
2558 DEFUN ("internal-make-lisp-face", Finternal_make_lisp_face,
2559 Sinternal_make_lisp_face, 1, 2, 0,
2560 doc: /* Make FACE, a symbol, a Lisp face with all attributes nil.
2561 If FACE was not known as a face before, create a new one.
2562 If optional argument FRAME is specified, make a frame-local face
2563 for that frame. Otherwise operate on the global face definition.
2564 Value is a vector of face attributes. */)
2565 (Lisp_Object face, Lisp_Object frame)
2567 Lisp_Object global_lface, lface;
2568 struct frame *f;
2569 int i;
2571 CHECK_SYMBOL (face);
2572 global_lface = lface_from_face_name (NULL, face, 0);
2574 if (!NILP (frame))
2576 CHECK_LIVE_FRAME (frame);
2577 f = XFRAME (frame);
2578 lface = lface_from_face_name (f, face, 0);
2580 else
2581 f = NULL, lface = Qnil;
2583 /* Add a global definition if there is none. */
2584 if (NILP (global_lface))
2586 global_lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
2587 Qunspecified);
2588 ASET (global_lface, 0, Qface);
2589 Vface_new_frame_defaults = Fcons (Fcons (face, global_lface),
2590 Vface_new_frame_defaults);
2592 /* Assign the new Lisp face a unique ID. The mapping from Lisp
2593 face id to Lisp face is given by the vector lface_id_to_name.
2594 The mapping from Lisp face to Lisp face id is given by the
2595 property `face' of the Lisp face name. */
2596 if (next_lface_id == lface_id_to_name_size)
2597 lface_id_to_name =
2598 xpalloc (lface_id_to_name, &lface_id_to_name_size, 1, MAX_FACE_ID,
2599 sizeof *lface_id_to_name);
2601 lface_id_to_name[next_lface_id] = face;
2602 Fput (face, Qface, make_number (next_lface_id));
2603 ++next_lface_id;
2605 else if (f == NULL)
2606 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2607 ASET (global_lface, i, Qunspecified);
2609 /* Add a frame-local definition. */
2610 if (f)
2612 if (NILP (lface))
2614 lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
2615 Qunspecified);
2616 ASET (lface, 0, Qface);
2617 fset_face_alist (f, Fcons (Fcons (face, lface), f->face_alist));
2619 else
2620 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2621 ASET (lface, i, Qunspecified);
2623 else
2624 lface = global_lface;
2626 /* Changing a named face means that all realized faces depending on
2627 that face are invalid. Since we cannot tell which realized faces
2628 depend on the face, make sure they are all removed. This is done
2629 by incrementing face_change_count. The next call to
2630 init_iterator will then free realized faces. */
2631 if (NILP (Fget (face, Qface_no_inherit)))
2633 ++face_change_count;
2634 ++windows_or_buffers_changed;
2637 eassert (LFACEP (lface));
2638 check_lface (lface);
2639 return lface;
2643 DEFUN ("internal-lisp-face-p", Finternal_lisp_face_p,
2644 Sinternal_lisp_face_p, 1, 2, 0,
2645 doc: /* Return non-nil if FACE names a face.
2646 FACE should be a symbol or string.
2647 If optional second argument FRAME is non-nil, check for the
2648 existence of a frame-local face with name FACE on that frame.
2649 Otherwise check for the existence of a global face. */)
2650 (Lisp_Object face, Lisp_Object frame)
2652 Lisp_Object lface;
2654 face = resolve_face_name (face, 1);
2656 if (!NILP (frame))
2658 CHECK_LIVE_FRAME (frame);
2659 lface = lface_from_face_name (XFRAME (frame), face, 0);
2661 else
2662 lface = lface_from_face_name (NULL, face, 0);
2664 return lface;
2668 DEFUN ("internal-copy-lisp-face", Finternal_copy_lisp_face,
2669 Sinternal_copy_lisp_face, 4, 4, 0,
2670 doc: /* Copy face FROM to TO.
2671 If FRAME is t, copy the global face definition of FROM.
2672 Otherwise, copy the frame-local definition of FROM on FRAME.
2673 If NEW-FRAME is a frame, copy that data into the frame-local
2674 definition of TO on NEW-FRAME. If NEW-FRAME is nil,
2675 FRAME controls where the data is copied to.
2677 The value is TO. */)
2678 (Lisp_Object from, Lisp_Object to, Lisp_Object frame, Lisp_Object new_frame)
2680 Lisp_Object lface, copy;
2682 CHECK_SYMBOL (from);
2683 CHECK_SYMBOL (to);
2685 if (EQ (frame, Qt))
2687 /* Copy global definition of FROM. We don't make copies of
2688 strings etc. because 20.2 didn't do it either. */
2689 lface = lface_from_face_name (NULL, from, 1);
2690 copy = Finternal_make_lisp_face (to, Qnil);
2692 else
2694 /* Copy frame-local definition of FROM. */
2695 if (NILP (new_frame))
2696 new_frame = frame;
2697 CHECK_LIVE_FRAME (frame);
2698 CHECK_LIVE_FRAME (new_frame);
2699 lface = lface_from_face_name (XFRAME (frame), from, 1);
2700 copy = Finternal_make_lisp_face (to, new_frame);
2703 vcopy (copy, 0, XVECTOR (lface)->contents, LFACE_VECTOR_SIZE);
2705 /* Changing a named face means that all realized faces depending on
2706 that face are invalid. Since we cannot tell which realized faces
2707 depend on the face, make sure they are all removed. This is done
2708 by incrementing face_change_count. The next call to
2709 init_iterator will then free realized faces. */
2710 if (NILP (Fget (to, Qface_no_inherit)))
2712 ++face_change_count;
2713 ++windows_or_buffers_changed;
2716 return to;
2720 DEFUN ("internal-set-lisp-face-attribute", Finternal_set_lisp_face_attribute,
2721 Sinternal_set_lisp_face_attribute, 3, 4, 0,
2722 doc: /* Set attribute ATTR of FACE to VALUE.
2723 FRAME being a frame means change the face on that frame.
2724 FRAME nil means change the face of the selected frame.
2725 FRAME t means change the default for new frames.
2726 FRAME 0 means change the face on all frames, and change the default
2727 for new frames. */)
2728 (Lisp_Object face, Lisp_Object attr, Lisp_Object value, Lisp_Object frame)
2730 Lisp_Object lface;
2731 Lisp_Object old_value = Qnil;
2732 /* Set one of enum font_property_index (> 0) if ATTR is one of
2733 font-related attributes other than QCfont and QCfontset. */
2734 enum font_property_index prop_index = 0;
2736 CHECK_SYMBOL (face);
2737 CHECK_SYMBOL (attr);
2739 face = resolve_face_name (face, 1);
2741 /* If FRAME is 0, change face on all frames, and change the
2742 default for new frames. */
2743 if (INTEGERP (frame) && XINT (frame) == 0)
2745 Lisp_Object tail;
2746 Finternal_set_lisp_face_attribute (face, attr, value, Qt);
2747 FOR_EACH_FRAME (tail, frame)
2748 Finternal_set_lisp_face_attribute (face, attr, value, frame);
2749 return face;
2752 /* Set lface to the Lisp attribute vector of FACE. */
2753 if (EQ (frame, Qt))
2755 lface = lface_from_face_name (NULL, face, 1);
2757 /* When updating face-new-frame-defaults, we put :ignore-defface
2758 where the caller wants `unspecified'. This forces the frame
2759 defaults to ignore the defface value. Otherwise, the defface
2760 will take effect, which is generally not what is intended.
2761 The value of that attribute will be inherited from some other
2762 face during face merging. See internal_merge_in_global_face. */
2763 if (UNSPECIFIEDP (value))
2764 value = QCignore_defface;
2766 else
2768 if (NILP (frame))
2769 frame = selected_frame;
2771 CHECK_LIVE_FRAME (frame);
2772 lface = lface_from_face_name (XFRAME (frame), face, 0);
2774 /* If a frame-local face doesn't exist yet, create one. */
2775 if (NILP (lface))
2776 lface = Finternal_make_lisp_face (face, frame);
2779 if (EQ (attr, QCfamily))
2781 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2783 CHECK_STRING (value);
2784 if (SCHARS (value) == 0)
2785 signal_error ("Invalid face family", value);
2787 old_value = LFACE_FAMILY (lface);
2788 ASET (lface, LFACE_FAMILY_INDEX, value);
2789 prop_index = FONT_FAMILY_INDEX;
2791 else if (EQ (attr, QCfoundry))
2793 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2795 CHECK_STRING (value);
2796 if (SCHARS (value) == 0)
2797 signal_error ("Invalid face foundry", value);
2799 old_value = LFACE_FOUNDRY (lface);
2800 ASET (lface, LFACE_FOUNDRY_INDEX, value);
2801 prop_index = FONT_FOUNDRY_INDEX;
2803 else if (EQ (attr, QCheight))
2805 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2807 if (EQ (face, Qdefault))
2809 /* The default face must have an absolute size. */
2810 if (!INTEGERP (value) || XINT (value) <= 0)
2811 signal_error ("Default face height not absolute and positive",
2812 value);
2814 else
2816 /* For non-default faces, do a test merge with a random
2817 height to see if VALUE's ok. */
2818 Lisp_Object test = merge_face_heights (value,
2819 make_number (10),
2820 Qnil);
2821 if (!INTEGERP (test) || XINT (test) <= 0)
2822 signal_error ("Face height does not produce a positive integer",
2823 value);
2827 old_value = LFACE_HEIGHT (lface);
2828 ASET (lface, LFACE_HEIGHT_INDEX, value);
2829 prop_index = FONT_SIZE_INDEX;
2831 else if (EQ (attr, QCweight))
2833 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2835 CHECK_SYMBOL (value);
2836 if (FONT_WEIGHT_NAME_NUMERIC (value) < 0)
2837 signal_error ("Invalid face weight", value);
2839 old_value = LFACE_WEIGHT (lface);
2840 ASET (lface, LFACE_WEIGHT_INDEX, value);
2841 prop_index = FONT_WEIGHT_INDEX;
2843 else if (EQ (attr, QCslant))
2845 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2847 CHECK_SYMBOL (value);
2848 if (FONT_SLANT_NAME_NUMERIC (value) < 0)
2849 signal_error ("Invalid face slant", value);
2851 old_value = LFACE_SLANT (lface);
2852 ASET (lface, LFACE_SLANT_INDEX, value);
2853 prop_index = FONT_SLANT_INDEX;
2855 else if (EQ (attr, QCunderline))
2857 int valid_p = 0;
2859 if (UNSPECIFIEDP (value) || IGNORE_DEFFACE_P (value))
2860 valid_p = 1;
2861 else if (NILP (value) || EQ (value, Qt))
2862 valid_p = 1;
2863 else if (STRINGP (value) && SCHARS (value) > 0)
2864 valid_p = 1;
2865 else if (CONSP (value))
2867 Lisp_Object key, val, list;
2869 list = value;
2870 /* FIXME? This errs on the side of acceptance. Eg it accepts:
2871 (defface foo '((t :underline 'foo) "doc")
2872 Maybe this is intentional, maybe it isn't.
2873 Non-nil symbols other than t are not documented as being valid.
2874 Eg compare with inverse-video, which explicitly rejects them.
2876 valid_p = 1;
2878 while (!NILP (CAR_SAFE(list)))
2880 key = CAR_SAFE (list);
2881 list = CDR_SAFE (list);
2882 val = CAR_SAFE (list);
2883 list = CDR_SAFE (list);
2885 if (NILP (key) || NILP (val))
2887 valid_p = 0;
2888 break;
2891 else if (EQ (key, QCcolor)
2892 && !(EQ (val, Qforeground_color)
2893 || (STRINGP (val) && SCHARS (val) > 0)))
2895 valid_p = 0;
2896 break;
2899 else if (EQ (key, QCstyle)
2900 && !(EQ (val, Qline) || EQ (val, Qwave)))
2902 valid_p = 0;
2903 break;
2908 if (!valid_p)
2909 signal_error ("Invalid face underline", value);
2911 old_value = LFACE_UNDERLINE (lface);
2912 ASET (lface, LFACE_UNDERLINE_INDEX, value);
2914 else if (EQ (attr, QCoverline))
2916 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2917 if ((SYMBOLP (value)
2918 && !EQ (value, Qt)
2919 && !EQ (value, Qnil))
2920 /* Overline color. */
2921 || (STRINGP (value)
2922 && SCHARS (value) == 0))
2923 signal_error ("Invalid face overline", value);
2925 old_value = LFACE_OVERLINE (lface);
2926 ASET (lface, LFACE_OVERLINE_INDEX, value);
2928 else if (EQ (attr, QCstrike_through))
2930 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2931 if ((SYMBOLP (value)
2932 && !EQ (value, Qt)
2933 && !EQ (value, Qnil))
2934 /* Strike-through color. */
2935 || (STRINGP (value)
2936 && SCHARS (value) == 0))
2937 signal_error ("Invalid face strike-through", value);
2939 old_value = LFACE_STRIKE_THROUGH (lface);
2940 ASET (lface, LFACE_STRIKE_THROUGH_INDEX, value);
2942 else if (EQ (attr, QCbox))
2944 int valid_p;
2946 /* Allow t meaning a simple box of width 1 in foreground color
2947 of the face. */
2948 if (EQ (value, Qt))
2949 value = make_number (1);
2951 if (UNSPECIFIEDP (value) || IGNORE_DEFFACE_P (value))
2952 valid_p = 1;
2953 else if (NILP (value))
2954 valid_p = 1;
2955 else if (INTEGERP (value))
2956 valid_p = XINT (value) != 0;
2957 else if (STRINGP (value))
2958 valid_p = SCHARS (value) > 0;
2959 else if (CONSP (value))
2961 Lisp_Object tem;
2963 tem = value;
2964 while (CONSP (tem))
2966 Lisp_Object k, v;
2968 k = XCAR (tem);
2969 tem = XCDR (tem);
2970 if (!CONSP (tem))
2971 break;
2972 v = XCAR (tem);
2973 tem = XCDR (tem);
2975 if (EQ (k, QCline_width))
2977 if (!INTEGERP (v) || XINT (v) == 0)
2978 break;
2980 else if (EQ (k, QCcolor))
2982 if (!NILP (v) && (!STRINGP (v) || SCHARS (v) == 0))
2983 break;
2985 else if (EQ (k, QCstyle))
2987 if (!EQ (v, Qpressed_button) && !EQ (v, Qreleased_button))
2988 break;
2990 else
2991 break;
2994 valid_p = NILP (tem);
2996 else
2997 valid_p = 0;
2999 if (!valid_p)
3000 signal_error ("Invalid face box", value);
3002 old_value = LFACE_BOX (lface);
3003 ASET (lface, LFACE_BOX_INDEX, value);
3005 else if (EQ (attr, QCinverse_video)
3006 || EQ (attr, QCreverse_video))
3008 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3010 CHECK_SYMBOL (value);
3011 if (!EQ (value, Qt) && !NILP (value))
3012 signal_error ("Invalid inverse-video face attribute value", value);
3014 old_value = LFACE_INVERSE (lface);
3015 ASET (lface, LFACE_INVERSE_INDEX, value);
3017 else if (EQ (attr, QCforeground))
3019 /* Compatibility with 20.x. */
3020 if (NILP (value))
3021 value = Qunspecified;
3022 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3024 /* Don't check for valid color names here because it depends
3025 on the frame (display) whether the color will be valid
3026 when the face is realized. */
3027 CHECK_STRING (value);
3028 if (SCHARS (value) == 0)
3029 signal_error ("Empty foreground color value", value);
3031 old_value = LFACE_FOREGROUND (lface);
3032 ASET (lface, LFACE_FOREGROUND_INDEX, value);
3034 else if (EQ (attr, QCbackground))
3036 /* Compatibility with 20.x. */
3037 if (NILP (value))
3038 value = Qunspecified;
3039 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3041 /* Don't check for valid color names here because it depends
3042 on the frame (display) whether the color will be valid
3043 when the face is realized. */
3044 CHECK_STRING (value);
3045 if (SCHARS (value) == 0)
3046 signal_error ("Empty background color value", value);
3048 old_value = LFACE_BACKGROUND (lface);
3049 ASET (lface, LFACE_BACKGROUND_INDEX, value);
3051 else if (EQ (attr, QCstipple))
3053 #if defined (HAVE_WINDOW_SYSTEM)
3054 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value)
3055 && !NILP (value)
3056 && NILP (Fbitmap_spec_p (value)))
3057 signal_error ("Invalid stipple attribute", value);
3058 old_value = LFACE_STIPPLE (lface);
3059 ASET (lface, LFACE_STIPPLE_INDEX, value);
3060 #endif /* HAVE_WINDOW_SYSTEM */
3062 else if (EQ (attr, QCwidth))
3064 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3066 CHECK_SYMBOL (value);
3067 if (FONT_WIDTH_NAME_NUMERIC (value) < 0)
3068 signal_error ("Invalid face width", value);
3070 old_value = LFACE_SWIDTH (lface);
3071 ASET (lface, LFACE_SWIDTH_INDEX, value);
3072 prop_index = FONT_WIDTH_INDEX;
3074 else if (EQ (attr, QCfont))
3076 #ifdef HAVE_WINDOW_SYSTEM
3077 if (EQ (frame, Qt) || FRAME_WINDOW_P (XFRAME (frame)))
3079 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3081 FRAME_PTR f;
3083 old_value = LFACE_FONT (lface);
3084 if (! FONTP (value))
3086 if (STRINGP (value))
3088 Lisp_Object name = value;
3089 int fontset = fs_query_fontset (name, 0);
3091 if (fontset >= 0)
3092 name = fontset_ascii (fontset);
3093 value = font_spec_from_name (name);
3094 if (!FONTP (value))
3095 signal_error ("Invalid font name", name);
3097 else
3098 signal_error ("Invalid font or font-spec", value);
3100 if (EQ (frame, Qt))
3101 f = XFRAME (selected_frame);
3102 else
3103 f = XFRAME (frame);
3104 if (! FONT_OBJECT_P (value))
3106 Lisp_Object *attrs = XVECTOR (lface)->contents;
3107 Lisp_Object font_object;
3109 font_object = font_load_for_lface (f, attrs, value);
3110 if (NILP (font_object))
3111 signal_error ("Font not available", value);
3112 value = font_object;
3114 set_lface_from_font (f, lface, value, 1);
3116 else
3117 ASET (lface, LFACE_FONT_INDEX, value);
3119 #endif /* HAVE_WINDOW_SYSTEM */
3121 else if (EQ (attr, QCfontset))
3123 #ifdef HAVE_WINDOW_SYSTEM
3124 if (EQ (frame, Qt) || FRAME_WINDOW_P (XFRAME (frame)))
3126 Lisp_Object tmp;
3128 old_value = LFACE_FONTSET (lface);
3129 tmp = Fquery_fontset (value, Qnil);
3130 if (NILP (tmp))
3131 signal_error ("Invalid fontset name", value);
3132 ASET (lface, LFACE_FONTSET_INDEX, value = tmp);
3134 #endif /* HAVE_WINDOW_SYSTEM */
3136 else if (EQ (attr, QCinherit))
3138 Lisp_Object tail;
3139 if (SYMBOLP (value))
3140 tail = Qnil;
3141 else
3142 for (tail = value; CONSP (tail); tail = XCDR (tail))
3143 if (!SYMBOLP (XCAR (tail)))
3144 break;
3145 if (NILP (tail))
3146 ASET (lface, LFACE_INHERIT_INDEX, value);
3147 else
3148 signal_error ("Invalid face inheritance", value);
3150 else if (EQ (attr, QCbold))
3152 old_value = LFACE_WEIGHT (lface);
3153 ASET (lface, LFACE_WEIGHT_INDEX, NILP (value) ? Qnormal : Qbold);
3154 prop_index = FONT_WEIGHT_INDEX;
3156 else if (EQ (attr, QCitalic))
3158 attr = QCslant;
3159 old_value = LFACE_SLANT (lface);
3160 ASET (lface, LFACE_SLANT_INDEX, NILP (value) ? Qnormal : Qitalic);
3161 prop_index = FONT_SLANT_INDEX;
3163 else
3164 signal_error ("Invalid face attribute name", attr);
3166 if (prop_index)
3168 /* If a font-related attribute other than QCfont and QCfontset
3169 is specified, and if the original QCfont attribute has a font
3170 (font-spec or font-object), set the corresponding property in
3171 the font to nil so that the font selector doesn't think that
3172 the attribute is mandatory. Also, clear the average
3173 width. */
3174 font_clear_prop (XVECTOR (lface)->contents, prop_index);
3177 /* Changing a named face means that all realized faces depending on
3178 that face are invalid. Since we cannot tell which realized faces
3179 depend on the face, make sure they are all removed. This is done
3180 by incrementing face_change_count. The next call to
3181 init_iterator will then free realized faces. */
3182 if (!EQ (frame, Qt)
3183 && NILP (Fget (face, Qface_no_inherit))
3184 && NILP (Fequal (old_value, value)))
3186 ++face_change_count;
3187 ++windows_or_buffers_changed;
3190 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value)
3191 && NILP (Fequal (old_value, value)))
3193 Lisp_Object param;
3195 param = Qnil;
3197 if (EQ (face, Qdefault))
3199 #ifdef HAVE_WINDOW_SYSTEM
3200 /* Changed font-related attributes of the `default' face are
3201 reflected in changed `font' frame parameters. */
3202 if (FRAMEP (frame)
3203 && (prop_index || EQ (attr, QCfont))
3204 && lface_fully_specified_p (XVECTOR (lface)->contents))
3205 set_font_frame_param (frame, lface);
3206 else
3207 #endif /* HAVE_WINDOW_SYSTEM */
3209 if (EQ (attr, QCforeground))
3210 param = Qforeground_color;
3211 else if (EQ (attr, QCbackground))
3212 param = Qbackground_color;
3214 #ifdef HAVE_WINDOW_SYSTEM
3215 #ifndef HAVE_NTGUI
3216 else if (EQ (face, Qscroll_bar))
3218 /* Changing the colors of `scroll-bar' sets frame parameters
3219 `scroll-bar-foreground' and `scroll-bar-background'. */
3220 if (EQ (attr, QCforeground))
3221 param = Qscroll_bar_foreground;
3222 else if (EQ (attr, QCbackground))
3223 param = Qscroll_bar_background;
3225 #endif /* not HAVE_NTGUI */
3226 else if (EQ (face, Qborder))
3228 /* Changing background color of `border' sets frame parameter
3229 `border-color'. */
3230 if (EQ (attr, QCbackground))
3231 param = Qborder_color;
3233 else if (EQ (face, Qcursor))
3235 /* Changing background color of `cursor' sets frame parameter
3236 `cursor-color'. */
3237 if (EQ (attr, QCbackground))
3238 param = Qcursor_color;
3240 else if (EQ (face, Qmouse))
3242 /* Changing background color of `mouse' sets frame parameter
3243 `mouse-color'. */
3244 if (EQ (attr, QCbackground))
3245 param = Qmouse_color;
3247 #endif /* HAVE_WINDOW_SYSTEM */
3248 else if (EQ (face, Qmenu))
3250 /* Indicate that we have to update the menu bar when
3251 realizing faces on FRAME. FRAME t change the
3252 default for new frames. We do this by setting
3253 setting the flag in new face caches */
3254 if (FRAMEP (frame))
3256 struct frame *f = XFRAME (frame);
3257 if (FRAME_FACE_CACHE (f) == NULL)
3258 FRAME_FACE_CACHE (f) = make_face_cache (f);
3259 FRAME_FACE_CACHE (f)->menu_face_changed_p = 1;
3261 else
3262 menu_face_changed_default = 1;
3265 if (!NILP (param))
3267 if (EQ (frame, Qt))
3268 /* Update `default-frame-alist', which is used for new frames. */
3270 store_in_alist (&Vdefault_frame_alist, param, value);
3272 else
3273 /* Update the current frame's parameters. */
3275 Lisp_Object cons;
3276 cons = XCAR (Vparam_value_alist);
3277 XSETCAR (cons, param);
3278 XSETCDR (cons, value);
3279 Fmodify_frame_parameters (frame, Vparam_value_alist);
3284 return face;
3288 /* Update the corresponding face when frame parameter PARAM on frame F
3289 has been assigned the value NEW_VALUE. */
3291 void
3292 update_face_from_frame_parameter (struct frame *f, Lisp_Object param,
3293 Lisp_Object new_value)
3295 Lisp_Object face = Qnil;
3296 Lisp_Object lface;
3298 /* If there are no faces yet, give up. This is the case when called
3299 from Fx_create_frame, and we do the necessary things later in
3300 face-set-after-frame-defaults. */
3301 if (NILP (f->face_alist))
3302 return;
3304 if (EQ (param, Qforeground_color))
3306 face = Qdefault;
3307 lface = lface_from_face_name (f, face, 1);
3308 ASET (lface, LFACE_FOREGROUND_INDEX,
3309 (STRINGP (new_value) ? new_value : Qunspecified));
3310 realize_basic_faces (f);
3312 else if (EQ (param, Qbackground_color))
3314 Lisp_Object frame;
3316 /* Changing the background color might change the background
3317 mode, so that we have to load new defface specs.
3318 Call frame-set-background-mode to do that. */
3319 XSETFRAME (frame, f);
3320 call1 (Qframe_set_background_mode, frame);
3322 face = Qdefault;
3323 lface = lface_from_face_name (f, face, 1);
3324 ASET (lface, LFACE_BACKGROUND_INDEX,
3325 (STRINGP (new_value) ? new_value : Qunspecified));
3326 realize_basic_faces (f);
3328 #ifdef HAVE_WINDOW_SYSTEM
3329 else if (EQ (param, Qborder_color))
3331 face = Qborder;
3332 lface = lface_from_face_name (f, face, 1);
3333 ASET (lface, LFACE_BACKGROUND_INDEX,
3334 (STRINGP (new_value) ? new_value : Qunspecified));
3336 else if (EQ (param, Qcursor_color))
3338 face = Qcursor;
3339 lface = lface_from_face_name (f, face, 1);
3340 ASET (lface, LFACE_BACKGROUND_INDEX,
3341 (STRINGP (new_value) ? new_value : Qunspecified));
3343 else if (EQ (param, Qmouse_color))
3345 face = Qmouse;
3346 lface = lface_from_face_name (f, face, 1);
3347 ASET (lface, LFACE_BACKGROUND_INDEX,
3348 (STRINGP (new_value) ? new_value : Qunspecified));
3350 #endif
3352 /* Changing a named face means that all realized faces depending on
3353 that face are invalid. Since we cannot tell which realized faces
3354 depend on the face, make sure they are all removed. This is done
3355 by incrementing face_change_count. The next call to
3356 init_iterator will then free realized faces. */
3357 if (!NILP (face)
3358 && NILP (Fget (face, Qface_no_inherit)))
3360 ++face_change_count;
3361 ++windows_or_buffers_changed;
3366 #ifdef HAVE_WINDOW_SYSTEM
3368 /* Set the `font' frame parameter of FRAME determined from the
3369 font-object set in `default' face attributes LFACE. */
3371 static void
3372 set_font_frame_param (Lisp_Object frame, Lisp_Object lface)
3374 struct frame *f = XFRAME (frame);
3375 Lisp_Object font;
3377 if (FRAME_WINDOW_P (f)
3378 /* Don't do anything if the font is `unspecified'. This can
3379 happen during frame creation. */
3380 && (font = LFACE_FONT (lface),
3381 ! UNSPECIFIEDP (font)))
3383 if (FONT_SPEC_P (font))
3385 font = font_load_for_lface (f, XVECTOR (lface)->contents, font);
3386 if (NILP (font))
3387 return;
3388 ASET (lface, LFACE_FONT_INDEX, font);
3390 f->default_face_done_p = 0;
3391 Fmodify_frame_parameters (frame, Fcons (Fcons (Qfont, font), Qnil));
3395 DEFUN ("internal-face-x-get-resource", Finternal_face_x_get_resource,
3396 Sinternal_face_x_get_resource, 2, 3, 0,
3397 doc: /* Get the value of X resource RESOURCE, class CLASS.
3398 Returned value is for the display of frame FRAME. If FRAME is not
3399 specified or nil, use selected frame. This function exists because
3400 ordinary `x-get-resource' doesn't take a frame argument. */)
3401 (Lisp_Object resource, Lisp_Object class, Lisp_Object frame)
3403 Lisp_Object value = Qnil;
3404 struct frame *f;
3406 CHECK_STRING (resource);
3407 CHECK_STRING (class);
3408 f = decode_live_frame (frame);
3409 block_input ();
3410 value = display_x_get_resource (FRAME_X_DISPLAY_INFO (f),
3411 resource, class, Qnil, Qnil);
3412 unblock_input ();
3413 return value;
3417 /* Return resource string VALUE as a boolean value, i.e. nil, or t.
3418 If VALUE is "on" or "true", return t. If VALUE is "off" or
3419 "false", return nil. Otherwise, if SIGNAL_P is non-zero, signal an
3420 error; if SIGNAL_P is zero, return 0. */
3422 static Lisp_Object
3423 face_boolean_x_resource_value (Lisp_Object value, int signal_p)
3425 Lisp_Object result = make_number (0);
3427 eassert (STRINGP (value));
3429 if (xstrcasecmp (SSDATA (value), "on") == 0
3430 || xstrcasecmp (SSDATA (value), "true") == 0)
3431 result = Qt;
3432 else if (xstrcasecmp (SSDATA (value), "off") == 0
3433 || xstrcasecmp (SSDATA (value), "false") == 0)
3434 result = Qnil;
3435 else if (xstrcasecmp (SSDATA (value), "unspecified") == 0)
3436 result = Qunspecified;
3437 else if (signal_p)
3438 signal_error ("Invalid face attribute value from X resource", value);
3440 return result;
3444 DEFUN ("internal-set-lisp-face-attribute-from-resource",
3445 Finternal_set_lisp_face_attribute_from_resource,
3446 Sinternal_set_lisp_face_attribute_from_resource,
3447 3, 4, 0, doc: /* */)
3448 (Lisp_Object face, Lisp_Object attr, Lisp_Object value, Lisp_Object frame)
3450 CHECK_SYMBOL (face);
3451 CHECK_SYMBOL (attr);
3452 CHECK_STRING (value);
3454 if (xstrcasecmp (SSDATA (value), "unspecified") == 0)
3455 value = Qunspecified;
3456 else if (EQ (attr, QCheight))
3458 value = Fstring_to_number (value, make_number (10));
3459 if (XINT (value) <= 0)
3460 signal_error ("Invalid face height from X resource", value);
3462 else if (EQ (attr, QCbold) || EQ (attr, QCitalic))
3463 value = face_boolean_x_resource_value (value, 1);
3464 else if (EQ (attr, QCweight) || EQ (attr, QCslant) || EQ (attr, QCwidth))
3465 value = intern (SSDATA (value));
3466 else if (EQ (attr, QCreverse_video) || EQ (attr, QCinverse_video))
3467 value = face_boolean_x_resource_value (value, 1);
3468 else if (EQ (attr, QCunderline)
3469 || EQ (attr, QCoverline)
3470 || EQ (attr, QCstrike_through))
3472 Lisp_Object boolean_value;
3474 /* If the result of face_boolean_x_resource_value is t or nil,
3475 VALUE does NOT specify a color. */
3476 boolean_value = face_boolean_x_resource_value (value, 0);
3477 if (SYMBOLP (boolean_value))
3478 value = boolean_value;
3480 else if (EQ (attr, QCbox) || EQ (attr, QCinherit))
3481 value = Fcar (Fread_from_string (value, Qnil, Qnil));
3483 return Finternal_set_lisp_face_attribute (face, attr, value, frame);
3486 #endif /* HAVE_WINDOW_SYSTEM */
3489 /***********************************************************************
3490 Menu face
3491 ***********************************************************************/
3493 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
3495 /* Make menus on frame F appear as specified by the `menu' face. */
3497 static void
3498 x_update_menu_appearance (struct frame *f)
3500 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3501 XrmDatabase rdb;
3503 if (dpyinfo
3504 && (rdb = XrmGetDatabase (FRAME_X_DISPLAY (f)),
3505 rdb != NULL))
3507 char line[512];
3508 char *buf = line;
3509 ptrdiff_t bufsize = sizeof line;
3510 Lisp_Object lface = lface_from_face_name (f, Qmenu, 1);
3511 struct face *face = FACE_FROM_ID (f, MENU_FACE_ID);
3512 const char *myname = SSDATA (Vx_resource_name);
3513 int changed_p = 0;
3514 #ifdef USE_MOTIF
3515 const char *popup_path = "popup_menu";
3516 #else
3517 const char *popup_path = "menu.popup";
3518 #endif
3520 if (STRINGP (LFACE_FOREGROUND (lface)))
3522 exprintf (&buf, &bufsize, line, -1, "%s.%s*foreground: %s",
3523 myname, popup_path,
3524 SDATA (LFACE_FOREGROUND (lface)));
3525 XrmPutLineResource (&rdb, line);
3526 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*foreground: %s",
3527 myname, SDATA (LFACE_FOREGROUND (lface)));
3528 XrmPutLineResource (&rdb, line);
3529 changed_p = 1;
3532 if (STRINGP (LFACE_BACKGROUND (lface)))
3534 exprintf (&buf, &bufsize, line, -1, "%s.%s*background: %s",
3535 myname, popup_path,
3536 SDATA (LFACE_BACKGROUND (lface)));
3537 XrmPutLineResource (&rdb, line);
3539 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*background: %s",
3540 myname, SDATA (LFACE_BACKGROUND (lface)));
3541 XrmPutLineResource (&rdb, line);
3542 changed_p = 1;
3545 if (face->font
3546 /* On Solaris 5.8, it's been reported that the `menu' face
3547 can be unspecified here, during startup. Why this
3548 happens remains unknown. -- cyd */
3549 && FONTP (LFACE_FONT (lface))
3550 && (!UNSPECIFIEDP (LFACE_FAMILY (lface))
3551 || !UNSPECIFIEDP (LFACE_FOUNDRY (lface))
3552 || !UNSPECIFIEDP (LFACE_SWIDTH (lface))
3553 || !UNSPECIFIEDP (LFACE_WEIGHT (lface))
3554 || !UNSPECIFIEDP (LFACE_SLANT (lface))
3555 || !UNSPECIFIEDP (LFACE_HEIGHT (lface))))
3557 Lisp_Object xlfd = Ffont_xlfd_name (LFACE_FONT (lface), Qnil);
3558 #ifdef USE_MOTIF
3559 const char *suffix = "List";
3560 Bool motif = True;
3561 #else
3562 #if defined HAVE_X_I18N
3564 const char *suffix = "Set";
3565 #else
3566 const char *suffix = "";
3567 #endif
3568 Bool motif = False;
3569 #endif
3571 if (! NILP (xlfd))
3573 #if defined HAVE_X_I18N
3574 char *fontsetname = xic_create_fontsetname (SSDATA (xlfd), motif);
3575 #else
3576 char *fontsetname = SSDATA (xlfd);
3577 #endif
3578 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*font%s: %s",
3579 myname, suffix, fontsetname);
3580 XrmPutLineResource (&rdb, line);
3582 exprintf (&buf, &bufsize, line, -1, "%s.%s*font%s: %s",
3583 myname, popup_path, suffix, fontsetname);
3584 XrmPutLineResource (&rdb, line);
3585 changed_p = 1;
3586 if (fontsetname != SSDATA (xlfd))
3587 xfree (fontsetname);
3591 if (changed_p && f->output_data.x->menubar_widget)
3592 free_frame_menubar (f);
3594 if (buf != line)
3595 xfree (buf);
3599 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
3602 DEFUN ("face-attribute-relative-p", Fface_attribute_relative_p,
3603 Sface_attribute_relative_p,
3604 2, 2, 0,
3605 doc: /* Check whether a face attribute value is relative.
3606 Specifically, this function returns t if the attribute ATTRIBUTE
3607 with the value VALUE is relative.
3609 A relative value is one that doesn't entirely override whatever is
3610 inherited from another face. For most possible attributes,
3611 the only relative value that users see is `unspecified'.
3612 However, for :height, floating point values are also relative. */)
3613 (Lisp_Object attribute, Lisp_Object value)
3615 if (EQ (value, Qunspecified) || (EQ (value, QCignore_defface)))
3616 return Qt;
3617 else if (EQ (attribute, QCheight))
3618 return INTEGERP (value) ? Qnil : Qt;
3619 else
3620 return Qnil;
3623 DEFUN ("merge-face-attribute", Fmerge_face_attribute, Smerge_face_attribute,
3624 3, 3, 0,
3625 doc: /* Return face ATTRIBUTE VALUE1 merged with VALUE2.
3626 If VALUE1 or VALUE2 are absolute (see `face-attribute-relative-p'), then
3627 the result will be absolute, otherwise it will be relative. */)
3628 (Lisp_Object attribute, Lisp_Object value1, Lisp_Object value2)
3630 if (EQ (value1, Qunspecified) || EQ (value1, QCignore_defface))
3631 return value2;
3632 else if (EQ (attribute, QCheight))
3633 return merge_face_heights (value1, value2, value1);
3634 else
3635 return value1;
3639 DEFUN ("internal-get-lisp-face-attribute", Finternal_get_lisp_face_attribute,
3640 Sinternal_get_lisp_face_attribute,
3641 2, 3, 0,
3642 doc: /* Return face attribute KEYWORD of face SYMBOL.
3643 If SYMBOL does not name a valid Lisp face or KEYWORD isn't a valid
3644 face attribute name, signal an error.
3645 If the optional argument FRAME is given, report on face SYMBOL in that
3646 frame. If FRAME is t, report on the defaults for face SYMBOL (for new
3647 frames). If FRAME is omitted or nil, use the selected frame. */)
3648 (Lisp_Object symbol, Lisp_Object keyword, Lisp_Object frame)
3650 struct frame *f = EQ (frame, Qt) ? NULL : decode_live_frame (frame);
3651 Lisp_Object lface = lface_from_face_name (f, symbol, 1), value = Qnil;
3653 CHECK_SYMBOL (symbol);
3654 CHECK_SYMBOL (keyword);
3656 if (EQ (keyword, QCfamily))
3657 value = LFACE_FAMILY (lface);
3658 else if (EQ (keyword, QCfoundry))
3659 value = LFACE_FOUNDRY (lface);
3660 else if (EQ (keyword, QCheight))
3661 value = LFACE_HEIGHT (lface);
3662 else if (EQ (keyword, QCweight))
3663 value = LFACE_WEIGHT (lface);
3664 else if (EQ (keyword, QCslant))
3665 value = LFACE_SLANT (lface);
3666 else if (EQ (keyword, QCunderline))
3667 value = LFACE_UNDERLINE (lface);
3668 else if (EQ (keyword, QCoverline))
3669 value = LFACE_OVERLINE (lface);
3670 else if (EQ (keyword, QCstrike_through))
3671 value = LFACE_STRIKE_THROUGH (lface);
3672 else if (EQ (keyword, QCbox))
3673 value = LFACE_BOX (lface);
3674 else if (EQ (keyword, QCinverse_video)
3675 || EQ (keyword, QCreverse_video))
3676 value = LFACE_INVERSE (lface);
3677 else if (EQ (keyword, QCforeground))
3678 value = LFACE_FOREGROUND (lface);
3679 else if (EQ (keyword, QCbackground))
3680 value = LFACE_BACKGROUND (lface);
3681 else if (EQ (keyword, QCstipple))
3682 value = LFACE_STIPPLE (lface);
3683 else if (EQ (keyword, QCwidth))
3684 value = LFACE_SWIDTH (lface);
3685 else if (EQ (keyword, QCinherit))
3686 value = LFACE_INHERIT (lface);
3687 else if (EQ (keyword, QCfont))
3688 value = LFACE_FONT (lface);
3689 else if (EQ (keyword, QCfontset))
3690 value = LFACE_FONTSET (lface);
3691 else
3692 signal_error ("Invalid face attribute name", keyword);
3694 if (IGNORE_DEFFACE_P (value))
3695 return Qunspecified;
3697 return value;
3701 DEFUN ("internal-lisp-face-attribute-values",
3702 Finternal_lisp_face_attribute_values,
3703 Sinternal_lisp_face_attribute_values, 1, 1, 0,
3704 doc: /* Return a list of valid discrete values for face attribute ATTR.
3705 Value is nil if ATTR doesn't have a discrete set of valid values. */)
3706 (Lisp_Object attr)
3708 Lisp_Object result = Qnil;
3710 CHECK_SYMBOL (attr);
3712 if (EQ (attr, QCunderline))
3713 result = Fcons (Qt, Fcons (Qnil, Qnil));
3714 else if (EQ (attr, QCoverline))
3715 result = Fcons (Qt, Fcons (Qnil, Qnil));
3716 else if (EQ (attr, QCstrike_through))
3717 result = Fcons (Qt, Fcons (Qnil, Qnil));
3718 else if (EQ (attr, QCinverse_video) || EQ (attr, QCreverse_video))
3719 result = Fcons (Qt, Fcons (Qnil, Qnil));
3721 return result;
3725 DEFUN ("internal-merge-in-global-face", Finternal_merge_in_global_face,
3726 Sinternal_merge_in_global_face, 2, 2, 0,
3727 doc: /* Add attributes from frame-default definition of FACE to FACE on FRAME.
3728 Default face attributes override any local face attributes. */)
3729 (Lisp_Object face, Lisp_Object frame)
3731 int i;
3732 Lisp_Object global_lface, local_lface, *gvec, *lvec;
3733 struct frame *f = XFRAME (frame);
3735 CHECK_LIVE_FRAME (frame);
3736 global_lface = lface_from_face_name (NULL, face, 1);
3737 local_lface = lface_from_face_name (f, face, 0);
3738 if (NILP (local_lface))
3739 local_lface = Finternal_make_lisp_face (face, frame);
3741 /* Make every specified global attribute override the local one.
3742 BEWARE!! This is only used from `face-set-after-frame-default' where
3743 the local frame is defined from default specs in `face-defface-spec'
3744 and those should be overridden by global settings. Hence the strange
3745 "global before local" priority. */
3746 lvec = XVECTOR (local_lface)->contents;
3747 gvec = XVECTOR (global_lface)->contents;
3748 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3749 if (IGNORE_DEFFACE_P (gvec[i]))
3750 ASET (local_lface, i, Qunspecified);
3751 else if (! UNSPECIFIEDP (gvec[i]))
3752 ASET (local_lface, i, AREF (global_lface, i));
3754 /* If the default face was changed, update the face cache and the
3755 `font' frame parameter. */
3756 if (EQ (face, Qdefault))
3758 struct face_cache *c = FRAME_FACE_CACHE (f);
3759 struct face *newface, *oldface = FACE_FROM_ID (f, DEFAULT_FACE_ID);
3760 Lisp_Object attrs[LFACE_VECTOR_SIZE];
3762 /* This can be NULL (e.g., in batch mode). */
3763 if (oldface)
3765 /* Ensure that the face vector is fully specified by merging
3766 the previously-cached vector. */
3767 memcpy (attrs, oldface->lface, sizeof attrs);
3768 merge_face_vectors (f, lvec, attrs, 0);
3769 vcopy (local_lface, 0, attrs, LFACE_VECTOR_SIZE);
3770 newface = realize_face (c, lvec, DEFAULT_FACE_ID);
3772 if ((! UNSPECIFIEDP (gvec[LFACE_FAMILY_INDEX])
3773 || ! UNSPECIFIEDP (gvec[LFACE_FOUNDRY_INDEX])
3774 || ! UNSPECIFIEDP (gvec[LFACE_HEIGHT_INDEX])
3775 || ! UNSPECIFIEDP (gvec[LFACE_WEIGHT_INDEX])
3776 || ! UNSPECIFIEDP (gvec[LFACE_SLANT_INDEX])
3777 || ! UNSPECIFIEDP (gvec[LFACE_SWIDTH_INDEX])
3778 || ! UNSPECIFIEDP (gvec[LFACE_FONT_INDEX]))
3779 && newface->font)
3781 Lisp_Object name = newface->font->props[FONT_NAME_INDEX];
3782 Fmodify_frame_parameters (frame, Fcons (Fcons (Qfont, name),
3783 Qnil));
3786 if (STRINGP (gvec[LFACE_FOREGROUND_INDEX]))
3787 Fmodify_frame_parameters (frame,
3788 Fcons (Fcons (Qforeground_color,
3789 gvec[LFACE_FOREGROUND_INDEX]),
3790 Qnil));
3792 if (STRINGP (gvec[LFACE_BACKGROUND_INDEX]))
3793 Fmodify_frame_parameters (frame,
3794 Fcons (Fcons (Qbackground_color,
3795 gvec[LFACE_BACKGROUND_INDEX]),
3796 Qnil));
3800 return Qnil;
3804 /* The following function is implemented for compatibility with 20.2.
3805 The function is used in x-resolve-fonts when it is asked to
3806 return fonts with the same size as the font of a face. This is
3807 done in fontset.el. */
3809 DEFUN ("face-font", Fface_font, Sface_font, 1, 3, 0,
3810 doc: /* Return the font name of face FACE, or nil if it is unspecified.
3811 The font name is, by default, for ASCII characters.
3812 If the optional argument FRAME is given, report on face FACE in that frame.
3813 If FRAME is t, report on the defaults for face FACE (for new frames).
3814 The font default for a face is either nil, or a list
3815 of the form (bold), (italic) or (bold italic).
3816 If FRAME is omitted or nil, use the selected frame. And, in this case,
3817 if the optional third argument CHARACTER is given,
3818 return the font name used for CHARACTER. */)
3819 (Lisp_Object face, Lisp_Object frame, Lisp_Object character)
3821 if (EQ (frame, Qt))
3823 Lisp_Object result = Qnil;
3824 Lisp_Object lface = lface_from_face_name (NULL, face, 1);
3826 if (!UNSPECIFIEDP (LFACE_WEIGHT (lface))
3827 && !EQ (LFACE_WEIGHT (lface), Qnormal))
3828 result = Fcons (Qbold, result);
3830 if (!UNSPECIFIEDP (LFACE_SLANT (lface))
3831 && !EQ (LFACE_SLANT (lface), Qnormal))
3832 result = Fcons (Qitalic, result);
3834 return result;
3836 else
3838 struct frame *f = decode_live_frame (frame);
3839 int face_id = lookup_named_face (f, face, 1);
3840 struct face *fface = FACE_FROM_ID (f, face_id);
3842 if (! fface)
3843 return Qnil;
3844 #ifdef HAVE_WINDOW_SYSTEM
3845 if (FRAME_WINDOW_P (f) && !NILP (character))
3847 CHECK_CHARACTER (character);
3848 face_id = FACE_FOR_CHAR (f, fface, XINT (character), -1, Qnil);
3849 fface = FACE_FROM_ID (f, face_id);
3851 return (fface->font
3852 ? fface->font->props[FONT_NAME_INDEX]
3853 : Qnil);
3854 #else /* !HAVE_WINDOW_SYSTEM */
3855 return build_string (FRAME_MSDOS_P (f)
3856 ? "ms-dos"
3857 : FRAME_W32_P (f) ? "w32term"
3858 :"tty");
3859 #endif
3864 /* Compare face-attribute values v1 and v2 for equality. Value is non-zero if
3865 all attributes are `equal'. Tries to be fast because this function
3866 is called quite often. */
3868 static int
3869 face_attr_equal_p (Lisp_Object v1, Lisp_Object v2)
3871 /* Type can differ, e.g. when one attribute is unspecified, i.e. nil,
3872 and the other is specified. */
3873 if (XTYPE (v1) != XTYPE (v2))
3874 return 0;
3876 if (EQ (v1, v2))
3877 return 1;
3879 switch (XTYPE (v1))
3881 case Lisp_String:
3882 if (SBYTES (v1) != SBYTES (v2))
3883 return 0;
3885 return memcmp (SDATA (v1), SDATA (v2), SBYTES (v1)) == 0;
3887 case_Lisp_Int:
3888 case Lisp_Symbol:
3889 return 0;
3891 default:
3892 return !NILP (Fequal (v1, v2));
3897 /* Compare face vectors V1 and V2 for equality. Value is non-zero if
3898 all attributes are `equal'. Tries to be fast because this function
3899 is called quite often. */
3901 static int
3902 lface_equal_p (Lisp_Object *v1, Lisp_Object *v2)
3904 int i, equal_p = 1;
3906 for (i = 1; i < LFACE_VECTOR_SIZE && equal_p; ++i)
3907 equal_p = face_attr_equal_p (v1[i], v2[i]);
3909 return equal_p;
3913 DEFUN ("internal-lisp-face-equal-p", Finternal_lisp_face_equal_p,
3914 Sinternal_lisp_face_equal_p, 2, 3, 0,
3915 doc: /* True if FACE1 and FACE2 are equal.
3916 If the optional argument FRAME is given, report on FACE1 and FACE2 in that frame.
3917 If FRAME is t, report on the defaults for FACE1 and FACE2 (for new frames).
3918 If FRAME is omitted or nil, use the selected frame. */)
3919 (Lisp_Object face1, Lisp_Object face2, Lisp_Object frame)
3921 int equal_p;
3922 struct frame *f;
3923 Lisp_Object lface1, lface2;
3925 /* Don't use decode_window_system_frame here because this function
3926 is called before X frames exist. At that time, if FRAME is nil,
3927 selected_frame will be used which is the frame dumped with
3928 Emacs. That frame is not an X frame. */
3929 f = EQ (frame, Qt) ? NULL : decode_live_frame (frame);
3931 lface1 = lface_from_face_name (f, face1, 1);
3932 lface2 = lface_from_face_name (f, face2, 1);
3933 equal_p = lface_equal_p (XVECTOR (lface1)->contents,
3934 XVECTOR (lface2)->contents);
3935 return equal_p ? Qt : Qnil;
3939 DEFUN ("internal-lisp-face-empty-p", Finternal_lisp_face_empty_p,
3940 Sinternal_lisp_face_empty_p, 1, 2, 0,
3941 doc: /* True if FACE has no attribute specified.
3942 If the optional argument FRAME is given, report on face FACE in that frame.
3943 If FRAME is t, report on the defaults for face FACE (for new frames).
3944 If FRAME is omitted or nil, use the selected frame. */)
3945 (Lisp_Object face, Lisp_Object frame)
3947 struct frame *f = EQ (frame, Qt) ? NULL : decode_live_frame (frame);
3948 Lisp_Object lface = lface_from_face_name (f, face, 1);
3949 int i;
3951 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3952 if (!UNSPECIFIEDP (AREF (lface, i)))
3953 break;
3955 return i == LFACE_VECTOR_SIZE ? Qt : Qnil;
3959 DEFUN ("frame-face-alist", Fframe_face_alist, Sframe_face_alist,
3960 0, 1, 0,
3961 doc: /* Return an alist of frame-local faces defined on FRAME.
3962 For internal use only. */)
3963 (Lisp_Object frame)
3965 return decode_live_frame (frame)->face_alist;
3969 /* Return a hash code for Lisp string STRING with case ignored. Used
3970 below in computing a hash value for a Lisp face. */
3972 static unsigned
3973 hash_string_case_insensitive (Lisp_Object string)
3975 const unsigned char *s;
3976 unsigned hash = 0;
3977 eassert (STRINGP (string));
3978 for (s = SDATA (string); *s; ++s)
3979 hash = (hash << 1) ^ c_tolower (*s);
3980 return hash;
3984 /* Return a hash code for face attribute vector V. */
3986 static unsigned
3987 lface_hash (Lisp_Object *v)
3989 return (hash_string_case_insensitive (v[LFACE_FAMILY_INDEX])
3990 ^ hash_string_case_insensitive (v[LFACE_FOUNDRY_INDEX])
3991 ^ hash_string_case_insensitive (v[LFACE_FOREGROUND_INDEX])
3992 ^ hash_string_case_insensitive (v[LFACE_BACKGROUND_INDEX])
3993 ^ XHASH (v[LFACE_WEIGHT_INDEX])
3994 ^ XHASH (v[LFACE_SLANT_INDEX])
3995 ^ XHASH (v[LFACE_SWIDTH_INDEX])
3996 ^ XHASH (v[LFACE_HEIGHT_INDEX]));
4000 /* Return non-zero if LFACE1 and LFACE2 specify the same font (without
4001 considering charsets/registries). They do if they specify the same
4002 family, point size, weight, width, slant, and font. Both
4003 LFACE1 and LFACE2 must be fully-specified. */
4005 static int
4006 lface_same_font_attributes_p (Lisp_Object *lface1, Lisp_Object *lface2)
4008 eassert (lface_fully_specified_p (lface1)
4009 && lface_fully_specified_p (lface2));
4010 return (xstrcasecmp (SSDATA (lface1[LFACE_FAMILY_INDEX]),
4011 SSDATA (lface2[LFACE_FAMILY_INDEX])) == 0
4012 && xstrcasecmp (SSDATA (lface1[LFACE_FOUNDRY_INDEX]),
4013 SSDATA (lface2[LFACE_FOUNDRY_INDEX])) == 0
4014 && EQ (lface1[LFACE_HEIGHT_INDEX], lface2[LFACE_HEIGHT_INDEX])
4015 && EQ (lface1[LFACE_SWIDTH_INDEX], lface2[LFACE_SWIDTH_INDEX])
4016 && EQ (lface1[LFACE_WEIGHT_INDEX], lface2[LFACE_WEIGHT_INDEX])
4017 && EQ (lface1[LFACE_SLANT_INDEX], lface2[LFACE_SLANT_INDEX])
4018 && EQ (lface1[LFACE_FONT_INDEX], lface2[LFACE_FONT_INDEX])
4019 && (EQ (lface1[LFACE_FONTSET_INDEX], lface2[LFACE_FONTSET_INDEX])
4020 || (STRINGP (lface1[LFACE_FONTSET_INDEX])
4021 && STRINGP (lface2[LFACE_FONTSET_INDEX])
4022 && ! xstrcasecmp (SSDATA (lface1[LFACE_FONTSET_INDEX]),
4023 SSDATA (lface2[LFACE_FONTSET_INDEX]))))
4029 /***********************************************************************
4030 Realized Faces
4031 ***********************************************************************/
4033 /* Allocate and return a new realized face for Lisp face attribute
4034 vector ATTR. */
4036 static struct face *
4037 make_realized_face (Lisp_Object *attr)
4039 struct face *face = xzalloc (sizeof *face);
4040 face->ascii_face = face;
4041 memcpy (face->lface, attr, sizeof face->lface);
4042 return face;
4046 /* Free realized face FACE, including its X resources. FACE may
4047 be null. */
4049 static void
4050 free_realized_face (struct frame *f, struct face *face)
4052 if (face)
4054 #ifdef HAVE_WINDOW_SYSTEM
4055 if (FRAME_WINDOW_P (f))
4057 /* Free fontset of FACE if it is ASCII face. */
4058 if (face->fontset >= 0 && face == face->ascii_face)
4059 free_face_fontset (f, face);
4060 if (face->gc)
4062 block_input ();
4063 if (face->font)
4064 font_done_for_face (f, face);
4065 x_free_gc (f, face->gc);
4066 face->gc = 0;
4067 unblock_input ();
4070 free_face_colors (f, face);
4071 x_destroy_bitmap (f, face->stipple);
4073 #endif /* HAVE_WINDOW_SYSTEM */
4075 xfree (face);
4080 /* Prepare face FACE for subsequent display on frame F. This
4081 allocated GCs if they haven't been allocated yet or have been freed
4082 by clearing the face cache. */
4084 void
4085 prepare_face_for_display (struct frame *f, struct face *face)
4087 #ifdef HAVE_WINDOW_SYSTEM
4088 eassert (FRAME_WINDOW_P (f));
4090 if (face->gc == 0)
4092 XGCValues xgcv;
4093 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
4095 xgcv.foreground = face->foreground;
4096 xgcv.background = face->background;
4097 #ifdef HAVE_X_WINDOWS
4098 xgcv.graphics_exposures = False;
4099 #endif
4101 block_input ();
4102 #ifdef HAVE_X_WINDOWS
4103 if (face->stipple)
4105 xgcv.fill_style = FillOpaqueStippled;
4106 xgcv.stipple = x_bitmap_pixmap (f, face->stipple);
4107 mask |= GCFillStyle | GCStipple;
4109 #endif
4110 face->gc = x_create_gc (f, mask, &xgcv);
4111 if (face->font)
4112 font_prepare_for_face (f, face);
4113 unblock_input ();
4115 #endif /* HAVE_WINDOW_SYSTEM */
4119 /* Returns the `distance' between the colors X and Y. */
4121 static int
4122 color_distance (XColor *x, XColor *y)
4124 /* This formula is from a paper titled `Colour metric' by Thiadmer Riemersma.
4125 Quoting from that paper:
4127 This formula has results that are very close to L*u*v* (with the
4128 modified lightness curve) and, more importantly, it is a more even
4129 algorithm: it does not have a range of colors where it suddenly
4130 gives far from optimal results.
4132 See <http://www.compuphase.com/cmetric.htm> for more info. */
4134 long r = (x->red - y->red) >> 8;
4135 long g = (x->green - y->green) >> 8;
4136 long b = (x->blue - y->blue) >> 8;
4137 long r_mean = (x->red + y->red) >> 9;
4139 return
4140 (((512 + r_mean) * r * r) >> 8)
4141 + 4 * g * g
4142 + (((767 - r_mean) * b * b) >> 8);
4146 DEFUN ("color-distance", Fcolor_distance, Scolor_distance, 2, 3, 0,
4147 doc: /* Return an integer distance between COLOR1 and COLOR2 on FRAME.
4148 COLOR1 and COLOR2 may be either strings containing the color name,
4149 or lists of the form (RED GREEN BLUE).
4150 If FRAME is unspecified or nil, the current frame is used. */)
4151 (Lisp_Object color1, Lisp_Object color2, Lisp_Object frame)
4153 struct frame *f = decode_live_frame (frame);
4154 XColor cdef1, cdef2;
4156 if (!(CONSP (color1) && parse_rgb_list (color1, &cdef1))
4157 && !(STRINGP (color1) && defined_color (f, SSDATA (color1), &cdef1, 0)))
4158 signal_error ("Invalid color", color1);
4159 if (!(CONSP (color2) && parse_rgb_list (color2, &cdef2))
4160 && !(STRINGP (color2) && defined_color (f, SSDATA (color2), &cdef2, 0)))
4161 signal_error ("Invalid color", color2);
4163 return make_number (color_distance (&cdef1, &cdef2));
4167 /***********************************************************************
4168 Face Cache
4169 ***********************************************************************/
4171 /* Return a new face cache for frame F. */
4173 static struct face_cache *
4174 make_face_cache (struct frame *f)
4176 struct face_cache *c;
4177 int size;
4179 c = xzalloc (sizeof *c);
4180 size = FACE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
4181 c->buckets = xzalloc (size);
4182 c->size = 50;
4183 c->faces_by_id = xmalloc (c->size * sizeof *c->faces_by_id);
4184 c->f = f;
4185 c->menu_face_changed_p = menu_face_changed_default;
4186 return c;
4190 /* Clear out all graphics contexts for all realized faces, except for
4191 the basic faces. This should be done from time to time just to avoid
4192 keeping too many graphics contexts that are no longer needed. */
4194 static void
4195 clear_face_gcs (struct face_cache *c)
4197 if (c && FRAME_WINDOW_P (c->f))
4199 #ifdef HAVE_WINDOW_SYSTEM
4200 int i;
4201 for (i = BASIC_FACE_ID_SENTINEL; i < c->used; ++i)
4203 struct face *face = c->faces_by_id[i];
4204 if (face && face->gc)
4206 block_input ();
4207 if (face->font)
4208 font_done_for_face (c->f, face);
4209 x_free_gc (c->f, face->gc);
4210 face->gc = 0;
4211 unblock_input ();
4214 #endif /* HAVE_WINDOW_SYSTEM */
4219 /* Free all realized faces in face cache C, including basic faces.
4220 C may be null. If faces are freed, make sure the frame's current
4221 matrix is marked invalid, so that a display caused by an expose
4222 event doesn't try to use faces we destroyed. */
4224 static void
4225 free_realized_faces (struct face_cache *c)
4227 if (c && c->used)
4229 int i, size;
4230 struct frame *f = c->f;
4232 /* We must block input here because we can't process X events
4233 safely while only some faces are freed, or when the frame's
4234 current matrix still references freed faces. */
4235 block_input ();
4237 for (i = 0; i < c->used; ++i)
4239 free_realized_face (f, c->faces_by_id[i]);
4240 c->faces_by_id[i] = NULL;
4243 c->used = 0;
4244 size = FACE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
4245 memset (c->buckets, 0, size);
4247 /* Must do a thorough redisplay the next time. Mark current
4248 matrices as invalid because they will reference faces freed
4249 above. This function is also called when a frame is
4250 destroyed. In this case, the root window of F is nil. */
4251 if (WINDOWP (f->root_window))
4253 clear_current_matrices (f);
4254 ++windows_or_buffers_changed;
4257 unblock_input ();
4262 /* Free all realized faces on FRAME or on all frames if FRAME is nil.
4263 This is done after attributes of a named face have been changed,
4264 because we can't tell which realized faces depend on that face. */
4266 void
4267 free_all_realized_faces (Lisp_Object frame)
4269 if (NILP (frame))
4271 Lisp_Object rest;
4272 FOR_EACH_FRAME (rest, frame)
4273 free_realized_faces (FRAME_FACE_CACHE (XFRAME (frame)));
4275 else
4276 free_realized_faces (FRAME_FACE_CACHE (XFRAME (frame)));
4280 /* Free face cache C and faces in it, including their X resources. */
4282 static void
4283 free_face_cache (struct face_cache *c)
4285 if (c)
4287 free_realized_faces (c);
4288 xfree (c->buckets);
4289 xfree (c->faces_by_id);
4290 xfree (c);
4295 /* Cache realized face FACE in face cache C. HASH is the hash value
4296 of FACE. If FACE is for ASCII characters (i.e. FACE->ascii_face ==
4297 FACE), insert the new face to the beginning of the collision list
4298 of the face hash table of C. Otherwise, add the new face to the
4299 end of the collision list. This way, lookup_face can quickly find
4300 that a requested face is not cached. */
4302 static void
4303 cache_face (struct face_cache *c, struct face *face, unsigned int hash)
4305 int i = hash % FACE_CACHE_BUCKETS_SIZE;
4307 face->hash = hash;
4309 if (face->ascii_face != face)
4311 struct face *last = c->buckets[i];
4312 if (last)
4314 while (last->next)
4315 last = last->next;
4316 last->next = face;
4317 face->prev = last;
4318 face->next = NULL;
4320 else
4322 c->buckets[i] = face;
4323 face->prev = face->next = NULL;
4326 else
4328 face->prev = NULL;
4329 face->next = c->buckets[i];
4330 if (face->next)
4331 face->next->prev = face;
4332 c->buckets[i] = face;
4335 /* Find a free slot in C->faces_by_id and use the index of the free
4336 slot as FACE->id. */
4337 for (i = 0; i < c->used; ++i)
4338 if (c->faces_by_id[i] == NULL)
4339 break;
4340 face->id = i;
4342 #ifdef GLYPH_DEBUG
4343 /* Check that FACE got a unique id. */
4345 int j, n;
4346 struct face *face1;
4348 for (j = n = 0; j < FACE_CACHE_BUCKETS_SIZE; ++j)
4349 for (face1 = c->buckets[j]; face1; face1 = face1->next)
4350 if (face1->id == i)
4351 ++n;
4353 eassert (n == 1);
4355 #endif /* GLYPH_DEBUG */
4357 /* Maybe enlarge C->faces_by_id. */
4358 if (i == c->used)
4360 if (c->used == c->size)
4361 c->faces_by_id = xpalloc (c->faces_by_id, &c->size, 1, MAX_FACE_ID,
4362 sizeof *c->faces_by_id);
4363 c->used++;
4366 c->faces_by_id[i] = face;
4370 /* Remove face FACE from cache C. */
4372 static void
4373 uncache_face (struct face_cache *c, struct face *face)
4375 int i = face->hash % FACE_CACHE_BUCKETS_SIZE;
4377 if (face->prev)
4378 face->prev->next = face->next;
4379 else
4380 c->buckets[i] = face->next;
4382 if (face->next)
4383 face->next->prev = face->prev;
4385 c->faces_by_id[face->id] = NULL;
4386 if (face->id == c->used)
4387 --c->used;
4391 /* Look up a realized face with face attributes ATTR in the face cache
4392 of frame F. The face will be used to display ASCII characters.
4393 Value is the ID of the face found. If no suitable face is found,
4394 realize a new one. */
4396 static int
4397 lookup_face (struct frame *f, Lisp_Object *attr)
4399 struct face_cache *cache = FRAME_FACE_CACHE (f);
4400 unsigned hash;
4401 int i;
4402 struct face *face;
4404 eassert (cache != NULL);
4405 check_lface_attrs (attr);
4407 /* Look up ATTR in the face cache. */
4408 hash = lface_hash (attr);
4409 i = hash % FACE_CACHE_BUCKETS_SIZE;
4411 for (face = cache->buckets[i]; face; face = face->next)
4413 if (face->ascii_face != face)
4415 /* There's no more ASCII face. */
4416 face = NULL;
4417 break;
4419 if (face->hash == hash
4420 && lface_equal_p (face->lface, attr))
4421 break;
4424 /* If not found, realize a new face. */
4425 if (face == NULL)
4426 face = realize_face (cache, attr, -1);
4428 #ifdef GLYPH_DEBUG
4429 eassert (face == FACE_FROM_ID (f, face->id));
4430 #endif /* GLYPH_DEBUG */
4432 return face->id;
4435 #ifdef HAVE_WINDOW_SYSTEM
4436 /* Look up a realized face that has the same attributes as BASE_FACE
4437 except for the font in the face cache of frame F. If FONT-OBJECT
4438 is not nil, it is an already opened font. If FONT-OBJECT is nil,
4439 the face has no font. Value is the ID of the face found. If no
4440 suitable face is found, realize a new one. */
4443 face_for_font (struct frame *f, Lisp_Object font_object, struct face *base_face)
4445 struct face_cache *cache = FRAME_FACE_CACHE (f);
4446 unsigned hash;
4447 int i;
4448 struct face *face;
4450 eassert (cache != NULL);
4451 base_face = base_face->ascii_face;
4452 hash = lface_hash (base_face->lface);
4453 i = hash % FACE_CACHE_BUCKETS_SIZE;
4455 for (face = cache->buckets[i]; face; face = face->next)
4457 if (face->ascii_face == face)
4458 continue;
4459 if (face->ascii_face == base_face
4460 && face->font == (NILP (font_object) ? NULL
4461 : XFONT_OBJECT (font_object))
4462 && lface_equal_p (face->lface, base_face->lface))
4463 return face->id;
4466 /* If not found, realize a new face. */
4467 face = realize_non_ascii_face (f, font_object, base_face);
4468 return face->id;
4470 #endif /* HAVE_WINDOW_SYSTEM */
4472 /* Return the face id of the realized face for named face SYMBOL on
4473 frame F suitable for displaying ASCII characters. Value is -1 if
4474 the face couldn't be determined, which might happen if the default
4475 face isn't realized and cannot be realized. */
4478 lookup_named_face (struct frame *f, Lisp_Object symbol, int signal_p)
4480 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4481 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
4482 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
4484 if (default_face == NULL)
4486 if (!realize_basic_faces (f))
4487 return -1;
4488 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
4489 if (default_face == NULL)
4490 emacs_abort (); /* realize_basic_faces must have set it up */
4493 if (! get_lface_attributes (f, symbol, symbol_attrs, signal_p, 0))
4494 return -1;
4496 memcpy (attrs, default_face->lface, sizeof attrs);
4497 merge_face_vectors (f, symbol_attrs, attrs, 0);
4499 return lookup_face (f, attrs);
4503 /* Return the display face-id of the basic face whose canonical face-id
4504 is FACE_ID. The return value will usually simply be FACE_ID, unless that
4505 basic face has bee remapped via Vface_remapping_alist. This function is
4506 conservative: if something goes wrong, it will simply return FACE_ID
4507 rather than signal an error. */
4510 lookup_basic_face (struct frame *f, int face_id)
4512 Lisp_Object name, mapping;
4513 int remapped_face_id;
4515 if (NILP (Vface_remapping_alist))
4516 return face_id; /* Nothing to do. */
4518 switch (face_id)
4520 case DEFAULT_FACE_ID: name = Qdefault; break;
4521 case MODE_LINE_FACE_ID: name = Qmode_line; break;
4522 case MODE_LINE_INACTIVE_FACE_ID: name = Qmode_line_inactive; break;
4523 case HEADER_LINE_FACE_ID: name = Qheader_line; break;
4524 case TOOL_BAR_FACE_ID: name = Qtool_bar; break;
4525 case FRINGE_FACE_ID: name = Qfringe; break;
4526 case SCROLL_BAR_FACE_ID: name = Qscroll_bar; break;
4527 case BORDER_FACE_ID: name = Qborder; break;
4528 case CURSOR_FACE_ID: name = Qcursor; break;
4529 case MOUSE_FACE_ID: name = Qmouse; break;
4530 case MENU_FACE_ID: name = Qmenu; break;
4532 default:
4533 emacs_abort (); /* the caller is supposed to pass us a basic face id */
4536 /* Do a quick scan through Vface_remapping_alist, and return immediately
4537 if there is no remapping for face NAME. This is just an optimization
4538 for the very common no-remapping case. */
4539 mapping = assq_no_quit (name, Vface_remapping_alist);
4540 if (NILP (mapping))
4541 return face_id; /* Give up. */
4543 /* If there is a remapping entry, lookup the face using NAME, which will
4544 handle the remapping too. */
4545 remapped_face_id = lookup_named_face (f, name, 0);
4546 if (remapped_face_id < 0)
4547 return face_id; /* Give up. */
4549 return remapped_face_id;
4553 /* Return a face for charset ASCII that is like the face with id
4554 FACE_ID on frame F, but has a font that is STEPS steps smaller.
4555 STEPS < 0 means larger. Value is the id of the face. */
4558 smaller_face (struct frame *f, int face_id, int steps)
4560 #ifdef HAVE_WINDOW_SYSTEM
4561 struct face *face;
4562 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4563 int pt, last_pt, last_height;
4564 int delta;
4565 int new_face_id;
4566 struct face *new_face;
4568 /* If not called for an X frame, just return the original face. */
4569 if (FRAME_TERMCAP_P (f))
4570 return face_id;
4572 /* Try in increments of 1/2 pt. */
4573 delta = steps < 0 ? 5 : -5;
4574 steps = eabs (steps);
4576 face = FACE_FROM_ID (f, face_id);
4577 memcpy (attrs, face->lface, sizeof attrs);
4578 pt = last_pt = XFASTINT (attrs[LFACE_HEIGHT_INDEX]);
4579 new_face_id = face_id;
4580 last_height = FONT_HEIGHT (face->font);
4582 while (steps
4583 && pt + delta > 0
4584 /* Give up if we cannot find a font within 10pt. */
4585 && eabs (last_pt - pt) < 100)
4587 /* Look up a face for a slightly smaller/larger font. */
4588 pt += delta;
4589 attrs[LFACE_HEIGHT_INDEX] = make_number (pt);
4590 new_face_id = lookup_face (f, attrs);
4591 new_face = FACE_FROM_ID (f, new_face_id);
4593 /* If height changes, count that as one step. */
4594 if ((delta < 0 && FONT_HEIGHT (new_face->font) < last_height)
4595 || (delta > 0 && FONT_HEIGHT (new_face->font) > last_height))
4597 --steps;
4598 last_height = FONT_HEIGHT (new_face->font);
4599 last_pt = pt;
4603 return new_face_id;
4605 #else /* not HAVE_WINDOW_SYSTEM */
4607 return face_id;
4609 #endif /* not HAVE_WINDOW_SYSTEM */
4613 /* Return a face for charset ASCII that is like the face with id
4614 FACE_ID on frame F, but has height HEIGHT. */
4617 face_with_height (struct frame *f, int face_id, int height)
4619 #ifdef HAVE_WINDOW_SYSTEM
4620 struct face *face;
4621 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4623 if (FRAME_TERMCAP_P (f)
4624 || height <= 0)
4625 return face_id;
4627 face = FACE_FROM_ID (f, face_id);
4628 memcpy (attrs, face->lface, sizeof attrs);
4629 attrs[LFACE_HEIGHT_INDEX] = make_number (height);
4630 font_clear_prop (attrs, FONT_SIZE_INDEX);
4631 face_id = lookup_face (f, attrs);
4632 #endif /* HAVE_WINDOW_SYSTEM */
4634 return face_id;
4638 /* Return the face id of the realized face for named face SYMBOL on
4639 frame F suitable for displaying ASCII characters, and use
4640 attributes of the face FACE_ID for attributes that aren't
4641 completely specified by SYMBOL. This is like lookup_named_face,
4642 except that the default attributes come from FACE_ID, not from the
4643 default face. FACE_ID is assumed to be already realized. */
4646 lookup_derived_face (struct frame *f, Lisp_Object symbol, int face_id,
4647 int signal_p)
4649 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4650 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
4651 struct face *default_face = FACE_FROM_ID (f, face_id);
4653 if (!default_face)
4654 emacs_abort ();
4656 if (!get_lface_attributes (f, symbol, symbol_attrs, signal_p, 0))
4657 return -1;
4659 memcpy (attrs, default_face->lface, sizeof attrs);
4660 merge_face_vectors (f, symbol_attrs, attrs, 0);
4661 return lookup_face (f, attrs);
4664 DEFUN ("face-attributes-as-vector", Fface_attributes_as_vector,
4665 Sface_attributes_as_vector, 1, 1, 0,
4666 doc: /* Return a vector of face attributes corresponding to PLIST. */)
4667 (Lisp_Object plist)
4669 Lisp_Object lface;
4670 lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
4671 Qunspecified);
4672 merge_face_ref (XFRAME (selected_frame), plist, XVECTOR (lface)->contents,
4673 1, 0);
4674 return lface;
4679 /***********************************************************************
4680 Face capability testing
4681 ***********************************************************************/
4684 /* If the distance (as returned by color_distance) between two colors is
4685 less than this, then they are considered the same, for determining
4686 whether a color is supported or not. The range of values is 0-65535. */
4688 #define TTY_SAME_COLOR_THRESHOLD 10000
4690 #ifdef HAVE_WINDOW_SYSTEM
4692 /* Return non-zero if all the face attributes in ATTRS are supported
4693 on the window-system frame F.
4695 The definition of `supported' is somewhat heuristic, but basically means
4696 that a face containing all the attributes in ATTRS, when merged with the
4697 default face for display, can be represented in a way that's
4699 \(1) different in appearance than the default face, and
4700 \(2) `close in spirit' to what the attributes specify, if not exact. */
4702 static int
4703 x_supports_face_attributes_p (struct frame *f,
4704 Lisp_Object attrs[LFACE_VECTOR_SIZE],
4705 struct face *def_face)
4707 Lisp_Object *def_attrs = def_face->lface;
4709 /* Check that other specified attributes are different that the default
4710 face. */
4711 if ((!UNSPECIFIEDP (attrs[LFACE_UNDERLINE_INDEX])
4712 && face_attr_equal_p (attrs[LFACE_UNDERLINE_INDEX],
4713 def_attrs[LFACE_UNDERLINE_INDEX]))
4714 || (!UNSPECIFIEDP (attrs[LFACE_INVERSE_INDEX])
4715 && face_attr_equal_p (attrs[LFACE_INVERSE_INDEX],
4716 def_attrs[LFACE_INVERSE_INDEX]))
4717 || (!UNSPECIFIEDP (attrs[LFACE_FOREGROUND_INDEX])
4718 && face_attr_equal_p (attrs[LFACE_FOREGROUND_INDEX],
4719 def_attrs[LFACE_FOREGROUND_INDEX]))
4720 || (!UNSPECIFIEDP (attrs[LFACE_BACKGROUND_INDEX])
4721 && face_attr_equal_p (attrs[LFACE_BACKGROUND_INDEX],
4722 def_attrs[LFACE_BACKGROUND_INDEX]))
4723 || (!UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
4724 && face_attr_equal_p (attrs[LFACE_STIPPLE_INDEX],
4725 def_attrs[LFACE_STIPPLE_INDEX]))
4726 || (!UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
4727 && face_attr_equal_p (attrs[LFACE_OVERLINE_INDEX],
4728 def_attrs[LFACE_OVERLINE_INDEX]))
4729 || (!UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
4730 && face_attr_equal_p (attrs[LFACE_STRIKE_THROUGH_INDEX],
4731 def_attrs[LFACE_STRIKE_THROUGH_INDEX]))
4732 || (!UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
4733 && face_attr_equal_p (attrs[LFACE_BOX_INDEX],
4734 def_attrs[LFACE_BOX_INDEX])))
4735 return 0;
4737 /* Check font-related attributes, as those are the most commonly
4738 "unsupported" on a window-system (because of missing fonts). */
4739 if (!UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
4740 || !UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
4741 || !UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
4742 || !UNSPECIFIEDP (attrs[LFACE_WEIGHT_INDEX])
4743 || !UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX])
4744 || !UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX]))
4746 int face_id;
4747 struct face *face;
4748 Lisp_Object merged_attrs[LFACE_VECTOR_SIZE];
4749 int i;
4751 memcpy (merged_attrs, def_attrs, sizeof merged_attrs);
4753 merge_face_vectors (f, attrs, merged_attrs, 0);
4755 face_id = lookup_face (f, merged_attrs);
4756 face = FACE_FROM_ID (f, face_id);
4758 if (! face)
4759 error ("Cannot make face");
4761 /* If the font is the same, or no font is found, then not
4762 supported. */
4763 if (face->font == def_face->font
4764 || ! face->font)
4765 return 0;
4766 for (i = FONT_TYPE_INDEX; i <= FONT_SIZE_INDEX; i++)
4767 if (! EQ (face->font->props[i], def_face->font->props[i]))
4769 Lisp_Object s1, s2;
4771 if (i < FONT_FOUNDRY_INDEX || i > FONT_REGISTRY_INDEX
4772 || face->font->driver->case_sensitive)
4773 return 1;
4774 s1 = SYMBOL_NAME (face->font->props[i]);
4775 s2 = SYMBOL_NAME (def_face->font->props[i]);
4776 if (! EQ (Fcompare_strings (s1, make_number (0), Qnil,
4777 s2, make_number (0), Qnil, Qt), Qt))
4778 return 1;
4780 return 0;
4783 /* Everything checks out, this face is supported. */
4784 return 1;
4787 #endif /* HAVE_WINDOW_SYSTEM */
4789 /* Return non-zero if all the face attributes in ATTRS are supported
4790 on the tty frame F.
4792 The definition of `supported' is somewhat heuristic, but basically means
4793 that a face containing all the attributes in ATTRS, when merged
4794 with the default face for display, can be represented in a way that's
4796 \(1) different in appearance than the default face, and
4797 \(2) `close in spirit' to what the attributes specify, if not exact.
4799 Point (2) implies that a `:weight black' attribute will be satisfied
4800 by any terminal that can display bold, and a `:foreground "yellow"' as
4801 long as the terminal can display a yellowish color, but `:slant italic'
4802 will _not_ be satisfied by the tty display code's automatic
4803 substitution of a `dim' face for italic. */
4805 static int
4806 tty_supports_face_attributes_p (struct frame *f,
4807 Lisp_Object attrs[LFACE_VECTOR_SIZE],
4808 struct face *def_face)
4810 int weight, slant;
4811 Lisp_Object val, fg, bg;
4812 XColor fg_tty_color, fg_std_color;
4813 XColor bg_tty_color, bg_std_color;
4814 unsigned test_caps = 0;
4815 Lisp_Object *def_attrs = def_face->lface;
4817 /* First check some easy-to-check stuff; ttys support none of the
4818 following attributes, so we can just return false if any are requested
4819 (even if `nominal' values are specified, we should still return false,
4820 as that will be the same value that the default face uses). We
4821 consider :slant unsupportable on ttys, even though the face code
4822 actually `fakes' them using a dim attribute if possible. This is
4823 because the faked result is too different from what the face
4824 specifies. */
4825 if (!UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
4826 || !UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
4827 || !UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
4828 || !UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
4829 || !UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
4830 || !UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
4831 || !UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
4832 || !UNSPECIFIEDP (attrs[LFACE_BOX_INDEX]))
4833 return 0;
4835 /* Test for terminal `capabilities' (non-color character attributes). */
4837 /* font weight (bold/dim) */
4838 val = attrs[LFACE_WEIGHT_INDEX];
4839 if (!UNSPECIFIEDP (val)
4840 && (weight = FONT_WEIGHT_NAME_NUMERIC (val), weight >= 0))
4842 int def_weight = FONT_WEIGHT_NAME_NUMERIC (def_attrs[LFACE_WEIGHT_INDEX]);
4844 if (weight > 100)
4846 if (def_weight > 100)
4847 return 0; /* same as default */
4848 test_caps = TTY_CAP_BOLD;
4850 else if (weight < 100)
4852 if (def_weight < 100)
4853 return 0; /* same as default */
4854 test_caps = TTY_CAP_DIM;
4856 else if (def_weight == 100)
4857 return 0; /* same as default */
4860 /* font slant */
4861 val = attrs[LFACE_SLANT_INDEX];
4862 if (!UNSPECIFIEDP (val)
4863 && (slant = FONT_SLANT_NAME_NUMERIC (val), slant >= 0))
4865 int def_slant = FONT_SLANT_NAME_NUMERIC (def_attrs[LFACE_SLANT_INDEX]);
4866 if (slant == 100 || slant == def_slant)
4867 return 0; /* same as default */
4868 else
4869 test_caps |= TTY_CAP_ITALIC;
4872 /* underlining */
4873 val = attrs[LFACE_UNDERLINE_INDEX];
4874 if (!UNSPECIFIEDP (val))
4876 if (STRINGP (val))
4877 return 0; /* ttys can't use colored underlines */
4878 else if (EQ (CAR_SAFE (val), QCstyle) && EQ (CAR_SAFE (CDR_SAFE (val)), Qwave))
4879 return 0; /* ttys can't use wave underlines */
4880 else if (face_attr_equal_p (val, def_attrs[LFACE_UNDERLINE_INDEX]))
4881 return 0; /* same as default */
4882 else
4883 test_caps |= TTY_CAP_UNDERLINE;
4886 /* inverse video */
4887 val = attrs[LFACE_INVERSE_INDEX];
4888 if (!UNSPECIFIEDP (val))
4890 if (face_attr_equal_p (val, def_attrs[LFACE_INVERSE_INDEX]))
4891 return 0; /* same as default */
4892 else
4893 test_caps |= TTY_CAP_INVERSE;
4897 /* Color testing. */
4899 /* Default the color indices in FG_TTY_COLOR and BG_TTY_COLOR, since
4900 we use them when calling `tty_capable_p' below, even if the face
4901 specifies no colors. */
4902 fg_tty_color.pixel = FACE_TTY_DEFAULT_FG_COLOR;
4903 bg_tty_color.pixel = FACE_TTY_DEFAULT_BG_COLOR;
4905 /* Check if foreground color is close enough. */
4906 fg = attrs[LFACE_FOREGROUND_INDEX];
4907 if (STRINGP (fg))
4909 Lisp_Object def_fg = def_attrs[LFACE_FOREGROUND_INDEX];
4911 if (face_attr_equal_p (fg, def_fg))
4912 return 0; /* same as default */
4913 else if (! tty_lookup_color (f, fg, &fg_tty_color, &fg_std_color))
4914 return 0; /* not a valid color */
4915 else if (color_distance (&fg_tty_color, &fg_std_color)
4916 > TTY_SAME_COLOR_THRESHOLD)
4917 return 0; /* displayed color is too different */
4918 else
4919 /* Make sure the color is really different than the default. */
4921 XColor def_fg_color;
4922 if (tty_lookup_color (f, def_fg, &def_fg_color, 0)
4923 && (color_distance (&fg_tty_color, &def_fg_color)
4924 <= TTY_SAME_COLOR_THRESHOLD))
4925 return 0;
4929 /* Check if background color is close enough. */
4930 bg = attrs[LFACE_BACKGROUND_INDEX];
4931 if (STRINGP (bg))
4933 Lisp_Object def_bg = def_attrs[LFACE_BACKGROUND_INDEX];
4935 if (face_attr_equal_p (bg, def_bg))
4936 return 0; /* same as default */
4937 else if (! tty_lookup_color (f, bg, &bg_tty_color, &bg_std_color))
4938 return 0; /* not a valid color */
4939 else if (color_distance (&bg_tty_color, &bg_std_color)
4940 > TTY_SAME_COLOR_THRESHOLD)
4941 return 0; /* displayed color is too different */
4942 else
4943 /* Make sure the color is really different than the default. */
4945 XColor def_bg_color;
4946 if (tty_lookup_color (f, def_bg, &def_bg_color, 0)
4947 && (color_distance (&bg_tty_color, &def_bg_color)
4948 <= TTY_SAME_COLOR_THRESHOLD))
4949 return 0;
4953 /* If both foreground and background are requested, see if the
4954 distance between them is OK. We just check to see if the distance
4955 between the tty's foreground and background is close enough to the
4956 distance between the standard foreground and background. */
4957 if (STRINGP (fg) && STRINGP (bg))
4959 int delta_delta
4960 = (color_distance (&fg_std_color, &bg_std_color)
4961 - color_distance (&fg_tty_color, &bg_tty_color));
4962 if (delta_delta > TTY_SAME_COLOR_THRESHOLD
4963 || delta_delta < -TTY_SAME_COLOR_THRESHOLD)
4964 return 0;
4968 /* See if the capabilities we selected above are supported, with the
4969 given colors. */
4970 if (test_caps != 0 &&
4971 ! tty_capable_p (FRAME_TTY (f), test_caps, fg_tty_color.pixel,
4972 bg_tty_color.pixel))
4973 return 0;
4976 /* Hmmm, everything checks out, this terminal must support this face. */
4977 return 1;
4981 DEFUN ("display-supports-face-attributes-p",
4982 Fdisplay_supports_face_attributes_p, Sdisplay_supports_face_attributes_p,
4983 1, 2, 0,
4984 doc: /* Return non-nil if all the face attributes in ATTRIBUTES are supported.
4985 The optional argument DISPLAY can be a display name, a frame, or
4986 nil (meaning the selected frame's display).
4988 The definition of `supported' is somewhat heuristic, but basically means
4989 that a face containing all the attributes in ATTRIBUTES, when merged
4990 with the default face for display, can be represented in a way that's
4992 \(1) different in appearance than the default face, and
4993 \(2) `close in spirit' to what the attributes specify, if not exact.
4995 Point (2) implies that a `:weight black' attribute will be satisfied by
4996 any display that can display bold, and a `:foreground \"yellow\"' as long
4997 as it can display a yellowish color, but `:slant italic' will _not_ be
4998 satisfied by the tty display code's automatic substitution of a `dim'
4999 face for italic. */)
5000 (Lisp_Object attributes, Lisp_Object display)
5002 int supports = 0, i;
5003 Lisp_Object frame;
5004 struct frame *f;
5005 struct face *def_face;
5006 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5008 if (noninteractive || !initialized)
5009 /* We may not be able to access low-level face information in batch
5010 mode, or before being dumped, and this function is not going to
5011 be very useful in those cases anyway, so just give up. */
5012 return Qnil;
5014 if (NILP (display))
5015 frame = selected_frame;
5016 else if (FRAMEP (display))
5017 frame = display;
5018 else
5020 /* Find any frame on DISPLAY. */
5021 Lisp_Object tail;
5023 frame = Qnil;
5024 FOR_EACH_FRAME (tail, frame)
5025 if (!NILP (Fequal (Fcdr (Fassq (Qdisplay,
5026 XFRAME (frame)->param_alist)),
5027 display)))
5028 break;
5031 CHECK_LIVE_FRAME (frame);
5032 f = XFRAME (frame);
5034 for (i = 0; i < LFACE_VECTOR_SIZE; i++)
5035 attrs[i] = Qunspecified;
5036 merge_face_ref (f, attributes, attrs, 1, 0);
5038 def_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5039 if (def_face == NULL)
5041 if (! realize_basic_faces (f))
5042 error ("Cannot realize default face");
5043 def_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5044 if (def_face == NULL)
5045 emacs_abort (); /* realize_basic_faces must have set it up */
5048 /* Dispatch to the appropriate handler. */
5049 if (FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5050 supports = tty_supports_face_attributes_p (f, attrs, def_face);
5051 #ifdef HAVE_WINDOW_SYSTEM
5052 else
5053 supports = x_supports_face_attributes_p (f, attrs, def_face);
5054 #endif
5056 return supports ? Qt : Qnil;
5060 /***********************************************************************
5061 Font selection
5062 ***********************************************************************/
5064 DEFUN ("internal-set-font-selection-order",
5065 Finternal_set_font_selection_order,
5066 Sinternal_set_font_selection_order, 1, 1, 0,
5067 doc: /* Set font selection order for face font selection to ORDER.
5068 ORDER must be a list of length 4 containing the symbols `:width',
5069 `:height', `:weight', and `:slant'. Face attributes appearing
5070 first in ORDER are matched first, e.g. if `:height' appears before
5071 `:weight' in ORDER, font selection first tries to find a font with
5072 a suitable height, and then tries to match the font weight.
5073 Value is ORDER. */)
5074 (Lisp_Object order)
5076 Lisp_Object list;
5077 int i;
5078 int indices[DIM (font_sort_order)];
5080 CHECK_LIST (order);
5081 memset (indices, 0, sizeof indices);
5082 i = 0;
5084 for (list = order;
5085 CONSP (list) && i < DIM (indices);
5086 list = XCDR (list), ++i)
5088 Lisp_Object attr = XCAR (list);
5089 int xlfd;
5091 if (EQ (attr, QCwidth))
5092 xlfd = XLFD_SWIDTH;
5093 else if (EQ (attr, QCheight))
5094 xlfd = XLFD_POINT_SIZE;
5095 else if (EQ (attr, QCweight))
5096 xlfd = XLFD_WEIGHT;
5097 else if (EQ (attr, QCslant))
5098 xlfd = XLFD_SLANT;
5099 else
5100 break;
5102 if (indices[i] != 0)
5103 break;
5104 indices[i] = xlfd;
5107 if (!NILP (list) || i != DIM (indices))
5108 signal_error ("Invalid font sort order", order);
5109 for (i = 0; i < DIM (font_sort_order); ++i)
5110 if (indices[i] == 0)
5111 signal_error ("Invalid font sort order", order);
5113 if (memcmp (indices, font_sort_order, sizeof indices) != 0)
5115 memcpy (font_sort_order, indices, sizeof font_sort_order);
5116 free_all_realized_faces (Qnil);
5119 font_update_sort_order (font_sort_order);
5121 return Qnil;
5125 DEFUN ("internal-set-alternative-font-family-alist",
5126 Finternal_set_alternative_font_family_alist,
5127 Sinternal_set_alternative_font_family_alist, 1, 1, 0,
5128 doc: /* Define alternative font families to try in face font selection.
5129 ALIST is an alist of (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...) entries.
5130 Each ALTERNATIVE is tried in order if no fonts of font family FAMILY can
5131 be found. Value is ALIST. */)
5132 (Lisp_Object alist)
5134 Lisp_Object entry, tail, tail2;
5136 CHECK_LIST (alist);
5137 alist = Fcopy_sequence (alist);
5138 for (tail = alist; CONSP (tail); tail = XCDR (tail))
5140 entry = XCAR (tail);
5141 CHECK_LIST (entry);
5142 entry = Fcopy_sequence (entry);
5143 XSETCAR (tail, entry);
5144 for (tail2 = entry; CONSP (tail2); tail2 = XCDR (tail2))
5145 XSETCAR (tail2, Fintern (XCAR (tail2), Qnil));
5148 Vface_alternative_font_family_alist = alist;
5149 free_all_realized_faces (Qnil);
5150 return alist;
5154 DEFUN ("internal-set-alternative-font-registry-alist",
5155 Finternal_set_alternative_font_registry_alist,
5156 Sinternal_set_alternative_font_registry_alist, 1, 1, 0,
5157 doc: /* Define alternative font registries to try in face font selection.
5158 ALIST is an alist of (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...) entries.
5159 Each ALTERNATIVE is tried in order if no fonts of font registry REGISTRY can
5160 be found. Value is ALIST. */)
5161 (Lisp_Object alist)
5163 Lisp_Object entry, tail, tail2;
5165 CHECK_LIST (alist);
5166 alist = Fcopy_sequence (alist);
5167 for (tail = alist; CONSP (tail); tail = XCDR (tail))
5169 entry = XCAR (tail);
5170 CHECK_LIST (entry);
5171 entry = Fcopy_sequence (entry);
5172 XSETCAR (tail, entry);
5173 for (tail2 = entry; CONSP (tail2); tail2 = XCDR (tail2))
5174 XSETCAR (tail2, Fdowncase (XCAR (tail2)));
5176 Vface_alternative_font_registry_alist = alist;
5177 free_all_realized_faces (Qnil);
5178 return alist;
5182 #ifdef HAVE_WINDOW_SYSTEM
5184 /* Return the fontset id of the base fontset name or alias name given
5185 by the fontset attribute of ATTRS. Value is -1 if the fontset
5186 attribute of ATTRS doesn't name a fontset. */
5188 static int
5189 face_fontset (Lisp_Object attrs[LFACE_VECTOR_SIZE])
5191 Lisp_Object name;
5193 name = attrs[LFACE_FONTSET_INDEX];
5194 if (!STRINGP (name))
5195 return -1;
5196 return fs_query_fontset (name, 0);
5199 #endif /* HAVE_WINDOW_SYSTEM */
5203 /***********************************************************************
5204 Face Realization
5205 ***********************************************************************/
5207 /* Realize basic faces on frame F. Value is zero if frame parameters
5208 of F don't contain enough information needed to realize the default
5209 face. */
5211 static int
5212 realize_basic_faces (struct frame *f)
5214 int success_p = 0;
5215 ptrdiff_t count = SPECPDL_INDEX ();
5217 /* Block input here so that we won't be surprised by an X expose
5218 event, for instance, without having the faces set up. */
5219 block_input ();
5220 specbind (Qscalable_fonts_allowed, Qt);
5222 if (realize_default_face (f))
5224 realize_named_face (f, Qmode_line, MODE_LINE_FACE_ID);
5225 realize_named_face (f, Qmode_line_inactive, MODE_LINE_INACTIVE_FACE_ID);
5226 realize_named_face (f, Qtool_bar, TOOL_BAR_FACE_ID);
5227 realize_named_face (f, Qfringe, FRINGE_FACE_ID);
5228 realize_named_face (f, Qheader_line, HEADER_LINE_FACE_ID);
5229 realize_named_face (f, Qscroll_bar, SCROLL_BAR_FACE_ID);
5230 realize_named_face (f, Qborder, BORDER_FACE_ID);
5231 realize_named_face (f, Qcursor, CURSOR_FACE_ID);
5232 realize_named_face (f, Qmouse, MOUSE_FACE_ID);
5233 realize_named_face (f, Qmenu, MENU_FACE_ID);
5234 realize_named_face (f, Qvertical_border, VERTICAL_BORDER_FACE_ID);
5236 /* Reflect changes in the `menu' face in menu bars. */
5237 if (FRAME_FACE_CACHE (f)->menu_face_changed_p)
5239 FRAME_FACE_CACHE (f)->menu_face_changed_p = 0;
5240 #ifdef USE_X_TOOLKIT
5241 if (FRAME_WINDOW_P (f))
5242 x_update_menu_appearance (f);
5243 #endif
5246 success_p = 1;
5249 unbind_to (count, Qnil);
5250 unblock_input ();
5251 return success_p;
5255 /* Realize the default face on frame F. If the face is not fully
5256 specified, make it fully-specified. Attributes of the default face
5257 that are not explicitly specified are taken from frame parameters. */
5259 static int
5260 realize_default_face (struct frame *f)
5262 struct face_cache *c = FRAME_FACE_CACHE (f);
5263 Lisp_Object lface;
5264 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5265 struct face *face;
5267 /* If the `default' face is not yet known, create it. */
5268 lface = lface_from_face_name (f, Qdefault, 0);
5269 if (NILP (lface))
5271 Lisp_Object frame;
5272 XSETFRAME (frame, f);
5273 lface = Finternal_make_lisp_face (Qdefault, frame);
5276 #ifdef HAVE_WINDOW_SYSTEM
5277 if (FRAME_WINDOW_P (f))
5279 Lisp_Object font_object;
5281 XSETFONT (font_object, FRAME_FONT (f));
5282 set_lface_from_font (f, lface, font_object, f->default_face_done_p);
5283 ASET (lface, LFACE_FONTSET_INDEX, fontset_name (FRAME_FONTSET (f)));
5284 f->default_face_done_p = 1;
5286 #endif /* HAVE_WINDOW_SYSTEM */
5288 if (!FRAME_WINDOW_P (f))
5290 ASET (lface, LFACE_FAMILY_INDEX, build_string ("default"));
5291 ASET (lface, LFACE_FOUNDRY_INDEX, LFACE_FAMILY (lface));
5292 ASET (lface, LFACE_SWIDTH_INDEX, Qnormal);
5293 ASET (lface, LFACE_HEIGHT_INDEX, make_number (1));
5294 if (UNSPECIFIEDP (LFACE_WEIGHT (lface)))
5295 ASET (lface, LFACE_WEIGHT_INDEX, Qnormal);
5296 if (UNSPECIFIEDP (LFACE_SLANT (lface)))
5297 ASET (lface, LFACE_SLANT_INDEX, Qnormal);
5298 if (UNSPECIFIEDP (LFACE_FONTSET (lface)))
5299 ASET (lface, LFACE_FONTSET_INDEX, Qnil);
5302 if (UNSPECIFIEDP (LFACE_UNDERLINE (lface)))
5303 ASET (lface, LFACE_UNDERLINE_INDEX, Qnil);
5305 if (UNSPECIFIEDP (LFACE_OVERLINE (lface)))
5306 ASET (lface, LFACE_OVERLINE_INDEX, Qnil);
5308 if (UNSPECIFIEDP (LFACE_STRIKE_THROUGH (lface)))
5309 ASET (lface, LFACE_STRIKE_THROUGH_INDEX, Qnil);
5311 if (UNSPECIFIEDP (LFACE_BOX (lface)))
5312 ASET (lface, LFACE_BOX_INDEX, Qnil);
5314 if (UNSPECIFIEDP (LFACE_INVERSE (lface)))
5315 ASET (lface, LFACE_INVERSE_INDEX, Qnil);
5317 if (UNSPECIFIEDP (LFACE_FOREGROUND (lface)))
5319 /* This function is called so early that colors are not yet
5320 set in the frame parameter list. */
5321 Lisp_Object color = Fassq (Qforeground_color, f->param_alist);
5323 if (CONSP (color) && STRINGP (XCDR (color)))
5324 ASET (lface, LFACE_FOREGROUND_INDEX, XCDR (color));
5325 else if (FRAME_WINDOW_P (f))
5326 return 0;
5327 else if (FRAME_INITIAL_P (f) || FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5328 ASET (lface, LFACE_FOREGROUND_INDEX, build_string (unspecified_fg));
5329 else
5330 emacs_abort ();
5333 if (UNSPECIFIEDP (LFACE_BACKGROUND (lface)))
5335 /* This function is called so early that colors are not yet
5336 set in the frame parameter list. */
5337 Lisp_Object color = Fassq (Qbackground_color, f->param_alist);
5338 if (CONSP (color) && STRINGP (XCDR (color)))
5339 ASET (lface, LFACE_BACKGROUND_INDEX, XCDR (color));
5340 else if (FRAME_WINDOW_P (f))
5341 return 0;
5342 else if (FRAME_INITIAL_P (f) || FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5343 ASET (lface, LFACE_BACKGROUND_INDEX, build_string (unspecified_bg));
5344 else
5345 emacs_abort ();
5348 if (UNSPECIFIEDP (LFACE_STIPPLE (lface)))
5349 ASET (lface, LFACE_STIPPLE_INDEX, Qnil);
5351 /* Realize the face; it must be fully-specified now. */
5352 eassert (lface_fully_specified_p (XVECTOR (lface)->contents));
5353 check_lface (lface);
5354 memcpy (attrs, XVECTOR (lface)->contents, sizeof attrs);
5355 face = realize_face (c, attrs, DEFAULT_FACE_ID);
5357 #ifdef HAVE_WINDOW_SYSTEM
5358 #ifdef HAVE_X_WINDOWS
5359 if (FRAME_X_P (f) && face->font != FRAME_FONT (f))
5361 /* This can happen when making a frame on a display that does
5362 not support the default font. */
5363 if (!face->font)
5364 return 0;
5366 /* Otherwise, the font specified for the frame was not
5367 acceptable as a font for the default face (perhaps because
5368 auto-scaled fonts are rejected), so we must adjust the frame
5369 font. */
5370 x_set_font (f, LFACE_FONT (lface), Qnil);
5372 #endif /* HAVE_X_WINDOWS */
5373 #endif /* HAVE_WINDOW_SYSTEM */
5374 return 1;
5378 /* Realize basic faces other than the default face in face cache C.
5379 SYMBOL is the face name, ID is the face id the realized face must
5380 have. The default face must have been realized already. */
5382 static void
5383 realize_named_face (struct frame *f, Lisp_Object symbol, int id)
5385 struct face_cache *c = FRAME_FACE_CACHE (f);
5386 Lisp_Object lface = lface_from_face_name (f, symbol, 0);
5387 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5388 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
5390 /* The default face must exist and be fully specified. */
5391 get_lface_attributes_no_remap (f, Qdefault, attrs, 1);
5392 check_lface_attrs (attrs);
5393 eassert (lface_fully_specified_p (attrs));
5395 /* If SYMBOL isn't know as a face, create it. */
5396 if (NILP (lface))
5398 Lisp_Object frame;
5399 XSETFRAME (frame, f);
5400 lface = Finternal_make_lisp_face (symbol, frame);
5403 /* Merge SYMBOL's face with the default face. */
5404 get_lface_attributes_no_remap (f, symbol, symbol_attrs, 1);
5405 merge_face_vectors (f, symbol_attrs, attrs, 0);
5407 /* Realize the face. */
5408 realize_face (c, attrs, id);
5412 /* Realize the fully-specified face with attributes ATTRS in face
5413 cache CACHE for ASCII characters. If FORMER_FACE_ID is
5414 non-negative, it is an ID of face to remove before caching the new
5415 face. Value is a pointer to the newly created realized face. */
5417 static struct face *
5418 realize_face (struct face_cache *cache, Lisp_Object attrs[LFACE_VECTOR_SIZE],
5419 int former_face_id)
5421 struct face *face;
5423 /* LFACE must be fully specified. */
5424 eassert (cache != NULL);
5425 check_lface_attrs (attrs);
5427 if (former_face_id >= 0 && cache->used > former_face_id)
5429 /* Remove the former face. */
5430 struct face *former_face = cache->faces_by_id[former_face_id];
5431 uncache_face (cache, former_face);
5432 free_realized_face (cache->f, former_face);
5433 SET_FRAME_GARBAGED (cache->f);
5436 if (FRAME_WINDOW_P (cache->f))
5437 face = realize_x_face (cache, attrs);
5438 else if (FRAME_TERMCAP_P (cache->f) || FRAME_MSDOS_P (cache->f))
5439 face = realize_tty_face (cache, attrs);
5440 else if (FRAME_INITIAL_P (cache->f))
5442 /* Create a dummy face. */
5443 face = make_realized_face (attrs);
5445 else
5446 emacs_abort ();
5448 /* Insert the new face. */
5449 cache_face (cache, face, lface_hash (attrs));
5450 return face;
5454 #ifdef HAVE_WINDOW_SYSTEM
5455 /* Realize the fully-specified face that uses FONT-OBJECT and has the
5456 same attributes as BASE_FACE except for the font on frame F.
5457 FONT-OBJECT may be nil, in which case, realized a face of
5458 no-font. */
5460 static struct face *
5461 realize_non_ascii_face (struct frame *f, Lisp_Object font_object,
5462 struct face *base_face)
5464 struct face_cache *cache = FRAME_FACE_CACHE (f);
5465 struct face *face;
5467 face = xmalloc (sizeof *face);
5468 *face = *base_face;
5469 face->gc = 0;
5470 face->extra = NULL;
5471 face->overstrike
5472 = (! NILP (font_object)
5473 && FONT_WEIGHT_NAME_NUMERIC (face->lface[LFACE_WEIGHT_INDEX]) > 100
5474 && FONT_WEIGHT_NUMERIC (font_object) <= 100);
5476 /* Don't try to free the colors copied bitwise from BASE_FACE. */
5477 face->colors_copied_bitwise_p = 1;
5478 face->font = NILP (font_object) ? NULL : XFONT_OBJECT (font_object);
5479 face->gc = 0;
5481 cache_face (cache, face, face->hash);
5483 return face;
5485 #endif /* HAVE_WINDOW_SYSTEM */
5488 /* Realize the fully-specified face with attributes ATTRS in face
5489 cache CACHE for ASCII characters. Do it for X frame CACHE->f. If
5490 the new face doesn't share font with the default face, a fontname
5491 is allocated from the heap and set in `font_name' of the new face,
5492 but it is not yet loaded here. Value is a pointer to the newly
5493 created realized face. */
5495 static struct face *
5496 realize_x_face (struct face_cache *cache, Lisp_Object attrs[LFACE_VECTOR_SIZE])
5498 struct face *face = NULL;
5499 #ifdef HAVE_WINDOW_SYSTEM
5500 struct face *default_face;
5501 struct frame *f;
5502 Lisp_Object stipple, underline, overline, strike_through, box;
5504 eassert (FRAME_WINDOW_P (cache->f));
5506 /* Allocate a new realized face. */
5507 face = make_realized_face (attrs);
5508 face->ascii_face = face;
5510 f = cache->f;
5512 /* Determine the font to use. Most of the time, the font will be
5513 the same as the font of the default face, so try that first. */
5514 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5515 if (default_face
5516 && lface_same_font_attributes_p (default_face->lface, attrs))
5518 face->font = default_face->font;
5519 face->fontset
5520 = make_fontset_for_ascii_face (f, default_face->fontset, face);
5522 else
5524 /* If the face attribute ATTRS specifies a fontset, use it as
5525 the base of a new realized fontset. Otherwise, use the same
5526 base fontset as of the default face. The base determines
5527 registry and encoding of a font. It may also determine
5528 foundry and family. The other fields of font name pattern
5529 are constructed from ATTRS. */
5530 int fontset = face_fontset (attrs);
5532 /* If we are realizing the default face, ATTRS should specify a
5533 fontset. In other words, if FONTSET is -1, we are not
5534 realizing the default face, thus the default face should have
5535 already been realized. */
5536 if (fontset == -1)
5538 if (default_face)
5539 fontset = default_face->fontset;
5540 if (fontset == -1)
5541 emacs_abort ();
5543 if (! FONT_OBJECT_P (attrs[LFACE_FONT_INDEX]))
5544 attrs[LFACE_FONT_INDEX]
5545 = font_load_for_lface (f, attrs, attrs[LFACE_FONT_INDEX]);
5546 if (FONT_OBJECT_P (attrs[LFACE_FONT_INDEX]))
5548 face->font = XFONT_OBJECT (attrs[LFACE_FONT_INDEX]);
5549 face->fontset = make_fontset_for_ascii_face (f, fontset, face);
5551 else
5553 face->font = NULL;
5554 face->fontset = -1;
5558 if (face->font
5559 && FONT_WEIGHT_NAME_NUMERIC (attrs[LFACE_WEIGHT_INDEX]) > 100
5560 && FONT_WEIGHT_NUMERIC (attrs[LFACE_FONT_INDEX]) <= 100)
5561 face->overstrike = 1;
5563 /* Load colors, and set remaining attributes. */
5565 load_face_colors (f, face, attrs);
5567 /* Set up box. */
5568 box = attrs[LFACE_BOX_INDEX];
5569 if (STRINGP (box))
5571 /* A simple box of line width 1 drawn in color given by
5572 the string. */
5573 face->box_color = load_color (f, face, attrs[LFACE_BOX_INDEX],
5574 LFACE_BOX_INDEX);
5575 face->box = FACE_SIMPLE_BOX;
5576 face->box_line_width = 1;
5578 else if (INTEGERP (box))
5580 /* Simple box of specified line width in foreground color of the
5581 face. */
5582 eassert (XINT (box) != 0);
5583 face->box = FACE_SIMPLE_BOX;
5584 face->box_line_width = XINT (box);
5585 face->box_color = face->foreground;
5586 face->box_color_defaulted_p = 1;
5588 else if (CONSP (box))
5590 /* `(:width WIDTH :color COLOR :shadow SHADOW)'. SHADOW
5591 being one of `raised' or `sunken'. */
5592 face->box = FACE_SIMPLE_BOX;
5593 face->box_color = face->foreground;
5594 face->box_color_defaulted_p = 1;
5595 face->box_line_width = 1;
5597 while (CONSP (box))
5599 Lisp_Object keyword, value;
5601 keyword = XCAR (box);
5602 box = XCDR (box);
5604 if (!CONSP (box))
5605 break;
5606 value = XCAR (box);
5607 box = XCDR (box);
5609 if (EQ (keyword, QCline_width))
5611 if (INTEGERP (value) && XINT (value) != 0)
5612 face->box_line_width = XINT (value);
5614 else if (EQ (keyword, QCcolor))
5616 if (STRINGP (value))
5618 face->box_color = load_color (f, face, value,
5619 LFACE_BOX_INDEX);
5620 face->use_box_color_for_shadows_p = 1;
5623 else if (EQ (keyword, QCstyle))
5625 if (EQ (value, Qreleased_button))
5626 face->box = FACE_RAISED_BOX;
5627 else if (EQ (value, Qpressed_button))
5628 face->box = FACE_SUNKEN_BOX;
5633 /* Text underline, overline, strike-through. */
5635 underline = attrs[LFACE_UNDERLINE_INDEX];
5636 if (EQ (underline, Qt))
5638 /* Use default color (same as foreground color). */
5639 face->underline_p = 1;
5640 face->underline_type = FACE_UNDER_LINE;
5641 face->underline_defaulted_p = 1;
5642 face->underline_color = 0;
5644 else if (STRINGP (underline))
5646 /* Use specified color. */
5647 face->underline_p = 1;
5648 face->underline_type = FACE_UNDER_LINE;
5649 face->underline_defaulted_p = 0;
5650 face->underline_color
5651 = load_color (f, face, underline,
5652 LFACE_UNDERLINE_INDEX);
5654 else if (NILP (underline))
5656 face->underline_p = 0;
5657 face->underline_defaulted_p = 0;
5658 face->underline_color = 0;
5660 else if (CONSP (underline))
5662 /* `(:color COLOR :style STYLE)'.
5663 STYLE being one of `line' or `wave'. */
5664 face->underline_p = 1;
5665 face->underline_color = 0;
5666 face->underline_defaulted_p = 1;
5667 face->underline_type = FACE_UNDER_LINE;
5669 /* FIXME? This is also not robust about checking the precise form.
5670 See comments in Finternal_set_lisp_face_attribute. */
5671 while (CONSP (underline))
5673 Lisp_Object keyword, value;
5675 keyword = XCAR (underline);
5676 underline = XCDR (underline);
5678 if (!CONSP (underline))
5679 break;
5680 value = XCAR (underline);
5681 underline = XCDR (underline);
5683 if (EQ (keyword, QCcolor))
5685 if (EQ (value, Qforeground_color))
5687 face->underline_defaulted_p = 1;
5688 face->underline_color = 0;
5690 else if (STRINGP (value))
5692 face->underline_defaulted_p = 0;
5693 face->underline_color = load_color (f, face, value,
5694 LFACE_UNDERLINE_INDEX);
5697 else if (EQ (keyword, QCstyle))
5699 if (EQ (value, Qline))
5700 face->underline_type = FACE_UNDER_LINE;
5701 else if (EQ (value, Qwave))
5702 face->underline_type = FACE_UNDER_WAVE;
5707 overline = attrs[LFACE_OVERLINE_INDEX];
5708 if (STRINGP (overline))
5710 face->overline_color
5711 = load_color (f, face, attrs[LFACE_OVERLINE_INDEX],
5712 LFACE_OVERLINE_INDEX);
5713 face->overline_p = 1;
5715 else if (EQ (overline, Qt))
5717 face->overline_color = face->foreground;
5718 face->overline_color_defaulted_p = 1;
5719 face->overline_p = 1;
5722 strike_through = attrs[LFACE_STRIKE_THROUGH_INDEX];
5723 if (STRINGP (strike_through))
5725 face->strike_through_color
5726 = load_color (f, face, attrs[LFACE_STRIKE_THROUGH_INDEX],
5727 LFACE_STRIKE_THROUGH_INDEX);
5728 face->strike_through_p = 1;
5730 else if (EQ (strike_through, Qt))
5732 face->strike_through_color = face->foreground;
5733 face->strike_through_color_defaulted_p = 1;
5734 face->strike_through_p = 1;
5737 stipple = attrs[LFACE_STIPPLE_INDEX];
5738 if (!NILP (stipple))
5739 face->stipple = load_pixmap (f, stipple, &face->pixmap_w, &face->pixmap_h);
5740 #endif /* HAVE_WINDOW_SYSTEM */
5742 return face;
5746 /* Map a specified color of face FACE on frame F to a tty color index.
5747 IDX is either LFACE_FOREGROUND_INDEX or LFACE_BACKGROUND_INDEX, and
5748 specifies which color to map. Set *DEFAULTED to 1 if mapping to the
5749 default foreground/background colors. */
5751 static void
5752 map_tty_color (struct frame *f, struct face *face,
5753 enum lface_attribute_index idx, int *defaulted)
5755 Lisp_Object frame, color, def;
5756 int foreground_p = idx == LFACE_FOREGROUND_INDEX;
5757 unsigned long default_pixel =
5758 foreground_p ? FACE_TTY_DEFAULT_FG_COLOR : FACE_TTY_DEFAULT_BG_COLOR;
5759 unsigned long pixel = default_pixel;
5760 #ifdef MSDOS
5761 unsigned long default_other_pixel =
5762 foreground_p ? FACE_TTY_DEFAULT_BG_COLOR : FACE_TTY_DEFAULT_FG_COLOR;
5763 #endif
5765 eassert (idx == LFACE_FOREGROUND_INDEX || idx == LFACE_BACKGROUND_INDEX);
5767 XSETFRAME (frame, f);
5768 color = face->lface[idx];
5770 if (STRINGP (color)
5771 && SCHARS (color)
5772 && CONSP (Vtty_defined_color_alist)
5773 && (def = assq_no_quit (color, call1 (Qtty_color_alist, frame)),
5774 CONSP (def)))
5776 /* Associations in tty-defined-color-alist are of the form
5777 (NAME INDEX R G B). We need the INDEX part. */
5778 pixel = XINT (XCAR (XCDR (def)));
5781 if (pixel == default_pixel && STRINGP (color))
5783 pixel = load_color (f, face, color, idx);
5785 #ifdef MSDOS
5786 /* If the foreground of the default face is the default color,
5787 use the foreground color defined by the frame. */
5788 if (FRAME_MSDOS_P (f))
5790 if (pixel == default_pixel
5791 || pixel == FACE_TTY_DEFAULT_COLOR)
5793 if (foreground_p)
5794 pixel = FRAME_FOREGROUND_PIXEL (f);
5795 else
5796 pixel = FRAME_BACKGROUND_PIXEL (f);
5797 face->lface[idx] = tty_color_name (f, pixel);
5798 *defaulted = 1;
5800 else if (pixel == default_other_pixel)
5802 if (foreground_p)
5803 pixel = FRAME_BACKGROUND_PIXEL (f);
5804 else
5805 pixel = FRAME_FOREGROUND_PIXEL (f);
5806 face->lface[idx] = tty_color_name (f, pixel);
5807 *defaulted = 1;
5810 #endif /* MSDOS */
5813 if (foreground_p)
5814 face->foreground = pixel;
5815 else
5816 face->background = pixel;
5820 /* Realize the fully-specified face with attributes ATTRS in face
5821 cache CACHE for ASCII characters. Do it for TTY frame CACHE->f.
5822 Value is a pointer to the newly created realized face. */
5824 static struct face *
5825 realize_tty_face (struct face_cache *cache,
5826 Lisp_Object attrs[LFACE_VECTOR_SIZE])
5828 struct face *face;
5829 int weight, slant;
5830 int face_colors_defaulted = 0;
5831 struct frame *f = cache->f;
5833 /* Frame must be a termcap frame. */
5834 eassert (FRAME_TERMCAP_P (cache->f) || FRAME_MSDOS_P (cache->f));
5836 /* Allocate a new realized face. */
5837 face = make_realized_face (attrs);
5838 #if 0
5839 face->font_name = FRAME_MSDOS_P (cache->f) ? "ms-dos" : "tty";
5840 #endif
5842 /* Map face attributes to TTY appearances. */
5843 weight = FONT_WEIGHT_NAME_NUMERIC (attrs[LFACE_WEIGHT_INDEX]);
5844 slant = FONT_SLANT_NAME_NUMERIC (attrs[LFACE_SLANT_INDEX]);
5845 if (weight > 100)
5846 face->tty_bold_p = 1;
5847 if (slant != 100)
5848 face->tty_italic_p = 1;
5849 if (!NILP (attrs[LFACE_UNDERLINE_INDEX]))
5850 face->tty_underline_p = 1;
5851 if (!NILP (attrs[LFACE_INVERSE_INDEX]))
5852 face->tty_reverse_p = 1;
5854 /* Map color names to color indices. */
5855 map_tty_color (f, face, LFACE_FOREGROUND_INDEX, &face_colors_defaulted);
5856 map_tty_color (f, face, LFACE_BACKGROUND_INDEX, &face_colors_defaulted);
5858 /* Swap colors if face is inverse-video. If the colors are taken
5859 from the frame colors, they are already inverted, since the
5860 frame-creation function calls x-handle-reverse-video. */
5861 if (face->tty_reverse_p && !face_colors_defaulted)
5863 unsigned long tem = face->foreground;
5864 face->foreground = face->background;
5865 face->background = tem;
5868 if (tty_suppress_bold_inverse_default_colors_p
5869 && face->tty_bold_p
5870 && face->background == FACE_TTY_DEFAULT_FG_COLOR
5871 && face->foreground == FACE_TTY_DEFAULT_BG_COLOR)
5872 face->tty_bold_p = 0;
5874 return face;
5878 DEFUN ("tty-suppress-bold-inverse-default-colors",
5879 Ftty_suppress_bold_inverse_default_colors,
5880 Stty_suppress_bold_inverse_default_colors, 1, 1, 0,
5881 doc: /* Suppress/allow boldness of faces with inverse default colors.
5882 SUPPRESS non-nil means suppress it.
5883 This affects bold faces on TTYs whose foreground is the default background
5884 color of the display and whose background is the default foreground color.
5885 For such faces, the bold face attribute is ignored if this variable
5886 is non-nil. */)
5887 (Lisp_Object suppress)
5889 tty_suppress_bold_inverse_default_colors_p = !NILP (suppress);
5890 ++face_change_count;
5891 return suppress;
5896 /***********************************************************************
5897 Computing Faces
5898 ***********************************************************************/
5900 /* Return the ID of the face to use to display character CH with face
5901 property PROP on frame F in current_buffer. */
5904 compute_char_face (struct frame *f, int ch, Lisp_Object prop)
5906 int face_id;
5908 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
5909 ch = 0;
5911 if (NILP (prop))
5913 struct face *face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5914 face_id = FACE_FOR_CHAR (f, face, ch, -1, Qnil);
5916 else
5918 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5919 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5920 memcpy (attrs, default_face->lface, sizeof attrs);
5921 merge_face_ref (f, prop, attrs, 1, 0);
5922 face_id = lookup_face (f, attrs);
5925 return face_id;
5928 /* Return the face ID associated with buffer position POS for
5929 displaying ASCII characters. Return in *ENDPTR the position at
5930 which a different face is needed, as far as text properties and
5931 overlays are concerned. W is a window displaying current_buffer.
5933 REGION_BEG, REGION_END delimit the region, so it can be
5934 highlighted.
5936 LIMIT is a position not to scan beyond. That is to limit the time
5937 this function can take.
5939 If MOUSE is non-zero, use the character's mouse-face, not its face.
5941 BASE_FACE_ID, if non-negative, specifies a base face id to use
5942 instead of DEFAULT_FACE_ID.
5944 The face returned is suitable for displaying ASCII characters. */
5947 face_at_buffer_position (struct window *w, ptrdiff_t pos,
5948 ptrdiff_t region_beg, ptrdiff_t region_end,
5949 ptrdiff_t *endptr, ptrdiff_t limit,
5950 int mouse, int base_face_id)
5952 struct frame *f = XFRAME (w->frame);
5953 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5954 Lisp_Object prop, position;
5955 ptrdiff_t i, noverlays;
5956 Lisp_Object *overlay_vec;
5957 ptrdiff_t endpos;
5958 Lisp_Object propname = mouse ? Qmouse_face : Qface;
5959 Lisp_Object limit1, end;
5960 struct face *default_face;
5962 /* W must display the current buffer. We could write this function
5963 to use the frame and buffer of W, but right now it doesn't. */
5964 /* eassert (XBUFFER (w->contents) == current_buffer); */
5966 XSETFASTINT (position, pos);
5968 endpos = ZV;
5969 if (pos < region_beg && region_beg < endpos)
5970 endpos = region_beg;
5972 /* Get the `face' or `mouse_face' text property at POS, and
5973 determine the next position at which the property changes. */
5974 prop = Fget_text_property (position, propname, w->contents);
5975 XSETFASTINT (limit1, (limit < endpos ? limit : endpos));
5976 end = Fnext_single_property_change (position, propname, w->contents, limit1);
5977 if (INTEGERP (end))
5978 endpos = XINT (end);
5980 /* Look at properties from overlays. */
5982 ptrdiff_t next_overlay;
5984 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, &next_overlay, 0);
5985 if (next_overlay < endpos)
5986 endpos = next_overlay;
5989 *endptr = endpos;
5992 int face_id;
5994 if (base_face_id >= 0)
5995 face_id = base_face_id;
5996 else if (NILP (Vface_remapping_alist))
5997 face_id = DEFAULT_FACE_ID;
5998 else
5999 face_id = lookup_basic_face (f, DEFAULT_FACE_ID);
6001 default_face = FACE_FROM_ID (f, face_id);
6004 /* Optimize common cases where we can use the default face. */
6005 if (noverlays == 0
6006 && NILP (prop)
6007 && !(pos >= region_beg && pos < region_end))
6008 return default_face->id;
6010 /* Begin with attributes from the default face. */
6011 memcpy (attrs, default_face->lface, sizeof attrs);
6013 /* Merge in attributes specified via text properties. */
6014 if (!NILP (prop))
6015 merge_face_ref (f, prop, attrs, 1, 0);
6017 /* Now merge the overlay data. */
6018 noverlays = sort_overlays (overlay_vec, noverlays, w);
6019 for (i = 0; i < noverlays; i++)
6021 Lisp_Object oend;
6022 ptrdiff_t oendpos;
6024 prop = Foverlay_get (overlay_vec[i], propname);
6025 if (!NILP (prop))
6026 merge_face_ref (f, prop, attrs, 1, 0);
6028 oend = OVERLAY_END (overlay_vec[i]);
6029 oendpos = OVERLAY_POSITION (oend);
6030 if (oendpos < endpos)
6031 endpos = oendpos;
6034 /* If in the region, merge in the region face. */
6035 if (pos >= region_beg && pos < region_end)
6037 merge_named_face (f, Qregion, attrs, 0);
6039 if (region_end < endpos)
6040 endpos = region_end;
6043 *endptr = endpos;
6045 /* Look up a realized face with the given face attributes,
6046 or realize a new one for ASCII characters. */
6047 return lookup_face (f, attrs);
6050 /* Return the face ID at buffer position POS for displaying ASCII
6051 characters associated with overlay strings for overlay OVERLAY.
6053 Like face_at_buffer_position except for OVERLAY. Currently it
6054 simply disregards the `face' properties of all overlays. */
6057 face_for_overlay_string (struct window *w, ptrdiff_t pos,
6058 ptrdiff_t region_beg, ptrdiff_t region_end,
6059 ptrdiff_t *endptr, ptrdiff_t limit,
6060 int mouse, Lisp_Object overlay)
6062 struct frame *f = XFRAME (w->frame);
6063 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6064 Lisp_Object prop, position;
6065 ptrdiff_t endpos;
6066 Lisp_Object propname = mouse ? Qmouse_face : Qface;
6067 Lisp_Object limit1, end;
6068 struct face *default_face;
6070 /* W must display the current buffer. We could write this function
6071 to use the frame and buffer of W, but right now it doesn't. */
6072 /* eassert (XBUFFER (w->contents) == current_buffer); */
6074 XSETFASTINT (position, pos);
6076 endpos = ZV;
6077 if (pos < region_beg && region_beg < endpos)
6078 endpos = region_beg;
6080 /* Get the `face' or `mouse_face' text property at POS, and
6081 determine the next position at which the property changes. */
6082 prop = Fget_text_property (position, propname, w->contents);
6083 XSETFASTINT (limit1, (limit < endpos ? limit : endpos));
6084 end = Fnext_single_property_change (position, propname, w->contents, limit1);
6085 if (INTEGERP (end))
6086 endpos = XINT (end);
6088 *endptr = endpos;
6090 /* Optimize common case where we can use the default face. */
6091 if (NILP (prop)
6092 && !(pos >= region_beg && pos < region_end)
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 /* If in the region, merge in the region face. */
6105 if (pos >= region_beg && pos < region_end)
6107 merge_named_face (f, Qregion, attrs, 0);
6109 if (region_end < endpos)
6110 endpos = region_end;
6113 *endptr = endpos;
6115 /* Look up a realized face with the given face attributes,
6116 or realize a new one for ASCII characters. */
6117 return lookup_face (f, attrs);
6121 /* Compute the face at character position POS in Lisp string STRING on
6122 window W, for ASCII characters.
6124 If STRING is an overlay string, it comes from position BUFPOS in
6125 current_buffer, otherwise BUFPOS is zero to indicate that STRING is
6126 not an overlay string. W must display the current buffer.
6127 REGION_BEG and REGION_END give the start and end positions of the
6128 region; both are -1 if no region is visible.
6130 BASE_FACE_ID is the id of a face to merge with. For strings coming
6131 from overlays or the `display' property it is the face at BUFPOS.
6133 If MOUSE_P is non-zero, use the character's mouse-face, not its face.
6135 Set *ENDPTR to the next position where to check for faces in
6136 STRING; -1 if the face is constant from POS to the end of the
6137 string.
6139 Value is the id of the face to use. The face returned is suitable
6140 for displaying ASCII characters. */
6143 face_at_string_position (struct window *w, Lisp_Object string,
6144 ptrdiff_t pos, ptrdiff_t bufpos,
6145 ptrdiff_t region_beg, ptrdiff_t region_end,
6146 ptrdiff_t *endptr, enum face_id base_face_id,
6147 int mouse_p)
6149 Lisp_Object prop, position, end, limit;
6150 struct frame *f = XFRAME (WINDOW_FRAME (w));
6151 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6152 struct face *base_face;
6153 bool multibyte_p = STRING_MULTIBYTE (string);
6154 Lisp_Object prop_name = mouse_p ? Qmouse_face : Qface;
6156 /* Get the value of the face property at the current position within
6157 STRING. Value is nil if there is no face property. */
6158 XSETFASTINT (position, pos);
6159 prop = Fget_text_property (position, prop_name, string);
6161 /* Get the next position at which to check for faces. Value of end
6162 is nil if face is constant all the way to the end of the string.
6163 Otherwise it is a string position where to check faces next.
6164 Limit is the maximum position up to which to check for property
6165 changes in Fnext_single_property_change. Strings are usually
6166 short, so set the limit to the end of the string. */
6167 XSETFASTINT (limit, SCHARS (string));
6168 end = Fnext_single_property_change (position, prop_name, string, limit);
6169 if (INTEGERP (end))
6170 *endptr = XFASTINT (end);
6171 else
6172 *endptr = -1;
6174 base_face = FACE_FROM_ID (f, base_face_id);
6175 eassert (base_face);
6177 /* Optimize the default case that there is no face property and we
6178 are not in the region. */
6179 if (NILP (prop)
6180 && (base_face_id != DEFAULT_FACE_ID
6181 /* BUFPOS <= 0 means STRING is not an overlay string, so
6182 that the region doesn't have to be taken into account. */
6183 || bufpos <= 0
6184 || bufpos < region_beg
6185 || bufpos >= region_end)
6186 && (multibyte_p
6187 /* We can't realize faces for different charsets differently
6188 if we don't have fonts, so we can stop here if not working
6189 on a window-system frame. */
6190 || !FRAME_WINDOW_P (f)
6191 || FACE_SUITABLE_FOR_ASCII_CHAR_P (base_face, 0)))
6192 return base_face->id;
6194 /* Begin with attributes from the base face. */
6195 memcpy (attrs, base_face->lface, sizeof attrs);
6197 /* Merge in attributes specified via text properties. */
6198 if (!NILP (prop))
6199 merge_face_ref (f, prop, attrs, 1, 0);
6201 /* If in the region, merge in the region face. */
6202 if (bufpos
6203 && bufpos >= region_beg
6204 && bufpos < region_end)
6205 merge_named_face (f, Qregion, attrs, 0);
6207 /* Look up a realized face with the given face attributes,
6208 or realize a new one for ASCII characters. */
6209 return lookup_face (f, attrs);
6213 /* Merge a face into a realized face.
6215 F is frame where faces are (to be) realized.
6217 FACE_NAME is named face to merge.
6219 If FACE_NAME is nil, FACE_ID is face_id of realized face to merge.
6221 If FACE_NAME is t, FACE_ID is lface_id of face to merge.
6223 BASE_FACE_ID is realized face to merge into.
6225 Return new face id.
6229 merge_faces (struct frame *f, Lisp_Object face_name, int face_id,
6230 int base_face_id)
6232 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6233 struct face *base_face;
6235 base_face = FACE_FROM_ID (f, base_face_id);
6236 if (!base_face)
6237 return base_face_id;
6239 if (EQ (face_name, Qt))
6241 if (face_id < 0 || face_id >= lface_id_to_name_size)
6242 return base_face_id;
6243 face_name = lface_id_to_name[face_id];
6244 /* When called during make-frame, lookup_derived_face may fail
6245 if the faces are uninitialized. Don't signal an error. */
6246 face_id = lookup_derived_face (f, face_name, base_face_id, 0);
6247 return (face_id >= 0 ? face_id : base_face_id);
6250 /* Begin with attributes from the base face. */
6251 memcpy (attrs, base_face->lface, sizeof attrs);
6253 if (!NILP (face_name))
6255 if (!merge_named_face (f, face_name, attrs, 0))
6256 return base_face_id;
6258 else
6260 struct face *face;
6261 if (face_id < 0)
6262 return base_face_id;
6263 face = FACE_FROM_ID (f, face_id);
6264 if (!face)
6265 return base_face_id;
6266 merge_face_vectors (f, face->lface, attrs, 0);
6269 /* Look up a realized face with the given face attributes,
6270 or realize a new one for ASCII characters. */
6271 return lookup_face (f, attrs);
6276 #ifndef HAVE_X_WINDOWS
6277 DEFUN ("x-load-color-file", Fx_load_color_file,
6278 Sx_load_color_file, 1, 1, 0,
6279 doc: /* Create an alist of color entries from an external file.
6281 The file should define one named RGB color per line like so:
6282 R G B name
6283 where R,G,B are numbers between 0 and 255 and name is an arbitrary string. */)
6284 (Lisp_Object filename)
6286 FILE *fp;
6287 Lisp_Object cmap = Qnil;
6288 Lisp_Object abspath;
6290 CHECK_STRING (filename);
6291 abspath = Fexpand_file_name (filename, Qnil);
6293 fp = fopen (SSDATA (abspath), "rt");
6294 if (fp)
6296 char buf[512];
6297 int red, green, blue;
6298 int num;
6300 block_input ();
6302 while (fgets (buf, sizeof (buf), fp) != NULL) {
6303 if (sscanf (buf, "%u %u %u %n", &red, &green, &blue, &num) == 3)
6305 char *name = buf + num;
6306 num = strlen (name) - 1;
6307 if (num >= 0 && name[num] == '\n')
6308 name[num] = 0;
6309 cmap = Fcons (Fcons (build_string (name),
6310 #ifdef HAVE_NTGUI
6311 make_number (RGB (red, green, blue))),
6312 #else
6313 make_number ((red << 16) | (green << 8) | blue)),
6314 #endif
6315 cmap);
6318 fclose (fp);
6320 unblock_input ();
6323 return cmap;
6325 #endif
6328 /***********************************************************************
6329 Tests
6330 ***********************************************************************/
6332 #ifdef GLYPH_DEBUG
6334 /* Print the contents of the realized face FACE to stderr. */
6336 static void
6337 dump_realized_face (struct face *face)
6339 fprintf (stderr, "ID: %d\n", face->id);
6340 #ifdef HAVE_X_WINDOWS
6341 fprintf (stderr, "gc: %ld\n", (long) face->gc);
6342 #endif
6343 fprintf (stderr, "foreground: 0x%lx (%s)\n",
6344 face->foreground,
6345 SDATA (face->lface[LFACE_FOREGROUND_INDEX]));
6346 fprintf (stderr, "background: 0x%lx (%s)\n",
6347 face->background,
6348 SDATA (face->lface[LFACE_BACKGROUND_INDEX]));
6349 if (face->font)
6350 fprintf (stderr, "font_name: %s (%s)\n",
6351 SDATA (face->font->props[FONT_NAME_INDEX]),
6352 SDATA (face->lface[LFACE_FAMILY_INDEX]));
6353 #ifdef HAVE_X_WINDOWS
6354 fprintf (stderr, "font = %p\n", face->font);
6355 #endif
6356 fprintf (stderr, "fontset: %d\n", face->fontset);
6357 fprintf (stderr, "underline: %d (%s)\n",
6358 face->underline_p,
6359 SDATA (Fsymbol_name (face->lface[LFACE_UNDERLINE_INDEX])));
6360 fprintf (stderr, "hash: %d\n", face->hash);
6364 DEFUN ("dump-face", Fdump_face, Sdump_face, 0, 1, 0, doc: /* */)
6365 (Lisp_Object n)
6367 if (NILP (n))
6369 int i;
6371 fprintf (stderr, "font selection order: ");
6372 for (i = 0; i < DIM (font_sort_order); ++i)
6373 fprintf (stderr, "%d ", font_sort_order[i]);
6374 fprintf (stderr, "\n");
6376 fprintf (stderr, "alternative fonts: ");
6377 debug_print (Vface_alternative_font_family_alist);
6378 fprintf (stderr, "\n");
6380 for (i = 0; i < FRAME_FACE_CACHE (SELECTED_FRAME ())->used; ++i)
6381 Fdump_face (make_number (i));
6383 else
6385 struct face *face;
6386 CHECK_NUMBER (n);
6387 face = FACE_FROM_ID (SELECTED_FRAME (), XINT (n));
6388 if (face == NULL)
6389 error ("Not a valid face");
6390 dump_realized_face (face);
6393 return Qnil;
6397 DEFUN ("show-face-resources", Fshow_face_resources, Sshow_face_resources,
6398 0, 0, 0, doc: /* */)
6399 (void)
6401 fprintf (stderr, "number of colors = %d\n", ncolors_allocated);
6402 fprintf (stderr, "number of pixmaps = %d\n", npixmaps_allocated);
6403 fprintf (stderr, "number of GCs = %d\n", ngcs);
6404 return Qnil;
6407 #endif /* GLYPH_DEBUG */
6411 /***********************************************************************
6412 Initialization
6413 ***********************************************************************/
6415 void
6416 syms_of_xfaces (void)
6418 DEFSYM (Qface, "face");
6419 DEFSYM (Qface_no_inherit, "face-no-inherit");
6420 DEFSYM (Qbitmap_spec_p, "bitmap-spec-p");
6421 DEFSYM (Qframe_set_background_mode, "frame-set-background-mode");
6423 /* Lisp face attribute keywords. */
6424 DEFSYM (QCfamily, ":family");
6425 DEFSYM (QCheight, ":height");
6426 DEFSYM (QCweight, ":weight");
6427 DEFSYM (QCslant, ":slant");
6428 DEFSYM (QCunderline, ":underline");
6429 DEFSYM (QCinverse_video, ":inverse-video");
6430 DEFSYM (QCreverse_video, ":reverse-video");
6431 DEFSYM (QCforeground, ":foreground");
6432 DEFSYM (QCbackground, ":background");
6433 DEFSYM (QCstipple, ":stipple");
6434 DEFSYM (QCwidth, ":width");
6435 DEFSYM (QCfont, ":font");
6436 DEFSYM (QCfontset, ":fontset");
6437 DEFSYM (QCbold, ":bold");
6438 DEFSYM (QCitalic, ":italic");
6439 DEFSYM (QCoverline, ":overline");
6440 DEFSYM (QCstrike_through, ":strike-through");
6441 DEFSYM (QCbox, ":box");
6442 DEFSYM (QCinherit, ":inherit");
6444 /* Symbols used for Lisp face attribute values. */
6445 DEFSYM (QCcolor, ":color");
6446 DEFSYM (QCline_width, ":line-width");
6447 DEFSYM (QCstyle, ":style");
6448 DEFSYM (Qline, "line");
6449 DEFSYM (Qwave, "wave");
6450 DEFSYM (Qreleased_button, "released-button");
6451 DEFSYM (Qpressed_button, "pressed-button");
6452 DEFSYM (Qnormal, "normal");
6453 DEFSYM (Qextra_light, "extra-light");
6454 DEFSYM (Qlight, "light");
6455 DEFSYM (Qsemi_light, "semi-light");
6456 DEFSYM (Qsemi_bold, "semi-bold");
6457 DEFSYM (Qbold, "bold");
6458 DEFSYM (Qextra_bold, "extra-bold");
6459 DEFSYM (Qultra_bold, "ultra-bold");
6460 DEFSYM (Qoblique, "oblique");
6461 DEFSYM (Qitalic, "italic");
6462 DEFSYM (Qbackground_color, "background-color");
6463 DEFSYM (Qforeground_color, "foreground-color");
6464 DEFSYM (Qunspecified, "unspecified");
6465 DEFSYM (QCignore_defface, ":ignore-defface");
6467 DEFSYM (Qface_alias, "face-alias");
6468 DEFSYM (Qdefault, "default");
6469 DEFSYM (Qtool_bar, "tool-bar");
6470 DEFSYM (Qregion, "region");
6471 DEFSYM (Qfringe, "fringe");
6472 DEFSYM (Qheader_line, "header-line");
6473 DEFSYM (Qscroll_bar, "scroll-bar");
6474 DEFSYM (Qmenu, "menu");
6475 DEFSYM (Qcursor, "cursor");
6476 DEFSYM (Qborder, "border");
6477 DEFSYM (Qmouse, "mouse");
6478 DEFSYM (Qmode_line_inactive, "mode-line-inactive");
6479 DEFSYM (Qvertical_border, "vertical-border");
6480 DEFSYM (Qtty_color_desc, "tty-color-desc");
6481 DEFSYM (Qtty_color_standard_values, "tty-color-standard-values");
6482 DEFSYM (Qtty_color_by_index, "tty-color-by-index");
6483 DEFSYM (Qtty_color_alist, "tty-color-alist");
6484 DEFSYM (Qscalable_fonts_allowed, "scalable-fonts-allowed");
6486 Vparam_value_alist = Fcons (Fcons (Qnil, Qnil), Qnil);
6487 staticpro (&Vparam_value_alist);
6488 Vface_alternative_font_family_alist = Qnil;
6489 staticpro (&Vface_alternative_font_family_alist);
6490 Vface_alternative_font_registry_alist = Qnil;
6491 staticpro (&Vface_alternative_font_registry_alist);
6493 defsubr (&Sinternal_make_lisp_face);
6494 defsubr (&Sinternal_lisp_face_p);
6495 defsubr (&Sinternal_set_lisp_face_attribute);
6496 #ifdef HAVE_WINDOW_SYSTEM
6497 defsubr (&Sinternal_set_lisp_face_attribute_from_resource);
6498 #endif
6499 defsubr (&Scolor_gray_p);
6500 defsubr (&Scolor_supported_p);
6501 #ifndef HAVE_X_WINDOWS
6502 defsubr (&Sx_load_color_file);
6503 #endif
6504 defsubr (&Sface_attribute_relative_p);
6505 defsubr (&Smerge_face_attribute);
6506 defsubr (&Sinternal_get_lisp_face_attribute);
6507 defsubr (&Sinternal_lisp_face_attribute_values);
6508 defsubr (&Sinternal_lisp_face_equal_p);
6509 defsubr (&Sinternal_lisp_face_empty_p);
6510 defsubr (&Sinternal_copy_lisp_face);
6511 defsubr (&Sinternal_merge_in_global_face);
6512 defsubr (&Sface_font);
6513 defsubr (&Sframe_face_alist);
6514 defsubr (&Sdisplay_supports_face_attributes_p);
6515 defsubr (&Scolor_distance);
6516 defsubr (&Sinternal_set_font_selection_order);
6517 defsubr (&Sinternal_set_alternative_font_family_alist);
6518 defsubr (&Sinternal_set_alternative_font_registry_alist);
6519 defsubr (&Sface_attributes_as_vector);
6520 #ifdef GLYPH_DEBUG
6521 defsubr (&Sdump_face);
6522 defsubr (&Sshow_face_resources);
6523 #endif /* GLYPH_DEBUG */
6524 defsubr (&Sclear_face_cache);
6525 defsubr (&Stty_suppress_bold_inverse_default_colors);
6527 #if defined DEBUG_X_COLORS && defined HAVE_X_WINDOWS
6528 defsubr (&Sdump_colors);
6529 #endif
6531 DEFVAR_LISP ("face-new-frame-defaults", Vface_new_frame_defaults,
6532 doc: /* List of global face definitions (for internal use only.) */);
6533 Vface_new_frame_defaults = Qnil;
6535 DEFVAR_LISP ("face-default-stipple", Vface_default_stipple,
6536 doc: /* Default stipple pattern used on monochrome displays.
6537 This stipple pattern is used on monochrome displays
6538 instead of shades of gray for a face background color.
6539 See `set-face-stipple' for possible values for this variable. */);
6540 Vface_default_stipple = build_pure_c_string ("gray3");
6542 DEFVAR_LISP ("tty-defined-color-alist", Vtty_defined_color_alist,
6543 doc: /* An alist of defined terminal colors and their RGB values.
6544 See the docstring of `tty-color-alist' for the details. */);
6545 Vtty_defined_color_alist = Qnil;
6547 DEFVAR_LISP ("scalable-fonts-allowed", Vscalable_fonts_allowed,
6548 doc: /* Allowed scalable fonts.
6549 A value of nil means don't allow any scalable fonts.
6550 A value of t means allow any scalable font.
6551 Otherwise, value must be a list of regular expressions. A font may be
6552 scaled if its name matches a regular expression in the list.
6553 Note that if value is nil, a scalable font might still be used, if no
6554 other font of the appropriate family and registry is available. */);
6555 Vscalable_fonts_allowed = Qnil;
6557 DEFVAR_LISP ("face-ignored-fonts", Vface_ignored_fonts,
6558 doc: /* List of ignored fonts.
6559 Each element is a regular expression that matches names of fonts to
6560 ignore. */);
6561 Vface_ignored_fonts = Qnil;
6563 DEFVAR_LISP ("face-remapping-alist", Vface_remapping_alist,
6564 doc: /* Alist of face remappings.
6565 Each element is of the form:
6567 (FACE . REPLACEMENT),
6569 which causes display of the face FACE to use REPLACEMENT instead.
6570 REPLACEMENT is a face specification, i.e. one of the following:
6572 (1) a face name
6573 (2) a property list of attribute/value pairs, or
6574 (3) a list in which each element has the form of (1) or (2).
6576 List values for REPLACEMENT are merged to form the final face
6577 specification, with earlier entries taking precedence, in the same as
6578 as in the `face' text property.
6580 Face-name remapping cycles are suppressed; recursive references use
6581 the underlying face instead of the remapped face. So a remapping of
6582 the form:
6584 (FACE EXTRA-FACE... FACE)
6588 (FACE (FACE-ATTR VAL ...) FACE)
6590 causes EXTRA-FACE... or (FACE-ATTR VAL ...) to be _merged_ with the
6591 existing definition of FACE. Note that this isn't necessary for the
6592 default face, since every face inherits from the default face.
6594 If this variable is made buffer-local, the face remapping takes effect
6595 only in that buffer. For instance, the mode my-mode could define a
6596 face `my-mode-default', and then in the mode setup function, do:
6598 (set (make-local-variable 'face-remapping-alist)
6599 '((default my-mode-default)))).
6601 Because Emacs normally only redraws screen areas when the underlying
6602 buffer contents change, you may need to call `redraw-display' after
6603 changing this variable for it to take effect. */);
6604 Vface_remapping_alist = Qnil;
6606 DEFVAR_LISP ("face-font-rescale-alist", Vface_font_rescale_alist,
6607 doc: /* Alist of fonts vs the rescaling factors.
6608 Each element is a cons (FONT-PATTERN . RESCALE-RATIO), where
6609 FONT-PATTERN is a font-spec or a regular expression matching a font name, and
6610 RESCALE-RATIO is a floating point number to specify how much larger
6611 \(or smaller) font we should use. For instance, if a face requests
6612 a font of 10 point, we actually use a font of 10 * RESCALE-RATIO point. */);
6613 Vface_font_rescale_alist = Qnil;
6615 #ifdef HAVE_WINDOW_SYSTEM
6616 defsubr (&Sbitmap_spec_p);
6617 defsubr (&Sx_list_fonts);
6618 defsubr (&Sinternal_face_x_get_resource);
6619 defsubr (&Sx_family_fonts);
6620 #endif