Merge from trunk.
[emacs.git] / src / xfaces.c
blobb988295e9b6aed053a558e0d8ad29b1f1fd536d2
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>
206 #include <stdio.h> /* This needs to be before termchar.h */
208 #include "lisp.h"
209 #include "character.h"
210 #include "charset.h"
211 #include "keyboard.h"
212 #include "frame.h"
213 #include "termhooks.h"
215 #ifdef HAVE_X_WINDOWS
216 #include "xterm.h"
217 #ifdef USE_MOTIF
218 #include <Xm/Xm.h>
219 #include <Xm/XmStrDefs.h>
220 #endif /* USE_MOTIF */
221 #endif /* HAVE_X_WINDOWS */
223 #ifdef MSDOS
224 #include "dosfns.h"
225 #endif
227 #ifdef HAVE_WINDOW_SYSTEM
228 #include TERM_HEADER
229 #include "fontset.h"
230 #ifdef HAVE_NTGUI
231 #undef FRAME_X_DISPLAY_INFO
232 #define FRAME_X_DISPLAY_INFO FRAME_W32_DISPLAY_INFO
233 #define x_display_info w32_display_info
234 #define check_x check_w32
235 #define GCGraphicsExposures 0
236 #endif /* HAVE_NTGUI */
238 #ifdef HAVE_NS
239 #undef FRAME_X_DISPLAY_INFO
240 #define FRAME_X_DISPLAY_INFO FRAME_NS_DISPLAY_INFO
241 #define x_display_info ns_display_info
242 #define check_x check_ns
243 #define GCGraphicsExposures 0
244 #endif /* HAVE_NS */
245 #endif /* HAVE_WINDOW_SYSTEM */
247 #include "buffer.h"
248 #include "dispextern.h"
249 #include "blockinput.h"
250 #include "window.h"
251 #include "intervals.h"
252 #include "termchar.h"
254 #include "font.h"
256 #ifdef HAVE_X_WINDOWS
258 /* Compensate for a bug in Xos.h on some systems, on which it requires
259 time.h. On some such systems, Xos.h tries to redefine struct
260 timeval and struct timezone if USG is #defined while it is
261 #included. */
263 #ifdef XOS_NEEDS_TIME_H
264 #include <time.h>
265 #undef USG
266 #include <X11/Xos.h>
267 #define USG
268 #define __TIMEVAL__
269 #if defined USG || defined __TIMEVAL__ /* Don't warn about unused macros. */
270 #endif
271 #else /* not XOS_NEEDS_TIME_H */
272 #include <X11/Xos.h>
273 #endif /* not XOS_NEEDS_TIME_H */
275 #endif /* HAVE_X_WINDOWS */
277 #include <c-ctype.h>
279 /* Number of pt per inch (from the TeXbook). */
281 #define PT_PER_INCH 72.27
283 /* Non-zero if face attribute ATTR is unspecified. */
285 #define UNSPECIFIEDP(ATTR) EQ ((ATTR), Qunspecified)
287 /* Non-zero if face attribute ATTR is `ignore-defface'. */
289 #define IGNORE_DEFFACE_P(ATTR) EQ ((ATTR), QCignore_defface)
291 /* Value is the number of elements of VECTOR. */
293 #define DIM(VECTOR) (sizeof (VECTOR) / sizeof *(VECTOR))
295 /* Size of hash table of realized faces in face caches (should be a
296 prime number). */
298 #define FACE_CACHE_BUCKETS_SIZE 1001
300 /* Keyword symbols used for face attribute names. */
302 Lisp_Object QCfamily, QCheight, QCweight, QCslant;
303 static Lisp_Object QCunderline;
304 static Lisp_Object QCinverse_video, QCstipple;
305 Lisp_Object QCforeground, QCbackground;
306 Lisp_Object QCwidth;
307 static Lisp_Object QCfont, QCbold, QCitalic;
308 static Lisp_Object QCreverse_video;
309 static Lisp_Object QCoverline, QCstrike_through, QCbox, QCinherit;
310 static Lisp_Object QCfontset;
312 /* Symbols used for attribute values. */
314 Lisp_Object Qnormal;
315 Lisp_Object Qbold;
316 static Lisp_Object Qline, Qwave;
317 Lisp_Object Qextra_light, Qlight;
318 Lisp_Object Qsemi_light, Qsemi_bold, Qextra_bold, Qultra_bold;
319 Lisp_Object Qoblique;
320 Lisp_Object Qitalic;
321 static Lisp_Object Qreleased_button, Qpressed_button;
322 static Lisp_Object QCstyle, QCcolor, QCline_width;
323 Lisp_Object Qunspecified; /* used in dosfns.c */
324 static Lisp_Object QCignore_defface;
326 char unspecified_fg[] = "unspecified-fg", unspecified_bg[] = "unspecified-bg";
328 /* The name of the function to call when the background of the frame
329 has changed, frame_set_background_mode. */
331 static Lisp_Object Qframe_set_background_mode;
333 /* Names of basic faces. */
335 Lisp_Object Qdefault, Qtool_bar, Qfringe;
336 static Lisp_Object Qregion;
337 Lisp_Object Qheader_line, Qscroll_bar, Qcursor;
338 static Lisp_Object Qborder, Qmouse, Qmenu;
339 Lisp_Object Qmode_line_inactive;
340 static Lisp_Object Qvertical_border;
342 /* The symbol `face-alias'. A symbols having that property is an
343 alias for another face. Value of the property is the name of
344 the aliased face. */
346 static Lisp_Object Qface_alias;
348 /* Alist of alternative font families. Each element is of the form
349 (FAMILY FAMILY1 FAMILY2 ...). If fonts of FAMILY can't be loaded,
350 try FAMILY1, then FAMILY2, ... */
352 Lisp_Object Vface_alternative_font_family_alist;
354 /* Alist of alternative font registries. Each element is of the form
355 (REGISTRY REGISTRY1 REGISTRY2...). If fonts of REGISTRY can't be
356 loaded, try REGISTRY1, then REGISTRY2, ... */
358 Lisp_Object Vface_alternative_font_registry_alist;
360 /* Allowed scalable fonts. A value of nil means don't allow any
361 scalable fonts. A value of t means allow the use of any scalable
362 font. Otherwise, value must be a list of regular expressions. A
363 font may be scaled if its name matches a regular expression in the
364 list. */
366 static Lisp_Object Qscalable_fonts_allowed;
368 /* The symbols `foreground-color' and `background-color' which can be
369 used as part of a `face' property. This is for compatibility with
370 Emacs 20.2. */
372 Lisp_Object Qforeground_color, Qbackground_color;
374 /* The symbols `face' and `mouse-face' used as text properties. */
376 Lisp_Object Qface;
378 /* Property for basic faces which other faces cannot inherit. */
380 static Lisp_Object Qface_no_inherit;
382 /* Error symbol for wrong_type_argument in load_pixmap. */
384 static Lisp_Object Qbitmap_spec_p;
386 /* The next ID to assign to Lisp faces. */
388 static int next_lface_id;
390 /* A vector mapping Lisp face Id's to face names. */
392 static Lisp_Object *lface_id_to_name;
393 static ptrdiff_t lface_id_to_name_size;
395 /* TTY color-related functions (defined in tty-colors.el). */
397 static Lisp_Object Qtty_color_desc, Qtty_color_by_index, Qtty_color_standard_values;
399 /* The name of the function used to compute colors on TTYs. */
401 static Lisp_Object Qtty_color_alist;
403 /* Counter for calls to clear_face_cache. If this counter reaches
404 CLEAR_FONT_TABLE_COUNT, and a frame has more than
405 CLEAR_FONT_TABLE_NFONTS load, unused fonts are freed. */
407 static int clear_font_table_count;
408 #define CLEAR_FONT_TABLE_COUNT 100
409 #define CLEAR_FONT_TABLE_NFONTS 10
411 /* Non-zero means face attributes have been changed since the last
412 redisplay. Used in redisplay_internal. */
414 int face_change_count;
416 /* Non-zero means don't display bold text if a face's foreground
417 and background colors are the inverse of the default colors of the
418 display. This is a kluge to suppress `bold black' foreground text
419 which is hard to read on an LCD monitor. */
421 static int tty_suppress_bold_inverse_default_colors_p;
423 /* A list of the form `((x . y))' used to avoid consing in
424 Finternal_set_lisp_face_attribute. */
426 static Lisp_Object Vparam_value_alist;
428 /* The total number of colors currently allocated. */
430 #ifdef GLYPH_DEBUG
431 static int ncolors_allocated;
432 static int npixmaps_allocated;
433 static int ngcs;
434 #endif
436 /* Non-zero means the definition of the `menu' face for new frames has
437 been changed. */
439 static int menu_face_changed_default;
442 /* Function prototypes. */
444 struct table_entry;
445 struct named_merge_point;
447 static void set_font_frame_param (Lisp_Object, Lisp_Object);
448 static struct face *realize_face (struct face_cache *, Lisp_Object *,
449 int);
450 static struct face *realize_non_ascii_face (struct frame *, Lisp_Object,
451 struct face *);
452 static struct face *realize_x_face (struct face_cache *, Lisp_Object *);
453 static struct face *realize_tty_face (struct face_cache *, Lisp_Object *);
454 static int realize_basic_faces (struct frame *);
455 static int realize_default_face (struct frame *);
456 static void realize_named_face (struct frame *, Lisp_Object, int);
457 static struct face_cache *make_face_cache (struct frame *);
458 static void clear_face_gcs (struct face_cache *);
459 static void free_face_cache (struct face_cache *);
460 static int merge_face_ref (struct frame *, Lisp_Object, Lisp_Object *,
461 int, struct named_merge_point *);
464 /***********************************************************************
465 Utilities
466 ***********************************************************************/
468 #ifdef HAVE_X_WINDOWS
470 #ifdef DEBUG_X_COLORS
472 /* The following is a poor mans infrastructure for debugging X color
473 allocation problems on displays with PseudoColor-8. Some X servers
474 like 3.3.5 XF86_SVGA with Matrox cards apparently don't implement
475 color reference counts completely so that they don't signal an
476 error when a color is freed whose reference count is already 0.
477 Other X servers do. To help me debug this, the following code
478 implements a simple reference counting schema of its own, for a
479 single display/screen. --gerd. */
481 /* Reference counts for pixel colors. */
483 int color_count[256];
485 /* Register color PIXEL as allocated. */
487 void
488 register_color (unsigned long pixel)
490 eassert (pixel < 256);
491 ++color_count[pixel];
495 /* Register color PIXEL as deallocated. */
497 void
498 unregister_color (unsigned long pixel)
500 eassert (pixel < 256);
501 if (color_count[pixel] > 0)
502 --color_count[pixel];
503 else
504 emacs_abort ();
508 /* Register N colors from PIXELS as deallocated. */
510 void
511 unregister_colors (unsigned long *pixels, int n)
513 int i;
514 for (i = 0; i < n; ++i)
515 unregister_color (pixels[i]);
519 DEFUN ("dump-colors", Fdump_colors, Sdump_colors, 0, 0, 0,
520 doc: /* Dump currently allocated colors to stderr. */)
521 (void)
523 int i, n;
525 fputc ('\n', stderr);
527 for (i = n = 0; i < sizeof color_count / sizeof color_count[0]; ++i)
528 if (color_count[i])
530 fprintf (stderr, "%3d: %5d", i, color_count[i]);
531 ++n;
532 if (n % 5 == 0)
533 fputc ('\n', stderr);
534 else
535 fputc ('\t', stderr);
538 if (n % 5 != 0)
539 fputc ('\n', stderr);
540 return Qnil;
543 #endif /* DEBUG_X_COLORS */
546 /* Free colors used on frame F. PIXELS is an array of NPIXELS pixel
547 color values. Interrupt input must be blocked when this function
548 is called. */
550 void
551 x_free_colors (struct frame *f, long unsigned int *pixels, int npixels)
553 int class = FRAME_X_DISPLAY_INFO (f)->visual->class;
555 /* If display has an immutable color map, freeing colors is not
556 necessary and some servers don't allow it. So don't do it. */
557 if (class != StaticColor && class != StaticGray && class != TrueColor)
559 #ifdef DEBUG_X_COLORS
560 unregister_colors (pixels, npixels);
561 #endif
562 XFreeColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
563 pixels, npixels, 0);
568 #ifdef USE_X_TOOLKIT
570 /* Free colors used on frame F. PIXELS is an array of NPIXELS pixel
571 color values. Interrupt input must be blocked when this function
572 is called. */
574 void
575 x_free_dpy_colors (Display *dpy, Screen *screen, Colormap cmap,
576 long unsigned int *pixels, int npixels)
578 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
579 int class = dpyinfo->visual->class;
581 /* If display has an immutable color map, freeing colors is not
582 necessary and some servers don't allow it. So don't do it. */
583 if (class != StaticColor && class != StaticGray && class != TrueColor)
585 #ifdef DEBUG_X_COLORS
586 unregister_colors (pixels, npixels);
587 #endif
588 XFreeColors (dpy, cmap, pixels, npixels, 0);
591 #endif /* USE_X_TOOLKIT */
593 /* Create and return a GC for use on frame F. GC values and mask
594 are given by XGCV and MASK. */
596 static GC
597 x_create_gc (struct frame *f, long unsigned int mask, XGCValues *xgcv)
599 GC gc;
600 block_input ();
601 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), mask, xgcv);
602 unblock_input ();
603 IF_DEBUG (++ngcs);
604 return gc;
608 /* Free GC which was used on frame F. */
610 static void
611 x_free_gc (struct frame *f, GC gc)
613 eassert (input_blocked_p ());
614 IF_DEBUG (eassert (--ngcs >= 0));
615 XFreeGC (FRAME_X_DISPLAY (f), gc);
618 #endif /* HAVE_X_WINDOWS */
620 #ifdef HAVE_NTGUI
621 /* W32 emulation of GCs */
623 static GC
624 x_create_gc (struct frame *f, unsigned long mask, XGCValues *xgcv)
626 GC gc;
627 block_input ();
628 gc = XCreateGC (NULL, FRAME_W32_WINDOW (f), mask, xgcv);
629 unblock_input ();
630 IF_DEBUG (++ngcs);
631 return gc;
635 /* Free GC which was used on frame F. */
637 static void
638 x_free_gc (struct frame *f, GC gc)
640 IF_DEBUG (eassert (--ngcs >= 0));
641 xfree (gc);
644 #endif /* HAVE_NTGUI */
646 #ifdef HAVE_NS
647 /* NS emulation of GCs */
649 static GC
650 x_create_gc (struct frame *f,
651 unsigned long mask,
652 XGCValues *xgcv)
654 GC gc = xmalloc (sizeof *gc);
655 *gc = *xgcv;
656 return gc;
659 static void
660 x_free_gc (struct frame *f, GC gc)
662 xfree (gc);
664 #endif /* HAVE_NS */
666 /***********************************************************************
667 Frames and faces
668 ***********************************************************************/
670 /* Initialize face cache and basic faces for frame F. */
672 void
673 init_frame_faces (struct frame *f)
675 /* Make a face cache, if F doesn't have one. */
676 if (FRAME_FACE_CACHE (f) == NULL)
677 FRAME_FACE_CACHE (f) = make_face_cache (f);
679 #ifdef HAVE_WINDOW_SYSTEM
680 /* Make the image cache. */
681 if (FRAME_WINDOW_P (f))
683 /* We initialize the image cache when creating the first frame
684 on a terminal, and not during terminal creation. This way,
685 `x-open-connection' on a tty won't create an image cache. */
686 if (FRAME_IMAGE_CACHE (f) == NULL)
687 FRAME_IMAGE_CACHE (f) = make_image_cache ();
688 ++FRAME_IMAGE_CACHE (f)->refcount;
690 #endif /* HAVE_WINDOW_SYSTEM */
692 /* Realize basic faces. Must have enough information in frame
693 parameters to realize basic faces at this point. */
694 #ifdef HAVE_X_WINDOWS
695 if (!FRAME_X_P (f) || FRAME_X_WINDOW (f))
696 #endif
697 #ifdef HAVE_NTGUI
698 if (!FRAME_WINDOW_P (f) || FRAME_W32_WINDOW (f))
699 #endif
700 #ifdef HAVE_NS
701 if (!FRAME_NS_P (f) || FRAME_NS_WINDOW (f))
702 #endif
703 if (!realize_basic_faces (f))
704 emacs_abort ();
708 /* Free face cache of frame F. Called from delete_frame. */
710 void
711 free_frame_faces (struct frame *f)
713 struct face_cache *face_cache = FRAME_FACE_CACHE (f);
715 if (face_cache)
717 free_face_cache (face_cache);
718 FRAME_FACE_CACHE (f) = NULL;
721 #ifdef HAVE_WINDOW_SYSTEM
722 if (FRAME_WINDOW_P (f))
724 struct image_cache *image_cache = FRAME_IMAGE_CACHE (f);
725 if (image_cache)
727 --image_cache->refcount;
728 if (image_cache->refcount == 0)
729 free_image_cache (f);
732 #endif /* HAVE_WINDOW_SYSTEM */
736 /* Clear face caches, and recompute basic faces for frame F. Call
737 this after changing frame parameters on which those faces depend,
738 or when realized faces have been freed due to changing attributes
739 of named faces. */
741 void
742 recompute_basic_faces (struct frame *f)
744 if (FRAME_FACE_CACHE (f))
746 clear_face_cache (0);
747 if (!realize_basic_faces (f))
748 emacs_abort ();
753 /* Clear the face caches of all frames. CLEAR_FONTS_P non-zero means
754 try to free unused fonts, too. */
756 void
757 clear_face_cache (int clear_fonts_p)
759 #ifdef HAVE_WINDOW_SYSTEM
760 Lisp_Object tail, frame;
762 if (clear_fonts_p
763 || ++clear_font_table_count == CLEAR_FONT_TABLE_COUNT)
765 #if 0
766 /* Not yet implemented. */
767 clear_font_cache (frame);
768 #endif
770 /* From time to time see if we can unload some fonts. This also
771 frees all realized faces on all frames. Fonts needed by
772 faces will be loaded again when faces are realized again. */
773 clear_font_table_count = 0;
775 FOR_EACH_FRAME (tail, frame)
777 struct frame *f = XFRAME (frame);
778 if (FRAME_WINDOW_P (f)
779 && FRAME_X_DISPLAY_INFO (f)->n_fonts > CLEAR_FONT_TABLE_NFONTS)
780 free_all_realized_faces (frame);
783 else
785 /* Clear GCs of realized faces. */
786 FOR_EACH_FRAME (tail, frame)
788 struct frame *f = XFRAME (frame);
789 if (FRAME_WINDOW_P (f))
790 clear_face_gcs (FRAME_FACE_CACHE (f));
792 clear_image_caches (Qnil);
794 #endif /* HAVE_WINDOW_SYSTEM */
798 DEFUN ("clear-face-cache", Fclear_face_cache, Sclear_face_cache, 0, 1, 0,
799 doc: /* Clear face caches on all frames.
800 Optional THOROUGHLY non-nil means try to free unused fonts, too. */)
801 (Lisp_Object thoroughly)
803 clear_face_cache (!NILP (thoroughly));
804 ++face_change_count;
805 ++windows_or_buffers_changed;
806 return Qnil;
810 /***********************************************************************
811 X Pixmaps
812 ***********************************************************************/
814 #ifdef HAVE_WINDOW_SYSTEM
816 DEFUN ("bitmap-spec-p", Fbitmap_spec_p, Sbitmap_spec_p, 1, 1, 0,
817 doc: /* Value is non-nil if OBJECT is a valid bitmap specification.
818 A bitmap specification is either a string, a file name, or a list
819 \(WIDTH HEIGHT DATA) where WIDTH is the pixel width of the bitmap,
820 HEIGHT is its height, and DATA is a string containing the bits of
821 the pixmap. Bits are stored row by row, each row occupies
822 \(WIDTH + 7)/8 bytes. */)
823 (Lisp_Object object)
825 int pixmap_p = 0;
827 if (STRINGP (object))
828 /* If OBJECT is a string, it's a file name. */
829 pixmap_p = 1;
830 else if (CONSP (object))
832 /* Otherwise OBJECT must be (WIDTH HEIGHT DATA), WIDTH and
833 HEIGHT must be ints > 0, and DATA must be string large
834 enough to hold a bitmap of the specified size. */
835 Lisp_Object width, height, data;
837 height = width = data = Qnil;
839 if (CONSP (object))
841 width = XCAR (object);
842 object = XCDR (object);
843 if (CONSP (object))
845 height = XCAR (object);
846 object = XCDR (object);
847 if (CONSP (object))
848 data = XCAR (object);
852 if (STRINGP (data)
853 && RANGED_INTEGERP (1, width, INT_MAX)
854 && RANGED_INTEGERP (1, height, INT_MAX))
856 int bytes_per_row = ((XINT (width) + BITS_PER_CHAR - 1)
857 / BITS_PER_CHAR);
858 if (XINT (height) <= SBYTES (data) / bytes_per_row)
859 pixmap_p = 1;
863 return pixmap_p ? Qt : Qnil;
867 /* Load a bitmap according to NAME (which is either a file name or a
868 pixmap spec) for use on frame F. Value is the bitmap_id (see
869 xfns.c). If NAME is nil, return with a bitmap id of zero. If
870 bitmap cannot be loaded, display a message saying so, and return
871 zero. Store the bitmap width in *W_PTR and its height in *H_PTR,
872 if these pointers are not null. */
874 static ptrdiff_t
875 load_pixmap (FRAME_PTR f, Lisp_Object name, unsigned int *w_ptr,
876 unsigned int *h_ptr)
878 ptrdiff_t bitmap_id;
880 if (NILP (name))
881 return 0;
883 CHECK_TYPE (!NILP (Fbitmap_spec_p (name)), Qbitmap_spec_p, name);
885 block_input ();
886 if (CONSP (name))
888 /* Decode a bitmap spec into a bitmap. */
890 int h, w;
891 Lisp_Object bits;
893 w = XINT (Fcar (name));
894 h = XINT (Fcar (Fcdr (name)));
895 bits = Fcar (Fcdr (Fcdr (name)));
897 bitmap_id = x_create_bitmap_from_data (f, SSDATA (bits),
898 w, h);
900 else
902 /* It must be a string -- a file name. */
903 bitmap_id = x_create_bitmap_from_file (f, name);
905 unblock_input ();
907 if (bitmap_id < 0)
909 add_to_log ("Invalid or undefined bitmap `%s'", name, Qnil);
910 bitmap_id = 0;
912 if (w_ptr)
913 *w_ptr = 0;
914 if (h_ptr)
915 *h_ptr = 0;
917 else
919 #ifdef GLYPH_DEBUG
920 ++npixmaps_allocated;
921 #endif
922 if (w_ptr)
923 *w_ptr = x_bitmap_width (f, bitmap_id);
925 if (h_ptr)
926 *h_ptr = x_bitmap_height (f, bitmap_id);
929 return bitmap_id;
932 #endif /* HAVE_WINDOW_SYSTEM */
936 /***********************************************************************
937 X Colors
938 ***********************************************************************/
940 /* Parse RGB_LIST, and fill in the RGB fields of COLOR.
941 RGB_LIST should contain (at least) 3 lisp integers.
942 Return 0 if there's a problem with RGB_LIST, otherwise return 1. */
944 static int
945 parse_rgb_list (Lisp_Object rgb_list, XColor *color)
947 #define PARSE_RGB_LIST_FIELD(field) \
948 if (CONSP (rgb_list) && INTEGERP (XCAR (rgb_list))) \
950 color->field = XINT (XCAR (rgb_list)); \
951 rgb_list = XCDR (rgb_list); \
953 else \
954 return 0;
956 PARSE_RGB_LIST_FIELD (red);
957 PARSE_RGB_LIST_FIELD (green);
958 PARSE_RGB_LIST_FIELD (blue);
960 return 1;
964 /* Lookup on frame F the color described by the lisp string COLOR.
965 The resulting tty color is returned in TTY_COLOR; if STD_COLOR is
966 non-zero, then the `standard' definition of the same color is
967 returned in it. */
969 static bool
970 tty_lookup_color (struct frame *f, Lisp_Object color, XColor *tty_color,
971 XColor *std_color)
973 Lisp_Object frame, color_desc;
975 if (!STRINGP (color) || NILP (Ffboundp (Qtty_color_desc)))
976 return 0;
978 XSETFRAME (frame, f);
980 color_desc = call2 (Qtty_color_desc, color, frame);
981 if (CONSP (color_desc) && CONSP (XCDR (color_desc)))
983 Lisp_Object rgb;
985 if (! INTEGERP (XCAR (XCDR (color_desc))))
986 return 0;
988 tty_color->pixel = XINT (XCAR (XCDR (color_desc)));
990 rgb = XCDR (XCDR (color_desc));
991 if (! parse_rgb_list (rgb, tty_color))
992 return 0;
994 /* Should we fill in STD_COLOR too? */
995 if (std_color)
997 /* Default STD_COLOR to the same as TTY_COLOR. */
998 *std_color = *tty_color;
1000 /* Do a quick check to see if the returned descriptor is
1001 actually _exactly_ equal to COLOR, otherwise we have to
1002 lookup STD_COLOR separately. If it's impossible to lookup
1003 a standard color, we just give up and use TTY_COLOR. */
1004 if ((!STRINGP (XCAR (color_desc))
1005 || NILP (Fstring_equal (color, XCAR (color_desc))))
1006 && !NILP (Ffboundp (Qtty_color_standard_values)))
1008 /* Look up STD_COLOR separately. */
1009 rgb = call1 (Qtty_color_standard_values, color);
1010 if (! parse_rgb_list (rgb, std_color))
1011 return 0;
1015 return 1;
1017 else if (NILP (Fsymbol_value (intern ("tty-defined-color-alist"))))
1018 /* We were called early during startup, and the colors are not
1019 yet set up in tty-defined-color-alist. Don't return a failure
1020 indication, since this produces the annoying "Unable to
1021 load color" messages in the *Messages* buffer. */
1022 return 1;
1023 else
1024 /* tty-color-desc seems to have returned a bad value. */
1025 return 0;
1028 /* A version of defined_color for non-X frames. */
1030 static bool
1031 tty_defined_color (struct frame *f, const char *color_name,
1032 XColor *color_def, bool alloc)
1034 bool status = 1;
1036 /* Defaults. */
1037 color_def->pixel = FACE_TTY_DEFAULT_COLOR;
1038 color_def->red = 0;
1039 color_def->blue = 0;
1040 color_def->green = 0;
1042 if (*color_name)
1043 status = tty_lookup_color (f, build_string (color_name), color_def, NULL);
1045 if (color_def->pixel == FACE_TTY_DEFAULT_COLOR && *color_name)
1047 if (strcmp (color_name, "unspecified-fg") == 0)
1048 color_def->pixel = FACE_TTY_DEFAULT_FG_COLOR;
1049 else if (strcmp (color_name, "unspecified-bg") == 0)
1050 color_def->pixel = FACE_TTY_DEFAULT_BG_COLOR;
1053 if (color_def->pixel != FACE_TTY_DEFAULT_COLOR)
1054 status = 1;
1056 return status;
1060 /* Decide if color named COLOR_NAME is valid for the display
1061 associated with the frame F; if so, return the rgb values in
1062 COLOR_DEF. If ALLOC, allocate a new colormap cell.
1064 This does the right thing for any type of frame. */
1066 static bool
1067 defined_color (struct frame *f, const char *color_name, XColor *color_def,
1068 bool alloc)
1070 if (!FRAME_WINDOW_P (f))
1071 return tty_defined_color (f, color_name, color_def, alloc);
1072 #ifdef HAVE_X_WINDOWS
1073 else if (FRAME_X_P (f))
1074 return x_defined_color (f, color_name, color_def, alloc);
1075 #endif
1076 #ifdef HAVE_NTGUI
1077 else if (FRAME_W32_P (f))
1078 return w32_defined_color (f, color_name, color_def, alloc);
1079 #endif
1080 #ifdef HAVE_NS
1081 else if (FRAME_NS_P (f))
1082 return ns_defined_color (f, color_name, color_def, alloc, 1);
1083 #endif
1084 else
1085 emacs_abort ();
1089 /* Given the index IDX of a tty color on frame F, return its name, a
1090 Lisp string. */
1092 Lisp_Object
1093 tty_color_name (struct frame *f, int idx)
1095 if (idx >= 0 && !NILP (Ffboundp (Qtty_color_by_index)))
1097 Lisp_Object frame;
1098 Lisp_Object coldesc;
1100 XSETFRAME (frame, f);
1101 coldesc = call2 (Qtty_color_by_index, make_number (idx), frame);
1103 if (!NILP (coldesc))
1104 return XCAR (coldesc);
1106 #ifdef MSDOS
1107 /* We can have an MSDOG frame under -nw for a short window of
1108 opportunity before internal_terminal_init is called. DTRT. */
1109 if (FRAME_MSDOS_P (f) && !inhibit_window_system)
1110 return msdos_stdcolor_name (idx);
1111 #endif
1113 if (idx == FACE_TTY_DEFAULT_FG_COLOR)
1114 return build_string (unspecified_fg);
1115 if (idx == FACE_TTY_DEFAULT_BG_COLOR)
1116 return build_string (unspecified_bg);
1118 return Qunspecified;
1122 /* Return non-zero if COLOR_NAME is a shade of gray (or white or
1123 black) on frame F.
1125 The criterion implemented here is not a terribly sophisticated one. */
1127 static int
1128 face_color_gray_p (struct frame *f, const char *color_name)
1130 XColor color;
1131 int gray_p;
1133 if (defined_color (f, color_name, &color, 0))
1134 gray_p = (/* Any color sufficiently close to black counts as gray. */
1135 (color.red < 5000 && color.green < 5000 && color.blue < 5000)
1137 ((eabs (color.red - color.green)
1138 < max (color.red, color.green) / 20)
1139 && (eabs (color.green - color.blue)
1140 < max (color.green, color.blue) / 20)
1141 && (eabs (color.blue - color.red)
1142 < max (color.blue, color.red) / 20)));
1143 else
1144 gray_p = 0;
1146 return gray_p;
1150 /* Return non-zero if color COLOR_NAME can be displayed on frame F.
1151 BACKGROUND_P non-zero means the color will be used as background
1152 color. */
1154 static int
1155 face_color_supported_p (struct frame *f, const char *color_name,
1156 int background_p)
1158 Lisp_Object frame;
1159 XColor not_used;
1161 XSETFRAME (frame, f);
1162 return
1163 #ifdef HAVE_WINDOW_SYSTEM
1164 FRAME_WINDOW_P (f)
1165 ? (!NILP (Fxw_display_color_p (frame))
1166 || xstrcasecmp (color_name, "black") == 0
1167 || xstrcasecmp (color_name, "white") == 0
1168 || (background_p
1169 && face_color_gray_p (f, color_name))
1170 || (!NILP (Fx_display_grayscale_p (frame))
1171 && face_color_gray_p (f, color_name)))
1173 #endif
1174 tty_defined_color (f, color_name, &not_used, 0);
1178 DEFUN ("color-gray-p", Fcolor_gray_p, Scolor_gray_p, 1, 2, 0,
1179 doc: /* Return non-nil if COLOR is a shade of gray (or white or black).
1180 FRAME specifies the frame and thus the display for interpreting COLOR.
1181 If FRAME is nil or omitted, use the selected frame. */)
1182 (Lisp_Object color, Lisp_Object frame)
1184 CHECK_STRING (color);
1185 return (face_color_gray_p (decode_any_frame (frame), SSDATA (color))
1186 ? Qt : Qnil);
1190 DEFUN ("color-supported-p", Fcolor_supported_p,
1191 Scolor_supported_p, 1, 3, 0,
1192 doc: /* Return non-nil if COLOR can be displayed on FRAME.
1193 BACKGROUND-P non-nil means COLOR is used as a background.
1194 Otherwise, this function tells whether it can be used as a foreground.
1195 If FRAME is nil or omitted, use the selected frame.
1196 COLOR must be a valid color name. */)
1197 (Lisp_Object color, Lisp_Object frame, Lisp_Object background_p)
1199 CHECK_STRING (color);
1200 return (face_color_supported_p (decode_any_frame (frame),
1201 SSDATA (color), !NILP (background_p))
1202 ? Qt : Qnil);
1206 /* Load color with name NAME for use by face FACE on frame F.
1207 TARGET_INDEX must be one of LFACE_FOREGROUND_INDEX,
1208 LFACE_BACKGROUND_INDEX, LFACE_UNDERLINE_INDEX, LFACE_OVERLINE_INDEX,
1209 LFACE_STRIKE_THROUGH_INDEX, or LFACE_BOX_INDEX. Value is the
1210 pixel color. If color cannot be loaded, display a message, and
1211 return the foreground, background or underline color of F, but
1212 record that fact in flags of the face so that we don't try to free
1213 these colors. */
1215 unsigned long
1216 load_color (struct frame *f, struct face *face, Lisp_Object name,
1217 enum lface_attribute_index target_index)
1219 XColor color;
1221 eassert (STRINGP (name));
1222 eassert (target_index == LFACE_FOREGROUND_INDEX
1223 || target_index == LFACE_BACKGROUND_INDEX
1224 || target_index == LFACE_UNDERLINE_INDEX
1225 || target_index == LFACE_OVERLINE_INDEX
1226 || target_index == LFACE_STRIKE_THROUGH_INDEX
1227 || target_index == LFACE_BOX_INDEX);
1229 /* if the color map is full, defined_color will return a best match
1230 to the values in an existing cell. */
1231 if (!defined_color (f, SSDATA (name), &color, 1))
1233 add_to_log ("Unable to load color \"%s\"", name, Qnil);
1235 switch (target_index)
1237 case LFACE_FOREGROUND_INDEX:
1238 face->foreground_defaulted_p = 1;
1239 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1240 break;
1242 case LFACE_BACKGROUND_INDEX:
1243 face->background_defaulted_p = 1;
1244 color.pixel = FRAME_BACKGROUND_PIXEL (f);
1245 break;
1247 case LFACE_UNDERLINE_INDEX:
1248 face->underline_defaulted_p = 1;
1249 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1250 break;
1252 case LFACE_OVERLINE_INDEX:
1253 face->overline_color_defaulted_p = 1;
1254 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1255 break;
1257 case LFACE_STRIKE_THROUGH_INDEX:
1258 face->strike_through_color_defaulted_p = 1;
1259 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1260 break;
1262 case LFACE_BOX_INDEX:
1263 face->box_color_defaulted_p = 1;
1264 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1265 break;
1267 default:
1268 emacs_abort ();
1271 #ifdef GLYPH_DEBUG
1272 else
1273 ++ncolors_allocated;
1274 #endif
1276 return color.pixel;
1280 #ifdef HAVE_WINDOW_SYSTEM
1282 /* Load colors for face FACE which is used on frame F. Colors are
1283 specified by slots LFACE_BACKGROUND_INDEX and LFACE_FOREGROUND_INDEX
1284 of ATTRS. If the background color specified is not supported on F,
1285 try to emulate gray colors with a stipple from Vface_default_stipple. */
1287 static void
1288 load_face_colors (struct frame *f, struct face *face,
1289 Lisp_Object attrs[LFACE_VECTOR_SIZE])
1291 Lisp_Object fg, bg;
1293 bg = attrs[LFACE_BACKGROUND_INDEX];
1294 fg = attrs[LFACE_FOREGROUND_INDEX];
1296 /* Swap colors if face is inverse-video. */
1297 if (EQ (attrs[LFACE_INVERSE_INDEX], Qt))
1299 Lisp_Object tmp;
1300 tmp = fg;
1301 fg = bg;
1302 bg = tmp;
1305 /* Check for support for foreground, not for background because
1306 face_color_supported_p is smart enough to know that grays are
1307 "supported" as background because we are supposed to use stipple
1308 for them. */
1309 if (!face_color_supported_p (f, SSDATA (bg), 0)
1310 && !NILP (Fbitmap_spec_p (Vface_default_stipple)))
1312 x_destroy_bitmap (f, face->stipple);
1313 face->stipple = load_pixmap (f, Vface_default_stipple,
1314 &face->pixmap_w, &face->pixmap_h);
1317 face->background = load_color (f, face, bg, LFACE_BACKGROUND_INDEX);
1318 face->foreground = load_color (f, face, fg, LFACE_FOREGROUND_INDEX);
1322 /* Free color PIXEL on frame F. */
1324 void
1325 unload_color (struct frame *f, long unsigned int pixel)
1327 #ifdef HAVE_X_WINDOWS
1328 if (pixel != -1)
1330 block_input ();
1331 x_free_colors (f, &pixel, 1);
1332 unblock_input ();
1334 #endif
1338 /* Free colors allocated for FACE. */
1340 static void
1341 free_face_colors (struct frame *f, struct face *face)
1343 /* PENDING(NS): need to do something here? */
1344 #ifdef HAVE_X_WINDOWS
1345 if (face->colors_copied_bitwise_p)
1346 return;
1348 block_input ();
1350 if (!face->foreground_defaulted_p)
1352 x_free_colors (f, &face->foreground, 1);
1353 IF_DEBUG (--ncolors_allocated);
1356 if (!face->background_defaulted_p)
1358 x_free_colors (f, &face->background, 1);
1359 IF_DEBUG (--ncolors_allocated);
1362 if (face->underline_p
1363 && !face->underline_defaulted_p)
1365 x_free_colors (f, &face->underline_color, 1);
1366 IF_DEBUG (--ncolors_allocated);
1369 if (face->overline_p
1370 && !face->overline_color_defaulted_p)
1372 x_free_colors (f, &face->overline_color, 1);
1373 IF_DEBUG (--ncolors_allocated);
1376 if (face->strike_through_p
1377 && !face->strike_through_color_defaulted_p)
1379 x_free_colors (f, &face->strike_through_color, 1);
1380 IF_DEBUG (--ncolors_allocated);
1383 if (face->box != FACE_NO_BOX
1384 && !face->box_color_defaulted_p)
1386 x_free_colors (f, &face->box_color, 1);
1387 IF_DEBUG (--ncolors_allocated);
1390 unblock_input ();
1391 #endif /* HAVE_X_WINDOWS */
1394 #endif /* HAVE_WINDOW_SYSTEM */
1398 /***********************************************************************
1399 XLFD Font Names
1400 ***********************************************************************/
1402 /* An enumerator for each field of an XLFD font name. */
1404 enum xlfd_field
1406 XLFD_FOUNDRY,
1407 XLFD_FAMILY,
1408 XLFD_WEIGHT,
1409 XLFD_SLANT,
1410 XLFD_SWIDTH,
1411 XLFD_ADSTYLE,
1412 XLFD_PIXEL_SIZE,
1413 XLFD_POINT_SIZE,
1414 XLFD_RESX,
1415 XLFD_RESY,
1416 XLFD_SPACING,
1417 XLFD_AVGWIDTH,
1418 XLFD_REGISTRY,
1419 XLFD_ENCODING,
1420 XLFD_LAST
1423 /* An enumerator for each possible slant value of a font. Taken from
1424 the XLFD specification. */
1426 enum xlfd_slant
1428 XLFD_SLANT_UNKNOWN,
1429 XLFD_SLANT_ROMAN,
1430 XLFD_SLANT_ITALIC,
1431 XLFD_SLANT_OBLIQUE,
1432 XLFD_SLANT_REVERSE_ITALIC,
1433 XLFD_SLANT_REVERSE_OBLIQUE,
1434 XLFD_SLANT_OTHER
1437 /* Relative font weight according to XLFD documentation. */
1439 enum xlfd_weight
1441 XLFD_WEIGHT_UNKNOWN,
1442 XLFD_WEIGHT_ULTRA_LIGHT, /* 10 */
1443 XLFD_WEIGHT_EXTRA_LIGHT, /* 20 */
1444 XLFD_WEIGHT_LIGHT, /* 30 */
1445 XLFD_WEIGHT_SEMI_LIGHT, /* 40: SemiLight, Book, ... */
1446 XLFD_WEIGHT_MEDIUM, /* 50: Medium, Normal, Regular, ... */
1447 XLFD_WEIGHT_SEMI_BOLD, /* 60: SemiBold, DemiBold, ... */
1448 XLFD_WEIGHT_BOLD, /* 70: Bold, ... */
1449 XLFD_WEIGHT_EXTRA_BOLD, /* 80: ExtraBold, Heavy, ... */
1450 XLFD_WEIGHT_ULTRA_BOLD /* 90: UltraBold, Black, ... */
1453 /* Relative proportionate width. */
1455 enum xlfd_swidth
1457 XLFD_SWIDTH_UNKNOWN,
1458 XLFD_SWIDTH_ULTRA_CONDENSED, /* 10 */
1459 XLFD_SWIDTH_EXTRA_CONDENSED, /* 20 */
1460 XLFD_SWIDTH_CONDENSED, /* 30: Condensed, Narrow, Compressed, ... */
1461 XLFD_SWIDTH_SEMI_CONDENSED, /* 40: semicondensed */
1462 XLFD_SWIDTH_MEDIUM, /* 50: Medium, Normal, Regular, ... */
1463 XLFD_SWIDTH_SEMI_EXPANDED, /* 60: SemiExpanded, DemiExpanded, ... */
1464 XLFD_SWIDTH_EXPANDED, /* 70: Expanded... */
1465 XLFD_SWIDTH_EXTRA_EXPANDED, /* 80: ExtraExpanded, Wide... */
1466 XLFD_SWIDTH_ULTRA_EXPANDED /* 90: UltraExpanded... */
1469 /* Order by which font selection chooses fonts. The default values
1470 mean `first, find a best match for the font width, then for the
1471 font height, then for weight, then for slant.' This variable can be
1472 set via set-face-font-sort-order. */
1474 static int font_sort_order[4];
1476 #ifdef HAVE_WINDOW_SYSTEM
1478 static enum font_property_index font_props_for_sorting[FONT_SIZE_INDEX];
1480 static int
1481 compare_fonts_by_sort_order (const void *v1, const void *v2)
1483 Lisp_Object const *p1 = v1;
1484 Lisp_Object const *p2 = v2;
1485 Lisp_Object font1 = *p1;
1486 Lisp_Object font2 = *p2;
1487 int i;
1489 for (i = 0; i < FONT_SIZE_INDEX; i++)
1491 enum font_property_index idx = font_props_for_sorting[i];
1492 Lisp_Object val1 = AREF (font1, idx), val2 = AREF (font2, idx);
1493 int result;
1495 if (idx <= FONT_REGISTRY_INDEX)
1497 if (STRINGP (val1))
1498 result = STRINGP (val2) ? strcmp (SSDATA (val1), SSDATA (val2)) : -1;
1499 else
1500 result = STRINGP (val2) ? 1 : 0;
1502 else
1504 if (INTEGERP (val1))
1505 result = (INTEGERP (val2) && XINT (val1) >= XINT (val2)
1506 ? XINT (val1) > XINT (val2)
1507 : -1);
1508 else
1509 result = INTEGERP (val2) ? 1 : 0;
1511 if (result)
1512 return result;
1514 return 0;
1517 DEFUN ("x-family-fonts", Fx_family_fonts, Sx_family_fonts, 0, 2, 0,
1518 doc: /* Return a list of available fonts of family FAMILY on FRAME.
1519 If FAMILY is omitted or nil, list all families.
1520 Otherwise, FAMILY must be a string, possibly containing wildcards
1521 `?' and `*'.
1522 If FRAME is omitted or nil, use the selected frame.
1523 Each element of the result is a vector [FAMILY WIDTH POINT-SIZE WEIGHT
1524 SLANT FIXED-P FULL REGISTRY-AND-ENCODING].
1525 FAMILY is the font family name. POINT-SIZE is the size of the
1526 font in 1/10 pt. WIDTH, WEIGHT, and SLANT are symbols describing the
1527 width, weight and slant of the font. These symbols are the same as for
1528 face attributes. FIXED-P is non-nil if the font is fixed-pitch.
1529 FULL is the full name of the font, and REGISTRY-AND-ENCODING is a string
1530 giving the registry and encoding of the font.
1531 The result list is sorted according to the current setting of
1532 the face font sort order. */)
1533 (Lisp_Object family, Lisp_Object frame)
1535 Lisp_Object font_spec, list, *drivers, vec;
1536 ptrdiff_t i, nfonts;
1537 EMACS_INT ndrivers;
1538 Lisp_Object result;
1539 USE_SAFE_ALLOCA;
1541 if (NILP (frame))
1542 frame = selected_frame;
1543 CHECK_LIVE_FRAME (frame);
1545 font_spec = Ffont_spec (0, NULL);
1546 if (!NILP (family))
1548 CHECK_STRING (family);
1549 font_parse_family_registry (family, Qnil, font_spec);
1552 list = font_list_entities (frame, font_spec);
1553 if (NILP (list))
1554 return Qnil;
1556 /* Sort the font entities. */
1557 for (i = 0; i < 4; i++)
1558 switch (font_sort_order[i])
1560 case XLFD_SWIDTH:
1561 font_props_for_sorting[i] = FONT_WIDTH_INDEX; break;
1562 case XLFD_POINT_SIZE:
1563 font_props_for_sorting[i] = FONT_SIZE_INDEX; break;
1564 case XLFD_WEIGHT:
1565 font_props_for_sorting[i] = FONT_WEIGHT_INDEX; break;
1566 default:
1567 font_props_for_sorting[i] = FONT_SLANT_INDEX; break;
1569 font_props_for_sorting[i++] = FONT_FAMILY_INDEX;
1570 font_props_for_sorting[i++] = FONT_FOUNDRY_INDEX;
1571 font_props_for_sorting[i++] = FONT_ADSTYLE_INDEX;
1572 font_props_for_sorting[i++] = FONT_REGISTRY_INDEX;
1574 ndrivers = XINT (Flength (list));
1575 SAFE_ALLOCA_LISP (drivers, ndrivers);
1576 for (i = 0; i < ndrivers; i++, list = XCDR (list))
1577 drivers[i] = XCAR (list);
1578 vec = Fvconcat (ndrivers, drivers);
1579 nfonts = ASIZE (vec);
1581 qsort (XVECTOR (vec)->contents, nfonts, word_size,
1582 compare_fonts_by_sort_order);
1584 result = Qnil;
1585 for (i = nfonts - 1; i >= 0; --i)
1587 Lisp_Object font = AREF (vec, i);
1588 Lisp_Object v = make_uninit_vector (8);
1589 int point;
1590 Lisp_Object spacing;
1592 ASET (v, 0, AREF (font, FONT_FAMILY_INDEX));
1593 ASET (v, 1, FONT_WIDTH_SYMBOLIC (font));
1594 point = PIXEL_TO_POINT (XINT (AREF (font, FONT_SIZE_INDEX)) * 10,
1595 FRAME_RES_Y (XFRAME (frame)));
1596 ASET (v, 2, make_number (point));
1597 ASET (v, 3, FONT_WEIGHT_SYMBOLIC (font));
1598 ASET (v, 4, FONT_SLANT_SYMBOLIC (font));
1599 spacing = Ffont_get (font, QCspacing);
1600 ASET (v, 5, (NILP (spacing) || EQ (spacing, Qp)) ? Qnil : Qt);
1601 ASET (v, 6, Ffont_xlfd_name (font, Qnil));
1602 ASET (v, 7, AREF (font, FONT_REGISTRY_INDEX));
1604 result = Fcons (v, result);
1607 SAFE_FREE ();
1608 return result;
1611 DEFUN ("x-list-fonts", Fx_list_fonts, Sx_list_fonts, 1, 5, 0,
1612 doc: /* Return a list of the names of available fonts matching PATTERN.
1613 If optional arguments FACE and FRAME are specified, return only fonts
1614 the same size as FACE on FRAME.
1616 PATTERN should be a string containing a font name in the XLFD,
1617 Fontconfig, or GTK format. A font name given in the XLFD format may
1618 contain wildcard characters:
1619 the * character matches any substring, and
1620 the ? character matches any single character.
1621 PATTERN is case-insensitive.
1623 The return value is a list of strings, suitable as arguments to
1624 `set-face-font'.
1626 Fonts Emacs can't use may or may not be excluded
1627 even if they match PATTERN and FACE.
1628 The optional fourth argument MAXIMUM sets a limit on how many
1629 fonts to match. The first MAXIMUM fonts are reported.
1630 The optional fifth argument WIDTH, if specified, is a number of columns
1631 occupied by a character of a font. In that case, return only fonts
1632 the WIDTH times as wide as FACE on FRAME. */)
1633 (Lisp_Object pattern, Lisp_Object face, Lisp_Object frame,
1634 Lisp_Object maximum, Lisp_Object width)
1636 struct frame *f;
1637 int size, avgwidth IF_LINT (= 0);
1639 check_x ();
1640 CHECK_STRING (pattern);
1642 if (! NILP (maximum))
1643 CHECK_NATNUM (maximum);
1645 if (!NILP (width))
1646 CHECK_NUMBER (width);
1648 /* We can't simply call check_x_frame because this function may be
1649 called before any frame is created. */
1650 f = decode_live_frame (frame);
1651 if (! FRAME_WINDOW_P (f))
1653 /* Perhaps we have not yet created any frame. */
1654 f = NULL;
1655 frame = Qnil;
1656 face = Qnil;
1658 else
1659 XSETFRAME (frame, f);
1661 /* Determine the width standard for comparison with the fonts we find. */
1663 if (NILP (face))
1664 size = 0;
1665 else
1667 /* This is of limited utility since it works with character
1668 widths. Keep it for compatibility. --gerd. */
1669 int face_id = lookup_named_face (f, face, 0);
1670 struct face *width_face = (face_id < 0
1671 ? NULL
1672 : FACE_FROM_ID (f, face_id));
1674 if (width_face && width_face->font)
1676 size = width_face->font->pixel_size;
1677 avgwidth = width_face->font->average_width;
1679 else
1681 size = FRAME_FONT (f)->pixel_size;
1682 avgwidth = FRAME_FONT (f)->average_width;
1684 if (!NILP (width))
1685 avgwidth *= XINT (width);
1689 Lisp_Object font_spec;
1690 Lisp_Object args[2], tail;
1692 font_spec = font_spec_from_name (pattern);
1693 if (!FONTP (font_spec))
1694 signal_error ("Invalid font name", pattern);
1696 if (size)
1698 Ffont_put (font_spec, QCsize, make_number (size));
1699 Ffont_put (font_spec, QCavgwidth, make_number (avgwidth));
1701 args[0] = Flist_fonts (font_spec, frame, maximum, font_spec);
1702 for (tail = args[0]; CONSP (tail); tail = XCDR (tail))
1704 Lisp_Object font_entity;
1706 font_entity = XCAR (tail);
1707 if ((NILP (AREF (font_entity, FONT_SIZE_INDEX))
1708 || XINT (AREF (font_entity, FONT_SIZE_INDEX)) == 0)
1709 && ! NILP (AREF (font_spec, FONT_SIZE_INDEX)))
1711 /* This is a scalable font. For backward compatibility,
1712 we set the specified size. */
1713 font_entity = copy_font_spec (font_entity);
1714 ASET (font_entity, FONT_SIZE_INDEX,
1715 AREF (font_spec, FONT_SIZE_INDEX));
1717 XSETCAR (tail, Ffont_xlfd_name (font_entity, Qnil));
1719 if (NILP (frame))
1720 /* We don't have to check fontsets. */
1721 return args[0];
1722 args[1] = list_fontsets (f, pattern, size);
1723 return Fnconc (2, args);
1727 #endif /* HAVE_WINDOW_SYSTEM */
1730 /***********************************************************************
1731 Lisp Faces
1732 ***********************************************************************/
1734 /* Access face attributes of face LFACE, a Lisp vector. */
1736 #define LFACE_FAMILY(LFACE) AREF ((LFACE), LFACE_FAMILY_INDEX)
1737 #define LFACE_FOUNDRY(LFACE) AREF ((LFACE), LFACE_FOUNDRY_INDEX)
1738 #define LFACE_HEIGHT(LFACE) AREF ((LFACE), LFACE_HEIGHT_INDEX)
1739 #define LFACE_WEIGHT(LFACE) AREF ((LFACE), LFACE_WEIGHT_INDEX)
1740 #define LFACE_SLANT(LFACE) AREF ((LFACE), LFACE_SLANT_INDEX)
1741 #define LFACE_UNDERLINE(LFACE) AREF ((LFACE), LFACE_UNDERLINE_INDEX)
1742 #define LFACE_INVERSE(LFACE) AREF ((LFACE), LFACE_INVERSE_INDEX)
1743 #define LFACE_FOREGROUND(LFACE) AREF ((LFACE), LFACE_FOREGROUND_INDEX)
1744 #define LFACE_BACKGROUND(LFACE) AREF ((LFACE), LFACE_BACKGROUND_INDEX)
1745 #define LFACE_STIPPLE(LFACE) AREF ((LFACE), LFACE_STIPPLE_INDEX)
1746 #define LFACE_SWIDTH(LFACE) AREF ((LFACE), LFACE_SWIDTH_INDEX)
1747 #define LFACE_OVERLINE(LFACE) AREF ((LFACE), LFACE_OVERLINE_INDEX)
1748 #define LFACE_STRIKE_THROUGH(LFACE) AREF ((LFACE), LFACE_STRIKE_THROUGH_INDEX)
1749 #define LFACE_BOX(LFACE) AREF ((LFACE), LFACE_BOX_INDEX)
1750 #define LFACE_FONT(LFACE) AREF ((LFACE), LFACE_FONT_INDEX)
1751 #define LFACE_INHERIT(LFACE) AREF ((LFACE), LFACE_INHERIT_INDEX)
1752 #define LFACE_FONTSET(LFACE) AREF ((LFACE), LFACE_FONTSET_INDEX)
1754 /* Non-zero if LFACE is a Lisp face. A Lisp face is a vector of size
1755 LFACE_VECTOR_SIZE which has the symbol `face' in slot 0. */
1757 #define LFACEP(LFACE) \
1758 (VECTORP (LFACE) \
1759 && ASIZE (LFACE) == LFACE_VECTOR_SIZE \
1760 && EQ (AREF (LFACE, 0), Qface))
1763 #ifdef GLYPH_DEBUG
1765 /* Check consistency of Lisp face attribute vector ATTRS. */
1767 static void
1768 check_lface_attrs (Lisp_Object attrs[LFACE_VECTOR_SIZE])
1770 eassert (UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
1771 || IGNORE_DEFFACE_P (attrs[LFACE_FAMILY_INDEX])
1772 || STRINGP (attrs[LFACE_FAMILY_INDEX]));
1773 eassert (UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
1774 || IGNORE_DEFFACE_P (attrs[LFACE_FOUNDRY_INDEX])
1775 || STRINGP (attrs[LFACE_FOUNDRY_INDEX]));
1776 eassert (UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
1777 || IGNORE_DEFFACE_P (attrs[LFACE_SWIDTH_INDEX])
1778 || SYMBOLP (attrs[LFACE_SWIDTH_INDEX]));
1779 eassert (UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
1780 || IGNORE_DEFFACE_P (attrs[LFACE_HEIGHT_INDEX])
1781 || INTEGERP (attrs[LFACE_HEIGHT_INDEX])
1782 || FLOATP (attrs[LFACE_HEIGHT_INDEX])
1783 || FUNCTIONP (attrs[LFACE_HEIGHT_INDEX]));
1784 eassert (UNSPECIFIEDP (attrs[LFACE_WEIGHT_INDEX])
1785 || IGNORE_DEFFACE_P (attrs[LFACE_WEIGHT_INDEX])
1786 || SYMBOLP (attrs[LFACE_WEIGHT_INDEX]));
1787 eassert (UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX])
1788 || IGNORE_DEFFACE_P (attrs[LFACE_SLANT_INDEX])
1789 || SYMBOLP (attrs[LFACE_SLANT_INDEX]));
1790 eassert (UNSPECIFIEDP (attrs[LFACE_UNDERLINE_INDEX])
1791 || IGNORE_DEFFACE_P (attrs[LFACE_UNDERLINE_INDEX])
1792 || SYMBOLP (attrs[LFACE_UNDERLINE_INDEX])
1793 || STRINGP (attrs[LFACE_UNDERLINE_INDEX])
1794 || CONSP (attrs[LFACE_UNDERLINE_INDEX]));
1795 eassert (UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
1796 || IGNORE_DEFFACE_P (attrs[LFACE_OVERLINE_INDEX])
1797 || SYMBOLP (attrs[LFACE_OVERLINE_INDEX])
1798 || STRINGP (attrs[LFACE_OVERLINE_INDEX]));
1799 eassert (UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
1800 || IGNORE_DEFFACE_P (attrs[LFACE_STRIKE_THROUGH_INDEX])
1801 || SYMBOLP (attrs[LFACE_STRIKE_THROUGH_INDEX])
1802 || STRINGP (attrs[LFACE_STRIKE_THROUGH_INDEX]));
1803 eassert (UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
1804 || IGNORE_DEFFACE_P (attrs[LFACE_BOX_INDEX])
1805 || SYMBOLP (attrs[LFACE_BOX_INDEX])
1806 || STRINGP (attrs[LFACE_BOX_INDEX])
1807 || INTEGERP (attrs[LFACE_BOX_INDEX])
1808 || CONSP (attrs[LFACE_BOX_INDEX]));
1809 eassert (UNSPECIFIEDP (attrs[LFACE_INVERSE_INDEX])
1810 || IGNORE_DEFFACE_P (attrs[LFACE_INVERSE_INDEX])
1811 || SYMBOLP (attrs[LFACE_INVERSE_INDEX]));
1812 eassert (UNSPECIFIEDP (attrs[LFACE_FOREGROUND_INDEX])
1813 || IGNORE_DEFFACE_P (attrs[LFACE_FOREGROUND_INDEX])
1814 || STRINGP (attrs[LFACE_FOREGROUND_INDEX]));
1815 eassert (UNSPECIFIEDP (attrs[LFACE_BACKGROUND_INDEX])
1816 || IGNORE_DEFFACE_P (attrs[LFACE_BACKGROUND_INDEX])
1817 || STRINGP (attrs[LFACE_BACKGROUND_INDEX]));
1818 eassert (UNSPECIFIEDP (attrs[LFACE_INHERIT_INDEX])
1819 || IGNORE_DEFFACE_P (attrs[LFACE_INHERIT_INDEX])
1820 || NILP (attrs[LFACE_INHERIT_INDEX])
1821 || SYMBOLP (attrs[LFACE_INHERIT_INDEX])
1822 || CONSP (attrs[LFACE_INHERIT_INDEX]));
1823 #ifdef HAVE_WINDOW_SYSTEM
1824 eassert (UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
1825 || IGNORE_DEFFACE_P (attrs[LFACE_STIPPLE_INDEX])
1826 || SYMBOLP (attrs[LFACE_STIPPLE_INDEX])
1827 || !NILP (Fbitmap_spec_p (attrs[LFACE_STIPPLE_INDEX])));
1828 eassert (UNSPECIFIEDP (attrs[LFACE_FONT_INDEX])
1829 || IGNORE_DEFFACE_P (attrs[LFACE_FONT_INDEX])
1830 || FONTP (attrs[LFACE_FONT_INDEX]));
1831 eassert (UNSPECIFIEDP (attrs[LFACE_FONTSET_INDEX])
1832 || STRINGP (attrs[LFACE_FONTSET_INDEX])
1833 || NILP (attrs[LFACE_FONTSET_INDEX]));
1834 #endif
1838 /* Check consistency of attributes of Lisp face LFACE (a Lisp vector). */
1840 static void
1841 check_lface (Lisp_Object lface)
1843 if (!NILP (lface))
1845 eassert (LFACEP (lface));
1846 check_lface_attrs (XVECTOR (lface)->contents);
1850 #else /* not GLYPH_DEBUG */
1852 #define check_lface_attrs(attrs) (void) 0
1853 #define check_lface(lface) (void) 0
1855 #endif /* GLYPH_DEBUG */
1859 /* Face-merge cycle checking. */
1861 enum named_merge_point_kind
1863 NAMED_MERGE_POINT_NORMAL,
1864 NAMED_MERGE_POINT_REMAP
1867 /* A `named merge point' is simply a point during face-merging where we
1868 look up a face by name. We keep a stack of which named lookups we're
1869 currently processing so that we can easily detect cycles, using a
1870 linked- list of struct named_merge_point structures, typically
1871 allocated on the stack frame of the named lookup functions which are
1872 active (so no consing is required). */
1873 struct named_merge_point
1875 Lisp_Object face_name;
1876 enum named_merge_point_kind named_merge_point_kind;
1877 struct named_merge_point *prev;
1881 /* If a face merging cycle is detected for FACE_NAME, return 0,
1882 otherwise add NEW_NAMED_MERGE_POINT, which is initialized using
1883 FACE_NAME and NAMED_MERGE_POINT_KIND, as the head of the linked list
1884 pointed to by NAMED_MERGE_POINTS, and return 1. */
1886 static int
1887 push_named_merge_point (struct named_merge_point *new_named_merge_point,
1888 Lisp_Object face_name,
1889 enum named_merge_point_kind named_merge_point_kind,
1890 struct named_merge_point **named_merge_points)
1892 struct named_merge_point *prev;
1894 for (prev = *named_merge_points; prev; prev = prev->prev)
1895 if (EQ (face_name, prev->face_name))
1897 if (prev->named_merge_point_kind == named_merge_point_kind)
1898 /* A cycle, so fail. */
1899 return 0;
1900 else if (prev->named_merge_point_kind == NAMED_MERGE_POINT_REMAP)
1901 /* A remap `hides ' any previous normal merge points
1902 (because the remap means that it's actually different face),
1903 so as we know the current merge point must be normal, we
1904 can just assume it's OK. */
1905 break;
1908 new_named_merge_point->face_name = face_name;
1909 new_named_merge_point->named_merge_point_kind = named_merge_point_kind;
1910 new_named_merge_point->prev = *named_merge_points;
1912 *named_merge_points = new_named_merge_point;
1914 return 1;
1918 /* Resolve face name FACE_NAME. If FACE_NAME is a string, intern it
1919 to make it a symbol. If FACE_NAME is an alias for another face,
1920 return that face's name.
1922 Return default face in case of errors. */
1924 static Lisp_Object
1925 resolve_face_name (Lisp_Object face_name, int signal_p)
1927 Lisp_Object orig_face;
1928 Lisp_Object tortoise, hare;
1930 if (STRINGP (face_name))
1931 face_name = intern (SSDATA (face_name));
1933 if (NILP (face_name) || !SYMBOLP (face_name))
1934 return face_name;
1936 orig_face = face_name;
1937 tortoise = hare = face_name;
1939 while (1)
1941 face_name = hare;
1942 hare = Fget (hare, Qface_alias);
1943 if (NILP (hare) || !SYMBOLP (hare))
1944 break;
1946 face_name = hare;
1947 hare = Fget (hare, Qface_alias);
1948 if (NILP (hare) || !SYMBOLP (hare))
1949 break;
1951 tortoise = Fget (tortoise, Qface_alias);
1952 if (EQ (hare, tortoise))
1954 if (signal_p)
1955 xsignal1 (Qcircular_list, orig_face);
1956 return Qdefault;
1960 return face_name;
1964 /* Return the face definition of FACE_NAME on frame F. F null means
1965 return the definition for new frames. FACE_NAME may be a string or
1966 a symbol (apparently Emacs 20.2 allowed strings as face names in
1967 face text properties; Ediff uses that). If SIGNAL_P is non-zero,
1968 signal an error if FACE_NAME is not a valid face name. If SIGNAL_P
1969 is zero, value is nil if FACE_NAME is not a valid face name. */
1970 static Lisp_Object
1971 lface_from_face_name_no_resolve (struct frame *f, Lisp_Object face_name,
1972 int signal_p)
1974 Lisp_Object lface;
1976 if (f)
1977 lface = assq_no_quit (face_name, f->face_alist);
1978 else
1979 lface = assq_no_quit (face_name, Vface_new_frame_defaults);
1981 if (CONSP (lface))
1982 lface = XCDR (lface);
1983 else if (signal_p)
1984 signal_error ("Invalid face", face_name);
1986 check_lface (lface);
1988 return lface;
1991 /* Return the face definition of FACE_NAME on frame F. F null means
1992 return the definition for new frames. FACE_NAME may be a string or
1993 a symbol (apparently Emacs 20.2 allowed strings as face names in
1994 face text properties; Ediff uses that). If FACE_NAME is an alias
1995 for another face, return that face's definition. If SIGNAL_P is
1996 non-zero, signal an error if FACE_NAME is not a valid face name.
1997 If SIGNAL_P is zero, value is nil if FACE_NAME is not a valid face
1998 name. */
1999 static Lisp_Object
2000 lface_from_face_name (struct frame *f, Lisp_Object face_name, int signal_p)
2002 face_name = resolve_face_name (face_name, signal_p);
2003 return lface_from_face_name_no_resolve (f, face_name, signal_p);
2007 /* Get face attributes of face FACE_NAME from frame-local faces on
2008 frame F. Store the resulting attributes in ATTRS which must point
2009 to a vector of Lisp_Objects of size LFACE_VECTOR_SIZE. If SIGNAL_P
2010 is non-zero, signal an error if FACE_NAME does not name a face.
2011 Otherwise, value is zero if FACE_NAME is not a face. */
2013 static int
2014 get_lface_attributes_no_remap (struct frame *f, Lisp_Object face_name,
2015 Lisp_Object attrs[LFACE_VECTOR_SIZE],
2016 int signal_p)
2018 Lisp_Object lface;
2020 lface = lface_from_face_name_no_resolve (f, face_name, signal_p);
2022 if (! NILP (lface))
2023 memcpy (attrs, XVECTOR (lface)->contents,
2024 LFACE_VECTOR_SIZE * sizeof *attrs);
2026 return !NILP (lface);
2029 /* Get face attributes of face FACE_NAME from frame-local faces on frame
2030 F. Store the resulting attributes in ATTRS which must point to a
2031 vector of Lisp_Objects of size LFACE_VECTOR_SIZE. If FACE_NAME is an
2032 alias for another face, use that face's definition. If SIGNAL_P is
2033 non-zero, signal an error if FACE_NAME does not name a face.
2034 Otherwise, value is zero if FACE_NAME is not a face. */
2036 static int
2037 get_lface_attributes (struct frame *f, Lisp_Object face_name,
2038 Lisp_Object attrs[LFACE_VECTOR_SIZE], int signal_p,
2039 struct named_merge_point *named_merge_points)
2041 Lisp_Object face_remapping;
2043 face_name = resolve_face_name (face_name, signal_p);
2045 /* See if SYMBOL has been remapped to some other face (usually this
2046 is done buffer-locally). */
2047 face_remapping = assq_no_quit (face_name, Vface_remapping_alist);
2048 if (CONSP (face_remapping))
2050 struct named_merge_point named_merge_point;
2052 if (push_named_merge_point (&named_merge_point,
2053 face_name, NAMED_MERGE_POINT_REMAP,
2054 &named_merge_points))
2056 int i;
2058 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2059 attrs[i] = Qunspecified;
2061 return merge_face_ref (f, XCDR (face_remapping), attrs,
2062 signal_p, named_merge_points);
2066 /* Default case, no remapping. */
2067 return get_lface_attributes_no_remap (f, face_name, attrs, signal_p);
2071 /* Non-zero if all attributes in face attribute vector ATTRS are
2072 specified, i.e. are non-nil. */
2074 static int
2075 lface_fully_specified_p (Lisp_Object attrs[LFACE_VECTOR_SIZE])
2077 int i;
2079 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2080 if (i != LFACE_FONT_INDEX && i != LFACE_INHERIT_INDEX)
2081 if ((UNSPECIFIEDP (attrs[i]) || IGNORE_DEFFACE_P (attrs[i])))
2082 break;
2084 return i == LFACE_VECTOR_SIZE;
2087 #ifdef HAVE_WINDOW_SYSTEM
2089 /* Set font-related attributes of Lisp face LFACE from FONT-OBJECT.
2090 If FORCE_P is zero, set only unspecified attributes of LFACE. The
2091 exception is `font' attribute. It is set to FONT_OBJECT regardless
2092 of FORCE_P. */
2094 static int
2095 set_lface_from_font (struct frame *f, Lisp_Object lface,
2096 Lisp_Object font_object, int force_p)
2098 Lisp_Object val;
2099 struct font *font = XFONT_OBJECT (font_object);
2101 /* Set attributes only if unspecified, otherwise face defaults for
2102 new frames would never take effect. If the font doesn't have a
2103 specific property, set a normal value for that. */
2105 if (force_p || UNSPECIFIEDP (LFACE_FAMILY (lface)))
2107 Lisp_Object family = AREF (font_object, FONT_FAMILY_INDEX);
2109 ASET (lface, LFACE_FAMILY_INDEX, SYMBOL_NAME (family));
2112 if (force_p || UNSPECIFIEDP (LFACE_FOUNDRY (lface)))
2114 Lisp_Object foundry = AREF (font_object, FONT_FOUNDRY_INDEX);
2116 ASET (lface, LFACE_FOUNDRY_INDEX, SYMBOL_NAME (foundry));
2119 if (force_p || UNSPECIFIEDP (LFACE_HEIGHT (lface)))
2121 int pt = PIXEL_TO_POINT (font->pixel_size * 10, FRAME_RES_Y (f));
2123 eassert (pt > 0);
2124 ASET (lface, LFACE_HEIGHT_INDEX, make_number (pt));
2127 if (force_p || UNSPECIFIEDP (LFACE_WEIGHT (lface)))
2129 val = FONT_WEIGHT_FOR_FACE (font_object);
2130 ASET (lface, LFACE_WEIGHT_INDEX, ! NILP (val) ? val :Qnormal);
2132 if (force_p || UNSPECIFIEDP (LFACE_SLANT (lface)))
2134 val = FONT_SLANT_FOR_FACE (font_object);
2135 ASET (lface, LFACE_SLANT_INDEX, ! NILP (val) ? val : Qnormal);
2137 if (force_p || UNSPECIFIEDP (LFACE_SWIDTH (lface)))
2139 val = FONT_WIDTH_FOR_FACE (font_object);
2140 ASET (lface, LFACE_SWIDTH_INDEX, ! NILP (val) ? val : Qnormal);
2143 ASET (lface, LFACE_FONT_INDEX, font_object);
2144 return 1;
2147 #endif /* HAVE_WINDOW_SYSTEM */
2150 /* Merges the face height FROM with the face height TO, and returns the
2151 merged height. If FROM is an invalid height, then INVALID is
2152 returned instead. FROM and TO may be either absolute face heights or
2153 `relative' heights; the returned value is always an absolute height
2154 unless both FROM and TO are relative. */
2156 static Lisp_Object
2157 merge_face_heights (Lisp_Object from, Lisp_Object to, Lisp_Object invalid)
2159 Lisp_Object result = invalid;
2161 if (INTEGERP (from))
2162 /* FROM is absolute, just use it as is. */
2163 result = from;
2164 else if (FLOATP (from))
2165 /* FROM is a scale, use it to adjust TO. */
2167 if (INTEGERP (to))
2168 /* relative X absolute => absolute */
2169 result = make_number (XFLOAT_DATA (from) * XINT (to));
2170 else if (FLOATP (to))
2171 /* relative X relative => relative */
2172 result = make_float (XFLOAT_DATA (from) * XFLOAT_DATA (to));
2173 else if (UNSPECIFIEDP (to))
2174 result = from;
2176 else if (FUNCTIONP (from))
2177 /* FROM is a function, which use to adjust TO. */
2179 /* Call function with current height as argument.
2180 From is the new height. */
2181 result = safe_call1 (from, to);
2183 /* Ensure that if TO was absolute, so is the result. */
2184 if (INTEGERP (to) && !INTEGERP (result))
2185 result = invalid;
2188 return result;
2192 /* Merge two Lisp face attribute vectors on frame F, FROM and TO, and
2193 store the resulting attributes in TO, which must be already be
2194 completely specified and contain only absolute attributes. Every
2195 specified attribute of FROM overrides the corresponding attribute of
2196 TO; relative attributes in FROM are merged with the absolute value in
2197 TO and replace it. NAMED_MERGE_POINTS is used internally to detect
2198 loops in face inheritance/remapping; it should be 0 when called from
2199 other places. */
2201 static void
2202 merge_face_vectors (struct frame *f, Lisp_Object *from, Lisp_Object *to,
2203 struct named_merge_point *named_merge_points)
2205 int i;
2206 Lisp_Object font = Qnil;
2208 /* If FROM inherits from some other faces, merge their attributes into
2209 TO before merging FROM's direct attributes. Note that an :inherit
2210 attribute of `unspecified' is the same as one of nil; we never
2211 merge :inherit attributes, so nil is more correct, but lots of
2212 other code uses `unspecified' as a generic value for face attributes. */
2213 if (!UNSPECIFIEDP (from[LFACE_INHERIT_INDEX])
2214 && !NILP (from[LFACE_INHERIT_INDEX]))
2215 merge_face_ref (f, from[LFACE_INHERIT_INDEX], to, 0, named_merge_points);
2217 if (FONT_SPEC_P (from[LFACE_FONT_INDEX]))
2219 if (!UNSPECIFIEDP (to[LFACE_FONT_INDEX]))
2220 font = merge_font_spec (from[LFACE_FONT_INDEX], to[LFACE_FONT_INDEX]);
2221 else
2222 font = copy_font_spec (from[LFACE_FONT_INDEX]);
2223 to[LFACE_FONT_INDEX] = font;
2226 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2227 if (!UNSPECIFIEDP (from[i]))
2229 if (i == LFACE_HEIGHT_INDEX && !INTEGERP (from[i]))
2231 to[i] = merge_face_heights (from[i], to[i], to[i]);
2232 font_clear_prop (to, FONT_SIZE_INDEX);
2234 else if (i != LFACE_FONT_INDEX && ! EQ (to[i], from[i]))
2236 to[i] = from[i];
2237 if (i >= LFACE_FAMILY_INDEX && i <=LFACE_SLANT_INDEX)
2238 font_clear_prop (to,
2239 (i == LFACE_FAMILY_INDEX ? FONT_FAMILY_INDEX
2240 : i == LFACE_FOUNDRY_INDEX ? FONT_FOUNDRY_INDEX
2241 : i == LFACE_SWIDTH_INDEX ? FONT_WIDTH_INDEX
2242 : i == LFACE_HEIGHT_INDEX ? FONT_SIZE_INDEX
2243 : i == LFACE_WEIGHT_INDEX ? FONT_WEIGHT_INDEX
2244 : FONT_SLANT_INDEX));
2248 /* If FROM specifies a font spec, make its contents take precedence
2249 over :family and other attributes. This is needed for face
2250 remapping using :font to work. */
2252 if (!NILP (font))
2254 if (! NILP (AREF (font, FONT_FOUNDRY_INDEX)))
2255 to[LFACE_FOUNDRY_INDEX] = SYMBOL_NAME (AREF (font, FONT_FOUNDRY_INDEX));
2256 if (! NILP (AREF (font, FONT_FAMILY_INDEX)))
2257 to[LFACE_FAMILY_INDEX] = SYMBOL_NAME (AREF (font, FONT_FAMILY_INDEX));
2258 if (! NILP (AREF (font, FONT_WEIGHT_INDEX)))
2259 to[LFACE_WEIGHT_INDEX] = FONT_WEIGHT_FOR_FACE (font);
2260 if (! NILP (AREF (font, FONT_SLANT_INDEX)))
2261 to[LFACE_SLANT_INDEX] = FONT_SLANT_FOR_FACE (font);
2262 if (! NILP (AREF (font, FONT_WIDTH_INDEX)))
2263 to[LFACE_SWIDTH_INDEX] = FONT_WIDTH_FOR_FACE (font);
2264 ASET (font, FONT_SIZE_INDEX, Qnil);
2267 /* TO is always an absolute face, which should inherit from nothing.
2268 We blindly copy the :inherit attribute above and fix it up here. */
2269 to[LFACE_INHERIT_INDEX] = Qnil;
2272 /* Merge the named face FACE_NAME on frame F, into the vector of face
2273 attributes TO. NAMED_MERGE_POINTS is used to detect loops in face
2274 inheritance. Returns true if FACE_NAME is a valid face name and
2275 merging succeeded. */
2277 static int
2278 merge_named_face (struct frame *f, Lisp_Object face_name, Lisp_Object *to,
2279 struct named_merge_point *named_merge_points)
2281 struct named_merge_point named_merge_point;
2283 if (push_named_merge_point (&named_merge_point,
2284 face_name, NAMED_MERGE_POINT_NORMAL,
2285 &named_merge_points))
2287 struct gcpro gcpro1;
2288 Lisp_Object from[LFACE_VECTOR_SIZE];
2289 int ok = get_lface_attributes (f, face_name, from, 0, named_merge_points);
2291 if (ok)
2293 GCPRO1 (named_merge_point.face_name);
2294 merge_face_vectors (f, from, to, named_merge_points);
2295 UNGCPRO;
2298 return ok;
2300 else
2301 return 0;
2305 /* Merge face attributes from the lisp `face reference' FACE_REF on
2306 frame F into the face attribute vector TO. If ERR_MSGS is non-zero,
2307 problems with FACE_REF cause an error message to be shown. Return
2308 non-zero if no errors occurred (regardless of the value of ERR_MSGS).
2309 NAMED_MERGE_POINTS is used to detect loops in face inheritance or
2310 list structure; it may be 0 for most callers.
2312 FACE_REF may be a single face specification or a list of such
2313 specifications. Each face specification can be:
2315 1. A symbol or string naming a Lisp face.
2317 2. A property list of the form (KEYWORD VALUE ...) where each
2318 KEYWORD is a face attribute name, and value is an appropriate value
2319 for that attribute.
2321 3. Conses or the form (FOREGROUND-COLOR . COLOR) or
2322 (BACKGROUND-COLOR . COLOR) where COLOR is a color name. This is
2323 for compatibility with 20.2.
2325 Face specifications earlier in lists take precedence over later
2326 specifications. */
2328 static int
2329 merge_face_ref (struct frame *f, Lisp_Object face_ref, Lisp_Object *to,
2330 int err_msgs, struct named_merge_point *named_merge_points)
2332 int ok = 1; /* Succeed without an error? */
2334 if (CONSP (face_ref))
2336 Lisp_Object first = XCAR (face_ref);
2338 if (EQ (first, Qforeground_color)
2339 || EQ (first, Qbackground_color))
2341 /* One of (FOREGROUND-COLOR . COLOR) or (BACKGROUND-COLOR
2342 . COLOR). COLOR must be a string. */
2343 Lisp_Object color_name = XCDR (face_ref);
2344 Lisp_Object color = first;
2346 if (STRINGP (color_name))
2348 if (EQ (color, Qforeground_color))
2349 to[LFACE_FOREGROUND_INDEX] = color_name;
2350 else
2351 to[LFACE_BACKGROUND_INDEX] = color_name;
2353 else
2355 if (err_msgs)
2356 add_to_log ("Invalid face color", color_name, Qnil);
2357 ok = 0;
2360 else if (SYMBOLP (first)
2361 && *SDATA (SYMBOL_NAME (first)) == ':')
2363 /* Assume this is the property list form. */
2364 while (CONSP (face_ref) && CONSP (XCDR (face_ref)))
2366 Lisp_Object keyword = XCAR (face_ref);
2367 Lisp_Object value = XCAR (XCDR (face_ref));
2368 int err = 0;
2370 /* Specifying `unspecified' is a no-op. */
2371 if (EQ (value, Qunspecified))
2373 else if (EQ (keyword, QCfamily))
2375 if (STRINGP (value))
2377 to[LFACE_FAMILY_INDEX] = value;
2378 font_clear_prop (to, FONT_FAMILY_INDEX);
2380 else
2381 err = 1;
2383 else if (EQ (keyword, QCfoundry))
2385 if (STRINGP (value))
2387 to[LFACE_FOUNDRY_INDEX] = value;
2388 font_clear_prop (to, FONT_FOUNDRY_INDEX);
2390 else
2391 err = 1;
2393 else if (EQ (keyword, QCheight))
2395 Lisp_Object new_height =
2396 merge_face_heights (value, to[LFACE_HEIGHT_INDEX], Qnil);
2398 if (! NILP (new_height))
2400 to[LFACE_HEIGHT_INDEX] = new_height;
2401 font_clear_prop (to, FONT_SIZE_INDEX);
2403 else
2404 err = 1;
2406 else if (EQ (keyword, QCweight))
2408 if (SYMBOLP (value) && FONT_WEIGHT_NAME_NUMERIC (value) >= 0)
2410 to[LFACE_WEIGHT_INDEX] = value;
2411 font_clear_prop (to, FONT_WEIGHT_INDEX);
2413 else
2414 err = 1;
2416 else if (EQ (keyword, QCslant))
2418 if (SYMBOLP (value) && FONT_SLANT_NAME_NUMERIC (value) >= 0)
2420 to[LFACE_SLANT_INDEX] = value;
2421 font_clear_prop (to, FONT_SLANT_INDEX);
2423 else
2424 err = 1;
2426 else if (EQ (keyword, QCunderline))
2428 if (EQ (value, Qt)
2429 || NILP (value)
2430 || STRINGP (value)
2431 || CONSP (value))
2432 to[LFACE_UNDERLINE_INDEX] = value;
2433 else
2434 err = 1;
2436 else if (EQ (keyword, QCoverline))
2438 if (EQ (value, Qt)
2439 || NILP (value)
2440 || STRINGP (value))
2441 to[LFACE_OVERLINE_INDEX] = value;
2442 else
2443 err = 1;
2445 else if (EQ (keyword, QCstrike_through))
2447 if (EQ (value, Qt)
2448 || NILP (value)
2449 || STRINGP (value))
2450 to[LFACE_STRIKE_THROUGH_INDEX] = value;
2451 else
2452 err = 1;
2454 else if (EQ (keyword, QCbox))
2456 if (EQ (value, Qt))
2457 value = make_number (1);
2458 if (INTEGERP (value)
2459 || STRINGP (value)
2460 || CONSP (value)
2461 || NILP (value))
2462 to[LFACE_BOX_INDEX] = value;
2463 else
2464 err = 1;
2466 else if (EQ (keyword, QCinverse_video)
2467 || EQ (keyword, QCreverse_video))
2469 if (EQ (value, Qt) || NILP (value))
2470 to[LFACE_INVERSE_INDEX] = value;
2471 else
2472 err = 1;
2474 else if (EQ (keyword, QCforeground))
2476 if (STRINGP (value))
2477 to[LFACE_FOREGROUND_INDEX] = value;
2478 else
2479 err = 1;
2481 else if (EQ (keyword, QCbackground))
2483 if (STRINGP (value))
2484 to[LFACE_BACKGROUND_INDEX] = value;
2485 else
2486 err = 1;
2488 else if (EQ (keyword, QCstipple))
2490 #if defined (HAVE_WINDOW_SYSTEM)
2491 Lisp_Object pixmap_p = Fbitmap_spec_p (value);
2492 if (!NILP (pixmap_p))
2493 to[LFACE_STIPPLE_INDEX] = value;
2494 else
2495 err = 1;
2496 #endif /* HAVE_WINDOW_SYSTEM */
2498 else if (EQ (keyword, QCwidth))
2500 if (SYMBOLP (value) && FONT_WIDTH_NAME_NUMERIC (value) >= 0)
2502 to[LFACE_SWIDTH_INDEX] = value;
2503 font_clear_prop (to, FONT_WIDTH_INDEX);
2505 else
2506 err = 1;
2508 else if (EQ (keyword, QCfont))
2510 if (FONTP (value))
2511 to[LFACE_FONT_INDEX] = value;
2512 else
2513 err = 1;
2515 else if (EQ (keyword, QCinherit))
2517 /* This is not really very useful; it's just like a
2518 normal face reference. */
2519 if (! merge_face_ref (f, value, to,
2520 err_msgs, named_merge_points))
2521 err = 1;
2523 else
2524 err = 1;
2526 if (err)
2528 add_to_log ("Invalid face attribute %S %S", keyword, value);
2529 ok = 0;
2532 face_ref = XCDR (XCDR (face_ref));
2535 else
2537 /* This is a list of face refs. Those at the beginning of the
2538 list take precedence over what follows, so we have to merge
2539 from the end backwards. */
2540 Lisp_Object next = XCDR (face_ref);
2542 if (! NILP (next))
2543 ok = merge_face_ref (f, next, to, err_msgs, named_merge_points);
2545 if (! merge_face_ref (f, first, to, err_msgs, named_merge_points))
2546 ok = 0;
2549 else
2551 /* FACE_REF ought to be a face name. */
2552 ok = merge_named_face (f, face_ref, to, named_merge_points);
2553 if (!ok && err_msgs)
2554 add_to_log ("Invalid face reference: %s", face_ref, Qnil);
2557 return ok;
2561 DEFUN ("internal-make-lisp-face", Finternal_make_lisp_face,
2562 Sinternal_make_lisp_face, 1, 2, 0,
2563 doc: /* Make FACE, a symbol, a Lisp face with all attributes nil.
2564 If FACE was not known as a face before, create a new one.
2565 If optional argument FRAME is specified, make a frame-local face
2566 for that frame. Otherwise operate on the global face definition.
2567 Value is a vector of face attributes. */)
2568 (Lisp_Object face, Lisp_Object frame)
2570 Lisp_Object global_lface, lface;
2571 struct frame *f;
2572 int i;
2574 CHECK_SYMBOL (face);
2575 global_lface = lface_from_face_name (NULL, face, 0);
2577 if (!NILP (frame))
2579 CHECK_LIVE_FRAME (frame);
2580 f = XFRAME (frame);
2581 lface = lface_from_face_name (f, face, 0);
2583 else
2584 f = NULL, lface = Qnil;
2586 /* Add a global definition if there is none. */
2587 if (NILP (global_lface))
2589 global_lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
2590 Qunspecified);
2591 ASET (global_lface, 0, Qface);
2592 Vface_new_frame_defaults = Fcons (Fcons (face, global_lface),
2593 Vface_new_frame_defaults);
2595 /* Assign the new Lisp face a unique ID. The mapping from Lisp
2596 face id to Lisp face is given by the vector lface_id_to_name.
2597 The mapping from Lisp face to Lisp face id is given by the
2598 property `face' of the Lisp face name. */
2599 if (next_lface_id == lface_id_to_name_size)
2600 lface_id_to_name =
2601 xpalloc (lface_id_to_name, &lface_id_to_name_size, 1, MAX_FACE_ID,
2602 sizeof *lface_id_to_name);
2604 lface_id_to_name[next_lface_id] = face;
2605 Fput (face, Qface, make_number (next_lface_id));
2606 ++next_lface_id;
2608 else if (f == NULL)
2609 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2610 ASET (global_lface, i, Qunspecified);
2612 /* Add a frame-local definition. */
2613 if (f)
2615 if (NILP (lface))
2617 lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
2618 Qunspecified);
2619 ASET (lface, 0, Qface);
2620 fset_face_alist (f, Fcons (Fcons (face, lface), f->face_alist));
2622 else
2623 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2624 ASET (lface, i, Qunspecified);
2626 else
2627 lface = global_lface;
2629 /* Changing a named face means that all realized faces depending on
2630 that face are invalid. Since we cannot tell which realized faces
2631 depend on the face, make sure they are all removed. This is done
2632 by incrementing face_change_count. The next call to
2633 init_iterator will then free realized faces. */
2634 if (NILP (Fget (face, Qface_no_inherit)))
2636 ++face_change_count;
2637 ++windows_or_buffers_changed;
2640 eassert (LFACEP (lface));
2641 check_lface (lface);
2642 return lface;
2646 DEFUN ("internal-lisp-face-p", Finternal_lisp_face_p,
2647 Sinternal_lisp_face_p, 1, 2, 0,
2648 doc: /* Return non-nil if FACE names a face.
2649 FACE should be a symbol or string.
2650 If optional second argument FRAME is non-nil, check for the
2651 existence of a frame-local face with name FACE on that frame.
2652 Otherwise check for the existence of a global face. */)
2653 (Lisp_Object face, Lisp_Object frame)
2655 Lisp_Object lface;
2657 face = resolve_face_name (face, 1);
2659 if (!NILP (frame))
2661 CHECK_LIVE_FRAME (frame);
2662 lface = lface_from_face_name (XFRAME (frame), face, 0);
2664 else
2665 lface = lface_from_face_name (NULL, face, 0);
2667 return lface;
2671 DEFUN ("internal-copy-lisp-face", Finternal_copy_lisp_face,
2672 Sinternal_copy_lisp_face, 4, 4, 0,
2673 doc: /* Copy face FROM to TO.
2674 If FRAME is t, copy the global face definition of FROM.
2675 Otherwise, copy the frame-local definition of FROM on FRAME.
2676 If NEW-FRAME is a frame, copy that data into the frame-local
2677 definition of TO on NEW-FRAME. If NEW-FRAME is nil,
2678 FRAME controls where the data is copied to.
2680 The value is TO. */)
2681 (Lisp_Object from, Lisp_Object to, Lisp_Object frame, Lisp_Object new_frame)
2683 Lisp_Object lface, copy;
2685 CHECK_SYMBOL (from);
2686 CHECK_SYMBOL (to);
2688 if (EQ (frame, Qt))
2690 /* Copy global definition of FROM. We don't make copies of
2691 strings etc. because 20.2 didn't do it either. */
2692 lface = lface_from_face_name (NULL, from, 1);
2693 copy = Finternal_make_lisp_face (to, Qnil);
2695 else
2697 /* Copy frame-local definition of FROM. */
2698 if (NILP (new_frame))
2699 new_frame = frame;
2700 CHECK_LIVE_FRAME (frame);
2701 CHECK_LIVE_FRAME (new_frame);
2702 lface = lface_from_face_name (XFRAME (frame), from, 1);
2703 copy = Finternal_make_lisp_face (to, new_frame);
2706 vcopy (copy, 0, XVECTOR (lface)->contents, LFACE_VECTOR_SIZE);
2708 /* Changing a named face means that all realized faces depending on
2709 that face are invalid. Since we cannot tell which realized faces
2710 depend on the face, make sure they are all removed. This is done
2711 by incrementing face_change_count. The next call to
2712 init_iterator will then free realized faces. */
2713 if (NILP (Fget (to, Qface_no_inherit)))
2715 ++face_change_count;
2716 ++windows_or_buffers_changed;
2719 return to;
2723 DEFUN ("internal-set-lisp-face-attribute", Finternal_set_lisp_face_attribute,
2724 Sinternal_set_lisp_face_attribute, 3, 4, 0,
2725 doc: /* Set attribute ATTR of FACE to VALUE.
2726 FRAME being a frame means change the face on that frame.
2727 FRAME nil means change the face of the selected frame.
2728 FRAME t means change the default for new frames.
2729 FRAME 0 means change the face on all frames, and change the default
2730 for new frames. */)
2731 (Lisp_Object face, Lisp_Object attr, Lisp_Object value, Lisp_Object frame)
2733 Lisp_Object lface;
2734 Lisp_Object old_value = Qnil;
2735 /* Set one of enum font_property_index (> 0) if ATTR is one of
2736 font-related attributes other than QCfont and QCfontset. */
2737 enum font_property_index prop_index = 0;
2739 CHECK_SYMBOL (face);
2740 CHECK_SYMBOL (attr);
2742 face = resolve_face_name (face, 1);
2744 /* If FRAME is 0, change face on all frames, and change the
2745 default for new frames. */
2746 if (INTEGERP (frame) && XINT (frame) == 0)
2748 Lisp_Object tail;
2749 Finternal_set_lisp_face_attribute (face, attr, value, Qt);
2750 FOR_EACH_FRAME (tail, frame)
2751 Finternal_set_lisp_face_attribute (face, attr, value, frame);
2752 return face;
2755 /* Set lface to the Lisp attribute vector of FACE. */
2756 if (EQ (frame, Qt))
2758 lface = lface_from_face_name (NULL, face, 1);
2760 /* When updating face-new-frame-defaults, we put :ignore-defface
2761 where the caller wants `unspecified'. This forces the frame
2762 defaults to ignore the defface value. Otherwise, the defface
2763 will take effect, which is generally not what is intended.
2764 The value of that attribute will be inherited from some other
2765 face during face merging. See internal_merge_in_global_face. */
2766 if (UNSPECIFIEDP (value))
2767 value = QCignore_defface;
2769 else
2771 if (NILP (frame))
2772 frame = selected_frame;
2774 CHECK_LIVE_FRAME (frame);
2775 lface = lface_from_face_name (XFRAME (frame), face, 0);
2777 /* If a frame-local face doesn't exist yet, create one. */
2778 if (NILP (lface))
2779 lface = Finternal_make_lisp_face (face, frame);
2782 if (EQ (attr, QCfamily))
2784 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2786 CHECK_STRING (value);
2787 if (SCHARS (value) == 0)
2788 signal_error ("Invalid face family", value);
2790 old_value = LFACE_FAMILY (lface);
2791 ASET (lface, LFACE_FAMILY_INDEX, value);
2792 prop_index = FONT_FAMILY_INDEX;
2794 else if (EQ (attr, QCfoundry))
2796 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2798 CHECK_STRING (value);
2799 if (SCHARS (value) == 0)
2800 signal_error ("Invalid face foundry", value);
2802 old_value = LFACE_FOUNDRY (lface);
2803 ASET (lface, LFACE_FOUNDRY_INDEX, value);
2804 prop_index = FONT_FOUNDRY_INDEX;
2806 else if (EQ (attr, QCheight))
2808 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2810 if (EQ (face, Qdefault))
2812 /* The default face must have an absolute size. */
2813 if (!INTEGERP (value) || XINT (value) <= 0)
2814 signal_error ("Default face height not absolute and positive",
2815 value);
2817 else
2819 /* For non-default faces, do a test merge with a random
2820 height to see if VALUE's ok. */
2821 Lisp_Object test = merge_face_heights (value,
2822 make_number (10),
2823 Qnil);
2824 if (!INTEGERP (test) || XINT (test) <= 0)
2825 signal_error ("Face height does not produce a positive integer",
2826 value);
2830 old_value = LFACE_HEIGHT (lface);
2831 ASET (lface, LFACE_HEIGHT_INDEX, value);
2832 prop_index = FONT_SIZE_INDEX;
2834 else if (EQ (attr, QCweight))
2836 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2838 CHECK_SYMBOL (value);
2839 if (FONT_WEIGHT_NAME_NUMERIC (value) < 0)
2840 signal_error ("Invalid face weight", value);
2842 old_value = LFACE_WEIGHT (lface);
2843 ASET (lface, LFACE_WEIGHT_INDEX, value);
2844 prop_index = FONT_WEIGHT_INDEX;
2846 else if (EQ (attr, QCslant))
2848 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2850 CHECK_SYMBOL (value);
2851 if (FONT_SLANT_NAME_NUMERIC (value) < 0)
2852 signal_error ("Invalid face slant", value);
2854 old_value = LFACE_SLANT (lface);
2855 ASET (lface, LFACE_SLANT_INDEX, value);
2856 prop_index = FONT_SLANT_INDEX;
2858 else if (EQ (attr, QCunderline))
2860 int valid_p = 0;
2862 if (UNSPECIFIEDP (value) || IGNORE_DEFFACE_P (value))
2863 valid_p = 1;
2864 else if (NILP (value) || EQ (value, Qt))
2865 valid_p = 1;
2866 else if (STRINGP (value) && SCHARS (value) > 0)
2867 valid_p = 1;
2868 else if (CONSP (value))
2870 Lisp_Object key, val, list;
2872 list = value;
2873 /* FIXME? This errs on the side of acceptance. Eg it accepts:
2874 (defface foo '((t :underline 'foo) "doc")
2875 Maybe this is intentional, maybe it isn't.
2876 Non-nil symbols other than t are not documented as being valid.
2877 Eg compare with inverse-video, which explicitly rejects them.
2879 valid_p = 1;
2881 while (!NILP (CAR_SAFE(list)))
2883 key = CAR_SAFE (list);
2884 list = CDR_SAFE (list);
2885 val = CAR_SAFE (list);
2886 list = CDR_SAFE (list);
2888 if (NILP (key) || NILP (val))
2890 valid_p = 0;
2891 break;
2894 else if (EQ (key, QCcolor)
2895 && !(EQ (val, Qforeground_color)
2896 || (STRINGP (val) && SCHARS (val) > 0)))
2898 valid_p = 0;
2899 break;
2902 else if (EQ (key, QCstyle)
2903 && !(EQ (val, Qline) || EQ (val, Qwave)))
2905 valid_p = 0;
2906 break;
2911 if (!valid_p)
2912 signal_error ("Invalid face underline", value);
2914 old_value = LFACE_UNDERLINE (lface);
2915 ASET (lface, LFACE_UNDERLINE_INDEX, value);
2917 else if (EQ (attr, QCoverline))
2919 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2920 if ((SYMBOLP (value)
2921 && !EQ (value, Qt)
2922 && !EQ (value, Qnil))
2923 /* Overline color. */
2924 || (STRINGP (value)
2925 && SCHARS (value) == 0))
2926 signal_error ("Invalid face overline", value);
2928 old_value = LFACE_OVERLINE (lface);
2929 ASET (lface, LFACE_OVERLINE_INDEX, value);
2931 else if (EQ (attr, QCstrike_through))
2933 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2934 if ((SYMBOLP (value)
2935 && !EQ (value, Qt)
2936 && !EQ (value, Qnil))
2937 /* Strike-through color. */
2938 || (STRINGP (value)
2939 && SCHARS (value) == 0))
2940 signal_error ("Invalid face strike-through", value);
2942 old_value = LFACE_STRIKE_THROUGH (lface);
2943 ASET (lface, LFACE_STRIKE_THROUGH_INDEX, value);
2945 else if (EQ (attr, QCbox))
2947 int valid_p;
2949 /* Allow t meaning a simple box of width 1 in foreground color
2950 of the face. */
2951 if (EQ (value, Qt))
2952 value = make_number (1);
2954 if (UNSPECIFIEDP (value) || IGNORE_DEFFACE_P (value))
2955 valid_p = 1;
2956 else if (NILP (value))
2957 valid_p = 1;
2958 else if (INTEGERP (value))
2959 valid_p = XINT (value) != 0;
2960 else if (STRINGP (value))
2961 valid_p = SCHARS (value) > 0;
2962 else if (CONSP (value))
2964 Lisp_Object tem;
2966 tem = value;
2967 while (CONSP (tem))
2969 Lisp_Object k, v;
2971 k = XCAR (tem);
2972 tem = XCDR (tem);
2973 if (!CONSP (tem))
2974 break;
2975 v = XCAR (tem);
2976 tem = XCDR (tem);
2978 if (EQ (k, QCline_width))
2980 if (!INTEGERP (v) || XINT (v) == 0)
2981 break;
2983 else if (EQ (k, QCcolor))
2985 if (!NILP (v) && (!STRINGP (v) || SCHARS (v) == 0))
2986 break;
2988 else if (EQ (k, QCstyle))
2990 if (!EQ (v, Qpressed_button) && !EQ (v, Qreleased_button))
2991 break;
2993 else
2994 break;
2997 valid_p = NILP (tem);
2999 else
3000 valid_p = 0;
3002 if (!valid_p)
3003 signal_error ("Invalid face box", value);
3005 old_value = LFACE_BOX (lface);
3006 ASET (lface, LFACE_BOX_INDEX, value);
3008 else if (EQ (attr, QCinverse_video)
3009 || EQ (attr, QCreverse_video))
3011 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3013 CHECK_SYMBOL (value);
3014 if (!EQ (value, Qt) && !NILP (value))
3015 signal_error ("Invalid inverse-video face attribute value", value);
3017 old_value = LFACE_INVERSE (lface);
3018 ASET (lface, LFACE_INVERSE_INDEX, value);
3020 else if (EQ (attr, QCforeground))
3022 /* Compatibility with 20.x. */
3023 if (NILP (value))
3024 value = Qunspecified;
3025 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3027 /* Don't check for valid color names here because it depends
3028 on the frame (display) whether the color will be valid
3029 when the face is realized. */
3030 CHECK_STRING (value);
3031 if (SCHARS (value) == 0)
3032 signal_error ("Empty foreground color value", value);
3034 old_value = LFACE_FOREGROUND (lface);
3035 ASET (lface, LFACE_FOREGROUND_INDEX, value);
3037 else if (EQ (attr, QCbackground))
3039 /* Compatibility with 20.x. */
3040 if (NILP (value))
3041 value = Qunspecified;
3042 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3044 /* Don't check for valid color names here because it depends
3045 on the frame (display) whether the color will be valid
3046 when the face is realized. */
3047 CHECK_STRING (value);
3048 if (SCHARS (value) == 0)
3049 signal_error ("Empty background color value", value);
3051 old_value = LFACE_BACKGROUND (lface);
3052 ASET (lface, LFACE_BACKGROUND_INDEX, value);
3054 else if (EQ (attr, QCstipple))
3056 #if defined (HAVE_WINDOW_SYSTEM)
3057 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value)
3058 && !NILP (value)
3059 && NILP (Fbitmap_spec_p (value)))
3060 signal_error ("Invalid stipple attribute", value);
3061 old_value = LFACE_STIPPLE (lface);
3062 ASET (lface, LFACE_STIPPLE_INDEX, value);
3063 #endif /* HAVE_WINDOW_SYSTEM */
3065 else if (EQ (attr, QCwidth))
3067 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3069 CHECK_SYMBOL (value);
3070 if (FONT_WIDTH_NAME_NUMERIC (value) < 0)
3071 signal_error ("Invalid face width", value);
3073 old_value = LFACE_SWIDTH (lface);
3074 ASET (lface, LFACE_SWIDTH_INDEX, value);
3075 prop_index = FONT_WIDTH_INDEX;
3077 else if (EQ (attr, QCfont))
3079 #ifdef HAVE_WINDOW_SYSTEM
3080 if (EQ (frame, Qt) || FRAME_WINDOW_P (XFRAME (frame)))
3082 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3084 FRAME_PTR f;
3086 old_value = LFACE_FONT (lface);
3087 if (! FONTP (value))
3089 if (STRINGP (value))
3091 Lisp_Object name = value;
3092 int fontset = fs_query_fontset (name, 0);
3094 if (fontset >= 0)
3095 name = fontset_ascii (fontset);
3096 value = font_spec_from_name (name);
3097 if (!FONTP (value))
3098 signal_error ("Invalid font name", name);
3100 else
3101 signal_error ("Invalid font or font-spec", value);
3103 if (EQ (frame, Qt))
3104 f = XFRAME (selected_frame);
3105 else
3106 f = XFRAME (frame);
3107 if (! FONT_OBJECT_P (value))
3109 Lisp_Object *attrs = XVECTOR (lface)->contents;
3110 Lisp_Object font_object;
3112 font_object = font_load_for_lface (f, attrs, value);
3113 if (NILP (font_object))
3114 signal_error ("Font not available", value);
3115 value = font_object;
3117 set_lface_from_font (f, lface, value, 1);
3119 else
3120 ASET (lface, LFACE_FONT_INDEX, value);
3122 #endif /* HAVE_WINDOW_SYSTEM */
3124 else if (EQ (attr, QCfontset))
3126 #ifdef HAVE_WINDOW_SYSTEM
3127 if (EQ (frame, Qt) || FRAME_WINDOW_P (XFRAME (frame)))
3129 Lisp_Object tmp;
3131 old_value = LFACE_FONTSET (lface);
3132 tmp = Fquery_fontset (value, Qnil);
3133 if (NILP (tmp))
3134 signal_error ("Invalid fontset name", value);
3135 ASET (lface, LFACE_FONTSET_INDEX, value = tmp);
3137 #endif /* HAVE_WINDOW_SYSTEM */
3139 else if (EQ (attr, QCinherit))
3141 Lisp_Object tail;
3142 if (SYMBOLP (value))
3143 tail = Qnil;
3144 else
3145 for (tail = value; CONSP (tail); tail = XCDR (tail))
3146 if (!SYMBOLP (XCAR (tail)))
3147 break;
3148 if (NILP (tail))
3149 ASET (lface, LFACE_INHERIT_INDEX, value);
3150 else
3151 signal_error ("Invalid face inheritance", value);
3153 else if (EQ (attr, QCbold))
3155 old_value = LFACE_WEIGHT (lface);
3156 ASET (lface, LFACE_WEIGHT_INDEX, NILP (value) ? Qnormal : Qbold);
3157 prop_index = FONT_WEIGHT_INDEX;
3159 else if (EQ (attr, QCitalic))
3161 attr = QCslant;
3162 old_value = LFACE_SLANT (lface);
3163 ASET (lface, LFACE_SLANT_INDEX, NILP (value) ? Qnormal : Qitalic);
3164 prop_index = FONT_SLANT_INDEX;
3166 else
3167 signal_error ("Invalid face attribute name", attr);
3169 if (prop_index)
3171 /* If a font-related attribute other than QCfont and QCfontset
3172 is specified, and if the original QCfont attribute has a font
3173 (font-spec or font-object), set the corresponding property in
3174 the font to nil so that the font selector doesn't think that
3175 the attribute is mandatory. Also, clear the average
3176 width. */
3177 font_clear_prop (XVECTOR (lface)->contents, prop_index);
3180 /* Changing a named face means that all realized faces depending on
3181 that face are invalid. Since we cannot tell which realized faces
3182 depend on the face, make sure they are all removed. This is done
3183 by incrementing face_change_count. The next call to
3184 init_iterator will then free realized faces. */
3185 if (!EQ (frame, Qt)
3186 && NILP (Fget (face, Qface_no_inherit))
3187 && NILP (Fequal (old_value, value)))
3189 ++face_change_count;
3190 ++windows_or_buffers_changed;
3193 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value)
3194 && NILP (Fequal (old_value, value)))
3196 Lisp_Object param;
3198 param = Qnil;
3200 if (EQ (face, Qdefault))
3202 #ifdef HAVE_WINDOW_SYSTEM
3203 /* Changed font-related attributes of the `default' face are
3204 reflected in changed `font' frame parameters. */
3205 if (FRAMEP (frame)
3206 && (prop_index || EQ (attr, QCfont))
3207 && lface_fully_specified_p (XVECTOR (lface)->contents))
3208 set_font_frame_param (frame, lface);
3209 else
3210 #endif /* HAVE_WINDOW_SYSTEM */
3212 if (EQ (attr, QCforeground))
3213 param = Qforeground_color;
3214 else if (EQ (attr, QCbackground))
3215 param = Qbackground_color;
3217 #ifdef HAVE_WINDOW_SYSTEM
3218 #ifndef HAVE_NTGUI
3219 else if (EQ (face, Qscroll_bar))
3221 /* Changing the colors of `scroll-bar' sets frame parameters
3222 `scroll-bar-foreground' and `scroll-bar-background'. */
3223 if (EQ (attr, QCforeground))
3224 param = Qscroll_bar_foreground;
3225 else if (EQ (attr, QCbackground))
3226 param = Qscroll_bar_background;
3228 #endif /* not HAVE_NTGUI */
3229 else if (EQ (face, Qborder))
3231 /* Changing background color of `border' sets frame parameter
3232 `border-color'. */
3233 if (EQ (attr, QCbackground))
3234 param = Qborder_color;
3236 else if (EQ (face, Qcursor))
3238 /* Changing background color of `cursor' sets frame parameter
3239 `cursor-color'. */
3240 if (EQ (attr, QCbackground))
3241 param = Qcursor_color;
3243 else if (EQ (face, Qmouse))
3245 /* Changing background color of `mouse' sets frame parameter
3246 `mouse-color'. */
3247 if (EQ (attr, QCbackground))
3248 param = Qmouse_color;
3250 #endif /* HAVE_WINDOW_SYSTEM */
3251 else if (EQ (face, Qmenu))
3253 /* Indicate that we have to update the menu bar when
3254 realizing faces on FRAME. FRAME t change the
3255 default for new frames. We do this by setting
3256 setting the flag in new face caches */
3257 if (FRAMEP (frame))
3259 struct frame *f = XFRAME (frame);
3260 if (FRAME_FACE_CACHE (f) == NULL)
3261 FRAME_FACE_CACHE (f) = make_face_cache (f);
3262 FRAME_FACE_CACHE (f)->menu_face_changed_p = 1;
3264 else
3265 menu_face_changed_default = 1;
3268 if (!NILP (param))
3270 if (EQ (frame, Qt))
3271 /* Update `default-frame-alist', which is used for new frames. */
3273 store_in_alist (&Vdefault_frame_alist, param, value);
3275 else
3276 /* Update the current frame's parameters. */
3278 Lisp_Object cons;
3279 cons = XCAR (Vparam_value_alist);
3280 XSETCAR (cons, param);
3281 XSETCDR (cons, value);
3282 Fmodify_frame_parameters (frame, Vparam_value_alist);
3287 return face;
3291 /* Update the corresponding face when frame parameter PARAM on frame F
3292 has been assigned the value NEW_VALUE. */
3294 void
3295 update_face_from_frame_parameter (struct frame *f, Lisp_Object param,
3296 Lisp_Object new_value)
3298 Lisp_Object face = Qnil;
3299 Lisp_Object lface;
3301 /* If there are no faces yet, give up. This is the case when called
3302 from Fx_create_frame, and we do the necessary things later in
3303 face-set-after-frame-defaults. */
3304 if (NILP (f->face_alist))
3305 return;
3307 if (EQ (param, Qforeground_color))
3309 face = Qdefault;
3310 lface = lface_from_face_name (f, face, 1);
3311 ASET (lface, LFACE_FOREGROUND_INDEX,
3312 (STRINGP (new_value) ? new_value : Qunspecified));
3313 realize_basic_faces (f);
3315 else if (EQ (param, Qbackground_color))
3317 Lisp_Object frame;
3319 /* Changing the background color might change the background
3320 mode, so that we have to load new defface specs.
3321 Call frame-set-background-mode to do that. */
3322 XSETFRAME (frame, f);
3323 call1 (Qframe_set_background_mode, frame);
3325 face = Qdefault;
3326 lface = lface_from_face_name (f, face, 1);
3327 ASET (lface, LFACE_BACKGROUND_INDEX,
3328 (STRINGP (new_value) ? new_value : Qunspecified));
3329 realize_basic_faces (f);
3331 #ifdef HAVE_WINDOW_SYSTEM
3332 else if (EQ (param, Qborder_color))
3334 face = Qborder;
3335 lface = lface_from_face_name (f, face, 1);
3336 ASET (lface, LFACE_BACKGROUND_INDEX,
3337 (STRINGP (new_value) ? new_value : Qunspecified));
3339 else if (EQ (param, Qcursor_color))
3341 face = Qcursor;
3342 lface = lface_from_face_name (f, face, 1);
3343 ASET (lface, LFACE_BACKGROUND_INDEX,
3344 (STRINGP (new_value) ? new_value : Qunspecified));
3346 else if (EQ (param, Qmouse_color))
3348 face = Qmouse;
3349 lface = lface_from_face_name (f, face, 1);
3350 ASET (lface, LFACE_BACKGROUND_INDEX,
3351 (STRINGP (new_value) ? new_value : Qunspecified));
3353 #endif
3355 /* Changing a named face means that all realized faces depending on
3356 that face are invalid. Since we cannot tell which realized faces
3357 depend on the face, make sure they are all removed. This is done
3358 by incrementing face_change_count. The next call to
3359 init_iterator will then free realized faces. */
3360 if (!NILP (face)
3361 && NILP (Fget (face, Qface_no_inherit)))
3363 ++face_change_count;
3364 ++windows_or_buffers_changed;
3369 #ifdef HAVE_WINDOW_SYSTEM
3371 /* Set the `font' frame parameter of FRAME determined from the
3372 font-object set in `default' face attributes LFACE. */
3374 static void
3375 set_font_frame_param (Lisp_Object frame, Lisp_Object lface)
3377 struct frame *f = XFRAME (frame);
3378 Lisp_Object font;
3380 if (FRAME_WINDOW_P (f)
3381 /* Don't do anything if the font is `unspecified'. This can
3382 happen during frame creation. */
3383 && (font = LFACE_FONT (lface),
3384 ! UNSPECIFIEDP (font)))
3386 if (FONT_SPEC_P (font))
3388 font = font_load_for_lface (f, XVECTOR (lface)->contents, font);
3389 if (NILP (font))
3390 return;
3391 ASET (lface, LFACE_FONT_INDEX, font);
3393 f->default_face_done_p = 0;
3394 Fmodify_frame_parameters (frame, Fcons (Fcons (Qfont, font), Qnil));
3398 DEFUN ("internal-face-x-get-resource", Finternal_face_x_get_resource,
3399 Sinternal_face_x_get_resource, 2, 3, 0,
3400 doc: /* Get the value of X resource RESOURCE, class CLASS.
3401 Returned value is for the display of frame FRAME. If FRAME is not
3402 specified or nil, use selected frame. This function exists because
3403 ordinary `x-get-resource' doesn't take a frame argument. */)
3404 (Lisp_Object resource, Lisp_Object class, Lisp_Object frame)
3406 Lisp_Object value = Qnil;
3407 struct frame *f;
3409 CHECK_STRING (resource);
3410 CHECK_STRING (class);
3411 f = decode_live_frame (frame);
3412 block_input ();
3413 value = display_x_get_resource (FRAME_X_DISPLAY_INFO (f),
3414 resource, class, Qnil, Qnil);
3415 unblock_input ();
3416 return value;
3420 /* Return resource string VALUE as a boolean value, i.e. nil, or t.
3421 If VALUE is "on" or "true", return t. If VALUE is "off" or
3422 "false", return nil. Otherwise, if SIGNAL_P is non-zero, signal an
3423 error; if SIGNAL_P is zero, return 0. */
3425 static Lisp_Object
3426 face_boolean_x_resource_value (Lisp_Object value, int signal_p)
3428 Lisp_Object result = make_number (0);
3430 eassert (STRINGP (value));
3432 if (xstrcasecmp (SSDATA (value), "on") == 0
3433 || xstrcasecmp (SSDATA (value), "true") == 0)
3434 result = Qt;
3435 else if (xstrcasecmp (SSDATA (value), "off") == 0
3436 || xstrcasecmp (SSDATA (value), "false") == 0)
3437 result = Qnil;
3438 else if (xstrcasecmp (SSDATA (value), "unspecified") == 0)
3439 result = Qunspecified;
3440 else if (signal_p)
3441 signal_error ("Invalid face attribute value from X resource", value);
3443 return result;
3447 DEFUN ("internal-set-lisp-face-attribute-from-resource",
3448 Finternal_set_lisp_face_attribute_from_resource,
3449 Sinternal_set_lisp_face_attribute_from_resource,
3450 3, 4, 0, doc: /* */)
3451 (Lisp_Object face, Lisp_Object attr, Lisp_Object value, Lisp_Object frame)
3453 CHECK_SYMBOL (face);
3454 CHECK_SYMBOL (attr);
3455 CHECK_STRING (value);
3457 if (xstrcasecmp (SSDATA (value), "unspecified") == 0)
3458 value = Qunspecified;
3459 else if (EQ (attr, QCheight))
3461 value = Fstring_to_number (value, make_number (10));
3462 if (XINT (value) <= 0)
3463 signal_error ("Invalid face height from X resource", value);
3465 else if (EQ (attr, QCbold) || EQ (attr, QCitalic))
3466 value = face_boolean_x_resource_value (value, 1);
3467 else if (EQ (attr, QCweight) || EQ (attr, QCslant) || EQ (attr, QCwidth))
3468 value = intern (SSDATA (value));
3469 else if (EQ (attr, QCreverse_video) || EQ (attr, QCinverse_video))
3470 value = face_boolean_x_resource_value (value, 1);
3471 else if (EQ (attr, QCunderline)
3472 || EQ (attr, QCoverline)
3473 || EQ (attr, QCstrike_through))
3475 Lisp_Object boolean_value;
3477 /* If the result of face_boolean_x_resource_value is t or nil,
3478 VALUE does NOT specify a color. */
3479 boolean_value = face_boolean_x_resource_value (value, 0);
3480 if (SYMBOLP (boolean_value))
3481 value = boolean_value;
3483 else if (EQ (attr, QCbox) || EQ (attr, QCinherit))
3484 value = Fcar (Fread_from_string (value, Qnil, Qnil));
3486 return Finternal_set_lisp_face_attribute (face, attr, value, frame);
3489 #endif /* HAVE_WINDOW_SYSTEM */
3492 /***********************************************************************
3493 Menu face
3494 ***********************************************************************/
3496 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
3498 /* Make menus on frame F appear as specified by the `menu' face. */
3500 static void
3501 x_update_menu_appearance (struct frame *f)
3503 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3504 XrmDatabase rdb;
3506 if (dpyinfo
3507 && (rdb = XrmGetDatabase (FRAME_X_DISPLAY (f)),
3508 rdb != NULL))
3510 char line[512];
3511 char *buf = line;
3512 ptrdiff_t bufsize = sizeof line;
3513 Lisp_Object lface = lface_from_face_name (f, Qmenu, 1);
3514 struct face *face = FACE_FROM_ID (f, MENU_FACE_ID);
3515 const char *myname = SSDATA (Vx_resource_name);
3516 int changed_p = 0;
3517 #ifdef USE_MOTIF
3518 const char *popup_path = "popup_menu";
3519 #else
3520 const char *popup_path = "menu.popup";
3521 #endif
3523 if (STRINGP (LFACE_FOREGROUND (lface)))
3525 exprintf (&buf, &bufsize, line, -1, "%s.%s*foreground: %s",
3526 myname, popup_path,
3527 SDATA (LFACE_FOREGROUND (lface)));
3528 XrmPutLineResource (&rdb, line);
3529 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*foreground: %s",
3530 myname, SDATA (LFACE_FOREGROUND (lface)));
3531 XrmPutLineResource (&rdb, line);
3532 changed_p = 1;
3535 if (STRINGP (LFACE_BACKGROUND (lface)))
3537 exprintf (&buf, &bufsize, line, -1, "%s.%s*background: %s",
3538 myname, popup_path,
3539 SDATA (LFACE_BACKGROUND (lface)));
3540 XrmPutLineResource (&rdb, line);
3542 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*background: %s",
3543 myname, SDATA (LFACE_BACKGROUND (lface)));
3544 XrmPutLineResource (&rdb, line);
3545 changed_p = 1;
3548 if (face->font
3549 /* On Solaris 5.8, it's been reported that the `menu' face
3550 can be unspecified here, during startup. Why this
3551 happens remains unknown. -- cyd */
3552 && FONTP (LFACE_FONT (lface))
3553 && (!UNSPECIFIEDP (LFACE_FAMILY (lface))
3554 || !UNSPECIFIEDP (LFACE_FOUNDRY (lface))
3555 || !UNSPECIFIEDP (LFACE_SWIDTH (lface))
3556 || !UNSPECIFIEDP (LFACE_WEIGHT (lface))
3557 || !UNSPECIFIEDP (LFACE_SLANT (lface))
3558 || !UNSPECIFIEDP (LFACE_HEIGHT (lface))))
3560 Lisp_Object xlfd = Ffont_xlfd_name (LFACE_FONT (lface), Qnil);
3561 #ifdef USE_MOTIF
3562 const char *suffix = "List";
3563 Bool motif = True;
3564 #else
3565 #if defined HAVE_X_I18N
3567 const char *suffix = "Set";
3568 #else
3569 const char *suffix = "";
3570 #endif
3571 Bool motif = False;
3572 #endif
3574 if (! NILP (xlfd))
3576 #if defined HAVE_X_I18N
3577 char *fontsetname = xic_create_fontsetname (SSDATA (xlfd), motif);
3578 #else
3579 char *fontsetname = SSDATA (xlfd);
3580 #endif
3581 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*font%s: %s",
3582 myname, suffix, fontsetname);
3583 XrmPutLineResource (&rdb, line);
3585 exprintf (&buf, &bufsize, line, -1, "%s.%s*font%s: %s",
3586 myname, popup_path, suffix, fontsetname);
3587 XrmPutLineResource (&rdb, line);
3588 changed_p = 1;
3589 if (fontsetname != SSDATA (xlfd))
3590 xfree (fontsetname);
3594 if (changed_p && f->output_data.x->menubar_widget)
3595 free_frame_menubar (f);
3597 if (buf != line)
3598 xfree (buf);
3602 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
3605 DEFUN ("face-attribute-relative-p", Fface_attribute_relative_p,
3606 Sface_attribute_relative_p,
3607 2, 2, 0,
3608 doc: /* Check whether a face attribute value is relative.
3609 Specifically, this function returns t if the attribute ATTRIBUTE
3610 with the value VALUE is relative.
3612 A relative value is one that doesn't entirely override whatever is
3613 inherited from another face. For most possible attributes,
3614 the only relative value that users see is `unspecified'.
3615 However, for :height, floating point values are also relative. */)
3616 (Lisp_Object attribute, Lisp_Object value)
3618 if (EQ (value, Qunspecified) || (EQ (value, QCignore_defface)))
3619 return Qt;
3620 else if (EQ (attribute, QCheight))
3621 return INTEGERP (value) ? Qnil : Qt;
3622 else
3623 return Qnil;
3626 DEFUN ("merge-face-attribute", Fmerge_face_attribute, Smerge_face_attribute,
3627 3, 3, 0,
3628 doc: /* Return face ATTRIBUTE VALUE1 merged with VALUE2.
3629 If VALUE1 or VALUE2 are absolute (see `face-attribute-relative-p'), then
3630 the result will be absolute, otherwise it will be relative. */)
3631 (Lisp_Object attribute, Lisp_Object value1, Lisp_Object value2)
3633 if (EQ (value1, Qunspecified) || EQ (value1, QCignore_defface))
3634 return value2;
3635 else if (EQ (attribute, QCheight))
3636 return merge_face_heights (value1, value2, value1);
3637 else
3638 return value1;
3642 DEFUN ("internal-get-lisp-face-attribute", Finternal_get_lisp_face_attribute,
3643 Sinternal_get_lisp_face_attribute,
3644 2, 3, 0,
3645 doc: /* Return face attribute KEYWORD of face SYMBOL.
3646 If SYMBOL does not name a valid Lisp face or KEYWORD isn't a valid
3647 face attribute name, signal an error.
3648 If the optional argument FRAME is given, report on face SYMBOL in that
3649 frame. If FRAME is t, report on the defaults for face SYMBOL (for new
3650 frames). If FRAME is omitted or nil, use the selected frame. */)
3651 (Lisp_Object symbol, Lisp_Object keyword, Lisp_Object frame)
3653 struct frame *f = EQ (frame, Qt) ? NULL : decode_live_frame (frame);
3654 Lisp_Object lface = lface_from_face_name (f, symbol, 1), value = Qnil;
3656 CHECK_SYMBOL (symbol);
3657 CHECK_SYMBOL (keyword);
3659 if (EQ (keyword, QCfamily))
3660 value = LFACE_FAMILY (lface);
3661 else if (EQ (keyword, QCfoundry))
3662 value = LFACE_FOUNDRY (lface);
3663 else if (EQ (keyword, QCheight))
3664 value = LFACE_HEIGHT (lface);
3665 else if (EQ (keyword, QCweight))
3666 value = LFACE_WEIGHT (lface);
3667 else if (EQ (keyword, QCslant))
3668 value = LFACE_SLANT (lface);
3669 else if (EQ (keyword, QCunderline))
3670 value = LFACE_UNDERLINE (lface);
3671 else if (EQ (keyword, QCoverline))
3672 value = LFACE_OVERLINE (lface);
3673 else if (EQ (keyword, QCstrike_through))
3674 value = LFACE_STRIKE_THROUGH (lface);
3675 else if (EQ (keyword, QCbox))
3676 value = LFACE_BOX (lface);
3677 else if (EQ (keyword, QCinverse_video)
3678 || EQ (keyword, QCreverse_video))
3679 value = LFACE_INVERSE (lface);
3680 else if (EQ (keyword, QCforeground))
3681 value = LFACE_FOREGROUND (lface);
3682 else if (EQ (keyword, QCbackground))
3683 value = LFACE_BACKGROUND (lface);
3684 else if (EQ (keyword, QCstipple))
3685 value = LFACE_STIPPLE (lface);
3686 else if (EQ (keyword, QCwidth))
3687 value = LFACE_SWIDTH (lface);
3688 else if (EQ (keyword, QCinherit))
3689 value = LFACE_INHERIT (lface);
3690 else if (EQ (keyword, QCfont))
3691 value = LFACE_FONT (lface);
3692 else if (EQ (keyword, QCfontset))
3693 value = LFACE_FONTSET (lface);
3694 else
3695 signal_error ("Invalid face attribute name", keyword);
3697 if (IGNORE_DEFFACE_P (value))
3698 return Qunspecified;
3700 return value;
3704 DEFUN ("internal-lisp-face-attribute-values",
3705 Finternal_lisp_face_attribute_values,
3706 Sinternal_lisp_face_attribute_values, 1, 1, 0,
3707 doc: /* Return a list of valid discrete values for face attribute ATTR.
3708 Value is nil if ATTR doesn't have a discrete set of valid values. */)
3709 (Lisp_Object attr)
3711 Lisp_Object result = Qnil;
3713 CHECK_SYMBOL (attr);
3715 if (EQ (attr, QCunderline))
3716 result = Fcons (Qt, Fcons (Qnil, Qnil));
3717 else if (EQ (attr, QCoverline))
3718 result = Fcons (Qt, Fcons (Qnil, Qnil));
3719 else if (EQ (attr, QCstrike_through))
3720 result = Fcons (Qt, Fcons (Qnil, Qnil));
3721 else if (EQ (attr, QCinverse_video) || EQ (attr, QCreverse_video))
3722 result = Fcons (Qt, Fcons (Qnil, Qnil));
3724 return result;
3728 DEFUN ("internal-merge-in-global-face", Finternal_merge_in_global_face,
3729 Sinternal_merge_in_global_face, 2, 2, 0,
3730 doc: /* Add attributes from frame-default definition of FACE to FACE on FRAME.
3731 Default face attributes override any local face attributes. */)
3732 (Lisp_Object face, Lisp_Object frame)
3734 int i;
3735 Lisp_Object global_lface, local_lface, *gvec, *lvec;
3736 struct frame *f = XFRAME (frame);
3738 CHECK_LIVE_FRAME (frame);
3739 global_lface = lface_from_face_name (NULL, face, 1);
3740 local_lface = lface_from_face_name (f, face, 0);
3741 if (NILP (local_lface))
3742 local_lface = Finternal_make_lisp_face (face, frame);
3744 /* Make every specified global attribute override the local one.
3745 BEWARE!! This is only used from `face-set-after-frame-default' where
3746 the local frame is defined from default specs in `face-defface-spec'
3747 and those should be overridden by global settings. Hence the strange
3748 "global before local" priority. */
3749 lvec = XVECTOR (local_lface)->contents;
3750 gvec = XVECTOR (global_lface)->contents;
3751 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3752 if (IGNORE_DEFFACE_P (gvec[i]))
3753 ASET (local_lface, i, Qunspecified);
3754 else if (! UNSPECIFIEDP (gvec[i]))
3755 ASET (local_lface, i, AREF (global_lface, i));
3757 /* If the default face was changed, update the face cache and the
3758 `font' frame parameter. */
3759 if (EQ (face, Qdefault))
3761 struct face_cache *c = FRAME_FACE_CACHE (f);
3762 struct face *newface, *oldface = FACE_FROM_ID (f, DEFAULT_FACE_ID);
3763 Lisp_Object attrs[LFACE_VECTOR_SIZE];
3765 /* This can be NULL (e.g., in batch mode). */
3766 if (oldface)
3768 /* Ensure that the face vector is fully specified by merging
3769 the previously-cached vector. */
3770 memcpy (attrs, oldface->lface, sizeof attrs);
3771 merge_face_vectors (f, lvec, attrs, 0);
3772 vcopy (local_lface, 0, attrs, LFACE_VECTOR_SIZE);
3773 newface = realize_face (c, lvec, DEFAULT_FACE_ID);
3775 if ((! UNSPECIFIEDP (gvec[LFACE_FAMILY_INDEX])
3776 || ! UNSPECIFIEDP (gvec[LFACE_FOUNDRY_INDEX])
3777 || ! UNSPECIFIEDP (gvec[LFACE_HEIGHT_INDEX])
3778 || ! UNSPECIFIEDP (gvec[LFACE_WEIGHT_INDEX])
3779 || ! UNSPECIFIEDP (gvec[LFACE_SLANT_INDEX])
3780 || ! UNSPECIFIEDP (gvec[LFACE_SWIDTH_INDEX])
3781 || ! UNSPECIFIEDP (gvec[LFACE_FONT_INDEX]))
3782 && newface->font)
3784 Lisp_Object name = newface->font->props[FONT_NAME_INDEX];
3785 Fmodify_frame_parameters (frame, Fcons (Fcons (Qfont, name),
3786 Qnil));
3789 if (STRINGP (gvec[LFACE_FOREGROUND_INDEX]))
3790 Fmodify_frame_parameters (frame,
3791 Fcons (Fcons (Qforeground_color,
3792 gvec[LFACE_FOREGROUND_INDEX]),
3793 Qnil));
3795 if (STRINGP (gvec[LFACE_BACKGROUND_INDEX]))
3796 Fmodify_frame_parameters (frame,
3797 Fcons (Fcons (Qbackground_color,
3798 gvec[LFACE_BACKGROUND_INDEX]),
3799 Qnil));
3803 return Qnil;
3807 /* The following function is implemented for compatibility with 20.2.
3808 The function is used in x-resolve-fonts when it is asked to
3809 return fonts with the same size as the font of a face. This is
3810 done in fontset.el. */
3812 DEFUN ("face-font", Fface_font, Sface_font, 1, 3, 0,
3813 doc: /* Return the font name of face FACE, or nil if it is unspecified.
3814 The font name is, by default, for ASCII characters.
3815 If the optional argument FRAME is given, report on face FACE in that frame.
3816 If FRAME is t, report on the defaults for face FACE (for new frames).
3817 The font default for a face is either nil, or a list
3818 of the form (bold), (italic) or (bold italic).
3819 If FRAME is omitted or nil, use the selected frame. And, in this case,
3820 if the optional third argument CHARACTER is given,
3821 return the font name used for CHARACTER. */)
3822 (Lisp_Object face, Lisp_Object frame, Lisp_Object character)
3824 if (EQ (frame, Qt))
3826 Lisp_Object result = Qnil;
3827 Lisp_Object lface = lface_from_face_name (NULL, face, 1);
3829 if (!UNSPECIFIEDP (LFACE_WEIGHT (lface))
3830 && !EQ (LFACE_WEIGHT (lface), Qnormal))
3831 result = Fcons (Qbold, result);
3833 if (!UNSPECIFIEDP (LFACE_SLANT (lface))
3834 && !EQ (LFACE_SLANT (lface), Qnormal))
3835 result = Fcons (Qitalic, result);
3837 return result;
3839 else
3841 struct frame *f = decode_live_frame (frame);
3842 int face_id = lookup_named_face (f, face, 1);
3843 struct face *fface = FACE_FROM_ID (f, face_id);
3845 if (! fface)
3846 return Qnil;
3847 #ifdef HAVE_WINDOW_SYSTEM
3848 if (FRAME_WINDOW_P (f) && !NILP (character))
3850 CHECK_CHARACTER (character);
3851 face_id = FACE_FOR_CHAR (f, fface, XINT (character), -1, Qnil);
3852 fface = FACE_FROM_ID (f, face_id);
3854 return (fface->font
3855 ? fface->font->props[FONT_NAME_INDEX]
3856 : Qnil);
3857 #else /* !HAVE_WINDOW_SYSTEM */
3858 return build_string (FRAME_MSDOS_P (f)
3859 ? "ms-dos"
3860 : FRAME_W32_P (f) ? "w32term"
3861 :"tty");
3862 #endif
3867 /* Compare face-attribute values v1 and v2 for equality. Value is non-zero if
3868 all attributes are `equal'. Tries to be fast because this function
3869 is called quite often. */
3871 static int
3872 face_attr_equal_p (Lisp_Object v1, Lisp_Object v2)
3874 /* Type can differ, e.g. when one attribute is unspecified, i.e. nil,
3875 and the other is specified. */
3876 if (XTYPE (v1) != XTYPE (v2))
3877 return 0;
3879 if (EQ (v1, v2))
3880 return 1;
3882 switch (XTYPE (v1))
3884 case Lisp_String:
3885 if (SBYTES (v1) != SBYTES (v2))
3886 return 0;
3888 return memcmp (SDATA (v1), SDATA (v2), SBYTES (v1)) == 0;
3890 case_Lisp_Int:
3891 case Lisp_Symbol:
3892 return 0;
3894 default:
3895 return !NILP (Fequal (v1, v2));
3900 /* Compare face vectors V1 and V2 for equality. Value is non-zero if
3901 all attributes are `equal'. Tries to be fast because this function
3902 is called quite often. */
3904 static int
3905 lface_equal_p (Lisp_Object *v1, Lisp_Object *v2)
3907 int i, equal_p = 1;
3909 for (i = 1; i < LFACE_VECTOR_SIZE && equal_p; ++i)
3910 equal_p = face_attr_equal_p (v1[i], v2[i]);
3912 return equal_p;
3916 DEFUN ("internal-lisp-face-equal-p", Finternal_lisp_face_equal_p,
3917 Sinternal_lisp_face_equal_p, 2, 3, 0,
3918 doc: /* True if FACE1 and FACE2 are equal.
3919 If the optional argument FRAME is given, report on FACE1 and FACE2 in that frame.
3920 If FRAME is t, report on the defaults for FACE1 and FACE2 (for new frames).
3921 If FRAME is omitted or nil, use the selected frame. */)
3922 (Lisp_Object face1, Lisp_Object face2, Lisp_Object frame)
3924 int equal_p;
3925 struct frame *f;
3926 Lisp_Object lface1, lface2;
3928 /* Don't use check_x_frame here because this function is called
3929 before X frames exist. At that time, if FRAME is nil,
3930 selected_frame will be used which is the frame dumped with
3931 Emacs. That frame is not an X frame. */
3932 f = EQ (frame, Qt) ? NULL : decode_live_frame (frame);
3934 lface1 = lface_from_face_name (f, face1, 1);
3935 lface2 = lface_from_face_name (f, face2, 1);
3936 equal_p = lface_equal_p (XVECTOR (lface1)->contents,
3937 XVECTOR (lface2)->contents);
3938 return equal_p ? Qt : Qnil;
3942 DEFUN ("internal-lisp-face-empty-p", Finternal_lisp_face_empty_p,
3943 Sinternal_lisp_face_empty_p, 1, 2, 0,
3944 doc: /* True if FACE has no attribute specified.
3945 If the optional argument FRAME is given, report on face FACE in that frame.
3946 If FRAME is t, report on the defaults for face FACE (for new frames).
3947 If FRAME is omitted or nil, use the selected frame. */)
3948 (Lisp_Object face, Lisp_Object frame)
3950 struct frame *f = EQ (frame, Qt) ? NULL : decode_live_frame (frame);
3951 Lisp_Object lface = lface_from_face_name (f, face, 1);
3952 int i;
3954 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3955 if (!UNSPECIFIEDP (AREF (lface, i)))
3956 break;
3958 return i == LFACE_VECTOR_SIZE ? Qt : Qnil;
3962 DEFUN ("frame-face-alist", Fframe_face_alist, Sframe_face_alist,
3963 0, 1, 0,
3964 doc: /* Return an alist of frame-local faces defined on FRAME.
3965 For internal use only. */)
3966 (Lisp_Object frame)
3968 return decode_live_frame (frame)->face_alist;
3972 /* Return a hash code for Lisp string STRING with case ignored. Used
3973 below in computing a hash value for a Lisp face. */
3975 static unsigned
3976 hash_string_case_insensitive (Lisp_Object string)
3978 const unsigned char *s;
3979 unsigned hash = 0;
3980 eassert (STRINGP (string));
3981 for (s = SDATA (string); *s; ++s)
3982 hash = (hash << 1) ^ c_tolower (*s);
3983 return hash;
3987 /* Return a hash code for face attribute vector V. */
3989 static unsigned
3990 lface_hash (Lisp_Object *v)
3992 return (hash_string_case_insensitive (v[LFACE_FAMILY_INDEX])
3993 ^ hash_string_case_insensitive (v[LFACE_FOUNDRY_INDEX])
3994 ^ hash_string_case_insensitive (v[LFACE_FOREGROUND_INDEX])
3995 ^ hash_string_case_insensitive (v[LFACE_BACKGROUND_INDEX])
3996 ^ XHASH (v[LFACE_WEIGHT_INDEX])
3997 ^ XHASH (v[LFACE_SLANT_INDEX])
3998 ^ XHASH (v[LFACE_SWIDTH_INDEX])
3999 ^ XHASH (v[LFACE_HEIGHT_INDEX]));
4003 /* Return non-zero if LFACE1 and LFACE2 specify the same font (without
4004 considering charsets/registries). They do if they specify the same
4005 family, point size, weight, width, slant, and font. Both
4006 LFACE1 and LFACE2 must be fully-specified. */
4008 static int
4009 lface_same_font_attributes_p (Lisp_Object *lface1, Lisp_Object *lface2)
4011 eassert (lface_fully_specified_p (lface1)
4012 && lface_fully_specified_p (lface2));
4013 return (xstrcasecmp (SSDATA (lface1[LFACE_FAMILY_INDEX]),
4014 SSDATA (lface2[LFACE_FAMILY_INDEX])) == 0
4015 && xstrcasecmp (SSDATA (lface1[LFACE_FOUNDRY_INDEX]),
4016 SSDATA (lface2[LFACE_FOUNDRY_INDEX])) == 0
4017 && EQ (lface1[LFACE_HEIGHT_INDEX], lface2[LFACE_HEIGHT_INDEX])
4018 && EQ (lface1[LFACE_SWIDTH_INDEX], lface2[LFACE_SWIDTH_INDEX])
4019 && EQ (lface1[LFACE_WEIGHT_INDEX], lface2[LFACE_WEIGHT_INDEX])
4020 && EQ (lface1[LFACE_SLANT_INDEX], lface2[LFACE_SLANT_INDEX])
4021 && EQ (lface1[LFACE_FONT_INDEX], lface2[LFACE_FONT_INDEX])
4022 && (EQ (lface1[LFACE_FONTSET_INDEX], lface2[LFACE_FONTSET_INDEX])
4023 || (STRINGP (lface1[LFACE_FONTSET_INDEX])
4024 && STRINGP (lface2[LFACE_FONTSET_INDEX])
4025 && ! xstrcasecmp (SSDATA (lface1[LFACE_FONTSET_INDEX]),
4026 SSDATA (lface2[LFACE_FONTSET_INDEX]))))
4032 /***********************************************************************
4033 Realized Faces
4034 ***********************************************************************/
4036 /* Allocate and return a new realized face for Lisp face attribute
4037 vector ATTR. */
4039 static struct face *
4040 make_realized_face (Lisp_Object *attr)
4042 struct face *face = xzalloc (sizeof *face);
4043 face->ascii_face = face;
4044 memcpy (face->lface, attr, sizeof face->lface);
4045 return face;
4049 /* Free realized face FACE, including its X resources. FACE may
4050 be null. */
4052 static void
4053 free_realized_face (struct frame *f, struct face *face)
4055 if (face)
4057 #ifdef HAVE_WINDOW_SYSTEM
4058 if (FRAME_WINDOW_P (f))
4060 /* Free fontset of FACE if it is ASCII face. */
4061 if (face->fontset >= 0 && face == face->ascii_face)
4062 free_face_fontset (f, face);
4063 if (face->gc)
4065 block_input ();
4066 if (face->font)
4067 font_done_for_face (f, face);
4068 x_free_gc (f, face->gc);
4069 face->gc = 0;
4070 unblock_input ();
4073 free_face_colors (f, face);
4074 x_destroy_bitmap (f, face->stipple);
4076 #endif /* HAVE_WINDOW_SYSTEM */
4078 xfree (face);
4083 /* Prepare face FACE for subsequent display on frame F. This
4084 allocated GCs if they haven't been allocated yet or have been freed
4085 by clearing the face cache. */
4087 void
4088 prepare_face_for_display (struct frame *f, struct face *face)
4090 #ifdef HAVE_WINDOW_SYSTEM
4091 eassert (FRAME_WINDOW_P (f));
4093 if (face->gc == 0)
4095 XGCValues xgcv;
4096 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
4098 xgcv.foreground = face->foreground;
4099 xgcv.background = face->background;
4100 #ifdef HAVE_X_WINDOWS
4101 xgcv.graphics_exposures = False;
4102 #endif
4104 block_input ();
4105 #ifdef HAVE_X_WINDOWS
4106 if (face->stipple)
4108 xgcv.fill_style = FillOpaqueStippled;
4109 xgcv.stipple = x_bitmap_pixmap (f, face->stipple);
4110 mask |= GCFillStyle | GCStipple;
4112 #endif
4113 face->gc = x_create_gc (f, mask, &xgcv);
4114 if (face->font)
4115 font_prepare_for_face (f, face);
4116 unblock_input ();
4118 #endif /* HAVE_WINDOW_SYSTEM */
4122 /* Returns the `distance' between the colors X and Y. */
4124 static int
4125 color_distance (XColor *x, XColor *y)
4127 /* This formula is from a paper titled `Colour metric' by Thiadmer Riemersma.
4128 Quoting from that paper:
4130 This formula has results that are very close to L*u*v* (with the
4131 modified lightness curve) and, more importantly, it is a more even
4132 algorithm: it does not have a range of colors where it suddenly
4133 gives far from optimal results.
4135 See <http://www.compuphase.com/cmetric.htm> for more info. */
4137 long r = (x->red - y->red) >> 8;
4138 long g = (x->green - y->green) >> 8;
4139 long b = (x->blue - y->blue) >> 8;
4140 long r_mean = (x->red + y->red) >> 9;
4142 return
4143 (((512 + r_mean) * r * r) >> 8)
4144 + 4 * g * g
4145 + (((767 - r_mean) * b * b) >> 8);
4149 DEFUN ("color-distance", Fcolor_distance, Scolor_distance, 2, 3, 0,
4150 doc: /* Return an integer distance between COLOR1 and COLOR2 on FRAME.
4151 COLOR1 and COLOR2 may be either strings containing the color name,
4152 or lists of the form (RED GREEN BLUE).
4153 If FRAME is unspecified or nil, the current frame is used. */)
4154 (Lisp_Object color1, Lisp_Object color2, Lisp_Object frame)
4156 struct frame *f = decode_live_frame (frame);
4157 XColor cdef1, cdef2;
4159 if (!(CONSP (color1) && parse_rgb_list (color1, &cdef1))
4160 && !(STRINGP (color1) && defined_color (f, SSDATA (color1), &cdef1, 0)))
4161 signal_error ("Invalid color", color1);
4162 if (!(CONSP (color2) && parse_rgb_list (color2, &cdef2))
4163 && !(STRINGP (color2) && defined_color (f, SSDATA (color2), &cdef2, 0)))
4164 signal_error ("Invalid color", color2);
4166 return make_number (color_distance (&cdef1, &cdef2));
4170 /***********************************************************************
4171 Face Cache
4172 ***********************************************************************/
4174 /* Return a new face cache for frame F. */
4176 static struct face_cache *
4177 make_face_cache (struct frame *f)
4179 struct face_cache *c;
4180 int size;
4182 c = xzalloc (sizeof *c);
4183 size = FACE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
4184 c->buckets = xzalloc (size);
4185 c->size = 50;
4186 c->faces_by_id = xmalloc (c->size * sizeof *c->faces_by_id);
4187 c->f = f;
4188 c->menu_face_changed_p = menu_face_changed_default;
4189 return c;
4193 /* Clear out all graphics contexts for all realized faces, except for
4194 the basic faces. This should be done from time to time just to avoid
4195 keeping too many graphics contexts that are no longer needed. */
4197 static void
4198 clear_face_gcs (struct face_cache *c)
4200 if (c && FRAME_WINDOW_P (c->f))
4202 #ifdef HAVE_WINDOW_SYSTEM
4203 int i;
4204 for (i = BASIC_FACE_ID_SENTINEL; i < c->used; ++i)
4206 struct face *face = c->faces_by_id[i];
4207 if (face && face->gc)
4209 block_input ();
4210 if (face->font)
4211 font_done_for_face (c->f, face);
4212 x_free_gc (c->f, face->gc);
4213 face->gc = 0;
4214 unblock_input ();
4217 #endif /* HAVE_WINDOW_SYSTEM */
4222 /* Free all realized faces in face cache C, including basic faces.
4223 C may be null. If faces are freed, make sure the frame's current
4224 matrix is marked invalid, so that a display caused by an expose
4225 event doesn't try to use faces we destroyed. */
4227 static void
4228 free_realized_faces (struct face_cache *c)
4230 if (c && c->used)
4232 int i, size;
4233 struct frame *f = c->f;
4235 /* We must block input here because we can't process X events
4236 safely while only some faces are freed, or when the frame's
4237 current matrix still references freed faces. */
4238 block_input ();
4240 for (i = 0; i < c->used; ++i)
4242 free_realized_face (f, c->faces_by_id[i]);
4243 c->faces_by_id[i] = NULL;
4246 c->used = 0;
4247 size = FACE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
4248 memset (c->buckets, 0, size);
4250 /* Must do a thorough redisplay the next time. Mark current
4251 matrices as invalid because they will reference faces freed
4252 above. This function is also called when a frame is
4253 destroyed. In this case, the root window of F is nil. */
4254 if (WINDOWP (f->root_window))
4256 clear_current_matrices (f);
4257 ++windows_or_buffers_changed;
4260 unblock_input ();
4265 /* Free all realized faces on FRAME or on all frames if FRAME is nil.
4266 This is done after attributes of a named face have been changed,
4267 because we can't tell which realized faces depend on that face. */
4269 void
4270 free_all_realized_faces (Lisp_Object frame)
4272 if (NILP (frame))
4274 Lisp_Object rest;
4275 FOR_EACH_FRAME (rest, frame)
4276 free_realized_faces (FRAME_FACE_CACHE (XFRAME (frame)));
4278 else
4279 free_realized_faces (FRAME_FACE_CACHE (XFRAME (frame)));
4283 /* Free face cache C and faces in it, including their X resources. */
4285 static void
4286 free_face_cache (struct face_cache *c)
4288 if (c)
4290 free_realized_faces (c);
4291 xfree (c->buckets);
4292 xfree (c->faces_by_id);
4293 xfree (c);
4298 /* Cache realized face FACE in face cache C. HASH is the hash value
4299 of FACE. If FACE is for ASCII characters (i.e. FACE->ascii_face ==
4300 FACE), insert the new face to the beginning of the collision list
4301 of the face hash table of C. Otherwise, add the new face to the
4302 end of the collision list. This way, lookup_face can quickly find
4303 that a requested face is not cached. */
4305 static void
4306 cache_face (struct face_cache *c, struct face *face, unsigned int hash)
4308 int i = hash % FACE_CACHE_BUCKETS_SIZE;
4310 face->hash = hash;
4312 if (face->ascii_face != face)
4314 struct face *last = c->buckets[i];
4315 if (last)
4317 while (last->next)
4318 last = last->next;
4319 last->next = face;
4320 face->prev = last;
4321 face->next = NULL;
4323 else
4325 c->buckets[i] = face;
4326 face->prev = face->next = NULL;
4329 else
4331 face->prev = NULL;
4332 face->next = c->buckets[i];
4333 if (face->next)
4334 face->next->prev = face;
4335 c->buckets[i] = face;
4338 /* Find a free slot in C->faces_by_id and use the index of the free
4339 slot as FACE->id. */
4340 for (i = 0; i < c->used; ++i)
4341 if (c->faces_by_id[i] == NULL)
4342 break;
4343 face->id = i;
4345 #ifdef GLYPH_DEBUG
4346 /* Check that FACE got a unique id. */
4348 int j, n;
4349 struct face *face1;
4351 for (j = n = 0; j < FACE_CACHE_BUCKETS_SIZE; ++j)
4352 for (face1 = c->buckets[j]; face1; face1 = face1->next)
4353 if (face1->id == i)
4354 ++n;
4356 eassert (n == 1);
4358 #endif /* GLYPH_DEBUG */
4360 /* Maybe enlarge C->faces_by_id. */
4361 if (i == c->used)
4363 if (c->used == c->size)
4364 c->faces_by_id = xpalloc (c->faces_by_id, &c->size, 1, MAX_FACE_ID,
4365 sizeof *c->faces_by_id);
4366 c->used++;
4369 c->faces_by_id[i] = face;
4373 /* Remove face FACE from cache C. */
4375 static void
4376 uncache_face (struct face_cache *c, struct face *face)
4378 int i = face->hash % FACE_CACHE_BUCKETS_SIZE;
4380 if (face->prev)
4381 face->prev->next = face->next;
4382 else
4383 c->buckets[i] = face->next;
4385 if (face->next)
4386 face->next->prev = face->prev;
4388 c->faces_by_id[face->id] = NULL;
4389 if (face->id == c->used)
4390 --c->used;
4394 /* Look up a realized face with face attributes ATTR in the face cache
4395 of frame F. The face will be used to display ASCII characters.
4396 Value is the ID of the face found. If no suitable face is found,
4397 realize a new one. */
4399 static int
4400 lookup_face (struct frame *f, Lisp_Object *attr)
4402 struct face_cache *cache = FRAME_FACE_CACHE (f);
4403 unsigned hash;
4404 int i;
4405 struct face *face;
4407 eassert (cache != NULL);
4408 check_lface_attrs (attr);
4410 /* Look up ATTR in the face cache. */
4411 hash = lface_hash (attr);
4412 i = hash % FACE_CACHE_BUCKETS_SIZE;
4414 for (face = cache->buckets[i]; face; face = face->next)
4416 if (face->ascii_face != face)
4418 /* There's no more ASCII face. */
4419 face = NULL;
4420 break;
4422 if (face->hash == hash
4423 && lface_equal_p (face->lface, attr))
4424 break;
4427 /* If not found, realize a new face. */
4428 if (face == NULL)
4429 face = realize_face (cache, attr, -1);
4431 #ifdef GLYPH_DEBUG
4432 eassert (face == FACE_FROM_ID (f, face->id));
4433 #endif /* GLYPH_DEBUG */
4435 return face->id;
4438 #ifdef HAVE_WINDOW_SYSTEM
4439 /* Look up a realized face that has the same attributes as BASE_FACE
4440 except for the font in the face cache of frame F. If FONT-OBJECT
4441 is not nil, it is an already opened font. If FONT-OBJECT is nil,
4442 the face has no font. Value is the ID of the face found. If no
4443 suitable face is found, realize a new one. */
4446 face_for_font (struct frame *f, Lisp_Object font_object, struct face *base_face)
4448 struct face_cache *cache = FRAME_FACE_CACHE (f);
4449 unsigned hash;
4450 int i;
4451 struct face *face;
4453 eassert (cache != NULL);
4454 base_face = base_face->ascii_face;
4455 hash = lface_hash (base_face->lface);
4456 i = hash % FACE_CACHE_BUCKETS_SIZE;
4458 for (face = cache->buckets[i]; face; face = face->next)
4460 if (face->ascii_face == face)
4461 continue;
4462 if (face->ascii_face == base_face
4463 && face->font == (NILP (font_object) ? NULL
4464 : XFONT_OBJECT (font_object))
4465 && lface_equal_p (face->lface, base_face->lface))
4466 return face->id;
4469 /* If not found, realize a new face. */
4470 face = realize_non_ascii_face (f, font_object, base_face);
4471 return face->id;
4473 #endif /* HAVE_WINDOW_SYSTEM */
4475 /* Return the face id of the realized face for named face SYMBOL on
4476 frame F suitable for displaying ASCII characters. Value is -1 if
4477 the face couldn't be determined, which might happen if the default
4478 face isn't realized and cannot be realized. */
4481 lookup_named_face (struct frame *f, Lisp_Object symbol, int signal_p)
4483 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4484 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
4485 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
4487 if (default_face == NULL)
4489 if (!realize_basic_faces (f))
4490 return -1;
4491 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
4492 if (default_face == NULL)
4493 emacs_abort (); /* realize_basic_faces must have set it up */
4496 if (! get_lface_attributes (f, symbol, symbol_attrs, signal_p, 0))
4497 return -1;
4499 memcpy (attrs, default_face->lface, sizeof attrs);
4500 merge_face_vectors (f, symbol_attrs, attrs, 0);
4502 return lookup_face (f, attrs);
4506 /* Return the display face-id of the basic face whose canonical face-id
4507 is FACE_ID. The return value will usually simply be FACE_ID, unless that
4508 basic face has bee remapped via Vface_remapping_alist. This function is
4509 conservative: if something goes wrong, it will simply return FACE_ID
4510 rather than signal an error. */
4513 lookup_basic_face (struct frame *f, int face_id)
4515 Lisp_Object name, mapping;
4516 int remapped_face_id;
4518 if (NILP (Vface_remapping_alist))
4519 return face_id; /* Nothing to do. */
4521 switch (face_id)
4523 case DEFAULT_FACE_ID: name = Qdefault; break;
4524 case MODE_LINE_FACE_ID: name = Qmode_line; break;
4525 case MODE_LINE_INACTIVE_FACE_ID: name = Qmode_line_inactive; break;
4526 case HEADER_LINE_FACE_ID: name = Qheader_line; break;
4527 case TOOL_BAR_FACE_ID: name = Qtool_bar; break;
4528 case FRINGE_FACE_ID: name = Qfringe; break;
4529 case SCROLL_BAR_FACE_ID: name = Qscroll_bar; break;
4530 case BORDER_FACE_ID: name = Qborder; break;
4531 case CURSOR_FACE_ID: name = Qcursor; break;
4532 case MOUSE_FACE_ID: name = Qmouse; break;
4533 case MENU_FACE_ID: name = Qmenu; break;
4535 default:
4536 emacs_abort (); /* the caller is supposed to pass us a basic face id */
4539 /* Do a quick scan through Vface_remapping_alist, and return immediately
4540 if there is no remapping for face NAME. This is just an optimization
4541 for the very common no-remapping case. */
4542 mapping = assq_no_quit (name, Vface_remapping_alist);
4543 if (NILP (mapping))
4544 return face_id; /* Give up. */
4546 /* If there is a remapping entry, lookup the face using NAME, which will
4547 handle the remapping too. */
4548 remapped_face_id = lookup_named_face (f, name, 0);
4549 if (remapped_face_id < 0)
4550 return face_id; /* Give up. */
4552 return remapped_face_id;
4556 /* Return a face for charset ASCII that is like the face with id
4557 FACE_ID on frame F, but has a font that is STEPS steps smaller.
4558 STEPS < 0 means larger. Value is the id of the face. */
4561 smaller_face (struct frame *f, int face_id, int steps)
4563 #ifdef HAVE_WINDOW_SYSTEM
4564 struct face *face;
4565 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4566 int pt, last_pt, last_height;
4567 int delta;
4568 int new_face_id;
4569 struct face *new_face;
4571 /* If not called for an X frame, just return the original face. */
4572 if (FRAME_TERMCAP_P (f))
4573 return face_id;
4575 /* Try in increments of 1/2 pt. */
4576 delta = steps < 0 ? 5 : -5;
4577 steps = eabs (steps);
4579 face = FACE_FROM_ID (f, face_id);
4580 memcpy (attrs, face->lface, sizeof attrs);
4581 pt = last_pt = XFASTINT (attrs[LFACE_HEIGHT_INDEX]);
4582 new_face_id = face_id;
4583 last_height = FONT_HEIGHT (face->font);
4585 while (steps
4586 && pt + delta > 0
4587 /* Give up if we cannot find a font within 10pt. */
4588 && eabs (last_pt - pt) < 100)
4590 /* Look up a face for a slightly smaller/larger font. */
4591 pt += delta;
4592 attrs[LFACE_HEIGHT_INDEX] = make_number (pt);
4593 new_face_id = lookup_face (f, attrs);
4594 new_face = FACE_FROM_ID (f, new_face_id);
4596 /* If height changes, count that as one step. */
4597 if ((delta < 0 && FONT_HEIGHT (new_face->font) < last_height)
4598 || (delta > 0 && FONT_HEIGHT (new_face->font) > last_height))
4600 --steps;
4601 last_height = FONT_HEIGHT (new_face->font);
4602 last_pt = pt;
4606 return new_face_id;
4608 #else /* not HAVE_WINDOW_SYSTEM */
4610 return face_id;
4612 #endif /* not HAVE_WINDOW_SYSTEM */
4616 /* Return a face for charset ASCII that is like the face with id
4617 FACE_ID on frame F, but has height HEIGHT. */
4620 face_with_height (struct frame *f, int face_id, int height)
4622 #ifdef HAVE_WINDOW_SYSTEM
4623 struct face *face;
4624 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4626 if (FRAME_TERMCAP_P (f)
4627 || height <= 0)
4628 return face_id;
4630 face = FACE_FROM_ID (f, face_id);
4631 memcpy (attrs, face->lface, sizeof attrs);
4632 attrs[LFACE_HEIGHT_INDEX] = make_number (height);
4633 font_clear_prop (attrs, FONT_SIZE_INDEX);
4634 face_id = lookup_face (f, attrs);
4635 #endif /* HAVE_WINDOW_SYSTEM */
4637 return face_id;
4641 /* Return the face id of the realized face for named face SYMBOL on
4642 frame F suitable for displaying ASCII characters, and use
4643 attributes of the face FACE_ID for attributes that aren't
4644 completely specified by SYMBOL. This is like lookup_named_face,
4645 except that the default attributes come from FACE_ID, not from the
4646 default face. FACE_ID is assumed to be already realized. */
4649 lookup_derived_face (struct frame *f, Lisp_Object symbol, int face_id,
4650 int signal_p)
4652 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4653 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
4654 struct face *default_face = FACE_FROM_ID (f, face_id);
4656 if (!default_face)
4657 emacs_abort ();
4659 if (!get_lface_attributes (f, symbol, symbol_attrs, signal_p, 0))
4660 return -1;
4662 memcpy (attrs, default_face->lface, sizeof attrs);
4663 merge_face_vectors (f, symbol_attrs, attrs, 0);
4664 return lookup_face (f, attrs);
4667 DEFUN ("face-attributes-as-vector", Fface_attributes_as_vector,
4668 Sface_attributes_as_vector, 1, 1, 0,
4669 doc: /* Return a vector of face attributes corresponding to PLIST. */)
4670 (Lisp_Object plist)
4672 Lisp_Object lface;
4673 lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
4674 Qunspecified);
4675 merge_face_ref (XFRAME (selected_frame), plist, XVECTOR (lface)->contents,
4676 1, 0);
4677 return lface;
4682 /***********************************************************************
4683 Face capability testing
4684 ***********************************************************************/
4687 /* If the distance (as returned by color_distance) between two colors is
4688 less than this, then they are considered the same, for determining
4689 whether a color is supported or not. The range of values is 0-65535. */
4691 #define TTY_SAME_COLOR_THRESHOLD 10000
4693 #ifdef HAVE_WINDOW_SYSTEM
4695 /* Return non-zero if all the face attributes in ATTRS are supported
4696 on the window-system frame F.
4698 The definition of `supported' is somewhat heuristic, but basically means
4699 that a face containing all the attributes in ATTRS, when merged with the
4700 default face for display, can be represented in a way that's
4702 \(1) different in appearance than the default face, and
4703 \(2) `close in spirit' to what the attributes specify, if not exact. */
4705 static int
4706 x_supports_face_attributes_p (struct frame *f,
4707 Lisp_Object attrs[LFACE_VECTOR_SIZE],
4708 struct face *def_face)
4710 Lisp_Object *def_attrs = def_face->lface;
4712 /* Check that other specified attributes are different that the default
4713 face. */
4714 if ((!UNSPECIFIEDP (attrs[LFACE_UNDERLINE_INDEX])
4715 && face_attr_equal_p (attrs[LFACE_UNDERLINE_INDEX],
4716 def_attrs[LFACE_UNDERLINE_INDEX]))
4717 || (!UNSPECIFIEDP (attrs[LFACE_INVERSE_INDEX])
4718 && face_attr_equal_p (attrs[LFACE_INVERSE_INDEX],
4719 def_attrs[LFACE_INVERSE_INDEX]))
4720 || (!UNSPECIFIEDP (attrs[LFACE_FOREGROUND_INDEX])
4721 && face_attr_equal_p (attrs[LFACE_FOREGROUND_INDEX],
4722 def_attrs[LFACE_FOREGROUND_INDEX]))
4723 || (!UNSPECIFIEDP (attrs[LFACE_BACKGROUND_INDEX])
4724 && face_attr_equal_p (attrs[LFACE_BACKGROUND_INDEX],
4725 def_attrs[LFACE_BACKGROUND_INDEX]))
4726 || (!UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
4727 && face_attr_equal_p (attrs[LFACE_STIPPLE_INDEX],
4728 def_attrs[LFACE_STIPPLE_INDEX]))
4729 || (!UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
4730 && face_attr_equal_p (attrs[LFACE_OVERLINE_INDEX],
4731 def_attrs[LFACE_OVERLINE_INDEX]))
4732 || (!UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
4733 && face_attr_equal_p (attrs[LFACE_STRIKE_THROUGH_INDEX],
4734 def_attrs[LFACE_STRIKE_THROUGH_INDEX]))
4735 || (!UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
4736 && face_attr_equal_p (attrs[LFACE_BOX_INDEX],
4737 def_attrs[LFACE_BOX_INDEX])))
4738 return 0;
4740 /* Check font-related attributes, as those are the most commonly
4741 "unsupported" on a window-system (because of missing fonts). */
4742 if (!UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
4743 || !UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
4744 || !UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
4745 || !UNSPECIFIEDP (attrs[LFACE_WEIGHT_INDEX])
4746 || !UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX])
4747 || !UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX]))
4749 int face_id;
4750 struct face *face;
4751 Lisp_Object merged_attrs[LFACE_VECTOR_SIZE];
4752 int i;
4754 memcpy (merged_attrs, def_attrs, sizeof merged_attrs);
4756 merge_face_vectors (f, attrs, merged_attrs, 0);
4758 face_id = lookup_face (f, merged_attrs);
4759 face = FACE_FROM_ID (f, face_id);
4761 if (! face)
4762 error ("Cannot make face");
4764 /* If the font is the same, or no font is found, then not
4765 supported. */
4766 if (face->font == def_face->font
4767 || ! face->font)
4768 return 0;
4769 for (i = FONT_TYPE_INDEX; i <= FONT_SIZE_INDEX; i++)
4770 if (! EQ (face->font->props[i], def_face->font->props[i]))
4772 Lisp_Object s1, s2;
4774 if (i < FONT_FOUNDRY_INDEX || i > FONT_REGISTRY_INDEX
4775 || face->font->driver->case_sensitive)
4776 return 1;
4777 s1 = SYMBOL_NAME (face->font->props[i]);
4778 s2 = SYMBOL_NAME (def_face->font->props[i]);
4779 if (! EQ (Fcompare_strings (s1, make_number (0), Qnil,
4780 s2, make_number (0), Qnil, Qt), Qt))
4781 return 1;
4783 return 0;
4786 /* Everything checks out, this face is supported. */
4787 return 1;
4790 #endif /* HAVE_WINDOW_SYSTEM */
4792 /* Return non-zero if all the face attributes in ATTRS are supported
4793 on the tty frame F.
4795 The definition of `supported' is somewhat heuristic, but basically means
4796 that a face containing all the attributes in ATTRS, when merged
4797 with the default face for display, can be represented in a way that's
4799 \(1) different in appearance than the default face, and
4800 \(2) `close in spirit' to what the attributes specify, if not exact.
4802 Point (2) implies that a `:weight black' attribute will be satisfied
4803 by any terminal that can display bold, and a `:foreground "yellow"' as
4804 long as the terminal can display a yellowish color, but `:slant italic'
4805 will _not_ be satisfied by the tty display code's automatic
4806 substitution of a `dim' face for italic. */
4808 static int
4809 tty_supports_face_attributes_p (struct frame *f,
4810 Lisp_Object attrs[LFACE_VECTOR_SIZE],
4811 struct face *def_face)
4813 int weight, slant;
4814 Lisp_Object val, fg, bg;
4815 XColor fg_tty_color, fg_std_color;
4816 XColor bg_tty_color, bg_std_color;
4817 unsigned test_caps = 0;
4818 Lisp_Object *def_attrs = def_face->lface;
4820 /* First check some easy-to-check stuff; ttys support none of the
4821 following attributes, so we can just return false if any are requested
4822 (even if `nominal' values are specified, we should still return false,
4823 as that will be the same value that the default face uses). We
4824 consider :slant unsupportable on ttys, even though the face code
4825 actually `fakes' them using a dim attribute if possible. This is
4826 because the faked result is too different from what the face
4827 specifies. */
4828 if (!UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
4829 || !UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
4830 || !UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
4831 || !UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
4832 || !UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
4833 || !UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
4834 || !UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
4835 || !UNSPECIFIEDP (attrs[LFACE_BOX_INDEX]))
4836 return 0;
4838 /* Test for terminal `capabilities' (non-color character attributes). */
4840 /* font weight (bold/dim) */
4841 val = attrs[LFACE_WEIGHT_INDEX];
4842 if (!UNSPECIFIEDP (val)
4843 && (weight = FONT_WEIGHT_NAME_NUMERIC (val), weight >= 0))
4845 int def_weight = FONT_WEIGHT_NAME_NUMERIC (def_attrs[LFACE_WEIGHT_INDEX]);
4847 if (weight > 100)
4849 if (def_weight > 100)
4850 return 0; /* same as default */
4851 test_caps = TTY_CAP_BOLD;
4853 else if (weight < 100)
4855 if (def_weight < 100)
4856 return 0; /* same as default */
4857 test_caps = TTY_CAP_DIM;
4859 else if (def_weight == 100)
4860 return 0; /* same as default */
4863 /* font slant */
4864 val = attrs[LFACE_SLANT_INDEX];
4865 if (!UNSPECIFIEDP (val)
4866 && (slant = FONT_SLANT_NAME_NUMERIC (val), slant >= 0))
4868 int def_slant = FONT_SLANT_NAME_NUMERIC (def_attrs[LFACE_SLANT_INDEX]);
4869 if (slant == 100 || slant == def_slant)
4870 return 0; /* same as default */
4871 else
4872 test_caps |= TTY_CAP_ITALIC;
4875 /* underlining */
4876 val = attrs[LFACE_UNDERLINE_INDEX];
4877 if (!UNSPECIFIEDP (val))
4879 if (STRINGP (val))
4880 return 0; /* ttys can't use colored underlines */
4881 else if (EQ (CAR_SAFE (val), QCstyle) && EQ (CAR_SAFE (CDR_SAFE (val)), Qwave))
4882 return 0; /* ttys can't use wave underlines */
4883 else if (face_attr_equal_p (val, def_attrs[LFACE_UNDERLINE_INDEX]))
4884 return 0; /* same as default */
4885 else
4886 test_caps |= TTY_CAP_UNDERLINE;
4889 /* inverse video */
4890 val = attrs[LFACE_INVERSE_INDEX];
4891 if (!UNSPECIFIEDP (val))
4893 if (face_attr_equal_p (val, def_attrs[LFACE_INVERSE_INDEX]))
4894 return 0; /* same as default */
4895 else
4896 test_caps |= TTY_CAP_INVERSE;
4900 /* Color testing. */
4902 /* Default the color indices in FG_TTY_COLOR and BG_TTY_COLOR, since
4903 we use them when calling `tty_capable_p' below, even if the face
4904 specifies no colors. */
4905 fg_tty_color.pixel = FACE_TTY_DEFAULT_FG_COLOR;
4906 bg_tty_color.pixel = FACE_TTY_DEFAULT_BG_COLOR;
4908 /* Check if foreground color is close enough. */
4909 fg = attrs[LFACE_FOREGROUND_INDEX];
4910 if (STRINGP (fg))
4912 Lisp_Object def_fg = def_attrs[LFACE_FOREGROUND_INDEX];
4914 if (face_attr_equal_p (fg, def_fg))
4915 return 0; /* same as default */
4916 else if (! tty_lookup_color (f, fg, &fg_tty_color, &fg_std_color))
4917 return 0; /* not a valid color */
4918 else if (color_distance (&fg_tty_color, &fg_std_color)
4919 > TTY_SAME_COLOR_THRESHOLD)
4920 return 0; /* displayed color is too different */
4921 else
4922 /* Make sure the color is really different than the default. */
4924 XColor def_fg_color;
4925 if (tty_lookup_color (f, def_fg, &def_fg_color, 0)
4926 && (color_distance (&fg_tty_color, &def_fg_color)
4927 <= TTY_SAME_COLOR_THRESHOLD))
4928 return 0;
4932 /* Check if background color is close enough. */
4933 bg = attrs[LFACE_BACKGROUND_INDEX];
4934 if (STRINGP (bg))
4936 Lisp_Object def_bg = def_attrs[LFACE_BACKGROUND_INDEX];
4938 if (face_attr_equal_p (bg, def_bg))
4939 return 0; /* same as default */
4940 else if (! tty_lookup_color (f, bg, &bg_tty_color, &bg_std_color))
4941 return 0; /* not a valid color */
4942 else if (color_distance (&bg_tty_color, &bg_std_color)
4943 > TTY_SAME_COLOR_THRESHOLD)
4944 return 0; /* displayed color is too different */
4945 else
4946 /* Make sure the color is really different than the default. */
4948 XColor def_bg_color;
4949 if (tty_lookup_color (f, def_bg, &def_bg_color, 0)
4950 && (color_distance (&bg_tty_color, &def_bg_color)
4951 <= TTY_SAME_COLOR_THRESHOLD))
4952 return 0;
4956 /* If both foreground and background are requested, see if the
4957 distance between them is OK. We just check to see if the distance
4958 between the tty's foreground and background is close enough to the
4959 distance between the standard foreground and background. */
4960 if (STRINGP (fg) && STRINGP (bg))
4962 int delta_delta
4963 = (color_distance (&fg_std_color, &bg_std_color)
4964 - color_distance (&fg_tty_color, &bg_tty_color));
4965 if (delta_delta > TTY_SAME_COLOR_THRESHOLD
4966 || delta_delta < -TTY_SAME_COLOR_THRESHOLD)
4967 return 0;
4971 /* See if the capabilities we selected above are supported, with the
4972 given colors. */
4973 if (test_caps != 0 &&
4974 ! tty_capable_p (FRAME_TTY (f), test_caps, fg_tty_color.pixel,
4975 bg_tty_color.pixel))
4976 return 0;
4979 /* Hmmm, everything checks out, this terminal must support this face. */
4980 return 1;
4984 DEFUN ("display-supports-face-attributes-p",
4985 Fdisplay_supports_face_attributes_p, Sdisplay_supports_face_attributes_p,
4986 1, 2, 0,
4987 doc: /* Return non-nil if all the face attributes in ATTRIBUTES are supported.
4988 The optional argument DISPLAY can be a display name, a frame, or
4989 nil (meaning the selected frame's display).
4991 The definition of `supported' is somewhat heuristic, but basically means
4992 that a face containing all the attributes in ATTRIBUTES, when merged
4993 with the default face for display, can be represented in a way that's
4995 \(1) different in appearance than the default face, and
4996 \(2) `close in spirit' to what the attributes specify, if not exact.
4998 Point (2) implies that a `:weight black' attribute will be satisfied by
4999 any display that can display bold, and a `:foreground \"yellow\"' as long
5000 as it can display a yellowish color, but `:slant italic' will _not_ be
5001 satisfied by the tty display code's automatic substitution of a `dim'
5002 face for italic. */)
5003 (Lisp_Object attributes, Lisp_Object display)
5005 int supports = 0, i;
5006 Lisp_Object frame;
5007 struct frame *f;
5008 struct face *def_face;
5009 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5011 if (noninteractive || !initialized)
5012 /* We may not be able to access low-level face information in batch
5013 mode, or before being dumped, and this function is not going to
5014 be very useful in those cases anyway, so just give up. */
5015 return Qnil;
5017 if (NILP (display))
5018 frame = selected_frame;
5019 else if (FRAMEP (display))
5020 frame = display;
5021 else
5023 /* Find any frame on DISPLAY. */
5024 Lisp_Object tail;
5026 frame = Qnil;
5027 FOR_EACH_FRAME (tail, frame)
5028 if (!NILP (Fequal (Fcdr (Fassq (Qdisplay,
5029 XFRAME (frame)->param_alist)),
5030 display)))
5031 break;
5034 CHECK_LIVE_FRAME (frame);
5035 f = XFRAME (frame);
5037 for (i = 0; i < LFACE_VECTOR_SIZE; i++)
5038 attrs[i] = Qunspecified;
5039 merge_face_ref (f, attributes, attrs, 1, 0);
5041 def_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5042 if (def_face == NULL)
5044 if (! realize_basic_faces (f))
5045 error ("Cannot realize default face");
5046 def_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5047 if (def_face == NULL)
5048 emacs_abort (); /* realize_basic_faces must have set it up */
5051 /* Dispatch to the appropriate handler. */
5052 if (FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5053 supports = tty_supports_face_attributes_p (f, attrs, def_face);
5054 #ifdef HAVE_WINDOW_SYSTEM
5055 else
5056 supports = x_supports_face_attributes_p (f, attrs, def_face);
5057 #endif
5059 return supports ? Qt : Qnil;
5063 /***********************************************************************
5064 Font selection
5065 ***********************************************************************/
5067 DEFUN ("internal-set-font-selection-order",
5068 Finternal_set_font_selection_order,
5069 Sinternal_set_font_selection_order, 1, 1, 0,
5070 doc: /* Set font selection order for face font selection to ORDER.
5071 ORDER must be a list of length 4 containing the symbols `:width',
5072 `:height', `:weight', and `:slant'. Face attributes appearing
5073 first in ORDER are matched first, e.g. if `:height' appears before
5074 `:weight' in ORDER, font selection first tries to find a font with
5075 a suitable height, and then tries to match the font weight.
5076 Value is ORDER. */)
5077 (Lisp_Object order)
5079 Lisp_Object list;
5080 int i;
5081 int indices[DIM (font_sort_order)];
5083 CHECK_LIST (order);
5084 memset (indices, 0, sizeof indices);
5085 i = 0;
5087 for (list = order;
5088 CONSP (list) && i < DIM (indices);
5089 list = XCDR (list), ++i)
5091 Lisp_Object attr = XCAR (list);
5092 int xlfd;
5094 if (EQ (attr, QCwidth))
5095 xlfd = XLFD_SWIDTH;
5096 else if (EQ (attr, QCheight))
5097 xlfd = XLFD_POINT_SIZE;
5098 else if (EQ (attr, QCweight))
5099 xlfd = XLFD_WEIGHT;
5100 else if (EQ (attr, QCslant))
5101 xlfd = XLFD_SLANT;
5102 else
5103 break;
5105 if (indices[i] != 0)
5106 break;
5107 indices[i] = xlfd;
5110 if (!NILP (list) || i != DIM (indices))
5111 signal_error ("Invalid font sort order", order);
5112 for (i = 0; i < DIM (font_sort_order); ++i)
5113 if (indices[i] == 0)
5114 signal_error ("Invalid font sort order", order);
5116 if (memcmp (indices, font_sort_order, sizeof indices) != 0)
5118 memcpy (font_sort_order, indices, sizeof font_sort_order);
5119 free_all_realized_faces (Qnil);
5122 font_update_sort_order (font_sort_order);
5124 return Qnil;
5128 DEFUN ("internal-set-alternative-font-family-alist",
5129 Finternal_set_alternative_font_family_alist,
5130 Sinternal_set_alternative_font_family_alist, 1, 1, 0,
5131 doc: /* Define alternative font families to try in face font selection.
5132 ALIST is an alist of (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...) entries.
5133 Each ALTERNATIVE is tried in order if no fonts of font family FAMILY can
5134 be found. Value is ALIST. */)
5135 (Lisp_Object alist)
5137 Lisp_Object entry, tail, tail2;
5139 CHECK_LIST (alist);
5140 alist = Fcopy_sequence (alist);
5141 for (tail = alist; CONSP (tail); tail = XCDR (tail))
5143 entry = XCAR (tail);
5144 CHECK_LIST (entry);
5145 entry = Fcopy_sequence (entry);
5146 XSETCAR (tail, entry);
5147 for (tail2 = entry; CONSP (tail2); tail2 = XCDR (tail2))
5148 XSETCAR (tail2, Fintern (XCAR (tail2), Qnil));
5151 Vface_alternative_font_family_alist = alist;
5152 free_all_realized_faces (Qnil);
5153 return alist;
5157 DEFUN ("internal-set-alternative-font-registry-alist",
5158 Finternal_set_alternative_font_registry_alist,
5159 Sinternal_set_alternative_font_registry_alist, 1, 1, 0,
5160 doc: /* Define alternative font registries to try in face font selection.
5161 ALIST is an alist of (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...) entries.
5162 Each ALTERNATIVE is tried in order if no fonts of font registry REGISTRY can
5163 be found. Value is ALIST. */)
5164 (Lisp_Object alist)
5166 Lisp_Object entry, tail, tail2;
5168 CHECK_LIST (alist);
5169 alist = Fcopy_sequence (alist);
5170 for (tail = alist; CONSP (tail); tail = XCDR (tail))
5172 entry = XCAR (tail);
5173 CHECK_LIST (entry);
5174 entry = Fcopy_sequence (entry);
5175 XSETCAR (tail, entry);
5176 for (tail2 = entry; CONSP (tail2); tail2 = XCDR (tail2))
5177 XSETCAR (tail2, Fdowncase (XCAR (tail2)));
5179 Vface_alternative_font_registry_alist = alist;
5180 free_all_realized_faces (Qnil);
5181 return alist;
5185 #ifdef HAVE_WINDOW_SYSTEM
5187 /* Return the fontset id of the base fontset name or alias name given
5188 by the fontset attribute of ATTRS. Value is -1 if the fontset
5189 attribute of ATTRS doesn't name a fontset. */
5191 static int
5192 face_fontset (Lisp_Object attrs[LFACE_VECTOR_SIZE])
5194 Lisp_Object name;
5196 name = attrs[LFACE_FONTSET_INDEX];
5197 if (!STRINGP (name))
5198 return -1;
5199 return fs_query_fontset (name, 0);
5202 #endif /* HAVE_WINDOW_SYSTEM */
5206 /***********************************************************************
5207 Face Realization
5208 ***********************************************************************/
5210 /* Realize basic faces on frame F. Value is zero if frame parameters
5211 of F don't contain enough information needed to realize the default
5212 face. */
5214 static int
5215 realize_basic_faces (struct frame *f)
5217 int success_p = 0;
5218 ptrdiff_t count = SPECPDL_INDEX ();
5220 /* Block input here so that we won't be surprised by an X expose
5221 event, for instance, without having the faces set up. */
5222 block_input ();
5223 specbind (Qscalable_fonts_allowed, Qt);
5225 if (realize_default_face (f))
5227 realize_named_face (f, Qmode_line, MODE_LINE_FACE_ID);
5228 realize_named_face (f, Qmode_line_inactive, MODE_LINE_INACTIVE_FACE_ID);
5229 realize_named_face (f, Qtool_bar, TOOL_BAR_FACE_ID);
5230 realize_named_face (f, Qfringe, FRINGE_FACE_ID);
5231 realize_named_face (f, Qheader_line, HEADER_LINE_FACE_ID);
5232 realize_named_face (f, Qscroll_bar, SCROLL_BAR_FACE_ID);
5233 realize_named_face (f, Qborder, BORDER_FACE_ID);
5234 realize_named_face (f, Qcursor, CURSOR_FACE_ID);
5235 realize_named_face (f, Qmouse, MOUSE_FACE_ID);
5236 realize_named_face (f, Qmenu, MENU_FACE_ID);
5237 realize_named_face (f, Qvertical_border, VERTICAL_BORDER_FACE_ID);
5239 /* Reflect changes in the `menu' face in menu bars. */
5240 if (FRAME_FACE_CACHE (f)->menu_face_changed_p)
5242 FRAME_FACE_CACHE (f)->menu_face_changed_p = 0;
5243 #ifdef USE_X_TOOLKIT
5244 if (FRAME_WINDOW_P (f))
5245 x_update_menu_appearance (f);
5246 #endif
5249 success_p = 1;
5252 unbind_to (count, Qnil);
5253 unblock_input ();
5254 return success_p;
5258 /* Realize the default face on frame F. If the face is not fully
5259 specified, make it fully-specified. Attributes of the default face
5260 that are not explicitly specified are taken from frame parameters. */
5262 static int
5263 realize_default_face (struct frame *f)
5265 struct face_cache *c = FRAME_FACE_CACHE (f);
5266 Lisp_Object lface;
5267 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5268 struct face *face;
5270 /* If the `default' face is not yet known, create it. */
5271 lface = lface_from_face_name (f, Qdefault, 0);
5272 if (NILP (lface))
5274 Lisp_Object frame;
5275 XSETFRAME (frame, f);
5276 lface = Finternal_make_lisp_face (Qdefault, frame);
5279 #ifdef HAVE_WINDOW_SYSTEM
5280 if (FRAME_WINDOW_P (f))
5282 Lisp_Object font_object;
5284 XSETFONT (font_object, FRAME_FONT (f));
5285 set_lface_from_font (f, lface, font_object, f->default_face_done_p);
5286 ASET (lface, LFACE_FONTSET_INDEX, fontset_name (FRAME_FONTSET (f)));
5287 f->default_face_done_p = 1;
5289 #endif /* HAVE_WINDOW_SYSTEM */
5291 if (!FRAME_WINDOW_P (f))
5293 ASET (lface, LFACE_FAMILY_INDEX, build_string ("default"));
5294 ASET (lface, LFACE_FOUNDRY_INDEX, LFACE_FAMILY (lface));
5295 ASET (lface, LFACE_SWIDTH_INDEX, Qnormal);
5296 ASET (lface, LFACE_HEIGHT_INDEX, make_number (1));
5297 if (UNSPECIFIEDP (LFACE_WEIGHT (lface)))
5298 ASET (lface, LFACE_WEIGHT_INDEX, Qnormal);
5299 if (UNSPECIFIEDP (LFACE_SLANT (lface)))
5300 ASET (lface, LFACE_SLANT_INDEX, Qnormal);
5301 if (UNSPECIFIEDP (LFACE_FONTSET (lface)))
5302 ASET (lface, LFACE_FONTSET_INDEX, Qnil);
5305 if (UNSPECIFIEDP (LFACE_UNDERLINE (lface)))
5306 ASET (lface, LFACE_UNDERLINE_INDEX, Qnil);
5308 if (UNSPECIFIEDP (LFACE_OVERLINE (lface)))
5309 ASET (lface, LFACE_OVERLINE_INDEX, Qnil);
5311 if (UNSPECIFIEDP (LFACE_STRIKE_THROUGH (lface)))
5312 ASET (lface, LFACE_STRIKE_THROUGH_INDEX, Qnil);
5314 if (UNSPECIFIEDP (LFACE_BOX (lface)))
5315 ASET (lface, LFACE_BOX_INDEX, Qnil);
5317 if (UNSPECIFIEDP (LFACE_INVERSE (lface)))
5318 ASET (lface, LFACE_INVERSE_INDEX, Qnil);
5320 if (UNSPECIFIEDP (LFACE_FOREGROUND (lface)))
5322 /* This function is called so early that colors are not yet
5323 set in the frame parameter list. */
5324 Lisp_Object color = Fassq (Qforeground_color, f->param_alist);
5326 if (CONSP (color) && STRINGP (XCDR (color)))
5327 ASET (lface, LFACE_FOREGROUND_INDEX, XCDR (color));
5328 else if (FRAME_WINDOW_P (f))
5329 return 0;
5330 else if (FRAME_INITIAL_P (f) || FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5331 ASET (lface, LFACE_FOREGROUND_INDEX, build_string (unspecified_fg));
5332 else
5333 emacs_abort ();
5336 if (UNSPECIFIEDP (LFACE_BACKGROUND (lface)))
5338 /* This function is called so early that colors are not yet
5339 set in the frame parameter list. */
5340 Lisp_Object color = Fassq (Qbackground_color, f->param_alist);
5341 if (CONSP (color) && STRINGP (XCDR (color)))
5342 ASET (lface, LFACE_BACKGROUND_INDEX, XCDR (color));
5343 else if (FRAME_WINDOW_P (f))
5344 return 0;
5345 else if (FRAME_INITIAL_P (f) || FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5346 ASET (lface, LFACE_BACKGROUND_INDEX, build_string (unspecified_bg));
5347 else
5348 emacs_abort ();
5351 if (UNSPECIFIEDP (LFACE_STIPPLE (lface)))
5352 ASET (lface, LFACE_STIPPLE_INDEX, Qnil);
5354 /* Realize the face; it must be fully-specified now. */
5355 eassert (lface_fully_specified_p (XVECTOR (lface)->contents));
5356 check_lface (lface);
5357 memcpy (attrs, XVECTOR (lface)->contents, sizeof attrs);
5358 face = realize_face (c, attrs, DEFAULT_FACE_ID);
5360 #ifdef HAVE_WINDOW_SYSTEM
5361 #ifdef HAVE_X_WINDOWS
5362 if (FRAME_X_P (f) && face->font != FRAME_FONT (f))
5364 /* This can happen when making a frame on a display that does
5365 not support the default font. */
5366 if (!face->font)
5367 return 0;
5369 /* Otherwise, the font specified for the frame was not
5370 acceptable as a font for the default face (perhaps because
5371 auto-scaled fonts are rejected), so we must adjust the frame
5372 font. */
5373 x_set_font (f, LFACE_FONT (lface), Qnil);
5375 #endif /* HAVE_X_WINDOWS */
5376 #endif /* HAVE_WINDOW_SYSTEM */
5377 return 1;
5381 /* Realize basic faces other than the default face in face cache C.
5382 SYMBOL is the face name, ID is the face id the realized face must
5383 have. The default face must have been realized already. */
5385 static void
5386 realize_named_face (struct frame *f, Lisp_Object symbol, int id)
5388 struct face_cache *c = FRAME_FACE_CACHE (f);
5389 Lisp_Object lface = lface_from_face_name (f, symbol, 0);
5390 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5391 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
5393 /* The default face must exist and be fully specified. */
5394 get_lface_attributes_no_remap (f, Qdefault, attrs, 1);
5395 check_lface_attrs (attrs);
5396 eassert (lface_fully_specified_p (attrs));
5398 /* If SYMBOL isn't know as a face, create it. */
5399 if (NILP (lface))
5401 Lisp_Object frame;
5402 XSETFRAME (frame, f);
5403 lface = Finternal_make_lisp_face (symbol, frame);
5406 /* Merge SYMBOL's face with the default face. */
5407 get_lface_attributes_no_remap (f, symbol, symbol_attrs, 1);
5408 merge_face_vectors (f, symbol_attrs, attrs, 0);
5410 /* Realize the face. */
5411 realize_face (c, attrs, id);
5415 /* Realize the fully-specified face with attributes ATTRS in face
5416 cache CACHE for ASCII characters. If FORMER_FACE_ID is
5417 non-negative, it is an ID of face to remove before caching the new
5418 face. Value is a pointer to the newly created realized face. */
5420 static struct face *
5421 realize_face (struct face_cache *cache, Lisp_Object attrs[LFACE_VECTOR_SIZE],
5422 int former_face_id)
5424 struct face *face;
5426 /* LFACE must be fully specified. */
5427 eassert (cache != NULL);
5428 check_lface_attrs (attrs);
5430 if (former_face_id >= 0 && cache->used > former_face_id)
5432 /* Remove the former face. */
5433 struct face *former_face = cache->faces_by_id[former_face_id];
5434 uncache_face (cache, former_face);
5435 free_realized_face (cache->f, former_face);
5436 SET_FRAME_GARBAGED (cache->f);
5439 if (FRAME_WINDOW_P (cache->f))
5440 face = realize_x_face (cache, attrs);
5441 else if (FRAME_TERMCAP_P (cache->f) || FRAME_MSDOS_P (cache->f))
5442 face = realize_tty_face (cache, attrs);
5443 else if (FRAME_INITIAL_P (cache->f))
5445 /* Create a dummy face. */
5446 face = make_realized_face (attrs);
5448 else
5449 emacs_abort ();
5451 /* Insert the new face. */
5452 cache_face (cache, face, lface_hash (attrs));
5453 return face;
5457 #ifdef HAVE_WINDOW_SYSTEM
5458 /* Realize the fully-specified face that uses FONT-OBJECT and has the
5459 same attributes as BASE_FACE except for the font on frame F.
5460 FONT-OBJECT may be nil, in which case, realized a face of
5461 no-font. */
5463 static struct face *
5464 realize_non_ascii_face (struct frame *f, Lisp_Object font_object,
5465 struct face *base_face)
5467 struct face_cache *cache = FRAME_FACE_CACHE (f);
5468 struct face *face;
5470 face = xmalloc (sizeof *face);
5471 *face = *base_face;
5472 face->gc = 0;
5473 face->extra = NULL;
5474 face->overstrike
5475 = (! NILP (font_object)
5476 && FONT_WEIGHT_NAME_NUMERIC (face->lface[LFACE_WEIGHT_INDEX]) > 100
5477 && FONT_WEIGHT_NUMERIC (font_object) <= 100);
5479 /* Don't try to free the colors copied bitwise from BASE_FACE. */
5480 face->colors_copied_bitwise_p = 1;
5481 face->font = NILP (font_object) ? NULL : XFONT_OBJECT (font_object);
5482 face->gc = 0;
5484 cache_face (cache, face, face->hash);
5486 return face;
5488 #endif /* HAVE_WINDOW_SYSTEM */
5491 /* Realize the fully-specified face with attributes ATTRS in face
5492 cache CACHE for ASCII characters. Do it for X frame CACHE->f. If
5493 the new face doesn't share font with the default face, a fontname
5494 is allocated from the heap and set in `font_name' of the new face,
5495 but it is not yet loaded here. Value is a pointer to the newly
5496 created realized face. */
5498 static struct face *
5499 realize_x_face (struct face_cache *cache, Lisp_Object attrs[LFACE_VECTOR_SIZE])
5501 struct face *face = NULL;
5502 #ifdef HAVE_WINDOW_SYSTEM
5503 struct face *default_face;
5504 struct frame *f;
5505 Lisp_Object stipple, underline, overline, strike_through, box;
5507 eassert (FRAME_WINDOW_P (cache->f));
5509 /* Allocate a new realized face. */
5510 face = make_realized_face (attrs);
5511 face->ascii_face = face;
5513 f = cache->f;
5515 /* Determine the font to use. Most of the time, the font will be
5516 the same as the font of the default face, so try that first. */
5517 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5518 if (default_face
5519 && lface_same_font_attributes_p (default_face->lface, attrs))
5521 face->font = default_face->font;
5522 face->fontset
5523 = make_fontset_for_ascii_face (f, default_face->fontset, face);
5525 else
5527 /* If the face attribute ATTRS specifies a fontset, use it as
5528 the base of a new realized fontset. Otherwise, use the same
5529 base fontset as of the default face. The base determines
5530 registry and encoding of a font. It may also determine
5531 foundry and family. The other fields of font name pattern
5532 are constructed from ATTRS. */
5533 int fontset = face_fontset (attrs);
5535 /* If we are realizing the default face, ATTRS should specify a
5536 fontset. In other words, if FONTSET is -1, we are not
5537 realizing the default face, thus the default face should have
5538 already been realized. */
5539 if (fontset == -1)
5541 if (default_face)
5542 fontset = default_face->fontset;
5543 if (fontset == -1)
5544 emacs_abort ();
5546 if (! FONT_OBJECT_P (attrs[LFACE_FONT_INDEX]))
5547 attrs[LFACE_FONT_INDEX]
5548 = font_load_for_lface (f, attrs, attrs[LFACE_FONT_INDEX]);
5549 if (FONT_OBJECT_P (attrs[LFACE_FONT_INDEX]))
5551 face->font = XFONT_OBJECT (attrs[LFACE_FONT_INDEX]);
5552 face->fontset = make_fontset_for_ascii_face (f, fontset, face);
5554 else
5556 face->font = NULL;
5557 face->fontset = -1;
5561 if (face->font
5562 && FONT_WEIGHT_NAME_NUMERIC (attrs[LFACE_WEIGHT_INDEX]) > 100
5563 && FONT_WEIGHT_NUMERIC (attrs[LFACE_FONT_INDEX]) <= 100)
5564 face->overstrike = 1;
5566 /* Load colors, and set remaining attributes. */
5568 load_face_colors (f, face, attrs);
5570 /* Set up box. */
5571 box = attrs[LFACE_BOX_INDEX];
5572 if (STRINGP (box))
5574 /* A simple box of line width 1 drawn in color given by
5575 the string. */
5576 face->box_color = load_color (f, face, attrs[LFACE_BOX_INDEX],
5577 LFACE_BOX_INDEX);
5578 face->box = FACE_SIMPLE_BOX;
5579 face->box_line_width = 1;
5581 else if (INTEGERP (box))
5583 /* Simple box of specified line width in foreground color of the
5584 face. */
5585 eassert (XINT (box) != 0);
5586 face->box = FACE_SIMPLE_BOX;
5587 face->box_line_width = XINT (box);
5588 face->box_color = face->foreground;
5589 face->box_color_defaulted_p = 1;
5591 else if (CONSP (box))
5593 /* `(:width WIDTH :color COLOR :shadow SHADOW)'. SHADOW
5594 being one of `raised' or `sunken'. */
5595 face->box = FACE_SIMPLE_BOX;
5596 face->box_color = face->foreground;
5597 face->box_color_defaulted_p = 1;
5598 face->box_line_width = 1;
5600 while (CONSP (box))
5602 Lisp_Object keyword, value;
5604 keyword = XCAR (box);
5605 box = XCDR (box);
5607 if (!CONSP (box))
5608 break;
5609 value = XCAR (box);
5610 box = XCDR (box);
5612 if (EQ (keyword, QCline_width))
5614 if (INTEGERP (value) && XINT (value) != 0)
5615 face->box_line_width = XINT (value);
5617 else if (EQ (keyword, QCcolor))
5619 if (STRINGP (value))
5621 face->box_color = load_color (f, face, value,
5622 LFACE_BOX_INDEX);
5623 face->use_box_color_for_shadows_p = 1;
5626 else if (EQ (keyword, QCstyle))
5628 if (EQ (value, Qreleased_button))
5629 face->box = FACE_RAISED_BOX;
5630 else if (EQ (value, Qpressed_button))
5631 face->box = FACE_SUNKEN_BOX;
5636 /* Text underline, overline, strike-through. */
5638 underline = attrs[LFACE_UNDERLINE_INDEX];
5639 if (EQ (underline, Qt))
5641 /* Use default color (same as foreground color). */
5642 face->underline_p = 1;
5643 face->underline_type = FACE_UNDER_LINE;
5644 face->underline_defaulted_p = 1;
5645 face->underline_color = 0;
5647 else if (STRINGP (underline))
5649 /* Use specified color. */
5650 face->underline_p = 1;
5651 face->underline_type = FACE_UNDER_LINE;
5652 face->underline_defaulted_p = 0;
5653 face->underline_color
5654 = load_color (f, face, underline,
5655 LFACE_UNDERLINE_INDEX);
5657 else if (NILP (underline))
5659 face->underline_p = 0;
5660 face->underline_defaulted_p = 0;
5661 face->underline_color = 0;
5663 else if (CONSP (underline))
5665 /* `(:color COLOR :style STYLE)'.
5666 STYLE being one of `line' or `wave'. */
5667 face->underline_p = 1;
5668 face->underline_color = 0;
5669 face->underline_defaulted_p = 1;
5670 face->underline_type = FACE_UNDER_LINE;
5672 /* FIXME? This is also not robust about checking the precise form.
5673 See comments in Finternal_set_lisp_face_attribute. */
5674 while (CONSP (underline))
5676 Lisp_Object keyword, value;
5678 keyword = XCAR (underline);
5679 underline = XCDR (underline);
5681 if (!CONSP (underline))
5682 break;
5683 value = XCAR (underline);
5684 underline = XCDR (underline);
5686 if (EQ (keyword, QCcolor))
5688 if (EQ (value, Qforeground_color))
5690 face->underline_defaulted_p = 1;
5691 face->underline_color = 0;
5693 else if (STRINGP (value))
5695 face->underline_defaulted_p = 0;
5696 face->underline_color = load_color (f, face, value,
5697 LFACE_UNDERLINE_INDEX);
5700 else if (EQ (keyword, QCstyle))
5702 if (EQ (value, Qline))
5703 face->underline_type = FACE_UNDER_LINE;
5704 else if (EQ (value, Qwave))
5705 face->underline_type = FACE_UNDER_WAVE;
5710 overline = attrs[LFACE_OVERLINE_INDEX];
5711 if (STRINGP (overline))
5713 face->overline_color
5714 = load_color (f, face, attrs[LFACE_OVERLINE_INDEX],
5715 LFACE_OVERLINE_INDEX);
5716 face->overline_p = 1;
5718 else if (EQ (overline, Qt))
5720 face->overline_color = face->foreground;
5721 face->overline_color_defaulted_p = 1;
5722 face->overline_p = 1;
5725 strike_through = attrs[LFACE_STRIKE_THROUGH_INDEX];
5726 if (STRINGP (strike_through))
5728 face->strike_through_color
5729 = load_color (f, face, attrs[LFACE_STRIKE_THROUGH_INDEX],
5730 LFACE_STRIKE_THROUGH_INDEX);
5731 face->strike_through_p = 1;
5733 else if (EQ (strike_through, Qt))
5735 face->strike_through_color = face->foreground;
5736 face->strike_through_color_defaulted_p = 1;
5737 face->strike_through_p = 1;
5740 stipple = attrs[LFACE_STIPPLE_INDEX];
5741 if (!NILP (stipple))
5742 face->stipple = load_pixmap (f, stipple, &face->pixmap_w, &face->pixmap_h);
5743 #endif /* HAVE_WINDOW_SYSTEM */
5745 return face;
5749 /* Map a specified color of face FACE on frame F to a tty color index.
5750 IDX is either LFACE_FOREGROUND_INDEX or LFACE_BACKGROUND_INDEX, and
5751 specifies which color to map. Set *DEFAULTED to 1 if mapping to the
5752 default foreground/background colors. */
5754 static void
5755 map_tty_color (struct frame *f, struct face *face,
5756 enum lface_attribute_index idx, int *defaulted)
5758 Lisp_Object frame, color, def;
5759 int foreground_p = idx == LFACE_FOREGROUND_INDEX;
5760 unsigned long default_pixel =
5761 foreground_p ? FACE_TTY_DEFAULT_FG_COLOR : FACE_TTY_DEFAULT_BG_COLOR;
5762 unsigned long pixel = default_pixel;
5763 #ifdef MSDOS
5764 unsigned long default_other_pixel =
5765 foreground_p ? FACE_TTY_DEFAULT_BG_COLOR : FACE_TTY_DEFAULT_FG_COLOR;
5766 #endif
5768 eassert (idx == LFACE_FOREGROUND_INDEX || idx == LFACE_BACKGROUND_INDEX);
5770 XSETFRAME (frame, f);
5771 color = face->lface[idx];
5773 if (STRINGP (color)
5774 && SCHARS (color)
5775 && CONSP (Vtty_defined_color_alist)
5776 && (def = assq_no_quit (color, call1 (Qtty_color_alist, frame)),
5777 CONSP (def)))
5779 /* Associations in tty-defined-color-alist are of the form
5780 (NAME INDEX R G B). We need the INDEX part. */
5781 pixel = XINT (XCAR (XCDR (def)));
5784 if (pixel == default_pixel && STRINGP (color))
5786 pixel = load_color (f, face, color, idx);
5788 #ifdef MSDOS
5789 /* If the foreground of the default face is the default color,
5790 use the foreground color defined by the frame. */
5791 if (FRAME_MSDOS_P (f))
5793 if (pixel == default_pixel
5794 || pixel == FACE_TTY_DEFAULT_COLOR)
5796 if (foreground_p)
5797 pixel = FRAME_FOREGROUND_PIXEL (f);
5798 else
5799 pixel = FRAME_BACKGROUND_PIXEL (f);
5800 face->lface[idx] = tty_color_name (f, pixel);
5801 *defaulted = 1;
5803 else if (pixel == default_other_pixel)
5805 if (foreground_p)
5806 pixel = FRAME_BACKGROUND_PIXEL (f);
5807 else
5808 pixel = FRAME_FOREGROUND_PIXEL (f);
5809 face->lface[idx] = tty_color_name (f, pixel);
5810 *defaulted = 1;
5813 #endif /* MSDOS */
5816 if (foreground_p)
5817 face->foreground = pixel;
5818 else
5819 face->background = pixel;
5823 /* Realize the fully-specified face with attributes ATTRS in face
5824 cache CACHE for ASCII characters. Do it for TTY frame CACHE->f.
5825 Value is a pointer to the newly created realized face. */
5827 static struct face *
5828 realize_tty_face (struct face_cache *cache,
5829 Lisp_Object attrs[LFACE_VECTOR_SIZE])
5831 struct face *face;
5832 int weight, slant;
5833 int face_colors_defaulted = 0;
5834 struct frame *f = cache->f;
5836 /* Frame must be a termcap frame. */
5837 eassert (FRAME_TERMCAP_P (cache->f) || FRAME_MSDOS_P (cache->f));
5839 /* Allocate a new realized face. */
5840 face = make_realized_face (attrs);
5841 #if 0
5842 face->font_name = FRAME_MSDOS_P (cache->f) ? "ms-dos" : "tty";
5843 #endif
5845 /* Map face attributes to TTY appearances. */
5846 weight = FONT_WEIGHT_NAME_NUMERIC (attrs[LFACE_WEIGHT_INDEX]);
5847 slant = FONT_SLANT_NAME_NUMERIC (attrs[LFACE_SLANT_INDEX]);
5848 if (weight > 100)
5849 face->tty_bold_p = 1;
5850 if (slant != 100)
5851 face->tty_italic_p = 1;
5852 if (!NILP (attrs[LFACE_UNDERLINE_INDEX]))
5853 face->tty_underline_p = 1;
5854 if (!NILP (attrs[LFACE_INVERSE_INDEX]))
5855 face->tty_reverse_p = 1;
5857 /* Map color names to color indices. */
5858 map_tty_color (f, face, LFACE_FOREGROUND_INDEX, &face_colors_defaulted);
5859 map_tty_color (f, face, LFACE_BACKGROUND_INDEX, &face_colors_defaulted);
5861 /* Swap colors if face is inverse-video. If the colors are taken
5862 from the frame colors, they are already inverted, since the
5863 frame-creation function calls x-handle-reverse-video. */
5864 if (face->tty_reverse_p && !face_colors_defaulted)
5866 unsigned long tem = face->foreground;
5867 face->foreground = face->background;
5868 face->background = tem;
5871 if (tty_suppress_bold_inverse_default_colors_p
5872 && face->tty_bold_p
5873 && face->background == FACE_TTY_DEFAULT_FG_COLOR
5874 && face->foreground == FACE_TTY_DEFAULT_BG_COLOR)
5875 face->tty_bold_p = 0;
5877 return face;
5881 DEFUN ("tty-suppress-bold-inverse-default-colors",
5882 Ftty_suppress_bold_inverse_default_colors,
5883 Stty_suppress_bold_inverse_default_colors, 1, 1, 0,
5884 doc: /* Suppress/allow boldness of faces with inverse default colors.
5885 SUPPRESS non-nil means suppress it.
5886 This affects bold faces on TTYs whose foreground is the default background
5887 color of the display and whose background is the default foreground color.
5888 For such faces, the bold face attribute is ignored if this variable
5889 is non-nil. */)
5890 (Lisp_Object suppress)
5892 tty_suppress_bold_inverse_default_colors_p = !NILP (suppress);
5893 ++face_change_count;
5894 return suppress;
5899 /***********************************************************************
5900 Computing Faces
5901 ***********************************************************************/
5903 /* Return the ID of the face to use to display character CH with face
5904 property PROP on frame F in current_buffer. */
5907 compute_char_face (struct frame *f, int ch, Lisp_Object prop)
5909 int face_id;
5911 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
5912 ch = 0;
5914 if (NILP (prop))
5916 struct face *face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5917 face_id = FACE_FOR_CHAR (f, face, ch, -1, Qnil);
5919 else
5921 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5922 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5923 memcpy (attrs, default_face->lface, sizeof attrs);
5924 merge_face_ref (f, prop, attrs, 1, 0);
5925 face_id = lookup_face (f, attrs);
5928 return face_id;
5931 /* Return the face ID associated with buffer position POS for
5932 displaying ASCII characters. Return in *ENDPTR the position at
5933 which a different face is needed, as far as text properties and
5934 overlays are concerned. W is a window displaying current_buffer.
5936 REGION_BEG, REGION_END delimit the region, so it can be
5937 highlighted.
5939 LIMIT is a position not to scan beyond. That is to limit the time
5940 this function can take.
5942 If MOUSE is non-zero, use the character's mouse-face, not its face.
5944 BASE_FACE_ID, if non-negative, specifies a base face id to use
5945 instead of DEFAULT_FACE_ID.
5947 The face returned is suitable for displaying ASCII characters. */
5950 face_at_buffer_position (struct window *w, ptrdiff_t pos,
5951 ptrdiff_t region_beg, ptrdiff_t region_end,
5952 ptrdiff_t *endptr, ptrdiff_t limit,
5953 int mouse, int base_face_id)
5955 struct frame *f = XFRAME (w->frame);
5956 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5957 Lisp_Object prop, position;
5958 ptrdiff_t i, noverlays;
5959 Lisp_Object *overlay_vec;
5960 ptrdiff_t endpos;
5961 Lisp_Object propname = mouse ? Qmouse_face : Qface;
5962 Lisp_Object limit1, end;
5963 struct face *default_face;
5965 /* W must display the current buffer. We could write this function
5966 to use the frame and buffer of W, but right now it doesn't. */
5967 /* eassert (XBUFFER (w->contents) == current_buffer); */
5969 XSETFASTINT (position, pos);
5971 endpos = ZV;
5972 if (pos < region_beg && region_beg < endpos)
5973 endpos = region_beg;
5975 /* Get the `face' or `mouse_face' text property at POS, and
5976 determine the next position at which the property changes. */
5977 prop = Fget_text_property (position, propname, w->contents);
5978 XSETFASTINT (limit1, (limit < endpos ? limit : endpos));
5979 end = Fnext_single_property_change (position, propname, w->contents, limit1);
5980 if (INTEGERP (end))
5981 endpos = XINT (end);
5983 /* Look at properties from overlays. */
5985 ptrdiff_t next_overlay;
5987 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, &next_overlay, 0);
5988 if (next_overlay < endpos)
5989 endpos = next_overlay;
5992 *endptr = endpos;
5995 int face_id;
5997 if (base_face_id >= 0)
5998 face_id = base_face_id;
5999 else if (NILP (Vface_remapping_alist))
6000 face_id = DEFAULT_FACE_ID;
6001 else
6002 face_id = lookup_basic_face (f, DEFAULT_FACE_ID);
6004 default_face = FACE_FROM_ID (f, face_id);
6007 /* Optimize common cases where we can use the default face. */
6008 if (noverlays == 0
6009 && NILP (prop)
6010 && !(pos >= region_beg && pos < region_end))
6011 return default_face->id;
6013 /* Begin with attributes from the default face. */
6014 memcpy (attrs, default_face->lface, sizeof attrs);
6016 /* Merge in attributes specified via text properties. */
6017 if (!NILP (prop))
6018 merge_face_ref (f, prop, attrs, 1, 0);
6020 /* Now merge the overlay data. */
6021 noverlays = sort_overlays (overlay_vec, noverlays, w);
6022 for (i = 0; i < noverlays; i++)
6024 Lisp_Object oend;
6025 ptrdiff_t oendpos;
6027 prop = Foverlay_get (overlay_vec[i], propname);
6028 if (!NILP (prop))
6029 merge_face_ref (f, prop, attrs, 1, 0);
6031 oend = OVERLAY_END (overlay_vec[i]);
6032 oendpos = OVERLAY_POSITION (oend);
6033 if (oendpos < endpos)
6034 endpos = oendpos;
6037 /* If in the region, merge in the region face. */
6038 if (pos >= region_beg && pos < region_end)
6040 merge_named_face (f, Qregion, attrs, 0);
6042 if (region_end < endpos)
6043 endpos = region_end;
6046 *endptr = endpos;
6048 /* Look up a realized face with the given face attributes,
6049 or realize a new one for ASCII characters. */
6050 return lookup_face (f, attrs);
6053 /* Return the face ID at buffer position POS for displaying ASCII
6054 characters associated with overlay strings for overlay OVERLAY.
6056 Like face_at_buffer_position except for OVERLAY. Currently it
6057 simply disregards the `face' properties of all overlays. */
6060 face_for_overlay_string (struct window *w, ptrdiff_t pos,
6061 ptrdiff_t region_beg, ptrdiff_t region_end,
6062 ptrdiff_t *endptr, ptrdiff_t limit,
6063 int mouse, Lisp_Object overlay)
6065 struct frame *f = XFRAME (w->frame);
6066 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6067 Lisp_Object prop, position;
6068 ptrdiff_t endpos;
6069 Lisp_Object propname = mouse ? Qmouse_face : Qface;
6070 Lisp_Object limit1, end;
6071 struct face *default_face;
6073 /* W must display the current buffer. We could write this function
6074 to use the frame and buffer of W, but right now it doesn't. */
6075 /* eassert (XBUFFER (w->contents) == current_buffer); */
6077 XSETFASTINT (position, pos);
6079 endpos = ZV;
6080 if (pos < region_beg && region_beg < endpos)
6081 endpos = region_beg;
6083 /* Get the `face' or `mouse_face' text property at POS, and
6084 determine the next position at which the property changes. */
6085 prop = Fget_text_property (position, propname, w->contents);
6086 XSETFASTINT (limit1, (limit < endpos ? limit : endpos));
6087 end = Fnext_single_property_change (position, propname, w->contents, limit1);
6088 if (INTEGERP (end))
6089 endpos = XINT (end);
6091 *endptr = endpos;
6093 /* Optimize common case where we can use the default face. */
6094 if (NILP (prop)
6095 && !(pos >= region_beg && pos < region_end)
6096 && NILP (Vface_remapping_alist))
6097 return DEFAULT_FACE_ID;
6099 /* Begin with attributes from the default face. */
6100 default_face = FACE_FROM_ID (f, lookup_basic_face (f, DEFAULT_FACE_ID));
6101 memcpy (attrs, default_face->lface, sizeof attrs);
6103 /* Merge in attributes specified via text properties. */
6104 if (!NILP (prop))
6105 merge_face_ref (f, prop, attrs, 1, 0);
6107 /* If in the region, merge in the region face. */
6108 if (pos >= region_beg && pos < region_end)
6110 merge_named_face (f, Qregion, attrs, 0);
6112 if (region_end < endpos)
6113 endpos = region_end;
6116 *endptr = endpos;
6118 /* Look up a realized face with the given face attributes,
6119 or realize a new one for ASCII characters. */
6120 return lookup_face (f, attrs);
6124 /* Compute the face at character position POS in Lisp string STRING on
6125 window W, for ASCII characters.
6127 If STRING is an overlay string, it comes from position BUFPOS in
6128 current_buffer, otherwise BUFPOS is zero to indicate that STRING is
6129 not an overlay string. W must display the current buffer.
6130 REGION_BEG and REGION_END give the start and end positions of the
6131 region; both are -1 if no region is visible.
6133 BASE_FACE_ID is the id of a face to merge with. For strings coming
6134 from overlays or the `display' property it is the face at BUFPOS.
6136 If MOUSE_P is non-zero, use the character's mouse-face, not its face.
6138 Set *ENDPTR to the next position where to check for faces in
6139 STRING; -1 if the face is constant from POS to the end of the
6140 string.
6142 Value is the id of the face to use. The face returned is suitable
6143 for displaying ASCII characters. */
6146 face_at_string_position (struct window *w, Lisp_Object string,
6147 ptrdiff_t pos, ptrdiff_t bufpos,
6148 ptrdiff_t region_beg, ptrdiff_t region_end,
6149 ptrdiff_t *endptr, enum face_id base_face_id,
6150 int mouse_p)
6152 Lisp_Object prop, position, end, limit;
6153 struct frame *f = XFRAME (WINDOW_FRAME (w));
6154 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6155 struct face *base_face;
6156 bool multibyte_p = STRING_MULTIBYTE (string);
6157 Lisp_Object prop_name = mouse_p ? Qmouse_face : Qface;
6159 /* Get the value of the face property at the current position within
6160 STRING. Value is nil if there is no face property. */
6161 XSETFASTINT (position, pos);
6162 prop = Fget_text_property (position, prop_name, string);
6164 /* Get the next position at which to check for faces. Value of end
6165 is nil if face is constant all the way to the end of the string.
6166 Otherwise it is a string position where to check faces next.
6167 Limit is the maximum position up to which to check for property
6168 changes in Fnext_single_property_change. Strings are usually
6169 short, so set the limit to the end of the string. */
6170 XSETFASTINT (limit, SCHARS (string));
6171 end = Fnext_single_property_change (position, prop_name, string, limit);
6172 if (INTEGERP (end))
6173 *endptr = XFASTINT (end);
6174 else
6175 *endptr = -1;
6177 base_face = FACE_FROM_ID (f, base_face_id);
6178 eassert (base_face);
6180 /* Optimize the default case that there is no face property and we
6181 are not in the region. */
6182 if (NILP (prop)
6183 && (base_face_id != DEFAULT_FACE_ID
6184 /* BUFPOS <= 0 means STRING is not an overlay string, so
6185 that the region doesn't have to be taken into account. */
6186 || bufpos <= 0
6187 || bufpos < region_beg
6188 || bufpos >= region_end)
6189 && (multibyte_p
6190 /* We can't realize faces for different charsets differently
6191 if we don't have fonts, so we can stop here if not working
6192 on a window-system frame. */
6193 || !FRAME_WINDOW_P (f)
6194 || FACE_SUITABLE_FOR_ASCII_CHAR_P (base_face, 0)))
6195 return base_face->id;
6197 /* Begin with attributes from the base face. */
6198 memcpy (attrs, base_face->lface, sizeof attrs);
6200 /* Merge in attributes specified via text properties. */
6201 if (!NILP (prop))
6202 merge_face_ref (f, prop, attrs, 1, 0);
6204 /* If in the region, merge in the region face. */
6205 if (bufpos
6206 && bufpos >= region_beg
6207 && bufpos < region_end)
6208 merge_named_face (f, Qregion, attrs, 0);
6210 /* Look up a realized face with the given face attributes,
6211 or realize a new one for ASCII characters. */
6212 return lookup_face (f, attrs);
6216 /* Merge a face into a realized face.
6218 F is frame where faces are (to be) realized.
6220 FACE_NAME is named face to merge.
6222 If FACE_NAME is nil, FACE_ID is face_id of realized face to merge.
6224 If FACE_NAME is t, FACE_ID is lface_id of face to merge.
6226 BASE_FACE_ID is realized face to merge into.
6228 Return new face id.
6232 merge_faces (struct frame *f, Lisp_Object face_name, int face_id,
6233 int base_face_id)
6235 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6236 struct face *base_face;
6238 base_face = FACE_FROM_ID (f, base_face_id);
6239 if (!base_face)
6240 return base_face_id;
6242 if (EQ (face_name, Qt))
6244 if (face_id < 0 || face_id >= lface_id_to_name_size)
6245 return base_face_id;
6246 face_name = lface_id_to_name[face_id];
6247 /* When called during make-frame, lookup_derived_face may fail
6248 if the faces are uninitialized. Don't signal an error. */
6249 face_id = lookup_derived_face (f, face_name, base_face_id, 0);
6250 return (face_id >= 0 ? face_id : base_face_id);
6253 /* Begin with attributes from the base face. */
6254 memcpy (attrs, base_face->lface, sizeof attrs);
6256 if (!NILP (face_name))
6258 if (!merge_named_face (f, face_name, attrs, 0))
6259 return base_face_id;
6261 else
6263 struct face *face;
6264 if (face_id < 0)
6265 return base_face_id;
6266 face = FACE_FROM_ID (f, face_id);
6267 if (!face)
6268 return base_face_id;
6269 merge_face_vectors (f, face->lface, attrs, 0);
6272 /* Look up a realized face with the given face attributes,
6273 or realize a new one for ASCII characters. */
6274 return lookup_face (f, attrs);
6279 #ifndef HAVE_X_WINDOWS
6280 DEFUN ("x-load-color-file", Fx_load_color_file,
6281 Sx_load_color_file, 1, 1, 0,
6282 doc: /* Create an alist of color entries from an external file.
6284 The file should define one named RGB color per line like so:
6285 R G B name
6286 where R,G,B are numbers between 0 and 255 and name is an arbitrary string. */)
6287 (Lisp_Object filename)
6289 FILE *fp;
6290 Lisp_Object cmap = Qnil;
6291 Lisp_Object abspath;
6293 CHECK_STRING (filename);
6294 abspath = Fexpand_file_name (filename, Qnil);
6296 fp = fopen (SSDATA (abspath), "rt");
6297 if (fp)
6299 char buf[512];
6300 int red, green, blue;
6301 int num;
6303 block_input ();
6305 while (fgets (buf, sizeof (buf), fp) != NULL) {
6306 if (sscanf (buf, "%u %u %u %n", &red, &green, &blue, &num) == 3)
6308 char *name = buf + num;
6309 num = strlen (name) - 1;
6310 if (num >= 0 && name[num] == '\n')
6311 name[num] = 0;
6312 cmap = Fcons (Fcons (build_string (name),
6313 #ifdef HAVE_NTGUI
6314 make_number (RGB (red, green, blue))),
6315 #else
6316 make_number ((red << 16) | (green << 8) | blue)),
6317 #endif
6318 cmap);
6321 fclose (fp);
6323 unblock_input ();
6326 return cmap;
6328 #endif
6331 /***********************************************************************
6332 Tests
6333 ***********************************************************************/
6335 #ifdef GLYPH_DEBUG
6337 /* Print the contents of the realized face FACE to stderr. */
6339 static void
6340 dump_realized_face (struct face *face)
6342 fprintf (stderr, "ID: %d\n", face->id);
6343 #ifdef HAVE_X_WINDOWS
6344 fprintf (stderr, "gc: %ld\n", (long) face->gc);
6345 #endif
6346 fprintf (stderr, "foreground: 0x%lx (%s)\n",
6347 face->foreground,
6348 SDATA (face->lface[LFACE_FOREGROUND_INDEX]));
6349 fprintf (stderr, "background: 0x%lx (%s)\n",
6350 face->background,
6351 SDATA (face->lface[LFACE_BACKGROUND_INDEX]));
6352 if (face->font)
6353 fprintf (stderr, "font_name: %s (%s)\n",
6354 SDATA (face->font->props[FONT_NAME_INDEX]),
6355 SDATA (face->lface[LFACE_FAMILY_INDEX]));
6356 #ifdef HAVE_X_WINDOWS
6357 fprintf (stderr, "font = %p\n", face->font);
6358 #endif
6359 fprintf (stderr, "fontset: %d\n", face->fontset);
6360 fprintf (stderr, "underline: %d (%s)\n",
6361 face->underline_p,
6362 SDATA (Fsymbol_name (face->lface[LFACE_UNDERLINE_INDEX])));
6363 fprintf (stderr, "hash: %d\n", face->hash);
6367 DEFUN ("dump-face", Fdump_face, Sdump_face, 0, 1, 0, doc: /* */)
6368 (Lisp_Object n)
6370 if (NILP (n))
6372 int i;
6374 fprintf (stderr, "font selection order: ");
6375 for (i = 0; i < DIM (font_sort_order); ++i)
6376 fprintf (stderr, "%d ", font_sort_order[i]);
6377 fprintf (stderr, "\n");
6379 fprintf (stderr, "alternative fonts: ");
6380 debug_print (Vface_alternative_font_family_alist);
6381 fprintf (stderr, "\n");
6383 for (i = 0; i < FRAME_FACE_CACHE (SELECTED_FRAME ())->used; ++i)
6384 Fdump_face (make_number (i));
6386 else
6388 struct face *face;
6389 CHECK_NUMBER (n);
6390 face = FACE_FROM_ID (SELECTED_FRAME (), XINT (n));
6391 if (face == NULL)
6392 error ("Not a valid face");
6393 dump_realized_face (face);
6396 return Qnil;
6400 DEFUN ("show-face-resources", Fshow_face_resources, Sshow_face_resources,
6401 0, 0, 0, doc: /* */)
6402 (void)
6404 fprintf (stderr, "number of colors = %d\n", ncolors_allocated);
6405 fprintf (stderr, "number of pixmaps = %d\n", npixmaps_allocated);
6406 fprintf (stderr, "number of GCs = %d\n", ngcs);
6407 return Qnil;
6410 #endif /* GLYPH_DEBUG */
6414 /***********************************************************************
6415 Initialization
6416 ***********************************************************************/
6418 void
6419 syms_of_xfaces (void)
6421 DEFSYM (Qface, "face");
6422 DEFSYM (Qface_no_inherit, "face-no-inherit");
6423 DEFSYM (Qbitmap_spec_p, "bitmap-spec-p");
6424 DEFSYM (Qframe_set_background_mode, "frame-set-background-mode");
6426 /* Lisp face attribute keywords. */
6427 DEFSYM (QCfamily, ":family");
6428 DEFSYM (QCheight, ":height");
6429 DEFSYM (QCweight, ":weight");
6430 DEFSYM (QCslant, ":slant");
6431 DEFSYM (QCunderline, ":underline");
6432 DEFSYM (QCinverse_video, ":inverse-video");
6433 DEFSYM (QCreverse_video, ":reverse-video");
6434 DEFSYM (QCforeground, ":foreground");
6435 DEFSYM (QCbackground, ":background");
6436 DEFSYM (QCstipple, ":stipple");
6437 DEFSYM (QCwidth, ":width");
6438 DEFSYM (QCfont, ":font");
6439 DEFSYM (QCfontset, ":fontset");
6440 DEFSYM (QCbold, ":bold");
6441 DEFSYM (QCitalic, ":italic");
6442 DEFSYM (QCoverline, ":overline");
6443 DEFSYM (QCstrike_through, ":strike-through");
6444 DEFSYM (QCbox, ":box");
6445 DEFSYM (QCinherit, ":inherit");
6447 /* Symbols used for Lisp face attribute values. */
6448 DEFSYM (QCcolor, ":color");
6449 DEFSYM (QCline_width, ":line-width");
6450 DEFSYM (QCstyle, ":style");
6451 DEFSYM (Qline, "line");
6452 DEFSYM (Qwave, "wave");
6453 DEFSYM (Qreleased_button, "released-button");
6454 DEFSYM (Qpressed_button, "pressed-button");
6455 DEFSYM (Qnormal, "normal");
6456 DEFSYM (Qextra_light, "extra-light");
6457 DEFSYM (Qlight, "light");
6458 DEFSYM (Qsemi_light, "semi-light");
6459 DEFSYM (Qsemi_bold, "semi-bold");
6460 DEFSYM (Qbold, "bold");
6461 DEFSYM (Qextra_bold, "extra-bold");
6462 DEFSYM (Qultra_bold, "ultra-bold");
6463 DEFSYM (Qoblique, "oblique");
6464 DEFSYM (Qitalic, "italic");
6465 DEFSYM (Qbackground_color, "background-color");
6466 DEFSYM (Qforeground_color, "foreground-color");
6467 DEFSYM (Qunspecified, "unspecified");
6468 DEFSYM (QCignore_defface, ":ignore-defface");
6470 DEFSYM (Qface_alias, "face-alias");
6471 DEFSYM (Qdefault, "default");
6472 DEFSYM (Qtool_bar, "tool-bar");
6473 DEFSYM (Qregion, "region");
6474 DEFSYM (Qfringe, "fringe");
6475 DEFSYM (Qheader_line, "header-line");
6476 DEFSYM (Qscroll_bar, "scroll-bar");
6477 DEFSYM (Qmenu, "menu");
6478 DEFSYM (Qcursor, "cursor");
6479 DEFSYM (Qborder, "border");
6480 DEFSYM (Qmouse, "mouse");
6481 DEFSYM (Qmode_line_inactive, "mode-line-inactive");
6482 DEFSYM (Qvertical_border, "vertical-border");
6483 DEFSYM (Qtty_color_desc, "tty-color-desc");
6484 DEFSYM (Qtty_color_standard_values, "tty-color-standard-values");
6485 DEFSYM (Qtty_color_by_index, "tty-color-by-index");
6486 DEFSYM (Qtty_color_alist, "tty-color-alist");
6487 DEFSYM (Qscalable_fonts_allowed, "scalable-fonts-allowed");
6489 Vparam_value_alist = Fcons (Fcons (Qnil, Qnil), Qnil);
6490 staticpro (&Vparam_value_alist);
6491 Vface_alternative_font_family_alist = Qnil;
6492 staticpro (&Vface_alternative_font_family_alist);
6493 Vface_alternative_font_registry_alist = Qnil;
6494 staticpro (&Vface_alternative_font_registry_alist);
6496 defsubr (&Sinternal_make_lisp_face);
6497 defsubr (&Sinternal_lisp_face_p);
6498 defsubr (&Sinternal_set_lisp_face_attribute);
6499 #ifdef HAVE_WINDOW_SYSTEM
6500 defsubr (&Sinternal_set_lisp_face_attribute_from_resource);
6501 #endif
6502 defsubr (&Scolor_gray_p);
6503 defsubr (&Scolor_supported_p);
6504 #ifndef HAVE_X_WINDOWS
6505 defsubr (&Sx_load_color_file);
6506 #endif
6507 defsubr (&Sface_attribute_relative_p);
6508 defsubr (&Smerge_face_attribute);
6509 defsubr (&Sinternal_get_lisp_face_attribute);
6510 defsubr (&Sinternal_lisp_face_attribute_values);
6511 defsubr (&Sinternal_lisp_face_equal_p);
6512 defsubr (&Sinternal_lisp_face_empty_p);
6513 defsubr (&Sinternal_copy_lisp_face);
6514 defsubr (&Sinternal_merge_in_global_face);
6515 defsubr (&Sface_font);
6516 defsubr (&Sframe_face_alist);
6517 defsubr (&Sdisplay_supports_face_attributes_p);
6518 defsubr (&Scolor_distance);
6519 defsubr (&Sinternal_set_font_selection_order);
6520 defsubr (&Sinternal_set_alternative_font_family_alist);
6521 defsubr (&Sinternal_set_alternative_font_registry_alist);
6522 defsubr (&Sface_attributes_as_vector);
6523 #ifdef GLYPH_DEBUG
6524 defsubr (&Sdump_face);
6525 defsubr (&Sshow_face_resources);
6526 #endif /* GLYPH_DEBUG */
6527 defsubr (&Sclear_face_cache);
6528 defsubr (&Stty_suppress_bold_inverse_default_colors);
6530 #if defined DEBUG_X_COLORS && defined HAVE_X_WINDOWS
6531 defsubr (&Sdump_colors);
6532 #endif
6534 DEFVAR_LISP ("face-new-frame-defaults", Vface_new_frame_defaults,
6535 doc: /* List of global face definitions (for internal use only.) */);
6536 Vface_new_frame_defaults = Qnil;
6538 DEFVAR_LISP ("face-default-stipple", Vface_default_stipple,
6539 doc: /* Default stipple pattern used on monochrome displays.
6540 This stipple pattern is used on monochrome displays
6541 instead of shades of gray for a face background color.
6542 See `set-face-stipple' for possible values for this variable. */);
6543 Vface_default_stipple = build_pure_c_string ("gray3");
6545 DEFVAR_LISP ("tty-defined-color-alist", Vtty_defined_color_alist,
6546 doc: /* An alist of defined terminal colors and their RGB values.
6547 See the docstring of `tty-color-alist' for the details. */);
6548 Vtty_defined_color_alist = Qnil;
6550 DEFVAR_LISP ("scalable-fonts-allowed", Vscalable_fonts_allowed,
6551 doc: /* Allowed scalable fonts.
6552 A value of nil means don't allow any scalable fonts.
6553 A value of t means allow any scalable font.
6554 Otherwise, value must be a list of regular expressions. A font may be
6555 scaled if its name matches a regular expression in the list.
6556 Note that if value is nil, a scalable font might still be used, if no
6557 other font of the appropriate family and registry is available. */);
6558 Vscalable_fonts_allowed = Qnil;
6560 DEFVAR_LISP ("face-ignored-fonts", Vface_ignored_fonts,
6561 doc: /* List of ignored fonts.
6562 Each element is a regular expression that matches names of fonts to
6563 ignore. */);
6564 Vface_ignored_fonts = Qnil;
6566 DEFVAR_LISP ("face-remapping-alist", Vface_remapping_alist,
6567 doc: /* Alist of face remappings.
6568 Each element is of the form:
6570 (FACE . REPLACEMENT),
6572 which causes display of the face FACE to use REPLACEMENT instead.
6573 REPLACEMENT is a face specification, i.e. one of the following:
6575 (1) a face name
6576 (2) a property list of attribute/value pairs, or
6577 (3) a list in which each element has the form of (1) or (2).
6579 List values for REPLACEMENT are merged to form the final face
6580 specification, with earlier entries taking precedence, in the same as
6581 as in the `face' text property.
6583 Face-name remapping cycles are suppressed; recursive references use
6584 the underlying face instead of the remapped face. So a remapping of
6585 the form:
6587 (FACE EXTRA-FACE... FACE)
6591 (FACE (FACE-ATTR VAL ...) FACE)
6593 causes EXTRA-FACE... or (FACE-ATTR VAL ...) to be _merged_ with the
6594 existing definition of FACE. Note that this isn't necessary for the
6595 default face, since every face inherits from the default face.
6597 If this variable is made buffer-local, the face remapping takes effect
6598 only in that buffer. For instance, the mode my-mode could define a
6599 face `my-mode-default', and then in the mode setup function, do:
6601 (set (make-local-variable 'face-remapping-alist)
6602 '((default my-mode-default)))).
6604 Because Emacs normally only redraws screen areas when the underlying
6605 buffer contents change, you may need to call `redraw-display' after
6606 changing this variable for it to take effect. */);
6607 Vface_remapping_alist = Qnil;
6609 DEFVAR_LISP ("face-font-rescale-alist", Vface_font_rescale_alist,
6610 doc: /* Alist of fonts vs the rescaling factors.
6611 Each element is a cons (FONT-PATTERN . RESCALE-RATIO), where
6612 FONT-PATTERN is a font-spec or a regular expression matching a font name, and
6613 RESCALE-RATIO is a floating point number to specify how much larger
6614 \(or smaller) font we should use. For instance, if a face requests
6615 a font of 10 point, we actually use a font of 10 * RESCALE-RATIO point. */);
6616 Vface_font_rescale_alist = Qnil;
6618 #ifdef HAVE_WINDOW_SYSTEM
6619 defsubr (&Sbitmap_spec_p);
6620 defsubr (&Sx_list_fonts);
6621 defsubr (&Sinternal_face_x_get_resource);
6622 defsubr (&Sx_family_fonts);
6623 #endif