Add support for italic text on ttys.
[emacs.git] / src / xfaces.c
blob772d2646291ad738b40b207f8868b3332047de73
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 */
207 #include <setjmp.h>
209 #include "lisp.h"
210 #include "character.h"
211 #include "charset.h"
212 #include "keyboard.h"
213 #include "frame.h"
214 #include "termhooks.h"
216 #ifdef HAVE_X_WINDOWS
217 #include "xterm.h"
218 #ifdef USE_MOTIF
219 #include <Xm/Xm.h>
220 #include <Xm/XmStrDefs.h>
221 #endif /* USE_MOTIF */
222 #endif /* HAVE_X_WINDOWS */
224 #ifdef MSDOS
225 #include "dosfns.h"
226 #endif
228 #ifdef WINDOWSNT
229 #include "w32term.h"
230 #include "fontset.h"
231 /* Redefine X specifics to W32 equivalents to avoid cluttering the
232 code with #ifdef blocks. */
233 #undef FRAME_X_DISPLAY_INFO
234 #define FRAME_X_DISPLAY_INFO FRAME_W32_DISPLAY_INFO
235 #define x_display_info w32_display_info
236 #define FRAME_X_FONT_TABLE FRAME_W32_FONT_TABLE
237 #define check_x check_w32
238 #define GCGraphicsExposures 0
239 #endif /* WINDOWSNT */
241 #ifdef HAVE_NS
242 #include "nsterm.h"
243 #undef FRAME_X_DISPLAY_INFO
244 #define FRAME_X_DISPLAY_INFO FRAME_NS_DISPLAY_INFO
245 #define x_display_info ns_display_info
246 #define FRAME_X_FONT_TABLE FRAME_NS_FONT_TABLE
247 #define check_x check_ns
248 #define GCGraphicsExposures 0
249 #endif /* HAVE_NS */
251 #include "buffer.h"
252 #include "dispextern.h"
253 #include "blockinput.h"
254 #include "window.h"
255 #include "intervals.h"
256 #include "termchar.h"
258 #include "font.h"
259 #ifdef HAVE_WINDOW_SYSTEM
260 #include "fontset.h"
261 #endif /* HAVE_WINDOW_SYSTEM */
263 #ifdef HAVE_X_WINDOWS
265 /* Compensate for a bug in Xos.h on some systems, on which it requires
266 time.h. On some such systems, Xos.h tries to redefine struct
267 timeval and struct timezone if USG is #defined while it is
268 #included. */
270 #ifdef XOS_NEEDS_TIME_H
271 #include <time.h>
272 #undef USG
273 #include <X11/Xos.h>
274 #define USG
275 #define __TIMEVAL__
276 #if defined USG || defined __TIMEVAL__ /* Don't warn about unused macros. */
277 #endif
278 #else /* not XOS_NEEDS_TIME_H */
279 #include <X11/Xos.h>
280 #endif /* not XOS_NEEDS_TIME_H */
282 #endif /* HAVE_X_WINDOWS */
284 #include <ctype.h>
286 /* Number of pt per inch (from the TeXbook). */
288 #define PT_PER_INCH 72.27
290 /* Non-zero if face attribute ATTR is unspecified. */
292 #define UNSPECIFIEDP(ATTR) EQ ((ATTR), Qunspecified)
294 /* Non-zero if face attribute ATTR is `ignore-defface'. */
296 #define IGNORE_DEFFACE_P(ATTR) EQ ((ATTR), QCignore_defface)
298 /* Value is the number of elements of VECTOR. */
300 #define DIM(VECTOR) (sizeof (VECTOR) / sizeof *(VECTOR))
302 /* Size of hash table of realized faces in face caches (should be a
303 prime number). */
305 #define FACE_CACHE_BUCKETS_SIZE 1001
307 /* Keyword symbols used for face attribute names. */
309 Lisp_Object QCfamily, QCheight, QCweight, QCslant;
310 static Lisp_Object QCunderline;
311 static Lisp_Object QCinverse_video, QCstipple;
312 Lisp_Object QCforeground, QCbackground;
313 Lisp_Object QCwidth;
314 static Lisp_Object QCfont, QCbold, QCitalic;
315 static Lisp_Object QCreverse_video;
316 static Lisp_Object QCoverline, QCstrike_through, QCbox, QCinherit;
317 static Lisp_Object QCfontset;
319 /* Symbols used for attribute values. */
321 Lisp_Object Qnormal;
322 Lisp_Object Qbold;
323 static Lisp_Object Qultra_light, Qextra_light, Qlight;
324 static Lisp_Object Qsemi_light, Qsemi_bold, Qextra_bold, Qultra_bold;
325 static Lisp_Object Qoblique, Qreverse_oblique, Qreverse_italic;
326 Lisp_Object Qitalic;
327 static Lisp_Object Qultra_condensed, Qextra_condensed;
328 Lisp_Object Qcondensed;
329 static Lisp_Object Qsemi_condensed, Qsemi_expanded, Qextra_expanded;
330 Lisp_Object Qexpanded;
331 static Lisp_Object Qultra_expanded;
332 static Lisp_Object Qreleased_button, Qpressed_button;
333 static Lisp_Object QCstyle, QCcolor, QCline_width;
334 Lisp_Object Qunspecified; /* used in dosfns.c */
335 static Lisp_Object QCignore_defface;
337 char unspecified_fg[] = "unspecified-fg", unspecified_bg[] = "unspecified-bg";
339 /* The name of the function to call when the background of the frame
340 has changed, frame_set_background_mode. */
342 static Lisp_Object Qframe_set_background_mode;
344 /* Names of basic faces. */
346 Lisp_Object Qdefault, Qtool_bar, Qfringe;
347 static Lisp_Object Qregion;
348 Lisp_Object Qheader_line, Qscroll_bar, Qcursor;
349 static Lisp_Object Qborder, Qmouse, Qmenu;
350 Lisp_Object Qmode_line_inactive;
351 static Lisp_Object Qvertical_border;
353 /* The symbol `face-alias'. A symbols having that property is an
354 alias for another face. Value of the property is the name of
355 the aliased face. */
357 static Lisp_Object Qface_alias;
359 /* Alist of alternative font families. Each element is of the form
360 (FAMILY FAMILY1 FAMILY2 ...). If fonts of FAMILY can't be loaded,
361 try FAMILY1, then FAMILY2, ... */
363 Lisp_Object Vface_alternative_font_family_alist;
365 /* Alist of alternative font registries. Each element is of the form
366 (REGISTRY REGISTRY1 REGISTRY2...). If fonts of REGISTRY can't be
367 loaded, try REGISTRY1, then REGISTRY2, ... */
369 Lisp_Object Vface_alternative_font_registry_alist;
371 /* Allowed scalable fonts. A value of nil means don't allow any
372 scalable fonts. A value of t means allow the use of any scalable
373 font. Otherwise, value must be a list of regular expressions. A
374 font may be scaled if its name matches a regular expression in the
375 list. */
377 static Lisp_Object Qscalable_fonts_allowed;
379 #define DEFAULT_FONT_LIST_LIMIT 100
381 /* The symbols `foreground-color' and `background-color' which can be
382 used as part of a `face' property. This is for compatibility with
383 Emacs 20.2. */
385 Lisp_Object Qforeground_color, Qbackground_color;
387 /* The symbols `face' and `mouse-face' used as text properties. */
389 Lisp_Object Qface;
391 /* Property for basic faces which other faces cannot inherit. */
393 static Lisp_Object Qface_no_inherit;
395 /* Error symbol for wrong_type_argument in load_pixmap. */
397 static Lisp_Object Qbitmap_spec_p;
399 /* The next ID to assign to Lisp faces. */
401 static int next_lface_id;
403 /* A vector mapping Lisp face Id's to face names. */
405 static Lisp_Object *lface_id_to_name;
406 static ptrdiff_t lface_id_to_name_size;
408 /* TTY color-related functions (defined in tty-colors.el). */
410 static Lisp_Object Qtty_color_desc, Qtty_color_by_index, Qtty_color_standard_values;
412 /* The name of the function used to compute colors on TTYs. */
414 static Lisp_Object Qtty_color_alist;
416 /* Counter for calls to clear_face_cache. If this counter reaches
417 CLEAR_FONT_TABLE_COUNT, and a frame has more than
418 CLEAR_FONT_TABLE_NFONTS load, unused fonts are freed. */
420 static int clear_font_table_count;
421 #define CLEAR_FONT_TABLE_COUNT 100
422 #define CLEAR_FONT_TABLE_NFONTS 10
424 /* Non-zero means face attributes have been changed since the last
425 redisplay. Used in redisplay_internal. */
427 int face_change_count;
429 /* Non-zero means don't display bold text if a face's foreground
430 and background colors are the inverse of the default colors of the
431 display. This is a kluge to suppress `bold black' foreground text
432 which is hard to read on an LCD monitor. */
434 static int tty_suppress_bold_inverse_default_colors_p;
436 /* A list of the form `((x . y))' used to avoid consing in
437 Finternal_set_lisp_face_attribute. */
439 static Lisp_Object Vparam_value_alist;
441 /* The total number of colors currently allocated. */
443 #if GLYPH_DEBUG
444 static int ncolors_allocated;
445 static int npixmaps_allocated;
446 static int ngcs;
447 #endif
449 /* Non-zero means the definition of the `menu' face for new frames has
450 been changed. */
452 static int menu_face_changed_default;
455 /* Function prototypes. */
457 struct table_entry;
458 struct named_merge_point;
460 static void map_tty_color (struct frame *, struct face *,
461 enum lface_attribute_index, int *);
462 static Lisp_Object resolve_face_name (Lisp_Object, int);
463 static void set_font_frame_param (Lisp_Object, Lisp_Object);
464 static int get_lface_attributes (struct frame *, Lisp_Object, Lisp_Object *,
465 int, struct named_merge_point *);
466 static ptrdiff_t load_pixmap (struct frame *, Lisp_Object,
467 unsigned *, unsigned *);
468 static struct frame *frame_or_selected_frame (Lisp_Object, int);
469 static void load_face_colors (struct frame *, struct face *, Lisp_Object *);
470 static void free_face_colors (struct frame *, struct face *);
471 static int face_color_gray_p (struct frame *, const char *);
472 static struct face *realize_face (struct face_cache *, Lisp_Object *,
473 int);
474 static struct face *realize_non_ascii_face (struct frame *, Lisp_Object,
475 struct face *);
476 static struct face *realize_x_face (struct face_cache *, Lisp_Object *);
477 static struct face *realize_tty_face (struct face_cache *, Lisp_Object *);
478 static int realize_basic_faces (struct frame *);
479 static int realize_default_face (struct frame *);
480 static void realize_named_face (struct frame *, Lisp_Object, int);
481 static int lface_fully_specified_p (Lisp_Object *);
482 static int lface_equal_p (Lisp_Object *, Lisp_Object *);
483 static unsigned hash_string_case_insensitive (Lisp_Object);
484 static unsigned lface_hash (Lisp_Object *);
485 static int lface_same_font_attributes_p (Lisp_Object *, Lisp_Object *);
486 static struct face_cache *make_face_cache (struct frame *);
487 static void clear_face_gcs (struct face_cache *);
488 static void free_face_cache (struct face_cache *);
489 static int face_fontset (Lisp_Object *);
490 static void merge_face_vectors (struct frame *, Lisp_Object *, Lisp_Object*,
491 struct named_merge_point *);
492 static int merge_face_ref (struct frame *, Lisp_Object, Lisp_Object *,
493 int, struct named_merge_point *);
494 static int set_lface_from_font (struct frame *, Lisp_Object, Lisp_Object,
495 int);
496 static Lisp_Object lface_from_face_name (struct frame *, Lisp_Object, int);
497 static struct face *make_realized_face (Lisp_Object *);
498 static void cache_face (struct face_cache *, struct face *, unsigned);
499 static void uncache_face (struct face_cache *, struct face *);
501 #ifdef HAVE_WINDOW_SYSTEM
503 static GC x_create_gc (struct frame *, unsigned long, XGCValues *);
504 static void x_free_gc (struct frame *, GC);
506 #ifdef USE_X_TOOLKIT
507 static void x_update_menu_appearance (struct frame *);
509 extern void free_frame_menubar (struct frame *);
510 #endif /* USE_X_TOOLKIT */
512 #endif /* HAVE_WINDOW_SYSTEM */
515 /***********************************************************************
516 Utilities
517 ***********************************************************************/
519 #ifdef HAVE_X_WINDOWS
521 #ifdef DEBUG_X_COLORS
523 /* The following is a poor mans infrastructure for debugging X color
524 allocation problems on displays with PseudoColor-8. Some X servers
525 like 3.3.5 XF86_SVGA with Matrox cards apparently don't implement
526 color reference counts completely so that they don't signal an
527 error when a color is freed whose reference count is already 0.
528 Other X servers do. To help me debug this, the following code
529 implements a simple reference counting schema of its own, for a
530 single display/screen. --gerd. */
532 /* Reference counts for pixel colors. */
534 int color_count[256];
536 /* Register color PIXEL as allocated. */
538 void
539 register_color (unsigned long pixel)
541 xassert (pixel < 256);
542 ++color_count[pixel];
546 /* Register color PIXEL as deallocated. */
548 void
549 unregister_color (unsigned long pixel)
551 xassert (pixel < 256);
552 if (color_count[pixel] > 0)
553 --color_count[pixel];
554 else
555 abort ();
559 /* Register N colors from PIXELS as deallocated. */
561 void
562 unregister_colors (unsigned long *pixels, int n)
564 int i;
565 for (i = 0; i < n; ++i)
566 unregister_color (pixels[i]);
570 DEFUN ("dump-colors", Fdump_colors, Sdump_colors, 0, 0, 0,
571 doc: /* Dump currently allocated colors to stderr. */)
572 (void)
574 int i, n;
576 fputc ('\n', stderr);
578 for (i = n = 0; i < sizeof color_count / sizeof color_count[0]; ++i)
579 if (color_count[i])
581 fprintf (stderr, "%3d: %5d", i, color_count[i]);
582 ++n;
583 if (n % 5 == 0)
584 fputc ('\n', stderr);
585 else
586 fputc ('\t', stderr);
589 if (n % 5 != 0)
590 fputc ('\n', stderr);
591 return Qnil;
594 #endif /* DEBUG_X_COLORS */
597 /* Free colors used on frame F. PIXELS is an array of NPIXELS pixel
598 color values. Interrupt input must be blocked when this function
599 is called. */
601 void
602 x_free_colors (struct frame *f, long unsigned int *pixels, int npixels)
604 int class = FRAME_X_DISPLAY_INFO (f)->visual->class;
606 /* If display has an immutable color map, freeing colors is not
607 necessary and some servers don't allow it. So don't do it. */
608 if (class != StaticColor && class != StaticGray && class != TrueColor)
610 #ifdef DEBUG_X_COLORS
611 unregister_colors (pixels, npixels);
612 #endif
613 XFreeColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
614 pixels, npixels, 0);
619 #ifdef USE_X_TOOLKIT
621 /* Free colors used on frame F. PIXELS is an array of NPIXELS pixel
622 color values. Interrupt input must be blocked when this function
623 is called. */
625 void
626 x_free_dpy_colors (Display *dpy, Screen *screen, Colormap cmap,
627 long unsigned int *pixels, int npixels)
629 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
630 int class = dpyinfo->visual->class;
632 /* If display has an immutable color map, freeing colors is not
633 necessary and some servers don't allow it. So don't do it. */
634 if (class != StaticColor && class != StaticGray && class != TrueColor)
636 #ifdef DEBUG_X_COLORS
637 unregister_colors (pixels, npixels);
638 #endif
639 XFreeColors (dpy, cmap, pixels, npixels, 0);
642 #endif /* USE_X_TOOLKIT */
644 /* Create and return a GC for use on frame F. GC values and mask
645 are given by XGCV and MASK. */
647 static inline GC
648 x_create_gc (struct frame *f, long unsigned int mask, XGCValues *xgcv)
650 GC gc;
651 BLOCK_INPUT;
652 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), mask, xgcv);
653 UNBLOCK_INPUT;
654 IF_DEBUG (++ngcs);
655 return gc;
659 /* Free GC which was used on frame F. */
661 static inline void
662 x_free_gc (struct frame *f, GC gc)
664 eassert (interrupt_input_blocked);
665 IF_DEBUG (xassert (--ngcs >= 0));
666 XFreeGC (FRAME_X_DISPLAY (f), gc);
669 #endif /* HAVE_X_WINDOWS */
671 #ifdef WINDOWSNT
672 /* W32 emulation of GCs */
674 static inline GC
675 x_create_gc (struct frame *f, unsigned long mask, XGCValues *xgcv)
677 GC gc;
678 BLOCK_INPUT;
679 gc = XCreateGC (NULL, FRAME_W32_WINDOW (f), mask, xgcv);
680 UNBLOCK_INPUT;
681 IF_DEBUG (++ngcs);
682 return gc;
686 /* Free GC which was used on frame F. */
688 static inline void
689 x_free_gc (struct frame *f, GC gc)
691 IF_DEBUG (xassert (--ngcs >= 0));
692 xfree (gc);
695 #endif /* WINDOWSNT */
697 #ifdef HAVE_NS
698 /* NS emulation of GCs */
700 static inline GC
701 x_create_gc (struct frame *f,
702 unsigned long mask,
703 XGCValues *xgcv)
705 GC gc = xmalloc (sizeof (*gc));
706 if (gc)
707 memcpy (gc, xgcv, sizeof (XGCValues));
708 return gc;
711 static inline void
712 x_free_gc (struct frame *f, GC gc)
714 xfree (gc);
716 #endif /* HAVE_NS */
718 /* Like strcasecmp/stricmp. Used to compare parts of font names which
719 are in ISO8859-1. */
722 xstrcasecmp (const char *s1, const char *s2)
724 while (*s1 && *s2)
726 unsigned char b1 = *s1;
727 unsigned char b2 = *s2;
728 unsigned char c1 = tolower (b1);
729 unsigned char c2 = tolower (b2);
730 if (c1 != c2)
731 return c1 < c2 ? -1 : 1;
732 ++s1, ++s2;
735 if (*s1 == 0)
736 return *s2 == 0 ? 0 : -1;
737 return 1;
741 /* If FRAME is nil, return a pointer to the selected frame.
742 Otherwise, check that FRAME is a live frame, and return a pointer
743 to it. NPARAM is the parameter number of FRAME, for
744 CHECK_LIVE_FRAME. This is here because it's a frequent pattern in
745 Lisp function definitions. */
747 static inline struct frame *
748 frame_or_selected_frame (Lisp_Object frame, int nparam)
750 if (NILP (frame))
751 frame = selected_frame;
753 CHECK_LIVE_FRAME (frame);
754 return XFRAME (frame);
758 /***********************************************************************
759 Frames and faces
760 ***********************************************************************/
762 /* Initialize face cache and basic faces for frame F. */
764 void
765 init_frame_faces (struct frame *f)
767 /* Make a face cache, if F doesn't have one. */
768 if (FRAME_FACE_CACHE (f) == NULL)
769 FRAME_FACE_CACHE (f) = make_face_cache (f);
771 #ifdef HAVE_WINDOW_SYSTEM
772 /* Make the image cache. */
773 if (FRAME_WINDOW_P (f))
775 /* We initialize the image cache when creating the first frame
776 on a terminal, and not during terminal creation. This way,
777 `x-open-connection' on a tty won't create an image cache. */
778 if (FRAME_IMAGE_CACHE (f) == NULL)
779 FRAME_IMAGE_CACHE (f) = make_image_cache ();
780 ++FRAME_IMAGE_CACHE (f)->refcount;
782 #endif /* HAVE_WINDOW_SYSTEM */
784 /* Realize basic faces. Must have enough information in frame
785 parameters to realize basic faces at this point. */
786 #ifdef HAVE_X_WINDOWS
787 if (!FRAME_X_P (f) || FRAME_X_WINDOW (f))
788 #endif
789 #ifdef WINDOWSNT
790 if (!FRAME_WINDOW_P (f) || FRAME_W32_WINDOW (f))
791 #endif
792 #ifdef HAVE_NS
793 if (!FRAME_NS_P (f) || FRAME_NS_WINDOW (f))
794 #endif
795 if (!realize_basic_faces (f))
796 abort ();
800 /* Free face cache of frame F. Called from delete_frame. */
802 void
803 free_frame_faces (struct frame *f)
805 struct face_cache *face_cache = FRAME_FACE_CACHE (f);
807 if (face_cache)
809 free_face_cache (face_cache);
810 FRAME_FACE_CACHE (f) = NULL;
813 #ifdef HAVE_WINDOW_SYSTEM
814 if (FRAME_WINDOW_P (f))
816 struct image_cache *image_cache = FRAME_IMAGE_CACHE (f);
817 if (image_cache)
819 --image_cache->refcount;
820 if (image_cache->refcount == 0)
821 free_image_cache (f);
824 #endif /* HAVE_WINDOW_SYSTEM */
828 /* Clear face caches, and recompute basic faces for frame F. Call
829 this after changing frame parameters on which those faces depend,
830 or when realized faces have been freed due to changing attributes
831 of named faces. */
833 void
834 recompute_basic_faces (struct frame *f)
836 if (FRAME_FACE_CACHE (f))
838 clear_face_cache (0);
839 if (!realize_basic_faces (f))
840 abort ();
845 /* Clear the face caches of all frames. CLEAR_FONTS_P non-zero means
846 try to free unused fonts, too. */
848 void
849 clear_face_cache (int clear_fonts_p)
851 #ifdef HAVE_WINDOW_SYSTEM
852 Lisp_Object tail, frame;
854 if (clear_fonts_p
855 || ++clear_font_table_count == CLEAR_FONT_TABLE_COUNT)
857 #if 0
858 /* Not yet implemented. */
859 clear_font_cache (frame);
860 #endif
862 /* From time to time see if we can unload some fonts. This also
863 frees all realized faces on all frames. Fonts needed by
864 faces will be loaded again when faces are realized again. */
865 clear_font_table_count = 0;
867 FOR_EACH_FRAME (tail, frame)
869 struct frame *f = XFRAME (frame);
870 if (FRAME_WINDOW_P (f)
871 && FRAME_X_DISPLAY_INFO (f)->n_fonts > CLEAR_FONT_TABLE_NFONTS)
872 free_all_realized_faces (frame);
875 else
877 /* Clear GCs of realized faces. */
878 FOR_EACH_FRAME (tail, frame)
880 struct frame *f = XFRAME (frame);
881 if (FRAME_WINDOW_P (f))
882 clear_face_gcs (FRAME_FACE_CACHE (f));
884 clear_image_caches (Qnil);
886 #endif /* HAVE_WINDOW_SYSTEM */
890 DEFUN ("clear-face-cache", Fclear_face_cache, Sclear_face_cache, 0, 1, 0,
891 doc: /* Clear face caches on all frames.
892 Optional THOROUGHLY non-nil means try to free unused fonts, too. */)
893 (Lisp_Object thoroughly)
895 clear_face_cache (!NILP (thoroughly));
896 ++face_change_count;
897 ++windows_or_buffers_changed;
898 return Qnil;
902 /***********************************************************************
903 X Pixmaps
904 ***********************************************************************/
906 #ifdef HAVE_WINDOW_SYSTEM
908 DEFUN ("bitmap-spec-p", Fbitmap_spec_p, Sbitmap_spec_p, 1, 1, 0,
909 doc: /* Value is non-nil if OBJECT is a valid bitmap specification.
910 A bitmap specification is either a string, a file name, or a list
911 \(WIDTH HEIGHT DATA) where WIDTH is the pixel width of the bitmap,
912 HEIGHT is its height, and DATA is a string containing the bits of
913 the pixmap. Bits are stored row by row, each row occupies
914 \(WIDTH + 7)/8 bytes. */)
915 (Lisp_Object object)
917 int pixmap_p = 0;
919 if (STRINGP (object))
920 /* If OBJECT is a string, it's a file name. */
921 pixmap_p = 1;
922 else if (CONSP (object))
924 /* Otherwise OBJECT must be (WIDTH HEIGHT DATA), WIDTH and
925 HEIGHT must be ints > 0, and DATA must be string large
926 enough to hold a bitmap of the specified size. */
927 Lisp_Object width, height, data;
929 height = width = data = Qnil;
931 if (CONSP (object))
933 width = XCAR (object);
934 object = XCDR (object);
935 if (CONSP (object))
937 height = XCAR (object);
938 object = XCDR (object);
939 if (CONSP (object))
940 data = XCAR (object);
944 if (STRINGP (data)
945 && RANGED_INTEGERP (1, width, INT_MAX)
946 && RANGED_INTEGERP (1, height, INT_MAX))
948 int bytes_per_row = ((XINT (width) + BITS_PER_CHAR - 1)
949 / BITS_PER_CHAR);
950 if (XINT (height) <= SBYTES (data) / bytes_per_row)
951 pixmap_p = 1;
955 return pixmap_p ? Qt : Qnil;
959 /* Load a bitmap according to NAME (which is either a file name or a
960 pixmap spec) for use on frame F. Value is the bitmap_id (see
961 xfns.c). If NAME is nil, return with a bitmap id of zero. If
962 bitmap cannot be loaded, display a message saying so, and return
963 zero. Store the bitmap width in *W_PTR and its height in *H_PTR,
964 if these pointers are not null. */
966 static ptrdiff_t
967 load_pixmap (FRAME_PTR f, Lisp_Object name, unsigned int *w_ptr,
968 unsigned int *h_ptr)
970 ptrdiff_t bitmap_id;
972 if (NILP (name))
973 return 0;
975 CHECK_TYPE (!NILP (Fbitmap_spec_p (name)), Qbitmap_spec_p, name);
977 BLOCK_INPUT;
978 if (CONSP (name))
980 /* Decode a bitmap spec into a bitmap. */
982 int h, w;
983 Lisp_Object bits;
985 w = XINT (Fcar (name));
986 h = XINT (Fcar (Fcdr (name)));
987 bits = Fcar (Fcdr (Fcdr (name)));
989 bitmap_id = x_create_bitmap_from_data (f, SSDATA (bits),
990 w, h);
992 else
994 /* It must be a string -- a file name. */
995 bitmap_id = x_create_bitmap_from_file (f, name);
997 UNBLOCK_INPUT;
999 if (bitmap_id < 0)
1001 add_to_log ("Invalid or undefined bitmap `%s'", name, Qnil);
1002 bitmap_id = 0;
1004 if (w_ptr)
1005 *w_ptr = 0;
1006 if (h_ptr)
1007 *h_ptr = 0;
1009 else
1011 #if GLYPH_DEBUG
1012 ++npixmaps_allocated;
1013 #endif
1014 if (w_ptr)
1015 *w_ptr = x_bitmap_width (f, bitmap_id);
1017 if (h_ptr)
1018 *h_ptr = x_bitmap_height (f, bitmap_id);
1021 return bitmap_id;
1024 #endif /* HAVE_WINDOW_SYSTEM */
1028 /***********************************************************************
1029 X Colors
1030 ***********************************************************************/
1032 /* Parse RGB_LIST, and fill in the RGB fields of COLOR.
1033 RGB_LIST should contain (at least) 3 lisp integers.
1034 Return 0 if there's a problem with RGB_LIST, otherwise return 1. */
1036 static int
1037 parse_rgb_list (Lisp_Object rgb_list, XColor *color)
1039 #define PARSE_RGB_LIST_FIELD(field) \
1040 if (CONSP (rgb_list) && INTEGERP (XCAR (rgb_list))) \
1042 color->field = XINT (XCAR (rgb_list)); \
1043 rgb_list = XCDR (rgb_list); \
1045 else \
1046 return 0;
1048 PARSE_RGB_LIST_FIELD (red);
1049 PARSE_RGB_LIST_FIELD (green);
1050 PARSE_RGB_LIST_FIELD (blue);
1052 return 1;
1056 /* Lookup on frame F the color described by the lisp string COLOR.
1057 The resulting tty color is returned in TTY_COLOR; if STD_COLOR is
1058 non-zero, then the `standard' definition of the same color is
1059 returned in it. */
1061 static int
1062 tty_lookup_color (struct frame *f, Lisp_Object color, XColor *tty_color,
1063 XColor *std_color)
1065 Lisp_Object frame, color_desc;
1067 if (!STRINGP (color) || NILP (Ffboundp (Qtty_color_desc)))
1068 return 0;
1070 XSETFRAME (frame, f);
1072 color_desc = call2 (Qtty_color_desc, color, frame);
1073 if (CONSP (color_desc) && CONSP (XCDR (color_desc)))
1075 Lisp_Object rgb;
1077 if (! INTEGERP (XCAR (XCDR (color_desc))))
1078 return 0;
1080 tty_color->pixel = XINT (XCAR (XCDR (color_desc)));
1082 rgb = XCDR (XCDR (color_desc));
1083 if (! parse_rgb_list (rgb, tty_color))
1084 return 0;
1086 /* Should we fill in STD_COLOR too? */
1087 if (std_color)
1089 /* Default STD_COLOR to the same as TTY_COLOR. */
1090 *std_color = *tty_color;
1092 /* Do a quick check to see if the returned descriptor is
1093 actually _exactly_ equal to COLOR, otherwise we have to
1094 lookup STD_COLOR separately. If it's impossible to lookup
1095 a standard color, we just give up and use TTY_COLOR. */
1096 if ((!STRINGP (XCAR (color_desc))
1097 || NILP (Fstring_equal (color, XCAR (color_desc))))
1098 && !NILP (Ffboundp (Qtty_color_standard_values)))
1100 /* Look up STD_COLOR separately. */
1101 rgb = call1 (Qtty_color_standard_values, color);
1102 if (! parse_rgb_list (rgb, std_color))
1103 return 0;
1107 return 1;
1109 else if (NILP (Fsymbol_value (intern ("tty-defined-color-alist"))))
1110 /* We were called early during startup, and the colors are not
1111 yet set up in tty-defined-color-alist. Don't return a failure
1112 indication, since this produces the annoying "Unable to
1113 load color" messages in the *Messages* buffer. */
1114 return 1;
1115 else
1116 /* tty-color-desc seems to have returned a bad value. */
1117 return 0;
1120 /* A version of defined_color for non-X frames. */
1122 static int
1123 tty_defined_color (struct frame *f, const char *color_name,
1124 XColor *color_def, int alloc)
1126 int status = 1;
1128 /* Defaults. */
1129 color_def->pixel = FACE_TTY_DEFAULT_COLOR;
1130 color_def->red = 0;
1131 color_def->blue = 0;
1132 color_def->green = 0;
1134 if (*color_name)
1135 status = tty_lookup_color (f, build_string (color_name), color_def, NULL);
1137 if (color_def->pixel == FACE_TTY_DEFAULT_COLOR && *color_name)
1139 if (strcmp (color_name, "unspecified-fg") == 0)
1140 color_def->pixel = FACE_TTY_DEFAULT_FG_COLOR;
1141 else if (strcmp (color_name, "unspecified-bg") == 0)
1142 color_def->pixel = FACE_TTY_DEFAULT_BG_COLOR;
1145 if (color_def->pixel != FACE_TTY_DEFAULT_COLOR)
1146 status = 1;
1148 return status;
1152 /* Decide if color named COLOR_NAME is valid for the display
1153 associated with the frame F; if so, return the rgb values in
1154 COLOR_DEF. If ALLOC is nonzero, allocate a new colormap cell.
1156 This does the right thing for any type of frame. */
1158 static int
1159 defined_color (struct frame *f, const char *color_name, XColor *color_def,
1160 int alloc)
1162 if (!FRAME_WINDOW_P (f))
1163 return tty_defined_color (f, color_name, color_def, alloc);
1164 #ifdef HAVE_X_WINDOWS
1165 else if (FRAME_X_P (f))
1166 return x_defined_color (f, color_name, color_def, alloc);
1167 #endif
1168 #ifdef WINDOWSNT
1169 else if (FRAME_W32_P (f))
1170 return w32_defined_color (f, color_name, color_def, alloc);
1171 #endif
1172 #ifdef HAVE_NS
1173 else if (FRAME_NS_P (f))
1174 return ns_defined_color (f, color_name, color_def, alloc, 1);
1175 #endif
1176 else
1177 abort ();
1181 /* Given the index IDX of a tty color on frame F, return its name, a
1182 Lisp string. */
1184 Lisp_Object
1185 tty_color_name (struct frame *f, int idx)
1187 if (idx >= 0 && !NILP (Ffboundp (Qtty_color_by_index)))
1189 Lisp_Object frame;
1190 Lisp_Object coldesc;
1192 XSETFRAME (frame, f);
1193 coldesc = call2 (Qtty_color_by_index, make_number (idx), frame);
1195 if (!NILP (coldesc))
1196 return XCAR (coldesc);
1198 #ifdef MSDOS
1199 /* We can have an MSDOG frame under -nw for a short window of
1200 opportunity before internal_terminal_init is called. DTRT. */
1201 if (FRAME_MSDOS_P (f) && !inhibit_window_system)
1202 return msdos_stdcolor_name (idx);
1203 #endif
1205 if (idx == FACE_TTY_DEFAULT_FG_COLOR)
1206 return build_string (unspecified_fg);
1207 if (idx == FACE_TTY_DEFAULT_BG_COLOR)
1208 return build_string (unspecified_bg);
1210 return Qunspecified;
1214 /* Return non-zero if COLOR_NAME is a shade of gray (or white or
1215 black) on frame F.
1217 The criterion implemented here is not a terribly sophisticated one. */
1219 static int
1220 face_color_gray_p (struct frame *f, const char *color_name)
1222 XColor color;
1223 int gray_p;
1225 if (defined_color (f, color_name, &color, 0))
1226 gray_p = (/* Any color sufficiently close to black counts as gray. */
1227 (color.red < 5000 && color.green < 5000 && color.blue < 5000)
1229 ((eabs (color.red - color.green)
1230 < max (color.red, color.green) / 20)
1231 && (eabs (color.green - color.blue)
1232 < max (color.green, color.blue) / 20)
1233 && (eabs (color.blue - color.red)
1234 < max (color.blue, color.red) / 20)));
1235 else
1236 gray_p = 0;
1238 return gray_p;
1242 /* Return non-zero if color COLOR_NAME can be displayed on frame F.
1243 BACKGROUND_P non-zero means the color will be used as background
1244 color. */
1246 static int
1247 face_color_supported_p (struct frame *f, const char *color_name,
1248 int background_p)
1250 Lisp_Object frame;
1251 XColor not_used;
1253 XSETFRAME (frame, f);
1254 return
1255 #ifdef HAVE_WINDOW_SYSTEM
1256 FRAME_WINDOW_P (f)
1257 ? (!NILP (Fxw_display_color_p (frame))
1258 || xstrcasecmp (color_name, "black") == 0
1259 || xstrcasecmp (color_name, "white") == 0
1260 || (background_p
1261 && face_color_gray_p (f, color_name))
1262 || (!NILP (Fx_display_grayscale_p (frame))
1263 && face_color_gray_p (f, color_name)))
1265 #endif
1266 tty_defined_color (f, color_name, &not_used, 0);
1270 DEFUN ("color-gray-p", Fcolor_gray_p, Scolor_gray_p, 1, 2, 0,
1271 doc: /* Return non-nil if COLOR is a shade of gray (or white or black).
1272 FRAME specifies the frame and thus the display for interpreting COLOR.
1273 If FRAME is nil or omitted, use the selected frame. */)
1274 (Lisp_Object color, Lisp_Object frame)
1276 struct frame *f;
1278 CHECK_STRING (color);
1279 if (NILP (frame))
1280 frame = selected_frame;
1281 else
1282 CHECK_FRAME (frame);
1283 f = XFRAME (frame);
1284 return face_color_gray_p (f, SSDATA (color)) ? Qt : Qnil;
1288 DEFUN ("color-supported-p", Fcolor_supported_p,
1289 Scolor_supported_p, 1, 3, 0,
1290 doc: /* Return non-nil if COLOR can be displayed on FRAME.
1291 BACKGROUND-P non-nil means COLOR is used as a background.
1292 Otherwise, this function tells whether it can be used as a foreground.
1293 If FRAME is nil or omitted, use the selected frame.
1294 COLOR must be a valid color name. */)
1295 (Lisp_Object color, Lisp_Object frame, Lisp_Object background_p)
1297 struct frame *f;
1299 CHECK_STRING (color);
1300 if (NILP (frame))
1301 frame = selected_frame;
1302 else
1303 CHECK_FRAME (frame);
1304 f = XFRAME (frame);
1305 if (face_color_supported_p (f, SSDATA (color), !NILP (background_p)))
1306 return Qt;
1307 return Qnil;
1311 /* Load color with name NAME for use by face FACE on frame F.
1312 TARGET_INDEX must be one of LFACE_FOREGROUND_INDEX,
1313 LFACE_BACKGROUND_INDEX, LFACE_UNDERLINE_INDEX, LFACE_OVERLINE_INDEX,
1314 LFACE_STRIKE_THROUGH_INDEX, or LFACE_BOX_INDEX. Value is the
1315 pixel color. If color cannot be loaded, display a message, and
1316 return the foreground, background or underline color of F, but
1317 record that fact in flags of the face so that we don't try to free
1318 these colors. */
1320 unsigned long
1321 load_color (struct frame *f, struct face *face, Lisp_Object name,
1322 enum lface_attribute_index target_index)
1324 XColor color;
1326 xassert (STRINGP (name));
1327 xassert (target_index == LFACE_FOREGROUND_INDEX
1328 || target_index == LFACE_BACKGROUND_INDEX
1329 || target_index == LFACE_UNDERLINE_INDEX
1330 || target_index == LFACE_OVERLINE_INDEX
1331 || target_index == LFACE_STRIKE_THROUGH_INDEX
1332 || target_index == LFACE_BOX_INDEX);
1334 /* if the color map is full, defined_color will return a best match
1335 to the values in an existing cell. */
1336 if (!defined_color (f, SSDATA (name), &color, 1))
1338 add_to_log ("Unable to load color \"%s\"", name, Qnil);
1340 switch (target_index)
1342 case LFACE_FOREGROUND_INDEX:
1343 face->foreground_defaulted_p = 1;
1344 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1345 break;
1347 case LFACE_BACKGROUND_INDEX:
1348 face->background_defaulted_p = 1;
1349 color.pixel = FRAME_BACKGROUND_PIXEL (f);
1350 break;
1352 case LFACE_UNDERLINE_INDEX:
1353 face->underline_defaulted_p = 1;
1354 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1355 break;
1357 case LFACE_OVERLINE_INDEX:
1358 face->overline_color_defaulted_p = 1;
1359 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1360 break;
1362 case LFACE_STRIKE_THROUGH_INDEX:
1363 face->strike_through_color_defaulted_p = 1;
1364 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1365 break;
1367 case LFACE_BOX_INDEX:
1368 face->box_color_defaulted_p = 1;
1369 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1370 break;
1372 default:
1373 abort ();
1376 #if GLYPH_DEBUG
1377 else
1378 ++ncolors_allocated;
1379 #endif
1381 return color.pixel;
1385 #ifdef HAVE_WINDOW_SYSTEM
1387 /* Load colors for face FACE which is used on frame F. Colors are
1388 specified by slots LFACE_BACKGROUND_INDEX and LFACE_FOREGROUND_INDEX
1389 of ATTRS. If the background color specified is not supported on F,
1390 try to emulate gray colors with a stipple from Vface_default_stipple. */
1392 static void
1393 load_face_colors (struct frame *f, struct face *face, Lisp_Object *attrs)
1395 Lisp_Object fg, bg;
1397 bg = attrs[LFACE_BACKGROUND_INDEX];
1398 fg = attrs[LFACE_FOREGROUND_INDEX];
1400 /* Swap colors if face is inverse-video. */
1401 if (EQ (attrs[LFACE_INVERSE_INDEX], Qt))
1403 Lisp_Object tmp;
1404 tmp = fg;
1405 fg = bg;
1406 bg = tmp;
1409 /* Check for support for foreground, not for background because
1410 face_color_supported_p is smart enough to know that grays are
1411 "supported" as background because we are supposed to use stipple
1412 for them. */
1413 if (!face_color_supported_p (f, SSDATA (bg), 0)
1414 && !NILP (Fbitmap_spec_p (Vface_default_stipple)))
1416 x_destroy_bitmap (f, face->stipple);
1417 face->stipple = load_pixmap (f, Vface_default_stipple,
1418 &face->pixmap_w, &face->pixmap_h);
1421 face->background = load_color (f, face, bg, LFACE_BACKGROUND_INDEX);
1422 face->foreground = load_color (f, face, fg, LFACE_FOREGROUND_INDEX);
1426 /* Free color PIXEL on frame F. */
1428 void
1429 unload_color (struct frame *f, long unsigned int pixel)
1431 #ifdef HAVE_X_WINDOWS
1432 if (pixel != -1)
1434 BLOCK_INPUT;
1435 x_free_colors (f, &pixel, 1);
1436 UNBLOCK_INPUT;
1438 #endif
1442 /* Free colors allocated for FACE. */
1444 static void
1445 free_face_colors (struct frame *f, struct face *face)
1447 /* PENDING(NS): need to do something here? */
1448 #ifdef HAVE_X_WINDOWS
1449 if (face->colors_copied_bitwise_p)
1450 return;
1452 BLOCK_INPUT;
1454 if (!face->foreground_defaulted_p)
1456 x_free_colors (f, &face->foreground, 1);
1457 IF_DEBUG (--ncolors_allocated);
1460 if (!face->background_defaulted_p)
1462 x_free_colors (f, &face->background, 1);
1463 IF_DEBUG (--ncolors_allocated);
1466 if (face->underline_p
1467 && !face->underline_defaulted_p)
1469 x_free_colors (f, &face->underline_color, 1);
1470 IF_DEBUG (--ncolors_allocated);
1473 if (face->overline_p
1474 && !face->overline_color_defaulted_p)
1476 x_free_colors (f, &face->overline_color, 1);
1477 IF_DEBUG (--ncolors_allocated);
1480 if (face->strike_through_p
1481 && !face->strike_through_color_defaulted_p)
1483 x_free_colors (f, &face->strike_through_color, 1);
1484 IF_DEBUG (--ncolors_allocated);
1487 if (face->box != FACE_NO_BOX
1488 && !face->box_color_defaulted_p)
1490 x_free_colors (f, &face->box_color, 1);
1491 IF_DEBUG (--ncolors_allocated);
1494 UNBLOCK_INPUT;
1495 #endif /* HAVE_X_WINDOWS */
1498 #endif /* HAVE_WINDOW_SYSTEM */
1502 /***********************************************************************
1503 XLFD Font Names
1504 ***********************************************************************/
1506 /* An enumerator for each field of an XLFD font name. */
1508 enum xlfd_field
1510 XLFD_FOUNDRY,
1511 XLFD_FAMILY,
1512 XLFD_WEIGHT,
1513 XLFD_SLANT,
1514 XLFD_SWIDTH,
1515 XLFD_ADSTYLE,
1516 XLFD_PIXEL_SIZE,
1517 XLFD_POINT_SIZE,
1518 XLFD_RESX,
1519 XLFD_RESY,
1520 XLFD_SPACING,
1521 XLFD_AVGWIDTH,
1522 XLFD_REGISTRY,
1523 XLFD_ENCODING,
1524 XLFD_LAST
1527 /* An enumerator for each possible slant value of a font. Taken from
1528 the XLFD specification. */
1530 enum xlfd_slant
1532 XLFD_SLANT_UNKNOWN,
1533 XLFD_SLANT_ROMAN,
1534 XLFD_SLANT_ITALIC,
1535 XLFD_SLANT_OBLIQUE,
1536 XLFD_SLANT_REVERSE_ITALIC,
1537 XLFD_SLANT_REVERSE_OBLIQUE,
1538 XLFD_SLANT_OTHER
1541 /* Relative font weight according to XLFD documentation. */
1543 enum xlfd_weight
1545 XLFD_WEIGHT_UNKNOWN,
1546 XLFD_WEIGHT_ULTRA_LIGHT, /* 10 */
1547 XLFD_WEIGHT_EXTRA_LIGHT, /* 20 */
1548 XLFD_WEIGHT_LIGHT, /* 30 */
1549 XLFD_WEIGHT_SEMI_LIGHT, /* 40: SemiLight, Book, ... */
1550 XLFD_WEIGHT_MEDIUM, /* 50: Medium, Normal, Regular, ... */
1551 XLFD_WEIGHT_SEMI_BOLD, /* 60: SemiBold, DemiBold, ... */
1552 XLFD_WEIGHT_BOLD, /* 70: Bold, ... */
1553 XLFD_WEIGHT_EXTRA_BOLD, /* 80: ExtraBold, Heavy, ... */
1554 XLFD_WEIGHT_ULTRA_BOLD /* 90: UltraBold, Black, ... */
1557 /* Relative proportionate width. */
1559 enum xlfd_swidth
1561 XLFD_SWIDTH_UNKNOWN,
1562 XLFD_SWIDTH_ULTRA_CONDENSED, /* 10 */
1563 XLFD_SWIDTH_EXTRA_CONDENSED, /* 20 */
1564 XLFD_SWIDTH_CONDENSED, /* 30: Condensed, Narrow, Compressed, ... */
1565 XLFD_SWIDTH_SEMI_CONDENSED, /* 40: semicondensed */
1566 XLFD_SWIDTH_MEDIUM, /* 50: Medium, Normal, Regular, ... */
1567 XLFD_SWIDTH_SEMI_EXPANDED, /* 60: SemiExpanded, DemiExpanded, ... */
1568 XLFD_SWIDTH_EXPANDED, /* 70: Expanded... */
1569 XLFD_SWIDTH_EXTRA_EXPANDED, /* 80: ExtraExpanded, Wide... */
1570 XLFD_SWIDTH_ULTRA_EXPANDED /* 90: UltraExpanded... */
1573 /* Order by which font selection chooses fonts. The default values
1574 mean `first, find a best match for the font width, then for the
1575 font height, then for weight, then for slant.' This variable can be
1576 set via set-face-font-sort-order. */
1578 static int font_sort_order[4];
1580 #ifdef HAVE_WINDOW_SYSTEM
1582 static enum font_property_index font_props_for_sorting[FONT_SIZE_INDEX];
1584 static int
1585 compare_fonts_by_sort_order (const void *v1, const void *v2)
1587 Lisp_Object font1 = *(Lisp_Object *) v1;
1588 Lisp_Object font2 = *(Lisp_Object *) v2;
1589 int i;
1591 for (i = 0; i < FONT_SIZE_INDEX; i++)
1593 enum font_property_index idx = font_props_for_sorting[i];
1594 Lisp_Object val1 = AREF (font1, idx), val2 = AREF (font2, idx);
1595 int result;
1597 if (idx <= FONT_REGISTRY_INDEX)
1599 if (STRINGP (val1))
1600 result = STRINGP (val2) ? strcmp (SSDATA (val1), SSDATA (val2)) : -1;
1601 else
1602 result = STRINGP (val2) ? 1 : 0;
1604 else
1606 if (INTEGERP (val1))
1607 result = (INTEGERP (val2) && XINT (val1) >= XINT (val2)
1608 ? XINT (val1) > XINT (val2)
1609 : -1);
1610 else
1611 result = INTEGERP (val2) ? 1 : 0;
1613 if (result)
1614 return result;
1616 return 0;
1619 DEFUN ("x-family-fonts", Fx_family_fonts, Sx_family_fonts, 0, 2, 0,
1620 doc: /* Return a list of available fonts of family FAMILY on FRAME.
1621 If FAMILY is omitted or nil, list all families.
1622 Otherwise, FAMILY must be a string, possibly containing wildcards
1623 `?' and `*'.
1624 If FRAME is omitted or nil, use the selected frame.
1625 Each element of the result is a vector [FAMILY WIDTH POINT-SIZE WEIGHT
1626 SLANT FIXED-P FULL REGISTRY-AND-ENCODING].
1627 FAMILY is the font family name. POINT-SIZE is the size of the
1628 font in 1/10 pt. WIDTH, WEIGHT, and SLANT are symbols describing the
1629 width, weight and slant of the font. These symbols are the same as for
1630 face attributes. FIXED-P is non-nil if the font is fixed-pitch.
1631 FULL is the full name of the font, and REGISTRY-AND-ENCODING is a string
1632 giving the registry and encoding of the font.
1633 The result list is sorted according to the current setting of
1634 the face font sort order. */)
1635 (Lisp_Object family, Lisp_Object frame)
1637 Lisp_Object font_spec, list, *drivers, vec;
1638 ptrdiff_t i, nfonts;
1639 EMACS_INT ndrivers;
1640 Lisp_Object result;
1641 USE_SAFE_ALLOCA;
1643 if (NILP (frame))
1644 frame = selected_frame;
1645 CHECK_LIVE_FRAME (frame);
1647 font_spec = Ffont_spec (0, NULL);
1648 if (!NILP (family))
1650 CHECK_STRING (family);
1651 font_parse_family_registry (family, Qnil, font_spec);
1654 list = font_list_entities (frame, font_spec);
1655 if (NILP (list))
1656 return Qnil;
1658 /* Sort the font entities. */
1659 for (i = 0; i < 4; i++)
1660 switch (font_sort_order[i])
1662 case XLFD_SWIDTH:
1663 font_props_for_sorting[i] = FONT_WIDTH_INDEX; break;
1664 case XLFD_POINT_SIZE:
1665 font_props_for_sorting[i] = FONT_SIZE_INDEX; break;
1666 case XLFD_WEIGHT:
1667 font_props_for_sorting[i] = FONT_WEIGHT_INDEX; break;
1668 default:
1669 font_props_for_sorting[i] = FONT_SLANT_INDEX; break;
1671 font_props_for_sorting[i++] = FONT_FAMILY_INDEX;
1672 font_props_for_sorting[i++] = FONT_FOUNDRY_INDEX;
1673 font_props_for_sorting[i++] = FONT_ADSTYLE_INDEX;
1674 font_props_for_sorting[i++] = FONT_REGISTRY_INDEX;
1676 ndrivers = XINT (Flength (list));
1677 SAFE_ALLOCA_LISP (drivers, ndrivers);
1678 for (i = 0; i < ndrivers; i++, list = XCDR (list))
1679 drivers[i] = XCAR (list);
1680 vec = Fvconcat (ndrivers, drivers);
1681 nfonts = ASIZE (vec);
1683 qsort (XVECTOR (vec)->contents, nfonts, sizeof (Lisp_Object),
1684 compare_fonts_by_sort_order);
1686 result = Qnil;
1687 for (i = nfonts - 1; i >= 0; --i)
1689 Lisp_Object font = AREF (vec, i);
1690 Lisp_Object v = Fmake_vector (make_number (8), Qnil);
1691 int point;
1692 Lisp_Object spacing;
1694 ASET (v, 0, AREF (font, FONT_FAMILY_INDEX));
1695 ASET (v, 1, FONT_WIDTH_SYMBOLIC (font));
1696 point = PIXEL_TO_POINT (XINT (AREF (font, FONT_SIZE_INDEX)) * 10,
1697 XFRAME (frame)->resy);
1698 ASET (v, 2, make_number (point));
1699 ASET (v, 3, FONT_WEIGHT_SYMBOLIC (font));
1700 ASET (v, 4, FONT_SLANT_SYMBOLIC (font));
1701 spacing = Ffont_get (font, QCspacing);
1702 ASET (v, 5, (NILP (spacing) || EQ (spacing, Qp)) ? Qnil : Qt);
1703 ASET (v, 6, Ffont_xlfd_name (font, Qnil));
1704 ASET (v, 7, AREF (font, FONT_REGISTRY_INDEX));
1706 result = Fcons (v, result);
1709 SAFE_FREE ();
1710 return result;
1713 DEFUN ("x-list-fonts", Fx_list_fonts, Sx_list_fonts, 1, 5, 0,
1714 doc: /* Return a list of the names of available fonts matching PATTERN.
1715 If optional arguments FACE and FRAME are specified, return only fonts
1716 the same size as FACE on FRAME.
1718 PATTERN should be a string containing a font name in the XLFD,
1719 Fontconfig, or GTK format. A font name given in the XLFD format may
1720 contain wildcard characters:
1721 the * character matches any substring, and
1722 the ? character matches any single character.
1723 PATTERN is case-insensitive.
1725 The return value is a list of strings, suitable as arguments to
1726 `set-face-font'.
1728 Fonts Emacs can't use may or may not be excluded
1729 even if they match PATTERN and FACE.
1730 The optional fourth argument MAXIMUM sets a limit on how many
1731 fonts to match. The first MAXIMUM fonts are reported.
1732 The optional fifth argument WIDTH, if specified, is a number of columns
1733 occupied by a character of a font. In that case, return only fonts
1734 the WIDTH times as wide as FACE on FRAME. */)
1735 (Lisp_Object pattern, Lisp_Object face, Lisp_Object frame,
1736 Lisp_Object maximum, Lisp_Object width)
1738 struct frame *f;
1739 int size, avgwidth IF_LINT (= 0);
1741 check_x ();
1742 CHECK_STRING (pattern);
1744 if (! NILP (maximum))
1745 CHECK_NATNUM (maximum);
1747 if (!NILP (width))
1748 CHECK_NUMBER (width);
1750 /* We can't simply call check_x_frame because this function may be
1751 called before any frame is created. */
1752 if (NILP (frame))
1753 frame = selected_frame;
1754 f = frame_or_selected_frame (frame, 2);
1755 if (! FRAME_WINDOW_P (f))
1757 /* Perhaps we have not yet created any frame. */
1758 f = NULL;
1759 frame = Qnil;
1760 face = Qnil;
1763 /* Determine the width standard for comparison with the fonts we find. */
1765 if (NILP (face))
1766 size = 0;
1767 else
1769 /* This is of limited utility since it works with character
1770 widths. Keep it for compatibility. --gerd. */
1771 int face_id = lookup_named_face (f, face, 0);
1772 struct face *width_face = (face_id < 0
1773 ? NULL
1774 : FACE_FROM_ID (f, face_id));
1776 if (width_face && width_face->font)
1778 size = width_face->font->pixel_size;
1779 avgwidth = width_face->font->average_width;
1781 else
1783 size = FRAME_FONT (f)->pixel_size;
1784 avgwidth = FRAME_FONT (f)->average_width;
1786 if (!NILP (width))
1787 avgwidth *= XINT (width);
1791 Lisp_Object font_spec;
1792 Lisp_Object args[2], tail;
1794 font_spec = font_spec_from_name (pattern);
1795 if (!FONTP (font_spec))
1796 signal_error ("Invalid font name", pattern);
1798 if (size)
1800 Ffont_put (font_spec, QCsize, make_number (size));
1801 Ffont_put (font_spec, QCavgwidth, make_number (avgwidth));
1803 args[0] = Flist_fonts (font_spec, frame, maximum, font_spec);
1804 for (tail = args[0]; CONSP (tail); tail = XCDR (tail))
1806 Lisp_Object font_entity;
1808 font_entity = XCAR (tail);
1809 if ((NILP (AREF (font_entity, FONT_SIZE_INDEX))
1810 || XINT (AREF (font_entity, FONT_SIZE_INDEX)) == 0)
1811 && ! NILP (AREF (font_spec, FONT_SIZE_INDEX)))
1813 /* This is a scalable font. For backward compatibility,
1814 we set the specified size. */
1815 font_entity = copy_font_spec (font_entity);
1816 ASET (font_entity, FONT_SIZE_INDEX,
1817 AREF (font_spec, FONT_SIZE_INDEX));
1819 XSETCAR (tail, Ffont_xlfd_name (font_entity, Qnil));
1821 if (NILP (frame))
1822 /* We don't have to check fontsets. */
1823 return args[0];
1824 args[1] = list_fontsets (f, pattern, size);
1825 return Fnconc (2, args);
1829 #endif /* HAVE_WINDOW_SYSTEM */
1832 /***********************************************************************
1833 Lisp Faces
1834 ***********************************************************************/
1836 /* Access face attributes of face LFACE, a Lisp vector. */
1838 #define LFACE_FAMILY(LFACE) AREF ((LFACE), LFACE_FAMILY_INDEX)
1839 #define LFACE_FOUNDRY(LFACE) AREF ((LFACE), LFACE_FOUNDRY_INDEX)
1840 #define LFACE_HEIGHT(LFACE) AREF ((LFACE), LFACE_HEIGHT_INDEX)
1841 #define LFACE_WEIGHT(LFACE) AREF ((LFACE), LFACE_WEIGHT_INDEX)
1842 #define LFACE_SLANT(LFACE) AREF ((LFACE), LFACE_SLANT_INDEX)
1843 #define LFACE_UNDERLINE(LFACE) AREF ((LFACE), LFACE_UNDERLINE_INDEX)
1844 #define LFACE_INVERSE(LFACE) AREF ((LFACE), LFACE_INVERSE_INDEX)
1845 #define LFACE_FOREGROUND(LFACE) AREF ((LFACE), LFACE_FOREGROUND_INDEX)
1846 #define LFACE_BACKGROUND(LFACE) AREF ((LFACE), LFACE_BACKGROUND_INDEX)
1847 #define LFACE_STIPPLE(LFACE) AREF ((LFACE), LFACE_STIPPLE_INDEX)
1848 #define LFACE_SWIDTH(LFACE) AREF ((LFACE), LFACE_SWIDTH_INDEX)
1849 #define LFACE_OVERLINE(LFACE) AREF ((LFACE), LFACE_OVERLINE_INDEX)
1850 #define LFACE_STRIKE_THROUGH(LFACE) AREF ((LFACE), LFACE_STRIKE_THROUGH_INDEX)
1851 #define LFACE_BOX(LFACE) AREF ((LFACE), LFACE_BOX_INDEX)
1852 #define LFACE_FONT(LFACE) AREF ((LFACE), LFACE_FONT_INDEX)
1853 #define LFACE_INHERIT(LFACE) AREF ((LFACE), LFACE_INHERIT_INDEX)
1854 #define LFACE_FONTSET(LFACE) AREF ((LFACE), LFACE_FONTSET_INDEX)
1856 #if XASSERTS
1857 /* Non-zero if LFACE is a Lisp face. A Lisp face is a vector of size
1858 LFACE_VECTOR_SIZE which has the symbol `face' in slot 0. */
1860 #define LFACEP(LFACE) \
1861 (VECTORP (LFACE) \
1862 && ASIZE (LFACE) == LFACE_VECTOR_SIZE \
1863 && EQ (AREF (LFACE, 0), Qface))
1864 #endif
1867 #if GLYPH_DEBUG
1869 /* Check consistency of Lisp face attribute vector ATTRS. */
1871 static void
1872 check_lface_attrs (Lisp_Object *attrs)
1874 xassert (UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
1875 || IGNORE_DEFFACE_P (attrs[LFACE_FAMILY_INDEX])
1876 || STRINGP (attrs[LFACE_FAMILY_INDEX]));
1877 xassert (UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
1878 || IGNORE_DEFFACE_P (attrs[LFACE_FOUNDRY_INDEX])
1879 || STRINGP (attrs[LFACE_FOUNDRY_INDEX]));
1880 xassert (UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
1881 || IGNORE_DEFFACE_P (attrs[LFACE_SWIDTH_INDEX])
1882 || SYMBOLP (attrs[LFACE_SWIDTH_INDEX]));
1883 xassert (UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
1884 || IGNORE_DEFFACE_P (attrs[LFACE_HEIGHT_INDEX])
1885 || INTEGERP (attrs[LFACE_HEIGHT_INDEX])
1886 || FLOATP (attrs[LFACE_HEIGHT_INDEX])
1887 || FUNCTIONP (attrs[LFACE_HEIGHT_INDEX]));
1888 xassert (UNSPECIFIEDP (attrs[LFACE_WEIGHT_INDEX])
1889 || IGNORE_DEFFACE_P (attrs[LFACE_WEIGHT_INDEX])
1890 || SYMBOLP (attrs[LFACE_WEIGHT_INDEX]));
1891 xassert (UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX])
1892 || IGNORE_DEFFACE_P (attrs[LFACE_SLANT_INDEX])
1893 || SYMBOLP (attrs[LFACE_SLANT_INDEX]));
1894 xassert (UNSPECIFIEDP (attrs[LFACE_UNDERLINE_INDEX])
1895 || IGNORE_DEFFACE_P (attrs[LFACE_UNDERLINE_INDEX])
1896 || SYMBOLP (attrs[LFACE_UNDERLINE_INDEX])
1897 || STRINGP (attrs[LFACE_UNDERLINE_INDEX]));
1898 xassert (UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
1899 || IGNORE_DEFFACE_P (attrs[LFACE_OVERLINE_INDEX])
1900 || SYMBOLP (attrs[LFACE_OVERLINE_INDEX])
1901 || STRINGP (attrs[LFACE_OVERLINE_INDEX]));
1902 xassert (UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
1903 || IGNORE_DEFFACE_P (attrs[LFACE_STRIKE_THROUGH_INDEX])
1904 || SYMBOLP (attrs[LFACE_STRIKE_THROUGH_INDEX])
1905 || STRINGP (attrs[LFACE_STRIKE_THROUGH_INDEX]));
1906 xassert (UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
1907 || IGNORE_DEFFACE_P (attrs[LFACE_BOX_INDEX])
1908 || SYMBOLP (attrs[LFACE_BOX_INDEX])
1909 || STRINGP (attrs[LFACE_BOX_INDEX])
1910 || INTEGERP (attrs[LFACE_BOX_INDEX])
1911 || CONSP (attrs[LFACE_BOX_INDEX]));
1912 xassert (UNSPECIFIEDP (attrs[LFACE_INVERSE_INDEX])
1913 || IGNORE_DEFFACE_P (attrs[LFACE_INVERSE_INDEX])
1914 || SYMBOLP (attrs[LFACE_INVERSE_INDEX]));
1915 xassert (UNSPECIFIEDP (attrs[LFACE_FOREGROUND_INDEX])
1916 || IGNORE_DEFFACE_P (attrs[LFACE_FOREGROUND_INDEX])
1917 || STRINGP (attrs[LFACE_FOREGROUND_INDEX]));
1918 xassert (UNSPECIFIEDP (attrs[LFACE_BACKGROUND_INDEX])
1919 || IGNORE_DEFFACE_P (attrs[LFACE_BACKGROUND_INDEX])
1920 || STRINGP (attrs[LFACE_BACKGROUND_INDEX]));
1921 xassert (UNSPECIFIEDP (attrs[LFACE_INHERIT_INDEX])
1922 || IGNORE_DEFFACE_P (attrs[LFACE_INHERIT_INDEX])
1923 || NILP (attrs[LFACE_INHERIT_INDEX])
1924 || SYMBOLP (attrs[LFACE_INHERIT_INDEX])
1925 || CONSP (attrs[LFACE_INHERIT_INDEX]));
1926 #ifdef HAVE_WINDOW_SYSTEM
1927 xassert (UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
1928 || IGNORE_DEFFACE_P (attrs[LFACE_STIPPLE_INDEX])
1929 || SYMBOLP (attrs[LFACE_STIPPLE_INDEX])
1930 || !NILP (Fbitmap_spec_p (attrs[LFACE_STIPPLE_INDEX])));
1931 xassert (UNSPECIFIEDP (attrs[LFACE_FONT_INDEX])
1932 || IGNORE_DEFFACE_P (attrs[LFACE_FONT_INDEX])
1933 || FONTP (attrs[LFACE_FONT_INDEX]));
1934 xassert (UNSPECIFIEDP (attrs[LFACE_FONTSET_INDEX])
1935 || STRINGP (attrs[LFACE_FONTSET_INDEX])
1936 || NILP (attrs[LFACE_FONTSET_INDEX]));
1937 #endif
1941 /* Check consistency of attributes of Lisp face LFACE (a Lisp vector). */
1943 static void
1944 check_lface (Lisp_Object lface)
1946 if (!NILP (lface))
1948 xassert (LFACEP (lface));
1949 check_lface_attrs (XVECTOR (lface)->contents);
1953 #else /* GLYPH_DEBUG == 0 */
1955 #define check_lface_attrs(attrs) (void) 0
1956 #define check_lface(lface) (void) 0
1958 #endif /* GLYPH_DEBUG == 0 */
1962 /* Face-merge cycle checking. */
1964 enum named_merge_point_kind
1966 NAMED_MERGE_POINT_NORMAL,
1967 NAMED_MERGE_POINT_REMAP
1970 /* A `named merge point' is simply a point during face-merging where we
1971 look up a face by name. We keep a stack of which named lookups we're
1972 currently processing so that we can easily detect cycles, using a
1973 linked- list of struct named_merge_point structures, typically
1974 allocated on the stack frame of the named lookup functions which are
1975 active (so no consing is required). */
1976 struct named_merge_point
1978 Lisp_Object face_name;
1979 enum named_merge_point_kind named_merge_point_kind;
1980 struct named_merge_point *prev;
1984 /* If a face merging cycle is detected for FACE_NAME, return 0,
1985 otherwise add NEW_NAMED_MERGE_POINT, which is initialized using
1986 FACE_NAME and NAMED_MERGE_POINT_KIND, as the head of the linked list
1987 pointed to by NAMED_MERGE_POINTS, and return 1. */
1989 static inline int
1990 push_named_merge_point (struct named_merge_point *new_named_merge_point,
1991 Lisp_Object face_name,
1992 enum named_merge_point_kind named_merge_point_kind,
1993 struct named_merge_point **named_merge_points)
1995 struct named_merge_point *prev;
1997 for (prev = *named_merge_points; prev; prev = prev->prev)
1998 if (EQ (face_name, prev->face_name))
2000 if (prev->named_merge_point_kind == named_merge_point_kind)
2001 /* A cycle, so fail. */
2002 return 0;
2003 else if (prev->named_merge_point_kind == NAMED_MERGE_POINT_REMAP)
2004 /* A remap `hides ' any previous normal merge points
2005 (because the remap means that it's actually different face),
2006 so as we know the current merge point must be normal, we
2007 can just assume it's OK. */
2008 break;
2011 new_named_merge_point->face_name = face_name;
2012 new_named_merge_point->named_merge_point_kind = named_merge_point_kind;
2013 new_named_merge_point->prev = *named_merge_points;
2015 *named_merge_points = new_named_merge_point;
2017 return 1;
2021 /* Resolve face name FACE_NAME. If FACE_NAME is a string, intern it
2022 to make it a symbol. If FACE_NAME is an alias for another face,
2023 return that face's name.
2025 Return default face in case of errors. */
2027 static Lisp_Object
2028 resolve_face_name (Lisp_Object face_name, int signal_p)
2030 Lisp_Object orig_face;
2031 Lisp_Object tortoise, hare;
2033 if (STRINGP (face_name))
2034 face_name = intern (SSDATA (face_name));
2036 if (NILP (face_name) || !SYMBOLP (face_name))
2037 return face_name;
2039 orig_face = face_name;
2040 tortoise = hare = face_name;
2042 while (1)
2044 face_name = hare;
2045 hare = Fget (hare, Qface_alias);
2046 if (NILP (hare) || !SYMBOLP (hare))
2047 break;
2049 face_name = hare;
2050 hare = Fget (hare, Qface_alias);
2051 if (NILP (hare) || !SYMBOLP (hare))
2052 break;
2054 tortoise = Fget (tortoise, Qface_alias);
2055 if (EQ (hare, tortoise))
2057 if (signal_p)
2058 xsignal1 (Qcircular_list, orig_face);
2059 return Qdefault;
2063 return face_name;
2067 /* Return the face definition of FACE_NAME on frame F. F null means
2068 return the definition for new frames. FACE_NAME may be a string or
2069 a symbol (apparently Emacs 20.2 allowed strings as face names in
2070 face text properties; Ediff uses that). If SIGNAL_P is non-zero,
2071 signal an error if FACE_NAME is not a valid face name. If SIGNAL_P
2072 is zero, value is nil if FACE_NAME is not a valid face name. */
2073 static inline Lisp_Object
2074 lface_from_face_name_no_resolve (struct frame *f, Lisp_Object face_name,
2075 int signal_p)
2077 Lisp_Object lface;
2079 if (f)
2080 lface = assq_no_quit (face_name, f->face_alist);
2081 else
2082 lface = assq_no_quit (face_name, Vface_new_frame_defaults);
2084 if (CONSP (lface))
2085 lface = XCDR (lface);
2086 else if (signal_p)
2087 signal_error ("Invalid face", face_name);
2089 check_lface (lface);
2091 return lface;
2094 /* Return the face definition of FACE_NAME on frame F. F null means
2095 return the definition for new frames. FACE_NAME may be a string or
2096 a symbol (apparently Emacs 20.2 allowed strings as face names in
2097 face text properties; Ediff uses that). If FACE_NAME is an alias
2098 for another face, return that face's definition. If SIGNAL_P is
2099 non-zero, signal an error if FACE_NAME is not a valid face name.
2100 If SIGNAL_P is zero, value is nil if FACE_NAME is not a valid face
2101 name. */
2102 static inline Lisp_Object
2103 lface_from_face_name (struct frame *f, Lisp_Object face_name, int signal_p)
2105 face_name = resolve_face_name (face_name, signal_p);
2106 return lface_from_face_name_no_resolve (f, face_name, signal_p);
2110 /* Get face attributes of face FACE_NAME from frame-local faces on
2111 frame F. Store the resulting attributes in ATTRS which must point
2112 to a vector of Lisp_Objects of size LFACE_VECTOR_SIZE. If SIGNAL_P
2113 is non-zero, signal an error if FACE_NAME does not name a face.
2114 Otherwise, value is zero if FACE_NAME is not a face. */
2116 static inline int
2117 get_lface_attributes_no_remap (struct frame *f, Lisp_Object face_name,
2118 Lisp_Object *attrs, int signal_p)
2120 Lisp_Object lface;
2122 lface = lface_from_face_name_no_resolve (f, face_name, signal_p);
2124 if (! NILP (lface))
2125 memcpy (attrs, XVECTOR (lface)->contents,
2126 LFACE_VECTOR_SIZE * sizeof *attrs);
2128 return !NILP (lface);
2131 /* Get face attributes of face FACE_NAME from frame-local faces on frame
2132 F. Store the resulting attributes in ATTRS which must point to a
2133 vector of Lisp_Objects of size LFACE_VECTOR_SIZE. If FACE_NAME is an
2134 alias for another face, use that face's definition. If SIGNAL_P is
2135 non-zero, signal an error if FACE_NAME does not name a face.
2136 Otherwise, value is zero if FACE_NAME is not a face. */
2138 static inline int
2139 get_lface_attributes (struct frame *f, Lisp_Object face_name,
2140 Lisp_Object *attrs, int signal_p,
2141 struct named_merge_point *named_merge_points)
2143 Lisp_Object face_remapping;
2145 face_name = resolve_face_name (face_name, signal_p);
2147 /* See if SYMBOL has been remapped to some other face (usually this
2148 is done buffer-locally). */
2149 face_remapping = assq_no_quit (face_name, Vface_remapping_alist);
2150 if (CONSP (face_remapping))
2152 struct named_merge_point named_merge_point;
2154 if (push_named_merge_point (&named_merge_point,
2155 face_name, NAMED_MERGE_POINT_REMAP,
2156 &named_merge_points))
2158 int i;
2160 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2161 attrs[i] = Qunspecified;
2163 return merge_face_ref (f, XCDR (face_remapping), attrs,
2164 signal_p, named_merge_points);
2168 /* Default case, no remapping. */
2169 return get_lface_attributes_no_remap (f, face_name, attrs, signal_p);
2173 /* Non-zero if all attributes in face attribute vector ATTRS are
2174 specified, i.e. are non-nil. */
2176 static int
2177 lface_fully_specified_p (Lisp_Object *attrs)
2179 int i;
2181 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2182 if (i != LFACE_FONT_INDEX && i != LFACE_INHERIT_INDEX)
2183 if ((UNSPECIFIEDP (attrs[i]) || IGNORE_DEFFACE_P (attrs[i])))
2184 break;
2186 return i == LFACE_VECTOR_SIZE;
2189 #ifdef HAVE_WINDOW_SYSTEM
2191 /* Set font-related attributes of Lisp face LFACE from FONT-OBJECT.
2192 If FORCE_P is zero, set only unspecified attributes of LFACE. The
2193 exception is `font' attribute. It is set to FONT_OBJECT regardless
2194 of FORCE_P. */
2196 static int
2197 set_lface_from_font (struct frame *f, Lisp_Object lface,
2198 Lisp_Object font_object, int force_p)
2200 Lisp_Object val;
2201 struct font *font = XFONT_OBJECT (font_object);
2203 /* Set attributes only if unspecified, otherwise face defaults for
2204 new frames would never take effect. If the font doesn't have a
2205 specific property, set a normal value for that. */
2207 if (force_p || UNSPECIFIEDP (LFACE_FAMILY (lface)))
2209 Lisp_Object family = AREF (font_object, FONT_FAMILY_INDEX);
2211 LFACE_FAMILY (lface) = SYMBOL_NAME (family);
2214 if (force_p || UNSPECIFIEDP (LFACE_FOUNDRY (lface)))
2216 Lisp_Object foundry = AREF (font_object, FONT_FOUNDRY_INDEX);
2218 LFACE_FOUNDRY (lface) = SYMBOL_NAME (foundry);
2221 if (force_p || UNSPECIFIEDP (LFACE_HEIGHT (lface)))
2223 int pt = PIXEL_TO_POINT (font->pixel_size * 10, f->resy);
2225 xassert (pt > 0);
2226 LFACE_HEIGHT (lface) = make_number (pt);
2229 if (force_p || UNSPECIFIEDP (LFACE_WEIGHT (lface)))
2231 val = FONT_WEIGHT_FOR_FACE (font_object);
2232 LFACE_WEIGHT (lface) = ! NILP (val) ? val :Qnormal;
2234 if (force_p || UNSPECIFIEDP (LFACE_SLANT (lface)))
2236 val = FONT_SLANT_FOR_FACE (font_object);
2237 LFACE_SLANT (lface) = ! NILP (val) ? val : Qnormal;
2239 if (force_p || UNSPECIFIEDP (LFACE_SWIDTH (lface)))
2241 val = FONT_WIDTH_FOR_FACE (font_object);
2242 LFACE_SWIDTH (lface) = ! NILP (val) ? val : Qnormal;
2245 LFACE_FONT (lface) = font_object;
2246 return 1;
2249 #endif /* HAVE_WINDOW_SYSTEM */
2252 /* Merges the face height FROM with the face height TO, and returns the
2253 merged height. If FROM is an invalid height, then INVALID is
2254 returned instead. FROM and TO may be either absolute face heights or
2255 `relative' heights; the returned value is always an absolute height
2256 unless both FROM and TO are relative. */
2258 static Lisp_Object
2259 merge_face_heights (Lisp_Object from, Lisp_Object to, Lisp_Object invalid)
2261 Lisp_Object result = invalid;
2263 if (INTEGERP (from))
2264 /* FROM is absolute, just use it as is. */
2265 result = from;
2266 else if (FLOATP (from))
2267 /* FROM is a scale, use it to adjust TO. */
2269 if (INTEGERP (to))
2270 /* relative X absolute => absolute */
2271 result = make_number (XFLOAT_DATA (from) * XINT (to));
2272 else if (FLOATP (to))
2273 /* relative X relative => relative */
2274 result = make_float (XFLOAT_DATA (from) * XFLOAT_DATA (to));
2275 else if (UNSPECIFIEDP (to))
2276 result = from;
2278 else if (FUNCTIONP (from))
2279 /* FROM is a function, which use to adjust TO. */
2281 /* Call function with current height as argument.
2282 From is the new height. */
2283 Lisp_Object args[2];
2285 args[0] = from;
2286 args[1] = to;
2287 result = safe_call (2, args);
2289 /* Ensure that if TO was absolute, so is the result. */
2290 if (INTEGERP (to) && !INTEGERP (result))
2291 result = invalid;
2294 return result;
2298 /* Merge two Lisp face attribute vectors on frame F, FROM and TO, and
2299 store the resulting attributes in TO, which must be already be
2300 completely specified and contain only absolute attributes. Every
2301 specified attribute of FROM overrides the corresponding attribute of
2302 TO; relative attributes in FROM are merged with the absolute value in
2303 TO and replace it. NAMED_MERGE_POINTS is used internally to detect
2304 loops in face inheritance/remapping; it should be 0 when called from
2305 other places. */
2307 static inline void
2308 merge_face_vectors (struct frame *f, Lisp_Object *from, Lisp_Object *to,
2309 struct named_merge_point *named_merge_points)
2311 int i;
2313 /* If FROM inherits from some other faces, merge their attributes into
2314 TO before merging FROM's direct attributes. Note that an :inherit
2315 attribute of `unspecified' is the same as one of nil; we never
2316 merge :inherit attributes, so nil is more correct, but lots of
2317 other code uses `unspecified' as a generic value for face attributes. */
2318 if (!UNSPECIFIEDP (from[LFACE_INHERIT_INDEX])
2319 && !NILP (from[LFACE_INHERIT_INDEX]))
2320 merge_face_ref (f, from[LFACE_INHERIT_INDEX], to, 0, named_merge_points);
2322 i = LFACE_FONT_INDEX;
2323 if (!UNSPECIFIEDP (from[i]))
2325 if (!UNSPECIFIEDP (to[i]))
2326 to[i] = merge_font_spec (from[i], to[i]);
2327 else
2328 to[i] = copy_font_spec (from[i]);
2329 if (! NILP (AREF (to[i], FONT_FOUNDRY_INDEX)))
2330 to[LFACE_FOUNDRY_INDEX] = SYMBOL_NAME (AREF (to[i], FONT_FOUNDRY_INDEX));
2331 if (! NILP (AREF (to[i], FONT_FAMILY_INDEX)))
2332 to[LFACE_FAMILY_INDEX] = SYMBOL_NAME (AREF (to[i], FONT_FAMILY_INDEX));
2333 if (! NILP (AREF (to[i], FONT_WEIGHT_INDEX)))
2334 to[LFACE_WEIGHT_INDEX] = FONT_WEIGHT_FOR_FACE (to[i]);
2335 if (! NILP (AREF (to[i], FONT_SLANT_INDEX)))
2336 to[LFACE_SLANT_INDEX] = FONT_SLANT_FOR_FACE (to[i]);
2337 if (! NILP (AREF (to[i], FONT_WIDTH_INDEX)))
2338 to[LFACE_SWIDTH_INDEX] = FONT_WIDTH_FOR_FACE (to[i]);
2339 ASET (to[i], FONT_SIZE_INDEX, Qnil);
2342 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2343 if (!UNSPECIFIEDP (from[i]))
2345 if (i == LFACE_HEIGHT_INDEX && !INTEGERP (from[i]))
2347 to[i] = merge_face_heights (from[i], to[i], to[i]);
2348 font_clear_prop (to, FONT_SIZE_INDEX);
2350 else if (i != LFACE_FONT_INDEX
2351 && ! EQ (to[i], from[i]))
2353 to[i] = from[i];
2354 if (i >= LFACE_FAMILY_INDEX && i <=LFACE_SLANT_INDEX)
2355 font_clear_prop (to,
2356 (i == LFACE_FAMILY_INDEX ? FONT_FAMILY_INDEX
2357 : i == LFACE_FOUNDRY_INDEX ? FONT_FOUNDRY_INDEX
2358 : i == LFACE_SWIDTH_INDEX ? FONT_WIDTH_INDEX
2359 : i == LFACE_HEIGHT_INDEX ? FONT_SIZE_INDEX
2360 : i == LFACE_WEIGHT_INDEX ? FONT_WEIGHT_INDEX
2361 : FONT_SLANT_INDEX));
2365 /* TO is always an absolute face, which should inherit from nothing.
2366 We blindly copy the :inherit attribute above and fix it up here. */
2367 to[LFACE_INHERIT_INDEX] = Qnil;
2370 /* Merge the named face FACE_NAME on frame F, into the vector of face
2371 attributes TO. NAMED_MERGE_POINTS is used to detect loops in face
2372 inheritance. Returns true if FACE_NAME is a valid face name and
2373 merging succeeded. */
2375 static int
2376 merge_named_face (struct frame *f, Lisp_Object face_name, Lisp_Object *to,
2377 struct named_merge_point *named_merge_points)
2379 struct named_merge_point named_merge_point;
2381 if (push_named_merge_point (&named_merge_point,
2382 face_name, NAMED_MERGE_POINT_NORMAL,
2383 &named_merge_points))
2385 struct gcpro gcpro1;
2386 Lisp_Object from[LFACE_VECTOR_SIZE];
2387 int ok = get_lface_attributes (f, face_name, from, 0, named_merge_points);
2389 if (ok)
2391 GCPRO1 (named_merge_point.face_name);
2392 merge_face_vectors (f, from, to, named_merge_points);
2393 UNGCPRO;
2396 return ok;
2398 else
2399 return 0;
2403 /* Merge face attributes from the lisp `face reference' FACE_REF on
2404 frame F into the face attribute vector TO. If ERR_MSGS is non-zero,
2405 problems with FACE_REF cause an error message to be shown. Return
2406 non-zero if no errors occurred (regardless of the value of ERR_MSGS).
2407 NAMED_MERGE_POINTS is used to detect loops in face inheritance or
2408 list structure; it may be 0 for most callers.
2410 FACE_REF may be a single face specification or a list of such
2411 specifications. Each face specification can be:
2413 1. A symbol or string naming a Lisp face.
2415 2. A property list of the form (KEYWORD VALUE ...) where each
2416 KEYWORD is a face attribute name, and value is an appropriate value
2417 for that attribute.
2419 3. Conses or the form (FOREGROUND-COLOR . COLOR) or
2420 (BACKGROUND-COLOR . COLOR) where COLOR is a color name. This is
2421 for compatibility with 20.2.
2423 Face specifications earlier in lists take precedence over later
2424 specifications. */
2426 static int
2427 merge_face_ref (struct frame *f, Lisp_Object face_ref, Lisp_Object *to,
2428 int err_msgs, struct named_merge_point *named_merge_points)
2430 int ok = 1; /* Succeed without an error? */
2432 if (CONSP (face_ref))
2434 Lisp_Object first = XCAR (face_ref);
2436 if (EQ (first, Qforeground_color)
2437 || EQ (first, Qbackground_color))
2439 /* One of (FOREGROUND-COLOR . COLOR) or (BACKGROUND-COLOR
2440 . COLOR). COLOR must be a string. */
2441 Lisp_Object color_name = XCDR (face_ref);
2442 Lisp_Object color = first;
2444 if (STRINGP (color_name))
2446 if (EQ (color, Qforeground_color))
2447 to[LFACE_FOREGROUND_INDEX] = color_name;
2448 else
2449 to[LFACE_BACKGROUND_INDEX] = color_name;
2451 else
2453 if (err_msgs)
2454 add_to_log ("Invalid face color", color_name, Qnil);
2455 ok = 0;
2458 else if (SYMBOLP (first)
2459 && *SDATA (SYMBOL_NAME (first)) == ':')
2461 /* Assume this is the property list form. */
2462 while (CONSP (face_ref) && CONSP (XCDR (face_ref)))
2464 Lisp_Object keyword = XCAR (face_ref);
2465 Lisp_Object value = XCAR (XCDR (face_ref));
2466 int err = 0;
2468 /* Specifying `unspecified' is a no-op. */
2469 if (EQ (value, Qunspecified))
2471 else if (EQ (keyword, QCfamily))
2473 if (STRINGP (value))
2475 to[LFACE_FAMILY_INDEX] = value;
2476 font_clear_prop (to, FONT_FAMILY_INDEX);
2478 else
2479 err = 1;
2481 else if (EQ (keyword, QCfoundry))
2483 if (STRINGP (value))
2485 to[LFACE_FOUNDRY_INDEX] = value;
2486 font_clear_prop (to, FONT_FOUNDRY_INDEX);
2488 else
2489 err = 1;
2491 else if (EQ (keyword, QCheight))
2493 Lisp_Object new_height =
2494 merge_face_heights (value, to[LFACE_HEIGHT_INDEX], Qnil);
2496 if (! NILP (new_height))
2498 to[LFACE_HEIGHT_INDEX] = new_height;
2499 font_clear_prop (to, FONT_SIZE_INDEX);
2501 else
2502 err = 1;
2504 else if (EQ (keyword, QCweight))
2506 if (SYMBOLP (value) && FONT_WEIGHT_NAME_NUMERIC (value) >= 0)
2508 to[LFACE_WEIGHT_INDEX] = value;
2509 font_clear_prop (to, FONT_WEIGHT_INDEX);
2511 else
2512 err = 1;
2514 else if (EQ (keyword, QCslant))
2516 if (SYMBOLP (value) && FONT_SLANT_NAME_NUMERIC (value) >= 0)
2518 to[LFACE_SLANT_INDEX] = value;
2519 font_clear_prop (to, FONT_SLANT_INDEX);
2521 else
2522 err = 1;
2524 else if (EQ (keyword, QCunderline))
2526 if (EQ (value, Qt)
2527 || NILP (value)
2528 || STRINGP (value))
2529 to[LFACE_UNDERLINE_INDEX] = value;
2530 else
2531 err = 1;
2533 else if (EQ (keyword, QCoverline))
2535 if (EQ (value, Qt)
2536 || NILP (value)
2537 || STRINGP (value))
2538 to[LFACE_OVERLINE_INDEX] = value;
2539 else
2540 err = 1;
2542 else if (EQ (keyword, QCstrike_through))
2544 if (EQ (value, Qt)
2545 || NILP (value)
2546 || STRINGP (value))
2547 to[LFACE_STRIKE_THROUGH_INDEX] = value;
2548 else
2549 err = 1;
2551 else if (EQ (keyword, QCbox))
2553 if (EQ (value, Qt))
2554 value = make_number (1);
2555 if (INTEGERP (value)
2556 || STRINGP (value)
2557 || CONSP (value)
2558 || NILP (value))
2559 to[LFACE_BOX_INDEX] = value;
2560 else
2561 err = 1;
2563 else if (EQ (keyword, QCinverse_video)
2564 || EQ (keyword, QCreverse_video))
2566 if (EQ (value, Qt) || NILP (value))
2567 to[LFACE_INVERSE_INDEX] = value;
2568 else
2569 err = 1;
2571 else if (EQ (keyword, QCforeground))
2573 if (STRINGP (value))
2574 to[LFACE_FOREGROUND_INDEX] = value;
2575 else
2576 err = 1;
2578 else if (EQ (keyword, QCbackground))
2580 if (STRINGP (value))
2581 to[LFACE_BACKGROUND_INDEX] = value;
2582 else
2583 err = 1;
2585 else if (EQ (keyword, QCstipple))
2587 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
2588 Lisp_Object pixmap_p = Fbitmap_spec_p (value);
2589 if (!NILP (pixmap_p))
2590 to[LFACE_STIPPLE_INDEX] = value;
2591 else
2592 err = 1;
2593 #endif
2595 else if (EQ (keyword, QCwidth))
2597 if (SYMBOLP (value) && FONT_WIDTH_NAME_NUMERIC (value) >= 0)
2599 to[LFACE_SWIDTH_INDEX] = value;
2600 font_clear_prop (to, FONT_WIDTH_INDEX);
2602 else
2603 err = 1;
2605 else if (EQ (keyword, QCinherit))
2607 /* This is not really very useful; it's just like a
2608 normal face reference. */
2609 if (! merge_face_ref (f, value, to,
2610 err_msgs, named_merge_points))
2611 err = 1;
2613 else
2614 err = 1;
2616 if (err)
2618 add_to_log ("Invalid face attribute %S %S", keyword, value);
2619 ok = 0;
2622 face_ref = XCDR (XCDR (face_ref));
2625 else
2627 /* This is a list of face refs. Those at the beginning of the
2628 list take precedence over what follows, so we have to merge
2629 from the end backwards. */
2630 Lisp_Object next = XCDR (face_ref);
2632 if (! NILP (next))
2633 ok = merge_face_ref (f, next, to, err_msgs, named_merge_points);
2635 if (! merge_face_ref (f, first, to, err_msgs, named_merge_points))
2636 ok = 0;
2639 else
2641 /* FACE_REF ought to be a face name. */
2642 ok = merge_named_face (f, face_ref, to, named_merge_points);
2643 if (!ok && err_msgs)
2644 add_to_log ("Invalid face reference: %s", face_ref, Qnil);
2647 return ok;
2651 DEFUN ("internal-make-lisp-face", Finternal_make_lisp_face,
2652 Sinternal_make_lisp_face, 1, 2, 0,
2653 doc: /* Make FACE, a symbol, a Lisp face with all attributes nil.
2654 If FACE was not known as a face before, create a new one.
2655 If optional argument FRAME is specified, make a frame-local face
2656 for that frame. Otherwise operate on the global face definition.
2657 Value is a vector of face attributes. */)
2658 (Lisp_Object face, Lisp_Object frame)
2660 Lisp_Object global_lface, lface;
2661 struct frame *f;
2662 int i;
2664 CHECK_SYMBOL (face);
2665 global_lface = lface_from_face_name (NULL, face, 0);
2667 if (!NILP (frame))
2669 CHECK_LIVE_FRAME (frame);
2670 f = XFRAME (frame);
2671 lface = lface_from_face_name (f, face, 0);
2673 else
2674 f = NULL, lface = Qnil;
2676 /* Add a global definition if there is none. */
2677 if (NILP (global_lface))
2679 global_lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
2680 Qunspecified);
2681 ASET (global_lface, 0, Qface);
2682 Vface_new_frame_defaults = Fcons (Fcons (face, global_lface),
2683 Vface_new_frame_defaults);
2685 /* Assign the new Lisp face a unique ID. The mapping from Lisp
2686 face id to Lisp face is given by the vector lface_id_to_name.
2687 The mapping from Lisp face to Lisp face id is given by the
2688 property `face' of the Lisp face name. */
2689 if (next_lface_id == lface_id_to_name_size)
2690 lface_id_to_name =
2691 xpalloc (lface_id_to_name, &lface_id_to_name_size, 1, MAX_FACE_ID,
2692 sizeof *lface_id_to_name);
2694 lface_id_to_name[next_lface_id] = face;
2695 Fput (face, Qface, make_number (next_lface_id));
2696 ++next_lface_id;
2698 else if (f == NULL)
2699 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2700 ASET (global_lface, i, Qunspecified);
2702 /* Add a frame-local definition. */
2703 if (f)
2705 if (NILP (lface))
2707 lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
2708 Qunspecified);
2709 ASET (lface, 0, Qface);
2710 f->face_alist = Fcons (Fcons (face, lface), f->face_alist);
2712 else
2713 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
2714 ASET (lface, i, Qunspecified);
2716 else
2717 lface = global_lface;
2719 /* Changing a named face means that all realized faces depending on
2720 that face are invalid. Since we cannot tell which realized faces
2721 depend on the face, make sure they are all removed. This is done
2722 by incrementing face_change_count. The next call to
2723 init_iterator will then free realized faces. */
2724 if (NILP (Fget (face, Qface_no_inherit)))
2726 ++face_change_count;
2727 ++windows_or_buffers_changed;
2730 xassert (LFACEP (lface));
2731 check_lface (lface);
2732 return lface;
2736 DEFUN ("internal-lisp-face-p", Finternal_lisp_face_p,
2737 Sinternal_lisp_face_p, 1, 2, 0,
2738 doc: /* Return non-nil if FACE names a face.
2739 FACE should be a symbol or string.
2740 If optional second argument FRAME is non-nil, check for the
2741 existence of a frame-local face with name FACE on that frame.
2742 Otherwise check for the existence of a global face. */)
2743 (Lisp_Object face, Lisp_Object frame)
2745 Lisp_Object lface;
2747 face = resolve_face_name (face, 1);
2749 if (!NILP (frame))
2751 CHECK_LIVE_FRAME (frame);
2752 lface = lface_from_face_name (XFRAME (frame), face, 0);
2754 else
2755 lface = lface_from_face_name (NULL, face, 0);
2757 return lface;
2761 DEFUN ("internal-copy-lisp-face", Finternal_copy_lisp_face,
2762 Sinternal_copy_lisp_face, 4, 4, 0,
2763 doc: /* Copy face FROM to TO.
2764 If FRAME is t, copy the global face definition of FROM.
2765 Otherwise, copy the frame-local definition of FROM on FRAME.
2766 If NEW-FRAME is a frame, copy that data into the frame-local
2767 definition of TO on NEW-FRAME. If NEW-FRAME is nil,
2768 FRAME controls where the data is copied to.
2770 The value is TO. */)
2771 (Lisp_Object from, Lisp_Object to, Lisp_Object frame, Lisp_Object new_frame)
2773 Lisp_Object lface, copy;
2775 CHECK_SYMBOL (from);
2776 CHECK_SYMBOL (to);
2778 if (EQ (frame, Qt))
2780 /* Copy global definition of FROM. We don't make copies of
2781 strings etc. because 20.2 didn't do it either. */
2782 lface = lface_from_face_name (NULL, from, 1);
2783 copy = Finternal_make_lisp_face (to, Qnil);
2785 else
2787 /* Copy frame-local definition of FROM. */
2788 if (NILP (new_frame))
2789 new_frame = frame;
2790 CHECK_LIVE_FRAME (frame);
2791 CHECK_LIVE_FRAME (new_frame);
2792 lface = lface_from_face_name (XFRAME (frame), from, 1);
2793 copy = Finternal_make_lisp_face (to, new_frame);
2796 memcpy (XVECTOR (copy)->contents, XVECTOR (lface)->contents,
2797 LFACE_VECTOR_SIZE * sizeof (Lisp_Object));
2799 /* Changing a named face means that all realized faces depending on
2800 that face are invalid. Since we cannot tell which realized faces
2801 depend on the face, make sure they are all removed. This is done
2802 by incrementing face_change_count. The next call to
2803 init_iterator will then free realized faces. */
2804 if (NILP (Fget (to, Qface_no_inherit)))
2806 ++face_change_count;
2807 ++windows_or_buffers_changed;
2810 return to;
2814 DEFUN ("internal-set-lisp-face-attribute", Finternal_set_lisp_face_attribute,
2815 Sinternal_set_lisp_face_attribute, 3, 4, 0,
2816 doc: /* Set attribute ATTR of FACE to VALUE.
2817 FRAME being a frame means change the face on that frame.
2818 FRAME nil means change the face of the selected frame.
2819 FRAME t means change the default for new frames.
2820 FRAME 0 means change the face on all frames, and change the default
2821 for new frames. */)
2822 (Lisp_Object face, Lisp_Object attr, Lisp_Object value, Lisp_Object frame)
2824 Lisp_Object lface;
2825 Lisp_Object old_value = Qnil;
2826 /* Set one of enum font_property_index (> 0) if ATTR is one of
2827 font-related attributes other than QCfont and QCfontset. */
2828 enum font_property_index prop_index = 0;
2830 CHECK_SYMBOL (face);
2831 CHECK_SYMBOL (attr);
2833 face = resolve_face_name (face, 1);
2835 /* If FRAME is 0, change face on all frames, and change the
2836 default for new frames. */
2837 if (INTEGERP (frame) && XINT (frame) == 0)
2839 Lisp_Object tail;
2840 Finternal_set_lisp_face_attribute (face, attr, value, Qt);
2841 FOR_EACH_FRAME (tail, frame)
2842 Finternal_set_lisp_face_attribute (face, attr, value, frame);
2843 return face;
2846 /* Set lface to the Lisp attribute vector of FACE. */
2847 if (EQ (frame, Qt))
2849 lface = lface_from_face_name (NULL, face, 1);
2851 /* When updating face-new-frame-defaults, we put :ignore-defface
2852 where the caller wants `unspecified'. This forces the frame
2853 defaults to ignore the defface value. Otherwise, the defface
2854 will take effect, which is generally not what is intended.
2855 The value of that attribute will be inherited from some other
2856 face during face merging. See internal_merge_in_global_face. */
2857 if (UNSPECIFIEDP (value))
2858 value = QCignore_defface;
2860 else
2862 if (NILP (frame))
2863 frame = selected_frame;
2865 CHECK_LIVE_FRAME (frame);
2866 lface = lface_from_face_name (XFRAME (frame), face, 0);
2868 /* If a frame-local face doesn't exist yet, create one. */
2869 if (NILP (lface))
2870 lface = Finternal_make_lisp_face (face, frame);
2873 if (EQ (attr, QCfamily))
2875 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2877 CHECK_STRING (value);
2878 if (SCHARS (value) == 0)
2879 signal_error ("Invalid face family", value);
2881 old_value = LFACE_FAMILY (lface);
2882 LFACE_FAMILY (lface) = value;
2883 prop_index = FONT_FAMILY_INDEX;
2885 else if (EQ (attr, QCfoundry))
2887 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2889 CHECK_STRING (value);
2890 if (SCHARS (value) == 0)
2891 signal_error ("Invalid face foundry", value);
2893 old_value = LFACE_FOUNDRY (lface);
2894 LFACE_FOUNDRY (lface) = value;
2895 prop_index = FONT_FOUNDRY_INDEX;
2897 else if (EQ (attr, QCheight))
2899 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2901 if (EQ (face, Qdefault))
2903 /* The default face must have an absolute size. */
2904 if (!INTEGERP (value) || XINT (value) <= 0)
2905 signal_error ("Default face height not absolute and positive",
2906 value);
2908 else
2910 /* For non-default faces, do a test merge with a random
2911 height to see if VALUE's ok. */
2912 Lisp_Object test = merge_face_heights (value,
2913 make_number (10),
2914 Qnil);
2915 if (!INTEGERP (test) || XINT (test) <= 0)
2916 signal_error ("Face height does not produce a positive integer",
2917 value);
2921 old_value = LFACE_HEIGHT (lface);
2922 LFACE_HEIGHT (lface) = value;
2923 prop_index = FONT_SIZE_INDEX;
2925 else if (EQ (attr, QCweight))
2927 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2929 CHECK_SYMBOL (value);
2930 if (FONT_WEIGHT_NAME_NUMERIC (value) < 0)
2931 signal_error ("Invalid face weight", value);
2933 old_value = LFACE_WEIGHT (lface);
2934 LFACE_WEIGHT (lface) = value;
2935 prop_index = FONT_WEIGHT_INDEX;
2937 else if (EQ (attr, QCslant))
2939 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2941 CHECK_SYMBOL (value);
2942 if (FONT_SLANT_NAME_NUMERIC (value) < 0)
2943 signal_error ("Invalid face slant", value);
2945 old_value = LFACE_SLANT (lface);
2946 LFACE_SLANT (lface) = value;
2947 prop_index = FONT_SLANT_INDEX;
2949 else if (EQ (attr, QCunderline))
2951 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2952 if ((SYMBOLP (value)
2953 && !EQ (value, Qt)
2954 && !EQ (value, Qnil))
2955 /* Underline color. */
2956 || (STRINGP (value)
2957 && SCHARS (value) == 0))
2958 signal_error ("Invalid face underline", value);
2960 old_value = LFACE_UNDERLINE (lface);
2961 LFACE_UNDERLINE (lface) = value;
2963 else if (EQ (attr, QCoverline))
2965 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2966 if ((SYMBOLP (value)
2967 && !EQ (value, Qt)
2968 && !EQ (value, Qnil))
2969 /* Overline color. */
2970 || (STRINGP (value)
2971 && SCHARS (value) == 0))
2972 signal_error ("Invalid face overline", value);
2974 old_value = LFACE_OVERLINE (lface);
2975 LFACE_OVERLINE (lface) = value;
2977 else if (EQ (attr, QCstrike_through))
2979 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
2980 if ((SYMBOLP (value)
2981 && !EQ (value, Qt)
2982 && !EQ (value, Qnil))
2983 /* Strike-through color. */
2984 || (STRINGP (value)
2985 && SCHARS (value) == 0))
2986 signal_error ("Invalid face strike-through", value);
2988 old_value = LFACE_STRIKE_THROUGH (lface);
2989 LFACE_STRIKE_THROUGH (lface) = value;
2991 else if (EQ (attr, QCbox))
2993 int valid_p;
2995 /* Allow t meaning a simple box of width 1 in foreground color
2996 of the face. */
2997 if (EQ (value, Qt))
2998 value = make_number (1);
3000 if (UNSPECIFIEDP (value) || IGNORE_DEFFACE_P (value))
3001 valid_p = 1;
3002 else if (NILP (value))
3003 valid_p = 1;
3004 else if (INTEGERP (value))
3005 valid_p = XINT (value) != 0;
3006 else if (STRINGP (value))
3007 valid_p = SCHARS (value) > 0;
3008 else if (CONSP (value))
3010 Lisp_Object tem;
3012 tem = value;
3013 while (CONSP (tem))
3015 Lisp_Object k, v;
3017 k = XCAR (tem);
3018 tem = XCDR (tem);
3019 if (!CONSP (tem))
3020 break;
3021 v = XCAR (tem);
3022 tem = XCDR (tem);
3024 if (EQ (k, QCline_width))
3026 if (!INTEGERP (v) || XINT (v) == 0)
3027 break;
3029 else if (EQ (k, QCcolor))
3031 if (!NILP (v) && (!STRINGP (v) || SCHARS (v) == 0))
3032 break;
3034 else if (EQ (k, QCstyle))
3036 if (!EQ (v, Qpressed_button) && !EQ (v, Qreleased_button))
3037 break;
3039 else
3040 break;
3043 valid_p = NILP (tem);
3045 else
3046 valid_p = 0;
3048 if (!valid_p)
3049 signal_error ("Invalid face box", value);
3051 old_value = LFACE_BOX (lface);
3052 LFACE_BOX (lface) = value;
3054 else if (EQ (attr, QCinverse_video)
3055 || EQ (attr, QCreverse_video))
3057 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3059 CHECK_SYMBOL (value);
3060 if (!EQ (value, Qt) && !NILP (value))
3061 signal_error ("Invalid inverse-video face attribute value", value);
3063 old_value = LFACE_INVERSE (lface);
3064 LFACE_INVERSE (lface) = value;
3066 else if (EQ (attr, QCforeground))
3068 /* Compatibility with 20.x. */
3069 if (NILP (value))
3070 value = Qunspecified;
3071 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3073 /* Don't check for valid color names here because it depends
3074 on the frame (display) whether the color will be valid
3075 when the face is realized. */
3076 CHECK_STRING (value);
3077 if (SCHARS (value) == 0)
3078 signal_error ("Empty foreground color value", value);
3080 old_value = LFACE_FOREGROUND (lface);
3081 LFACE_FOREGROUND (lface) = value;
3083 else if (EQ (attr, QCbackground))
3085 /* Compatibility with 20.x. */
3086 if (NILP (value))
3087 value = Qunspecified;
3088 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3090 /* Don't check for valid color names here because it depends
3091 on the frame (display) whether the color will be valid
3092 when the face is realized. */
3093 CHECK_STRING (value);
3094 if (SCHARS (value) == 0)
3095 signal_error ("Empty background color value", value);
3097 old_value = LFACE_BACKGROUND (lface);
3098 LFACE_BACKGROUND (lface) = value;
3100 else if (EQ (attr, QCstipple))
3102 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3103 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value)
3104 && !NILP (value)
3105 && NILP (Fbitmap_spec_p (value)))
3106 signal_error ("Invalid stipple attribute", value);
3107 old_value = LFACE_STIPPLE (lface);
3108 LFACE_STIPPLE (lface) = value;
3109 #endif /* HAVE_X_WINDOWS || HAVE_NS */
3111 else if (EQ (attr, QCwidth))
3113 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3115 CHECK_SYMBOL (value);
3116 if (FONT_WIDTH_NAME_NUMERIC (value) < 0)
3117 signal_error ("Invalid face width", value);
3119 old_value = LFACE_SWIDTH (lface);
3120 LFACE_SWIDTH (lface) = value;
3121 prop_index = FONT_WIDTH_INDEX;
3123 else if (EQ (attr, QCfont))
3125 #ifdef HAVE_WINDOW_SYSTEM
3126 if (EQ (frame, Qt) || FRAME_WINDOW_P (XFRAME (frame)))
3128 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
3130 FRAME_PTR f;
3132 old_value = LFACE_FONT (lface);
3133 if (! FONTP (value))
3135 if (STRINGP (value))
3137 Lisp_Object name = value;
3138 int fontset = fs_query_fontset (name, 0);
3140 if (fontset >= 0)
3141 name = fontset_ascii (fontset);
3142 value = font_spec_from_name (name);
3143 if (!FONTP (value))
3144 signal_error ("Invalid font name", name);
3146 else
3147 signal_error ("Invalid font or font-spec", value);
3149 if (EQ (frame, Qt))
3150 f = XFRAME (selected_frame);
3151 else
3152 f = XFRAME (frame);
3153 if (! FONT_OBJECT_P (value))
3155 Lisp_Object *attrs = XVECTOR (lface)->contents;
3156 Lisp_Object font_object;
3158 font_object = font_load_for_lface (f, attrs, value);
3159 if (NILP (font_object))
3160 signal_error ("Font not available", value);
3161 value = font_object;
3163 set_lface_from_font (f, lface, value, 1);
3165 else
3166 LFACE_FONT (lface) = value;
3168 #endif /* HAVE_WINDOW_SYSTEM */
3170 else if (EQ (attr, QCfontset))
3172 #ifdef HAVE_WINDOW_SYSTEM
3173 if (EQ (frame, Qt) || FRAME_WINDOW_P (XFRAME (frame)))
3175 Lisp_Object tmp;
3177 old_value = LFACE_FONTSET (lface);
3178 tmp = Fquery_fontset (value, Qnil);
3179 if (NILP (tmp))
3180 signal_error ("Invalid fontset name", value);
3181 LFACE_FONTSET (lface) = value = tmp;
3183 #endif /* HAVE_WINDOW_SYSTEM */
3185 else if (EQ (attr, QCinherit))
3187 Lisp_Object tail;
3188 if (SYMBOLP (value))
3189 tail = Qnil;
3190 else
3191 for (tail = value; CONSP (tail); tail = XCDR (tail))
3192 if (!SYMBOLP (XCAR (tail)))
3193 break;
3194 if (NILP (tail))
3195 LFACE_INHERIT (lface) = value;
3196 else
3197 signal_error ("Invalid face inheritance", value);
3199 else if (EQ (attr, QCbold))
3201 old_value = LFACE_WEIGHT (lface);
3202 LFACE_WEIGHT (lface) = NILP (value) ? Qnormal : Qbold;
3203 prop_index = FONT_WEIGHT_INDEX;
3205 else if (EQ (attr, QCitalic))
3207 attr = QCslant;
3208 old_value = LFACE_SLANT (lface);
3209 LFACE_SLANT (lface) = NILP (value) ? Qnormal : Qitalic;
3210 prop_index = FONT_SLANT_INDEX;
3212 else
3213 signal_error ("Invalid face attribute name", attr);
3215 if (prop_index)
3217 /* If a font-related attribute other than QCfont and QCfontset
3218 is specified, and if the original QCfont attribute has a font
3219 (font-spec or font-object), set the corresponding property in
3220 the font to nil so that the font selector doesn't think that
3221 the attribute is mandatory. Also, clear the average
3222 width. */
3223 font_clear_prop (XVECTOR (lface)->contents, prop_index);
3226 /* Changing a named face means that all realized faces depending on
3227 that face are invalid. Since we cannot tell which realized faces
3228 depend on the face, make sure they are all removed. This is done
3229 by incrementing face_change_count. The next call to
3230 init_iterator will then free realized faces. */
3231 if (!EQ (frame, Qt)
3232 && NILP (Fget (face, Qface_no_inherit))
3233 && NILP (Fequal (old_value, value)))
3235 ++face_change_count;
3236 ++windows_or_buffers_changed;
3239 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value)
3240 && NILP (Fequal (old_value, value)))
3242 Lisp_Object param;
3244 param = Qnil;
3246 if (EQ (face, Qdefault))
3248 #ifdef HAVE_WINDOW_SYSTEM
3249 /* Changed font-related attributes of the `default' face are
3250 reflected in changed `font' frame parameters. */
3251 if (FRAMEP (frame)
3252 && (prop_index || EQ (attr, QCfont))
3253 && lface_fully_specified_p (XVECTOR (lface)->contents))
3254 set_font_frame_param (frame, lface);
3255 else
3256 #endif /* HAVE_WINDOW_SYSTEM */
3258 if (EQ (attr, QCforeground))
3259 param = Qforeground_color;
3260 else if (EQ (attr, QCbackground))
3261 param = Qbackground_color;
3263 #ifdef HAVE_WINDOW_SYSTEM
3264 #ifndef WINDOWSNT
3265 else if (EQ (face, Qscroll_bar))
3267 /* Changing the colors of `scroll-bar' sets frame parameters
3268 `scroll-bar-foreground' and `scroll-bar-background'. */
3269 if (EQ (attr, QCforeground))
3270 param = Qscroll_bar_foreground;
3271 else if (EQ (attr, QCbackground))
3272 param = Qscroll_bar_background;
3274 #endif /* not WINDOWSNT */
3275 else if (EQ (face, Qborder))
3277 /* Changing background color of `border' sets frame parameter
3278 `border-color'. */
3279 if (EQ (attr, QCbackground))
3280 param = Qborder_color;
3282 else if (EQ (face, Qcursor))
3284 /* Changing background color of `cursor' sets frame parameter
3285 `cursor-color'. */
3286 if (EQ (attr, QCbackground))
3287 param = Qcursor_color;
3289 else if (EQ (face, Qmouse))
3291 /* Changing background color of `mouse' sets frame parameter
3292 `mouse-color'. */
3293 if (EQ (attr, QCbackground))
3294 param = Qmouse_color;
3296 #endif /* HAVE_WINDOW_SYSTEM */
3297 else if (EQ (face, Qmenu))
3299 /* Indicate that we have to update the menu bar when
3300 realizing faces on FRAME. FRAME t change the
3301 default for new frames. We do this by setting
3302 setting the flag in new face caches */
3303 if (FRAMEP (frame))
3305 struct frame *f = XFRAME (frame);
3306 if (FRAME_FACE_CACHE (f) == NULL)
3307 FRAME_FACE_CACHE (f) = make_face_cache (f);
3308 FRAME_FACE_CACHE (f)->menu_face_changed_p = 1;
3310 else
3311 menu_face_changed_default = 1;
3314 if (!NILP (param))
3316 if (EQ (frame, Qt))
3317 /* Update `default-frame-alist', which is used for new frames. */
3319 store_in_alist (&Vdefault_frame_alist, param, value);
3321 else
3322 /* Update the current frame's parameters. */
3324 Lisp_Object cons;
3325 cons = XCAR (Vparam_value_alist);
3326 XSETCAR (cons, param);
3327 XSETCDR (cons, value);
3328 Fmodify_frame_parameters (frame, Vparam_value_alist);
3333 return face;
3337 /* Update the corresponding face when frame parameter PARAM on frame F
3338 has been assigned the value NEW_VALUE. */
3340 void
3341 update_face_from_frame_parameter (struct frame *f, Lisp_Object param,
3342 Lisp_Object new_value)
3344 Lisp_Object face = Qnil;
3345 Lisp_Object lface;
3347 /* If there are no faces yet, give up. This is the case when called
3348 from Fx_create_frame, and we do the necessary things later in
3349 face-set-after-frame-defaults. */
3350 if (NILP (f->face_alist))
3351 return;
3353 if (EQ (param, Qforeground_color))
3355 face = Qdefault;
3356 lface = lface_from_face_name (f, face, 1);
3357 LFACE_FOREGROUND (lface) = (STRINGP (new_value)
3358 ? new_value : Qunspecified);
3359 realize_basic_faces (f);
3361 else if (EQ (param, Qbackground_color))
3363 Lisp_Object frame;
3365 /* Changing the background color might change the background
3366 mode, so that we have to load new defface specs.
3367 Call frame-set-background-mode to do that. */
3368 XSETFRAME (frame, f);
3369 call1 (Qframe_set_background_mode, frame);
3371 face = Qdefault;
3372 lface = lface_from_face_name (f, face, 1);
3373 LFACE_BACKGROUND (lface) = (STRINGP (new_value)
3374 ? new_value : Qunspecified);
3375 realize_basic_faces (f);
3377 #ifdef HAVE_WINDOW_SYSTEM
3378 else if (EQ (param, Qborder_color))
3380 face = Qborder;
3381 lface = lface_from_face_name (f, face, 1);
3382 LFACE_BACKGROUND (lface) = (STRINGP (new_value)
3383 ? new_value : Qunspecified);
3385 else if (EQ (param, Qcursor_color))
3387 face = Qcursor;
3388 lface = lface_from_face_name (f, face, 1);
3389 LFACE_BACKGROUND (lface) = (STRINGP (new_value)
3390 ? new_value : Qunspecified);
3392 else if (EQ (param, Qmouse_color))
3394 face = Qmouse;
3395 lface = lface_from_face_name (f, face, 1);
3396 LFACE_BACKGROUND (lface) = (STRINGP (new_value)
3397 ? new_value : Qunspecified);
3399 #endif
3401 /* Changing a named face means that all realized faces depending on
3402 that face are invalid. Since we cannot tell which realized faces
3403 depend on the face, make sure they are all removed. This is done
3404 by incrementing face_change_count. The next call to
3405 init_iterator will then free realized faces. */
3406 if (!NILP (face)
3407 && NILP (Fget (face, Qface_no_inherit)))
3409 ++face_change_count;
3410 ++windows_or_buffers_changed;
3415 #ifdef HAVE_WINDOW_SYSTEM
3417 /* Set the `font' frame parameter of FRAME determined from the
3418 font-object set in `default' face attributes LFACE. */
3420 static void
3421 set_font_frame_param (Lisp_Object frame, Lisp_Object lface)
3423 struct frame *f = XFRAME (frame);
3424 Lisp_Object font;
3426 if (FRAME_WINDOW_P (f)
3427 /* Don't do anything if the font is `unspecified'. This can
3428 happen during frame creation. */
3429 && (font = LFACE_FONT (lface),
3430 ! UNSPECIFIEDP (font)))
3432 if (FONT_SPEC_P (font))
3434 font = font_load_for_lface (f, XVECTOR (lface)->contents, font);
3435 if (NILP (font))
3436 return;
3437 LFACE_FONT (lface) = font;
3439 f->default_face_done_p = 0;
3440 Fmodify_frame_parameters (frame, Fcons (Fcons (Qfont, font), Qnil));
3445 /* Get the value of X resource RESOURCE, class CLASS for the display
3446 of frame FRAME. This is here because ordinary `x-get-resource'
3447 doesn't take a frame argument. */
3449 DEFUN ("internal-face-x-get-resource", Finternal_face_x_get_resource,
3450 Sinternal_face_x_get_resource, 3, 3, 0, doc: /* */)
3451 (Lisp_Object resource, Lisp_Object class, Lisp_Object frame)
3453 Lisp_Object value = Qnil;
3454 CHECK_STRING (resource);
3455 CHECK_STRING (class);
3456 CHECK_LIVE_FRAME (frame);
3457 BLOCK_INPUT;
3458 value = display_x_get_resource (FRAME_X_DISPLAY_INFO (XFRAME (frame)),
3459 resource, class, Qnil, Qnil);
3460 UNBLOCK_INPUT;
3461 return value;
3465 /* Return resource string VALUE as a boolean value, i.e. nil, or t.
3466 If VALUE is "on" or "true", return t. If VALUE is "off" or
3467 "false", return nil. Otherwise, if SIGNAL_P is non-zero, signal an
3468 error; if SIGNAL_P is zero, return 0. */
3470 static Lisp_Object
3471 face_boolean_x_resource_value (Lisp_Object value, int signal_p)
3473 Lisp_Object result = make_number (0);
3475 xassert (STRINGP (value));
3477 if (xstrcasecmp (SSDATA (value), "on") == 0
3478 || xstrcasecmp (SSDATA (value), "true") == 0)
3479 result = Qt;
3480 else if (xstrcasecmp (SSDATA (value), "off") == 0
3481 || xstrcasecmp (SSDATA (value), "false") == 0)
3482 result = Qnil;
3483 else if (xstrcasecmp (SSDATA (value), "unspecified") == 0)
3484 result = Qunspecified;
3485 else if (signal_p)
3486 signal_error ("Invalid face attribute value from X resource", value);
3488 return result;
3492 DEFUN ("internal-set-lisp-face-attribute-from-resource",
3493 Finternal_set_lisp_face_attribute_from_resource,
3494 Sinternal_set_lisp_face_attribute_from_resource,
3495 3, 4, 0, doc: /* */)
3496 (Lisp_Object face, Lisp_Object attr, Lisp_Object value, Lisp_Object frame)
3498 CHECK_SYMBOL (face);
3499 CHECK_SYMBOL (attr);
3500 CHECK_STRING (value);
3502 if (xstrcasecmp (SSDATA (value), "unspecified") == 0)
3503 value = Qunspecified;
3504 else if (EQ (attr, QCheight))
3506 value = Fstring_to_number (value, make_number (10));
3507 if (XINT (value) <= 0)
3508 signal_error ("Invalid face height from X resource", value);
3510 else if (EQ (attr, QCbold) || EQ (attr, QCitalic))
3511 value = face_boolean_x_resource_value (value, 1);
3512 else if (EQ (attr, QCweight) || EQ (attr, QCslant) || EQ (attr, QCwidth))
3513 value = intern (SSDATA (value));
3514 else if (EQ (attr, QCreverse_video) || EQ (attr, QCinverse_video))
3515 value = face_boolean_x_resource_value (value, 1);
3516 else if (EQ (attr, QCunderline)
3517 || EQ (attr, QCoverline)
3518 || EQ (attr, QCstrike_through))
3520 Lisp_Object boolean_value;
3522 /* If the result of face_boolean_x_resource_value is t or nil,
3523 VALUE does NOT specify a color. */
3524 boolean_value = face_boolean_x_resource_value (value, 0);
3525 if (SYMBOLP (boolean_value))
3526 value = boolean_value;
3528 else if (EQ (attr, QCbox) || EQ (attr, QCinherit))
3529 value = Fcar (Fread_from_string (value, Qnil, Qnil));
3531 return Finternal_set_lisp_face_attribute (face, attr, value, frame);
3534 #endif /* HAVE_WINDOW_SYSTEM */
3537 /***********************************************************************
3538 Menu face
3539 ***********************************************************************/
3541 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
3543 /* Make menus on frame F appear as specified by the `menu' face. */
3545 static void
3546 x_update_menu_appearance (struct frame *f)
3548 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3549 XrmDatabase rdb;
3551 if (dpyinfo
3552 && (rdb = XrmGetDatabase (FRAME_X_DISPLAY (f)),
3553 rdb != NULL))
3555 char line[512];
3556 char *buf = line;
3557 ptrdiff_t bufsize = sizeof line;
3558 Lisp_Object lface = lface_from_face_name (f, Qmenu, 1);
3559 struct face *face = FACE_FROM_ID (f, MENU_FACE_ID);
3560 const char *myname = SSDATA (Vx_resource_name);
3561 int changed_p = 0;
3562 #ifdef USE_MOTIF
3563 const char *popup_path = "popup_menu";
3564 #else
3565 const char *popup_path = "menu.popup";
3566 #endif
3568 if (STRINGP (LFACE_FOREGROUND (lface)))
3570 exprintf (&buf, &bufsize, line, -1, "%s.%s*foreground: %s",
3571 myname, popup_path,
3572 SDATA (LFACE_FOREGROUND (lface)));
3573 XrmPutLineResource (&rdb, line);
3574 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*foreground: %s",
3575 myname, SDATA (LFACE_FOREGROUND (lface)));
3576 XrmPutLineResource (&rdb, line);
3577 changed_p = 1;
3580 if (STRINGP (LFACE_BACKGROUND (lface)))
3582 exprintf (&buf, &bufsize, line, -1, "%s.%s*background: %s",
3583 myname, popup_path,
3584 SDATA (LFACE_BACKGROUND (lface)));
3585 XrmPutLineResource (&rdb, line);
3587 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*background: %s",
3588 myname, SDATA (LFACE_BACKGROUND (lface)));
3589 XrmPutLineResource (&rdb, line);
3590 changed_p = 1;
3593 if (face->font
3594 /* On Solaris 5.8, it's been reported that the `menu' face
3595 can be unspecified here, during startup. Why this
3596 happens remains unknown. -- cyd */
3597 && FONTP (LFACE_FONT (lface))
3598 && (!UNSPECIFIEDP (LFACE_FAMILY (lface))
3599 || !UNSPECIFIEDP (LFACE_FOUNDRY (lface))
3600 || !UNSPECIFIEDP (LFACE_SWIDTH (lface))
3601 || !UNSPECIFIEDP (LFACE_WEIGHT (lface))
3602 || !UNSPECIFIEDP (LFACE_SLANT (lface))
3603 || !UNSPECIFIEDP (LFACE_HEIGHT (lface))))
3605 Lisp_Object xlfd = Ffont_xlfd_name (LFACE_FONT (lface), Qnil);
3606 #ifdef USE_MOTIF
3607 const char *suffix = "List";
3608 Bool motif = True;
3609 #else
3610 #if defined HAVE_X_I18N
3612 const char *suffix = "Set";
3613 #else
3614 const char *suffix = "";
3615 #endif
3616 Bool motif = False;
3617 #endif
3619 if (! NILP (xlfd))
3621 #if defined HAVE_X_I18N
3622 char *fontsetname = xic_create_fontsetname (SSDATA (xlfd), motif);
3623 #else
3624 char *fontsetname = SSDATA (xlfd);
3625 #endif
3626 exprintf (&buf, &bufsize, line, -1, "%s.pane.menubar*font%s: %s",
3627 myname, suffix, fontsetname);
3628 XrmPutLineResource (&rdb, line);
3630 exprintf (&buf, &bufsize, line, -1, "%s.%s*font%s: %s",
3631 myname, popup_path, suffix, fontsetname);
3632 XrmPutLineResource (&rdb, line);
3633 changed_p = 1;
3634 if (fontsetname != SSDATA (xlfd))
3635 xfree (fontsetname);
3639 if (changed_p && f->output_data.x->menubar_widget)
3640 free_frame_menubar (f);
3642 if (buf != line)
3643 xfree (buf);
3647 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
3650 DEFUN ("face-attribute-relative-p", Fface_attribute_relative_p,
3651 Sface_attribute_relative_p,
3652 2, 2, 0,
3653 doc: /* Check whether a face attribute value is relative.
3654 Specifically, this function returns t if the attribute ATTRIBUTE
3655 with the value VALUE is relative.
3657 A relative value is one that doesn't entirely override whatever is
3658 inherited from another face. For most possible attributes,
3659 the only relative value that users see is `unspecified'.
3660 However, for :height, floating point values are also relative. */)
3661 (Lisp_Object attribute, Lisp_Object value)
3663 if (EQ (value, Qunspecified) || (EQ (value, QCignore_defface)))
3664 return Qt;
3665 else if (EQ (attribute, QCheight))
3666 return INTEGERP (value) ? Qnil : Qt;
3667 else
3668 return Qnil;
3671 DEFUN ("merge-face-attribute", Fmerge_face_attribute, Smerge_face_attribute,
3672 3, 3, 0,
3673 doc: /* Return face ATTRIBUTE VALUE1 merged with VALUE2.
3674 If VALUE1 or VALUE2 are absolute (see `face-attribute-relative-p'), then
3675 the result will be absolute, otherwise it will be relative. */)
3676 (Lisp_Object attribute, Lisp_Object value1, Lisp_Object value2)
3678 if (EQ (value1, Qunspecified) || EQ (value1, QCignore_defface))
3679 return value2;
3680 else if (EQ (attribute, QCheight))
3681 return merge_face_heights (value1, value2, value1);
3682 else
3683 return value1;
3687 DEFUN ("internal-get-lisp-face-attribute", Finternal_get_lisp_face_attribute,
3688 Sinternal_get_lisp_face_attribute,
3689 2, 3, 0,
3690 doc: /* Return face attribute KEYWORD of face SYMBOL.
3691 If SYMBOL does not name a valid Lisp face or KEYWORD isn't a valid
3692 face attribute name, signal an error.
3693 If the optional argument FRAME is given, report on face SYMBOL in that
3694 frame. If FRAME is t, report on the defaults for face SYMBOL (for new
3695 frames). If FRAME is omitted or nil, use the selected frame. */)
3696 (Lisp_Object symbol, Lisp_Object keyword, Lisp_Object frame)
3698 Lisp_Object lface, value = Qnil;
3700 CHECK_SYMBOL (symbol);
3701 CHECK_SYMBOL (keyword);
3703 if (EQ (frame, Qt))
3704 lface = lface_from_face_name (NULL, symbol, 1);
3705 else
3707 if (NILP (frame))
3708 frame = selected_frame;
3709 CHECK_LIVE_FRAME (frame);
3710 lface = lface_from_face_name (XFRAME (frame), symbol, 1);
3713 if (EQ (keyword, QCfamily))
3714 value = LFACE_FAMILY (lface);
3715 else if (EQ (keyword, QCfoundry))
3716 value = LFACE_FOUNDRY (lface);
3717 else if (EQ (keyword, QCheight))
3718 value = LFACE_HEIGHT (lface);
3719 else if (EQ (keyword, QCweight))
3720 value = LFACE_WEIGHT (lface);
3721 else if (EQ (keyword, QCslant))
3722 value = LFACE_SLANT (lface);
3723 else if (EQ (keyword, QCunderline))
3724 value = LFACE_UNDERLINE (lface);
3725 else if (EQ (keyword, QCoverline))
3726 value = LFACE_OVERLINE (lface);
3727 else if (EQ (keyword, QCstrike_through))
3728 value = LFACE_STRIKE_THROUGH (lface);
3729 else if (EQ (keyword, QCbox))
3730 value = LFACE_BOX (lface);
3731 else if (EQ (keyword, QCinverse_video)
3732 || EQ (keyword, QCreverse_video))
3733 value = LFACE_INVERSE (lface);
3734 else if (EQ (keyword, QCforeground))
3735 value = LFACE_FOREGROUND (lface);
3736 else if (EQ (keyword, QCbackground))
3737 value = LFACE_BACKGROUND (lface);
3738 else if (EQ (keyword, QCstipple))
3739 value = LFACE_STIPPLE (lface);
3740 else if (EQ (keyword, QCwidth))
3741 value = LFACE_SWIDTH (lface);
3742 else if (EQ (keyword, QCinherit))
3743 value = LFACE_INHERIT (lface);
3744 else if (EQ (keyword, QCfont))
3745 value = LFACE_FONT (lface);
3746 else if (EQ (keyword, QCfontset))
3747 value = LFACE_FONTSET (lface);
3748 else
3749 signal_error ("Invalid face attribute name", keyword);
3751 if (IGNORE_DEFFACE_P (value))
3752 return Qunspecified;
3754 return value;
3758 DEFUN ("internal-lisp-face-attribute-values",
3759 Finternal_lisp_face_attribute_values,
3760 Sinternal_lisp_face_attribute_values, 1, 1, 0,
3761 doc: /* Return a list of valid discrete values for face attribute ATTR.
3762 Value is nil if ATTR doesn't have a discrete set of valid values. */)
3763 (Lisp_Object attr)
3765 Lisp_Object result = Qnil;
3767 CHECK_SYMBOL (attr);
3769 if (EQ (attr, QCunderline))
3770 result = Fcons (Qt, Fcons (Qnil, Qnil));
3771 else if (EQ (attr, QCoverline))
3772 result = Fcons (Qt, Fcons (Qnil, Qnil));
3773 else if (EQ (attr, QCstrike_through))
3774 result = Fcons (Qt, Fcons (Qnil, Qnil));
3775 else if (EQ (attr, QCinverse_video) || EQ (attr, QCreverse_video))
3776 result = Fcons (Qt, Fcons (Qnil, Qnil));
3778 return result;
3782 DEFUN ("internal-merge-in-global-face", Finternal_merge_in_global_face,
3783 Sinternal_merge_in_global_face, 2, 2, 0,
3784 doc: /* Add attributes from frame-default definition of FACE to FACE on FRAME.
3785 Default face attributes override any local face attributes. */)
3786 (Lisp_Object face, Lisp_Object frame)
3788 int i;
3789 Lisp_Object global_lface, local_lface, *gvec, *lvec;
3790 struct frame *f = XFRAME (frame);
3792 CHECK_LIVE_FRAME (frame);
3793 global_lface = lface_from_face_name (NULL, face, 1);
3794 local_lface = lface_from_face_name (f, face, 0);
3795 if (NILP (local_lface))
3796 local_lface = Finternal_make_lisp_face (face, frame);
3798 /* Make every specified global attribute override the local one.
3799 BEWARE!! This is only used from `face-set-after-frame-default' where
3800 the local frame is defined from default specs in `face-defface-spec'
3801 and those should be overridden by global settings. Hence the strange
3802 "global before local" priority. */
3803 lvec = XVECTOR (local_lface)->contents;
3804 gvec = XVECTOR (global_lface)->contents;
3805 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3806 if (IGNORE_DEFFACE_P (gvec[i]))
3807 lvec[i] = Qunspecified;
3808 else if (! UNSPECIFIEDP (gvec[i]))
3809 lvec[i] = gvec[i];
3811 /* If the default face was changed, update the face cache and the
3812 `font' frame parameter. */
3813 if (EQ (face, Qdefault))
3815 struct face_cache *c = FRAME_FACE_CACHE (f);
3816 struct face *newface, *oldface = FACE_FROM_ID (f, DEFAULT_FACE_ID);
3817 Lisp_Object attrs[LFACE_VECTOR_SIZE];
3819 /* This can be NULL (e.g., in batch mode). */
3820 if (oldface)
3822 /* Ensure that the face vector is fully specified by merging
3823 the previously-cached vector. */
3824 memcpy (attrs, oldface->lface, sizeof attrs);
3825 merge_face_vectors (f, lvec, attrs, 0);
3826 memcpy (lvec, attrs, sizeof attrs);
3827 newface = realize_face (c, lvec, DEFAULT_FACE_ID);
3829 if ((! UNSPECIFIEDP (gvec[LFACE_FAMILY_INDEX])
3830 || ! UNSPECIFIEDP (gvec[LFACE_FOUNDRY_INDEX])
3831 || ! UNSPECIFIEDP (gvec[LFACE_HEIGHT_INDEX])
3832 || ! UNSPECIFIEDP (gvec[LFACE_WEIGHT_INDEX])
3833 || ! UNSPECIFIEDP (gvec[LFACE_SLANT_INDEX])
3834 || ! UNSPECIFIEDP (gvec[LFACE_SWIDTH_INDEX])
3835 || ! UNSPECIFIEDP (gvec[LFACE_FONT_INDEX]))
3836 && newface->font)
3838 Lisp_Object name = newface->font->props[FONT_NAME_INDEX];
3839 Fmodify_frame_parameters (frame, Fcons (Fcons (Qfont, name),
3840 Qnil));
3843 if (STRINGP (gvec[LFACE_FOREGROUND_INDEX]))
3844 Fmodify_frame_parameters (frame,
3845 Fcons (Fcons (Qforeground_color,
3846 gvec[LFACE_FOREGROUND_INDEX]),
3847 Qnil));
3849 if (STRINGP (gvec[LFACE_BACKGROUND_INDEX]))
3850 Fmodify_frame_parameters (frame,
3851 Fcons (Fcons (Qbackground_color,
3852 gvec[LFACE_BACKGROUND_INDEX]),
3853 Qnil));
3857 return Qnil;
3861 /* The following function is implemented for compatibility with 20.2.
3862 The function is used in x-resolve-fonts when it is asked to
3863 return fonts with the same size as the font of a face. This is
3864 done in fontset.el. */
3866 DEFUN ("face-font", Fface_font, Sface_font, 1, 3, 0,
3867 doc: /* Return the font name of face FACE, or nil if it is unspecified.
3868 The font name is, by default, for ASCII characters.
3869 If the optional argument FRAME is given, report on face FACE in that frame.
3870 If FRAME is t, report on the defaults for face FACE (for new frames).
3871 The font default for a face is either nil, or a list
3872 of the form (bold), (italic) or (bold italic).
3873 If FRAME is omitted or nil, use the selected frame. And, in this case,
3874 if the optional third argument CHARACTER is given,
3875 return the font name used for CHARACTER. */)
3876 (Lisp_Object face, Lisp_Object frame, Lisp_Object character)
3878 if (EQ (frame, Qt))
3880 Lisp_Object result = Qnil;
3881 Lisp_Object lface = lface_from_face_name (NULL, face, 1);
3883 if (!UNSPECIFIEDP (LFACE_WEIGHT (lface))
3884 && !EQ (LFACE_WEIGHT (lface), Qnormal))
3885 result = Fcons (Qbold, result);
3887 if (!UNSPECIFIEDP (LFACE_SLANT (lface))
3888 && !EQ (LFACE_SLANT (lface), Qnormal))
3889 result = Fcons (Qitalic, result);
3891 return result;
3893 else
3895 struct frame *f = frame_or_selected_frame (frame, 1);
3896 int face_id = lookup_named_face (f, face, 1);
3897 struct face *fface = FACE_FROM_ID (f, face_id);
3899 if (! fface)
3900 return Qnil;
3901 #ifdef HAVE_WINDOW_SYSTEM
3902 if (FRAME_WINDOW_P (f) && !NILP (character))
3904 CHECK_CHARACTER (character);
3905 face_id = FACE_FOR_CHAR (f, fface, XINT (character), -1, Qnil);
3906 fface = FACE_FROM_ID (f, face_id);
3908 return (fface->font
3909 ? fface->font->props[FONT_NAME_INDEX]
3910 : Qnil);
3911 #else /* !HAVE_WINDOW_SYSTEM */
3912 return build_string (FRAME_MSDOS_P (f)
3913 ? "ms-dos"
3914 : FRAME_W32_P (f) ? "w32term"
3915 :"tty");
3916 #endif
3921 /* Compare face-attribute values v1 and v2 for equality. Value is non-zero if
3922 all attributes are `equal'. Tries to be fast because this function
3923 is called quite often. */
3925 static inline int
3926 face_attr_equal_p (Lisp_Object v1, Lisp_Object v2)
3928 /* Type can differ, e.g. when one attribute is unspecified, i.e. nil,
3929 and the other is specified. */
3930 if (XTYPE (v1) != XTYPE (v2))
3931 return 0;
3933 if (EQ (v1, v2))
3934 return 1;
3936 switch (XTYPE (v1))
3938 case Lisp_String:
3939 if (SBYTES (v1) != SBYTES (v2))
3940 return 0;
3942 return memcmp (SDATA (v1), SDATA (v2), SBYTES (v1)) == 0;
3944 case_Lisp_Int:
3945 case Lisp_Symbol:
3946 return 0;
3948 default:
3949 return !NILP (Fequal (v1, v2));
3954 /* Compare face vectors V1 and V2 for equality. Value is non-zero if
3955 all attributes are `equal'. Tries to be fast because this function
3956 is called quite often. */
3958 static inline int
3959 lface_equal_p (Lisp_Object *v1, Lisp_Object *v2)
3961 int i, equal_p = 1;
3963 for (i = 1; i < LFACE_VECTOR_SIZE && equal_p; ++i)
3964 equal_p = face_attr_equal_p (v1[i], v2[i]);
3966 return equal_p;
3970 DEFUN ("internal-lisp-face-equal-p", Finternal_lisp_face_equal_p,
3971 Sinternal_lisp_face_equal_p, 2, 3, 0,
3972 doc: /* True if FACE1 and FACE2 are equal.
3973 If the optional argument FRAME is given, report on FACE1 and FACE2 in that frame.
3974 If FRAME is t, report on the defaults for FACE1 and FACE2 (for new frames).
3975 If FRAME is omitted or nil, use the selected frame. */)
3976 (Lisp_Object face1, Lisp_Object face2, Lisp_Object frame)
3978 int equal_p;
3979 struct frame *f;
3980 Lisp_Object lface1, lface2;
3982 if (EQ (frame, Qt))
3983 f = NULL;
3984 else
3985 /* Don't use check_x_frame here because this function is called
3986 before X frames exist. At that time, if FRAME is nil,
3987 selected_frame will be used which is the frame dumped with
3988 Emacs. That frame is not an X frame. */
3989 f = frame_or_selected_frame (frame, 2);
3991 lface1 = lface_from_face_name (f, face1, 1);
3992 lface2 = lface_from_face_name (f, face2, 1);
3993 equal_p = lface_equal_p (XVECTOR (lface1)->contents,
3994 XVECTOR (lface2)->contents);
3995 return equal_p ? Qt : Qnil;
3999 DEFUN ("internal-lisp-face-empty-p", Finternal_lisp_face_empty_p,
4000 Sinternal_lisp_face_empty_p, 1, 2, 0,
4001 doc: /* True if FACE has no attribute specified.
4002 If the optional argument FRAME is given, report on face FACE in that frame.
4003 If FRAME is t, report on the defaults for face FACE (for new frames).
4004 If FRAME is omitted or nil, use the selected frame. */)
4005 (Lisp_Object face, Lisp_Object frame)
4007 struct frame *f;
4008 Lisp_Object lface;
4009 int i;
4011 if (NILP (frame))
4012 frame = selected_frame;
4013 CHECK_LIVE_FRAME (frame);
4014 f = XFRAME (frame);
4016 if (EQ (frame, Qt))
4017 lface = lface_from_face_name (NULL, face, 1);
4018 else
4019 lface = lface_from_face_name (f, face, 1);
4021 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
4022 if (!UNSPECIFIEDP (AREF (lface, i)))
4023 break;
4025 return i == LFACE_VECTOR_SIZE ? Qt : Qnil;
4029 DEFUN ("frame-face-alist", Fframe_face_alist, Sframe_face_alist,
4030 0, 1, 0,
4031 doc: /* Return an alist of frame-local faces defined on FRAME.
4032 For internal use only. */)
4033 (Lisp_Object frame)
4035 struct frame *f = frame_or_selected_frame (frame, 0);
4036 return f->face_alist;
4040 /* Return a hash code for Lisp string STRING with case ignored. Used
4041 below in computing a hash value for a Lisp face. */
4043 static inline unsigned
4044 hash_string_case_insensitive (Lisp_Object string)
4046 const unsigned char *s;
4047 unsigned hash = 0;
4048 xassert (STRINGP (string));
4049 for (s = SDATA (string); *s; ++s)
4050 hash = (hash << 1) ^ tolower (*s);
4051 return hash;
4055 /* Return a hash code for face attribute vector V. */
4057 static inline unsigned
4058 lface_hash (Lisp_Object *v)
4060 return (hash_string_case_insensitive (v[LFACE_FAMILY_INDEX])
4061 ^ hash_string_case_insensitive (v[LFACE_FOUNDRY_INDEX])
4062 ^ hash_string_case_insensitive (v[LFACE_FOREGROUND_INDEX])
4063 ^ hash_string_case_insensitive (v[LFACE_BACKGROUND_INDEX])
4064 ^ XHASH (v[LFACE_WEIGHT_INDEX])
4065 ^ XHASH (v[LFACE_SLANT_INDEX])
4066 ^ XHASH (v[LFACE_SWIDTH_INDEX])
4067 ^ XHASH (v[LFACE_HEIGHT_INDEX]));
4071 /* Return non-zero if LFACE1 and LFACE2 specify the same font (without
4072 considering charsets/registries). They do if they specify the same
4073 family, point size, weight, width, slant, and font. Both
4074 LFACE1 and LFACE2 must be fully-specified. */
4076 static inline int
4077 lface_same_font_attributes_p (Lisp_Object *lface1, Lisp_Object *lface2)
4079 xassert (lface_fully_specified_p (lface1)
4080 && lface_fully_specified_p (lface2));
4081 return (xstrcasecmp (SSDATA (lface1[LFACE_FAMILY_INDEX]),
4082 SSDATA (lface2[LFACE_FAMILY_INDEX])) == 0
4083 && xstrcasecmp (SSDATA (lface1[LFACE_FOUNDRY_INDEX]),
4084 SSDATA (lface2[LFACE_FOUNDRY_INDEX])) == 0
4085 && EQ (lface1[LFACE_HEIGHT_INDEX], lface2[LFACE_HEIGHT_INDEX])
4086 && EQ (lface1[LFACE_SWIDTH_INDEX], lface2[LFACE_SWIDTH_INDEX])
4087 && EQ (lface1[LFACE_WEIGHT_INDEX], lface2[LFACE_WEIGHT_INDEX])
4088 && EQ (lface1[LFACE_SLANT_INDEX], lface2[LFACE_SLANT_INDEX])
4089 && EQ (lface1[LFACE_FONT_INDEX], lface2[LFACE_FONT_INDEX])
4090 && (EQ (lface1[LFACE_FONTSET_INDEX], lface2[LFACE_FONTSET_INDEX])
4091 || (STRINGP (lface1[LFACE_FONTSET_INDEX])
4092 && STRINGP (lface2[LFACE_FONTSET_INDEX])
4093 && ! xstrcasecmp (SSDATA (lface1[LFACE_FONTSET_INDEX]),
4094 SSDATA (lface2[LFACE_FONTSET_INDEX]))))
4100 /***********************************************************************
4101 Realized Faces
4102 ***********************************************************************/
4104 /* Allocate and return a new realized face for Lisp face attribute
4105 vector ATTR. */
4107 static struct face *
4108 make_realized_face (Lisp_Object *attr)
4110 struct face *face = (struct face *) xmalloc (sizeof *face);
4111 memset (face, 0, sizeof *face);
4112 face->ascii_face = face;
4113 memcpy (face->lface, attr, sizeof face->lface);
4114 return face;
4118 /* Free realized face FACE, including its X resources. FACE may
4119 be null. */
4121 static void
4122 free_realized_face (struct frame *f, struct face *face)
4124 if (face)
4126 #ifdef HAVE_WINDOW_SYSTEM
4127 if (FRAME_WINDOW_P (f))
4129 /* Free fontset of FACE if it is ASCII face. */
4130 if (face->fontset >= 0 && face == face->ascii_face)
4131 free_face_fontset (f, face);
4132 if (face->gc)
4134 BLOCK_INPUT;
4135 if (face->font)
4136 font_done_for_face (f, face);
4137 x_free_gc (f, face->gc);
4138 face->gc = 0;
4139 UNBLOCK_INPUT;
4142 free_face_colors (f, face);
4143 x_destroy_bitmap (f, face->stipple);
4145 #endif /* HAVE_WINDOW_SYSTEM */
4147 xfree (face);
4152 /* Prepare face FACE for subsequent display on frame F. This
4153 allocated GCs if they haven't been allocated yet or have been freed
4154 by clearing the face cache. */
4156 void
4157 prepare_face_for_display (struct frame *f, struct face *face)
4159 #ifdef HAVE_WINDOW_SYSTEM
4160 xassert (FRAME_WINDOW_P (f));
4162 if (face->gc == 0)
4164 XGCValues xgcv;
4165 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
4167 xgcv.foreground = face->foreground;
4168 xgcv.background = face->background;
4169 #ifdef HAVE_X_WINDOWS
4170 xgcv.graphics_exposures = False;
4171 #endif
4173 BLOCK_INPUT;
4174 #ifdef HAVE_X_WINDOWS
4175 if (face->stipple)
4177 xgcv.fill_style = FillOpaqueStippled;
4178 xgcv.stipple = x_bitmap_pixmap (f, face->stipple);
4179 mask |= GCFillStyle | GCStipple;
4181 #endif
4182 face->gc = x_create_gc (f, mask, &xgcv);
4183 if (face->font)
4184 font_prepare_for_face (f, face);
4185 UNBLOCK_INPUT;
4187 #endif /* HAVE_WINDOW_SYSTEM */
4191 /* Returns the `distance' between the colors X and Y. */
4193 static int
4194 color_distance (XColor *x, XColor *y)
4196 /* This formula is from a paper titled `Colour metric' by Thiadmer Riemersma.
4197 Quoting from that paper:
4199 This formula has results that are very close to L*u*v* (with the
4200 modified lightness curve) and, more importantly, it is a more even
4201 algorithm: it does not have a range of colors where it suddenly
4202 gives far from optimal results.
4204 See <http://www.compuphase.com/cmetric.htm> for more info. */
4206 long r = (x->red - y->red) >> 8;
4207 long g = (x->green - y->green) >> 8;
4208 long b = (x->blue - y->blue) >> 8;
4209 long r_mean = (x->red + y->red) >> 9;
4211 return
4212 (((512 + r_mean) * r * r) >> 8)
4213 + 4 * g * g
4214 + (((767 - r_mean) * b * b) >> 8);
4218 DEFUN ("color-distance", Fcolor_distance, Scolor_distance, 2, 3, 0,
4219 doc: /* Return an integer distance between COLOR1 and COLOR2 on FRAME.
4220 COLOR1 and COLOR2 may be either strings containing the color name,
4221 or lists of the form (RED GREEN BLUE).
4222 If FRAME is unspecified or nil, the current frame is used. */)
4223 (Lisp_Object color1, Lisp_Object color2, Lisp_Object frame)
4225 struct frame *f;
4226 XColor cdef1, cdef2;
4228 if (NILP (frame))
4229 frame = selected_frame;
4230 CHECK_LIVE_FRAME (frame);
4231 f = XFRAME (frame);
4233 if (!(CONSP (color1) && parse_rgb_list (color1, &cdef1))
4234 && !(STRINGP (color1) && defined_color (f, SSDATA (color1), &cdef1, 0)))
4235 signal_error ("Invalid color", color1);
4236 if (!(CONSP (color2) && parse_rgb_list (color2, &cdef2))
4237 && !(STRINGP (color2) && defined_color (f, SSDATA (color2), &cdef2, 0)))
4238 signal_error ("Invalid color", color2);
4240 return make_number (color_distance (&cdef1, &cdef2));
4244 /***********************************************************************
4245 Face Cache
4246 ***********************************************************************/
4248 /* Return a new face cache for frame F. */
4250 static struct face_cache *
4251 make_face_cache (struct frame *f)
4253 struct face_cache *c;
4254 int size;
4256 c = (struct face_cache *) xmalloc (sizeof *c);
4257 memset (c, 0, sizeof *c);
4258 size = FACE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
4259 c->buckets = (struct face **) xmalloc (size);
4260 memset (c->buckets, 0, size);
4261 c->size = 50;
4262 c->faces_by_id = (struct face **) xmalloc (c->size * sizeof *c->faces_by_id);
4263 c->f = f;
4264 c->menu_face_changed_p = menu_face_changed_default;
4265 return c;
4269 /* Clear out all graphics contexts for all realized faces, except for
4270 the basic faces. This should be done from time to time just to avoid
4271 keeping too many graphics contexts that are no longer needed. */
4273 static void
4274 clear_face_gcs (struct face_cache *c)
4276 if (c && FRAME_WINDOW_P (c->f))
4278 #ifdef HAVE_WINDOW_SYSTEM
4279 int i;
4280 for (i = BASIC_FACE_ID_SENTINEL; i < c->used; ++i)
4282 struct face *face = c->faces_by_id[i];
4283 if (face && face->gc)
4285 BLOCK_INPUT;
4286 if (face->font)
4287 font_done_for_face (c->f, face);
4288 x_free_gc (c->f, face->gc);
4289 face->gc = 0;
4290 UNBLOCK_INPUT;
4293 #endif /* HAVE_WINDOW_SYSTEM */
4298 /* Free all realized faces in face cache C, including basic faces.
4299 C may be null. If faces are freed, make sure the frame's current
4300 matrix is marked invalid, so that a display caused by an expose
4301 event doesn't try to use faces we destroyed. */
4303 static void
4304 free_realized_faces (struct face_cache *c)
4306 if (c && c->used)
4308 int i, size;
4309 struct frame *f = c->f;
4311 /* We must block input here because we can't process X events
4312 safely while only some faces are freed, or when the frame's
4313 current matrix still references freed faces. */
4314 BLOCK_INPUT;
4316 for (i = 0; i < c->used; ++i)
4318 free_realized_face (f, c->faces_by_id[i]);
4319 c->faces_by_id[i] = NULL;
4322 c->used = 0;
4323 size = FACE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
4324 memset (c->buckets, 0, size);
4326 /* Must do a thorough redisplay the next time. Mark current
4327 matrices as invalid because they will reference faces freed
4328 above. This function is also called when a frame is
4329 destroyed. In this case, the root window of F is nil. */
4330 if (WINDOWP (f->root_window))
4332 clear_current_matrices (f);
4333 ++windows_or_buffers_changed;
4336 UNBLOCK_INPUT;
4341 /* Free all realized faces on FRAME or on all frames if FRAME is nil.
4342 This is done after attributes of a named face have been changed,
4343 because we can't tell which realized faces depend on that face. */
4345 void
4346 free_all_realized_faces (Lisp_Object frame)
4348 if (NILP (frame))
4350 Lisp_Object rest;
4351 FOR_EACH_FRAME (rest, frame)
4352 free_realized_faces (FRAME_FACE_CACHE (XFRAME (frame)));
4354 else
4355 free_realized_faces (FRAME_FACE_CACHE (XFRAME (frame)));
4359 /* Free face cache C and faces in it, including their X resources. */
4361 static void
4362 free_face_cache (struct face_cache *c)
4364 if (c)
4366 free_realized_faces (c);
4367 xfree (c->buckets);
4368 xfree (c->faces_by_id);
4369 xfree (c);
4374 /* Cache realized face FACE in face cache C. HASH is the hash value
4375 of FACE. If FACE is for ASCII characters (i.e. FACE->ascii_face ==
4376 FACE), insert the new face to the beginning of the collision list
4377 of the face hash table of C. Otherwise, add the new face to the
4378 end of the collision list. This way, lookup_face can quickly find
4379 that a requested face is not cached. */
4381 static void
4382 cache_face (struct face_cache *c, struct face *face, unsigned int hash)
4384 int i = hash % FACE_CACHE_BUCKETS_SIZE;
4386 face->hash = hash;
4388 if (face->ascii_face != face)
4390 struct face *last = c->buckets[i];
4391 if (last)
4393 while (last->next)
4394 last = last->next;
4395 last->next = face;
4396 face->prev = last;
4397 face->next = NULL;
4399 else
4401 c->buckets[i] = face;
4402 face->prev = face->next = NULL;
4405 else
4407 face->prev = NULL;
4408 face->next = c->buckets[i];
4409 if (face->next)
4410 face->next->prev = face;
4411 c->buckets[i] = face;
4414 /* Find a free slot in C->faces_by_id and use the index of the free
4415 slot as FACE->id. */
4416 for (i = 0; i < c->used; ++i)
4417 if (c->faces_by_id[i] == NULL)
4418 break;
4419 face->id = i;
4421 #if GLYPH_DEBUG
4422 /* Check that FACE got a unique id. */
4424 int j, n;
4425 struct face *face1;
4427 for (j = n = 0; j < FACE_CACHE_BUCKETS_SIZE; ++j)
4428 for (face1 = c->buckets[j]; face1; face1 = face1->next)
4429 if (face1->id == i)
4430 ++n;
4432 xassert (n == 1);
4434 #endif /* GLYPH_DEBUG */
4436 /* Maybe enlarge C->faces_by_id. */
4437 if (i == c->used)
4439 if (c->used == c->size)
4440 c->faces_by_id = xpalloc (c->faces_by_id, &c->size, 1, MAX_FACE_ID,
4441 sizeof *c->faces_by_id);
4442 c->used++;
4445 c->faces_by_id[i] = face;
4449 /* Remove face FACE from cache C. */
4451 static void
4452 uncache_face (struct face_cache *c, struct face *face)
4454 int i = face->hash % FACE_CACHE_BUCKETS_SIZE;
4456 if (face->prev)
4457 face->prev->next = face->next;
4458 else
4459 c->buckets[i] = face->next;
4461 if (face->next)
4462 face->next->prev = face->prev;
4464 c->faces_by_id[face->id] = NULL;
4465 if (face->id == c->used)
4466 --c->used;
4470 /* Look up a realized face with face attributes ATTR in the face cache
4471 of frame F. The face will be used to display ASCII characters.
4472 Value is the ID of the face found. If no suitable face is found,
4473 realize a new one. */
4475 static inline int
4476 lookup_face (struct frame *f, Lisp_Object *attr)
4478 struct face_cache *cache = FRAME_FACE_CACHE (f);
4479 unsigned hash;
4480 int i;
4481 struct face *face;
4483 xassert (cache != NULL);
4484 check_lface_attrs (attr);
4486 /* Look up ATTR in the face cache. */
4487 hash = lface_hash (attr);
4488 i = hash % FACE_CACHE_BUCKETS_SIZE;
4490 for (face = cache->buckets[i]; face; face = face->next)
4492 if (face->ascii_face != face)
4494 /* There's no more ASCII face. */
4495 face = NULL;
4496 break;
4498 if (face->hash == hash
4499 && lface_equal_p (face->lface, attr))
4500 break;
4503 /* If not found, realize a new face. */
4504 if (face == NULL)
4505 face = realize_face (cache, attr, -1);
4507 #if GLYPH_DEBUG
4508 xassert (face == FACE_FROM_ID (f, face->id));
4509 #endif /* GLYPH_DEBUG */
4511 return face->id;
4514 #ifdef HAVE_WINDOW_SYSTEM
4515 /* Look up a realized face that has the same attributes as BASE_FACE
4516 except for the font in the face cache of frame F. If FONT-OBJECT
4517 is not nil, it is an already opened font. If FONT-OBJECT is nil,
4518 the face has no font. Value is the ID of the face found. If no
4519 suitable face is found, realize a new one. */
4522 face_for_font (struct frame *f, Lisp_Object font_object, struct face *base_face)
4524 struct face_cache *cache = FRAME_FACE_CACHE (f);
4525 unsigned hash;
4526 int i;
4527 struct face *face;
4529 xassert (cache != NULL);
4530 base_face = base_face->ascii_face;
4531 hash = lface_hash (base_face->lface);
4532 i = hash % FACE_CACHE_BUCKETS_SIZE;
4534 for (face = cache->buckets[i]; face; face = face->next)
4536 if (face->ascii_face == face)
4537 continue;
4538 if (face->ascii_face == base_face
4539 && face->font == (NILP (font_object) ? NULL
4540 : XFONT_OBJECT (font_object))
4541 && lface_equal_p (face->lface, base_face->lface))
4542 return face->id;
4545 /* If not found, realize a new face. */
4546 face = realize_non_ascii_face (f, font_object, base_face);
4547 return face->id;
4549 #endif /* HAVE_WINDOW_SYSTEM */
4551 /* Return the face id of the realized face for named face SYMBOL on
4552 frame F suitable for displaying ASCII characters. Value is -1 if
4553 the face couldn't be determined, which might happen if the default
4554 face isn't realized and cannot be realized. */
4557 lookup_named_face (struct frame *f, Lisp_Object symbol, int signal_p)
4559 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4560 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
4561 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
4563 if (default_face == NULL)
4565 if (!realize_basic_faces (f))
4566 return -1;
4567 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
4568 if (default_face == NULL)
4569 abort (); /* realize_basic_faces must have set it up */
4572 if (! get_lface_attributes (f, symbol, symbol_attrs, signal_p, 0))
4573 return -1;
4575 memcpy (attrs, default_face->lface, sizeof attrs);
4576 merge_face_vectors (f, symbol_attrs, attrs, 0);
4578 return lookup_face (f, attrs);
4582 /* Return the display face-id of the basic face whose canonical face-id
4583 is FACE_ID. The return value will usually simply be FACE_ID, unless that
4584 basic face has bee remapped via Vface_remapping_alist. This function is
4585 conservative: if something goes wrong, it will simply return FACE_ID
4586 rather than signal an error. */
4589 lookup_basic_face (struct frame *f, int face_id)
4591 Lisp_Object name, mapping;
4592 int remapped_face_id;
4594 if (NILP (Vface_remapping_alist))
4595 return face_id; /* Nothing to do. */
4597 switch (face_id)
4599 case DEFAULT_FACE_ID: name = Qdefault; break;
4600 case MODE_LINE_FACE_ID: name = Qmode_line; break;
4601 case MODE_LINE_INACTIVE_FACE_ID: name = Qmode_line_inactive; break;
4602 case HEADER_LINE_FACE_ID: name = Qheader_line; break;
4603 case TOOL_BAR_FACE_ID: name = Qtool_bar; break;
4604 case FRINGE_FACE_ID: name = Qfringe; break;
4605 case SCROLL_BAR_FACE_ID: name = Qscroll_bar; break;
4606 case BORDER_FACE_ID: name = Qborder; break;
4607 case CURSOR_FACE_ID: name = Qcursor; break;
4608 case MOUSE_FACE_ID: name = Qmouse; break;
4609 case MENU_FACE_ID: name = Qmenu; break;
4611 default:
4612 abort (); /* the caller is supposed to pass us a basic face id */
4615 /* Do a quick scan through Vface_remapping_alist, and return immediately
4616 if there is no remapping for face NAME. This is just an optimization
4617 for the very common no-remapping case. */
4618 mapping = assq_no_quit (name, Vface_remapping_alist);
4619 if (NILP (mapping))
4620 return face_id; /* Give up. */
4622 /* If there is a remapping entry, lookup the face using NAME, which will
4623 handle the remapping too. */
4624 remapped_face_id = lookup_named_face (f, name, 0);
4625 if (remapped_face_id < 0)
4626 return face_id; /* Give up. */
4628 return remapped_face_id;
4632 /* Return a face for charset ASCII that is like the face with id
4633 FACE_ID on frame F, but has a font that is STEPS steps smaller.
4634 STEPS < 0 means larger. Value is the id of the face. */
4637 smaller_face (struct frame *f, int face_id, int steps)
4639 #ifdef HAVE_WINDOW_SYSTEM
4640 struct face *face;
4641 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4642 int pt, last_pt, last_height;
4643 int delta;
4644 int new_face_id;
4645 struct face *new_face;
4647 /* If not called for an X frame, just return the original face. */
4648 if (FRAME_TERMCAP_P (f))
4649 return face_id;
4651 /* Try in increments of 1/2 pt. */
4652 delta = steps < 0 ? 5 : -5;
4653 steps = eabs (steps);
4655 face = FACE_FROM_ID (f, face_id);
4656 memcpy (attrs, face->lface, sizeof attrs);
4657 pt = last_pt = XFASTINT (attrs[LFACE_HEIGHT_INDEX]);
4658 new_face_id = face_id;
4659 last_height = FONT_HEIGHT (face->font);
4661 while (steps
4662 && pt + delta > 0
4663 /* Give up if we cannot find a font within 10pt. */
4664 && eabs (last_pt - pt) < 100)
4666 /* Look up a face for a slightly smaller/larger font. */
4667 pt += delta;
4668 attrs[LFACE_HEIGHT_INDEX] = make_number (pt);
4669 new_face_id = lookup_face (f, attrs);
4670 new_face = FACE_FROM_ID (f, new_face_id);
4672 /* If height changes, count that as one step. */
4673 if ((delta < 0 && FONT_HEIGHT (new_face->font) < last_height)
4674 || (delta > 0 && FONT_HEIGHT (new_face->font) > last_height))
4676 --steps;
4677 last_height = FONT_HEIGHT (new_face->font);
4678 last_pt = pt;
4682 return new_face_id;
4684 #else /* not HAVE_WINDOW_SYSTEM */
4686 return face_id;
4688 #endif /* not HAVE_WINDOW_SYSTEM */
4692 /* Return a face for charset ASCII that is like the face with id
4693 FACE_ID on frame F, but has height HEIGHT. */
4696 face_with_height (struct frame *f, int face_id, int height)
4698 #ifdef HAVE_WINDOW_SYSTEM
4699 struct face *face;
4700 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4702 if (FRAME_TERMCAP_P (f)
4703 || height <= 0)
4704 return face_id;
4706 face = FACE_FROM_ID (f, face_id);
4707 memcpy (attrs, face->lface, sizeof attrs);
4708 attrs[LFACE_HEIGHT_INDEX] = make_number (height);
4709 font_clear_prop (attrs, FONT_SIZE_INDEX);
4710 face_id = lookup_face (f, attrs);
4711 #endif /* HAVE_WINDOW_SYSTEM */
4713 return face_id;
4717 /* Return the face id of the realized face for named face SYMBOL on
4718 frame F suitable for displaying ASCII characters, and use
4719 attributes of the face FACE_ID for attributes that aren't
4720 completely specified by SYMBOL. This is like lookup_named_face,
4721 except that the default attributes come from FACE_ID, not from the
4722 default face. FACE_ID is assumed to be already realized. */
4725 lookup_derived_face (struct frame *f, Lisp_Object symbol, int face_id,
4726 int signal_p)
4728 Lisp_Object attrs[LFACE_VECTOR_SIZE];
4729 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
4730 struct face *default_face = FACE_FROM_ID (f, face_id);
4732 if (!default_face)
4733 abort ();
4735 if (!get_lface_attributes (f, symbol, symbol_attrs, signal_p, 0))
4736 return -1;
4738 memcpy (attrs, default_face->lface, sizeof attrs);
4739 merge_face_vectors (f, symbol_attrs, attrs, 0);
4740 return lookup_face (f, attrs);
4743 DEFUN ("face-attributes-as-vector", Fface_attributes_as_vector,
4744 Sface_attributes_as_vector, 1, 1, 0,
4745 doc: /* Return a vector of face attributes corresponding to PLIST. */)
4746 (Lisp_Object plist)
4748 Lisp_Object lface;
4749 lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
4750 Qunspecified);
4751 merge_face_ref (XFRAME (selected_frame), plist, XVECTOR (lface)->contents,
4752 1, 0);
4753 return lface;
4758 /***********************************************************************
4759 Face capability testing
4760 ***********************************************************************/
4763 /* If the distance (as returned by color_distance) between two colors is
4764 less than this, then they are considered the same, for determining
4765 whether a color is supported or not. The range of values is 0-65535. */
4767 #define TTY_SAME_COLOR_THRESHOLD 10000
4769 #ifdef HAVE_WINDOW_SYSTEM
4771 /* Return non-zero if all the face attributes in ATTRS are supported
4772 on the window-system frame F.
4774 The definition of `supported' is somewhat heuristic, but basically means
4775 that a face containing all the attributes in ATTRS, when merged with the
4776 default face for display, can be represented in a way that's
4778 \(1) different in appearance than the default face, and
4779 \(2) `close in spirit' to what the attributes specify, if not exact. */
4781 static int
4782 x_supports_face_attributes_p (struct frame *f, Lisp_Object *attrs,
4783 struct face *def_face)
4785 Lisp_Object *def_attrs = def_face->lface;
4787 /* Check that other specified attributes are different that the default
4788 face. */
4789 if ((!UNSPECIFIEDP (attrs[LFACE_UNDERLINE_INDEX])
4790 && face_attr_equal_p (attrs[LFACE_UNDERLINE_INDEX],
4791 def_attrs[LFACE_UNDERLINE_INDEX]))
4792 || (!UNSPECIFIEDP (attrs[LFACE_INVERSE_INDEX])
4793 && face_attr_equal_p (attrs[LFACE_INVERSE_INDEX],
4794 def_attrs[LFACE_INVERSE_INDEX]))
4795 || (!UNSPECIFIEDP (attrs[LFACE_FOREGROUND_INDEX])
4796 && face_attr_equal_p (attrs[LFACE_FOREGROUND_INDEX],
4797 def_attrs[LFACE_FOREGROUND_INDEX]))
4798 || (!UNSPECIFIEDP (attrs[LFACE_BACKGROUND_INDEX])
4799 && face_attr_equal_p (attrs[LFACE_BACKGROUND_INDEX],
4800 def_attrs[LFACE_BACKGROUND_INDEX]))
4801 || (!UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
4802 && face_attr_equal_p (attrs[LFACE_STIPPLE_INDEX],
4803 def_attrs[LFACE_STIPPLE_INDEX]))
4804 || (!UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
4805 && face_attr_equal_p (attrs[LFACE_OVERLINE_INDEX],
4806 def_attrs[LFACE_OVERLINE_INDEX]))
4807 || (!UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
4808 && face_attr_equal_p (attrs[LFACE_STRIKE_THROUGH_INDEX],
4809 def_attrs[LFACE_STRIKE_THROUGH_INDEX]))
4810 || (!UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
4811 && face_attr_equal_p (attrs[LFACE_BOX_INDEX],
4812 def_attrs[LFACE_BOX_INDEX])))
4813 return 0;
4815 /* Check font-related attributes, as those are the most commonly
4816 "unsupported" on a window-system (because of missing fonts). */
4817 if (!UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
4818 || !UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
4819 || !UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
4820 || !UNSPECIFIEDP (attrs[LFACE_WEIGHT_INDEX])
4821 || !UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX])
4822 || !UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX]))
4824 int face_id;
4825 struct face *face;
4826 Lisp_Object merged_attrs[LFACE_VECTOR_SIZE];
4827 int i;
4829 memcpy (merged_attrs, def_attrs, sizeof merged_attrs);
4831 merge_face_vectors (f, attrs, merged_attrs, 0);
4833 face_id = lookup_face (f, merged_attrs);
4834 face = FACE_FROM_ID (f, face_id);
4836 if (! face)
4837 error ("Cannot make face");
4839 /* If the font is the same, or no font is found, then not
4840 supported. */
4841 if (face->font == def_face->font
4842 || ! face->font)
4843 return 0;
4844 for (i = FONT_TYPE_INDEX; i <= FONT_SIZE_INDEX; i++)
4845 if (! EQ (face->font->props[i], def_face->font->props[i]))
4847 Lisp_Object s1, s2;
4849 if (i < FONT_FOUNDRY_INDEX || i > FONT_REGISTRY_INDEX
4850 || face->font->driver->case_sensitive)
4851 return 1;
4852 s1 = SYMBOL_NAME (face->font->props[i]);
4853 s2 = SYMBOL_NAME (def_face->font->props[i]);
4854 if (! EQ (Fcompare_strings (s1, make_number (0), Qnil,
4855 s2, make_number (0), Qnil, Qt), Qt))
4856 return 1;
4858 return 0;
4861 /* Everything checks out, this face is supported. */
4862 return 1;
4865 #endif /* HAVE_WINDOW_SYSTEM */
4867 /* Return non-zero if all the face attributes in ATTRS are supported
4868 on the tty frame F.
4870 The definition of `supported' is somewhat heuristic, but basically means
4871 that a face containing all the attributes in ATTRS, when merged
4872 with the default face for display, can be represented in a way that's
4874 \(1) different in appearance than the default face, and
4875 \(2) `close in spirit' to what the attributes specify, if not exact.
4877 Point (2) implies that a `:weight black' attribute will be satisfied
4878 by any terminal that can display bold, and a `:foreground "yellow"' as
4879 long as the terminal can display a yellowish color, but `:slant italic'
4880 will _not_ be satisfied by the tty display code's automatic
4881 substitution of a `dim' face for italic. */
4883 static int
4884 tty_supports_face_attributes_p (struct frame *f, Lisp_Object *attrs,
4885 struct face *def_face)
4887 int weight, slant;
4888 Lisp_Object val, fg, bg;
4889 XColor fg_tty_color, fg_std_color;
4890 XColor bg_tty_color, bg_std_color;
4891 unsigned test_caps = 0;
4892 Lisp_Object *def_attrs = def_face->lface;
4894 /* First check some easy-to-check stuff; ttys support none of the
4895 following attributes, so we can just return false if any are requested
4896 (even if `nominal' values are specified, we should still return false,
4897 as that will be the same value that the default face uses). We
4898 consider :slant unsupportable on ttys, even though the face code
4899 actually `fakes' them using a dim attribute if possible. This is
4900 because the faked result is too different from what the face
4901 specifies. */
4902 if (!UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
4903 || !UNSPECIFIEDP (attrs[LFACE_FOUNDRY_INDEX])
4904 || !UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
4905 || !UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
4906 || !UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
4907 || !UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
4908 || !UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
4909 || !UNSPECIFIEDP (attrs[LFACE_BOX_INDEX]))
4910 return 0;
4912 /* Test for terminal `capabilities' (non-color character attributes). */
4914 /* font weight (bold/dim) */
4915 val = attrs[LFACE_WEIGHT_INDEX];
4916 if (!UNSPECIFIEDP (val)
4917 && (weight = FONT_WEIGHT_NAME_NUMERIC (val), weight >= 0))
4919 int def_weight = FONT_WEIGHT_NAME_NUMERIC (def_attrs[LFACE_WEIGHT_INDEX]);
4921 if (weight > 100)
4923 if (def_weight > 100)
4924 return 0; /* same as default */
4925 test_caps = TTY_CAP_BOLD;
4927 else if (weight < 100)
4929 if (def_weight < 100)
4930 return 0; /* same as default */
4931 test_caps = TTY_CAP_DIM;
4933 else if (def_weight == 100)
4934 return 0; /* same as default */
4937 /* font slant */
4938 val = attrs[LFACE_SLANT_INDEX];
4939 if (!UNSPECIFIEDP (val)
4940 && (slant = FONT_SLANT_NAME_NUMERIC (val), slant >= 0))
4942 int def_slant = FONT_SLANT_NAME_NUMERIC (def_attrs[LFACE_SLANT_INDEX]);
4943 if (slant == 100 || slant == def_slant)
4944 return 0; /* same as default */
4945 else
4946 test_caps |= TTY_CAP_ITALIC;
4949 /* underlining */
4950 val = attrs[LFACE_UNDERLINE_INDEX];
4951 if (!UNSPECIFIEDP (val))
4953 if (STRINGP (val))
4954 return 0; /* ttys can't use colored underlines */
4955 else if (face_attr_equal_p (val, def_attrs[LFACE_UNDERLINE_INDEX]))
4956 return 0; /* same as default */
4957 else
4958 test_caps |= TTY_CAP_UNDERLINE;
4961 /* inverse video */
4962 val = attrs[LFACE_INVERSE_INDEX];
4963 if (!UNSPECIFIEDP (val))
4965 if (face_attr_equal_p (val, def_attrs[LFACE_INVERSE_INDEX]))
4966 return 0; /* same as default */
4967 else
4968 test_caps |= TTY_CAP_INVERSE;
4972 /* Color testing. */
4974 /* Default the color indices in FG_TTY_COLOR and BG_TTY_COLOR, since
4975 we use them when calling `tty_capable_p' below, even if the face
4976 specifies no colors. */
4977 fg_tty_color.pixel = FACE_TTY_DEFAULT_FG_COLOR;
4978 bg_tty_color.pixel = FACE_TTY_DEFAULT_BG_COLOR;
4980 /* Check if foreground color is close enough. */
4981 fg = attrs[LFACE_FOREGROUND_INDEX];
4982 if (STRINGP (fg))
4984 Lisp_Object def_fg = def_attrs[LFACE_FOREGROUND_INDEX];
4986 if (face_attr_equal_p (fg, def_fg))
4987 return 0; /* same as default */
4988 else if (! tty_lookup_color (f, fg, &fg_tty_color, &fg_std_color))
4989 return 0; /* not a valid color */
4990 else if (color_distance (&fg_tty_color, &fg_std_color)
4991 > TTY_SAME_COLOR_THRESHOLD)
4992 return 0; /* displayed color is too different */
4993 else
4994 /* Make sure the color is really different than the default. */
4996 XColor def_fg_color;
4997 if (tty_lookup_color (f, def_fg, &def_fg_color, 0)
4998 && (color_distance (&fg_tty_color, &def_fg_color)
4999 <= TTY_SAME_COLOR_THRESHOLD))
5000 return 0;
5004 /* Check if background color is close enough. */
5005 bg = attrs[LFACE_BACKGROUND_INDEX];
5006 if (STRINGP (bg))
5008 Lisp_Object def_bg = def_attrs[LFACE_BACKGROUND_INDEX];
5010 if (face_attr_equal_p (bg, def_bg))
5011 return 0; /* same as default */
5012 else if (! tty_lookup_color (f, bg, &bg_tty_color, &bg_std_color))
5013 return 0; /* not a valid color */
5014 else if (color_distance (&bg_tty_color, &bg_std_color)
5015 > TTY_SAME_COLOR_THRESHOLD)
5016 return 0; /* displayed color is too different */
5017 else
5018 /* Make sure the color is really different than the default. */
5020 XColor def_bg_color;
5021 if (tty_lookup_color (f, def_bg, &def_bg_color, 0)
5022 && (color_distance (&bg_tty_color, &def_bg_color)
5023 <= TTY_SAME_COLOR_THRESHOLD))
5024 return 0;
5028 /* If both foreground and background are requested, see if the
5029 distance between them is OK. We just check to see if the distance
5030 between the tty's foreground and background is close enough to the
5031 distance between the standard foreground and background. */
5032 if (STRINGP (fg) && STRINGP (bg))
5034 int delta_delta
5035 = (color_distance (&fg_std_color, &bg_std_color)
5036 - color_distance (&fg_tty_color, &bg_tty_color));
5037 if (delta_delta > TTY_SAME_COLOR_THRESHOLD
5038 || delta_delta < -TTY_SAME_COLOR_THRESHOLD)
5039 return 0;
5043 /* See if the capabilities we selected above are supported, with the
5044 given colors. */
5045 if (test_caps != 0 &&
5046 ! tty_capable_p (FRAME_TTY (f), test_caps, fg_tty_color.pixel,
5047 bg_tty_color.pixel))
5048 return 0;
5051 /* Hmmm, everything checks out, this terminal must support this face. */
5052 return 1;
5056 DEFUN ("display-supports-face-attributes-p",
5057 Fdisplay_supports_face_attributes_p, Sdisplay_supports_face_attributes_p,
5058 1, 2, 0,
5059 doc: /* Return non-nil if all the face attributes in ATTRIBUTES are supported.
5060 The optional argument DISPLAY can be a display name, a frame, or
5061 nil (meaning the selected frame's display).
5063 The definition of `supported' is somewhat heuristic, but basically means
5064 that a face containing all the attributes in ATTRIBUTES, when merged
5065 with the default face for display, can be represented in a way that's
5067 \(1) different in appearance than the default face, and
5068 \(2) `close in spirit' to what the attributes specify, if not exact.
5070 Point (2) implies that a `:weight black' attribute will be satisfied by
5071 any display that can display bold, and a `:foreground \"yellow\"' as long
5072 as it can display a yellowish color, but `:slant italic' will _not_ be
5073 satisfied by the tty display code's automatic substitution of a `dim'
5074 face for italic. */)
5075 (Lisp_Object attributes, Lisp_Object display)
5077 int supports = 0, i;
5078 Lisp_Object frame;
5079 struct frame *f;
5080 struct face *def_face;
5081 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5083 if (noninteractive || !initialized)
5084 /* We may not be able to access low-level face information in batch
5085 mode, or before being dumped, and this function is not going to
5086 be very useful in those cases anyway, so just give up. */
5087 return Qnil;
5089 if (NILP (display))
5090 frame = selected_frame;
5091 else if (FRAMEP (display))
5092 frame = display;
5093 else
5095 /* Find any frame on DISPLAY. */
5096 Lisp_Object fl_tail;
5098 frame = Qnil;
5099 for (fl_tail = Vframe_list; CONSP (fl_tail); fl_tail = XCDR (fl_tail))
5101 frame = XCAR (fl_tail);
5102 if (!NILP (Fequal (Fcdr (Fassq (Qdisplay,
5103 XFRAME (frame)->param_alist)),
5104 display)))
5105 break;
5109 CHECK_LIVE_FRAME (frame);
5110 f = XFRAME (frame);
5112 for (i = 0; i < LFACE_VECTOR_SIZE; i++)
5113 attrs[i] = Qunspecified;
5114 merge_face_ref (f, attributes, attrs, 1, 0);
5116 def_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5117 if (def_face == NULL)
5119 if (! realize_basic_faces (f))
5120 error ("Cannot realize default face");
5121 def_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5122 if (def_face == NULL)
5123 abort (); /* realize_basic_faces must have set it up */
5126 /* Dispatch to the appropriate handler. */
5127 if (FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5128 supports = tty_supports_face_attributes_p (f, attrs, def_face);
5129 #ifdef HAVE_WINDOW_SYSTEM
5130 else
5131 supports = x_supports_face_attributes_p (f, attrs, def_face);
5132 #endif
5134 return supports ? Qt : Qnil;
5138 /***********************************************************************
5139 Font selection
5140 ***********************************************************************/
5142 DEFUN ("internal-set-font-selection-order",
5143 Finternal_set_font_selection_order,
5144 Sinternal_set_font_selection_order, 1, 1, 0,
5145 doc: /* Set font selection order for face font selection to ORDER.
5146 ORDER must be a list of length 4 containing the symbols `:width',
5147 `:height', `:weight', and `:slant'. Face attributes appearing
5148 first in ORDER are matched first, e.g. if `:height' appears before
5149 `:weight' in ORDER, font selection first tries to find a font with
5150 a suitable height, and then tries to match the font weight.
5151 Value is ORDER. */)
5152 (Lisp_Object order)
5154 Lisp_Object list;
5155 int i;
5156 int indices[DIM (font_sort_order)];
5158 CHECK_LIST (order);
5159 memset (indices, 0, sizeof indices);
5160 i = 0;
5162 for (list = order;
5163 CONSP (list) && i < DIM (indices);
5164 list = XCDR (list), ++i)
5166 Lisp_Object attr = XCAR (list);
5167 int xlfd;
5169 if (EQ (attr, QCwidth))
5170 xlfd = XLFD_SWIDTH;
5171 else if (EQ (attr, QCheight))
5172 xlfd = XLFD_POINT_SIZE;
5173 else if (EQ (attr, QCweight))
5174 xlfd = XLFD_WEIGHT;
5175 else if (EQ (attr, QCslant))
5176 xlfd = XLFD_SLANT;
5177 else
5178 break;
5180 if (indices[i] != 0)
5181 break;
5182 indices[i] = xlfd;
5185 if (!NILP (list) || i != DIM (indices))
5186 signal_error ("Invalid font sort order", order);
5187 for (i = 0; i < DIM (font_sort_order); ++i)
5188 if (indices[i] == 0)
5189 signal_error ("Invalid font sort order", order);
5191 if (memcmp (indices, font_sort_order, sizeof indices) != 0)
5193 memcpy (font_sort_order, indices, sizeof font_sort_order);
5194 free_all_realized_faces (Qnil);
5197 font_update_sort_order (font_sort_order);
5199 return Qnil;
5203 DEFUN ("internal-set-alternative-font-family-alist",
5204 Finternal_set_alternative_font_family_alist,
5205 Sinternal_set_alternative_font_family_alist, 1, 1, 0,
5206 doc: /* Define alternative font families to try in face font selection.
5207 ALIST is an alist of (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...) entries.
5208 Each ALTERNATIVE is tried in order if no fonts of font family FAMILY can
5209 be found. Value is ALIST. */)
5210 (Lisp_Object alist)
5212 Lisp_Object entry, tail, tail2;
5214 CHECK_LIST (alist);
5215 alist = Fcopy_sequence (alist);
5216 for (tail = alist; CONSP (tail); tail = XCDR (tail))
5218 entry = XCAR (tail);
5219 CHECK_LIST (entry);
5220 entry = Fcopy_sequence (entry);
5221 XSETCAR (tail, entry);
5222 for (tail2 = entry; CONSP (tail2); tail2 = XCDR (tail2))
5223 XSETCAR (tail2, Fintern (XCAR (tail2), Qnil));
5226 Vface_alternative_font_family_alist = alist;
5227 free_all_realized_faces (Qnil);
5228 return alist;
5232 DEFUN ("internal-set-alternative-font-registry-alist",
5233 Finternal_set_alternative_font_registry_alist,
5234 Sinternal_set_alternative_font_registry_alist, 1, 1, 0,
5235 doc: /* Define alternative font registries to try in face font selection.
5236 ALIST is an alist of (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...) entries.
5237 Each ALTERNATIVE is tried in order if no fonts of font registry REGISTRY can
5238 be found. Value is ALIST. */)
5239 (Lisp_Object alist)
5241 Lisp_Object entry, tail, tail2;
5243 CHECK_LIST (alist);
5244 alist = Fcopy_sequence (alist);
5245 for (tail = alist; CONSP (tail); tail = XCDR (tail))
5247 entry = XCAR (tail);
5248 CHECK_LIST (entry);
5249 entry = Fcopy_sequence (entry);
5250 XSETCAR (tail, entry);
5251 for (tail2 = entry; CONSP (tail2); tail2 = XCDR (tail2))
5252 XSETCAR (tail2, Fdowncase (XCAR (tail2)));
5254 Vface_alternative_font_registry_alist = alist;
5255 free_all_realized_faces (Qnil);
5256 return alist;
5260 #ifdef HAVE_WINDOW_SYSTEM
5262 /* Return the fontset id of the base fontset name or alias name given
5263 by the fontset attribute of ATTRS. Value is -1 if the fontset
5264 attribute of ATTRS doesn't name a fontset. */
5266 static int
5267 face_fontset (Lisp_Object *attrs)
5269 Lisp_Object name;
5271 name = attrs[LFACE_FONTSET_INDEX];
5272 if (!STRINGP (name))
5273 return -1;
5274 return fs_query_fontset (name, 0);
5277 #endif /* HAVE_WINDOW_SYSTEM */
5281 /***********************************************************************
5282 Face Realization
5283 ***********************************************************************/
5285 /* Realize basic faces on frame F. Value is zero if frame parameters
5286 of F don't contain enough information needed to realize the default
5287 face. */
5289 static int
5290 realize_basic_faces (struct frame *f)
5292 int success_p = 0;
5293 ptrdiff_t count = SPECPDL_INDEX ();
5295 /* Block input here so that we won't be surprised by an X expose
5296 event, for instance, without having the faces set up. */
5297 BLOCK_INPUT;
5298 specbind (Qscalable_fonts_allowed, Qt);
5300 if (realize_default_face (f))
5302 realize_named_face (f, Qmode_line, MODE_LINE_FACE_ID);
5303 realize_named_face (f, Qmode_line_inactive, MODE_LINE_INACTIVE_FACE_ID);
5304 realize_named_face (f, Qtool_bar, TOOL_BAR_FACE_ID);
5305 realize_named_face (f, Qfringe, FRINGE_FACE_ID);
5306 realize_named_face (f, Qheader_line, HEADER_LINE_FACE_ID);
5307 realize_named_face (f, Qscroll_bar, SCROLL_BAR_FACE_ID);
5308 realize_named_face (f, Qborder, BORDER_FACE_ID);
5309 realize_named_face (f, Qcursor, CURSOR_FACE_ID);
5310 realize_named_face (f, Qmouse, MOUSE_FACE_ID);
5311 realize_named_face (f, Qmenu, MENU_FACE_ID);
5312 realize_named_face (f, Qvertical_border, VERTICAL_BORDER_FACE_ID);
5314 /* Reflect changes in the `menu' face in menu bars. */
5315 if (FRAME_FACE_CACHE (f)->menu_face_changed_p)
5317 FRAME_FACE_CACHE (f)->menu_face_changed_p = 0;
5318 #ifdef USE_X_TOOLKIT
5319 if (FRAME_WINDOW_P (f))
5320 x_update_menu_appearance (f);
5321 #endif
5324 success_p = 1;
5327 unbind_to (count, Qnil);
5328 UNBLOCK_INPUT;
5329 return success_p;
5333 /* Realize the default face on frame F. If the face is not fully
5334 specified, make it fully-specified. Attributes of the default face
5335 that are not explicitly specified are taken from frame parameters. */
5337 static int
5338 realize_default_face (struct frame *f)
5340 struct face_cache *c = FRAME_FACE_CACHE (f);
5341 Lisp_Object lface;
5342 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5343 struct face *face;
5345 /* If the `default' face is not yet known, create it. */
5346 lface = lface_from_face_name (f, Qdefault, 0);
5347 if (NILP (lface))
5349 Lisp_Object frame;
5350 XSETFRAME (frame, f);
5351 lface = Finternal_make_lisp_face (Qdefault, frame);
5354 #ifdef HAVE_WINDOW_SYSTEM
5355 if (FRAME_WINDOW_P (f))
5357 Lisp_Object font_object;
5359 XSETFONT (font_object, FRAME_FONT (f));
5360 set_lface_from_font (f, lface, font_object, f->default_face_done_p);
5361 LFACE_FONTSET (lface) = fontset_name (FRAME_FONTSET (f));
5362 f->default_face_done_p = 1;
5364 #endif /* HAVE_WINDOW_SYSTEM */
5366 if (!FRAME_WINDOW_P (f))
5368 LFACE_FAMILY (lface) = build_string ("default");
5369 LFACE_FOUNDRY (lface) = LFACE_FAMILY (lface);
5370 LFACE_SWIDTH (lface) = Qnormal;
5371 LFACE_HEIGHT (lface) = make_number (1);
5372 if (UNSPECIFIEDP (LFACE_WEIGHT (lface)))
5373 LFACE_WEIGHT (lface) = Qnormal;
5374 if (UNSPECIFIEDP (LFACE_SLANT (lface)))
5375 LFACE_SLANT (lface) = Qnormal;
5376 if (UNSPECIFIEDP (LFACE_FONTSET (lface)))
5377 LFACE_FONTSET (lface) = Qnil;
5380 if (UNSPECIFIEDP (LFACE_UNDERLINE (lface)))
5381 LFACE_UNDERLINE (lface) = Qnil;
5383 if (UNSPECIFIEDP (LFACE_OVERLINE (lface)))
5384 LFACE_OVERLINE (lface) = Qnil;
5386 if (UNSPECIFIEDP (LFACE_STRIKE_THROUGH (lface)))
5387 LFACE_STRIKE_THROUGH (lface) = Qnil;
5389 if (UNSPECIFIEDP (LFACE_BOX (lface)))
5390 LFACE_BOX (lface) = Qnil;
5392 if (UNSPECIFIEDP (LFACE_INVERSE (lface)))
5393 LFACE_INVERSE (lface) = Qnil;
5395 if (UNSPECIFIEDP (LFACE_FOREGROUND (lface)))
5397 /* This function is called so early that colors are not yet
5398 set in the frame parameter list. */
5399 Lisp_Object color = Fassq (Qforeground_color, f->param_alist);
5401 if (CONSP (color) && STRINGP (XCDR (color)))
5402 LFACE_FOREGROUND (lface) = XCDR (color);
5403 else if (FRAME_WINDOW_P (f))
5404 return 0;
5405 else if (FRAME_INITIAL_P (f) || FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5406 LFACE_FOREGROUND (lface) = build_string (unspecified_fg);
5407 else
5408 abort ();
5411 if (UNSPECIFIEDP (LFACE_BACKGROUND (lface)))
5413 /* This function is called so early that colors are not yet
5414 set in the frame parameter list. */
5415 Lisp_Object color = Fassq (Qbackground_color, f->param_alist);
5416 if (CONSP (color) && STRINGP (XCDR (color)))
5417 LFACE_BACKGROUND (lface) = XCDR (color);
5418 else if (FRAME_WINDOW_P (f))
5419 return 0;
5420 else if (FRAME_INITIAL_P (f) || FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
5421 LFACE_BACKGROUND (lface) = build_string (unspecified_bg);
5422 else
5423 abort ();
5426 if (UNSPECIFIEDP (LFACE_STIPPLE (lface)))
5427 LFACE_STIPPLE (lface) = Qnil;
5429 /* Realize the face; it must be fully-specified now. */
5430 xassert (lface_fully_specified_p (XVECTOR (lface)->contents));
5431 check_lface (lface);
5432 memcpy (attrs, XVECTOR (lface)->contents, sizeof attrs);
5433 face = realize_face (c, attrs, DEFAULT_FACE_ID);
5435 #ifdef HAVE_WINDOW_SYSTEM
5436 #ifdef HAVE_X_WINDOWS
5437 if (FRAME_X_P (f) && face->font != FRAME_FONT (f))
5439 /* This can happen when making a frame on a display that does
5440 not support the default font. */
5441 if (!face->font)
5442 return 0;
5444 /* Otherwise, the font specified for the frame was not
5445 acceptable as a font for the default face (perhaps because
5446 auto-scaled fonts are rejected), so we must adjust the frame
5447 font. */
5448 x_set_font (f, LFACE_FONT (lface), Qnil);
5450 #endif /* HAVE_X_WINDOWS */
5451 #endif /* HAVE_WINDOW_SYSTEM */
5452 return 1;
5456 /* Realize basic faces other than the default face in face cache C.
5457 SYMBOL is the face name, ID is the face id the realized face must
5458 have. The default face must have been realized already. */
5460 static void
5461 realize_named_face (struct frame *f, Lisp_Object symbol, int id)
5463 struct face_cache *c = FRAME_FACE_CACHE (f);
5464 Lisp_Object lface = lface_from_face_name (f, symbol, 0);
5465 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5466 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
5468 /* The default face must exist and be fully specified. */
5469 get_lface_attributes_no_remap (f, Qdefault, attrs, 1);
5470 check_lface_attrs (attrs);
5471 xassert (lface_fully_specified_p (attrs));
5473 /* If SYMBOL isn't know as a face, create it. */
5474 if (NILP (lface))
5476 Lisp_Object frame;
5477 XSETFRAME (frame, f);
5478 lface = Finternal_make_lisp_face (symbol, frame);
5481 /* Merge SYMBOL's face with the default face. */
5482 get_lface_attributes_no_remap (f, symbol, symbol_attrs, 1);
5483 merge_face_vectors (f, symbol_attrs, attrs, 0);
5485 /* Realize the face. */
5486 realize_face (c, attrs, id);
5490 /* Realize the fully-specified face with attributes ATTRS in face
5491 cache CACHE for ASCII characters. If FORMER_FACE_ID is
5492 non-negative, it is an ID of face to remove before caching the new
5493 face. Value is a pointer to the newly created realized face. */
5495 static struct face *
5496 realize_face (struct face_cache *cache, Lisp_Object *attrs, int former_face_id)
5498 struct face *face;
5500 /* LFACE must be fully specified. */
5501 xassert (cache != NULL);
5502 check_lface_attrs (attrs);
5504 if (former_face_id >= 0 && cache->used > former_face_id)
5506 /* Remove the former face. */
5507 struct face *former_face = cache->faces_by_id[former_face_id];
5508 uncache_face (cache, former_face);
5509 free_realized_face (cache->f, former_face);
5510 SET_FRAME_GARBAGED (cache->f);
5513 if (FRAME_WINDOW_P (cache->f))
5514 face = realize_x_face (cache, attrs);
5515 else if (FRAME_TERMCAP_P (cache->f) || FRAME_MSDOS_P (cache->f))
5516 face = realize_tty_face (cache, attrs);
5517 else if (FRAME_INITIAL_P (cache->f))
5519 /* Create a dummy face. */
5520 face = make_realized_face (attrs);
5522 else
5523 abort ();
5525 /* Insert the new face. */
5526 cache_face (cache, face, lface_hash (attrs));
5527 return face;
5531 #ifdef HAVE_WINDOW_SYSTEM
5532 /* Realize the fully-specified face that uses FONT-OBJECT and has the
5533 same attributes as BASE_FACE except for the font on frame F.
5534 FONT-OBJECT may be nil, in which case, realized a face of
5535 no-font. */
5537 static struct face *
5538 realize_non_ascii_face (struct frame *f, Lisp_Object font_object,
5539 struct face *base_face)
5541 struct face_cache *cache = FRAME_FACE_CACHE (f);
5542 struct face *face;
5544 face = (struct face *) xmalloc (sizeof *face);
5545 *face = *base_face;
5546 face->gc = 0;
5547 face->extra = NULL;
5548 face->overstrike
5549 = (! NILP (font_object)
5550 && FONT_WEIGHT_NAME_NUMERIC (face->lface[LFACE_WEIGHT_INDEX]) > 100
5551 && FONT_WEIGHT_NUMERIC (font_object) <= 100);
5553 /* Don't try to free the colors copied bitwise from BASE_FACE. */
5554 face->colors_copied_bitwise_p = 1;
5555 face->font = NILP (font_object) ? NULL : XFONT_OBJECT (font_object);
5556 face->gc = 0;
5558 cache_face (cache, face, face->hash);
5560 return face;
5562 #endif /* HAVE_WINDOW_SYSTEM */
5565 /* Realize the fully-specified face with attributes ATTRS in face
5566 cache CACHE for ASCII characters. Do it for X frame CACHE->f. If
5567 the new face doesn't share font with the default face, a fontname
5568 is allocated from the heap and set in `font_name' of the new face,
5569 but it is not yet loaded here. Value is a pointer to the newly
5570 created realized face. */
5572 static struct face *
5573 realize_x_face (struct face_cache *cache, Lisp_Object *attrs)
5575 struct face *face = NULL;
5576 #ifdef HAVE_WINDOW_SYSTEM
5577 struct face *default_face;
5578 struct frame *f;
5579 Lisp_Object stipple, overline, strike_through, box;
5581 xassert (FRAME_WINDOW_P (cache->f));
5583 /* Allocate a new realized face. */
5584 face = make_realized_face (attrs);
5585 face->ascii_face = face;
5587 f = cache->f;
5589 /* Determine the font to use. Most of the time, the font will be
5590 the same as the font of the default face, so try that first. */
5591 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5592 if (default_face
5593 && lface_same_font_attributes_p (default_face->lface, attrs))
5595 face->font = default_face->font;
5596 face->fontset
5597 = make_fontset_for_ascii_face (f, default_face->fontset, face);
5599 else
5601 /* If the face attribute ATTRS specifies a fontset, use it as
5602 the base of a new realized fontset. Otherwise, use the same
5603 base fontset as of the default face. The base determines
5604 registry and encoding of a font. It may also determine
5605 foundry and family. The other fields of font name pattern
5606 are constructed from ATTRS. */
5607 int fontset = face_fontset (attrs);
5609 /* If we are realizing the default face, ATTRS should specify a
5610 fontset. In other words, if FONTSET is -1, we are not
5611 realizing the default face, thus the default face should have
5612 already been realized. */
5613 if (fontset == -1)
5615 if (default_face)
5616 fontset = default_face->fontset;
5617 if (fontset == -1)
5618 abort ();
5620 if (! FONT_OBJECT_P (attrs[LFACE_FONT_INDEX]))
5621 attrs[LFACE_FONT_INDEX]
5622 = font_load_for_lface (f, attrs, attrs[LFACE_FONT_INDEX]);
5623 if (FONT_OBJECT_P (attrs[LFACE_FONT_INDEX]))
5625 face->font = XFONT_OBJECT (attrs[LFACE_FONT_INDEX]);
5626 face->fontset = make_fontset_for_ascii_face (f, fontset, face);
5628 else
5630 face->font = NULL;
5631 face->fontset = -1;
5635 if (face->font
5636 && FONT_WEIGHT_NAME_NUMERIC (attrs[LFACE_WEIGHT_INDEX]) > 100
5637 && FONT_WEIGHT_NUMERIC (attrs[LFACE_FONT_INDEX]) <= 100)
5638 face->overstrike = 1;
5640 /* Load colors, and set remaining attributes. */
5642 load_face_colors (f, face, attrs);
5644 /* Set up box. */
5645 box = attrs[LFACE_BOX_INDEX];
5646 if (STRINGP (box))
5648 /* A simple box of line width 1 drawn in color given by
5649 the string. */
5650 face->box_color = load_color (f, face, attrs[LFACE_BOX_INDEX],
5651 LFACE_BOX_INDEX);
5652 face->box = FACE_SIMPLE_BOX;
5653 face->box_line_width = 1;
5655 else if (INTEGERP (box))
5657 /* Simple box of specified line width in foreground color of the
5658 face. */
5659 xassert (XINT (box) != 0);
5660 face->box = FACE_SIMPLE_BOX;
5661 face->box_line_width = XINT (box);
5662 face->box_color = face->foreground;
5663 face->box_color_defaulted_p = 1;
5665 else if (CONSP (box))
5667 /* `(:width WIDTH :color COLOR :shadow SHADOW)'. SHADOW
5668 being one of `raised' or `sunken'. */
5669 face->box = FACE_SIMPLE_BOX;
5670 face->box_color = face->foreground;
5671 face->box_color_defaulted_p = 1;
5672 face->box_line_width = 1;
5674 while (CONSP (box))
5676 Lisp_Object keyword, value;
5678 keyword = XCAR (box);
5679 box = XCDR (box);
5681 if (!CONSP (box))
5682 break;
5683 value = XCAR (box);
5684 box = XCDR (box);
5686 if (EQ (keyword, QCline_width))
5688 if (INTEGERP (value) && XINT (value) != 0)
5689 face->box_line_width = XINT (value);
5691 else if (EQ (keyword, QCcolor))
5693 if (STRINGP (value))
5695 face->box_color = load_color (f, face, value,
5696 LFACE_BOX_INDEX);
5697 face->use_box_color_for_shadows_p = 1;
5700 else if (EQ (keyword, QCstyle))
5702 if (EQ (value, Qreleased_button))
5703 face->box = FACE_RAISED_BOX;
5704 else if (EQ (value, Qpressed_button))
5705 face->box = FACE_SUNKEN_BOX;
5710 /* Text underline, overline, strike-through. */
5712 if (EQ (attrs[LFACE_UNDERLINE_INDEX], Qt))
5714 /* Use default color (same as foreground color). */
5715 face->underline_p = 1;
5716 face->underline_defaulted_p = 1;
5717 face->underline_color = 0;
5719 else if (STRINGP (attrs[LFACE_UNDERLINE_INDEX]))
5721 /* Use specified color. */
5722 face->underline_p = 1;
5723 face->underline_defaulted_p = 0;
5724 face->underline_color
5725 = load_color (f, face, attrs[LFACE_UNDERLINE_INDEX],
5726 LFACE_UNDERLINE_INDEX);
5728 else if (NILP (attrs[LFACE_UNDERLINE_INDEX]))
5730 face->underline_p = 0;
5731 face->underline_defaulted_p = 0;
5732 face->underline_color = 0;
5735 overline = attrs[LFACE_OVERLINE_INDEX];
5736 if (STRINGP (overline))
5738 face->overline_color
5739 = load_color (f, face, attrs[LFACE_OVERLINE_INDEX],
5740 LFACE_OVERLINE_INDEX);
5741 face->overline_p = 1;
5743 else if (EQ (overline, Qt))
5745 face->overline_color = face->foreground;
5746 face->overline_color_defaulted_p = 1;
5747 face->overline_p = 1;
5750 strike_through = attrs[LFACE_STRIKE_THROUGH_INDEX];
5751 if (STRINGP (strike_through))
5753 face->strike_through_color
5754 = load_color (f, face, attrs[LFACE_STRIKE_THROUGH_INDEX],
5755 LFACE_STRIKE_THROUGH_INDEX);
5756 face->strike_through_p = 1;
5758 else if (EQ (strike_through, Qt))
5760 face->strike_through_color = face->foreground;
5761 face->strike_through_color_defaulted_p = 1;
5762 face->strike_through_p = 1;
5765 stipple = attrs[LFACE_STIPPLE_INDEX];
5766 if (!NILP (stipple))
5767 face->stipple = load_pixmap (f, stipple, &face->pixmap_w, &face->pixmap_h);
5768 #endif /* HAVE_WINDOW_SYSTEM */
5770 return face;
5774 /* Map a specified color of face FACE on frame F to a tty color index.
5775 IDX is either LFACE_FOREGROUND_INDEX or LFACE_BACKGROUND_INDEX, and
5776 specifies which color to map. Set *DEFAULTED to 1 if mapping to the
5777 default foreground/background colors. */
5779 static void
5780 map_tty_color (struct frame *f, struct face *face,
5781 enum lface_attribute_index idx, int *defaulted)
5783 Lisp_Object frame, color, def;
5784 int foreground_p = idx == LFACE_FOREGROUND_INDEX;
5785 unsigned long default_pixel =
5786 foreground_p ? FACE_TTY_DEFAULT_FG_COLOR : FACE_TTY_DEFAULT_BG_COLOR;
5787 unsigned long pixel = default_pixel;
5788 #ifdef MSDOS
5789 unsigned long default_other_pixel =
5790 foreground_p ? FACE_TTY_DEFAULT_BG_COLOR : FACE_TTY_DEFAULT_FG_COLOR;
5791 #endif
5793 xassert (idx == LFACE_FOREGROUND_INDEX || idx == LFACE_BACKGROUND_INDEX);
5795 XSETFRAME (frame, f);
5796 color = face->lface[idx];
5798 if (STRINGP (color)
5799 && SCHARS (color)
5800 && CONSP (Vtty_defined_color_alist)
5801 && (def = assq_no_quit (color, call1 (Qtty_color_alist, frame)),
5802 CONSP (def)))
5804 /* Associations in tty-defined-color-alist are of the form
5805 (NAME INDEX R G B). We need the INDEX part. */
5806 pixel = XINT (XCAR (XCDR (def)));
5809 if (pixel == default_pixel && STRINGP (color))
5811 pixel = load_color (f, face, color, idx);
5813 #ifdef MSDOS
5814 /* If the foreground of the default face is the default color,
5815 use the foreground color defined by the frame. */
5816 if (FRAME_MSDOS_P (f))
5818 if (pixel == default_pixel
5819 || pixel == FACE_TTY_DEFAULT_COLOR)
5821 if (foreground_p)
5822 pixel = FRAME_FOREGROUND_PIXEL (f);
5823 else
5824 pixel = FRAME_BACKGROUND_PIXEL (f);
5825 face->lface[idx] = tty_color_name (f, pixel);
5826 *defaulted = 1;
5828 else if (pixel == default_other_pixel)
5830 if (foreground_p)
5831 pixel = FRAME_BACKGROUND_PIXEL (f);
5832 else
5833 pixel = FRAME_FOREGROUND_PIXEL (f);
5834 face->lface[idx] = tty_color_name (f, pixel);
5835 *defaulted = 1;
5838 #endif /* MSDOS */
5841 if (foreground_p)
5842 face->foreground = pixel;
5843 else
5844 face->background = pixel;
5848 /* Realize the fully-specified face with attributes ATTRS in face
5849 cache CACHE for ASCII characters. Do it for TTY frame CACHE->f.
5850 Value is a pointer to the newly created realized face. */
5852 static struct face *
5853 realize_tty_face (struct face_cache *cache, Lisp_Object *attrs)
5855 struct face *face;
5856 int weight, slant;
5857 int face_colors_defaulted = 0;
5858 struct frame *f = cache->f;
5860 /* Frame must be a termcap frame. */
5861 xassert (FRAME_TERMCAP_P (cache->f) || FRAME_MSDOS_P (cache->f));
5863 /* Allocate a new realized face. */
5864 face = make_realized_face (attrs);
5865 #if 0
5866 face->font_name = FRAME_MSDOS_P (cache->f) ? "ms-dos" : "tty";
5867 #endif
5869 /* Map face attributes to TTY appearances. */
5870 weight = FONT_WEIGHT_NAME_NUMERIC (attrs[LFACE_WEIGHT_INDEX]);
5871 slant = FONT_SLANT_NAME_NUMERIC (attrs[LFACE_SLANT_INDEX]);
5872 if (weight > 100)
5873 face->tty_bold_p = 1;
5874 if (slant != 100)
5875 face->tty_italic_p = 1;
5876 if (!NILP (attrs[LFACE_UNDERLINE_INDEX]))
5877 face->tty_underline_p = 1;
5878 if (!NILP (attrs[LFACE_INVERSE_INDEX]))
5879 face->tty_reverse_p = 1;
5881 /* Map color names to color indices. */
5882 map_tty_color (f, face, LFACE_FOREGROUND_INDEX, &face_colors_defaulted);
5883 map_tty_color (f, face, LFACE_BACKGROUND_INDEX, &face_colors_defaulted);
5885 /* Swap colors if face is inverse-video. If the colors are taken
5886 from the frame colors, they are already inverted, since the
5887 frame-creation function calls x-handle-reverse-video. */
5888 if (face->tty_reverse_p && !face_colors_defaulted)
5890 unsigned long tem = face->foreground;
5891 face->foreground = face->background;
5892 face->background = tem;
5895 if (tty_suppress_bold_inverse_default_colors_p
5896 && face->tty_bold_p
5897 && face->background == FACE_TTY_DEFAULT_FG_COLOR
5898 && face->foreground == FACE_TTY_DEFAULT_BG_COLOR)
5899 face->tty_bold_p = 0;
5901 return face;
5905 DEFUN ("tty-suppress-bold-inverse-default-colors",
5906 Ftty_suppress_bold_inverse_default_colors,
5907 Stty_suppress_bold_inverse_default_colors, 1, 1, 0,
5908 doc: /* Suppress/allow boldness of faces with inverse default colors.
5909 SUPPRESS non-nil means suppress it.
5910 This affects bold faces on TTYs whose foreground is the default background
5911 color of the display and whose background is the default foreground color.
5912 For such faces, the bold face attribute is ignored if this variable
5913 is non-nil. */)
5914 (Lisp_Object suppress)
5916 tty_suppress_bold_inverse_default_colors_p = !NILP (suppress);
5917 ++face_change_count;
5918 return suppress;
5923 /***********************************************************************
5924 Computing Faces
5925 ***********************************************************************/
5927 /* Return the ID of the face to use to display character CH with face
5928 property PROP on frame F in current_buffer. */
5931 compute_char_face (struct frame *f, int ch, Lisp_Object prop)
5933 int face_id;
5935 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
5936 ch = 0;
5938 if (NILP (prop))
5940 struct face *face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5941 face_id = FACE_FOR_CHAR (f, face, ch, -1, Qnil);
5943 else
5945 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5946 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5947 memcpy (attrs, default_face->lface, sizeof attrs);
5948 merge_face_ref (f, prop, attrs, 1, 0);
5949 face_id = lookup_face (f, attrs);
5952 return face_id;
5955 /* Return the face ID associated with buffer position POS for
5956 displaying ASCII characters. Return in *ENDPTR the position at
5957 which a different face is needed, as far as text properties and
5958 overlays are concerned. W is a window displaying current_buffer.
5960 REGION_BEG, REGION_END delimit the region, so it can be
5961 highlighted.
5963 LIMIT is a position not to scan beyond. That is to limit the time
5964 this function can take.
5966 If MOUSE is non-zero, use the character's mouse-face, not its face.
5968 BASE_FACE_ID, if non-negative, specifies a base face id to use
5969 instead of DEFAULT_FACE_ID.
5971 The face returned is suitable for displaying ASCII characters. */
5974 face_at_buffer_position (struct window *w, ptrdiff_t pos,
5975 ptrdiff_t region_beg, ptrdiff_t region_end,
5976 ptrdiff_t *endptr, ptrdiff_t limit,
5977 int mouse, int base_face_id)
5979 struct frame *f = XFRAME (w->frame);
5980 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5981 Lisp_Object prop, position;
5982 ptrdiff_t i, noverlays;
5983 Lisp_Object *overlay_vec;
5984 Lisp_Object frame;
5985 ptrdiff_t endpos;
5986 Lisp_Object propname = mouse ? Qmouse_face : Qface;
5987 Lisp_Object limit1, end;
5988 struct face *default_face;
5990 /* W must display the current buffer. We could write this function
5991 to use the frame and buffer of W, but right now it doesn't. */
5992 /* xassert (XBUFFER (w->buffer) == current_buffer); */
5994 XSETFRAME (frame, f);
5995 XSETFASTINT (position, pos);
5997 endpos = ZV;
5998 if (pos < region_beg && region_beg < endpos)
5999 endpos = region_beg;
6001 /* Get the `face' or `mouse_face' text property at POS, and
6002 determine the next position at which the property changes. */
6003 prop = Fget_text_property (position, propname, w->buffer);
6004 XSETFASTINT (limit1, (limit < endpos ? limit : endpos));
6005 end = Fnext_single_property_change (position, propname, w->buffer, limit1);
6006 if (INTEGERP (end))
6007 endpos = XINT (end);
6009 /* Look at properties from overlays. */
6011 ptrdiff_t next_overlay;
6013 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, &next_overlay, 0);
6014 if (next_overlay < endpos)
6015 endpos = next_overlay;
6018 *endptr = endpos;
6021 int face_id;
6023 if (base_face_id >= 0)
6024 face_id = base_face_id;
6025 else if (NILP (Vface_remapping_alist))
6026 face_id = DEFAULT_FACE_ID;
6027 else
6028 face_id = lookup_basic_face (f, DEFAULT_FACE_ID);
6030 default_face = FACE_FROM_ID (f, face_id);
6033 /* Optimize common cases where we can use the default face. */
6034 if (noverlays == 0
6035 && NILP (prop)
6036 && !(pos >= region_beg && pos < region_end))
6037 return default_face->id;
6039 /* Begin with attributes from the default face. */
6040 memcpy (attrs, default_face->lface, sizeof attrs);
6042 /* Merge in attributes specified via text properties. */
6043 if (!NILP (prop))
6044 merge_face_ref (f, prop, attrs, 1, 0);
6046 /* Now merge the overlay data. */
6047 noverlays = sort_overlays (overlay_vec, noverlays, w);
6048 for (i = 0; i < noverlays; i++)
6050 Lisp_Object oend;
6051 int oendpos;
6053 prop = Foverlay_get (overlay_vec[i], propname);
6054 if (!NILP (prop))
6055 merge_face_ref (f, prop, attrs, 1, 0);
6057 oend = OVERLAY_END (overlay_vec[i]);
6058 oendpos = OVERLAY_POSITION (oend);
6059 if (oendpos < endpos)
6060 endpos = oendpos;
6063 /* If in the region, merge in the region face. */
6064 if (pos >= region_beg && pos < region_end)
6066 merge_named_face (f, Qregion, attrs, 0);
6068 if (region_end < endpos)
6069 endpos = region_end;
6072 *endptr = endpos;
6074 /* Look up a realized face with the given face attributes,
6075 or realize a new one for ASCII characters. */
6076 return lookup_face (f, attrs);
6079 /* Return the face ID at buffer position POS for displaying ASCII
6080 characters associated with overlay strings for overlay OVERLAY.
6082 Like face_at_buffer_position except for OVERLAY. Currently it
6083 simply disregards the `face' properties of all overlays. */
6086 face_for_overlay_string (struct window *w, ptrdiff_t pos,
6087 ptrdiff_t region_beg, ptrdiff_t region_end,
6088 ptrdiff_t *endptr, ptrdiff_t limit,
6089 int mouse, Lisp_Object overlay)
6091 struct frame *f = XFRAME (w->frame);
6092 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6093 Lisp_Object prop, position;
6094 Lisp_Object frame;
6095 int endpos;
6096 Lisp_Object propname = mouse ? Qmouse_face : Qface;
6097 Lisp_Object limit1, end;
6098 struct face *default_face;
6100 /* W must display the current buffer. We could write this function
6101 to use the frame and buffer of W, but right now it doesn't. */
6102 /* xassert (XBUFFER (w->buffer) == current_buffer); */
6104 XSETFRAME (frame, f);
6105 XSETFASTINT (position, pos);
6107 endpos = ZV;
6108 if (pos < region_beg && region_beg < endpos)
6109 endpos = region_beg;
6111 /* Get the `face' or `mouse_face' text property at POS, and
6112 determine the next position at which the property changes. */
6113 prop = Fget_text_property (position, propname, w->buffer);
6114 XSETFASTINT (limit1, (limit < endpos ? limit : endpos));
6115 end = Fnext_single_property_change (position, propname, w->buffer, limit1);
6116 if (INTEGERP (end))
6117 endpos = XINT (end);
6119 *endptr = endpos;
6121 /* Optimize common case where we can use the default face. */
6122 if (NILP (prop)
6123 && !(pos >= region_beg && pos < region_end)
6124 && NILP (Vface_remapping_alist))
6125 return DEFAULT_FACE_ID;
6127 /* Begin with attributes from the default face. */
6128 default_face = FACE_FROM_ID (f, lookup_basic_face (f, DEFAULT_FACE_ID));
6129 memcpy (attrs, default_face->lface, sizeof attrs);
6131 /* Merge in attributes specified via text properties. */
6132 if (!NILP (prop))
6133 merge_face_ref (f, prop, attrs, 1, 0);
6135 /* If in the region, merge in the region face. */
6136 if (pos >= region_beg && pos < region_end)
6138 merge_named_face (f, Qregion, attrs, 0);
6140 if (region_end < endpos)
6141 endpos = region_end;
6144 *endptr = endpos;
6146 /* Look up a realized face with the given face attributes,
6147 or realize a new one for ASCII characters. */
6148 return lookup_face (f, attrs);
6152 /* Compute the face at character position POS in Lisp string STRING on
6153 window W, for ASCII characters.
6155 If STRING is an overlay string, it comes from position BUFPOS in
6156 current_buffer, otherwise BUFPOS is zero to indicate that STRING is
6157 not an overlay string. W must display the current buffer.
6158 REGION_BEG and REGION_END give the start and end positions of the
6159 region; both are -1 if no region is visible.
6161 BASE_FACE_ID is the id of a face to merge with. For strings coming
6162 from overlays or the `display' property it is the face at BUFPOS.
6164 If MOUSE_P is non-zero, use the character's mouse-face, not its face.
6166 Set *ENDPTR to the next position where to check for faces in
6167 STRING; -1 if the face is constant from POS to the end of the
6168 string.
6170 Value is the id of the face to use. The face returned is suitable
6171 for displaying ASCII characters. */
6174 face_at_string_position (struct window *w, Lisp_Object string,
6175 ptrdiff_t pos, ptrdiff_t bufpos,
6176 ptrdiff_t region_beg, ptrdiff_t region_end,
6177 ptrdiff_t *endptr, enum face_id base_face_id,
6178 int mouse_p)
6180 Lisp_Object prop, position, end, limit;
6181 struct frame *f = XFRAME (WINDOW_FRAME (w));
6182 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6183 struct face *base_face;
6184 int multibyte_p = STRING_MULTIBYTE (string);
6185 Lisp_Object prop_name = mouse_p ? Qmouse_face : Qface;
6187 /* Get the value of the face property at the current position within
6188 STRING. Value is nil if there is no face property. */
6189 XSETFASTINT (position, pos);
6190 prop = Fget_text_property (position, prop_name, string);
6192 /* Get the next position at which to check for faces. Value of end
6193 is nil if face is constant all the way to the end of the string.
6194 Otherwise it is a string position where to check faces next.
6195 Limit is the maximum position up to which to check for property
6196 changes in Fnext_single_property_change. Strings are usually
6197 short, so set the limit to the end of the string. */
6198 XSETFASTINT (limit, SCHARS (string));
6199 end = Fnext_single_property_change (position, prop_name, string, limit);
6200 if (INTEGERP (end))
6201 *endptr = XFASTINT (end);
6202 else
6203 *endptr = -1;
6205 base_face = FACE_FROM_ID (f, base_face_id);
6206 xassert (base_face);
6208 /* Optimize the default case that there is no face property and we
6209 are not in the region. */
6210 if (NILP (prop)
6211 && (base_face_id != DEFAULT_FACE_ID
6212 /* BUFPOS <= 0 means STRING is not an overlay string, so
6213 that the region doesn't have to be taken into account. */
6214 || bufpos <= 0
6215 || bufpos < region_beg
6216 || bufpos >= region_end)
6217 && (multibyte_p
6218 /* We can't realize faces for different charsets differently
6219 if we don't have fonts, so we can stop here if not working
6220 on a window-system frame. */
6221 || !FRAME_WINDOW_P (f)
6222 || FACE_SUITABLE_FOR_ASCII_CHAR_P (base_face, 0)))
6223 return base_face->id;
6225 /* Begin with attributes from the base face. */
6226 memcpy (attrs, base_face->lface, sizeof attrs);
6228 /* Merge in attributes specified via text properties. */
6229 if (!NILP (prop))
6230 merge_face_ref (f, prop, attrs, 1, 0);
6232 /* If in the region, merge in the region face. */
6233 if (bufpos
6234 && bufpos >= region_beg
6235 && bufpos < region_end)
6236 merge_named_face (f, Qregion, attrs, 0);
6238 /* Look up a realized face with the given face attributes,
6239 or realize a new one for ASCII characters. */
6240 return lookup_face (f, attrs);
6244 /* Merge a face into a realized face.
6246 F is frame where faces are (to be) realized.
6248 FACE_NAME is named face to merge.
6250 If FACE_NAME is nil, FACE_ID is face_id of realized face to merge.
6252 If FACE_NAME is t, FACE_ID is lface_id of face to merge.
6254 BASE_FACE_ID is realized face to merge into.
6256 Return new face id.
6260 merge_faces (struct frame *f, Lisp_Object face_name, int face_id,
6261 int base_face_id)
6263 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6264 struct face *base_face;
6266 base_face = FACE_FROM_ID (f, base_face_id);
6267 if (!base_face)
6268 return base_face_id;
6270 if (EQ (face_name, Qt))
6272 if (face_id < 0 || face_id >= lface_id_to_name_size)
6273 return base_face_id;
6274 face_name = lface_id_to_name[face_id];
6275 /* When called during make-frame, lookup_derived_face may fail
6276 if the faces are uninitialized. Don't signal an error. */
6277 face_id = lookup_derived_face (f, face_name, base_face_id, 0);
6278 return (face_id >= 0 ? face_id : base_face_id);
6281 /* Begin with attributes from the base face. */
6282 memcpy (attrs, base_face->lface, sizeof attrs);
6284 if (!NILP (face_name))
6286 if (!merge_named_face (f, face_name, attrs, 0))
6287 return base_face_id;
6289 else
6291 struct face *face;
6292 if (face_id < 0)
6293 return base_face_id;
6294 face = FACE_FROM_ID (f, face_id);
6295 if (!face)
6296 return base_face_id;
6297 merge_face_vectors (f, face->lface, attrs, 0);
6300 /* Look up a realized face with the given face attributes,
6301 or realize a new one for ASCII characters. */
6302 return lookup_face (f, attrs);
6307 #ifndef HAVE_X_WINDOWS
6308 DEFUN ("x-load-color-file", Fx_load_color_file,
6309 Sx_load_color_file, 1, 1, 0,
6310 doc: /* Create an alist of color entries from an external file.
6312 The file should define one named RGB color per line like so:
6313 R G B name
6314 where R,G,B are numbers between 0 and 255 and name is an arbitrary string. */)
6315 (Lisp_Object filename)
6317 FILE *fp;
6318 Lisp_Object cmap = Qnil;
6319 Lisp_Object abspath;
6321 CHECK_STRING (filename);
6322 abspath = Fexpand_file_name (filename, Qnil);
6324 fp = fopen (SDATA (abspath), "rt");
6325 if (fp)
6327 char buf[512];
6328 int red, green, blue;
6329 int num;
6331 BLOCK_INPUT;
6333 while (fgets (buf, sizeof (buf), fp) != NULL) {
6334 if (sscanf (buf, "%u %u %u %n", &red, &green, &blue, &num) == 3)
6336 char *name = buf + num;
6337 num = strlen (name) - 1;
6338 if (num >= 0 && name[num] == '\n')
6339 name[num] = 0;
6340 cmap = Fcons (Fcons (build_string (name),
6341 #ifdef WINDOWSNT
6342 make_number (RGB (red, green, blue))),
6343 #else
6344 make_number ((red << 16) | (green << 8) | blue)),
6345 #endif
6346 cmap);
6349 fclose (fp);
6351 UNBLOCK_INPUT;
6354 return cmap;
6356 #endif
6359 /***********************************************************************
6360 Tests
6361 ***********************************************************************/
6363 #if GLYPH_DEBUG
6365 /* Print the contents of the realized face FACE to stderr. */
6367 static void
6368 dump_realized_face (struct face *face)
6370 fprintf (stderr, "ID: %d\n", face->id);
6371 #ifdef HAVE_X_WINDOWS
6372 fprintf (stderr, "gc: %ld\n", (long) face->gc);
6373 #endif
6374 fprintf (stderr, "foreground: 0x%lx (%s)\n",
6375 face->foreground,
6376 SDATA (face->lface[LFACE_FOREGROUND_INDEX]));
6377 fprintf (stderr, "background: 0x%lx (%s)\n",
6378 face->background,
6379 SDATA (face->lface[LFACE_BACKGROUND_INDEX]));
6380 if (face->font)
6381 fprintf (stderr, "font_name: %s (%s)\n",
6382 SDATA (face->font->props[FONT_NAME_INDEX]),
6383 SDATA (face->lface[LFACE_FAMILY_INDEX]));
6384 #ifdef HAVE_X_WINDOWS
6385 fprintf (stderr, "font = %p\n", face->font);
6386 #endif
6387 fprintf (stderr, "fontset: %d\n", face->fontset);
6388 fprintf (stderr, "underline: %d (%s)\n",
6389 face->underline_p,
6390 SDATA (Fsymbol_name (face->lface[LFACE_UNDERLINE_INDEX])));
6391 fprintf (stderr, "hash: %d\n", face->hash);
6395 DEFUN ("dump-face", Fdump_face, Sdump_face, 0, 1, 0, doc: /* */)
6396 (Lisp_Object n)
6398 if (NILP (n))
6400 int i;
6402 fprintf (stderr, "font selection order: ");
6403 for (i = 0; i < DIM (font_sort_order); ++i)
6404 fprintf (stderr, "%d ", font_sort_order[i]);
6405 fprintf (stderr, "\n");
6407 fprintf (stderr, "alternative fonts: ");
6408 debug_print (Vface_alternative_font_family_alist);
6409 fprintf (stderr, "\n");
6411 for (i = 0; i < FRAME_FACE_CACHE (SELECTED_FRAME ())->used; ++i)
6412 Fdump_face (make_number (i));
6414 else
6416 struct face *face;
6417 CHECK_NUMBER (n);
6418 face = FACE_FROM_ID (SELECTED_FRAME (), XINT (n));
6419 if (face == NULL)
6420 error ("Not a valid face");
6421 dump_realized_face (face);
6424 return Qnil;
6428 DEFUN ("show-face-resources", Fshow_face_resources, Sshow_face_resources,
6429 0, 0, 0, doc: /* */)
6430 (void)
6432 fprintf (stderr, "number of colors = %d\n", ncolors_allocated);
6433 fprintf (stderr, "number of pixmaps = %d\n", npixmaps_allocated);
6434 fprintf (stderr, "number of GCs = %d\n", ngcs);
6435 return Qnil;
6438 #endif /* GLYPH_DEBUG != 0 */
6442 /***********************************************************************
6443 Initialization
6444 ***********************************************************************/
6446 void
6447 syms_of_xfaces (void)
6449 DEFSYM (Qface, "face");
6450 DEFSYM (Qface_no_inherit, "face-no-inherit");
6451 DEFSYM (Qbitmap_spec_p, "bitmap-spec-p");
6452 DEFSYM (Qframe_set_background_mode, "frame-set-background-mode");
6454 /* Lisp face attribute keywords. */
6455 DEFSYM (QCfamily, ":family");
6456 DEFSYM (QCheight, ":height");
6457 DEFSYM (QCweight, ":weight");
6458 DEFSYM (QCslant, ":slant");
6459 DEFSYM (QCunderline, ":underline");
6460 DEFSYM (QCinverse_video, ":inverse-video");
6461 DEFSYM (QCreverse_video, ":reverse-video");
6462 DEFSYM (QCforeground, ":foreground");
6463 DEFSYM (QCbackground, ":background");
6464 DEFSYM (QCstipple, ":stipple");
6465 DEFSYM (QCwidth, ":width");
6466 DEFSYM (QCfont, ":font");
6467 DEFSYM (QCfontset, ":fontset");
6468 DEFSYM (QCbold, ":bold");
6469 DEFSYM (QCitalic, ":italic");
6470 DEFSYM (QCoverline, ":overline");
6471 DEFSYM (QCstrike_through, ":strike-through");
6472 DEFSYM (QCbox, ":box");
6473 DEFSYM (QCinherit, ":inherit");
6475 /* Symbols used for Lisp face attribute values. */
6476 DEFSYM (QCcolor, ":color");
6477 DEFSYM (QCline_width, ":line-width");
6478 DEFSYM (QCstyle, ":style");
6479 DEFSYM (Qreleased_button, "released-button");
6480 DEFSYM (Qpressed_button, "pressed-button");
6481 DEFSYM (Qnormal, "normal");
6482 DEFSYM (Qultra_light, "ultra-light");
6483 DEFSYM (Qextra_light, "extra-light");
6484 DEFSYM (Qlight, "light");
6485 DEFSYM (Qsemi_light, "semi-light");
6486 DEFSYM (Qsemi_bold, "semi-bold");
6487 DEFSYM (Qbold, "bold");
6488 DEFSYM (Qextra_bold, "extra-bold");
6489 DEFSYM (Qultra_bold, "ultra-bold");
6490 DEFSYM (Qoblique, "oblique");
6491 DEFSYM (Qitalic, "italic");
6492 DEFSYM (Qreverse_oblique, "reverse-oblique");
6493 DEFSYM (Qreverse_italic, "reverse-italic");
6494 DEFSYM (Qultra_condensed, "ultra-condensed");
6495 DEFSYM (Qextra_condensed, "extra-condensed");
6496 DEFSYM (Qcondensed, "condensed");
6497 DEFSYM (Qsemi_condensed, "semi-condensed");
6498 DEFSYM (Qsemi_expanded, "semi-expanded");
6499 DEFSYM (Qexpanded, "expanded");
6500 DEFSYM (Qextra_expanded, "extra-expanded");
6501 DEFSYM (Qultra_expanded, "ultra-expanded");
6502 DEFSYM (Qbackground_color, "background-color");
6503 DEFSYM (Qforeground_color, "foreground-color");
6504 DEFSYM (Qunspecified, "unspecified");
6505 DEFSYM (QCignore_defface, ":ignore-defface");
6507 DEFSYM (Qface_alias, "face-alias");
6508 DEFSYM (Qdefault, "default");
6509 DEFSYM (Qtool_bar, "tool-bar");
6510 DEFSYM (Qregion, "region");
6511 DEFSYM (Qfringe, "fringe");
6512 DEFSYM (Qheader_line, "header-line");
6513 DEFSYM (Qscroll_bar, "scroll-bar");
6514 DEFSYM (Qmenu, "menu");
6515 DEFSYM (Qcursor, "cursor");
6516 DEFSYM (Qborder, "border");
6517 DEFSYM (Qmouse, "mouse");
6518 DEFSYM (Qmode_line_inactive, "mode-line-inactive");
6519 DEFSYM (Qvertical_border, "vertical-border");
6520 DEFSYM (Qtty_color_desc, "tty-color-desc");
6521 DEFSYM (Qtty_color_standard_values, "tty-color-standard-values");
6522 DEFSYM (Qtty_color_by_index, "tty-color-by-index");
6523 DEFSYM (Qtty_color_alist, "tty-color-alist");
6524 DEFSYM (Qscalable_fonts_allowed, "scalable-fonts-allowed");
6526 Vparam_value_alist = Fcons (Fcons (Qnil, Qnil), Qnil);
6527 staticpro (&Vparam_value_alist);
6528 Vface_alternative_font_family_alist = Qnil;
6529 staticpro (&Vface_alternative_font_family_alist);
6530 Vface_alternative_font_registry_alist = Qnil;
6531 staticpro (&Vface_alternative_font_registry_alist);
6533 defsubr (&Sinternal_make_lisp_face);
6534 defsubr (&Sinternal_lisp_face_p);
6535 defsubr (&Sinternal_set_lisp_face_attribute);
6536 #ifdef HAVE_WINDOW_SYSTEM
6537 defsubr (&Sinternal_set_lisp_face_attribute_from_resource);
6538 #endif
6539 defsubr (&Scolor_gray_p);
6540 defsubr (&Scolor_supported_p);
6541 #ifndef HAVE_X_WINDOWS
6542 defsubr (&Sx_load_color_file);
6543 #endif
6544 defsubr (&Sface_attribute_relative_p);
6545 defsubr (&Smerge_face_attribute);
6546 defsubr (&Sinternal_get_lisp_face_attribute);
6547 defsubr (&Sinternal_lisp_face_attribute_values);
6548 defsubr (&Sinternal_lisp_face_equal_p);
6549 defsubr (&Sinternal_lisp_face_empty_p);
6550 defsubr (&Sinternal_copy_lisp_face);
6551 defsubr (&Sinternal_merge_in_global_face);
6552 defsubr (&Sface_font);
6553 defsubr (&Sframe_face_alist);
6554 defsubr (&Sdisplay_supports_face_attributes_p);
6555 defsubr (&Scolor_distance);
6556 defsubr (&Sinternal_set_font_selection_order);
6557 defsubr (&Sinternal_set_alternative_font_family_alist);
6558 defsubr (&Sinternal_set_alternative_font_registry_alist);
6559 defsubr (&Sface_attributes_as_vector);
6560 #if GLYPH_DEBUG
6561 defsubr (&Sdump_face);
6562 defsubr (&Sshow_face_resources);
6563 #endif /* GLYPH_DEBUG */
6564 defsubr (&Sclear_face_cache);
6565 defsubr (&Stty_suppress_bold_inverse_default_colors);
6567 #if defined DEBUG_X_COLORS && defined HAVE_X_WINDOWS
6568 defsubr (&Sdump_colors);
6569 #endif
6571 DEFVAR_LISP ("font-list-limit", Vfont_list_limit,
6572 doc: /* Limit for font matching.
6573 If an integer > 0, font matching functions won't load more than
6574 that number of fonts when searching for a matching font. */);
6575 Vfont_list_limit = make_number (DEFAULT_FONT_LIST_LIMIT);
6577 DEFVAR_LISP ("face-new-frame-defaults", Vface_new_frame_defaults,
6578 doc: /* List of global face definitions (for internal use only.) */);
6579 Vface_new_frame_defaults = Qnil;
6581 DEFVAR_LISP ("face-default-stipple", Vface_default_stipple,
6582 doc: /* Default stipple pattern used on monochrome displays.
6583 This stipple pattern is used on monochrome displays
6584 instead of shades of gray for a face background color.
6585 See `set-face-stipple' for possible values for this variable. */);
6586 Vface_default_stipple = make_pure_c_string ("gray3");
6588 DEFVAR_LISP ("tty-defined-color-alist", Vtty_defined_color_alist,
6589 doc: /* An alist of defined terminal colors and their RGB values.
6590 See the docstring of `tty-color-alist' for the details. */);
6591 Vtty_defined_color_alist = Qnil;
6593 DEFVAR_LISP ("scalable-fonts-allowed", Vscalable_fonts_allowed,
6594 doc: /* Allowed scalable fonts.
6595 A value of nil means don't allow any scalable fonts.
6596 A value of t means allow any scalable font.
6597 Otherwise, value must be a list of regular expressions. A font may be
6598 scaled if its name matches a regular expression in the list.
6599 Note that if value is nil, a scalable font might still be used, if no
6600 other font of the appropriate family and registry is available. */);
6601 Vscalable_fonts_allowed = Qnil;
6603 DEFVAR_LISP ("face-ignored-fonts", Vface_ignored_fonts,
6604 doc: /* List of ignored fonts.
6605 Each element is a regular expression that matches names of fonts to
6606 ignore. */);
6607 Vface_ignored_fonts = Qnil;
6609 DEFVAR_LISP ("face-remapping-alist", Vface_remapping_alist,
6610 doc: /* Alist of face remappings.
6611 Each element is of the form:
6613 (FACE . REPLACEMENT),
6615 which causes display of the face FACE to use REPLACEMENT instead.
6616 REPLACEMENT is a face specification, i.e. one of the following:
6618 (1) a face name
6619 (2) a property list of attribute/value pairs, or
6620 (3) a list in which each element has the form of (1) or (2).
6622 List values for REPLACEMENT are merged to form the final face
6623 specification, with earlier entries taking precedence, in the same as
6624 as in the `face' text property.
6626 Face-name remapping cycles are suppressed; recursive references use
6627 the underlying face instead of the remapped face. So a remapping of
6628 the form:
6630 (FACE EXTRA-FACE... FACE)
6634 (FACE (FACE-ATTR VAL ...) FACE)
6636 causes EXTRA-FACE... or (FACE-ATTR VAL ...) to be _merged_ with the
6637 existing definition of FACE. Note that this isn't necessary for the
6638 default face, since every face inherits from the default face.
6640 If this variable is made buffer-local, the face remapping takes effect
6641 only in that buffer. For instance, the mode my-mode could define a
6642 face `my-mode-default', and then in the mode setup function, do:
6644 (set (make-local-variable 'face-remapping-alist)
6645 '((default my-mode-default)))).
6647 Because Emacs normally only redraws screen areas when the underlying
6648 buffer contents change, you may need to call `redraw-display' after
6649 changing this variable for it to take effect. */);
6650 Vface_remapping_alist = Qnil;
6652 DEFVAR_LISP ("face-font-rescale-alist", Vface_font_rescale_alist,
6653 doc: /* Alist of fonts vs the rescaling factors.
6654 Each element is a cons (FONT-PATTERN . RESCALE-RATIO), where
6655 FONT-PATTERN is a font-spec or a regular expression matching a font name, and
6656 RESCALE-RATIO is a floating point number to specify how much larger
6657 \(or smaller) font we should use. For instance, if a face requests
6658 a font of 10 point, we actually use a font of 10 * RESCALE-RATIO point. */);
6659 Vface_font_rescale_alist = Qnil;
6661 #ifdef HAVE_WINDOW_SYSTEM
6662 defsubr (&Sbitmap_spec_p);
6663 defsubr (&Sx_list_fonts);
6664 defsubr (&Sinternal_face_x_get_resource);
6665 defsubr (&Sx_family_fonts);
6666 #endif