Merge from trunk
[emacs.git] / src / xfaces.c
blob51e568547ee20677e5f36e32261d60bf90e04138
1 /* xfaces.c -- "Face" primitives.
3 Copyright (C) 1993-1994, 1998-2012 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 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 static Lisp_Object Qultra_light, Qreverse_oblique, Qreverse_italic;
318 Lisp_Object Qextra_light, Qlight;
319 Lisp_Object Qsemi_light, Qsemi_bold, Qextra_bold, Qultra_bold;
320 Lisp_Object Qoblique;
321 Lisp_Object Qitalic;
322 static Lisp_Object Qultra_condensed, Qextra_condensed;
323 Lisp_Object Qcondensed;
324 static Lisp_Object Qsemi_condensed, Qsemi_expanded, Qextra_expanded;
325 Lisp_Object Qexpanded;
326 static Lisp_Object Qultra_expanded;
327 static Lisp_Object Qreleased_button, Qpressed_button;
328 static Lisp_Object QCstyle, QCcolor, QCline_width;
329 Lisp_Object Qunspecified; /* used in dosfns.c */
330 static Lisp_Object QCignore_defface;
332 char unspecified_fg[] = "unspecified-fg", unspecified_bg[] = "unspecified-bg";
334 /* The name of the function to call when the background of the frame
335 has changed, frame_set_background_mode. */
337 static Lisp_Object Qframe_set_background_mode;
339 /* Names of basic faces. */
341 Lisp_Object Qdefault, Qtool_bar, Qfringe;
342 static Lisp_Object Qregion;
343 Lisp_Object Qheader_line, Qscroll_bar, Qcursor;
344 static Lisp_Object Qborder, Qmouse, Qmenu;
345 Lisp_Object Qmode_line_inactive;
346 static Lisp_Object Qvertical_border;
348 /* The symbol `face-alias'. A symbols having that property is an
349 alias for another face. Value of the property is the name of
350 the aliased face. */
352 static Lisp_Object Qface_alias;
354 /* Alist of alternative font families. Each element is of the form
355 (FAMILY FAMILY1 FAMILY2 ...). If fonts of FAMILY can't be loaded,
356 try FAMILY1, then FAMILY2, ... */
358 Lisp_Object Vface_alternative_font_family_alist;
360 /* Alist of alternative font registries. Each element is of the form
361 (REGISTRY REGISTRY1 REGISTRY2...). If fonts of REGISTRY can't be
362 loaded, try REGISTRY1, then REGISTRY2, ... */
364 Lisp_Object Vface_alternative_font_registry_alist;
366 /* Allowed scalable fonts. A value of nil means don't allow any
367 scalable fonts. A value of t means allow the use of any scalable
368 font. Otherwise, value must be a list of regular expressions. A
369 font may be scaled if its name matches a regular expression in the
370 list. */
372 static Lisp_Object Qscalable_fonts_allowed;
374 #define DEFAULT_FONT_LIST_LIMIT 100
376 /* The symbols `foreground-color' and `background-color' which can be
377 used as part of a `face' property. This is for compatibility with
378 Emacs 20.2. */
380 Lisp_Object Qforeground_color, Qbackground_color;
382 /* The symbols `face' and `mouse-face' used as text properties. */
384 Lisp_Object Qface;
386 /* Property for basic faces which other faces cannot inherit. */
388 static Lisp_Object Qface_no_inherit;
390 /* Error symbol for wrong_type_argument in load_pixmap. */
392 static Lisp_Object Qbitmap_spec_p;
394 /* The next ID to assign to Lisp faces. */
396 static int next_lface_id;
398 /* A vector mapping Lisp face Id's to face names. */
400 static Lisp_Object *lface_id_to_name;
401 static ptrdiff_t lface_id_to_name_size;
403 /* TTY color-related functions (defined in tty-colors.el). */
405 static Lisp_Object Qtty_color_desc, Qtty_color_by_index, Qtty_color_standard_values;
407 /* The name of the function used to compute colors on TTYs. */
409 static Lisp_Object Qtty_color_alist;
411 /* Counter for calls to clear_face_cache. If this counter reaches
412 CLEAR_FONT_TABLE_COUNT, and a frame has more than
413 CLEAR_FONT_TABLE_NFONTS load, unused fonts are freed. */
415 static int clear_font_table_count;
416 #define CLEAR_FONT_TABLE_COUNT 100
417 #define CLEAR_FONT_TABLE_NFONTS 10
419 /* Non-zero means face attributes have been changed since the last
420 redisplay. Used in redisplay_internal. */
422 int face_change_count;
424 /* Non-zero means don't display bold text if a face's foreground
425 and background colors are the inverse of the default colors of the
426 display. This is a kluge to suppress `bold black' foreground text
427 which is hard to read on an LCD monitor. */
429 static int tty_suppress_bold_inverse_default_colors_p;
431 /* A list of the form `((x . y))' used to avoid consing in
432 Finternal_set_lisp_face_attribute. */
434 static Lisp_Object Vparam_value_alist;
436 /* The total number of colors currently allocated. */
438 #ifdef GLYPH_DEBUG
439 static int ncolors_allocated;
440 static int npixmaps_allocated;
441 static int ngcs;
442 #endif
444 /* Non-zero means the definition of the `menu' face for new frames has
445 been changed. */
447 static int menu_face_changed_default;
450 /* Function prototypes. */
452 struct table_entry;
453 struct named_merge_point;
455 static void set_font_frame_param (Lisp_Object, Lisp_Object);
456 static struct face *realize_face (struct face_cache *, Lisp_Object *,
457 int);
458 static struct face *realize_non_ascii_face (struct frame *, Lisp_Object,
459 struct face *);
460 static struct face *realize_x_face (struct face_cache *, Lisp_Object *);
461 static struct face *realize_tty_face (struct face_cache *, Lisp_Object *);
462 static int realize_basic_faces (struct frame *);
463 static int realize_default_face (struct frame *);
464 static void realize_named_face (struct frame *, Lisp_Object, int);
465 static struct face_cache *make_face_cache (struct frame *);
466 static void clear_face_gcs (struct face_cache *);
467 static void free_face_cache (struct face_cache *);
468 static int merge_face_ref (struct frame *, Lisp_Object, Lisp_Object *,
469 int, struct named_merge_point *);
472 /***********************************************************************
473 Utilities
474 ***********************************************************************/
476 #ifdef HAVE_X_WINDOWS
478 #ifdef DEBUG_X_COLORS
480 /* The following is a poor mans infrastructure for debugging X color
481 allocation problems on displays with PseudoColor-8. Some X servers
482 like 3.3.5 XF86_SVGA with Matrox cards apparently don't implement
483 color reference counts completely so that they don't signal an
484 error when a color is freed whose reference count is already 0.
485 Other X servers do. To help me debug this, the following code
486 implements a simple reference counting schema of its own, for a
487 single display/screen. --gerd. */
489 /* Reference counts for pixel colors. */
491 int color_count[256];
493 /* Register color PIXEL as allocated. */
495 void
496 register_color (unsigned long pixel)
498 eassert (pixel < 256);
499 ++color_count[pixel];
503 /* Register color PIXEL as deallocated. */
505 void
506 unregister_color (unsigned long pixel)
508 eassert (pixel < 256);
509 if (color_count[pixel] > 0)
510 --color_count[pixel];
511 else
512 emacs_abort ();
516 /* Register N colors from PIXELS as deallocated. */
518 void
519 unregister_colors (unsigned long *pixels, int n)
521 int i;
522 for (i = 0; i < n; ++i)
523 unregister_color (pixels[i]);
527 DEFUN ("dump-colors", Fdump_colors, Sdump_colors, 0, 0, 0,
528 doc: /* Dump currently allocated colors to stderr. */)
529 (void)
531 int i, n;
533 fputc ('\n', stderr);
535 for (i = n = 0; i < sizeof color_count / sizeof color_count[0]; ++i)
536 if (color_count[i])
538 fprintf (stderr, "%3d: %5d", i, color_count[i]);
539 ++n;
540 if (n % 5 == 0)
541 fputc ('\n', stderr);
542 else
543 fputc ('\t', stderr);
546 if (n % 5 != 0)
547 fputc ('\n', stderr);
548 return Qnil;
551 #endif /* DEBUG_X_COLORS */
554 /* Free colors used on frame F. PIXELS is an array of NPIXELS pixel
555 color values. Interrupt input must be blocked when this function
556 is called. */
558 void
559 x_free_colors (struct frame *f, long unsigned int *pixels, int npixels)
561 int class = FRAME_X_DISPLAY_INFO (f)->visual->class;
563 /* If display has an immutable color map, freeing colors is not
564 necessary and some servers don't allow it. So don't do it. */
565 if (class != StaticColor && class != StaticGray && class != TrueColor)
567 #ifdef DEBUG_X_COLORS
568 unregister_colors (pixels, npixels);
569 #endif
570 XFreeColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
571 pixels, npixels, 0);
576 #ifdef USE_X_TOOLKIT
578 /* Free colors used on frame F. PIXELS is an array of NPIXELS pixel
579 color values. Interrupt input must be blocked when this function
580 is called. */
582 void
583 x_free_dpy_colors (Display *dpy, Screen *screen, Colormap cmap,
584 long unsigned int *pixels, int npixels)
586 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
587 int class = dpyinfo->visual->class;
589 /* If display has an immutable color map, freeing colors is not
590 necessary and some servers don't allow it. So don't do it. */
591 if (class != StaticColor && class != StaticGray && class != TrueColor)
593 #ifdef DEBUG_X_COLORS
594 unregister_colors (pixels, npixels);
595 #endif
596 XFreeColors (dpy, cmap, pixels, npixels, 0);
599 #endif /* USE_X_TOOLKIT */
601 /* Create and return a GC for use on frame F. GC values and mask
602 are given by XGCV and MASK. */
604 static inline GC
605 x_create_gc (struct frame *f, long unsigned int mask, XGCValues *xgcv)
607 GC gc;
608 BLOCK_INPUT;
609 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), mask, xgcv);
610 UNBLOCK_INPUT;
611 IF_DEBUG (++ngcs);
612 return gc;
616 /* Free GC which was used on frame F. */
618 static inline void
619 x_free_gc (struct frame *f, GC gc)
621 eassert (interrupt_input_blocked);
622 IF_DEBUG (eassert (--ngcs >= 0));
623 XFreeGC (FRAME_X_DISPLAY (f), gc);
626 #endif /* HAVE_X_WINDOWS */
628 #ifdef HAVE_NTGUI
629 /* W32 emulation of GCs */
631 static inline GC
632 x_create_gc (struct frame *f, unsigned long mask, XGCValues *xgcv)
634 GC gc;
635 BLOCK_INPUT;
636 gc = XCreateGC (NULL, FRAME_W32_WINDOW (f), mask, xgcv);
637 UNBLOCK_INPUT;
638 IF_DEBUG (++ngcs);
639 return gc;
643 /* Free GC which was used on frame F. */
645 static inline void
646 x_free_gc (struct frame *f, GC gc)
648 IF_DEBUG (eassert (--ngcs >= 0));
649 xfree (gc);
652 #endif /* HAVE_NTGUI */
654 #ifdef HAVE_NS
655 /* NS emulation of GCs */
657 static inline GC
658 x_create_gc (struct frame *f,
659 unsigned long mask,
660 XGCValues *xgcv)
662 GC gc = xmalloc (sizeof *gc);
663 *gc = *xgcv;
664 return gc;
667 static inline void
668 x_free_gc (struct frame *f, GC gc)
670 xfree (gc);
672 #endif /* HAVE_NS */
674 /* If FRAME is nil, return a pointer to the selected frame.
675 Otherwise, check that FRAME is a live frame, and return a pointer
676 to it. NPARAM is the parameter number of FRAME, for
677 CHECK_LIVE_FRAME. This is here because it's a frequent pattern in
678 Lisp function definitions. */
680 static inline struct frame *
681 frame_or_selected_frame (Lisp_Object frame, int nparam)
683 if (NILP (frame))
684 frame = selected_frame;
686 CHECK_LIVE_FRAME (frame);
687 return XFRAME (frame);
691 /***********************************************************************
692 Frames and faces
693 ***********************************************************************/
695 /* Initialize face cache and basic faces for frame F. */
697 void
698 init_frame_faces (struct frame *f)
700 /* Make a face cache, if F doesn't have one. */
701 if (FRAME_FACE_CACHE (f) == NULL)
702 FRAME_FACE_CACHE (f) = make_face_cache (f);
704 #ifdef HAVE_WINDOW_SYSTEM
705 /* Make the image cache. */
706 if (FRAME_WINDOW_P (f))
708 /* We initialize the image cache when creating the first frame
709 on a terminal, and not during terminal creation. This way,
710 `x-open-connection' on a tty won't create an image cache. */
711 if (FRAME_IMAGE_CACHE (f) == NULL)
712 FRAME_IMAGE_CACHE (f) = make_image_cache ();
713 ++FRAME_IMAGE_CACHE (f)->refcount;
715 #endif /* HAVE_WINDOW_SYSTEM */
717 /* Realize basic faces. Must have enough information in frame
718 parameters to realize basic faces at this point. */
719 #ifdef HAVE_X_WINDOWS
720 if (!FRAME_X_P (f) || FRAME_X_WINDOW (f))
721 #endif
722 #ifdef HAVE_NTGUI
723 if (!FRAME_WINDOW_P (f) || FRAME_W32_WINDOW (f))
724 #endif
725 #ifdef HAVE_NS
726 if (!FRAME_NS_P (f) || FRAME_NS_WINDOW (f))
727 #endif
728 if (!realize_basic_faces (f))
729 emacs_abort ();
733 /* Free face cache of frame F. Called from delete_frame. */
735 void
736 free_frame_faces (struct frame *f)
738 struct face_cache *face_cache = FRAME_FACE_CACHE (f);
740 if (face_cache)
742 free_face_cache (face_cache);
743 FRAME_FACE_CACHE (f) = NULL;
746 #ifdef HAVE_WINDOW_SYSTEM
747 if (FRAME_WINDOW_P (f))
749 struct image_cache *image_cache = FRAME_IMAGE_CACHE (f);
750 if (image_cache)
752 --image_cache->refcount;
753 if (image_cache->refcount == 0)
754 free_image_cache (f);
757 #endif /* HAVE_WINDOW_SYSTEM */
761 /* Clear face caches, and recompute basic faces for frame F. Call
762 this after changing frame parameters on which those faces depend,
763 or when realized faces have been freed due to changing attributes
764 of named faces. */
766 void
767 recompute_basic_faces (struct frame *f)
769 if (FRAME_FACE_CACHE (f))
771 clear_face_cache (0);
772 if (!realize_basic_faces (f))
773 emacs_abort ();
778 /* Clear the face caches of all frames. CLEAR_FONTS_P non-zero means
779 try to free unused fonts, too. */
781 void
782 clear_face_cache (int clear_fonts_p)
784 #ifdef HAVE_WINDOW_SYSTEM
785 Lisp_Object tail, frame;
787 if (clear_fonts_p
788 || ++clear_font_table_count == CLEAR_FONT_TABLE_COUNT)
790 #if 0
791 /* Not yet implemented. */
792 clear_font_cache (frame);
793 #endif
795 /* From time to time see if we can unload some fonts. This also
796 frees all realized faces on all frames. Fonts needed by
797 faces will be loaded again when faces are realized again. */
798 clear_font_table_count = 0;
800 FOR_EACH_FRAME (tail, frame)
802 struct frame *f = XFRAME (frame);
803 if (FRAME_WINDOW_P (f)
804 && FRAME_X_DISPLAY_INFO (f)->n_fonts > CLEAR_FONT_TABLE_NFONTS)
805 free_all_realized_faces (frame);
808 else
810 /* Clear GCs of realized faces. */
811 FOR_EACH_FRAME (tail, frame)
813 struct frame *f = XFRAME (frame);
814 if (FRAME_WINDOW_P (f))
815 clear_face_gcs (FRAME_FACE_CACHE (f));
817 clear_image_caches (Qnil);
819 #endif /* HAVE_WINDOW_SYSTEM */
823 DEFUN ("clear-face-cache", Fclear_face_cache, Sclear_face_cache, 0, 1, 0,
824 doc: /* Clear face caches on all frames.
825 Optional THOROUGHLY non-nil means try to free unused fonts, too. */)
826 (Lisp_Object thoroughly)
828 clear_face_cache (!NILP (thoroughly));
829 ++face_change_count;
830 ++windows_or_buffers_changed;
831 return Qnil;
835 /***********************************************************************
836 X Pixmaps
837 ***********************************************************************/
839 #ifdef HAVE_WINDOW_SYSTEM
841 DEFUN ("bitmap-spec-p", Fbitmap_spec_p, Sbitmap_spec_p, 1, 1, 0,
842 doc: /* Value is non-nil if OBJECT is a valid bitmap specification.
843 A bitmap specification is either a string, a file name, or a list
844 \(WIDTH HEIGHT DATA) where WIDTH is the pixel width of the bitmap,
845 HEIGHT is its height, and DATA is a string containing the bits of
846 the pixmap. Bits are stored row by row, each row occupies
847 \(WIDTH + 7)/8 bytes. */)
848 (Lisp_Object object)
850 int pixmap_p = 0;
852 if (STRINGP (object))
853 /* If OBJECT is a string, it's a file name. */
854 pixmap_p = 1;
855 else if (CONSP (object))
857 /* Otherwise OBJECT must be (WIDTH HEIGHT DATA), WIDTH and
858 HEIGHT must be ints > 0, and DATA must be string large
859 enough to hold a bitmap of the specified size. */
860 Lisp_Object width, height, data;
862 height = width = data = Qnil;
864 if (CONSP (object))
866 width = XCAR (object);
867 object = XCDR (object);
868 if (CONSP (object))
870 height = XCAR (object);
871 object = XCDR (object);
872 if (CONSP (object))
873 data = XCAR (object);
877 if (STRINGP (data)
878 && RANGED_INTEGERP (1, width, INT_MAX)
879 && RANGED_INTEGERP (1, height, INT_MAX))
881 int bytes_per_row = ((XINT (width) + BITS_PER_CHAR - 1)
882 / BITS_PER_CHAR);
883 if (XINT (height) <= SBYTES (data) / bytes_per_row)
884 pixmap_p = 1;
888 return pixmap_p ? Qt : Qnil;
892 /* Load a bitmap according to NAME (which is either a file name or a
893 pixmap spec) for use on frame F. Value is the bitmap_id (see
894 xfns.c). If NAME is nil, return with a bitmap id of zero. If
895 bitmap cannot be loaded, display a message saying so, and return
896 zero. Store the bitmap width in *W_PTR and its height in *H_PTR,
897 if these pointers are not null. */
899 static ptrdiff_t
900 load_pixmap (FRAME_PTR f, Lisp_Object name, unsigned int *w_ptr,
901 unsigned int *h_ptr)
903 ptrdiff_t bitmap_id;
905 if (NILP (name))
906 return 0;
908 CHECK_TYPE (!NILP (Fbitmap_spec_p (name)), Qbitmap_spec_p, name);
910 BLOCK_INPUT;
911 if (CONSP (name))
913 /* Decode a bitmap spec into a bitmap. */
915 int h, w;
916 Lisp_Object bits;
918 w = XINT (Fcar (name));
919 h = XINT (Fcar (Fcdr (name)));
920 bits = Fcar (Fcdr (Fcdr (name)));
922 bitmap_id = x_create_bitmap_from_data (f, SSDATA (bits),
923 w, h);
925 else
927 /* It must be a string -- a file name. */
928 bitmap_id = x_create_bitmap_from_file (f, name);
930 UNBLOCK_INPUT;
932 if (bitmap_id < 0)
934 add_to_log ("Invalid or undefined bitmap `%s'", name, Qnil);
935 bitmap_id = 0;
937 if (w_ptr)
938 *w_ptr = 0;
939 if (h_ptr)
940 *h_ptr = 0;
942 else
944 #ifdef GLYPH_DEBUG
945 ++npixmaps_allocated;
946 #endif
947 if (w_ptr)
948 *w_ptr = x_bitmap_width (f, bitmap_id);
950 if (h_ptr)
951 *h_ptr = x_bitmap_height (f, bitmap_id);
954 return bitmap_id;
957 #endif /* HAVE_WINDOW_SYSTEM */
961 /***********************************************************************
962 X Colors
963 ***********************************************************************/
965 /* Parse RGB_LIST, and fill in the RGB fields of COLOR.
966 RGB_LIST should contain (at least) 3 lisp integers.
967 Return 0 if there's a problem with RGB_LIST, otherwise return 1. */
969 static int
970 parse_rgb_list (Lisp_Object rgb_list, XColor *color)
972 #define PARSE_RGB_LIST_FIELD(field) \
973 if (CONSP (rgb_list) && INTEGERP (XCAR (rgb_list))) \
975 color->field = XINT (XCAR (rgb_list)); \
976 rgb_list = XCDR (rgb_list); \
978 else \
979 return 0;
981 PARSE_RGB_LIST_FIELD (red);
982 PARSE_RGB_LIST_FIELD (green);
983 PARSE_RGB_LIST_FIELD (blue);
985 return 1;
989 /* Lookup on frame F the color described by the lisp string COLOR.
990 The resulting tty color is returned in TTY_COLOR; if STD_COLOR is
991 non-zero, then the `standard' definition of the same color is
992 returned in it. */
994 static int
995 tty_lookup_color (struct frame *f, Lisp_Object color, XColor *tty_color,
996 XColor *std_color)
998 Lisp_Object frame, color_desc;
1000 if (!STRINGP (color) || NILP (Ffboundp (Qtty_color_desc)))
1001 return 0;
1003 XSETFRAME (frame, f);
1005 color_desc = call2 (Qtty_color_desc, color, frame);
1006 if (CONSP (color_desc) && CONSP (XCDR (color_desc)))
1008 Lisp_Object rgb;
1010 if (! INTEGERP (XCAR (XCDR (color_desc))))
1011 return 0;
1013 tty_color->pixel = XINT (XCAR (XCDR (color_desc)));
1015 rgb = XCDR (XCDR (color_desc));
1016 if (! parse_rgb_list (rgb, tty_color))
1017 return 0;
1019 /* Should we fill in STD_COLOR too? */
1020 if (std_color)
1022 /* Default STD_COLOR to the same as TTY_COLOR. */
1023 *std_color = *tty_color;
1025 /* Do a quick check to see if the returned descriptor is
1026 actually _exactly_ equal to COLOR, otherwise we have to
1027 lookup STD_COLOR separately. If it's impossible to lookup
1028 a standard color, we just give up and use TTY_COLOR. */
1029 if ((!STRINGP (XCAR (color_desc))
1030 || NILP (Fstring_equal (color, XCAR (color_desc))))
1031 && !NILP (Ffboundp (Qtty_color_standard_values)))
1033 /* Look up STD_COLOR separately. */
1034 rgb = call1 (Qtty_color_standard_values, color);
1035 if (! parse_rgb_list (rgb, std_color))
1036 return 0;
1040 return 1;
1042 else if (NILP (Fsymbol_value (intern ("tty-defined-color-alist"))))
1043 /* We were called early during startup, and the colors are not
1044 yet set up in tty-defined-color-alist. Don't return a failure
1045 indication, since this produces the annoying "Unable to
1046 load color" messages in the *Messages* buffer. */
1047 return 1;
1048 else
1049 /* tty-color-desc seems to have returned a bad value. */
1050 return 0;
1053 /* A version of defined_color for non-X frames. */
1055 static int
1056 tty_defined_color (struct frame *f, const char *color_name,
1057 XColor *color_def, int alloc)
1059 int status = 1;
1061 /* Defaults. */
1062 color_def->pixel = FACE_TTY_DEFAULT_COLOR;
1063 color_def->red = 0;
1064 color_def->blue = 0;
1065 color_def->green = 0;
1067 if (*color_name)
1068 status = tty_lookup_color (f, build_string (color_name), color_def, NULL);
1070 if (color_def->pixel == FACE_TTY_DEFAULT_COLOR && *color_name)
1072 if (strcmp (color_name, "unspecified-fg") == 0)
1073 color_def->pixel = FACE_TTY_DEFAULT_FG_COLOR;
1074 else if (strcmp (color_name, "unspecified-bg") == 0)
1075 color_def->pixel = FACE_TTY_DEFAULT_BG_COLOR;
1078 if (color_def->pixel != FACE_TTY_DEFAULT_COLOR)
1079 status = 1;
1081 return status;
1085 /* Decide if color named COLOR_NAME is valid for the display
1086 associated with the frame F; if so, return the rgb values in
1087 COLOR_DEF. If ALLOC is nonzero, allocate a new colormap cell.
1089 This does the right thing for any type of frame. */
1091 static int
1092 defined_color (struct frame *f, const char *color_name, XColor *color_def,
1093 int alloc)
1095 if (!FRAME_WINDOW_P (f))
1096 return tty_defined_color (f, color_name, color_def, alloc);
1097 #ifdef HAVE_X_WINDOWS
1098 else if (FRAME_X_P (f))
1099 return x_defined_color (f, color_name, color_def, alloc);
1100 #endif
1101 #ifdef HAVE_NTGUI
1102 else if (FRAME_W32_P (f))
1103 return w32_defined_color (f, color_name, color_def, alloc);
1104 #endif
1105 #ifdef HAVE_NS
1106 else if (FRAME_NS_P (f))
1107 return ns_defined_color (f, color_name, color_def, alloc, 1);
1108 #endif
1109 else
1110 emacs_abort ();
1114 /* Given the index IDX of a tty color on frame F, return its name, a
1115 Lisp string. */
1117 Lisp_Object
1118 tty_color_name (struct frame *f, int idx)
1120 if (idx >= 0 && !NILP (Ffboundp (Qtty_color_by_index)))
1122 Lisp_Object frame;
1123 Lisp_Object coldesc;
1125 XSETFRAME (frame, f);
1126 coldesc = call2 (Qtty_color_by_index, make_number (idx), frame);
1128 if (!NILP (coldesc))
1129 return XCAR (coldesc);
1131 #ifdef MSDOS
1132 /* We can have an MSDOG frame under -nw for a short window of
1133 opportunity before internal_terminal_init is called. DTRT. */
1134 if (FRAME_MSDOS_P (f) && !inhibit_window_system)
1135 return msdos_stdcolor_name (idx);
1136 #endif
1138 if (idx == FACE_TTY_DEFAULT_FG_COLOR)
1139 return build_string (unspecified_fg);
1140 if (idx == FACE_TTY_DEFAULT_BG_COLOR)
1141 return build_string (unspecified_bg);
1143 return Qunspecified;
1147 /* Return non-zero if COLOR_NAME is a shade of gray (or white or
1148 black) on frame F.
1150 The criterion implemented here is not a terribly sophisticated one. */
1152 static int
1153 face_color_gray_p (struct frame *f, const char *color_name)
1155 XColor color;
1156 int gray_p;
1158 if (defined_color (f, color_name, &color, 0))
1159 gray_p = (/* Any color sufficiently close to black counts as gray. */
1160 (color.red < 5000 && color.green < 5000 && color.blue < 5000)
1162 ((eabs (color.red - color.green)
1163 < max (color.red, color.green) / 20)
1164 && (eabs (color.green - color.blue)
1165 < max (color.green, color.blue) / 20)
1166 && (eabs (color.blue - color.red)
1167 < max (color.blue, color.red) / 20)));
1168 else
1169 gray_p = 0;
1171 return gray_p;
1175 /* Return non-zero if color COLOR_NAME can be displayed on frame F.
1176 BACKGROUND_P non-zero means the color will be used as background
1177 color. */
1179 static int
1180 face_color_supported_p (struct frame *f, const char *color_name,
1181 int background_p)
1183 Lisp_Object frame;
1184 XColor not_used;
1186 XSETFRAME (frame, f);
1187 return
1188 #ifdef HAVE_WINDOW_SYSTEM
1189 FRAME_WINDOW_P (f)
1190 ? (!NILP (Fxw_display_color_p (frame))
1191 || xstrcasecmp (color_name, "black") == 0
1192 || xstrcasecmp (color_name, "white") == 0
1193 || (background_p
1194 && face_color_gray_p (f, color_name))
1195 || (!NILP (Fx_display_grayscale_p (frame))
1196 && face_color_gray_p (f, color_name)))
1198 #endif
1199 tty_defined_color (f, color_name, &not_used, 0);
1203 DEFUN ("color-gray-p", Fcolor_gray_p, Scolor_gray_p, 1, 2, 0,
1204 doc: /* Return non-nil if COLOR is a shade of gray (or white or black).
1205 FRAME specifies the frame and thus the display for interpreting COLOR.
1206 If FRAME is nil or omitted, use the selected frame. */)
1207 (Lisp_Object color, Lisp_Object frame)
1209 struct frame *f;
1211 CHECK_STRING (color);
1212 if (NILP (frame))
1213 frame = selected_frame;
1214 else
1215 CHECK_FRAME (frame);
1216 f = XFRAME (frame);
1217 return face_color_gray_p (f, SSDATA (color)) ? Qt : Qnil;
1221 DEFUN ("color-supported-p", Fcolor_supported_p,
1222 Scolor_supported_p, 1, 3, 0,
1223 doc: /* Return non-nil if COLOR can be displayed on FRAME.
1224 BACKGROUND-P non-nil means COLOR is used as a background.
1225 Otherwise, this function tells whether it can be used as a foreground.
1226 If FRAME is nil or omitted, use the selected frame.
1227 COLOR must be a valid color name. */)
1228 (Lisp_Object color, Lisp_Object frame, Lisp_Object background_p)
1230 struct frame *f;
1232 CHECK_STRING (color);
1233 if (NILP (frame))
1234 frame = selected_frame;
1235 else
1236 CHECK_FRAME (frame);
1237 f = XFRAME (frame);
1238 if (face_color_supported_p (f, SSDATA (color), !NILP (background_p)))
1239 return Qt;
1240 return Qnil;
1244 /* Load color with name NAME for use by face FACE on frame F.
1245 TARGET_INDEX must be one of LFACE_FOREGROUND_INDEX,
1246 LFACE_BACKGROUND_INDEX, LFACE_UNDERLINE_INDEX, LFACE_OVERLINE_INDEX,
1247 LFACE_STRIKE_THROUGH_INDEX, or LFACE_BOX_INDEX. Value is the
1248 pixel color. If color cannot be loaded, display a message, and
1249 return the foreground, background or underline color of F, but
1250 record that fact in flags of the face so that we don't try to free
1251 these colors. */
1253 unsigned long
1254 load_color (struct frame *f, struct face *face, Lisp_Object name,
1255 enum lface_attribute_index target_index)
1257 XColor color;
1259 eassert (STRINGP (name));
1260 eassert (target_index == LFACE_FOREGROUND_INDEX
1261 || target_index == LFACE_BACKGROUND_INDEX
1262 || target_index == LFACE_UNDERLINE_INDEX
1263 || target_index == LFACE_OVERLINE_INDEX
1264 || target_index == LFACE_STRIKE_THROUGH_INDEX
1265 || target_index == LFACE_BOX_INDEX);
1267 /* if the color map is full, defined_color will return a best match
1268 to the values in an existing cell. */
1269 if (!defined_color (f, SSDATA (name), &color, 1))
1271 add_to_log ("Unable to load color \"%s\"", name, Qnil);
1273 switch (target_index)
1275 case LFACE_FOREGROUND_INDEX:
1276 face->foreground_defaulted_p = 1;
1277 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1278 break;
1280 case LFACE_BACKGROUND_INDEX:
1281 face->background_defaulted_p = 1;
1282 color.pixel = FRAME_BACKGROUND_PIXEL (f);
1283 break;
1285 case LFACE_UNDERLINE_INDEX:
1286 face->underline_defaulted_p = 1;
1287 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1288 break;
1290 case LFACE_OVERLINE_INDEX:
1291 face->overline_color_defaulted_p = 1;
1292 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1293 break;
1295 case LFACE_STRIKE_THROUGH_INDEX:
1296 face->strike_through_color_defaulted_p = 1;
1297 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1298 break;
1300 case LFACE_BOX_INDEX:
1301 face->box_color_defaulted_p = 1;
1302 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1303 break;
1305 default:
1306 emacs_abort ();
1309 #ifdef GLYPH_DEBUG
1310 else
1311 ++ncolors_allocated;
1312 #endif
1314 return color.pixel;
1318 #ifdef HAVE_WINDOW_SYSTEM
1320 /* Load colors for face FACE which is used on frame F. Colors are
1321 specified by slots LFACE_BACKGROUND_INDEX and LFACE_FOREGROUND_INDEX
1322 of ATTRS. If the background color specified is not supported on F,
1323 try to emulate gray colors with a stipple from Vface_default_stipple. */
1325 static void
1326 load_face_colors (struct frame *f, struct face *face, Lisp_Object *attrs)
1328 Lisp_Object fg, bg;
1330 bg = attrs[LFACE_BACKGROUND_INDEX];
1331 fg = attrs[LFACE_FOREGROUND_INDEX];
1333 /* Swap colors if face is inverse-video. */
1334 if (EQ (attrs[LFACE_INVERSE_INDEX], Qt))
1336 Lisp_Object tmp;
1337 tmp = fg;
1338 fg = bg;
1339 bg = tmp;
1342 /* Check for support for foreground, not for background because
1343 face_color_supported_p is smart enough to know that grays are
1344 "supported" as background because we are supposed to use stipple
1345 for them. */
1346 if (!face_color_supported_p (f, SSDATA (bg), 0)
1347 && !NILP (Fbitmap_spec_p (Vface_default_stipple)))
1349 x_destroy_bitmap (f, face->stipple);
1350 face->stipple = load_pixmap (f, Vface_default_stipple,
1351 &face->pixmap_w, &face->pixmap_h);
1354 face->background = load_color (f, face, bg, LFACE_BACKGROUND_INDEX);
1355 face->foreground = load_color (f, face, fg, LFACE_FOREGROUND_INDEX);
1359 /* Free color PIXEL on frame F. */
1361 void
1362 unload_color (struct frame *f, long unsigned int pixel)
1364 #ifdef HAVE_X_WINDOWS
1365 if (pixel != -1)
1367 BLOCK_INPUT;
1368 x_free_colors (f, &pixel, 1);
1369 UNBLOCK_INPUT;
1371 #endif
1375 /* Free colors allocated for FACE. */
1377 static void
1378 free_face_colors (struct frame *f, struct face *face)
1380 /* PENDING(NS): need to do something here? */
1381 #ifdef HAVE_X_WINDOWS
1382 if (face->colors_copied_bitwise_p)
1383 return;
1385 BLOCK_INPUT;
1387 if (!face->foreground_defaulted_p)
1389 x_free_colors (f, &face->foreground, 1);
1390 IF_DEBUG (--ncolors_allocated);
1393 if (!face->background_defaulted_p)
1395 x_free_colors (f, &face->background, 1);
1396 IF_DEBUG (--ncolors_allocated);
1399 if (face->underline_p
1400 && !face->underline_defaulted_p)
1402 x_free_colors (f, &face->underline_color, 1);
1403 IF_DEBUG (--ncolors_allocated);
1406 if (face->overline_p
1407 && !face->overline_color_defaulted_p)
1409 x_free_colors (f, &face->overline_color, 1);
1410 IF_DEBUG (--ncolors_allocated);
1413 if (face->strike_through_p
1414 && !face->strike_through_color_defaulted_p)
1416 x_free_colors (f, &face->strike_through_color, 1);
1417 IF_DEBUG (--ncolors_allocated);
1420 if (face->box != FACE_NO_BOX
1421 && !face->box_color_defaulted_p)
1423 x_free_colors (f, &face->box_color, 1);
1424 IF_DEBUG (--ncolors_allocated);
1427 UNBLOCK_INPUT;
1428 #endif /* HAVE_X_WINDOWS */
1431 #endif /* HAVE_WINDOW_SYSTEM */
1435 /***********************************************************************
1436 XLFD Font Names
1437 ***********************************************************************/
1439 /* An enumerator for each field of an XLFD font name. */
1441 enum xlfd_field
1443 XLFD_FOUNDRY,
1444 XLFD_FAMILY,
1445 XLFD_WEIGHT,
1446 XLFD_SLANT,
1447 XLFD_SWIDTH,
1448 XLFD_ADSTYLE,
1449 XLFD_PIXEL_SIZE,
1450 XLFD_POINT_SIZE,
1451 XLFD_RESX,
1452 XLFD_RESY,
1453 XLFD_SPACING,
1454 XLFD_AVGWIDTH,
1455 XLFD_REGISTRY,
1456 XLFD_ENCODING,
1457 XLFD_LAST
1460 /* An enumerator for each possible slant value of a font. Taken from
1461 the XLFD specification. */
1463 enum xlfd_slant
1465 XLFD_SLANT_UNKNOWN,
1466 XLFD_SLANT_ROMAN,
1467 XLFD_SLANT_ITALIC,
1468 XLFD_SLANT_OBLIQUE,
1469 XLFD_SLANT_REVERSE_ITALIC,
1470 XLFD_SLANT_REVERSE_OBLIQUE,
1471 XLFD_SLANT_OTHER
1474 /* Relative font weight according to XLFD documentation. */
1476 enum xlfd_weight
1478 XLFD_WEIGHT_UNKNOWN,
1479 XLFD_WEIGHT_ULTRA_LIGHT, /* 10 */
1480 XLFD_WEIGHT_EXTRA_LIGHT, /* 20 */
1481 XLFD_WEIGHT_LIGHT, /* 30 */
1482 XLFD_WEIGHT_SEMI_LIGHT, /* 40: SemiLight, Book, ... */
1483 XLFD_WEIGHT_MEDIUM, /* 50: Medium, Normal, Regular, ... */
1484 XLFD_WEIGHT_SEMI_BOLD, /* 60: SemiBold, DemiBold, ... */
1485 XLFD_WEIGHT_BOLD, /* 70: Bold, ... */
1486 XLFD_WEIGHT_EXTRA_BOLD, /* 80: ExtraBold, Heavy, ... */
1487 XLFD_WEIGHT_ULTRA_BOLD /* 90: UltraBold, Black, ... */
1490 /* Relative proportionate width. */
1492 enum xlfd_swidth
1494 XLFD_SWIDTH_UNKNOWN,
1495 XLFD_SWIDTH_ULTRA_CONDENSED, /* 10 */
1496 XLFD_SWIDTH_EXTRA_CONDENSED, /* 20 */
1497 XLFD_SWIDTH_CONDENSED, /* 30: Condensed, Narrow, Compressed, ... */
1498 XLFD_SWIDTH_SEMI_CONDENSED, /* 40: semicondensed */
1499 XLFD_SWIDTH_MEDIUM, /* 50: Medium, Normal, Regular, ... */
1500 XLFD_SWIDTH_SEMI_EXPANDED, /* 60: SemiExpanded, DemiExpanded, ... */
1501 XLFD_SWIDTH_EXPANDED, /* 70: Expanded... */
1502 XLFD_SWIDTH_EXTRA_EXPANDED, /* 80: ExtraExpanded, Wide... */
1503 XLFD_SWIDTH_ULTRA_EXPANDED /* 90: UltraExpanded... */
1506 /* Order by which font selection chooses fonts. The default values
1507 mean `first, find a best match for the font width, then for the
1508 font height, then for weight, then for slant.' This variable can be
1509 set via set-face-font-sort-order. */
1511 static int font_sort_order[4];
1513 #ifdef HAVE_WINDOW_SYSTEM
1515 static enum font_property_index font_props_for_sorting[FONT_SIZE_INDEX];
1517 static int
1518 compare_fonts_by_sort_order (const void *v1, const void *v2)
1520 Lisp_Object const *p1 = v1;
1521 Lisp_Object const *p2 = v2;
1522 Lisp_Object font1 = *p1;
1523 Lisp_Object font2 = *p2;
1524 int i;
1526 for (i = 0; i < FONT_SIZE_INDEX; i++)
1528 enum font_property_index idx = font_props_for_sorting[i];
1529 Lisp_Object val1 = AREF (font1, idx), val2 = AREF (font2, idx);
1530 int result;
1532 if (idx <= FONT_REGISTRY_INDEX)
1534 if (STRINGP (val1))
1535 result = STRINGP (val2) ? strcmp (SSDATA (val1), SSDATA (val2)) : -1;
1536 else
1537 result = STRINGP (val2) ? 1 : 0;
1539 else
1541 if (INTEGERP (val1))
1542 result = (INTEGERP (val2) && XINT (val1) >= XINT (val2)
1543 ? XINT (val1) > XINT (val2)
1544 : -1);
1545 else
1546 result = INTEGERP (val2) ? 1 : 0;
1548 if (result)
1549 return result;
1551 return 0;
1554 DEFUN ("x-family-fonts", Fx_family_fonts, Sx_family_fonts, 0, 2, 0,
1555 doc: /* Return a list of available fonts of family FAMILY on FRAME.
1556 If FAMILY is omitted or nil, list all families.
1557 Otherwise, FAMILY must be a string, possibly containing wildcards
1558 `?' and `*'.
1559 If FRAME is omitted or nil, use the selected frame.
1560 Each element of the result is a vector [FAMILY WIDTH POINT-SIZE WEIGHT
1561 SLANT FIXED-P FULL REGISTRY-AND-ENCODING].
1562 FAMILY is the font family name. POINT-SIZE is the size of the
1563 font in 1/10 pt. WIDTH, WEIGHT, and SLANT are symbols describing the
1564 width, weight and slant of the font. These symbols are the same as for
1565 face attributes. FIXED-P is non-nil if the font is fixed-pitch.
1566 FULL is the full name of the font, and REGISTRY-AND-ENCODING is a string
1567 giving the registry and encoding of the font.
1568 The result list is sorted according to the current setting of
1569 the face font sort order. */)
1570 (Lisp_Object family, Lisp_Object frame)
1572 Lisp_Object font_spec, list, *drivers, vec;
1573 ptrdiff_t i, nfonts;
1574 EMACS_INT ndrivers;
1575 Lisp_Object result;
1576 USE_SAFE_ALLOCA;
1578 if (NILP (frame))
1579 frame = selected_frame;
1580 CHECK_LIVE_FRAME (frame);
1582 font_spec = Ffont_spec (0, NULL);
1583 if (!NILP (family))
1585 CHECK_STRING (family);
1586 font_parse_family_registry (family, Qnil, font_spec);
1589 list = font_list_entities (frame, font_spec);
1590 if (NILP (list))
1591 return Qnil;
1593 /* Sort the font entities. */
1594 for (i = 0; i < 4; i++)
1595 switch (font_sort_order[i])
1597 case XLFD_SWIDTH:
1598 font_props_for_sorting[i] = FONT_WIDTH_INDEX; break;
1599 case XLFD_POINT_SIZE:
1600 font_props_for_sorting[i] = FONT_SIZE_INDEX; break;
1601 case XLFD_WEIGHT:
1602 font_props_for_sorting[i] = FONT_WEIGHT_INDEX; break;
1603 default:
1604 font_props_for_sorting[i] = FONT_SLANT_INDEX; break;
1606 font_props_for_sorting[i++] = FONT_FAMILY_INDEX;
1607 font_props_for_sorting[i++] = FONT_FOUNDRY_INDEX;
1608 font_props_for_sorting[i++] = FONT_ADSTYLE_INDEX;
1609 font_props_for_sorting[i++] = FONT_REGISTRY_INDEX;
1611 ndrivers = XINT (Flength (list));
1612 SAFE_ALLOCA_LISP (drivers, ndrivers);
1613 for (i = 0; i < ndrivers; i++, list = XCDR (list))
1614 drivers[i] = XCAR (list);
1615 vec = Fvconcat (ndrivers, drivers);
1616 nfonts = ASIZE (vec);
1618 qsort (XVECTOR (vec)->contents, nfonts, word_size,
1619 compare_fonts_by_sort_order);
1621 result = Qnil;
1622 for (i = nfonts - 1; i >= 0; --i)
1624 Lisp_Object font = AREF (vec, i);
1625 Lisp_Object v = Fmake_vector (make_number (8), Qnil);
1626 int point;
1627 Lisp_Object spacing;
1629 ASET (v, 0, AREF (font, FONT_FAMILY_INDEX));
1630 ASET (v, 1, FONT_WIDTH_SYMBOLIC (font));
1631 point = PIXEL_TO_POINT (XINT (AREF (font, FONT_SIZE_INDEX)) * 10,
1632 XFRAME (frame)->resy);
1633 ASET (v, 2, make_number (point));
1634 ASET (v, 3, FONT_WEIGHT_SYMBOLIC (font));
1635 ASET (v, 4, FONT_SLANT_SYMBOLIC (font));
1636 spacing = Ffont_get (font, QCspacing);
1637 ASET (v, 5, (NILP (spacing) || EQ (spacing, Qp)) ? Qnil : Qt);
1638 ASET (v, 6, Ffont_xlfd_name (font, Qnil));
1639 ASET (v, 7, AREF (font, FONT_REGISTRY_INDEX));
1641 result = Fcons (v, result);
1644 SAFE_FREE ();
1645 return result;
1648 DEFUN ("x-list-fonts", Fx_list_fonts, Sx_list_fonts, 1, 5, 0,
1649 doc: /* Return a list of the names of available fonts matching PATTERN.
1650 If optional arguments FACE and FRAME are specified, return only fonts
1651 the same size as FACE on FRAME.
1653 PATTERN should be a string containing a font name in the XLFD,
1654 Fontconfig, or GTK format. A font name given in the XLFD format may
1655 contain wildcard characters:
1656 the * character matches any substring, and
1657 the ? character matches any single character.
1658 PATTERN is case-insensitive.
1660 The return value is a list of strings, suitable as arguments to
1661 `set-face-font'.
1663 Fonts Emacs can't use may or may not be excluded
1664 even if they match PATTERN and FACE.
1665 The optional fourth argument MAXIMUM sets a limit on how many
1666 fonts to match. The first MAXIMUM fonts are reported.
1667 The optional fifth argument WIDTH, if specified, is a number of columns
1668 occupied by a character of a font. In that case, return only fonts
1669 the WIDTH times as wide as FACE on FRAME. */)
1670 (Lisp_Object pattern, Lisp_Object face, Lisp_Object frame,
1671 Lisp_Object maximum, Lisp_Object width)
1673 struct frame *f;
1674 int size, avgwidth IF_LINT (= 0);
1676 check_x ();
1677 CHECK_STRING (pattern);
1679 if (! NILP (maximum))
1680 CHECK_NATNUM (maximum);
1682 if (!NILP (width))
1683 CHECK_NUMBER (width);
1685 /* We can't simply call check_x_frame because this function may be
1686 called before any frame is created. */
1687 if (NILP (frame))
1688 frame = selected_frame;
1689 f = frame_or_selected_frame (frame, 2);
1690 if (! FRAME_WINDOW_P (f))
1692 /* Perhaps we have not yet created any frame. */
1693 f = NULL;
1694 frame = Qnil;
1695 face = Qnil;
1698 /* Determine the width standard for comparison with the fonts we find. */
1700 if (NILP (face))
1701 size = 0;
1702 else
1704 /* This is of limited utility since it works with character
1705 widths. Keep it for compatibility. --gerd. */
1706 int face_id = lookup_named_face (f, face, 0);
1707 struct face *width_face = (face_id < 0
1708 ? NULL
1709 : FACE_FROM_ID (f, face_id));
1711 if (width_face && width_face->font)
1713 size = width_face->font->pixel_size;
1714 avgwidth = width_face->font->average_width;
1716 else
1718 size = FRAME_FONT (f)->pixel_size;
1719 avgwidth = FRAME_FONT (f)->average_width;
1721 if (!NILP (width))
1722 avgwidth *= XINT (width);
1726 Lisp_Object font_spec;
1727 Lisp_Object args[2], tail;
1729 font_spec = font_spec_from_name (pattern);
1730 if (!FONTP (font_spec))
1731 signal_error ("Invalid font name", pattern);
1733 if (size)
1735 Ffont_put (font_spec, QCsize, make_number (size));
1736 Ffont_put (font_spec, QCavgwidth, make_number (avgwidth));
1738 args[0] = Flist_fonts (font_spec, frame, maximum, font_spec);
1739 for (tail = args[0]; CONSP (tail); tail = XCDR (tail))
1741 Lisp_Object font_entity;
1743 font_entity = XCAR (tail);
1744 if ((NILP (AREF (font_entity, FONT_SIZE_INDEX))
1745 || XINT (AREF (font_entity, FONT_SIZE_INDEX)) == 0)
1746 && ! NILP (AREF (font_spec, FONT_SIZE_INDEX)))
1748 /* This is a scalable font. For backward compatibility,
1749 we set the specified size. */
1750 font_entity = copy_font_spec (font_entity);
1751 ASET (font_entity, FONT_SIZE_INDEX,
1752 AREF (font_spec, FONT_SIZE_INDEX));
1754 XSETCAR (tail, Ffont_xlfd_name (font_entity, Qnil));
1756 if (NILP (frame))
1757 /* We don't have to check fontsets. */
1758 return args[0];
1759 args[1] = list_fontsets (f, pattern, size);
1760 return Fnconc (2, args);
1764 #endif /* HAVE_WINDOW_SYSTEM */
1767 /***********************************************************************
1768 Lisp Faces
1769 ***********************************************************************/
1771 /* Access face attributes of face LFACE, a Lisp vector. */
1773 #define LFACE_FAMILY(LFACE) AREF ((LFACE), LFACE_FAMILY_INDEX)
1774 #define LFACE_FOUNDRY(LFACE) AREF ((LFACE), LFACE_FOUNDRY_INDEX)
1775 #define LFACE_HEIGHT(LFACE) AREF ((LFACE), LFACE_HEIGHT_INDEX)
1776 #define LFACE_WEIGHT(LFACE) AREF ((LFACE), LFACE_WEIGHT_INDEX)
1777 #define LFACE_SLANT(LFACE) AREF ((LFACE), LFACE_SLANT_INDEX)
1778 #define LFACE_UNDERLINE(LFACE) AREF ((LFACE), LFACE_UNDERLINE_INDEX)
1779 #define LFACE_INVERSE(LFACE) AREF ((LFACE), LFACE_INVERSE_INDEX)
1780 #define LFACE_FOREGROUND(LFACE) AREF ((LFACE), LFACE_FOREGROUND_INDEX)
1781 #define LFACE_BACKGROUND(LFACE) AREF ((LFACE), LFACE_BACKGROUND_INDEX)
1782 #define LFACE_STIPPLE(LFACE) AREF ((LFACE), LFACE_STIPPLE_INDEX)
1783 #define LFACE_SWIDTH(LFACE) AREF ((LFACE), LFACE_SWIDTH_INDEX)
1784 #define LFACE_OVERLINE(LFACE) AREF ((LFACE), LFACE_OVERLINE_INDEX)
1785 #define LFACE_STRIKE_THROUGH(LFACE) AREF ((LFACE), LFACE_STRIKE_THROUGH_INDEX)
1786 #define LFACE_BOX(LFACE) AREF ((LFACE), LFACE_BOX_INDEX)
1787 #define LFACE_FONT(LFACE) AREF ((LFACE), LFACE_FONT_INDEX)
1788 #define LFACE_INHERIT(LFACE) AREF ((LFACE), LFACE_INHERIT_INDEX)
1789 #define LFACE_FONTSET(LFACE) AREF ((LFACE), LFACE_FONTSET_INDEX)
1791 /* Non-zero if LFACE is a Lisp face. A Lisp face is a vector of size
1792 LFACE_VECTOR_SIZE which has the symbol `face' in slot 0. */
1794 #define LFACEP(LFACE) \
1795 (VECTORP (LFACE) \
1796 && ASIZE (LFACE) == LFACE_VECTOR_SIZE \
1797 && EQ (AREF (LFACE, 0), Qface))
1800 #ifdef GLYPH_DEBUG
1802 /* Check consistency of Lisp face attribute vector ATTRS. */
1804 static void
1805 check_lface_attrs (Lisp_Object *attrs)
1807 eassert (UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
1808 || IGNORE_DEFFACE_P (attrs[LFACE_FAMILY_INDEX])
1809 || STRINGP (attrs[LFACE_FAMILY_INDEX]));
1810 eassert (UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
1811 || IGNORE_DEFFACE_P (attrs[LFACE_FOUNDRY_INDEX])
1812 || STRINGP (attrs[LFACE_FOUNDRY_INDEX]));
1813 eassert (UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
1814 || IGNORE_DEFFACE_P (attrs[LFACE_SWIDTH_INDEX])
1815 || SYMBOLP (attrs[LFACE_SWIDTH_INDEX]));
1816 eassert (UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
1817 || IGNORE_DEFFACE_P (attrs[LFACE_HEIGHT_INDEX])
1818 || INTEGERP (attrs[LFACE_HEIGHT_INDEX])
1819 || FLOATP (attrs[LFACE_HEIGHT_INDEX])
1820 || FUNCTIONP (attrs[LFACE_HEIGHT_INDEX]));
1821 eassert (UNSPECIFIEDP (attrs[LFACE_WEIGHT_INDEX])
1822 || IGNORE_DEFFACE_P (attrs[LFACE_WEIGHT_INDEX])
1823 || SYMBOLP (attrs[LFACE_WEIGHT_INDEX]));
1824 eassert (UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX])
1825 || IGNORE_DEFFACE_P (attrs[LFACE_SLANT_INDEX])
1826 || SYMBOLP (attrs[LFACE_SLANT_INDEX]));
1827 eassert (UNSPECIFIEDP (attrs[LFACE_UNDERLINE_INDEX])
1828 || IGNORE_DEFFACE_P (attrs[LFACE_UNDERLINE_INDEX])
1829 || SYMBOLP (attrs[LFACE_UNDERLINE_INDEX])
1830 || STRINGP (attrs[LFACE_UNDERLINE_INDEX])
1831 || CONSP (attrs[LFACE_UNDERLINE_INDEX]));
1832 eassert (UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
1833 || IGNORE_DEFFACE_P (attrs[LFACE_OVERLINE_INDEX])
1834 || SYMBOLP (attrs[LFACE_OVERLINE_INDEX])
1835 || STRINGP (attrs[LFACE_OVERLINE_INDEX]));
1836 eassert (UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
1837 || IGNORE_DEFFACE_P (attrs[LFACE_STRIKE_THROUGH_INDEX])
1838 || SYMBOLP (attrs[LFACE_STRIKE_THROUGH_INDEX])
1839 || STRINGP (attrs[LFACE_STRIKE_THROUGH_INDEX]));
1840 eassert (UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
1841 || IGNORE_DEFFACE_P (attrs[LFACE_BOX_INDEX])
1842 || SYMBOLP (attrs[LFACE_BOX_INDEX])
1843 || STRINGP (attrs[LFACE_BOX_INDEX])
1844 || INTEGERP (attrs[LFACE_BOX_INDEX])
1845 || CONSP (attrs[LFACE_BOX_INDEX]));
1846 eassert (UNSPECIFIEDP (attrs[LFACE_INVERSE_INDEX])
1847 || IGNORE_DEFFACE_P (attrs[LFACE_INVERSE_INDEX])
1848 || SYMBOLP (attrs[LFACE_INVERSE_INDEX]));
1849 eassert (UNSPECIFIEDP (attrs[LFACE_FOREGROUND_INDEX])
1850 || IGNORE_DEFFACE_P (attrs[LFACE_FOREGROUND_INDEX])
1851 || STRINGP (attrs[LFACE_FOREGROUND_INDEX]));
1852 eassert (UNSPECIFIEDP (attrs[LFACE_BACKGROUND_INDEX])
1853 || IGNORE_DEFFACE_P (attrs[LFACE_BACKGROUND_INDEX])
1854 || STRINGP (attrs[LFACE_BACKGROUND_INDEX]));
1855 eassert (UNSPECIFIEDP (attrs[LFACE_INHERIT_INDEX])
1856 || IGNORE_DEFFACE_P (attrs[LFACE_INHERIT_INDEX])
1857 || NILP (attrs[LFACE_INHERIT_INDEX])
1858 || SYMBOLP (attrs[LFACE_INHERIT_INDEX])
1859 || CONSP (attrs[LFACE_INHERIT_INDEX]));
1860 #ifdef HAVE_WINDOW_SYSTEM
1861 eassert (UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
1862 || IGNORE_DEFFACE_P (attrs[LFACE_STIPPLE_INDEX])
1863 || SYMBOLP (attrs[LFACE_STIPPLE_INDEX])
1864 || !NILP (Fbitmap_spec_p (attrs[LFACE_STIPPLE_INDEX])));
1865 eassert (UNSPECIFIEDP (attrs[LFACE_FONT_INDEX])
1866 || IGNORE_DEFFACE_P (attrs[LFACE_FONT_INDEX])
1867 || FONTP (attrs[LFACE_FONT_INDEX]));
1868 eassert (UNSPECIFIEDP (attrs[LFACE_FONTSET_INDEX])
1869 || STRINGP (attrs[LFACE_FONTSET_INDEX])
1870 || NILP (attrs[LFACE_FONTSET_INDEX]));
1871 #endif
1875 /* Check consistency of attributes of Lisp face LFACE (a Lisp vector). */
1877 static void
1878 check_lface (Lisp_Object lface)
1880 if (!NILP (lface))
1882 eassert (LFACEP (lface));
1883 check_lface_attrs (XVECTOR (lface)->contents);
1887 #else /* not GLYPH_DEBUG */
1889 #define check_lface_attrs(attrs) (void) 0
1890 #define check_lface(lface) (void) 0
1892 #endif /* GLYPH_DEBUG */
1896 /* Face-merge cycle checking. */
1898 enum named_merge_point_kind
1900 NAMED_MERGE_POINT_NORMAL,
1901 NAMED_MERGE_POINT_REMAP
1904 /* A `named merge point' is simply a point during face-merging where we
1905 look up a face by name. We keep a stack of which named lookups we're
1906 currently processing so that we can easily detect cycles, using a
1907 linked- list of struct named_merge_point structures, typically
1908 allocated on the stack frame of the named lookup functions which are
1909 active (so no consing is required). */
1910 struct named_merge_point
1912 Lisp_Object face_name;
1913 enum named_merge_point_kind named_merge_point_kind;
1914 struct named_merge_point *prev;
1918 /* If a face merging cycle is detected for FACE_NAME, return 0,
1919 otherwise add NEW_NAMED_MERGE_POINT, which is initialized using
1920 FACE_NAME and NAMED_MERGE_POINT_KIND, as the head of the linked list
1921 pointed to by NAMED_MERGE_POINTS, and return 1. */
1923 static inline int
1924 push_named_merge_point (struct named_merge_point *new_named_merge_point,
1925 Lisp_Object face_name,
1926 enum named_merge_point_kind named_merge_point_kind,
1927 struct named_merge_point **named_merge_points)
1929 struct named_merge_point *prev;
1931 for (prev = *named_merge_points; prev; prev = prev->prev)
1932 if (EQ (face_name, prev->face_name))
1934 if (prev->named_merge_point_kind == named_merge_point_kind)
1935 /* A cycle, so fail. */
1936 return 0;
1937 else if (prev->named_merge_point_kind == NAMED_MERGE_POINT_REMAP)
1938 /* A remap `hides ' any previous normal merge points
1939 (because the remap means that it's actually different face),
1940 so as we know the current merge point must be normal, we
1941 can just assume it's OK. */
1942 break;
1945 new_named_merge_point->face_name = face_name;
1946 new_named_merge_point->named_merge_point_kind = named_merge_point_kind;
1947 new_named_merge_point->prev = *named_merge_points;
1949 *named_merge_points = new_named_merge_point;
1951 return 1;
1955 /* Resolve face name FACE_NAME. If FACE_NAME is a string, intern it
1956 to make it a symbol. If FACE_NAME is an alias for another face,
1957 return that face's name.
1959 Return default face in case of errors. */
1961 static Lisp_Object
1962 resolve_face_name (Lisp_Object face_name, int signal_p)
1964 Lisp_Object orig_face;
1965 Lisp_Object tortoise, hare;
1967 if (STRINGP (face_name))
1968 face_name = intern (SSDATA (face_name));
1970 if (NILP (face_name) || !SYMBOLP (face_name))
1971 return face_name;
1973 orig_face = face_name;
1974 tortoise = hare = face_name;
1976 while (1)
1978 face_name = hare;
1979 hare = Fget (hare, Qface_alias);
1980 if (NILP (hare) || !SYMBOLP (hare))
1981 break;
1983 face_name = hare;
1984 hare = Fget (hare, Qface_alias);
1985 if (NILP (hare) || !SYMBOLP (hare))
1986 break;
1988 tortoise = Fget (tortoise, Qface_alias);
1989 if (EQ (hare, tortoise))
1991 if (signal_p)
1992 xsignal1 (Qcircular_list, orig_face);
1993 return Qdefault;
1997 return face_name;
2001 /* Return the face definition of FACE_NAME on frame F. F null means
2002 return the definition for new frames. FACE_NAME may be a string or
2003 a symbol (apparently Emacs 20.2 allowed strings as face names in
2004 face text properties; Ediff uses that). If SIGNAL_P is non-zero,
2005 signal an error if FACE_NAME is not a valid face name. If SIGNAL_P
2006 is zero, value is nil if FACE_NAME is not a valid face name. */
2007 static inline Lisp_Object
2008 lface_from_face_name_no_resolve (struct frame *f, Lisp_Object face_name,
2009 int signal_p)
2011 Lisp_Object lface;
2013 if (f)
2014 lface = assq_no_quit (face_name, f->face_alist);
2015 else
2016 lface = assq_no_quit (face_name, Vface_new_frame_defaults);
2018 if (CONSP (lface))
2019 lface = XCDR (lface);
2020 else if (signal_p)
2021 signal_error ("Invalid face", face_name);
2023 check_lface (lface);
2025 return lface;
2028 /* Return the face definition of FACE_NAME on frame F. F null means
2029 return the definition for new frames. FACE_NAME may be a string or
2030 a symbol (apparently Emacs 20.2 allowed strings as face names in
2031 face text properties; Ediff uses that). If FACE_NAME is an alias
2032 for another face, return that face's definition. If SIGNAL_P is
2033 non-zero, signal an error if FACE_NAME is not a valid face name.
2034 If SIGNAL_P is zero, value is nil if FACE_NAME is not a valid face
2035 name. */
2036 static inline Lisp_Object
2037 lface_from_face_name (struct frame *f, Lisp_Object face_name, int signal_p)
2039 face_name = resolve_face_name (face_name, signal_p);
2040 return lface_from_face_name_no_resolve (f, face_name, signal_p);
2044 /* Get face attributes of face FACE_NAME from frame-local faces on
2045 frame F. Store the resulting attributes in ATTRS which must point
2046 to a vector of Lisp_Objects of size LFACE_VECTOR_SIZE. If SIGNAL_P
2047 is non-zero, signal an error if FACE_NAME does not name a face.
2048 Otherwise, value is zero if FACE_NAME is not a face. */
2050 static inline int
2051 get_lface_attributes_no_remap (struct frame *f, Lisp_Object face_name,
2052 Lisp_Object *attrs, int signal_p)
2054 Lisp_Object lface;
2056 lface = lface_from_face_name_no_resolve (f, face_name, signal_p);
2058 if (! NILP (lface))
2059 memcpy (attrs, XVECTOR (lface)->contents,
2060 LFACE_VECTOR_SIZE * sizeof *attrs);
2062 return !NILP (lface);
2065 /* Get face attributes of face FACE_NAME from frame-local faces on frame
2066 F. Store the resulting attributes in ATTRS which must point to a
2067 vector of Lisp_Objects of size LFACE_VECTOR_SIZE. If FACE_NAME is an
2068 alias for another face, use that face's definition. If SIGNAL_P is
2069 non-zero, signal an error if FACE_NAME does not name a face.
2070 Otherwise, value is zero if FACE_NAME is not a face. */
2072 static inline int
2073 get_lface_attributes (struct frame *f, Lisp_Object face_name,
2074 Lisp_Object *attrs, int signal_p,
2075 struct named_merge_point *named_merge_points)
2077 Lisp_Object face_remapping;
2079 face_name = resolve_face_name (face_name, signal_p);
2081 /* See if SYMBOL has been remapped to some other face (usually this
2082 is done buffer-locally). */
2083 face_remapping = assq_no_quit (face_name, Vface_remapping_alist);
2084 if (CONSP (face_remapping))
2086 struct named_merge_point named_merge_point;
2088 if (push_named_merge_point (&named_merge_point,
2089 face_name, NAMED_MERGE_POINT_REMAP,
2090 &named_merge_points))
2092 int i;
2094 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2095 attrs[i] = Qunspecified;
2097 return merge_face_ref (f, XCDR (face_remapping), attrs,
2098 signal_p, named_merge_points);
2102 /* Default case, no remapping. */
2103 return get_lface_attributes_no_remap (f, face_name, attrs, signal_p);
2107 /* Non-zero if all attributes in face attribute vector ATTRS are
2108 specified, i.e. are non-nil. */
2110 static int
2111 lface_fully_specified_p (Lisp_Object *attrs)
2113 int i;
2115 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2116 if (i != LFACE_FONT_INDEX && i != LFACE_INHERIT_INDEX)
2117 if ((UNSPECIFIEDP (attrs[i]) || IGNORE_DEFFACE_P (attrs[i])))
2118 break;
2120 return i == LFACE_VECTOR_SIZE;
2123 #ifdef HAVE_WINDOW_SYSTEM
2125 /* Set font-related attributes of Lisp face LFACE from FONT-OBJECT.
2126 If FORCE_P is zero, set only unspecified attributes of LFACE. The
2127 exception is `font' attribute. It is set to FONT_OBJECT regardless
2128 of FORCE_P. */
2130 static int
2131 set_lface_from_font (struct frame *f, Lisp_Object lface,
2132 Lisp_Object font_object, int force_p)
2134 Lisp_Object val;
2135 struct font *font = XFONT_OBJECT (font_object);
2137 /* Set attributes only if unspecified, otherwise face defaults for
2138 new frames would never take effect. If the font doesn't have a
2139 specific property, set a normal value for that. */
2141 if (force_p || UNSPECIFIEDP (LFACE_FAMILY (lface)))
2143 Lisp_Object family = AREF (font_object, FONT_FAMILY_INDEX);
2145 ASET (lface, LFACE_FAMILY_INDEX, SYMBOL_NAME (family));
2148 if (force_p || UNSPECIFIEDP (LFACE_FOUNDRY (lface)))
2150 Lisp_Object foundry = AREF (font_object, FONT_FOUNDRY_INDEX);
2152 ASET (lface, LFACE_FOUNDRY_INDEX, SYMBOL_NAME (foundry));
2155 if (force_p || UNSPECIFIEDP (LFACE_HEIGHT (lface)))
2157 int pt = PIXEL_TO_POINT (font->pixel_size * 10, f->resy);
2159 eassert (pt > 0);
2160 ASET (lface, LFACE_HEIGHT_INDEX, make_number (pt));
2163 if (force_p || UNSPECIFIEDP (LFACE_WEIGHT (lface)))
2165 val = FONT_WEIGHT_FOR_FACE (font_object);
2166 ASET (lface, LFACE_WEIGHT_INDEX, ! NILP (val) ? val :Qnormal);
2168 if (force_p || UNSPECIFIEDP (LFACE_SLANT (lface)))
2170 val = FONT_SLANT_FOR_FACE (font_object);
2171 ASET (lface, LFACE_SLANT_INDEX, ! NILP (val) ? val : Qnormal);
2173 if (force_p || UNSPECIFIEDP (LFACE_SWIDTH (lface)))
2175 val = FONT_WIDTH_FOR_FACE (font_object);
2176 ASET (lface, LFACE_SWIDTH_INDEX, ! NILP (val) ? val : Qnormal);
2179 ASET (lface, LFACE_FONT_INDEX, font_object);
2180 return 1;
2183 #endif /* HAVE_WINDOW_SYSTEM */
2186 /* Merges the face height FROM with the face height TO, and returns the
2187 merged height. If FROM is an invalid height, then INVALID is
2188 returned instead. FROM and TO may be either absolute face heights or
2189 `relative' heights; the returned value is always an absolute height
2190 unless both FROM and TO are relative. */
2192 static Lisp_Object
2193 merge_face_heights (Lisp_Object from, Lisp_Object to, Lisp_Object invalid)
2195 Lisp_Object result = invalid;
2197 if (INTEGERP (from))
2198 /* FROM is absolute, just use it as is. */
2199 result = from;
2200 else if (FLOATP (from))
2201 /* FROM is a scale, use it to adjust TO. */
2203 if (INTEGERP (to))
2204 /* relative X absolute => absolute */
2205 result = make_number (XFLOAT_DATA (from) * XINT (to));
2206 else if (FLOATP (to))
2207 /* relative X relative => relative */
2208 result = make_float (XFLOAT_DATA (from) * XFLOAT_DATA (to));
2209 else if (UNSPECIFIEDP (to))
2210 result = from;
2212 else if (FUNCTIONP (from))
2213 /* FROM is a function, which use to adjust TO. */
2215 /* Call function with current height as argument.
2216 From is the new height. */
2217 result = safe_call1 (from, to);
2219 /* Ensure that if TO was absolute, so is the result. */
2220 if (INTEGERP (to) && !INTEGERP (result))
2221 result = invalid;
2224 return result;
2228 /* Merge two Lisp face attribute vectors on frame F, FROM and TO, and
2229 store the resulting attributes in TO, which must be already be
2230 completely specified and contain only absolute attributes. Every
2231 specified attribute of FROM overrides the corresponding attribute of
2232 TO; relative attributes in FROM are merged with the absolute value in
2233 TO and replace it. NAMED_MERGE_POINTS is used internally to detect
2234 loops in face inheritance/remapping; it should be 0 when called from
2235 other places. */
2237 static inline void
2238 merge_face_vectors (struct frame *f, Lisp_Object *from, Lisp_Object *to,
2239 struct named_merge_point *named_merge_points)
2241 int i;
2242 Lisp_Object font = Qnil;
2244 /* If FROM inherits from some other faces, merge their attributes into
2245 TO before merging FROM's direct attributes. Note that an :inherit
2246 attribute of `unspecified' is the same as one of nil; we never
2247 merge :inherit attributes, so nil is more correct, but lots of
2248 other code uses `unspecified' as a generic value for face attributes. */
2249 if (!UNSPECIFIEDP (from[LFACE_INHERIT_INDEX])
2250 && !NILP (from[LFACE_INHERIT_INDEX]))
2251 merge_face_ref (f, from[LFACE_INHERIT_INDEX], to, 0, named_merge_points);
2253 if (FONT_SPEC_P (from[LFACE_FONT_INDEX]))
2255 if (!UNSPECIFIEDP (to[LFACE_FONT_INDEX]))
2256 font = merge_font_spec (from[LFACE_FONT_INDEX], to[LFACE_FONT_INDEX]);
2257 else
2258 font = copy_font_spec (from[LFACE_FONT_INDEX]);
2259 to[LFACE_FONT_INDEX] = font;
2262 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2263 if (!UNSPECIFIEDP (from[i]))
2265 if (i == LFACE_HEIGHT_INDEX && !INTEGERP (from[i]))
2267 to[i] = merge_face_heights (from[i], to[i], to[i]);
2268 font_clear_prop (to, FONT_SIZE_INDEX);
2270 else if (i != LFACE_FONT_INDEX && ! EQ (to[i], from[i]))
2272 to[i] = from[i];
2273 if (i >= LFACE_FAMILY_INDEX && i <=LFACE_SLANT_INDEX)
2274 font_clear_prop (to,
2275 (i == LFACE_FAMILY_INDEX ? FONT_FAMILY_INDEX
2276 : i == LFACE_FOUNDRY_INDEX ? FONT_FOUNDRY_INDEX
2277 : i == LFACE_SWIDTH_INDEX ? FONT_WIDTH_INDEX
2278 : i == LFACE_HEIGHT_INDEX ? FONT_SIZE_INDEX
2279 : i == LFACE_WEIGHT_INDEX ? FONT_WEIGHT_INDEX
2280 : FONT_SLANT_INDEX));
2284 /* If FROM specifies a font spec, make its contents take precedence
2285 over :family and other attributes. This is needed for face
2286 remapping using :font to work. */
2288 if (!NILP (font))
2290 if (! NILP (AREF (font, FONT_FOUNDRY_INDEX)))
2291 to[LFACE_FOUNDRY_INDEX] = SYMBOL_NAME (AREF (font, FONT_FOUNDRY_INDEX));
2292 if (! NILP (AREF (font, FONT_FAMILY_INDEX)))
2293 to[LFACE_FAMILY_INDEX] = SYMBOL_NAME (AREF (font, FONT_FAMILY_INDEX));
2294 if (! NILP (AREF (font, FONT_WEIGHT_INDEX)))
2295 to[LFACE_WEIGHT_INDEX] = FONT_WEIGHT_FOR_FACE (font);
2296 if (! NILP (AREF (font, FONT_SLANT_INDEX)))
2297 to[LFACE_SLANT_INDEX] = FONT_SLANT_FOR_FACE (font);
2298 if (! NILP (AREF (font, FONT_WIDTH_INDEX)))
2299 to[LFACE_SWIDTH_INDEX] = FONT_WIDTH_FOR_FACE (font);
2300 ASET (font, FONT_SIZE_INDEX, Qnil);
2303 /* TO is always an absolute face, which should inherit from nothing.
2304 We blindly copy the :inherit attribute above and fix it up here. */
2305 to[LFACE_INHERIT_INDEX] = Qnil;
2308 /* Merge the named face FACE_NAME on frame F, into the vector of face
2309 attributes TO. NAMED_MERGE_POINTS is used to detect loops in face
2310 inheritance. Returns true if FACE_NAME is a valid face name and
2311 merging succeeded. */
2313 static int
2314 merge_named_face (struct frame *f, Lisp_Object face_name, Lisp_Object *to,
2315 struct named_merge_point *named_merge_points)
2317 struct named_merge_point named_merge_point;
2319 if (push_named_merge_point (&named_merge_point,
2320 face_name, NAMED_MERGE_POINT_NORMAL,
2321 &named_merge_points))
2323 struct gcpro gcpro1;
2324 Lisp_Object from[LFACE_VECTOR_SIZE];
2325 int ok = get_lface_attributes (f, face_name, from, 0, named_merge_points);
2327 if (ok)
2329 GCPRO1 (named_merge_point.face_name);
2330 merge_face_vectors (f, from, to, named_merge_points);
2331 UNGCPRO;
2334 return ok;
2336 else
2337 return 0;
2341 /* Merge face attributes from the lisp `face reference' FACE_REF on
2342 frame F into the face attribute vector TO. If ERR_MSGS is non-zero,
2343 problems with FACE_REF cause an error message to be shown. Return
2344 non-zero if no errors occurred (regardless of the value of ERR_MSGS).
2345 NAMED_MERGE_POINTS is used to detect loops in face inheritance or
2346 list structure; it may be 0 for most callers.
2348 FACE_REF may be a single face specification or a list of such
2349 specifications. Each face specification can be:
2351 1. A symbol or string naming a Lisp face.
2353 2. A property list of the form (KEYWORD VALUE ...) where each
2354 KEYWORD is a face attribute name, and value is an appropriate value
2355 for that attribute.
2357 3. Conses or the form (FOREGROUND-COLOR . COLOR) or
2358 (BACKGROUND-COLOR . COLOR) where COLOR is a color name. This is
2359 for compatibility with 20.2.
2361 Face specifications earlier in lists take precedence over later
2362 specifications. */
2364 static int
2365 merge_face_ref (struct frame *f, Lisp_Object face_ref, Lisp_Object *to,
2366 int err_msgs, struct named_merge_point *named_merge_points)
2368 int ok = 1; /* Succeed without an error? */
2370 if (CONSP (face_ref))
2372 Lisp_Object first = XCAR (face_ref);
2374 if (EQ (first, Qforeground_color)
2375 || EQ (first, Qbackground_color))
2377 /* One of (FOREGROUND-COLOR . COLOR) or (BACKGROUND-COLOR
2378 . COLOR). COLOR must be a string. */
2379 Lisp_Object color_name = XCDR (face_ref);
2380 Lisp_Object color = first;
2382 if (STRINGP (color_name))
2384 if (EQ (color, Qforeground_color))
2385 to[LFACE_FOREGROUND_INDEX] = color_name;
2386 else
2387 to[LFACE_BACKGROUND_INDEX] = color_name;
2389 else
2391 if (err_msgs)
2392 add_to_log ("Invalid face color", color_name, Qnil);
2393 ok = 0;
2396 else if (SYMBOLP (first)
2397 && *SDATA (SYMBOL_NAME (first)) == ':')
2399 /* Assume this is the property list form. */
2400 while (CONSP (face_ref) && CONSP (XCDR (face_ref)))
2402 Lisp_Object keyword = XCAR (face_ref);
2403 Lisp_Object value = XCAR (XCDR (face_ref));
2404 int err = 0;
2406 /* Specifying `unspecified' is a no-op. */
2407 if (EQ (value, Qunspecified))
2409 else if (EQ (keyword, QCfamily))
2411 if (STRINGP (value))
2413 to[LFACE_FAMILY_INDEX] = value;
2414 font_clear_prop (to, FONT_FAMILY_INDEX);
2416 else
2417 err = 1;
2419 else if (EQ (keyword, QCfoundry))
2421 if (STRINGP (value))
2423 to[LFACE_FOUNDRY_INDEX] = value;
2424 font_clear_prop (to, FONT_FOUNDRY_INDEX);
2426 else
2427 err = 1;
2429 else if (EQ (keyword, QCheight))
2431 Lisp_Object new_height =
2432 merge_face_heights (value, to[LFACE_HEIGHT_INDEX], Qnil);
2434 if (! NILP (new_height))
2436 to[LFACE_HEIGHT_INDEX] = new_height;
2437 font_clear_prop (to, FONT_SIZE_INDEX);
2439 else
2440 err = 1;
2442 else if (EQ (keyword, QCweight))
2444 if (SYMBOLP (value) && FONT_WEIGHT_NAME_NUMERIC (value) >= 0)
2446 to[LFACE_WEIGHT_INDEX] = value;
2447 font_clear_prop (to, FONT_WEIGHT_INDEX);
2449 else
2450 err = 1;
2452 else if (EQ (keyword, QCslant))
2454 if (SYMBOLP (value) && FONT_SLANT_NAME_NUMERIC (value) >= 0)
2456 to[LFACE_SLANT_INDEX] = value;
2457 font_clear_prop (to, FONT_SLANT_INDEX);
2459 else
2460 err = 1;
2462 else if (EQ (keyword, QCunderline))
2464 if (EQ (value, Qt)
2465 || NILP (value)
2466 || STRINGP (value)
2467 || CONSP (value))
2468 to[LFACE_UNDERLINE_INDEX] = value;
2469 else
2470 err = 1;
2472 else if (EQ (keyword, QCoverline))
2474 if (EQ (value, Qt)
2475 || NILP (value)
2476 || STRINGP (value))
2477 to[LFACE_OVERLINE_INDEX] = value;
2478 else
2479 err = 1;
2481 else if (EQ (keyword, QCstrike_through))
2483 if (EQ (value, Qt)
2484 || NILP (value)
2485 || STRINGP (value))
2486 to[LFACE_STRIKE_THROUGH_INDEX] = value;
2487 else
2488 err = 1;
2490 else if (EQ (keyword, QCbox))
2492 if (EQ (value, Qt))
2493 value = make_number (1);
2494 if (INTEGERP (value)
2495 || STRINGP (value)
2496 || CONSP (value)
2497 || NILP (value))
2498 to[LFACE_BOX_INDEX] = value;
2499 else
2500 err = 1;
2502 else if (EQ (keyword, QCinverse_video)
2503 || EQ (keyword, QCreverse_video))
2505 if (EQ (value, Qt) || NILP (value))
2506 to[LFACE_INVERSE_INDEX] = value;
2507 else
2508 err = 1;
2510 else if (EQ (keyword, QCforeground))
2512 if (STRINGP (value))
2513 to[LFACE_FOREGROUND_INDEX] = value;
2514 else
2515 err = 1;
2517 else if (EQ (keyword, QCbackground))
2519 if (STRINGP (value))
2520 to[LFACE_BACKGROUND_INDEX] = value;
2521 else
2522 err = 1;
2524 else if (EQ (keyword, QCstipple))
2526 #if defined (HAVE_WINDOW_SYSTEM)
2527 Lisp_Object pixmap_p = Fbitmap_spec_p (value);
2528 if (!NILP (pixmap_p))
2529 to[LFACE_STIPPLE_INDEX] = value;
2530 else
2531 err = 1;
2532 #endif /* HAVE_WINDOW_SYSTEM */
2534 else if (EQ (keyword, QCwidth))
2536 if (SYMBOLP (value) && FONT_WIDTH_NAME_NUMERIC (value) >= 0)
2538 to[LFACE_SWIDTH_INDEX] = value;
2539 font_clear_prop (to, FONT_WIDTH_INDEX);
2541 else
2542 err = 1;
2544 else if (EQ (keyword, QCfont))
2546 if (FONTP (value))
2547 to[LFACE_FONT_INDEX] = value;
2548 else
2549 err = 1;
2551 else if (EQ (keyword, QCinherit))
2553 /* This is not really very useful; it's just like a
2554 normal face reference. */
2555 if (! merge_face_ref (f, value, to,
2556 err_msgs, named_merge_points))
2557 err = 1;
2559 else
2560 err = 1;
2562 if (err)
2564 add_to_log ("Invalid face attribute %S %S", keyword, value);
2565 ok = 0;
2568 face_ref = XCDR (XCDR (face_ref));
2571 else
2573 /* This is a list of face refs. Those at the beginning of the
2574 list take precedence over what follows, so we have to merge
2575 from the end backwards. */
2576 Lisp_Object next = XCDR (face_ref);
2578 if (! NILP (next))
2579 ok = merge_face_ref (f, next, to, err_msgs, named_merge_points);
2581 if (! merge_face_ref (f, first, to, err_msgs, named_merge_points))
2582 ok = 0;
2585 else
2587 /* FACE_REF ought to be a face name. */
2588 ok = merge_named_face (f, face_ref, to, named_merge_points);
2589 if (!ok && err_msgs)
2590 add_to_log ("Invalid face reference: %s", face_ref, Qnil);
2593 return ok;
2597 DEFUN ("internal-make-lisp-face", Finternal_make_lisp_face,
2598 Sinternal_make_lisp_face, 1, 2, 0,
2599 doc: /* Make FACE, a symbol, a Lisp face with all attributes nil.
2600 If FACE was not known as a face before, create a new one.
2601 If optional argument FRAME is specified, make a frame-local face
2602 for that frame. Otherwise operate on the global face definition.
2603 Value is a vector of face attributes. */)
2604 (Lisp_Object face, Lisp_Object frame)
2606 Lisp_Object global_lface, lface;
2607 struct frame *f;
2608 int i;
2610 CHECK_SYMBOL (face);
2611 global_lface = lface_from_face_name (NULL, face, 0);
2613 if (!NILP (frame))
2615 CHECK_LIVE_FRAME (frame);
2616 f = XFRAME (frame);
2617 lface = lface_from_face_name (f, face, 0);
2619 else
2620 f = NULL, lface = Qnil;
2622 /* Add a global definition if there is none. */
2623 if (NILP (global_lface))
2625 global_lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
2626 Qunspecified);
2627 ASET (global_lface, 0, Qface);
2628 Vface_new_frame_defaults = Fcons (Fcons (face, global_lface),
2629 Vface_new_frame_defaults);
2631 /* Assign the new Lisp face a unique ID. The mapping from Lisp
2632 face id to Lisp face is given by the vector lface_id_to_name.
2633 The mapping from Lisp face to Lisp face id is given by the
2634 property `face' of the Lisp face name. */
2635 if (next_lface_id == lface_id_to_name_size)
2636 lface_id_to_name =
2637 xpalloc (lface_id_to_name, &lface_id_to_name_size, 1, MAX_FACE_ID,
2638 sizeof *lface_id_to_name);
2640 lface_id_to_name[next_lface_id] = face;
2641 Fput (face, Qface, make_number (next_lface_id));
2642 ++next_lface_id;
2644 else if (f == NULL)
2645 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2646 ASET (global_lface, i, Qunspecified);
2648 /* Add a frame-local definition. */
2649 if (f)
2651 if (NILP (lface))
2653 lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
2654 Qunspecified);
2655 ASET (lface, 0, Qface);
2656 fset_face_alist (f, Fcons (Fcons (face, lface), f->face_alist));
2658 else
2659 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2660 ASET (lface, i, Qunspecified);
2662 else
2663 lface = global_lface;
2665 /* Changing a named face means that all realized faces depending on
2666 that face are invalid. Since we cannot tell which realized faces
2667 depend on the face, make sure they are all removed. This is done
2668 by incrementing face_change_count. The next call to
2669 init_iterator will then free realized faces. */
2670 if (NILP (Fget (face, Qface_no_inherit)))
2672 ++face_change_count;
2673 ++windows_or_buffers_changed;
2676 eassert (LFACEP (lface));
2677 check_lface (lface);
2678 return lface;
2682 DEFUN ("internal-lisp-face-p", Finternal_lisp_face_p,
2683 Sinternal_lisp_face_p, 1, 2, 0,
2684 doc: /* Return non-nil if FACE names a face.
2685 FACE should be a symbol or string.
2686 If optional second argument FRAME is non-nil, check for the
2687 existence of a frame-local face with name FACE on that frame.
2688 Otherwise check for the existence of a global face. */)
2689 (Lisp_Object face, Lisp_Object frame)
2691 Lisp_Object lface;
2693 face = resolve_face_name (face, 1);
2695 if (!NILP (frame))
2697 CHECK_LIVE_FRAME (frame);
2698 lface = lface_from_face_name (XFRAME (frame), face, 0);
2700 else
2701 lface = lface_from_face_name (NULL, face, 0);
2703 return lface;
2707 DEFUN ("internal-copy-lisp-face", Finternal_copy_lisp_face,
2708 Sinternal_copy_lisp_face, 4, 4, 0,
2709 doc: /* Copy face FROM to TO.
2710 If FRAME is t, copy the global face definition of FROM.
2711 Otherwise, copy the frame-local definition of FROM on FRAME.
2712 If NEW-FRAME is a frame, copy that data into the frame-local
2713 definition of TO on NEW-FRAME. If NEW-FRAME is nil,
2714 FRAME controls where the data is copied to.
2716 The value is TO. */)
2717 (Lisp_Object from, Lisp_Object to, Lisp_Object frame, Lisp_Object new_frame)
2719 Lisp_Object lface, copy;
2721 CHECK_SYMBOL (from);
2722 CHECK_SYMBOL (to);
2724 if (EQ (frame, Qt))
2726 /* Copy global definition of FROM. We don't make copies of
2727 strings etc. because 20.2 didn't do it either. */
2728 lface = lface_from_face_name (NULL, from, 1);
2729 copy = Finternal_make_lisp_face (to, Qnil);
2731 else
2733 /* Copy frame-local definition of FROM. */
2734 if (NILP (new_frame))
2735 new_frame = frame;
2736 CHECK_LIVE_FRAME (frame);
2737 CHECK_LIVE_FRAME (new_frame);
2738 lface = lface_from_face_name (XFRAME (frame), from, 1);
2739 copy = Finternal_make_lisp_face (to, new_frame);
2742 vcopy (copy, 0, XVECTOR (lface)->contents, LFACE_VECTOR_SIZE);
2744 /* Changing a named face means that all realized faces depending on
2745 that face are invalid. Since we cannot tell which realized faces
2746 depend on the face, make sure they are all removed. This is done
2747 by incrementing face_change_count. The next call to
2748 init_iterator will then free realized faces. */
2749 if (NILP (Fget (to, Qface_no_inherit)))
2751 ++face_change_count;
2752 ++windows_or_buffers_changed;
2755 return to;
2759 DEFUN ("internal-set-lisp-face-attribute", Finternal_set_lisp_face_attribute,
2760 Sinternal_set_lisp_face_attribute, 3, 4, 0,
2761 doc: /* Set attribute ATTR of FACE to VALUE.
2762 FRAME being a frame means change the face on that frame.
2763 FRAME nil means change the face of the selected frame.
2764 FRAME t means change the default for new frames.
2765 FRAME 0 means change the face on all frames, and change the default
2766 for new frames. */)
2767 (Lisp_Object face, Lisp_Object attr, Lisp_Object value, Lisp_Object frame)
2769 Lisp_Object lface;
2770 Lisp_Object old_value = Qnil;
2771 /* Set one of enum font_property_index (> 0) if ATTR is one of
2772 font-related attributes other than QCfont and QCfontset. */
2773 enum font_property_index prop_index = 0;
2775 CHECK_SYMBOL (face);
2776 CHECK_SYMBOL (attr);
2778 face = resolve_face_name (face, 1);
2780 /* If FRAME is 0, change face on all frames, and change the
2781 default for new frames. */
2782 if (INTEGERP (frame) && XINT (frame) == 0)
2784 Lisp_Object tail;
2785 Finternal_set_lisp_face_attribute (face, attr, value, Qt);
2786 FOR_EACH_FRAME (tail, frame)
2787 Finternal_set_lisp_face_attribute (face, attr, value, frame);
2788 return face;
2791 /* Set lface to the Lisp attribute vector of FACE. */
2792 if (EQ (frame, Qt))
2794 lface = lface_from_face_name (NULL, face, 1);
2796 /* When updating face-new-frame-defaults, we put :ignore-defface
2797 where the caller wants `unspecified'. This forces the frame
2798 defaults to ignore the defface value. Otherwise, the defface
2799 will take effect, which is generally not what is intended.
2800 The value of that attribute will be inherited from some other
2801 face during face merging. See internal_merge_in_global_face. */
2802 if (UNSPECIFIEDP (value))
2803 value = QCignore_defface;
2805 else
2807 if (NILP (frame))
2808 frame = selected_frame;
2810 CHECK_LIVE_FRAME (frame);
2811 lface = lface_from_face_name (XFRAME (frame), face, 0);
2813 /* If a frame-local face doesn't exist yet, create one. */
2814 if (NILP (lface))
2815 lface = Finternal_make_lisp_face (face, frame);
2818 if (EQ (attr, QCfamily))
2820 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2822 CHECK_STRING (value);
2823 if (SCHARS (value) == 0)
2824 signal_error ("Invalid face family", value);
2826 old_value = LFACE_FAMILY (lface);
2827 ASET (lface, LFACE_FAMILY_INDEX, value);
2828 prop_index = FONT_FAMILY_INDEX;
2830 else if (EQ (attr, QCfoundry))
2832 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2834 CHECK_STRING (value);
2835 if (SCHARS (value) == 0)
2836 signal_error ("Invalid face foundry", value);
2838 old_value = LFACE_FOUNDRY (lface);
2839 ASET (lface, LFACE_FOUNDRY_INDEX, value);
2840 prop_index = FONT_FOUNDRY_INDEX;
2842 else if (EQ (attr, QCheight))
2844 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2846 if (EQ (face, Qdefault))
2848 /* The default face must have an absolute size. */
2849 if (!INTEGERP (value) || XINT (value) <= 0)
2850 signal_error ("Default face height not absolute and positive",
2851 value);
2853 else
2855 /* For non-default faces, do a test merge with a random
2856 height to see if VALUE's ok. */
2857 Lisp_Object test = merge_face_heights (value,
2858 make_number (10),
2859 Qnil);
2860 if (!INTEGERP (test) || XINT (test) <= 0)
2861 signal_error ("Face height does not produce a positive integer",
2862 value);
2866 old_value = LFACE_HEIGHT (lface);
2867 ASET (lface, LFACE_HEIGHT_INDEX, value);
2868 prop_index = FONT_SIZE_INDEX;
2870 else if (EQ (attr, QCweight))
2872 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2874 CHECK_SYMBOL (value);
2875 if (FONT_WEIGHT_NAME_NUMERIC (value) < 0)
2876 signal_error ("Invalid face weight", value);
2878 old_value = LFACE_WEIGHT (lface);
2879 ASET (lface, LFACE_WEIGHT_INDEX, value);
2880 prop_index = FONT_WEIGHT_INDEX;
2882 else if (EQ (attr, QCslant))
2884 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2886 CHECK_SYMBOL (value);
2887 if (FONT_SLANT_NAME_NUMERIC (value) < 0)
2888 signal_error ("Invalid face slant", value);
2890 old_value = LFACE_SLANT (lface);
2891 ASET (lface, LFACE_SLANT_INDEX, value);
2892 prop_index = FONT_SLANT_INDEX;
2894 else if (EQ (attr, QCunderline))
2896 int valid_p = 0;
2898 if (UNSPECIFIEDP (value) || IGNORE_DEFFACE_P (value))
2899 valid_p = 1;
2900 else if (NILP (value) || EQ (value, Qt))
2901 valid_p = 1;
2902 else if (STRINGP (value) && SCHARS (value) > 0)
2903 valid_p = 1;
2904 else if (CONSP (value))
2906 Lisp_Object key, val, list;
2908 list = value;
2909 valid_p = 1;
2911 while (!NILP (CAR_SAFE(list)))
2913 key = CAR_SAFE (list);
2914 list = CDR_SAFE (list);
2915 val = CAR_SAFE (list);
2916 list = CDR_SAFE (list);
2918 if (NILP (key) || NILP (val))
2920 valid_p = 0;
2921 break;
2924 else if (EQ (key, QCcolor)
2925 && !(EQ (val, Qforeground_color)
2926 || (STRINGP (val) && SCHARS (val) > 0)))
2928 valid_p = 0;
2929 break;
2932 else if (EQ (key, QCstyle)
2933 && !(EQ (val, Qline) || EQ (val, Qwave)))
2935 valid_p = 0;
2936 break;
2941 if (!valid_p)
2942 signal_error ("Invalid face underline", value);
2944 old_value = LFACE_UNDERLINE (lface);
2945 ASET (lface, LFACE_UNDERLINE_INDEX, value);
2947 else if (EQ (attr, QCoverline))
2949 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2950 if ((SYMBOLP (value)
2951 && !EQ (value, Qt)
2952 && !EQ (value, Qnil))
2953 /* Overline color. */
2954 || (STRINGP (value)
2955 && SCHARS (value) == 0))
2956 signal_error ("Invalid face overline", value);
2958 old_value = LFACE_OVERLINE (lface);
2959 ASET (lface, LFACE_OVERLINE_INDEX, value);
2961 else if (EQ (attr, QCstrike_through))
2963 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2964 if ((SYMBOLP (value)
2965 && !EQ (value, Qt)
2966 && !EQ (value, Qnil))
2967 /* Strike-through color. */
2968 || (STRINGP (value)
2969 && SCHARS (value) == 0))
2970 signal_error ("Invalid face strike-through", value);
2972 old_value = LFACE_STRIKE_THROUGH (lface);
2973 ASET (lface, LFACE_STRIKE_THROUGH_INDEX, value);
2975 else if (EQ (attr, QCbox))
2977 int valid_p;
2979 /* Allow t meaning a simple box of width 1 in foreground color
2980 of the face. */
2981 if (EQ (value, Qt))
2982 value = make_number (1);
2984 if (UNSPECIFIEDP (value) || IGNORE_DEFFACE_P (value))
2985 valid_p = 1;
2986 else if (NILP (value))
2987 valid_p = 1;
2988 else if (INTEGERP (value))
2989 valid_p = XINT (value) != 0;
2990 else if (STRINGP (value))
2991 valid_p = SCHARS (value) > 0;
2992 else if (CONSP (value))
2994 Lisp_Object tem;
2996 tem = value;
2997 while (CONSP (tem))
2999 Lisp_Object k, v;
3001 k = XCAR (tem);
3002 tem = XCDR (tem);
3003 if (!CONSP (tem))
3004 break;
3005 v = XCAR (tem);
3006 tem = XCDR (tem);
3008 if (EQ (k, QCline_width))
3010 if (!INTEGERP (v) || XINT (v) == 0)
3011 break;
3013 else if (EQ (k, QCcolor))
3015 if (!NILP (v) && (!STRINGP (v) || SCHARS (v) == 0))
3016 break;
3018 else if (EQ (k, QCstyle))
3020 if (!EQ (v, Qpressed_button) && !EQ (v, Qreleased_button))
3021 break;
3023 else
3024 break;
3027 valid_p = NILP (tem);
3029 else
3030 valid_p = 0;
3032 if (!valid_p)
3033 signal_error ("Invalid face box", value);
3035 old_value = LFACE_BOX (lface);
3036 ASET (lface, LFACE_BOX_INDEX, value);
3038 else if (EQ (attr, QCinverse_video)
3039 || EQ (attr, QCreverse_video))
3041 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3043 CHECK_SYMBOL (value);
3044 if (!EQ (value, Qt) && !NILP (value))
3045 signal_error ("Invalid inverse-video face attribute value", value);
3047 old_value = LFACE_INVERSE (lface);
3048 ASET (lface, LFACE_INVERSE_INDEX, value);
3050 else if (EQ (attr, QCforeground))
3052 /* Compatibility with 20.x. */
3053 if (NILP (value))
3054 value = Qunspecified;
3055 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3057 /* Don't check for valid color names here because it depends
3058 on the frame (display) whether the color will be valid
3059 when the face is realized. */
3060 CHECK_STRING (value);
3061 if (SCHARS (value) == 0)
3062 signal_error ("Empty foreground color value", value);
3064 old_value = LFACE_FOREGROUND (lface);
3065 ASET (lface, LFACE_FOREGROUND_INDEX, value);
3067 else if (EQ (attr, QCbackground))
3069 /* Compatibility with 20.x. */
3070 if (NILP (value))
3071 value = Qunspecified;
3072 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3074 /* Don't check for valid color names here because it depends
3075 on the frame (display) whether the color will be valid
3076 when the face is realized. */
3077 CHECK_STRING (value);
3078 if (SCHARS (value) == 0)
3079 signal_error ("Empty background color value", value);
3081 old_value = LFACE_BACKGROUND (lface);
3082 ASET (lface, LFACE_BACKGROUND_INDEX, value);
3084 else if (EQ (attr, QCstipple))
3086 #if defined (HAVE_WINDOW_SYSTEM)
3087 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value)
3088 && !NILP (value)
3089 && NILP (Fbitmap_spec_p (value)))
3090 signal_error ("Invalid stipple attribute", value);
3091 old_value = LFACE_STIPPLE (lface);
3092 ASET (lface, LFACE_STIPPLE_INDEX, value);
3093 #endif /* HAVE_WINDOW_SYSTEM */
3095 else if (EQ (attr, QCwidth))
3097 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3099 CHECK_SYMBOL (value);
3100 if (FONT_WIDTH_NAME_NUMERIC (value) < 0)
3101 signal_error ("Invalid face width", value);
3103 old_value = LFACE_SWIDTH (lface);
3104 ASET (lface, LFACE_SWIDTH_INDEX, value);
3105 prop_index = FONT_WIDTH_INDEX;
3107 else if (EQ (attr, QCfont))
3109 #ifdef HAVE_WINDOW_SYSTEM
3110 if (EQ (frame, Qt) || FRAME_WINDOW_P (XFRAME (frame)))
3112 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3114 FRAME_PTR f;
3116 old_value = LFACE_FONT (lface);
3117 if (! FONTP (value))
3119 if (STRINGP (value))
3121 Lisp_Object name = value;
3122 int fontset = fs_query_fontset (name, 0);
3124 if (fontset >= 0)
3125 name = fontset_ascii (fontset);
3126 value = font_spec_from_name (name);
3127 if (!FONTP (value))
3128 signal_error ("Invalid font name", name);
3130 else
3131 signal_error ("Invalid font or font-spec", value);
3133 if (EQ (frame, Qt))
3134 f = XFRAME (selected_frame);
3135 else
3136 f = XFRAME (frame);
3137 if (! FONT_OBJECT_P (value))
3139 Lisp_Object *attrs = XVECTOR (lface)->contents;
3140 Lisp_Object font_object;
3142 font_object = font_load_for_lface (f, attrs, value);
3143 if (NILP (font_object))
3144 signal_error ("Font not available", value);
3145 value = font_object;
3147 set_lface_from_font (f, lface, value, 1);
3149 else
3150 ASET (lface, LFACE_FONT_INDEX, value);
3152 #endif /* HAVE_WINDOW_SYSTEM */
3154 else if (EQ (attr, QCfontset))
3156 #ifdef HAVE_WINDOW_SYSTEM
3157 if (EQ (frame, Qt) || FRAME_WINDOW_P (XFRAME (frame)))
3159 Lisp_Object tmp;
3161 old_value = LFACE_FONTSET (lface);
3162 tmp = Fquery_fontset (value, Qnil);
3163 if (NILP (tmp))
3164 signal_error ("Invalid fontset name", value);
3165 ASET (lface, LFACE_FONTSET_INDEX, value = tmp);
3167 #endif /* HAVE_WINDOW_SYSTEM */
3169 else if (EQ (attr, QCinherit))
3171 Lisp_Object tail;
3172 if (SYMBOLP (value))
3173 tail = Qnil;
3174 else
3175 for (tail = value; CONSP (tail); tail = XCDR (tail))
3176 if (!SYMBOLP (XCAR (tail)))
3177 break;
3178 if (NILP (tail))
3179 ASET (lface, LFACE_INHERIT_INDEX, value);
3180 else
3181 signal_error ("Invalid face inheritance", value);
3183 else if (EQ (attr, QCbold))
3185 old_value = LFACE_WEIGHT (lface);
3186 ASET (lface, LFACE_WEIGHT_INDEX, NILP (value) ? Qnormal : Qbold);
3187 prop_index = FONT_WEIGHT_INDEX;
3189 else if (EQ (attr, QCitalic))
3191 attr = QCslant;
3192 old_value = LFACE_SLANT (lface);
3193 ASET (lface, LFACE_SLANT_INDEX, NILP (value) ? Qnormal : Qitalic);
3194 prop_index = FONT_SLANT_INDEX;
3196 else
3197 signal_error ("Invalid face attribute name", attr);
3199 if (prop_index)
3201 /* If a font-related attribute other than QCfont and QCfontset
3202 is specified, and if the original QCfont attribute has a font
3203 (font-spec or font-object), set the corresponding property in
3204 the font to nil so that the font selector doesn't think that
3205 the attribute is mandatory. Also, clear the average
3206 width. */
3207 font_clear_prop (XVECTOR (lface)->contents, prop_index);
3210 /* Changing a named face means that all realized faces depending on
3211 that face are invalid. Since we cannot tell which realized faces
3212 depend on the face, make sure they are all removed. This is done
3213 by incrementing face_change_count. The next call to
3214 init_iterator will then free realized faces. */
3215 if (!EQ (frame, Qt)
3216 && NILP (Fget (face, Qface_no_inherit))
3217 && NILP (Fequal (old_value, value)))
3219 ++face_change_count;
3220 ++windows_or_buffers_changed;
3223 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value)
3224 && NILP (Fequal (old_value, value)))
3226 Lisp_Object param;
3228 param = Qnil;
3230 if (EQ (face, Qdefault))
3232 #ifdef HAVE_WINDOW_SYSTEM
3233 /* Changed font-related attributes of the `default' face are
3234 reflected in changed `font' frame parameters. */
3235 if (FRAMEP (frame)
3236 && (prop_index || EQ (attr, QCfont))
3237 && lface_fully_specified_p (XVECTOR (lface)->contents))
3238 set_font_frame_param (frame, lface);
3239 else
3240 #endif /* HAVE_WINDOW_SYSTEM */
3242 if (EQ (attr, QCforeground))
3243 param = Qforeground_color;
3244 else if (EQ (attr, QCbackground))
3245 param = Qbackground_color;
3247 #ifdef HAVE_WINDOW_SYSTEM
3248 #ifndef HAVE_NTGUI
3249 else if (EQ (face, Qscroll_bar))
3251 /* Changing the colors of `scroll-bar' sets frame parameters
3252 `scroll-bar-foreground' and `scroll-bar-background'. */
3253 if (EQ (attr, QCforeground))
3254 param = Qscroll_bar_foreground;
3255 else if (EQ (attr, QCbackground))
3256 param = Qscroll_bar_background;
3258 #endif /* not HAVE_NTGUI */
3259 else if (EQ (face, Qborder))
3261 /* Changing background color of `border' sets frame parameter
3262 `border-color'. */
3263 if (EQ (attr, QCbackground))
3264 param = Qborder_color;
3266 else if (EQ (face, Qcursor))
3268 /* Changing background color of `cursor' sets frame parameter
3269 `cursor-color'. */
3270 if (EQ (attr, QCbackground))
3271 param = Qcursor_color;
3273 else if (EQ (face, Qmouse))
3275 /* Changing background color of `mouse' sets frame parameter
3276 `mouse-color'. */
3277 if (EQ (attr, QCbackground))
3278 param = Qmouse_color;
3280 #endif /* HAVE_WINDOW_SYSTEM */
3281 else if (EQ (face, Qmenu))
3283 /* Indicate that we have to update the menu bar when
3284 realizing faces on FRAME. FRAME t change the
3285 default for new frames. We do this by setting
3286 setting the flag in new face caches */
3287 if (FRAMEP (frame))
3289 struct frame *f = XFRAME (frame);
3290 if (FRAME_FACE_CACHE (f) == NULL)
3291 FRAME_FACE_CACHE (f) = make_face_cache (f);
3292 FRAME_FACE_CACHE (f)->menu_face_changed_p = 1;
3294 else
3295 menu_face_changed_default = 1;
3298 if (!NILP (param))
3300 if (EQ (frame, Qt))
3301 /* Update `default-frame-alist', which is used for new frames. */
3303 store_in_alist (&Vdefault_frame_alist, param, value);
3305 else
3306 /* Update the current frame's parameters. */
3308 Lisp_Object cons;
3309 cons = XCAR (Vparam_value_alist);
3310 XSETCAR (cons, param);
3311 XSETCDR (cons, value);
3312 Fmodify_frame_parameters (frame, Vparam_value_alist);
3317 return face;
3321 /* Update the corresponding face when frame parameter PARAM on frame F
3322 has been assigned the value NEW_VALUE. */
3324 void
3325 update_face_from_frame_parameter (struct frame *f, Lisp_Object param,
3326 Lisp_Object new_value)
3328 Lisp_Object face = Qnil;
3329 Lisp_Object lface;
3331 /* If there are no faces yet, give up. This is the case when called
3332 from Fx_create_frame, and we do the necessary things later in
3333 face-set-after-frame-defaults. */
3334 if (NILP (f->face_alist))
3335 return;
3337 if (EQ (param, Qforeground_color))
3339 face = Qdefault;
3340 lface = lface_from_face_name (f, face, 1);
3341 ASET (lface, LFACE_FOREGROUND_INDEX,
3342 (STRINGP (new_value) ? new_value : Qunspecified));
3343 realize_basic_faces (f);
3345 else if (EQ (param, Qbackground_color))
3347 Lisp_Object frame;
3349 /* Changing the background color might change the background
3350 mode, so that we have to load new defface specs.
3351 Call frame-set-background-mode to do that. */
3352 XSETFRAME (frame, f);
3353 call1 (Qframe_set_background_mode, frame);
3355 face = Qdefault;
3356 lface = lface_from_face_name (f, face, 1);
3357 ASET (lface, LFACE_BACKGROUND_INDEX,
3358 (STRINGP (new_value) ? new_value : Qunspecified));
3359 realize_basic_faces (f);
3361 #ifdef HAVE_WINDOW_SYSTEM
3362 else if (EQ (param, Qborder_color))
3364 face = Qborder;
3365 lface = lface_from_face_name (f, face, 1);
3366 ASET (lface, LFACE_BACKGROUND_INDEX,
3367 (STRINGP (new_value) ? new_value : Qunspecified));
3369 else if (EQ (param, Qcursor_color))
3371 face = Qcursor;
3372 lface = lface_from_face_name (f, face, 1);
3373 ASET (lface, LFACE_BACKGROUND_INDEX,
3374 (STRINGP (new_value) ? new_value : Qunspecified));
3376 else if (EQ (param, Qmouse_color))
3378 face = Qmouse;
3379 lface = lface_from_face_name (f, face, 1);
3380 ASET (lface, LFACE_BACKGROUND_INDEX,
3381 (STRINGP (new_value) ? new_value : Qunspecified));
3383 #endif
3385 /* Changing a named face means that all realized faces depending on
3386 that face are invalid. Since we cannot tell which realized faces
3387 depend on the face, make sure they are all removed. This is done
3388 by incrementing face_change_count. The next call to
3389 init_iterator will then free realized faces. */
3390 if (!NILP (face)
3391 && NILP (Fget (face, Qface_no_inherit)))
3393 ++face_change_count;
3394 ++windows_or_buffers_changed;
3399 #ifdef HAVE_WINDOW_SYSTEM
3401 /* Set the `font' frame parameter of FRAME determined from the
3402 font-object set in `default' face attributes LFACE. */
3404 static void
3405 set_font_frame_param (Lisp_Object frame, Lisp_Object lface)
3407 struct frame *f = XFRAME (frame);
3408 Lisp_Object font;
3410 if (FRAME_WINDOW_P (f)
3411 /* Don't do anything if the font is `unspecified'. This can
3412 happen during frame creation. */
3413 && (font = LFACE_FONT (lface),
3414 ! UNSPECIFIEDP (font)))
3416 if (FONT_SPEC_P (font))
3418 font = font_load_for_lface (f, XVECTOR (lface)->contents, font);
3419 if (NILP (font))
3420 return;
3421 ASET (lface, LFACE_FONT_INDEX, font);
3423 f->default_face_done_p = 0;
3424 Fmodify_frame_parameters (frame, Fcons (Fcons (Qfont, font), Qnil));
3429 /* Get the value of X resource RESOURCE, class CLASS for the display
3430 of frame FRAME. This is here because ordinary `x-get-resource'
3431 doesn't take a frame argument. */
3433 DEFUN ("internal-face-x-get-resource", Finternal_face_x_get_resource,
3434 Sinternal_face_x_get_resource, 3, 3, 0, doc: /* */)
3435 (Lisp_Object resource, Lisp_Object class, Lisp_Object frame)
3437 Lisp_Object value = Qnil;
3438 CHECK_STRING (resource);
3439 CHECK_STRING (class);
3440 CHECK_LIVE_FRAME (frame);
3441 BLOCK_INPUT;
3442 value = display_x_get_resource (FRAME_X_DISPLAY_INFO (XFRAME (frame)),
3443 resource, class, Qnil, Qnil);
3444 UNBLOCK_INPUT;
3445 return value;
3449 /* Return resource string VALUE as a boolean value, i.e. nil, or t.
3450 If VALUE is "on" or "true", return t. If VALUE is "off" or
3451 "false", return nil. Otherwise, if SIGNAL_P is non-zero, signal an
3452 error; if SIGNAL_P is zero, return 0. */
3454 static Lisp_Object
3455 face_boolean_x_resource_value (Lisp_Object value, int signal_p)
3457 Lisp_Object result = make_number (0);
3459 eassert (STRINGP (value));
3461 if (xstrcasecmp (SSDATA (value), "on") == 0
3462 || xstrcasecmp (SSDATA (value), "true") == 0)
3463 result = Qt;
3464 else if (xstrcasecmp (SSDATA (value), "off") == 0
3465 || xstrcasecmp (SSDATA (value), "false") == 0)
3466 result = Qnil;
3467 else if (xstrcasecmp (SSDATA (value), "unspecified") == 0)
3468 result = Qunspecified;
3469 else if (signal_p)
3470 signal_error ("Invalid face attribute value from X resource", value);
3472 return result;
3476 DEFUN ("internal-set-lisp-face-attribute-from-resource",
3477 Finternal_set_lisp_face_attribute_from_resource,
3478 Sinternal_set_lisp_face_attribute_from_resource,
3479 3, 4, 0, doc: /* */)
3480 (Lisp_Object face, Lisp_Object attr, Lisp_Object value, Lisp_Object frame)
3482 CHECK_SYMBOL (face);
3483 CHECK_SYMBOL (attr);
3484 CHECK_STRING (value);
3486 if (xstrcasecmp (SSDATA (value), "unspecified") == 0)
3487 value = Qunspecified;
3488 else if (EQ (attr, QCheight))
3490 value = Fstring_to_number (value, make_number (10));
3491 if (XINT (value) <= 0)
3492 signal_error ("Invalid face height from X resource", value);
3494 else if (EQ (attr, QCbold) || EQ (attr, QCitalic))
3495 value = face_boolean_x_resource_value (value, 1);
3496 else if (EQ (attr, QCweight) || EQ (attr, QCslant) || EQ (attr, QCwidth))
3497 value = intern (SSDATA (value));
3498 else if (EQ (attr, QCreverse_video) || EQ (attr, QCinverse_video))
3499 value = face_boolean_x_resource_value (value, 1);
3500 else if (EQ (attr, QCunderline)
3501 || EQ (attr, QCoverline)
3502 || EQ (attr, QCstrike_through))
3504 Lisp_Object boolean_value;
3506 /* If the result of face_boolean_x_resource_value is t or nil,
3507 VALUE does NOT specify a color. */
3508 boolean_value = face_boolean_x_resource_value (value, 0);
3509 if (SYMBOLP (boolean_value))
3510 value = boolean_value;
3512 else if (EQ (attr, QCbox) || EQ (attr, QCinherit))
3513 value = Fcar (Fread_from_string (value, Qnil, Qnil));
3515 return Finternal_set_lisp_face_attribute (face, attr, value, frame);
3518 #endif /* HAVE_WINDOW_SYSTEM */
3521 /***********************************************************************
3522 Menu face
3523 ***********************************************************************/
3525 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
3527 /* Make menus on frame F appear as specified by the `menu' face. */
3529 static void
3530 x_update_menu_appearance (struct frame *f)
3532 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3533 XrmDatabase rdb;
3535 if (dpyinfo
3536 && (rdb = XrmGetDatabase (FRAME_X_DISPLAY (f)),
3537 rdb != NULL))
3539 char line[512];
3540 char *buf = line;
3541 ptrdiff_t bufsize = sizeof line;
3542 Lisp_Object lface = lface_from_face_name (f, Qmenu, 1);
3543 struct face *face = FACE_FROM_ID (f, MENU_FACE_ID);
3544 const char *myname = SSDATA (Vx_resource_name);
3545 int changed_p = 0;
3546 #ifdef USE_MOTIF
3547 const char *popup_path = "popup_menu";
3548 #else
3549 const char *popup_path = "menu.popup";
3550 #endif
3552 if (STRINGP (LFACE_FOREGROUND (lface)))
3554 exprintf (&buf, &bufsize, line, -1, "%s.%s*foreground: %s",
3555 myname, popup_path,
3556 SDATA (LFACE_FOREGROUND (lface)));
3557 XrmPutLineResource (&rdb, line);
3558 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*foreground: %s",
3559 myname, SDATA (LFACE_FOREGROUND (lface)));
3560 XrmPutLineResource (&rdb, line);
3561 changed_p = 1;
3564 if (STRINGP (LFACE_BACKGROUND (lface)))
3566 exprintf (&buf, &bufsize, line, -1, "%s.%s*background: %s",
3567 myname, popup_path,
3568 SDATA (LFACE_BACKGROUND (lface)));
3569 XrmPutLineResource (&rdb, line);
3571 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*background: %s",
3572 myname, SDATA (LFACE_BACKGROUND (lface)));
3573 XrmPutLineResource (&rdb, line);
3574 changed_p = 1;
3577 if (face->font
3578 /* On Solaris 5.8, it's been reported that the `menu' face
3579 can be unspecified here, during startup. Why this
3580 happens remains unknown. -- cyd */
3581 && FONTP (LFACE_FONT (lface))
3582 && (!UNSPECIFIEDP (LFACE_FAMILY (lface))
3583 || !UNSPECIFIEDP (LFACE_FOUNDRY (lface))
3584 || !UNSPECIFIEDP (LFACE_SWIDTH (lface))
3585 || !UNSPECIFIEDP (LFACE_WEIGHT (lface))
3586 || !UNSPECIFIEDP (LFACE_SLANT (lface))
3587 || !UNSPECIFIEDP (LFACE_HEIGHT (lface))))
3589 Lisp_Object xlfd = Ffont_xlfd_name (LFACE_FONT (lface), Qnil);
3590 #ifdef USE_MOTIF
3591 const char *suffix = "List";
3592 Bool motif = True;
3593 #else
3594 #if defined HAVE_X_I18N
3596 const char *suffix = "Set";
3597 #else
3598 const char *suffix = "";
3599 #endif
3600 Bool motif = False;
3601 #endif
3603 if (! NILP (xlfd))
3605 #if defined HAVE_X_I18N
3606 char *fontsetname = xic_create_fontsetname (SSDATA (xlfd), motif);
3607 #else
3608 char *fontsetname = SSDATA (xlfd);
3609 #endif
3610 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*font%s: %s",
3611 myname, suffix, fontsetname);
3612 XrmPutLineResource (&rdb, line);
3614 exprintf (&buf, &bufsize, line, -1, "%s.%s*font%s: %s",
3615 myname, popup_path, suffix, fontsetname);
3616 XrmPutLineResource (&rdb, line);
3617 changed_p = 1;
3618 if (fontsetname != SSDATA (xlfd))
3619 xfree (fontsetname);
3623 if (changed_p && f->output_data.x->menubar_widget)
3624 free_frame_menubar (f);
3626 if (buf != line)
3627 xfree (buf);
3631 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
3634 DEFUN ("face-attribute-relative-p", Fface_attribute_relative_p,
3635 Sface_attribute_relative_p,
3636 2, 2, 0,
3637 doc: /* Check whether a face attribute value is relative.
3638 Specifically, this function returns t if the attribute ATTRIBUTE
3639 with the value VALUE is relative.
3641 A relative value is one that doesn't entirely override whatever is
3642 inherited from another face. For most possible attributes,
3643 the only relative value that users see is `unspecified'.
3644 However, for :height, floating point values are also relative. */)
3645 (Lisp_Object attribute, Lisp_Object value)
3647 if (EQ (value, Qunspecified) || (EQ (value, QCignore_defface)))
3648 return Qt;
3649 else if (EQ (attribute, QCheight))
3650 return INTEGERP (value) ? Qnil : Qt;
3651 else
3652 return Qnil;
3655 DEFUN ("merge-face-attribute", Fmerge_face_attribute, Smerge_face_attribute,
3656 3, 3, 0,
3657 doc: /* Return face ATTRIBUTE VALUE1 merged with VALUE2.
3658 If VALUE1 or VALUE2 are absolute (see `face-attribute-relative-p'), then
3659 the result will be absolute, otherwise it will be relative. */)
3660 (Lisp_Object attribute, Lisp_Object value1, Lisp_Object value2)
3662 if (EQ (value1, Qunspecified) || EQ (value1, QCignore_defface))
3663 return value2;
3664 else if (EQ (attribute, QCheight))
3665 return merge_face_heights (value1, value2, value1);
3666 else
3667 return value1;
3671 DEFUN ("internal-get-lisp-face-attribute", Finternal_get_lisp_face_attribute,
3672 Sinternal_get_lisp_face_attribute,
3673 2, 3, 0,
3674 doc: /* Return face attribute KEYWORD of face SYMBOL.
3675 If SYMBOL does not name a valid Lisp face or KEYWORD isn't a valid
3676 face attribute name, signal an error.
3677 If the optional argument FRAME is given, report on face SYMBOL in that
3678 frame. If FRAME is t, report on the defaults for face SYMBOL (for new
3679 frames). If FRAME is omitted or nil, use the selected frame. */)
3680 (Lisp_Object symbol, Lisp_Object keyword, Lisp_Object frame)
3682 Lisp_Object lface, value = Qnil;
3684 CHECK_SYMBOL (symbol);
3685 CHECK_SYMBOL (keyword);
3687 if (EQ (frame, Qt))
3688 lface = lface_from_face_name (NULL, symbol, 1);
3689 else
3691 if (NILP (frame))
3692 frame = selected_frame;
3693 CHECK_LIVE_FRAME (frame);
3694 lface = lface_from_face_name (XFRAME (frame), symbol, 1);
3697 if (EQ (keyword, QCfamily))
3698 value = LFACE_FAMILY (lface);
3699 else if (EQ (keyword, QCfoundry))
3700 value = LFACE_FOUNDRY (lface);
3701 else if (EQ (keyword, QCheight))
3702 value = LFACE_HEIGHT (lface);
3703 else if (EQ (keyword, QCweight))
3704 value = LFACE_WEIGHT (lface);
3705 else if (EQ (keyword, QCslant))
3706 value = LFACE_SLANT (lface);
3707 else if (EQ (keyword, QCunderline))
3708 value = LFACE_UNDERLINE (lface);
3709 else if (EQ (keyword, QCoverline))
3710 value = LFACE_OVERLINE (lface);
3711 else if (EQ (keyword, QCstrike_through))
3712 value = LFACE_STRIKE_THROUGH (lface);
3713 else if (EQ (keyword, QCbox))
3714 value = LFACE_BOX (lface);
3715 else if (EQ (keyword, QCinverse_video)
3716 || EQ (keyword, QCreverse_video))
3717 value = LFACE_INVERSE (lface);
3718 else if (EQ (keyword, QCforeground))
3719 value = LFACE_FOREGROUND (lface);
3720 else if (EQ (keyword, QCbackground))
3721 value = LFACE_BACKGROUND (lface);
3722 else if (EQ (keyword, QCstipple))
3723 value = LFACE_STIPPLE (lface);
3724 else if (EQ (keyword, QCwidth))
3725 value = LFACE_SWIDTH (lface);
3726 else if (EQ (keyword, QCinherit))
3727 value = LFACE_INHERIT (lface);
3728 else if (EQ (keyword, QCfont))
3729 value = LFACE_FONT (lface);
3730 else if (EQ (keyword, QCfontset))
3731 value = LFACE_FONTSET (lface);
3732 else
3733 signal_error ("Invalid face attribute name", keyword);
3735 if (IGNORE_DEFFACE_P (value))
3736 return Qunspecified;
3738 return value;
3742 DEFUN ("internal-lisp-face-attribute-values",
3743 Finternal_lisp_face_attribute_values,
3744 Sinternal_lisp_face_attribute_values, 1, 1, 0,
3745 doc: /* Return a list of valid discrete values for face attribute ATTR.
3746 Value is nil if ATTR doesn't have a discrete set of valid values. */)
3747 (Lisp_Object attr)
3749 Lisp_Object result = Qnil;
3751 CHECK_SYMBOL (attr);
3753 if (EQ (attr, QCunderline))
3754 result = Fcons (Qt, Fcons (Qnil, Qnil));
3755 else if (EQ (attr, QCoverline))
3756 result = Fcons (Qt, Fcons (Qnil, Qnil));
3757 else if (EQ (attr, QCstrike_through))
3758 result = Fcons (Qt, Fcons (Qnil, Qnil));
3759 else if (EQ (attr, QCinverse_video) || EQ (attr, QCreverse_video))
3760 result = Fcons (Qt, Fcons (Qnil, Qnil));
3762 return result;
3766 DEFUN ("internal-merge-in-global-face", Finternal_merge_in_global_face,
3767 Sinternal_merge_in_global_face, 2, 2, 0,
3768 doc: /* Add attributes from frame-default definition of FACE to FACE on FRAME.
3769 Default face attributes override any local face attributes. */)
3770 (Lisp_Object face, Lisp_Object frame)
3772 int i;
3773 Lisp_Object global_lface, local_lface, *gvec, *lvec;
3774 struct frame *f = XFRAME (frame);
3776 CHECK_LIVE_FRAME (frame);
3777 global_lface = lface_from_face_name (NULL, face, 1);
3778 local_lface = lface_from_face_name (f, face, 0);
3779 if (NILP (local_lface))
3780 local_lface = Finternal_make_lisp_face (face, frame);
3782 /* Make every specified global attribute override the local one.
3783 BEWARE!! This is only used from `face-set-after-frame-default' where
3784 the local frame is defined from default specs in `face-defface-spec'
3785 and those should be overridden by global settings. Hence the strange
3786 "global before local" priority. */
3787 lvec = XVECTOR (local_lface)->contents;
3788 gvec = XVECTOR (global_lface)->contents;
3789 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3790 if (IGNORE_DEFFACE_P (gvec[i]))
3791 ASET (local_lface, i, Qunspecified);
3792 else if (! UNSPECIFIEDP (gvec[i]))
3793 ASET (local_lface, i, AREF (global_lface, i));
3795 /* If the default face was changed, update the face cache and the
3796 `font' frame parameter. */
3797 if (EQ (face, Qdefault))
3799 struct face_cache *c = FRAME_FACE_CACHE (f);
3800 struct face *newface, *oldface = FACE_FROM_ID (f, DEFAULT_FACE_ID);
3801 Lisp_Object attrs[LFACE_VECTOR_SIZE];
3803 /* This can be NULL (e.g., in batch mode). */
3804 if (oldface)
3806 /* Ensure that the face vector is fully specified by merging
3807 the previously-cached vector. */
3808 memcpy (attrs, oldface->lface, sizeof attrs);
3809 merge_face_vectors (f, lvec, attrs, 0);
3810 vcopy (local_lface, 0, attrs, LFACE_VECTOR_SIZE);
3811 newface = realize_face (c, lvec, DEFAULT_FACE_ID);
3813 if ((! UNSPECIFIEDP (gvec[LFACE_FAMILY_INDEX])
3814 || ! UNSPECIFIEDP (gvec[LFACE_FOUNDRY_INDEX])
3815 || ! UNSPECIFIEDP (gvec[LFACE_HEIGHT_INDEX])
3816 || ! UNSPECIFIEDP (gvec[LFACE_WEIGHT_INDEX])
3817 || ! UNSPECIFIEDP (gvec[LFACE_SLANT_INDEX])
3818 || ! UNSPECIFIEDP (gvec[LFACE_SWIDTH_INDEX])
3819 || ! UNSPECIFIEDP (gvec[LFACE_FONT_INDEX]))
3820 && newface->font)
3822 Lisp_Object name = newface->font->props[FONT_NAME_INDEX];
3823 Fmodify_frame_parameters (frame, Fcons (Fcons (Qfont, name),
3824 Qnil));
3827 if (STRINGP (gvec[LFACE_FOREGROUND_INDEX]))
3828 Fmodify_frame_parameters (frame,
3829 Fcons (Fcons (Qforeground_color,
3830 gvec[LFACE_FOREGROUND_INDEX]),
3831 Qnil));
3833 if (STRINGP (gvec[LFACE_BACKGROUND_INDEX]))
3834 Fmodify_frame_parameters (frame,
3835 Fcons (Fcons (Qbackground_color,
3836 gvec[LFACE_BACKGROUND_INDEX]),
3837 Qnil));
3841 return Qnil;
3845 /* The following function is implemented for compatibility with 20.2.
3846 The function is used in x-resolve-fonts when it is asked to
3847 return fonts with the same size as the font of a face. This is
3848 done in fontset.el. */
3850 DEFUN ("face-font", Fface_font, Sface_font, 1, 3, 0,
3851 doc: /* Return the font name of face FACE, or nil if it is unspecified.
3852 The font name is, by default, for ASCII characters.
3853 If the optional argument FRAME is given, report on face FACE in that frame.
3854 If FRAME is t, report on the defaults for face FACE (for new frames).
3855 The font default for a face is either nil, or a list
3856 of the form (bold), (italic) or (bold italic).
3857 If FRAME is omitted or nil, use the selected frame. And, in this case,
3858 if the optional third argument CHARACTER is given,
3859 return the font name used for CHARACTER. */)
3860 (Lisp_Object face, Lisp_Object frame, Lisp_Object character)
3862 if (EQ (frame, Qt))
3864 Lisp_Object result = Qnil;
3865 Lisp_Object lface = lface_from_face_name (NULL, face, 1);
3867 if (!UNSPECIFIEDP (LFACE_WEIGHT (lface))
3868 && !EQ (LFACE_WEIGHT (lface), Qnormal))
3869 result = Fcons (Qbold, result);
3871 if (!UNSPECIFIEDP (LFACE_SLANT (lface))
3872 && !EQ (LFACE_SLANT (lface), Qnormal))
3873 result = Fcons (Qitalic, result);
3875 return result;
3877 else
3879 struct frame *f = frame_or_selected_frame (frame, 1);
3880 int face_id = lookup_named_face (f, face, 1);
3881 struct face *fface = FACE_FROM_ID (f, face_id);
3883 if (! fface)
3884 return Qnil;
3885 #ifdef HAVE_WINDOW_SYSTEM
3886 if (FRAME_WINDOW_P (f) && !NILP (character))
3888 CHECK_CHARACTER (character);
3889 face_id = FACE_FOR_CHAR (f, fface, XINT (character), -1, Qnil);
3890 fface = FACE_FROM_ID (f, face_id);
3892 return (fface->font
3893 ? fface->font->props[FONT_NAME_INDEX]
3894 : Qnil);
3895 #else /* !HAVE_WINDOW_SYSTEM */
3896 return build_string (FRAME_MSDOS_P (f)
3897 ? "ms-dos"
3898 : FRAME_W32_P (f) ? "w32term"
3899 :"tty");
3900 #endif
3905 /* Compare face-attribute values v1 and v2 for equality. Value is non-zero if
3906 all attributes are `equal'. Tries to be fast because this function
3907 is called quite often. */
3909 static inline int
3910 face_attr_equal_p (Lisp_Object v1, Lisp_Object v2)
3912 /* Type can differ, e.g. when one attribute is unspecified, i.e. nil,
3913 and the other is specified. */
3914 if (XTYPE (v1) != XTYPE (v2))
3915 return 0;
3917 if (EQ (v1, v2))
3918 return 1;
3920 switch (XTYPE (v1))
3922 case Lisp_String:
3923 if (SBYTES (v1) != SBYTES (v2))
3924 return 0;
3926 return memcmp (SDATA (v1), SDATA (v2), SBYTES (v1)) == 0;
3928 case_Lisp_Int:
3929 case Lisp_Symbol:
3930 return 0;
3932 default:
3933 return !NILP (Fequal (v1, v2));
3938 /* Compare face vectors V1 and V2 for equality. Value is non-zero if
3939 all attributes are `equal'. Tries to be fast because this function
3940 is called quite often. */
3942 static inline int
3943 lface_equal_p (Lisp_Object *v1, Lisp_Object *v2)
3945 int i, equal_p = 1;
3947 for (i = 1; i < LFACE_VECTOR_SIZE && equal_p; ++i)
3948 equal_p = face_attr_equal_p (v1[i], v2[i]);
3950 return equal_p;
3954 DEFUN ("internal-lisp-face-equal-p", Finternal_lisp_face_equal_p,
3955 Sinternal_lisp_face_equal_p, 2, 3, 0,
3956 doc: /* True if FACE1 and FACE2 are equal.
3957 If the optional argument FRAME is given, report on FACE1 and FACE2 in that frame.
3958 If FRAME is t, report on the defaults for FACE1 and FACE2 (for new frames).
3959 If FRAME is omitted or nil, use the selected frame. */)
3960 (Lisp_Object face1, Lisp_Object face2, Lisp_Object frame)
3962 int equal_p;
3963 struct frame *f;
3964 Lisp_Object lface1, lface2;
3966 if (EQ (frame, Qt))
3967 f = NULL;
3968 else
3969 /* Don't use check_x_frame here because this function is called
3970 before X frames exist. At that time, if FRAME is nil,
3971 selected_frame will be used which is the frame dumped with
3972 Emacs. That frame is not an X frame. */
3973 f = frame_or_selected_frame (frame, 2);
3975 lface1 = lface_from_face_name (f, face1, 1);
3976 lface2 = lface_from_face_name (f, face2, 1);
3977 equal_p = lface_equal_p (XVECTOR (lface1)->contents,
3978 XVECTOR (lface2)->contents);
3979 return equal_p ? Qt : Qnil;
3983 DEFUN ("internal-lisp-face-empty-p", Finternal_lisp_face_empty_p,
3984 Sinternal_lisp_face_empty_p, 1, 2, 0,
3985 doc: /* True if FACE has no attribute specified.
3986 If the optional argument FRAME is given, report on face FACE in that frame.
3987 If FRAME is t, report on the defaults for face FACE (for new frames).
3988 If FRAME is omitted or nil, use the selected frame. */)
3989 (Lisp_Object face, Lisp_Object frame)
3991 struct frame *f;
3992 Lisp_Object lface;
3993 int i;
3995 if (NILP (frame))
3996 frame = selected_frame;
3997 CHECK_LIVE_FRAME (frame);
3998 f = XFRAME (frame);
4000 if (EQ (frame, Qt))
4001 lface = lface_from_face_name (NULL, face, 1);
4002 else
4003 lface = lface_from_face_name (f, face, 1);
4005 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
4006 if (!UNSPECIFIEDP (AREF (lface, i)))
4007 break;
4009 return i == LFACE_VECTOR_SIZE ? Qt : Qnil;
4013 DEFUN ("frame-face-alist", Fframe_face_alist, Sframe_face_alist,
4014 0, 1, 0,
4015 doc: /* Return an alist of frame-local faces defined on FRAME.
4016 For internal use only. */)
4017 (Lisp_Object frame)
4019 struct frame *f = frame_or_selected_frame (frame, 0);
4020 return f->face_alist;
4024 /* Return a hash code for Lisp string STRING with case ignored. Used
4025 below in computing a hash value for a Lisp face. */
4027 static inline unsigned
4028 hash_string_case_insensitive (Lisp_Object string)
4030 const unsigned char *s;
4031 unsigned hash = 0;
4032 eassert (STRINGP (string));
4033 for (s = SDATA (string); *s; ++s)
4034 hash = (hash << 1) ^ c_tolower (*s);
4035 return hash;
4039 /* Return a hash code for face attribute vector V. */
4041 static inline unsigned
4042 lface_hash (Lisp_Object *v)
4044 return (hash_string_case_insensitive (v[LFACE_FAMILY_INDEX])
4045 ^ hash_string_case_insensitive (v[LFACE_FOUNDRY_INDEX])
4046 ^ hash_string_case_insensitive (v[LFACE_FOREGROUND_INDEX])
4047 ^ hash_string_case_insensitive (v[LFACE_BACKGROUND_INDEX])
4048 ^ XHASH (v[LFACE_WEIGHT_INDEX])
4049 ^ XHASH (v[LFACE_SLANT_INDEX])
4050 ^ XHASH (v[LFACE_SWIDTH_INDEX])
4051 ^ XHASH (v[LFACE_HEIGHT_INDEX]));
4055 /* Return non-zero if LFACE1 and LFACE2 specify the same font (without
4056 considering charsets/registries). They do if they specify the same
4057 family, point size, weight, width, slant, and font. Both
4058 LFACE1 and LFACE2 must be fully-specified. */
4060 static inline int
4061 lface_same_font_attributes_p (Lisp_Object *lface1, Lisp_Object *lface2)
4063 eassert (lface_fully_specified_p (lface1)
4064 && lface_fully_specified_p (lface2));
4065 return (xstrcasecmp (SSDATA (lface1[LFACE_FAMILY_INDEX]),
4066 SSDATA (lface2[LFACE_FAMILY_INDEX])) == 0
4067 && xstrcasecmp (SSDATA (lface1[LFACE_FOUNDRY_INDEX]),
4068 SSDATA (lface2[LFACE_FOUNDRY_INDEX])) == 0
4069 && EQ (lface1[LFACE_HEIGHT_INDEX], lface2[LFACE_HEIGHT_INDEX])
4070 && EQ (lface1[LFACE_SWIDTH_INDEX], lface2[LFACE_SWIDTH_INDEX])
4071 && EQ (lface1[LFACE_WEIGHT_INDEX], lface2[LFACE_WEIGHT_INDEX])
4072 && EQ (lface1[LFACE_SLANT_INDEX], lface2[LFACE_SLANT_INDEX])
4073 && EQ (lface1[LFACE_FONT_INDEX], lface2[LFACE_FONT_INDEX])
4074 && (EQ (lface1[LFACE_FONTSET_INDEX], lface2[LFACE_FONTSET_INDEX])
4075 || (STRINGP (lface1[LFACE_FONTSET_INDEX])
4076 && STRINGP (lface2[LFACE_FONTSET_INDEX])
4077 && ! xstrcasecmp (SSDATA (lface1[LFACE_FONTSET_INDEX]),
4078 SSDATA (lface2[LFACE_FONTSET_INDEX]))))
4084 /***********************************************************************
4085 Realized Faces
4086 ***********************************************************************/
4088 /* Allocate and return a new realized face for Lisp face attribute
4089 vector ATTR. */
4091 static struct face *
4092 make_realized_face (Lisp_Object *attr)
4094 struct face *face = xzalloc (sizeof *face);
4095 face->ascii_face = face;
4096 memcpy (face->lface, attr, sizeof face->lface);
4097 return face;
4101 /* Free realized face FACE, including its X resources. FACE may
4102 be null. */
4104 static void
4105 free_realized_face (struct frame *f, struct face *face)
4107 if (face)
4109 #ifdef HAVE_WINDOW_SYSTEM
4110 if (FRAME_WINDOW_P (f))
4112 /* Free fontset of FACE if it is ASCII face. */
4113 if (face->fontset >= 0 && face == face->ascii_face)
4114 free_face_fontset (f, face);
4115 if (face->gc)
4117 BLOCK_INPUT;
4118 if (face->font)
4119 font_done_for_face (f, face);
4120 x_free_gc (f, face->gc);
4121 face->gc = 0;
4122 UNBLOCK_INPUT;
4125 free_face_colors (f, face);
4126 x_destroy_bitmap (f, face->stipple);
4128 #endif /* HAVE_WINDOW_SYSTEM */
4130 xfree (face);
4135 /* Prepare face FACE for subsequent display on frame F. This
4136 allocated GCs if they haven't been allocated yet or have been freed
4137 by clearing the face cache. */
4139 void
4140 prepare_face_for_display (struct frame *f, struct face *face)
4142 #ifdef HAVE_WINDOW_SYSTEM
4143 eassert (FRAME_WINDOW_P (f));
4145 if (face->gc == 0)
4147 XGCValues xgcv;
4148 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
4150 xgcv.foreground = face->foreground;
4151 xgcv.background = face->background;
4152 #ifdef HAVE_X_WINDOWS
4153 xgcv.graphics_exposures = False;
4154 #endif
4156 BLOCK_INPUT;
4157 #ifdef HAVE_X_WINDOWS
4158 if (face->stipple)
4160 xgcv.fill_style = FillOpaqueStippled;
4161 xgcv.stipple = x_bitmap_pixmap (f, face->stipple);
4162 mask |= GCFillStyle | GCStipple;
4164 #endif
4165 face->gc = x_create_gc (f, mask, &xgcv);
4166 if (face->font)
4167 font_prepare_for_face (f, face);
4168 UNBLOCK_INPUT;
4170 #endif /* HAVE_WINDOW_SYSTEM */
4174 /* Returns the `distance' between the colors X and Y. */
4176 static int
4177 color_distance (XColor *x, XColor *y)
4179 /* This formula is from a paper titled `Colour metric' by Thiadmer Riemersma.
4180 Quoting from that paper:
4182 This formula has results that are very close to L*u*v* (with the
4183 modified lightness curve) and, more importantly, it is a more even
4184 algorithm: it does not have a range of colors where it suddenly
4185 gives far from optimal results.
4187 See <http://www.compuphase.com/cmetric.htm> for more info. */
4189 long r = (x->red - y->red) >> 8;
4190 long g = (x->green - y->green) >> 8;
4191 long b = (x->blue - y->blue) >> 8;
4192 long r_mean = (x->red + y->red) >> 9;
4194 return
4195 (((512 + r_mean) * r * r) >> 8)
4196 + 4 * g * g
4197 + (((767 - r_mean) * b * b) >> 8);
4201 DEFUN ("color-distance", Fcolor_distance, Scolor_distance, 2, 3, 0,
4202 doc: /* Return an integer distance between COLOR1 and COLOR2 on FRAME.
4203 COLOR1 and COLOR2 may be either strings containing the color name,
4204 or lists of the form (RED GREEN BLUE).
4205 If FRAME is unspecified or nil, the current frame is used. */)
4206 (Lisp_Object color1, Lisp_Object color2, Lisp_Object frame)
4208 struct frame *f;
4209 XColor cdef1, cdef2;
4211 if (NILP (frame))
4212 frame = selected_frame;
4213 CHECK_LIVE_FRAME (frame);
4214 f = XFRAME (frame);
4216 if (!(CONSP (color1) && parse_rgb_list (color1, &cdef1))
4217 && !(STRINGP (color1) && defined_color (f, SSDATA (color1), &cdef1, 0)))
4218 signal_error ("Invalid color", color1);
4219 if (!(CONSP (color2) && parse_rgb_list (color2, &cdef2))
4220 && !(STRINGP (color2) && defined_color (f, SSDATA (color2), &cdef2, 0)))
4221 signal_error ("Invalid color", color2);
4223 return make_number (color_distance (&cdef1, &cdef2));
4227 /***********************************************************************
4228 Face Cache
4229 ***********************************************************************/
4231 /* Return a new face cache for frame F. */
4233 static struct face_cache *
4234 make_face_cache (struct frame *f)
4236 struct face_cache *c;
4237 int size;
4239 c = xzalloc (sizeof *c);
4240 size = FACE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
4241 c->buckets = xzalloc (size);
4242 c->size = 50;
4243 c->faces_by_id = xmalloc (c->size * sizeof *c->faces_by_id);
4244 c->f = f;
4245 c->menu_face_changed_p = menu_face_changed_default;
4246 return c;
4250 /* Clear out all graphics contexts for all realized faces, except for
4251 the basic faces. This should be done from time to time just to avoid
4252 keeping too many graphics contexts that are no longer needed. */
4254 static void
4255 clear_face_gcs (struct face_cache *c)
4257 if (c && FRAME_WINDOW_P (c->f))
4259 #ifdef HAVE_WINDOW_SYSTEM
4260 int i;
4261 for (i = BASIC_FACE_ID_SENTINEL; i < c->used; ++i)
4263 struct face *face = c->faces_by_id[i];
4264 if (face && face->gc)
4266 BLOCK_INPUT;
4267 if (face->font)
4268 font_done_for_face (c->f, face);
4269 x_free_gc (c->f, face->gc);
4270 face->gc = 0;
4271 UNBLOCK_INPUT;
4274 #endif /* HAVE_WINDOW_SYSTEM */
4279 /* Free all realized faces in face cache C, including basic faces.
4280 C may be null. If faces are freed, make sure the frame's current
4281 matrix is marked invalid, so that a display caused by an expose
4282 event doesn't try to use faces we destroyed. */
4284 static void
4285 free_realized_faces (struct face_cache *c)
4287 if (c && c->used)
4289 int i, size;
4290 struct frame *f = c->f;
4292 /* We must block input here because we can't process X events
4293 safely while only some faces are freed, or when the frame's
4294 current matrix still references freed faces. */
4295 BLOCK_INPUT;
4297 for (i = 0; i < c->used; ++i)
4299 free_realized_face (f, c->faces_by_id[i]);
4300 c->faces_by_id[i] = NULL;
4303 c->used = 0;
4304 size = FACE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
4305 memset (c->buckets, 0, size);
4307 /* Must do a thorough redisplay the next time. Mark current
4308 matrices as invalid because they will reference faces freed
4309 above. This function is also called when a frame is
4310 destroyed. In this case, the root window of F is nil. */
4311 if (WINDOWP (f->root_window))
4313 clear_current_matrices (f);
4314 ++windows_or_buffers_changed;
4317 UNBLOCK_INPUT;
4322 /* Free all realized faces on FRAME or on all frames if FRAME is nil.
4323 This is done after attributes of a named face have been changed,
4324 because we can't tell which realized faces depend on that face. */
4326 void
4327 free_all_realized_faces (Lisp_Object frame)
4329 if (NILP (frame))
4331 Lisp_Object rest;
4332 FOR_EACH_FRAME (rest, frame)
4333 free_realized_faces (FRAME_FACE_CACHE (XFRAME (frame)));
4335 else
4336 free_realized_faces (FRAME_FACE_CACHE (XFRAME (frame)));
4340 /* Free face cache C and faces in it, including their X resources. */
4342 static void
4343 free_face_cache (struct face_cache *c)
4345 if (c)
4347 free_realized_faces (c);
4348 xfree (c->buckets);
4349 xfree (c->faces_by_id);
4350 xfree (c);
4355 /* Cache realized face FACE in face cache C. HASH is the hash value
4356 of FACE. If FACE is for ASCII characters (i.e. FACE->ascii_face ==
4357 FACE), insert the new face to the beginning of the collision list
4358 of the face hash table of C. Otherwise, add the new face to the
4359 end of the collision list. This way, lookup_face can quickly find
4360 that a requested face is not cached. */
4362 static void
4363 cache_face (struct face_cache *c, struct face *face, unsigned int hash)
4365 int i = hash % FACE_CACHE_BUCKETS_SIZE;
4367 face->hash = hash;
4369 if (face->ascii_face != face)
4371 struct face *last = c->buckets[i];
4372 if (last)
4374 while (last->next)
4375 last = last->next;
4376 last->next = face;
4377 face->prev = last;
4378 face->next = NULL;
4380 else
4382 c->buckets[i] = face;
4383 face->prev = face->next = NULL;
4386 else
4388 face->prev = NULL;
4389 face->next = c->buckets[i];
4390 if (face->next)
4391 face->next->prev = face;
4392 c->buckets[i] = face;
4395 /* Find a free slot in C->faces_by_id and use the index of the free
4396 slot as FACE->id. */
4397 for (i = 0; i < c->used; ++i)
4398 if (c->faces_by_id[i] == NULL)
4399 break;
4400 face->id = i;
4402 #ifdef GLYPH_DEBUG
4403 /* Check that FACE got a unique id. */
4405 int j, n;
4406 struct face *face1;
4408 for (j = n = 0; j < FACE_CACHE_BUCKETS_SIZE; ++j)
4409 for (face1 = c->buckets[j]; face1; face1 = face1->next)
4410 if (face1->id == i)
4411 ++n;
4413 eassert (n == 1);
4415 #endif /* GLYPH_DEBUG */
4417 /* Maybe enlarge C->faces_by_id. */
4418 if (i == c->used)
4420 if (c->used == c->size)
4421 c->faces_by_id = xpalloc (c->faces_by_id, &c->size, 1, MAX_FACE_ID,
4422 sizeof *c->faces_by_id);
4423 c->used++;
4426 c->faces_by_id[i] = face;
4430 /* Remove face FACE from cache C. */
4432 static void
4433 uncache_face (struct face_cache *c, struct face *face)
4435 int i = face->hash % FACE_CACHE_BUCKETS_SIZE;
4437 if (face->prev)
4438 face->prev->next = face->next;
4439 else
4440 c->buckets[i] = face->next;
4442 if (face->next)
4443 face->next->prev = face->prev;
4445 c->faces_by_id[face->id] = NULL;
4446 if (face->id == c->used)
4447 --c->used;
4451 /* Look up a realized face with face attributes ATTR in the face cache
4452 of frame F. The face will be used to display ASCII characters.
4453 Value is the ID of the face found. If no suitable face is found,
4454 realize a new one. */
4456 static inline int
4457 lookup_face (struct frame *f, Lisp_Object *attr)
4459 struct face_cache *cache = FRAME_FACE_CACHE (f);
4460 unsigned hash;
4461 int i;
4462 struct face *face;
4464 eassert (cache != NULL);
4465 check_lface_attrs (attr);
4467 /* Look up ATTR in the face cache. */
4468 hash = lface_hash (attr);
4469 i = hash % FACE_CACHE_BUCKETS_SIZE;
4471 for (face = cache->buckets[i]; face; face = face->next)
4473 if (face->ascii_face != face)
4475 /* There's no more ASCII face. */
4476 face = NULL;
4477 break;
4479 if (face->hash == hash
4480 && lface_equal_p (face->lface, attr))
4481 break;
4484 /* If not found, realize a new face. */
4485 if (face == NULL)
4486 face = realize_face (cache, attr, -1);
4488 #ifdef GLYPH_DEBUG
4489 eassert (face == FACE_FROM_ID (f, face->id));
4490 #endif /* GLYPH_DEBUG */
4492 return face->id;
4495 #ifdef HAVE_WINDOW_SYSTEM
4496 /* Look up a realized face that has the same attributes as BASE_FACE
4497 except for the font in the face cache of frame F. If FONT-OBJECT
4498 is not nil, it is an already opened font. If FONT-OBJECT is nil,
4499 the face has no font. Value is the ID of the face found. If no
4500 suitable face is found, realize a new one. */
4503 face_for_font (struct frame *f, Lisp_Object font_object, struct face *base_face)
4505 struct face_cache *cache = FRAME_FACE_CACHE (f);
4506 unsigned hash;
4507 int i;
4508 struct face *face;
4510 eassert (cache != NULL);
4511 base_face = base_face->ascii_face;
4512 hash = lface_hash (base_face->lface);
4513 i = hash % FACE_CACHE_BUCKETS_SIZE;
4515 for (face = cache->buckets[i]; face; face = face->next)
4517 if (face->ascii_face == face)
4518 continue;
4519 if (face->ascii_face == base_face
4520 && face->font == (NILP (font_object) ? NULL
4521 : XFONT_OBJECT (font_object))
4522 && lface_equal_p (face->lface, base_face->lface))
4523 return face->id;
4526 /* If not found, realize a new face. */
4527 face = realize_non_ascii_face (f, font_object, base_face);
4528 return face->id;
4530 #endif /* HAVE_WINDOW_SYSTEM */
4532 /* Return the face id of the realized face for named face SYMBOL on
4533 frame F suitable for displaying ASCII characters. Value is -1 if
4534 the face couldn't be determined, which might happen if the default
4535 face isn't realized and cannot be realized. */
4538 lookup_named_face (struct frame *f, Lisp_Object symbol, int signal_p)
4540 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4541 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
4542 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
4544 if (default_face == NULL)
4546 if (!realize_basic_faces (f))
4547 return -1;
4548 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
4549 if (default_face == NULL)
4550 emacs_abort (); /* realize_basic_faces must have set it up */
4553 if (! get_lface_attributes (f, symbol, symbol_attrs, signal_p, 0))
4554 return -1;
4556 memcpy (attrs, default_face->lface, sizeof attrs);
4557 merge_face_vectors (f, symbol_attrs, attrs, 0);
4559 return lookup_face (f, attrs);
4563 /* Return the display face-id of the basic face whose canonical face-id
4564 is FACE_ID. The return value will usually simply be FACE_ID, unless that
4565 basic face has bee remapped via Vface_remapping_alist. This function is
4566 conservative: if something goes wrong, it will simply return FACE_ID
4567 rather than signal an error. */
4570 lookup_basic_face (struct frame *f, int face_id)
4572 Lisp_Object name, mapping;
4573 int remapped_face_id;
4575 if (NILP (Vface_remapping_alist))
4576 return face_id; /* Nothing to do. */
4578 switch (face_id)
4580 case DEFAULT_FACE_ID: name = Qdefault; break;
4581 case MODE_LINE_FACE_ID: name = Qmode_line; break;
4582 case MODE_LINE_INACTIVE_FACE_ID: name = Qmode_line_inactive; break;
4583 case HEADER_LINE_FACE_ID: name = Qheader_line; break;
4584 case TOOL_BAR_FACE_ID: name = Qtool_bar; break;
4585 case FRINGE_FACE_ID: name = Qfringe; break;
4586 case SCROLL_BAR_FACE_ID: name = Qscroll_bar; break;
4587 case BORDER_FACE_ID: name = Qborder; break;
4588 case CURSOR_FACE_ID: name = Qcursor; break;
4589 case MOUSE_FACE_ID: name = Qmouse; break;
4590 case MENU_FACE_ID: name = Qmenu; break;
4592 default:
4593 emacs_abort (); /* the caller is supposed to pass us a basic face id */
4596 /* Do a quick scan through Vface_remapping_alist, and return immediately
4597 if there is no remapping for face NAME. This is just an optimization
4598 for the very common no-remapping case. */
4599 mapping = assq_no_quit (name, Vface_remapping_alist);
4600 if (NILP (mapping))
4601 return face_id; /* Give up. */
4603 /* If there is a remapping entry, lookup the face using NAME, which will
4604 handle the remapping too. */
4605 remapped_face_id = lookup_named_face (f, name, 0);
4606 if (remapped_face_id < 0)
4607 return face_id; /* Give up. */
4609 return remapped_face_id;
4613 /* Return a face for charset ASCII that is like the face with id
4614 FACE_ID on frame F, but has a font that is STEPS steps smaller.
4615 STEPS < 0 means larger. Value is the id of the face. */
4618 smaller_face (struct frame *f, int face_id, int steps)
4620 #ifdef HAVE_WINDOW_SYSTEM
4621 struct face *face;
4622 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4623 int pt, last_pt, last_height;
4624 int delta;
4625 int new_face_id;
4626 struct face *new_face;
4628 /* If not called for an X frame, just return the original face. */
4629 if (FRAME_TERMCAP_P (f))
4630 return face_id;
4632 /* Try in increments of 1/2 pt. */
4633 delta = steps < 0 ? 5 : -5;
4634 steps = eabs (steps);
4636 face = FACE_FROM_ID (f, face_id);
4637 memcpy (attrs, face->lface, sizeof attrs);
4638 pt = last_pt = XFASTINT (attrs[LFACE_HEIGHT_INDEX]);
4639 new_face_id = face_id;
4640 last_height = FONT_HEIGHT (face->font);
4642 while (steps
4643 && pt + delta > 0
4644 /* Give up if we cannot find a font within 10pt. */
4645 && eabs (last_pt - pt) < 100)
4647 /* Look up a face for a slightly smaller/larger font. */
4648 pt += delta;
4649 attrs[LFACE_HEIGHT_INDEX] = make_number (pt);
4650 new_face_id = lookup_face (f, attrs);
4651 new_face = FACE_FROM_ID (f, new_face_id);
4653 /* If height changes, count that as one step. */
4654 if ((delta < 0 && FONT_HEIGHT (new_face->font) < last_height)
4655 || (delta > 0 && FONT_HEIGHT (new_face->font) > last_height))
4657 --steps;
4658 last_height = FONT_HEIGHT (new_face->font);
4659 last_pt = pt;
4663 return new_face_id;
4665 #else /* not HAVE_WINDOW_SYSTEM */
4667 return face_id;
4669 #endif /* not HAVE_WINDOW_SYSTEM */
4673 /* Return a face for charset ASCII that is like the face with id
4674 FACE_ID on frame F, but has height HEIGHT. */
4677 face_with_height (struct frame *f, int face_id, int height)
4679 #ifdef HAVE_WINDOW_SYSTEM
4680 struct face *face;
4681 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4683 if (FRAME_TERMCAP_P (f)
4684 || height <= 0)
4685 return face_id;
4687 face = FACE_FROM_ID (f, face_id);
4688 memcpy (attrs, face->lface, sizeof attrs);
4689 attrs[LFACE_HEIGHT_INDEX] = make_number (height);
4690 font_clear_prop (attrs, FONT_SIZE_INDEX);
4691 face_id = lookup_face (f, attrs);
4692 #endif /* HAVE_WINDOW_SYSTEM */
4694 return face_id;
4698 /* Return the face id of the realized face for named face SYMBOL on
4699 frame F suitable for displaying ASCII characters, and use
4700 attributes of the face FACE_ID for attributes that aren't
4701 completely specified by SYMBOL. This is like lookup_named_face,
4702 except that the default attributes come from FACE_ID, not from the
4703 default face. FACE_ID is assumed to be already realized. */
4706 lookup_derived_face (struct frame *f, Lisp_Object symbol, int face_id,
4707 int signal_p)
4709 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4710 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
4711 struct face *default_face = FACE_FROM_ID (f, face_id);
4713 if (!default_face)
4714 emacs_abort ();
4716 if (!get_lface_attributes (f, symbol, symbol_attrs, signal_p, 0))
4717 return -1;
4719 memcpy (attrs, default_face->lface, sizeof attrs);
4720 merge_face_vectors (f, symbol_attrs, attrs, 0);
4721 return lookup_face (f, attrs);
4724 DEFUN ("face-attributes-as-vector", Fface_attributes_as_vector,
4725 Sface_attributes_as_vector, 1, 1, 0,
4726 doc: /* Return a vector of face attributes corresponding to PLIST. */)
4727 (Lisp_Object plist)
4729 Lisp_Object lface;
4730 lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
4731 Qunspecified);
4732 merge_face_ref (XFRAME (selected_frame), plist, XVECTOR (lface)->contents,
4733 1, 0);
4734 return lface;
4739 /***********************************************************************
4740 Face capability testing
4741 ***********************************************************************/
4744 /* If the distance (as returned by color_distance) between two colors is
4745 less than this, then they are considered the same, for determining
4746 whether a color is supported or not. The range of values is 0-65535. */
4748 #define TTY_SAME_COLOR_THRESHOLD 10000
4750 #ifdef HAVE_WINDOW_SYSTEM
4752 /* Return non-zero if all the face attributes in ATTRS are supported
4753 on the window-system frame F.
4755 The definition of `supported' is somewhat heuristic, but basically means
4756 that a face containing all the attributes in ATTRS, when merged with the
4757 default face for display, can be represented in a way that's
4759 \(1) different in appearance than the default face, and
4760 \(2) `close in spirit' to what the attributes specify, if not exact. */
4762 static int
4763 x_supports_face_attributes_p (struct frame *f, Lisp_Object *attrs,
4764 struct face *def_face)
4766 Lisp_Object *def_attrs = def_face->lface;
4768 /* Check that other specified attributes are different that the default
4769 face. */
4770 if ((!UNSPECIFIEDP (attrs[LFACE_UNDERLINE_INDEX])
4771 && face_attr_equal_p (attrs[LFACE_UNDERLINE_INDEX],
4772 def_attrs[LFACE_UNDERLINE_INDEX]))
4773 || (!UNSPECIFIEDP (attrs[LFACE_INVERSE_INDEX])
4774 && face_attr_equal_p (attrs[LFACE_INVERSE_INDEX],
4775 def_attrs[LFACE_INVERSE_INDEX]))
4776 || (!UNSPECIFIEDP (attrs[LFACE_FOREGROUND_INDEX])
4777 && face_attr_equal_p (attrs[LFACE_FOREGROUND_INDEX],
4778 def_attrs[LFACE_FOREGROUND_INDEX]))
4779 || (!UNSPECIFIEDP (attrs[LFACE_BACKGROUND_INDEX])
4780 && face_attr_equal_p (attrs[LFACE_BACKGROUND_INDEX],
4781 def_attrs[LFACE_BACKGROUND_INDEX]))
4782 || (!UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
4783 && face_attr_equal_p (attrs[LFACE_STIPPLE_INDEX],
4784 def_attrs[LFACE_STIPPLE_INDEX]))
4785 || (!UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
4786 && face_attr_equal_p (attrs[LFACE_OVERLINE_INDEX],
4787 def_attrs[LFACE_OVERLINE_INDEX]))
4788 || (!UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
4789 && face_attr_equal_p (attrs[LFACE_STRIKE_THROUGH_INDEX],
4790 def_attrs[LFACE_STRIKE_THROUGH_INDEX]))
4791 || (!UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
4792 && face_attr_equal_p (attrs[LFACE_BOX_INDEX],
4793 def_attrs[LFACE_BOX_INDEX])))
4794 return 0;
4796 /* Check font-related attributes, as those are the most commonly
4797 "unsupported" on a window-system (because of missing fonts). */
4798 if (!UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
4799 || !UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
4800 || !UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
4801 || !UNSPECIFIEDP (attrs[LFACE_WEIGHT_INDEX])
4802 || !UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX])
4803 || !UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX]))
4805 int face_id;
4806 struct face *face;
4807 Lisp_Object merged_attrs[LFACE_VECTOR_SIZE];
4808 int i;
4810 memcpy (merged_attrs, def_attrs, sizeof merged_attrs);
4812 merge_face_vectors (f, attrs, merged_attrs, 0);
4814 face_id = lookup_face (f, merged_attrs);
4815 face = FACE_FROM_ID (f, face_id);
4817 if (! face)
4818 error ("Cannot make face");
4820 /* If the font is the same, or no font is found, then not
4821 supported. */
4822 if (face->font == def_face->font
4823 || ! face->font)
4824 return 0;
4825 for (i = FONT_TYPE_INDEX; i <= FONT_SIZE_INDEX; i++)
4826 if (! EQ (face->font->props[i], def_face->font->props[i]))
4828 Lisp_Object s1, s2;
4830 if (i < FONT_FOUNDRY_INDEX || i > FONT_REGISTRY_INDEX
4831 || face->font->driver->case_sensitive)
4832 return 1;
4833 s1 = SYMBOL_NAME (face->font->props[i]);
4834 s2 = SYMBOL_NAME (def_face->font->props[i]);
4835 if (! EQ (Fcompare_strings (s1, make_number (0), Qnil,
4836 s2, make_number (0), Qnil, Qt), Qt))
4837 return 1;
4839 return 0;
4842 /* Everything checks out, this face is supported. */
4843 return 1;
4846 #endif /* HAVE_WINDOW_SYSTEM */
4848 /* Return non-zero if all the face attributes in ATTRS are supported
4849 on the tty frame F.
4851 The definition of `supported' is somewhat heuristic, but basically means
4852 that a face containing all the attributes in ATTRS, when merged
4853 with the default face for display, can be represented in a way that's
4855 \(1) different in appearance than the default face, and
4856 \(2) `close in spirit' to what the attributes specify, if not exact.
4858 Point (2) implies that a `:weight black' attribute will be satisfied
4859 by any terminal that can display bold, and a `:foreground "yellow"' as
4860 long as the terminal can display a yellowish color, but `:slant italic'
4861 will _not_ be satisfied by the tty display code's automatic
4862 substitution of a `dim' face for italic. */
4864 static int
4865 tty_supports_face_attributes_p (struct frame *f, Lisp_Object *attrs,
4866 struct face *def_face)
4868 int weight, slant;
4869 Lisp_Object val, fg, bg;
4870 XColor fg_tty_color, fg_std_color;
4871 XColor bg_tty_color, bg_std_color;
4872 unsigned test_caps = 0;
4873 Lisp_Object *def_attrs = def_face->lface;
4875 /* First check some easy-to-check stuff; ttys support none of the
4876 following attributes, so we can just return false if any are requested
4877 (even if `nominal' values are specified, we should still return false,
4878 as that will be the same value that the default face uses). We
4879 consider :slant unsupportable on ttys, even though the face code
4880 actually `fakes' them using a dim attribute if possible. This is
4881 because the faked result is too different from what the face
4882 specifies. */
4883 if (!UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
4884 || !UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
4885 || !UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
4886 || !UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
4887 || !UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
4888 || !UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
4889 || !UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
4890 || !UNSPECIFIEDP (attrs[LFACE_BOX_INDEX]))
4891 return 0;
4893 /* Test for terminal `capabilities' (non-color character attributes). */
4895 /* font weight (bold/dim) */
4896 val = attrs[LFACE_WEIGHT_INDEX];
4897 if (!UNSPECIFIEDP (val)
4898 && (weight = FONT_WEIGHT_NAME_NUMERIC (val), weight >= 0))
4900 int def_weight = FONT_WEIGHT_NAME_NUMERIC (def_attrs[LFACE_WEIGHT_INDEX]);
4902 if (weight > 100)
4904 if (def_weight > 100)
4905 return 0; /* same as default */
4906 test_caps = TTY_CAP_BOLD;
4908 else if (weight < 100)
4910 if (def_weight < 100)
4911 return 0; /* same as default */
4912 test_caps = TTY_CAP_DIM;
4914 else if (def_weight == 100)
4915 return 0; /* same as default */
4918 /* font slant */
4919 val = attrs[LFACE_SLANT_INDEX];
4920 if (!UNSPECIFIEDP (val)
4921 && (slant = FONT_SLANT_NAME_NUMERIC (val), slant >= 0))
4923 int def_slant = FONT_SLANT_NAME_NUMERIC (def_attrs[LFACE_SLANT_INDEX]);
4924 if (slant == 100 || slant == def_slant)
4925 return 0; /* same as default */
4926 else
4927 test_caps |= TTY_CAP_ITALIC;
4930 /* underlining */
4931 val = attrs[LFACE_UNDERLINE_INDEX];
4932 if (!UNSPECIFIEDP (val))
4934 if (STRINGP (val))
4935 return 0; /* ttys can't use colored underlines */
4936 else if (face_attr_equal_p (val, def_attrs[LFACE_UNDERLINE_INDEX]))
4937 return 0; /* same as default */
4938 else
4939 test_caps |= TTY_CAP_UNDERLINE;
4942 /* inverse video */
4943 val = attrs[LFACE_INVERSE_INDEX];
4944 if (!UNSPECIFIEDP (val))
4946 if (face_attr_equal_p (val, def_attrs[LFACE_INVERSE_INDEX]))
4947 return 0; /* same as default */
4948 else
4949 test_caps |= TTY_CAP_INVERSE;
4953 /* Color testing. */
4955 /* Default the color indices in FG_TTY_COLOR and BG_TTY_COLOR, since
4956 we use them when calling `tty_capable_p' below, even if the face
4957 specifies no colors. */
4958 fg_tty_color.pixel = FACE_TTY_DEFAULT_FG_COLOR;
4959 bg_tty_color.pixel = FACE_TTY_DEFAULT_BG_COLOR;
4961 /* Check if foreground color is close enough. */
4962 fg = attrs[LFACE_FOREGROUND_INDEX];
4963 if (STRINGP (fg))
4965 Lisp_Object def_fg = def_attrs[LFACE_FOREGROUND_INDEX];
4967 if (face_attr_equal_p (fg, def_fg))
4968 return 0; /* same as default */
4969 else if (! tty_lookup_color (f, fg, &fg_tty_color, &fg_std_color))
4970 return 0; /* not a valid color */
4971 else if (color_distance (&fg_tty_color, &fg_std_color)
4972 > TTY_SAME_COLOR_THRESHOLD)
4973 return 0; /* displayed color is too different */
4974 else
4975 /* Make sure the color is really different than the default. */
4977 XColor def_fg_color;
4978 if (tty_lookup_color (f, def_fg, &def_fg_color, 0)
4979 && (color_distance (&fg_tty_color, &def_fg_color)
4980 <= TTY_SAME_COLOR_THRESHOLD))
4981 return 0;
4985 /* Check if background color is close enough. */
4986 bg = attrs[LFACE_BACKGROUND_INDEX];
4987 if (STRINGP (bg))
4989 Lisp_Object def_bg = def_attrs[LFACE_BACKGROUND_INDEX];
4991 if (face_attr_equal_p (bg, def_bg))
4992 return 0; /* same as default */
4993 else if (! tty_lookup_color (f, bg, &bg_tty_color, &bg_std_color))
4994 return 0; /* not a valid color */
4995 else if (color_distance (&bg_tty_color, &bg_std_color)
4996 > TTY_SAME_COLOR_THRESHOLD)
4997 return 0; /* displayed color is too different */
4998 else
4999 /* Make sure the color is really different than the default. */
5001 XColor def_bg_color;
5002 if (tty_lookup_color (f, def_bg, &def_bg_color, 0)
5003 && (color_distance (&bg_tty_color, &def_bg_color)
5004 <= TTY_SAME_COLOR_THRESHOLD))
5005 return 0;
5009 /* If both foreground and background are requested, see if the
5010 distance between them is OK. We just check to see if the distance
5011 between the tty's foreground and background is close enough to the
5012 distance between the standard foreground and background. */
5013 if (STRINGP (fg) && STRINGP (bg))
5015 int delta_delta
5016 = (color_distance (&fg_std_color, &bg_std_color)
5017 - color_distance (&fg_tty_color, &bg_tty_color));
5018 if (delta_delta > TTY_SAME_COLOR_THRESHOLD
5019 || delta_delta < -TTY_SAME_COLOR_THRESHOLD)
5020 return 0;
5024 /* See if the capabilities we selected above are supported, with the
5025 given colors. */
5026 if (test_caps != 0 &&
5027 ! tty_capable_p (FRAME_TTY (f), test_caps, fg_tty_color.pixel,
5028 bg_tty_color.pixel))
5029 return 0;
5032 /* Hmmm, everything checks out, this terminal must support this face. */
5033 return 1;
5037 DEFUN ("display-supports-face-attributes-p",
5038 Fdisplay_supports_face_attributes_p, Sdisplay_supports_face_attributes_p,
5039 1, 2, 0,
5040 doc: /* Return non-nil if all the face attributes in ATTRIBUTES are supported.
5041 The optional argument DISPLAY can be a display name, a frame, or
5042 nil (meaning the selected frame's display).
5044 The definition of `supported' is somewhat heuristic, but basically means
5045 that a face containing all the attributes in ATTRIBUTES, when merged
5046 with the default face for display, can be represented in a way that's
5048 \(1) different in appearance than the default face, and
5049 \(2) `close in spirit' to what the attributes specify, if not exact.
5051 Point (2) implies that a `:weight black' attribute will be satisfied by
5052 any display that can display bold, and a `:foreground \"yellow\"' as long
5053 as it can display a yellowish color, but `:slant italic' will _not_ be
5054 satisfied by the tty display code's automatic substitution of a `dim'
5055 face for italic. */)
5056 (Lisp_Object attributes, Lisp_Object display)
5058 int supports = 0, i;
5059 Lisp_Object frame;
5060 struct frame *f;
5061 struct face *def_face;
5062 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5064 if (noninteractive || !initialized)
5065 /* We may not be able to access low-level face information in batch
5066 mode, or before being dumped, and this function is not going to
5067 be very useful in those cases anyway, so just give up. */
5068 return Qnil;
5070 if (NILP (display))
5071 frame = selected_frame;
5072 else if (FRAMEP (display))
5073 frame = display;
5074 else
5076 /* Find any frame on DISPLAY. */
5077 Lisp_Object fl_tail;
5079 frame = Qnil;
5080 for (fl_tail = Vframe_list; CONSP (fl_tail); fl_tail = XCDR (fl_tail))
5082 frame = XCAR (fl_tail);
5083 if (!NILP (Fequal (Fcdr (Fassq (Qdisplay,
5084 XFRAME (frame)->param_alist)),
5085 display)))
5086 break;
5090 CHECK_LIVE_FRAME (frame);
5091 f = XFRAME (frame);
5093 for (i = 0; i < LFACE_VECTOR_SIZE; i++)
5094 attrs[i] = Qunspecified;
5095 merge_face_ref (f, attributes, attrs, 1, 0);
5097 def_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5098 if (def_face == NULL)
5100 if (! realize_basic_faces (f))
5101 error ("Cannot realize default face");
5102 def_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5103 if (def_face == NULL)
5104 emacs_abort (); /* realize_basic_faces must have set it up */
5107 /* Dispatch to the appropriate handler. */
5108 if (FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5109 supports = tty_supports_face_attributes_p (f, attrs, def_face);
5110 #ifdef HAVE_WINDOW_SYSTEM
5111 else
5112 supports = x_supports_face_attributes_p (f, attrs, def_face);
5113 #endif
5115 return supports ? Qt : Qnil;
5119 /***********************************************************************
5120 Font selection
5121 ***********************************************************************/
5123 DEFUN ("internal-set-font-selection-order",
5124 Finternal_set_font_selection_order,
5125 Sinternal_set_font_selection_order, 1, 1, 0,
5126 doc: /* Set font selection order for face font selection to ORDER.
5127 ORDER must be a list of length 4 containing the symbols `:width',
5128 `:height', `:weight', and `:slant'. Face attributes appearing
5129 first in ORDER are matched first, e.g. if `:height' appears before
5130 `:weight' in ORDER, font selection first tries to find a font with
5131 a suitable height, and then tries to match the font weight.
5132 Value is ORDER. */)
5133 (Lisp_Object order)
5135 Lisp_Object list;
5136 int i;
5137 int indices[DIM (font_sort_order)];
5139 CHECK_LIST (order);
5140 memset (indices, 0, sizeof indices);
5141 i = 0;
5143 for (list = order;
5144 CONSP (list) && i < DIM (indices);
5145 list = XCDR (list), ++i)
5147 Lisp_Object attr = XCAR (list);
5148 int xlfd;
5150 if (EQ (attr, QCwidth))
5151 xlfd = XLFD_SWIDTH;
5152 else if (EQ (attr, QCheight))
5153 xlfd = XLFD_POINT_SIZE;
5154 else if (EQ (attr, QCweight))
5155 xlfd = XLFD_WEIGHT;
5156 else if (EQ (attr, QCslant))
5157 xlfd = XLFD_SLANT;
5158 else
5159 break;
5161 if (indices[i] != 0)
5162 break;
5163 indices[i] = xlfd;
5166 if (!NILP (list) || i != DIM (indices))
5167 signal_error ("Invalid font sort order", order);
5168 for (i = 0; i < DIM (font_sort_order); ++i)
5169 if (indices[i] == 0)
5170 signal_error ("Invalid font sort order", order);
5172 if (memcmp (indices, font_sort_order, sizeof indices) != 0)
5174 memcpy (font_sort_order, indices, sizeof font_sort_order);
5175 free_all_realized_faces (Qnil);
5178 font_update_sort_order (font_sort_order);
5180 return Qnil;
5184 DEFUN ("internal-set-alternative-font-family-alist",
5185 Finternal_set_alternative_font_family_alist,
5186 Sinternal_set_alternative_font_family_alist, 1, 1, 0,
5187 doc: /* Define alternative font families to try in face font selection.
5188 ALIST is an alist of (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...) entries.
5189 Each ALTERNATIVE is tried in order if no fonts of font family FAMILY can
5190 be found. Value is ALIST. */)
5191 (Lisp_Object alist)
5193 Lisp_Object entry, tail, tail2;
5195 CHECK_LIST (alist);
5196 alist = Fcopy_sequence (alist);
5197 for (tail = alist; CONSP (tail); tail = XCDR (tail))
5199 entry = XCAR (tail);
5200 CHECK_LIST (entry);
5201 entry = Fcopy_sequence (entry);
5202 XSETCAR (tail, entry);
5203 for (tail2 = entry; CONSP (tail2); tail2 = XCDR (tail2))
5204 XSETCAR (tail2, Fintern (XCAR (tail2), Qnil));
5207 Vface_alternative_font_family_alist = alist;
5208 free_all_realized_faces (Qnil);
5209 return alist;
5213 DEFUN ("internal-set-alternative-font-registry-alist",
5214 Finternal_set_alternative_font_registry_alist,
5215 Sinternal_set_alternative_font_registry_alist, 1, 1, 0,
5216 doc: /* Define alternative font registries to try in face font selection.
5217 ALIST is an alist of (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...) entries.
5218 Each ALTERNATIVE is tried in order if no fonts of font registry REGISTRY can
5219 be found. Value is ALIST. */)
5220 (Lisp_Object alist)
5222 Lisp_Object entry, tail, tail2;
5224 CHECK_LIST (alist);
5225 alist = Fcopy_sequence (alist);
5226 for (tail = alist; CONSP (tail); tail = XCDR (tail))
5228 entry = XCAR (tail);
5229 CHECK_LIST (entry);
5230 entry = Fcopy_sequence (entry);
5231 XSETCAR (tail, entry);
5232 for (tail2 = entry; CONSP (tail2); tail2 = XCDR (tail2))
5233 XSETCAR (tail2, Fdowncase (XCAR (tail2)));
5235 Vface_alternative_font_registry_alist = alist;
5236 free_all_realized_faces (Qnil);
5237 return alist;
5241 #ifdef HAVE_WINDOW_SYSTEM
5243 /* Return the fontset id of the base fontset name or alias name given
5244 by the fontset attribute of ATTRS. Value is -1 if the fontset
5245 attribute of ATTRS doesn't name a fontset. */
5247 static int
5248 face_fontset (Lisp_Object *attrs)
5250 Lisp_Object name;
5252 name = attrs[LFACE_FONTSET_INDEX];
5253 if (!STRINGP (name))
5254 return -1;
5255 return fs_query_fontset (name, 0);
5258 #endif /* HAVE_WINDOW_SYSTEM */
5262 /***********************************************************************
5263 Face Realization
5264 ***********************************************************************/
5266 /* Realize basic faces on frame F. Value is zero if frame parameters
5267 of F don't contain enough information needed to realize the default
5268 face. */
5270 static int
5271 realize_basic_faces (struct frame *f)
5273 int success_p = 0;
5274 ptrdiff_t count = SPECPDL_INDEX ();
5276 /* Block input here so that we won't be surprised by an X expose
5277 event, for instance, without having the faces set up. */
5278 BLOCK_INPUT;
5279 specbind (Qscalable_fonts_allowed, Qt);
5281 if (realize_default_face (f))
5283 realize_named_face (f, Qmode_line, MODE_LINE_FACE_ID);
5284 realize_named_face (f, Qmode_line_inactive, MODE_LINE_INACTIVE_FACE_ID);
5285 realize_named_face (f, Qtool_bar, TOOL_BAR_FACE_ID);
5286 realize_named_face (f, Qfringe, FRINGE_FACE_ID);
5287 realize_named_face (f, Qheader_line, HEADER_LINE_FACE_ID);
5288 realize_named_face (f, Qscroll_bar, SCROLL_BAR_FACE_ID);
5289 realize_named_face (f, Qborder, BORDER_FACE_ID);
5290 realize_named_face (f, Qcursor, CURSOR_FACE_ID);
5291 realize_named_face (f, Qmouse, MOUSE_FACE_ID);
5292 realize_named_face (f, Qmenu, MENU_FACE_ID);
5293 realize_named_face (f, Qvertical_border, VERTICAL_BORDER_FACE_ID);
5295 /* Reflect changes in the `menu' face in menu bars. */
5296 if (FRAME_FACE_CACHE (f)->menu_face_changed_p)
5298 FRAME_FACE_CACHE (f)->menu_face_changed_p = 0;
5299 #ifdef USE_X_TOOLKIT
5300 if (FRAME_WINDOW_P (f))
5301 x_update_menu_appearance (f);
5302 #endif
5305 success_p = 1;
5308 unbind_to (count, Qnil);
5309 UNBLOCK_INPUT;
5310 return success_p;
5314 /* Realize the default face on frame F. If the face is not fully
5315 specified, make it fully-specified. Attributes of the default face
5316 that are not explicitly specified are taken from frame parameters. */
5318 static int
5319 realize_default_face (struct frame *f)
5321 struct face_cache *c = FRAME_FACE_CACHE (f);
5322 Lisp_Object lface;
5323 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5324 struct face *face;
5326 /* If the `default' face is not yet known, create it. */
5327 lface = lface_from_face_name (f, Qdefault, 0);
5328 if (NILP (lface))
5330 Lisp_Object frame;
5331 XSETFRAME (frame, f);
5332 lface = Finternal_make_lisp_face (Qdefault, frame);
5335 #ifdef HAVE_WINDOW_SYSTEM
5336 if (FRAME_WINDOW_P (f))
5338 Lisp_Object font_object;
5340 XSETFONT (font_object, FRAME_FONT (f));
5341 set_lface_from_font (f, lface, font_object, f->default_face_done_p);
5342 ASET (lface, LFACE_FONTSET_INDEX, fontset_name (FRAME_FONTSET (f)));
5343 f->default_face_done_p = 1;
5345 #endif /* HAVE_WINDOW_SYSTEM */
5347 if (!FRAME_WINDOW_P (f))
5349 ASET (lface, LFACE_FAMILY_INDEX, build_string ("default"));
5350 ASET (lface, LFACE_FOUNDRY_INDEX, LFACE_FAMILY (lface));
5351 ASET (lface, LFACE_SWIDTH_INDEX, Qnormal);
5352 ASET (lface, LFACE_HEIGHT_INDEX, make_number (1));
5353 if (UNSPECIFIEDP (LFACE_WEIGHT (lface)))
5354 ASET (lface, LFACE_WEIGHT_INDEX, Qnormal);
5355 if (UNSPECIFIEDP (LFACE_SLANT (lface)))
5356 ASET (lface, LFACE_SLANT_INDEX, Qnormal);
5357 if (UNSPECIFIEDP (LFACE_FONTSET (lface)))
5358 ASET (lface, LFACE_FONTSET_INDEX, Qnil);
5361 if (UNSPECIFIEDP (LFACE_UNDERLINE (lface)))
5362 ASET (lface, LFACE_UNDERLINE_INDEX, Qnil);
5364 if (UNSPECIFIEDP (LFACE_OVERLINE (lface)))
5365 ASET (lface, LFACE_OVERLINE_INDEX, Qnil);
5367 if (UNSPECIFIEDP (LFACE_STRIKE_THROUGH (lface)))
5368 ASET (lface, LFACE_STRIKE_THROUGH_INDEX, Qnil);
5370 if (UNSPECIFIEDP (LFACE_BOX (lface)))
5371 ASET (lface, LFACE_BOX_INDEX, Qnil);
5373 if (UNSPECIFIEDP (LFACE_INVERSE (lface)))
5374 ASET (lface, LFACE_INVERSE_INDEX, Qnil);
5376 if (UNSPECIFIEDP (LFACE_FOREGROUND (lface)))
5378 /* This function is called so early that colors are not yet
5379 set in the frame parameter list. */
5380 Lisp_Object color = Fassq (Qforeground_color, f->param_alist);
5382 if (CONSP (color) && STRINGP (XCDR (color)))
5383 ASET (lface, LFACE_FOREGROUND_INDEX, XCDR (color));
5384 else if (FRAME_WINDOW_P (f))
5385 return 0;
5386 else if (FRAME_INITIAL_P (f) || FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5387 ASET (lface, LFACE_FOREGROUND_INDEX, build_string (unspecified_fg));
5388 else
5389 emacs_abort ();
5392 if (UNSPECIFIEDP (LFACE_BACKGROUND (lface)))
5394 /* This function is called so early that colors are not yet
5395 set in the frame parameter list. */
5396 Lisp_Object color = Fassq (Qbackground_color, f->param_alist);
5397 if (CONSP (color) && STRINGP (XCDR (color)))
5398 ASET (lface, LFACE_BACKGROUND_INDEX, XCDR (color));
5399 else if (FRAME_WINDOW_P (f))
5400 return 0;
5401 else if (FRAME_INITIAL_P (f) || FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5402 ASET (lface, LFACE_BACKGROUND_INDEX, build_string (unspecified_bg));
5403 else
5404 emacs_abort ();
5407 if (UNSPECIFIEDP (LFACE_STIPPLE (lface)))
5408 ASET (lface, LFACE_STIPPLE_INDEX, Qnil);
5410 /* Realize the face; it must be fully-specified now. */
5411 eassert (lface_fully_specified_p (XVECTOR (lface)->contents));
5412 check_lface (lface);
5413 memcpy (attrs, XVECTOR (lface)->contents, sizeof attrs);
5414 face = realize_face (c, attrs, DEFAULT_FACE_ID);
5416 #ifdef HAVE_WINDOW_SYSTEM
5417 #ifdef HAVE_X_WINDOWS
5418 if (FRAME_X_P (f) && face->font != FRAME_FONT (f))
5420 /* This can happen when making a frame on a display that does
5421 not support the default font. */
5422 if (!face->font)
5423 return 0;
5425 /* Otherwise, the font specified for the frame was not
5426 acceptable as a font for the default face (perhaps because
5427 auto-scaled fonts are rejected), so we must adjust the frame
5428 font. */
5429 x_set_font (f, LFACE_FONT (lface), Qnil);
5431 #endif /* HAVE_X_WINDOWS */
5432 #endif /* HAVE_WINDOW_SYSTEM */
5433 return 1;
5437 /* Realize basic faces other than the default face in face cache C.
5438 SYMBOL is the face name, ID is the face id the realized face must
5439 have. The default face must have been realized already. */
5441 static void
5442 realize_named_face (struct frame *f, Lisp_Object symbol, int id)
5444 struct face_cache *c = FRAME_FACE_CACHE (f);
5445 Lisp_Object lface = lface_from_face_name (f, symbol, 0);
5446 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5447 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
5449 /* The default face must exist and be fully specified. */
5450 get_lface_attributes_no_remap (f, Qdefault, attrs, 1);
5451 check_lface_attrs (attrs);
5452 eassert (lface_fully_specified_p (attrs));
5454 /* If SYMBOL isn't know as a face, create it. */
5455 if (NILP (lface))
5457 Lisp_Object frame;
5458 XSETFRAME (frame, f);
5459 lface = Finternal_make_lisp_face (symbol, frame);
5462 /* Merge SYMBOL's face with the default face. */
5463 get_lface_attributes_no_remap (f, symbol, symbol_attrs, 1);
5464 merge_face_vectors (f, symbol_attrs, attrs, 0);
5466 /* Realize the face. */
5467 realize_face (c, attrs, id);
5471 /* Realize the fully-specified face with attributes ATTRS in face
5472 cache CACHE for ASCII characters. If FORMER_FACE_ID is
5473 non-negative, it is an ID of face to remove before caching the new
5474 face. Value is a pointer to the newly created realized face. */
5476 static struct face *
5477 realize_face (struct face_cache *cache, Lisp_Object *attrs, int former_face_id)
5479 struct face *face;
5481 /* LFACE must be fully specified. */
5482 eassert (cache != NULL);
5483 check_lface_attrs (attrs);
5485 if (former_face_id >= 0 && cache->used > former_face_id)
5487 /* Remove the former face. */
5488 struct face *former_face = cache->faces_by_id[former_face_id];
5489 uncache_face (cache, former_face);
5490 free_realized_face (cache->f, former_face);
5491 SET_FRAME_GARBAGED (cache->f);
5494 if (FRAME_WINDOW_P (cache->f))
5495 face = realize_x_face (cache, attrs);
5496 else if (FRAME_TERMCAP_P (cache->f) || FRAME_MSDOS_P (cache->f))
5497 face = realize_tty_face (cache, attrs);
5498 else if (FRAME_INITIAL_P (cache->f))
5500 /* Create a dummy face. */
5501 face = make_realized_face (attrs);
5503 else
5504 emacs_abort ();
5506 /* Insert the new face. */
5507 cache_face (cache, face, lface_hash (attrs));
5508 return face;
5512 #ifdef HAVE_WINDOW_SYSTEM
5513 /* Realize the fully-specified face that uses FONT-OBJECT and has the
5514 same attributes as BASE_FACE except for the font on frame F.
5515 FONT-OBJECT may be nil, in which case, realized a face of
5516 no-font. */
5518 static struct face *
5519 realize_non_ascii_face (struct frame *f, Lisp_Object font_object,
5520 struct face *base_face)
5522 struct face_cache *cache = FRAME_FACE_CACHE (f);
5523 struct face *face;
5525 face = xmalloc (sizeof *face);
5526 *face = *base_face;
5527 face->gc = 0;
5528 face->extra = NULL;
5529 face->overstrike
5530 = (! NILP (font_object)
5531 && FONT_WEIGHT_NAME_NUMERIC (face->lface[LFACE_WEIGHT_INDEX]) > 100
5532 && FONT_WEIGHT_NUMERIC (font_object) <= 100);
5534 /* Don't try to free the colors copied bitwise from BASE_FACE. */
5535 face->colors_copied_bitwise_p = 1;
5536 face->font = NILP (font_object) ? NULL : XFONT_OBJECT (font_object);
5537 face->gc = 0;
5539 cache_face (cache, face, face->hash);
5541 return face;
5543 #endif /* HAVE_WINDOW_SYSTEM */
5546 /* Realize the fully-specified face with attributes ATTRS in face
5547 cache CACHE for ASCII characters. Do it for X frame CACHE->f. If
5548 the new face doesn't share font with the default face, a fontname
5549 is allocated from the heap and set in `font_name' of the new face,
5550 but it is not yet loaded here. Value is a pointer to the newly
5551 created realized face. */
5553 static struct face *
5554 realize_x_face (struct face_cache *cache, Lisp_Object *attrs)
5556 struct face *face = NULL;
5557 #ifdef HAVE_WINDOW_SYSTEM
5558 struct face *default_face;
5559 struct frame *f;
5560 Lisp_Object stipple, underline, overline, strike_through, box;
5562 eassert (FRAME_WINDOW_P (cache->f));
5564 /* Allocate a new realized face. */
5565 face = make_realized_face (attrs);
5566 face->ascii_face = face;
5568 f = cache->f;
5570 /* Determine the font to use. Most of the time, the font will be
5571 the same as the font of the default face, so try that first. */
5572 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5573 if (default_face
5574 && lface_same_font_attributes_p (default_face->lface, attrs))
5576 face->font = default_face->font;
5577 face->fontset
5578 = make_fontset_for_ascii_face (f, default_face->fontset, face);
5580 else
5582 /* If the face attribute ATTRS specifies a fontset, use it as
5583 the base of a new realized fontset. Otherwise, use the same
5584 base fontset as of the default face. The base determines
5585 registry and encoding of a font. It may also determine
5586 foundry and family. The other fields of font name pattern
5587 are constructed from ATTRS. */
5588 int fontset = face_fontset (attrs);
5590 /* If we are realizing the default face, ATTRS should specify a
5591 fontset. In other words, if FONTSET is -1, we are not
5592 realizing the default face, thus the default face should have
5593 already been realized. */
5594 if (fontset == -1)
5596 if (default_face)
5597 fontset = default_face->fontset;
5598 if (fontset == -1)
5599 emacs_abort ();
5601 if (! FONT_OBJECT_P (attrs[LFACE_FONT_INDEX]))
5602 attrs[LFACE_FONT_INDEX]
5603 = font_load_for_lface (f, attrs, attrs[LFACE_FONT_INDEX]);
5604 if (FONT_OBJECT_P (attrs[LFACE_FONT_INDEX]))
5606 face->font = XFONT_OBJECT (attrs[LFACE_FONT_INDEX]);
5607 face->fontset = make_fontset_for_ascii_face (f, fontset, face);
5609 else
5611 face->font = NULL;
5612 face->fontset = -1;
5616 if (face->font
5617 && FONT_WEIGHT_NAME_NUMERIC (attrs[LFACE_WEIGHT_INDEX]) > 100
5618 && FONT_WEIGHT_NUMERIC (attrs[LFACE_FONT_INDEX]) <= 100)
5619 face->overstrike = 1;
5621 /* Load colors, and set remaining attributes. */
5623 load_face_colors (f, face, attrs);
5625 /* Set up box. */
5626 box = attrs[LFACE_BOX_INDEX];
5627 if (STRINGP (box))
5629 /* A simple box of line width 1 drawn in color given by
5630 the string. */
5631 face->box_color = load_color (f, face, attrs[LFACE_BOX_INDEX],
5632 LFACE_BOX_INDEX);
5633 face->box = FACE_SIMPLE_BOX;
5634 face->box_line_width = 1;
5636 else if (INTEGERP (box))
5638 /* Simple box of specified line width in foreground color of the
5639 face. */
5640 eassert (XINT (box) != 0);
5641 face->box = FACE_SIMPLE_BOX;
5642 face->box_line_width = XINT (box);
5643 face->box_color = face->foreground;
5644 face->box_color_defaulted_p = 1;
5646 else if (CONSP (box))
5648 /* `(:width WIDTH :color COLOR :shadow SHADOW)'. SHADOW
5649 being one of `raised' or `sunken'. */
5650 face->box = FACE_SIMPLE_BOX;
5651 face->box_color = face->foreground;
5652 face->box_color_defaulted_p = 1;
5653 face->box_line_width = 1;
5655 while (CONSP (box))
5657 Lisp_Object keyword, value;
5659 keyword = XCAR (box);
5660 box = XCDR (box);
5662 if (!CONSP (box))
5663 break;
5664 value = XCAR (box);
5665 box = XCDR (box);
5667 if (EQ (keyword, QCline_width))
5669 if (INTEGERP (value) && XINT (value) != 0)
5670 face->box_line_width = XINT (value);
5672 else if (EQ (keyword, QCcolor))
5674 if (STRINGP (value))
5676 face->box_color = load_color (f, face, value,
5677 LFACE_BOX_INDEX);
5678 face->use_box_color_for_shadows_p = 1;
5681 else if (EQ (keyword, QCstyle))
5683 if (EQ (value, Qreleased_button))
5684 face->box = FACE_RAISED_BOX;
5685 else if (EQ (value, Qpressed_button))
5686 face->box = FACE_SUNKEN_BOX;
5691 /* Text underline, overline, strike-through. */
5693 underline = attrs[LFACE_UNDERLINE_INDEX];
5694 if (EQ (underline, Qt))
5696 /* Use default color (same as foreground color). */
5697 face->underline_p = 1;
5698 face->underline_type = FACE_UNDER_LINE;
5699 face->underline_defaulted_p = 1;
5700 face->underline_color = 0;
5702 else if (STRINGP (underline))
5704 /* Use specified color. */
5705 face->underline_p = 1;
5706 face->underline_type = FACE_UNDER_LINE;
5707 face->underline_defaulted_p = 0;
5708 face->underline_color
5709 = load_color (f, face, underline,
5710 LFACE_UNDERLINE_INDEX);
5712 else if (NILP (underline))
5714 face->underline_p = 0;
5715 face->underline_defaulted_p = 0;
5716 face->underline_color = 0;
5718 else if (CONSP (underline))
5720 /* `(:color COLOR :style STYLE)'.
5721 STYLE being one of `line' or `wave'. */
5722 face->underline_p = 1;
5723 face->underline_color = 0;
5724 face->underline_defaulted_p = 1;
5725 face->underline_type = FACE_UNDER_LINE;
5727 while (CONSP (underline))
5729 Lisp_Object keyword, value;
5731 keyword = XCAR (underline);
5732 underline = XCDR (underline);
5734 if (!CONSP (underline))
5735 break;
5736 value = XCAR (underline);
5737 underline = XCDR (underline);
5739 if (EQ (keyword, QCcolor))
5741 if (EQ (value, Qforeground_color))
5743 face->underline_defaulted_p = 1;
5744 face->underline_color = 0;
5746 else if (STRINGP (value))
5748 face->underline_defaulted_p = 0;
5749 face->underline_color = load_color (f, face, value,
5750 LFACE_UNDERLINE_INDEX);
5753 else if (EQ (keyword, QCstyle))
5755 if (EQ (value, Qline))
5756 face->underline_type = FACE_UNDER_LINE;
5757 else if (EQ (value, Qwave))
5758 face->underline_type = FACE_UNDER_WAVE;
5763 overline = attrs[LFACE_OVERLINE_INDEX];
5764 if (STRINGP (overline))
5766 face->overline_color
5767 = load_color (f, face, attrs[LFACE_OVERLINE_INDEX],
5768 LFACE_OVERLINE_INDEX);
5769 face->overline_p = 1;
5771 else if (EQ (overline, Qt))
5773 face->overline_color = face->foreground;
5774 face->overline_color_defaulted_p = 1;
5775 face->overline_p = 1;
5778 strike_through = attrs[LFACE_STRIKE_THROUGH_INDEX];
5779 if (STRINGP (strike_through))
5781 face->strike_through_color
5782 = load_color (f, face, attrs[LFACE_STRIKE_THROUGH_INDEX],
5783 LFACE_STRIKE_THROUGH_INDEX);
5784 face->strike_through_p = 1;
5786 else if (EQ (strike_through, Qt))
5788 face->strike_through_color = face->foreground;
5789 face->strike_through_color_defaulted_p = 1;
5790 face->strike_through_p = 1;
5793 stipple = attrs[LFACE_STIPPLE_INDEX];
5794 if (!NILP (stipple))
5795 face->stipple = load_pixmap (f, stipple, &face->pixmap_w, &face->pixmap_h);
5796 #endif /* HAVE_WINDOW_SYSTEM */
5798 return face;
5802 /* Map a specified color of face FACE on frame F to a tty color index.
5803 IDX is either LFACE_FOREGROUND_INDEX or LFACE_BACKGROUND_INDEX, and
5804 specifies which color to map. Set *DEFAULTED to 1 if mapping to the
5805 default foreground/background colors. */
5807 static void
5808 map_tty_color (struct frame *f, struct face *face,
5809 enum lface_attribute_index idx, int *defaulted)
5811 Lisp_Object frame, color, def;
5812 int foreground_p = idx == LFACE_FOREGROUND_INDEX;
5813 unsigned long default_pixel =
5814 foreground_p ? FACE_TTY_DEFAULT_FG_COLOR : FACE_TTY_DEFAULT_BG_COLOR;
5815 unsigned long pixel = default_pixel;
5816 #ifdef MSDOS
5817 unsigned long default_other_pixel =
5818 foreground_p ? FACE_TTY_DEFAULT_BG_COLOR : FACE_TTY_DEFAULT_FG_COLOR;
5819 #endif
5821 eassert (idx == LFACE_FOREGROUND_INDEX || idx == LFACE_BACKGROUND_INDEX);
5823 XSETFRAME (frame, f);
5824 color = face->lface[idx];
5826 if (STRINGP (color)
5827 && SCHARS (color)
5828 && CONSP (Vtty_defined_color_alist)
5829 && (def = assq_no_quit (color, call1 (Qtty_color_alist, frame)),
5830 CONSP (def)))
5832 /* Associations in tty-defined-color-alist are of the form
5833 (NAME INDEX R G B). We need the INDEX part. */
5834 pixel = XINT (XCAR (XCDR (def)));
5837 if (pixel == default_pixel && STRINGP (color))
5839 pixel = load_color (f, face, color, idx);
5841 #ifdef MSDOS
5842 /* If the foreground of the default face is the default color,
5843 use the foreground color defined by the frame. */
5844 if (FRAME_MSDOS_P (f))
5846 if (pixel == default_pixel
5847 || pixel == FACE_TTY_DEFAULT_COLOR)
5849 if (foreground_p)
5850 pixel = FRAME_FOREGROUND_PIXEL (f);
5851 else
5852 pixel = FRAME_BACKGROUND_PIXEL (f);
5853 face->lface[idx] = tty_color_name (f, pixel);
5854 *defaulted = 1;
5856 else if (pixel == default_other_pixel)
5858 if (foreground_p)
5859 pixel = FRAME_BACKGROUND_PIXEL (f);
5860 else
5861 pixel = FRAME_FOREGROUND_PIXEL (f);
5862 face->lface[idx] = tty_color_name (f, pixel);
5863 *defaulted = 1;
5866 #endif /* MSDOS */
5869 if (foreground_p)
5870 face->foreground = pixel;
5871 else
5872 face->background = pixel;
5876 /* Realize the fully-specified face with attributes ATTRS in face
5877 cache CACHE for ASCII characters. Do it for TTY frame CACHE->f.
5878 Value is a pointer to the newly created realized face. */
5880 static struct face *
5881 realize_tty_face (struct face_cache *cache, Lisp_Object *attrs)
5883 struct face *face;
5884 int weight, slant;
5885 int face_colors_defaulted = 0;
5886 struct frame *f = cache->f;
5888 /* Frame must be a termcap frame. */
5889 eassert (FRAME_TERMCAP_P (cache->f) || FRAME_MSDOS_P (cache->f));
5891 /* Allocate a new realized face. */
5892 face = make_realized_face (attrs);
5893 #if 0
5894 face->font_name = FRAME_MSDOS_P (cache->f) ? "ms-dos" : "tty";
5895 #endif
5897 /* Map face attributes to TTY appearances. */
5898 weight = FONT_WEIGHT_NAME_NUMERIC (attrs[LFACE_WEIGHT_INDEX]);
5899 slant = FONT_SLANT_NAME_NUMERIC (attrs[LFACE_SLANT_INDEX]);
5900 if (weight > 100)
5901 face->tty_bold_p = 1;
5902 if (slant != 100)
5903 face->tty_italic_p = 1;
5904 if (!NILP (attrs[LFACE_UNDERLINE_INDEX]))
5905 face->tty_underline_p = 1;
5906 if (!NILP (attrs[LFACE_INVERSE_INDEX]))
5907 face->tty_reverse_p = 1;
5909 /* Map color names to color indices. */
5910 map_tty_color (f, face, LFACE_FOREGROUND_INDEX, &face_colors_defaulted);
5911 map_tty_color (f, face, LFACE_BACKGROUND_INDEX, &face_colors_defaulted);
5913 /* Swap colors if face is inverse-video. If the colors are taken
5914 from the frame colors, they are already inverted, since the
5915 frame-creation function calls x-handle-reverse-video. */
5916 if (face->tty_reverse_p && !face_colors_defaulted)
5918 unsigned long tem = face->foreground;
5919 face->foreground = face->background;
5920 face->background = tem;
5923 if (tty_suppress_bold_inverse_default_colors_p
5924 && face->tty_bold_p
5925 && face->background == FACE_TTY_DEFAULT_FG_COLOR
5926 && face->foreground == FACE_TTY_DEFAULT_BG_COLOR)
5927 face->tty_bold_p = 0;
5929 return face;
5933 DEFUN ("tty-suppress-bold-inverse-default-colors",
5934 Ftty_suppress_bold_inverse_default_colors,
5935 Stty_suppress_bold_inverse_default_colors, 1, 1, 0,
5936 doc: /* Suppress/allow boldness of faces with inverse default colors.
5937 SUPPRESS non-nil means suppress it.
5938 This affects bold faces on TTYs whose foreground is the default background
5939 color of the display and whose background is the default foreground color.
5940 For such faces, the bold face attribute is ignored if this variable
5941 is non-nil. */)
5942 (Lisp_Object suppress)
5944 tty_suppress_bold_inverse_default_colors_p = !NILP (suppress);
5945 ++face_change_count;
5946 return suppress;
5951 /***********************************************************************
5952 Computing Faces
5953 ***********************************************************************/
5955 /* Return the ID of the face to use to display character CH with face
5956 property PROP on frame F in current_buffer. */
5959 compute_char_face (struct frame *f, int ch, Lisp_Object prop)
5961 int face_id;
5963 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
5964 ch = 0;
5966 if (NILP (prop))
5968 struct face *face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5969 face_id = FACE_FOR_CHAR (f, face, ch, -1, Qnil);
5971 else
5973 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5974 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5975 memcpy (attrs, default_face->lface, sizeof attrs);
5976 merge_face_ref (f, prop, attrs, 1, 0);
5977 face_id = lookup_face (f, attrs);
5980 return face_id;
5983 /* Return the face ID associated with buffer position POS for
5984 displaying ASCII characters. Return in *ENDPTR the position at
5985 which a different face is needed, as far as text properties and
5986 overlays are concerned. W is a window displaying current_buffer.
5988 REGION_BEG, REGION_END delimit the region, so it can be
5989 highlighted.
5991 LIMIT is a position not to scan beyond. That is to limit the time
5992 this function can take.
5994 If MOUSE is non-zero, use the character's mouse-face, not its face.
5996 BASE_FACE_ID, if non-negative, specifies a base face id to use
5997 instead of DEFAULT_FACE_ID.
5999 The face returned is suitable for displaying ASCII characters. */
6002 face_at_buffer_position (struct window *w, ptrdiff_t pos,
6003 ptrdiff_t region_beg, ptrdiff_t region_end,
6004 ptrdiff_t *endptr, ptrdiff_t limit,
6005 int mouse, int base_face_id)
6007 struct frame *f = XFRAME (w->frame);
6008 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6009 Lisp_Object prop, position;
6010 ptrdiff_t i, noverlays;
6011 Lisp_Object *overlay_vec;
6012 ptrdiff_t endpos;
6013 Lisp_Object propname = mouse ? Qmouse_face : Qface;
6014 Lisp_Object limit1, end;
6015 struct face *default_face;
6017 /* W must display the current buffer. We could write this function
6018 to use the frame and buffer of W, but right now it doesn't. */
6019 /* eassert (XBUFFER (w->buffer) == current_buffer); */
6021 XSETFASTINT (position, pos);
6023 endpos = ZV;
6024 if (pos < region_beg && region_beg < endpos)
6025 endpos = region_beg;
6027 /* Get the `face' or `mouse_face' text property at POS, and
6028 determine the next position at which the property changes. */
6029 prop = Fget_text_property (position, propname, w->buffer);
6030 XSETFASTINT (limit1, (limit < endpos ? limit : endpos));
6031 end = Fnext_single_property_change (position, propname, w->buffer, limit1);
6032 if (INTEGERP (end))
6033 endpos = XINT (end);
6035 /* Look at properties from overlays. */
6037 ptrdiff_t next_overlay;
6039 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, &next_overlay, 0);
6040 if (next_overlay < endpos)
6041 endpos = next_overlay;
6044 *endptr = endpos;
6047 int face_id;
6049 if (base_face_id >= 0)
6050 face_id = base_face_id;
6051 else if (NILP (Vface_remapping_alist))
6052 face_id = DEFAULT_FACE_ID;
6053 else
6054 face_id = lookup_basic_face (f, DEFAULT_FACE_ID);
6056 default_face = FACE_FROM_ID (f, face_id);
6059 /* Optimize common cases where we can use the default face. */
6060 if (noverlays == 0
6061 && NILP (prop)
6062 && !(pos >= region_beg && pos < region_end))
6063 return default_face->id;
6065 /* Begin with attributes from the default face. */
6066 memcpy (attrs, default_face->lface, sizeof attrs);
6068 /* Merge in attributes specified via text properties. */
6069 if (!NILP (prop))
6070 merge_face_ref (f, prop, attrs, 1, 0);
6072 /* Now merge the overlay data. */
6073 noverlays = sort_overlays (overlay_vec, noverlays, w);
6074 for (i = 0; i < noverlays; i++)
6076 Lisp_Object oend;
6077 ptrdiff_t oendpos;
6079 prop = Foverlay_get (overlay_vec[i], propname);
6080 if (!NILP (prop))
6081 merge_face_ref (f, prop, attrs, 1, 0);
6083 oend = OVERLAY_END (overlay_vec[i]);
6084 oendpos = OVERLAY_POSITION (oend);
6085 if (oendpos < endpos)
6086 endpos = oendpos;
6089 /* If in the region, merge in the region face. */
6090 if (pos >= region_beg && pos < region_end)
6092 merge_named_face (f, Qregion, attrs, 0);
6094 if (region_end < endpos)
6095 endpos = region_end;
6098 *endptr = endpos;
6100 /* Look up a realized face with the given face attributes,
6101 or realize a new one for ASCII characters. */
6102 return lookup_face (f, attrs);
6105 /* Return the face ID at buffer position POS for displaying ASCII
6106 characters associated with overlay strings for overlay OVERLAY.
6108 Like face_at_buffer_position except for OVERLAY. Currently it
6109 simply disregards the `face' properties of all overlays. */
6112 face_for_overlay_string (struct window *w, ptrdiff_t pos,
6113 ptrdiff_t region_beg, ptrdiff_t region_end,
6114 ptrdiff_t *endptr, ptrdiff_t limit,
6115 int mouse, Lisp_Object overlay)
6117 struct frame *f = XFRAME (w->frame);
6118 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6119 Lisp_Object prop, position;
6120 ptrdiff_t endpos;
6121 Lisp_Object propname = mouse ? Qmouse_face : Qface;
6122 Lisp_Object limit1, end;
6123 struct face *default_face;
6125 /* W must display the current buffer. We could write this function
6126 to use the frame and buffer of W, but right now it doesn't. */
6127 /* eassert (XBUFFER (w->buffer) == current_buffer); */
6129 XSETFASTINT (position, pos);
6131 endpos = ZV;
6132 if (pos < region_beg && region_beg < endpos)
6133 endpos = region_beg;
6135 /* Get the `face' or `mouse_face' text property at POS, and
6136 determine the next position at which the property changes. */
6137 prop = Fget_text_property (position, propname, w->buffer);
6138 XSETFASTINT (limit1, (limit < endpos ? limit : endpos));
6139 end = Fnext_single_property_change (position, propname, w->buffer, limit1);
6140 if (INTEGERP (end))
6141 endpos = XINT (end);
6143 *endptr = endpos;
6145 /* Optimize common case where we can use the default face. */
6146 if (NILP (prop)
6147 && !(pos >= region_beg && pos < region_end)
6148 && NILP (Vface_remapping_alist))
6149 return DEFAULT_FACE_ID;
6151 /* Begin with attributes from the default face. */
6152 default_face = FACE_FROM_ID (f, lookup_basic_face (f, DEFAULT_FACE_ID));
6153 memcpy (attrs, default_face->lface, sizeof attrs);
6155 /* Merge in attributes specified via text properties. */
6156 if (!NILP (prop))
6157 merge_face_ref (f, prop, attrs, 1, 0);
6159 /* If in the region, merge in the region face. */
6160 if (pos >= region_beg && pos < region_end)
6162 merge_named_face (f, Qregion, attrs, 0);
6164 if (region_end < endpos)
6165 endpos = region_end;
6168 *endptr = endpos;
6170 /* Look up a realized face with the given face attributes,
6171 or realize a new one for ASCII characters. */
6172 return lookup_face (f, attrs);
6176 /* Compute the face at character position POS in Lisp string STRING on
6177 window W, for ASCII characters.
6179 If STRING is an overlay string, it comes from position BUFPOS in
6180 current_buffer, otherwise BUFPOS is zero to indicate that STRING is
6181 not an overlay string. W must display the current buffer.
6182 REGION_BEG and REGION_END give the start and end positions of the
6183 region; both are -1 if no region is visible.
6185 BASE_FACE_ID is the id of a face to merge with. For strings coming
6186 from overlays or the `display' property it is the face at BUFPOS.
6188 If MOUSE_P is non-zero, use the character's mouse-face, not its face.
6190 Set *ENDPTR to the next position where to check for faces in
6191 STRING; -1 if the face is constant from POS to the end of the
6192 string.
6194 Value is the id of the face to use. The face returned is suitable
6195 for displaying ASCII characters. */
6198 face_at_string_position (struct window *w, Lisp_Object string,
6199 ptrdiff_t pos, ptrdiff_t bufpos,
6200 ptrdiff_t region_beg, ptrdiff_t region_end,
6201 ptrdiff_t *endptr, enum face_id base_face_id,
6202 int mouse_p)
6204 Lisp_Object prop, position, end, limit;
6205 struct frame *f = XFRAME (WINDOW_FRAME (w));
6206 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6207 struct face *base_face;
6208 int multibyte_p = STRING_MULTIBYTE (string);
6209 Lisp_Object prop_name = mouse_p ? Qmouse_face : Qface;
6211 /* Get the value of the face property at the current position within
6212 STRING. Value is nil if there is no face property. */
6213 XSETFASTINT (position, pos);
6214 prop = Fget_text_property (position, prop_name, string);
6216 /* Get the next position at which to check for faces. Value of end
6217 is nil if face is constant all the way to the end of the string.
6218 Otherwise it is a string position where to check faces next.
6219 Limit is the maximum position up to which to check for property
6220 changes in Fnext_single_property_change. Strings are usually
6221 short, so set the limit to the end of the string. */
6222 XSETFASTINT (limit, SCHARS (string));
6223 end = Fnext_single_property_change (position, prop_name, string, limit);
6224 if (INTEGERP (end))
6225 *endptr = XFASTINT (end);
6226 else
6227 *endptr = -1;
6229 base_face = FACE_FROM_ID (f, base_face_id);
6230 eassert (base_face);
6232 /* Optimize the default case that there is no face property and we
6233 are not in the region. */
6234 if (NILP (prop)
6235 && (base_face_id != DEFAULT_FACE_ID
6236 /* BUFPOS <= 0 means STRING is not an overlay string, so
6237 that the region doesn't have to be taken into account. */
6238 || bufpos <= 0
6239 || bufpos < region_beg
6240 || bufpos >= region_end)
6241 && (multibyte_p
6242 /* We can't realize faces for different charsets differently
6243 if we don't have fonts, so we can stop here if not working
6244 on a window-system frame. */
6245 || !FRAME_WINDOW_P (f)
6246 || FACE_SUITABLE_FOR_ASCII_CHAR_P (base_face, 0)))
6247 return base_face->id;
6249 /* Begin with attributes from the base face. */
6250 memcpy (attrs, base_face->lface, sizeof attrs);
6252 /* Merge in attributes specified via text properties. */
6253 if (!NILP (prop))
6254 merge_face_ref (f, prop, attrs, 1, 0);
6256 /* If in the region, merge in the region face. */
6257 if (bufpos
6258 && bufpos >= region_beg
6259 && bufpos < region_end)
6260 merge_named_face (f, Qregion, attrs, 0);
6262 /* Look up a realized face with the given face attributes,
6263 or realize a new one for ASCII characters. */
6264 return lookup_face (f, attrs);
6268 /* Merge a face into a realized face.
6270 F is frame where faces are (to be) realized.
6272 FACE_NAME is named face to merge.
6274 If FACE_NAME is nil, FACE_ID is face_id of realized face to merge.
6276 If FACE_NAME is t, FACE_ID is lface_id of face to merge.
6278 BASE_FACE_ID is realized face to merge into.
6280 Return new face id.
6284 merge_faces (struct frame *f, Lisp_Object face_name, int face_id,
6285 int base_face_id)
6287 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6288 struct face *base_face;
6290 base_face = FACE_FROM_ID (f, base_face_id);
6291 if (!base_face)
6292 return base_face_id;
6294 if (EQ (face_name, Qt))
6296 if (face_id < 0 || face_id >= lface_id_to_name_size)
6297 return base_face_id;
6298 face_name = lface_id_to_name[face_id];
6299 /* When called during make-frame, lookup_derived_face may fail
6300 if the faces are uninitialized. Don't signal an error. */
6301 face_id = lookup_derived_face (f, face_name, base_face_id, 0);
6302 return (face_id >= 0 ? face_id : base_face_id);
6305 /* Begin with attributes from the base face. */
6306 memcpy (attrs, base_face->lface, sizeof attrs);
6308 if (!NILP (face_name))
6310 if (!merge_named_face (f, face_name, attrs, 0))
6311 return base_face_id;
6313 else
6315 struct face *face;
6316 if (face_id < 0)
6317 return base_face_id;
6318 face = FACE_FROM_ID (f, face_id);
6319 if (!face)
6320 return base_face_id;
6321 merge_face_vectors (f, face->lface, attrs, 0);
6324 /* Look up a realized face with the given face attributes,
6325 or realize a new one for ASCII characters. */
6326 return lookup_face (f, attrs);
6331 #ifndef HAVE_X_WINDOWS
6332 DEFUN ("x-load-color-file", Fx_load_color_file,
6333 Sx_load_color_file, 1, 1, 0,
6334 doc: /* Create an alist of color entries from an external file.
6336 The file should define one named RGB color per line like so:
6337 R G B name
6338 where R,G,B are numbers between 0 and 255 and name is an arbitrary string. */)
6339 (Lisp_Object filename)
6341 FILE *fp;
6342 Lisp_Object cmap = Qnil;
6343 Lisp_Object abspath;
6345 CHECK_STRING (filename);
6346 abspath = Fexpand_file_name (filename, Qnil);
6348 fp = fopen (SSDATA (abspath), "rt");
6349 if (fp)
6351 char buf[512];
6352 int red, green, blue;
6353 int num;
6355 BLOCK_INPUT;
6357 while (fgets (buf, sizeof (buf), fp) != NULL) {
6358 if (sscanf (buf, "%u %u %u %n", &red, &green, &blue, &num) == 3)
6360 char *name = buf + num;
6361 num = strlen (name) - 1;
6362 if (num >= 0 && name[num] == '\n')
6363 name[num] = 0;
6364 cmap = Fcons (Fcons (build_string (name),
6365 #ifdef HAVE_NTGUI
6366 make_number (RGB (red, green, blue))),
6367 #else
6368 make_number ((red << 16) | (green << 8) | blue)),
6369 #endif
6370 cmap);
6373 fclose (fp);
6375 UNBLOCK_INPUT;
6378 return cmap;
6380 #endif
6383 /***********************************************************************
6384 Tests
6385 ***********************************************************************/
6387 #ifdef GLYPH_DEBUG
6389 /* Print the contents of the realized face FACE to stderr. */
6391 static void
6392 dump_realized_face (struct face *face)
6394 fprintf (stderr, "ID: %d\n", face->id);
6395 #ifdef HAVE_X_WINDOWS
6396 fprintf (stderr, "gc: %ld\n", (long) face->gc);
6397 #endif
6398 fprintf (stderr, "foreground: 0x%lx (%s)\n",
6399 face->foreground,
6400 SDATA (face->lface[LFACE_FOREGROUND_INDEX]));
6401 fprintf (stderr, "background: 0x%lx (%s)\n",
6402 face->background,
6403 SDATA (face->lface[LFACE_BACKGROUND_INDEX]));
6404 if (face->font)
6405 fprintf (stderr, "font_name: %s (%s)\n",
6406 SDATA (face->font->props[FONT_NAME_INDEX]),
6407 SDATA (face->lface[LFACE_FAMILY_INDEX]));
6408 #ifdef HAVE_X_WINDOWS
6409 fprintf (stderr, "font = %p\n", face->font);
6410 #endif
6411 fprintf (stderr, "fontset: %d\n", face->fontset);
6412 fprintf (stderr, "underline: %d (%s)\n",
6413 face->underline_p,
6414 SDATA (Fsymbol_name (face->lface[LFACE_UNDERLINE_INDEX])));
6415 fprintf (stderr, "hash: %d\n", face->hash);
6419 DEFUN ("dump-face", Fdump_face, Sdump_face, 0, 1, 0, doc: /* */)
6420 (Lisp_Object n)
6422 if (NILP (n))
6424 int i;
6426 fprintf (stderr, "font selection order: ");
6427 for (i = 0; i < DIM (font_sort_order); ++i)
6428 fprintf (stderr, "%d ", font_sort_order[i]);
6429 fprintf (stderr, "\n");
6431 fprintf (stderr, "alternative fonts: ");
6432 debug_print (Vface_alternative_font_family_alist);
6433 fprintf (stderr, "\n");
6435 for (i = 0; i < FRAME_FACE_CACHE (SELECTED_FRAME ())->used; ++i)
6436 Fdump_face (make_number (i));
6438 else
6440 struct face *face;
6441 CHECK_NUMBER (n);
6442 face = FACE_FROM_ID (SELECTED_FRAME (), XINT (n));
6443 if (face == NULL)
6444 error ("Not a valid face");
6445 dump_realized_face (face);
6448 return Qnil;
6452 DEFUN ("show-face-resources", Fshow_face_resources, Sshow_face_resources,
6453 0, 0, 0, doc: /* */)
6454 (void)
6456 fprintf (stderr, "number of colors = %d\n", ncolors_allocated);
6457 fprintf (stderr, "number of pixmaps = %d\n", npixmaps_allocated);
6458 fprintf (stderr, "number of GCs = %d\n", ngcs);
6459 return Qnil;
6462 #endif /* GLYPH_DEBUG */
6466 /***********************************************************************
6467 Initialization
6468 ***********************************************************************/
6470 void
6471 syms_of_xfaces (void)
6473 DEFSYM (Qface, "face");
6474 DEFSYM (Qface_no_inherit, "face-no-inherit");
6475 DEFSYM (Qbitmap_spec_p, "bitmap-spec-p");
6476 DEFSYM (Qframe_set_background_mode, "frame-set-background-mode");
6478 /* Lisp face attribute keywords. */
6479 DEFSYM (QCfamily, ":family");
6480 DEFSYM (QCheight, ":height");
6481 DEFSYM (QCweight, ":weight");
6482 DEFSYM (QCslant, ":slant");
6483 DEFSYM (QCunderline, ":underline");
6484 DEFSYM (QCinverse_video, ":inverse-video");
6485 DEFSYM (QCreverse_video, ":reverse-video");
6486 DEFSYM (QCforeground, ":foreground");
6487 DEFSYM (QCbackground, ":background");
6488 DEFSYM (QCstipple, ":stipple");
6489 DEFSYM (QCwidth, ":width");
6490 DEFSYM (QCfont, ":font");
6491 DEFSYM (QCfontset, ":fontset");
6492 DEFSYM (QCbold, ":bold");
6493 DEFSYM (QCitalic, ":italic");
6494 DEFSYM (QCoverline, ":overline");
6495 DEFSYM (QCstrike_through, ":strike-through");
6496 DEFSYM (QCbox, ":box");
6497 DEFSYM (QCinherit, ":inherit");
6499 /* Symbols used for Lisp face attribute values. */
6500 DEFSYM (QCcolor, ":color");
6501 DEFSYM (QCline_width, ":line-width");
6502 DEFSYM (QCstyle, ":style");
6503 DEFSYM (Qline, "line");
6504 DEFSYM (Qwave, "wave");
6505 DEFSYM (Qreleased_button, "released-button");
6506 DEFSYM (Qpressed_button, "pressed-button");
6507 DEFSYM (Qnormal, "normal");
6508 DEFSYM (Qultra_light, "ultra-light");
6509 DEFSYM (Qextra_light, "extra-light");
6510 DEFSYM (Qlight, "light");
6511 DEFSYM (Qsemi_light, "semi-light");
6512 DEFSYM (Qsemi_bold, "semi-bold");
6513 DEFSYM (Qbold, "bold");
6514 DEFSYM (Qextra_bold, "extra-bold");
6515 DEFSYM (Qultra_bold, "ultra-bold");
6516 DEFSYM (Qoblique, "oblique");
6517 DEFSYM (Qitalic, "italic");
6518 DEFSYM (Qreverse_oblique, "reverse-oblique");
6519 DEFSYM (Qreverse_italic, "reverse-italic");
6520 DEFSYM (Qultra_condensed, "ultra-condensed");
6521 DEFSYM (Qextra_condensed, "extra-condensed");
6522 DEFSYM (Qcondensed, "condensed");
6523 DEFSYM (Qsemi_condensed, "semi-condensed");
6524 DEFSYM (Qsemi_expanded, "semi-expanded");
6525 DEFSYM (Qexpanded, "expanded");
6526 DEFSYM (Qextra_expanded, "extra-expanded");
6527 DEFSYM (Qultra_expanded, "ultra-expanded");
6528 DEFSYM (Qbackground_color, "background-color");
6529 DEFSYM (Qforeground_color, "foreground-color");
6530 DEFSYM (Qunspecified, "unspecified");
6531 DEFSYM (QCignore_defface, ":ignore-defface");
6533 DEFSYM (Qface_alias, "face-alias");
6534 DEFSYM (Qdefault, "default");
6535 DEFSYM (Qtool_bar, "tool-bar");
6536 DEFSYM (Qregion, "region");
6537 DEFSYM (Qfringe, "fringe");
6538 DEFSYM (Qheader_line, "header-line");
6539 DEFSYM (Qscroll_bar, "scroll-bar");
6540 DEFSYM (Qmenu, "menu");
6541 DEFSYM (Qcursor, "cursor");
6542 DEFSYM (Qborder, "border");
6543 DEFSYM (Qmouse, "mouse");
6544 DEFSYM (Qmode_line_inactive, "mode-line-inactive");
6545 DEFSYM (Qvertical_border, "vertical-border");
6546 DEFSYM (Qtty_color_desc, "tty-color-desc");
6547 DEFSYM (Qtty_color_standard_values, "tty-color-standard-values");
6548 DEFSYM (Qtty_color_by_index, "tty-color-by-index");
6549 DEFSYM (Qtty_color_alist, "tty-color-alist");
6550 DEFSYM (Qscalable_fonts_allowed, "scalable-fonts-allowed");
6552 Vparam_value_alist = Fcons (Fcons (Qnil, Qnil), Qnil);
6553 staticpro (&Vparam_value_alist);
6554 Vface_alternative_font_family_alist = Qnil;
6555 staticpro (&Vface_alternative_font_family_alist);
6556 Vface_alternative_font_registry_alist = Qnil;
6557 staticpro (&Vface_alternative_font_registry_alist);
6559 defsubr (&Sinternal_make_lisp_face);
6560 defsubr (&Sinternal_lisp_face_p);
6561 defsubr (&Sinternal_set_lisp_face_attribute);
6562 #ifdef HAVE_WINDOW_SYSTEM
6563 defsubr (&Sinternal_set_lisp_face_attribute_from_resource);
6564 #endif
6565 defsubr (&Scolor_gray_p);
6566 defsubr (&Scolor_supported_p);
6567 #ifndef HAVE_X_WINDOWS
6568 defsubr (&Sx_load_color_file);
6569 #endif
6570 defsubr (&Sface_attribute_relative_p);
6571 defsubr (&Smerge_face_attribute);
6572 defsubr (&Sinternal_get_lisp_face_attribute);
6573 defsubr (&Sinternal_lisp_face_attribute_values);
6574 defsubr (&Sinternal_lisp_face_equal_p);
6575 defsubr (&Sinternal_lisp_face_empty_p);
6576 defsubr (&Sinternal_copy_lisp_face);
6577 defsubr (&Sinternal_merge_in_global_face);
6578 defsubr (&Sface_font);
6579 defsubr (&Sframe_face_alist);
6580 defsubr (&Sdisplay_supports_face_attributes_p);
6581 defsubr (&Scolor_distance);
6582 defsubr (&Sinternal_set_font_selection_order);
6583 defsubr (&Sinternal_set_alternative_font_family_alist);
6584 defsubr (&Sinternal_set_alternative_font_registry_alist);
6585 defsubr (&Sface_attributes_as_vector);
6586 #ifdef GLYPH_DEBUG
6587 defsubr (&Sdump_face);
6588 defsubr (&Sshow_face_resources);
6589 #endif /* GLYPH_DEBUG */
6590 defsubr (&Sclear_face_cache);
6591 defsubr (&Stty_suppress_bold_inverse_default_colors);
6593 #if defined DEBUG_X_COLORS && defined HAVE_X_WINDOWS
6594 defsubr (&Sdump_colors);
6595 #endif
6597 DEFVAR_LISP ("font-list-limit", Vfont_list_limit,
6598 doc: /* Limit for font matching.
6599 If an integer > 0, font matching functions won't load more than
6600 that number of fonts when searching for a matching font. */);
6601 Vfont_list_limit = make_number (DEFAULT_FONT_LIST_LIMIT);
6603 DEFVAR_LISP ("face-new-frame-defaults", Vface_new_frame_defaults,
6604 doc: /* List of global face definitions (for internal use only.) */);
6605 Vface_new_frame_defaults = Qnil;
6607 DEFVAR_LISP ("face-default-stipple", Vface_default_stipple,
6608 doc: /* Default stipple pattern used on monochrome displays.
6609 This stipple pattern is used on monochrome displays
6610 instead of shades of gray for a face background color.
6611 See `set-face-stipple' for possible values for this variable. */);
6612 Vface_default_stipple = build_pure_c_string ("gray3");
6614 DEFVAR_LISP ("tty-defined-color-alist", Vtty_defined_color_alist,
6615 doc: /* An alist of defined terminal colors and their RGB values.
6616 See the docstring of `tty-color-alist' for the details. */);
6617 Vtty_defined_color_alist = Qnil;
6619 DEFVAR_LISP ("scalable-fonts-allowed", Vscalable_fonts_allowed,
6620 doc: /* Allowed scalable fonts.
6621 A value of nil means don't allow any scalable fonts.
6622 A value of t means allow any scalable font.
6623 Otherwise, value must be a list of regular expressions. A font may be
6624 scaled if its name matches a regular expression in the list.
6625 Note that if value is nil, a scalable font might still be used, if no
6626 other font of the appropriate family and registry is available. */);
6627 Vscalable_fonts_allowed = Qnil;
6629 DEFVAR_LISP ("face-ignored-fonts", Vface_ignored_fonts,
6630 doc: /* List of ignored fonts.
6631 Each element is a regular expression that matches names of fonts to
6632 ignore. */);
6633 Vface_ignored_fonts = Qnil;
6635 DEFVAR_LISP ("face-remapping-alist", Vface_remapping_alist,
6636 doc: /* Alist of face remappings.
6637 Each element is of the form:
6639 (FACE . REPLACEMENT),
6641 which causes display of the face FACE to use REPLACEMENT instead.
6642 REPLACEMENT is a face specification, i.e. one of the following:
6644 (1) a face name
6645 (2) a property list of attribute/value pairs, or
6646 (3) a list in which each element has the form of (1) or (2).
6648 List values for REPLACEMENT are merged to form the final face
6649 specification, with earlier entries taking precedence, in the same as
6650 as in the `face' text property.
6652 Face-name remapping cycles are suppressed; recursive references use
6653 the underlying face instead of the remapped face. So a remapping of
6654 the form:
6656 (FACE EXTRA-FACE... FACE)
6660 (FACE (FACE-ATTR VAL ...) FACE)
6662 causes EXTRA-FACE... or (FACE-ATTR VAL ...) to be _merged_ with the
6663 existing definition of FACE. Note that this isn't necessary for the
6664 default face, since every face inherits from the default face.
6666 If this variable is made buffer-local, the face remapping takes effect
6667 only in that buffer. For instance, the mode my-mode could define a
6668 face `my-mode-default', and then in the mode setup function, do:
6670 (set (make-local-variable 'face-remapping-alist)
6671 '((default my-mode-default)))).
6673 Because Emacs normally only redraws screen areas when the underlying
6674 buffer contents change, you may need to call `redraw-display' after
6675 changing this variable for it to take effect. */);
6676 Vface_remapping_alist = Qnil;
6678 DEFVAR_LISP ("face-font-rescale-alist", Vface_font_rescale_alist,
6679 doc: /* Alist of fonts vs the rescaling factors.
6680 Each element is a cons (FONT-PATTERN . RESCALE-RATIO), where
6681 FONT-PATTERN is a font-spec or a regular expression matching a font name, and
6682 RESCALE-RATIO is a floating point number to specify how much larger
6683 \(or smaller) font we should use. For instance, if a face requests
6684 a font of 10 point, we actually use a font of 10 * RESCALE-RATIO point. */);
6685 Vface_font_rescale_alist = Qnil;
6687 #ifdef HAVE_WINDOW_SYSTEM
6688 defsubr (&Sbitmap_spec_p);
6689 defsubr (&Sx_list_fonts);
6690 defsubr (&Sinternal_face_x_get_resource);
6691 defsubr (&Sx_family_fonts);
6692 #endif