(vc-git--call, vc-git--out-ok): New funcs.
[emacs.git] / src / xfaces.c
blob36bbacb84ce375be2e8e9197308e41babcae1529
1 /* xfaces.c -- "Face" primitives.
2 Copyright (C) 1993, 1994, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007 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, or (at your option)
10 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; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
22 /* New face implementation by Gerd Moellmann <gerd@gnu.org>. */
24 /* Faces.
26 When using Emacs with X, the display style of characters can be
27 changed by defining `faces'. Each face can specify the following
28 display attributes:
30 1. Font family name.
32 2. Relative proportionate width, aka character set width or set
33 width (swidth), e.g. `semi-compressed'.
35 3. Font height in 1/10pt.
37 4. Font weight, e.g. `bold'.
39 5. Font slant, e.g. `italic'.
41 6. Foreground color.
43 7. Background color.
45 8. Whether or not characters should be underlined, and in what color.
47 9. Whether or not characters should be displayed in inverse video.
49 10. A background stipple, a bitmap.
51 11. Whether or not characters should be overlined, and in what color.
53 12. Whether or not characters should be strike-through, and in what
54 color.
56 13. Whether or not a box should be drawn around characters, the box
57 type, and, for simple boxes, in what color.
59 14. Font or fontset pattern, or nil. This is a special attribute.
60 When this attribute is specified, the face uses a font opened by
61 that pattern as is. In addition, all the other font-related
62 attributes (1st thru 5th) are generated from the opened font name.
63 On the other hand, if one of the other font-related attributes are
64 specified, this attribute is set to nil. In that case, the face
65 doesn't inherit this attribute from the `default' face, and uses a
66 font determined by the other attributes (those may be inherited
67 from the `default' face).
69 15. A face name or list of face names from which to inherit attributes.
71 16. A specified average font width, which is invisible from Lisp,
72 and is used to ensure that a font specified on the command line,
73 for example, can be matched exactly.
75 Faces are frame-local by nature because Emacs allows to define the
76 same named face (face names are symbols) differently for different
77 frames. Each frame has an alist of face definitions for all named
78 faces. The value of a named face in such an alist is a Lisp vector
79 with the symbol `face' in slot 0, and a slot for each of the face
80 attributes mentioned above.
82 There is also a global face alist `Vface_new_frame_defaults'. Face
83 definitions from this list are used to initialize faces of newly
84 created frames.
86 A face doesn't have to specify all attributes. Those not specified
87 have a value of `unspecified'. Faces specifying all attributes but
88 the 14th are called `fully-specified'.
91 Face merging.
93 The display style of a given character in the text is determined by
94 combining several faces. This process is called `face merging'.
95 Any aspect of the display style that isn't specified by overlays or
96 text properties is taken from the `default' face. Since it is made
97 sure that the default face is always fully-specified, face merging
98 always results in a fully-specified face.
101 Face realization.
103 After all face attributes for a character have been determined by
104 merging faces of that character, that face is `realized'. The
105 realization process maps face attributes to what is physically
106 available on the system where Emacs runs. The result is a
107 `realized face' in form of a struct face which is stored in the
108 face cache of the frame on which it was realized.
110 Face realization is done in the context of the character to display
111 because different fonts may be used for different characters. In
112 other words, for characters that have different font
113 specifications, different realized faces are needed to display
114 them.
116 Font specification is done by fontsets. See the comment in
117 fontset.c for the details. In the current implementation, all ASCII
118 characters share the same font in a fontset.
120 Faces are at first realized for ASCII characters, and, at that
121 time, assigned a specific realized fontset. Hereafter, we call
122 such a face as `ASCII face'. When a face for a multibyte character
123 is realized, it inherits (thus shares) a fontset of an ASCII face
124 that has the same attributes other than font-related ones.
126 Thus, all realized face have a realized fontset.
129 Unibyte text.
131 Unibyte text (i.e. raw 8-bit characters) is displayed with the same
132 font as ASCII characters. That is because it is expected that
133 unibyte text users specify a font that is suitable both for ASCII
134 and raw 8-bit characters.
137 Font selection.
139 Font selection tries to find the best available matching font for a
140 given (character, face) combination.
142 If the face specifies a fontset name, that fontset determines a
143 pattern for fonts of the given character. If the face specifies a
144 font name or the other font-related attributes, a fontset is
145 realized from the default fontset. In that case, that
146 specification determines a pattern for ASCII characters and the
147 default fontset determines a pattern for multibyte characters.
149 Available fonts on the system on which Emacs runs are then matched
150 against the font pattern. The result of font selection is the best
151 match for the given face attributes in this font list.
153 Font selection can be influenced by the user.
155 1. The user can specify the relative importance he gives the face
156 attributes width, height, weight, and slant by setting
157 face-font-selection-order (faces.el) to a list of face attribute
158 names. The default is '(:width :height :weight :slant), and means
159 that font selection first tries to find a good match for the font
160 width specified by a face, then---within fonts with that
161 width---tries to find a best match for the specified font height,
162 etc.
164 2. Setting face-font-family-alternatives allows the user to
165 specify alternative font families to try if a family specified by a
166 face doesn't exist.
168 3. Setting face-font-registry-alternatives allows the user to
169 specify all alternative font registries to try for a face
170 specifying a registry.
172 4. Setting face-ignored-fonts allows the user to ignore specific
173 fonts.
176 Character composition.
178 Usually, the realization process is already finished when Emacs
179 actually reflects the desired glyph matrix on the screen. However,
180 on displaying a composition (sequence of characters to be composed
181 on the screen), a suitable font for the components of the
182 composition is selected and realized while drawing them on the
183 screen, i.e. the realization process is delayed but in principle
184 the same.
187 Initialization of basic faces.
189 The faces `default', `modeline' are considered `basic faces'.
190 When redisplay happens the first time for a newly created frame,
191 basic faces are realized for CHARSET_ASCII. Frame parameters are
192 used to fill in unspecified attributes of the default face. */
194 #include <config.h>
195 #include <stdio.h>
196 #include <sys/types.h>
197 #include <sys/stat.h>
198 #include <stdio.h> /* This needs to be before termchar.h */
200 #include "lisp.h"
201 #include "charset.h"
202 #include "keyboard.h"
203 #include "frame.h"
204 #include "termhooks.h"
206 #ifdef HAVE_WINDOW_SYSTEM
207 #include "fontset.h"
208 #endif /* HAVE_WINDOW_SYSTEM */
210 #ifdef HAVE_X_WINDOWS
211 #include "xterm.h"
212 #ifdef USE_MOTIF
213 #include <Xm/Xm.h>
214 #include <Xm/XmStrDefs.h>
215 #endif /* USE_MOTIF */
216 #endif /* HAVE_X_WINDOWS */
218 #ifdef MSDOS
219 #include "dosfns.h"
220 #endif
222 #ifdef WINDOWSNT
223 #include "w32term.h"
224 #include "fontset.h"
225 /* Redefine X specifics to W32 equivalents to avoid cluttering the
226 code with #ifdef blocks. */
227 #undef FRAME_X_DISPLAY_INFO
228 #define FRAME_X_DISPLAY_INFO FRAME_W32_DISPLAY_INFO
229 #define x_display_info w32_display_info
230 #define FRAME_X_FONT_TABLE FRAME_W32_FONT_TABLE
231 #define check_x check_w32
232 #define x_list_fonts w32_list_fonts
233 #define GCGraphicsExposures 0
234 #endif /* WINDOWSNT */
236 #ifdef MAC_OS
237 #include "macterm.h"
238 #define x_display_info mac_display_info
239 #define check_x check_mac
240 #endif /* MAC_OS */
242 #include "buffer.h"
243 #include "dispextern.h"
244 #include "blockinput.h"
245 #include "window.h"
246 #include "intervals.h"
247 #include "termchar.h"
249 #ifdef HAVE_X_WINDOWS
251 /* Compensate for a bug in Xos.h on some systems, on which it requires
252 time.h. On some such systems, Xos.h tries to redefine struct
253 timeval and struct timezone if USG is #defined while it is
254 #included. */
256 #ifdef XOS_NEEDS_TIME_H
257 #include <time.h>
258 #undef USG
259 #include <X11/Xos.h>
260 #define USG
261 #define __TIMEVAL__
262 #else /* not XOS_NEEDS_TIME_H */
263 #include <X11/Xos.h>
264 #endif /* not XOS_NEEDS_TIME_H */
266 #endif /* HAVE_X_WINDOWS */
268 #include <ctype.h>
270 /* Number of pt per inch (from the TeXbook). */
272 #define PT_PER_INCH 72.27
274 /* Non-zero if face attribute ATTR is unspecified. */
276 #define UNSPECIFIEDP(ATTR) EQ ((ATTR), Qunspecified)
278 /* Non-zero if face attribute ATTR is `ignore-defface'. */
280 #define IGNORE_DEFFACE_P(ATTR) EQ ((ATTR), Qignore_defface)
282 /* Value is the number of elements of VECTOR. */
284 #define DIM(VECTOR) (sizeof (VECTOR) / sizeof *(VECTOR))
286 /* Make a copy of string S on the stack using alloca. Value is a pointer
287 to the copy. */
289 #define STRDUPA(S) strcpy ((char *) alloca (strlen ((S)) + 1), (S))
291 /* Make a copy of the contents of Lisp string S on the stack using
292 alloca. Value is a pointer to the copy. */
294 #define LSTRDUPA(S) STRDUPA (SDATA ((S)))
296 /* Size of hash table of realized faces in face caches (should be a
297 prime number). */
299 #define FACE_CACHE_BUCKETS_SIZE 1001
301 /* Keyword symbols used for face attribute names. */
303 Lisp_Object QCfamily, QCheight, QCweight, QCslant, QCunderline;
304 Lisp_Object QCinverse_video, QCforeground, QCbackground, QCstipple;
305 Lisp_Object QCwidth, QCfont, QCbold, QCitalic;
306 Lisp_Object QCreverse_video;
307 Lisp_Object QCoverline, QCstrike_through, QCbox, QCinherit;
309 /* Symbols used for attribute values. */
311 Lisp_Object Qnormal, Qbold, Qultra_light, Qextra_light, Qlight;
312 Lisp_Object Qsemi_light, Qsemi_bold, Qextra_bold, Qultra_bold;
313 Lisp_Object Qoblique, Qitalic, Qreverse_oblique, Qreverse_italic;
314 Lisp_Object Qultra_condensed, Qextra_condensed, Qcondensed;
315 Lisp_Object Qsemi_condensed, Qsemi_expanded, Qexpanded, Qextra_expanded;
316 Lisp_Object Qultra_expanded;
317 Lisp_Object Qreleased_button, Qpressed_button;
318 Lisp_Object QCstyle, QCcolor, QCline_width;
319 Lisp_Object Qunspecified;
320 Lisp_Object Qignore_defface;
322 char unspecified_fg[] = "unspecified-fg", unspecified_bg[] = "unspecified-bg";
324 /* The name of the function to call when the background of the frame
325 has changed, frame_set_background_mode. */
327 Lisp_Object Qframe_set_background_mode;
329 /* Names of basic faces. */
331 Lisp_Object Qdefault, Qtool_bar, Qregion, Qfringe;
332 Lisp_Object Qheader_line, Qscroll_bar, Qcursor, Qborder, Qmouse, Qmenu;
333 Lisp_Object Qmode_line_inactive, Qvertical_border;
334 extern Lisp_Object Qmode_line;
336 /* The symbol `face-alias'. A symbols having that property is an
337 alias for another face. Value of the property is the name of
338 the aliased face. */
340 Lisp_Object Qface_alias;
342 extern Lisp_Object Qcircular_list;
344 /* Default stipple pattern used on monochrome displays. This stipple
345 pattern is used on monochrome displays instead of shades of gray
346 for a face background color. See `set-face-stipple' for possible
347 values for this variable. */
349 Lisp_Object Vface_default_stipple;
351 /* Alist of alternative font families. Each element is of the form
352 (FAMILY FAMILY1 FAMILY2 ...). If fonts of FAMILY can't be loaded,
353 try FAMILY1, then FAMILY2, ... */
355 Lisp_Object Vface_alternative_font_family_alist;
357 /* Alist of alternative font registries. Each element is of the form
358 (REGISTRY REGISTRY1 REGISTRY2...). If fonts of REGISTRY can't be
359 loaded, try REGISTRY1, then REGISTRY2, ... */
361 Lisp_Object Vface_alternative_font_registry_alist;
363 /* Allowed scalable fonts. A value of nil means don't allow any
364 scalable fonts. A value of t means allow the use of any scalable
365 font. Otherwise, value must be a list of regular expressions. A
366 font may be scaled if its name matches a regular expression in the
367 list. */
369 Lisp_Object Vscalable_fonts_allowed, Qscalable_fonts_allowed;
371 /* List of regular expressions that matches names of fonts to ignore. */
373 Lisp_Object Vface_ignored_fonts;
375 /* Alist of font name patterns vs the rescaling factor. */
377 Lisp_Object Vface_font_rescale_alist;
379 /* Maximum number of fonts to consider in font_list. If not an
380 integer > 0, DEFAULT_FONT_LIST_LIMIT is used instead. */
382 Lisp_Object Vfont_list_limit;
383 #define DEFAULT_FONT_LIST_LIMIT 100
385 /* The symbols `foreground-color' and `background-color' which can be
386 used as part of a `face' property. This is for compatibility with
387 Emacs 20.2. */
389 Lisp_Object Qforeground_color, Qbackground_color;
391 /* The symbols `face' and `mouse-face' used as text properties. */
393 Lisp_Object Qface;
394 extern Lisp_Object Qmouse_face;
396 /* Property for basic faces which other faces cannot inherit. */
398 Lisp_Object Qface_no_inherit;
400 /* Error symbol for wrong_type_argument in load_pixmap. */
402 Lisp_Object Qbitmap_spec_p;
404 /* Alist of global face definitions. Each element is of the form
405 (FACE . LFACE) where FACE is a symbol naming a face and LFACE
406 is a Lisp vector of face attributes. These faces are used
407 to initialize faces for new frames. */
409 Lisp_Object Vface_new_frame_defaults;
411 /* The next ID to assign to Lisp faces. */
413 static int next_lface_id;
415 /* A vector mapping Lisp face Id's to face names. */
417 static Lisp_Object *lface_id_to_name;
418 static int lface_id_to_name_size;
420 /* TTY color-related functions (defined in tty-colors.el). */
422 Lisp_Object Qtty_color_desc, Qtty_color_by_index, Qtty_color_standard_values;
424 /* The name of the function used to compute colors on TTYs. */
426 Lisp_Object Qtty_color_alist;
428 /* An alist of defined terminal colors and their RGB values. */
430 Lisp_Object Vtty_defined_color_alist;
432 /* Counter for calls to clear_face_cache. If this counter reaches
433 CLEAR_FONT_TABLE_COUNT, and a frame has more than
434 CLEAR_FONT_TABLE_NFONTS load, unused fonts are freed. */
436 static int clear_font_table_count;
437 #define CLEAR_FONT_TABLE_COUNT 100
438 #define CLEAR_FONT_TABLE_NFONTS 10
440 /* Non-zero means face attributes have been changed since the last
441 redisplay. Used in redisplay_internal. */
443 int face_change_count;
445 /* Non-zero means don't display bold text if a face's foreground
446 and background colors are the inverse of the default colors of the
447 display. This is a kluge to suppress `bold black' foreground text
448 which is hard to read on an LCD monitor. */
450 int tty_suppress_bold_inverse_default_colors_p;
452 /* A list of the form `((x . y))' used to avoid consing in
453 Finternal_set_lisp_face_attribute. */
455 static Lisp_Object Vparam_value_alist;
457 /* The total number of colors currently allocated. */
459 #if GLYPH_DEBUG
460 static int ncolors_allocated;
461 static int npixmaps_allocated;
462 static int ngcs;
463 #endif
465 /* Non-zero means the definition of the `menu' face for new frames has
466 been changed. */
468 int menu_face_changed_default;
471 /* Function prototypes. */
473 struct font_name;
474 struct table_entry;
475 struct named_merge_point;
477 static void map_tty_color P_ ((struct frame *, struct face *,
478 enum lface_attribute_index, int *));
479 static Lisp_Object resolve_face_name P_ ((Lisp_Object, int));
480 static int may_use_scalable_font_p P_ ((const char *));
481 static void set_font_frame_param P_ ((Lisp_Object, Lisp_Object));
482 static int better_font_p P_ ((int *, struct font_name *, struct font_name *,
483 int, int));
484 static int x_face_list_fonts P_ ((struct frame *, char *,
485 struct font_name **, int, int));
486 static int font_scalable_p P_ ((struct font_name *));
487 static int get_lface_attributes P_ ((struct frame *, Lisp_Object, Lisp_Object *, int));
488 static int load_pixmap P_ ((struct frame *, Lisp_Object, unsigned *, unsigned *));
489 static unsigned char *xstrlwr P_ ((unsigned char *));
490 static struct frame *frame_or_selected_frame P_ ((Lisp_Object, int));
491 static void load_face_font P_ ((struct frame *, struct face *, int));
492 static void load_face_colors P_ ((struct frame *, struct face *, Lisp_Object *));
493 static void free_face_colors P_ ((struct frame *, struct face *));
494 static int face_color_gray_p P_ ((struct frame *, char *));
495 static char *build_font_name P_ ((struct font_name *));
496 static void free_font_names P_ ((struct font_name *, int));
497 static int sorted_font_list P_ ((struct frame *, char *,
498 int (*cmpfn) P_ ((const void *, const void *)),
499 struct font_name **));
500 static int font_list_1 P_ ((struct frame *, Lisp_Object, Lisp_Object,
501 Lisp_Object, struct font_name **));
502 static int font_list P_ ((struct frame *, Lisp_Object, Lisp_Object,
503 Lisp_Object, struct font_name **));
504 static int try_font_list P_ ((struct frame *, Lisp_Object *,
505 Lisp_Object, Lisp_Object, struct font_name **,
506 int));
507 static int try_alternative_families P_ ((struct frame *f, Lisp_Object,
508 Lisp_Object, struct font_name **));
509 static int cmp_font_names P_ ((const void *, const void *));
510 static struct face *realize_face P_ ((struct face_cache *, Lisp_Object *, int,
511 struct face *, int));
512 static struct face *realize_x_face P_ ((struct face_cache *,
513 Lisp_Object *, int, struct face *));
514 static struct face *realize_tty_face P_ ((struct face_cache *,
515 Lisp_Object *, int));
516 static int realize_basic_faces P_ ((struct frame *));
517 static int realize_default_face P_ ((struct frame *));
518 static void realize_named_face P_ ((struct frame *, Lisp_Object, int));
519 static int lface_fully_specified_p P_ ((Lisp_Object *));
520 static int lface_equal_p P_ ((Lisp_Object *, Lisp_Object *));
521 static unsigned hash_string_case_insensitive P_ ((Lisp_Object));
522 static unsigned lface_hash P_ ((Lisp_Object *));
523 static int lface_same_font_attributes_p P_ ((Lisp_Object *, Lisp_Object *));
524 static struct face_cache *make_face_cache P_ ((struct frame *));
525 static void free_realized_face P_ ((struct frame *, struct face *));
526 static void clear_face_gcs P_ ((struct face_cache *));
527 static void free_face_cache P_ ((struct face_cache *));
528 static int face_numeric_weight P_ ((Lisp_Object));
529 static int face_numeric_slant P_ ((Lisp_Object));
530 static int face_numeric_swidth P_ ((Lisp_Object));
531 static int face_fontset P_ ((Lisp_Object *));
532 static char *choose_face_font P_ ((struct frame *, Lisp_Object *, int, int, int*));
533 static void merge_face_vectors P_ ((struct frame *, Lisp_Object *, Lisp_Object*,
534 struct named_merge_point *));
535 static int merge_face_ref P_ ((struct frame *, Lisp_Object, Lisp_Object *,
536 int, struct named_merge_point *));
537 static int set_lface_from_font_name P_ ((struct frame *, Lisp_Object,
538 Lisp_Object, int, int));
539 static Lisp_Object lface_from_face_name P_ ((struct frame *, Lisp_Object, int));
540 static struct face *make_realized_face P_ ((Lisp_Object *));
541 static void free_realized_faces P_ ((struct face_cache *));
542 static char *best_matching_font P_ ((struct frame *, Lisp_Object *,
543 struct font_name *, int, int, int *));
544 static void cache_face P_ ((struct face_cache *, struct face *, unsigned));
545 static void uncache_face P_ ((struct face_cache *, struct face *));
546 static int xlfd_numeric_slant P_ ((struct font_name *));
547 static int xlfd_numeric_weight P_ ((struct font_name *));
548 static int xlfd_numeric_swidth P_ ((struct font_name *));
549 static Lisp_Object xlfd_symbolic_slant P_ ((struct font_name *));
550 static Lisp_Object xlfd_symbolic_weight P_ ((struct font_name *));
551 static Lisp_Object xlfd_symbolic_swidth P_ ((struct font_name *));
552 static int xlfd_fixed_p P_ ((struct font_name *));
553 static int xlfd_numeric_value P_ ((struct table_entry *, int, struct font_name *,
554 int, int));
555 static Lisp_Object xlfd_symbolic_value P_ ((struct table_entry *, int,
556 struct font_name *, int,
557 Lisp_Object));
558 static struct table_entry *xlfd_lookup_field_contents P_ ((struct table_entry *, int,
559 struct font_name *, int));
561 #ifdef HAVE_WINDOW_SYSTEM
563 static int split_font_name P_ ((struct frame *, struct font_name *, int));
564 static int xlfd_point_size P_ ((struct frame *, struct font_name *));
565 static void sort_fonts P_ ((struct frame *, struct font_name *, int,
566 int (*cmpfn) P_ ((const void *, const void *))));
567 static GC x_create_gc P_ ((struct frame *, unsigned long, XGCValues *));
568 static void x_free_gc P_ ((struct frame *, GC));
569 static void clear_font_table P_ ((struct x_display_info *));
571 #ifdef WINDOWSNT
572 extern Lisp_Object w32_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
573 #endif /* WINDOWSNT */
575 #ifdef USE_X_TOOLKIT
576 static void x_update_menu_appearance P_ ((struct frame *));
578 extern void free_frame_menubar P_ ((struct frame *));
579 #endif /* USE_X_TOOLKIT */
581 #endif /* HAVE_WINDOW_SYSTEM */
584 /***********************************************************************
585 Utilities
586 ***********************************************************************/
588 #ifdef HAVE_X_WINDOWS
590 #ifdef DEBUG_X_COLORS
592 /* The following is a poor mans infrastructure for debugging X color
593 allocation problems on displays with PseudoColor-8. Some X servers
594 like 3.3.5 XF86_SVGA with Matrox cards apparently don't implement
595 color reference counts completely so that they don't signal an
596 error when a color is freed whose reference count is already 0.
597 Other X servers do. To help me debug this, the following code
598 implements a simple reference counting schema of its own, for a
599 single display/screen. --gerd. */
601 /* Reference counts for pixel colors. */
603 int color_count[256];
605 /* Register color PIXEL as allocated. */
607 void
608 register_color (pixel)
609 unsigned long pixel;
611 xassert (pixel < 256);
612 ++color_count[pixel];
616 /* Register color PIXEL as deallocated. */
618 void
619 unregister_color (pixel)
620 unsigned long pixel;
622 xassert (pixel < 256);
623 if (color_count[pixel] > 0)
624 --color_count[pixel];
625 else
626 abort ();
630 /* Register N colors from PIXELS as deallocated. */
632 void
633 unregister_colors (pixels, n)
634 unsigned long *pixels;
635 int n;
637 int i;
638 for (i = 0; i < n; ++i)
639 unregister_color (pixels[i]);
643 DEFUN ("dump-colors", Fdump_colors, Sdump_colors, 0, 0, 0,
644 doc: /* Dump currently allocated colors to stderr. */)
647 int i, n;
649 fputc ('\n', stderr);
651 for (i = n = 0; i < sizeof color_count / sizeof color_count[0]; ++i)
652 if (color_count[i])
654 fprintf (stderr, "%3d: %5d", i, color_count[i]);
655 ++n;
656 if (n % 5 == 0)
657 fputc ('\n', stderr);
658 else
659 fputc ('\t', stderr);
662 if (n % 5 != 0)
663 fputc ('\n', stderr);
664 return Qnil;
667 #endif /* DEBUG_X_COLORS */
670 /* Free colors used on frame F. PIXELS is an array of NPIXELS pixel
671 color values. Interrupt input must be blocked when this function
672 is called. */
674 void
675 x_free_colors (f, pixels, npixels)
676 struct frame *f;
677 unsigned long *pixels;
678 int npixels;
680 int class = FRAME_X_DISPLAY_INFO (f)->visual->class;
682 /* If display has an immutable color map, freeing colors is not
683 necessary and some servers don't allow it. So don't do it. */
684 if (class != StaticColor && class != StaticGray && class != TrueColor)
686 #ifdef DEBUG_X_COLORS
687 unregister_colors (pixels, npixels);
688 #endif
689 XFreeColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
690 pixels, npixels, 0);
695 /* Free colors used on frame F. PIXELS is an array of NPIXELS pixel
696 color values. Interrupt input must be blocked when this function
697 is called. */
699 void
700 x_free_dpy_colors (dpy, screen, cmap, pixels, npixels)
701 Display *dpy;
702 Screen *screen;
703 Colormap cmap;
704 unsigned long *pixels;
705 int npixels;
707 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
708 int class = dpyinfo->visual->class;
710 /* If display has an immutable color map, freeing colors is not
711 necessary and some servers don't allow it. So don't do it. */
712 if (class != StaticColor && class != StaticGray && class != TrueColor)
714 #ifdef DEBUG_X_COLORS
715 unregister_colors (pixels, npixels);
716 #endif
717 XFreeColors (dpy, cmap, pixels, npixels, 0);
722 /* Create and return a GC for use on frame F. GC values and mask
723 are given by XGCV and MASK. */
725 static INLINE GC
726 x_create_gc (f, mask, xgcv)
727 struct frame *f;
728 unsigned long mask;
729 XGCValues *xgcv;
731 GC gc;
732 BLOCK_INPUT;
733 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), mask, xgcv);
734 UNBLOCK_INPUT;
735 IF_DEBUG (++ngcs);
736 return gc;
740 /* Free GC which was used on frame F. */
742 static INLINE void
743 x_free_gc (f, gc)
744 struct frame *f;
745 GC gc;
747 eassert (interrupt_input_blocked);
748 IF_DEBUG (xassert (--ngcs >= 0));
749 XFreeGC (FRAME_X_DISPLAY (f), gc);
752 #endif /* HAVE_X_WINDOWS */
754 #ifdef WINDOWSNT
755 /* W32 emulation of GCs */
757 static INLINE GC
758 x_create_gc (f, mask, xgcv)
759 struct frame *f;
760 unsigned long mask;
761 XGCValues *xgcv;
763 GC gc;
764 BLOCK_INPUT;
765 gc = XCreateGC (NULL, FRAME_W32_WINDOW (f), mask, xgcv);
766 UNBLOCK_INPUT;
767 IF_DEBUG (++ngcs);
768 return gc;
772 /* Free GC which was used on frame F. */
774 static INLINE void
775 x_free_gc (f, gc)
776 struct frame *f;
777 GC gc;
779 IF_DEBUG (xassert (--ngcs >= 0));
780 xfree (gc);
783 #endif /* WINDOWSNT */
785 #ifdef MAC_OS
786 /* Mac OS emulation of GCs */
788 static INLINE GC
789 x_create_gc (f, mask, xgcv)
790 struct frame *f;
791 unsigned long mask;
792 XGCValues *xgcv;
794 GC gc;
795 BLOCK_INPUT;
796 gc = XCreateGC (FRAME_MAC_DISPLAY (f), FRAME_MAC_WINDOW (f), mask, xgcv);
797 UNBLOCK_INPUT;
798 IF_DEBUG (++ngcs);
799 return gc;
802 static INLINE void
803 x_free_gc (f, gc)
804 struct frame *f;
805 GC gc;
807 eassert (interrupt_input_blocked);
808 IF_DEBUG (xassert (--ngcs >= 0));
809 XFreeGC (FRAME_MAC_DISPLAY (f), gc);
812 #endif /* MAC_OS */
814 /* Like stricmp. Used to compare parts of font names which are in
815 ISO8859-1. */
818 xstricmp (s1, s2)
819 const unsigned char *s1, *s2;
821 while (*s1 && *s2)
823 unsigned char c1 = tolower (*s1);
824 unsigned char c2 = tolower (*s2);
825 if (c1 != c2)
826 return c1 < c2 ? -1 : 1;
827 ++s1, ++s2;
830 if (*s1 == 0)
831 return *s2 == 0 ? 0 : -1;
832 return 1;
836 /* Like strlwr, which might not always be available. */
838 static unsigned char *
839 xstrlwr (s)
840 unsigned char *s;
842 unsigned char *p = s;
844 for (p = s; *p; ++p)
845 /* On Mac OS X 10.3, tolower also converts non-ASCII characters
846 for some locales. */
847 if (isascii (*p))
848 *p = tolower (*p);
850 return s;
854 /* If FRAME is nil, return a pointer to the selected frame.
855 Otherwise, check that FRAME is a live frame, and return a pointer
856 to it. NPARAM is the parameter number of FRAME, for
857 CHECK_LIVE_FRAME. This is here because it's a frequent pattern in
858 Lisp function definitions. */
860 static INLINE struct frame *
861 frame_or_selected_frame (frame, nparam)
862 Lisp_Object frame;
863 int nparam;
865 if (NILP (frame))
866 frame = selected_frame;
868 CHECK_LIVE_FRAME (frame);
869 return XFRAME (frame);
873 /***********************************************************************
874 Frames and faces
875 ***********************************************************************/
877 /* Initialize face cache and basic faces for frame F. */
879 void
880 init_frame_faces (f)
881 struct frame *f;
883 /* Make a face cache, if F doesn't have one. */
884 if (FRAME_FACE_CACHE (f) == NULL)
885 FRAME_FACE_CACHE (f) = make_face_cache (f);
887 #ifdef HAVE_WINDOW_SYSTEM
888 /* Make the image cache. */
889 if (FRAME_WINDOW_P (f))
891 if (FRAME_X_IMAGE_CACHE (f) == NULL)
892 FRAME_X_IMAGE_CACHE (f) = make_image_cache ();
893 ++FRAME_X_IMAGE_CACHE (f)->refcount;
895 #endif /* HAVE_WINDOW_SYSTEM */
897 /* Realize basic faces. Must have enough information in frame
898 parameters to realize basic faces at this point. */
899 #ifdef HAVE_X_WINDOWS
900 if (!FRAME_X_P (f) || FRAME_X_WINDOW (f))
901 #endif
902 #ifdef WINDOWSNT
903 if (!FRAME_WINDOW_P (f) || FRAME_W32_WINDOW (f))
904 #endif
905 #ifdef MAC_OS
906 if (!FRAME_MAC_P (f) || FRAME_MAC_WINDOW (f))
907 #endif
908 if (!realize_basic_faces (f))
909 abort ();
913 /* Free face cache of frame F. Called from Fdelete_frame. */
915 void
916 free_frame_faces (f)
917 struct frame *f;
919 struct face_cache *face_cache = FRAME_FACE_CACHE (f);
921 if (face_cache)
923 free_face_cache (face_cache);
924 FRAME_FACE_CACHE (f) = NULL;
927 #ifdef HAVE_WINDOW_SYSTEM
928 if (FRAME_WINDOW_P (f))
930 struct image_cache *image_cache = FRAME_X_IMAGE_CACHE (f);
931 if (image_cache)
933 --image_cache->refcount;
934 if (image_cache->refcount == 0)
935 free_image_cache (f);
938 #endif /* HAVE_WINDOW_SYSTEM */
942 /* Clear face caches, and recompute basic faces for frame F. Call
943 this after changing frame parameters on which those faces depend,
944 or when realized faces have been freed due to changing attributes
945 of named faces. */
947 void
948 recompute_basic_faces (f)
949 struct frame *f;
951 if (FRAME_FACE_CACHE (f))
953 clear_face_cache (0);
954 if (!realize_basic_faces (f))
955 abort ();
960 /* Clear the face caches of all frames. CLEAR_FONTS_P non-zero means
961 try to free unused fonts, too. */
963 void
964 clear_face_cache (clear_fonts_p)
965 int clear_fonts_p;
967 #ifdef HAVE_WINDOW_SYSTEM
968 Lisp_Object tail, frame;
969 struct frame *f;
971 if (clear_fonts_p
972 || ++clear_font_table_count == CLEAR_FONT_TABLE_COUNT)
974 struct x_display_info *dpyinfo;
976 /* Fonts are common for frames on one display, i.e. on
977 one X screen. */
978 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
979 if (dpyinfo->n_fonts > CLEAR_FONT_TABLE_NFONTS)
980 clear_font_table (dpyinfo);
982 /* From time to time see if we can unload some fonts. This also
983 frees all realized faces on all frames. Fonts needed by
984 faces will be loaded again when faces are realized again. */
985 clear_font_table_count = 0;
987 FOR_EACH_FRAME (tail, frame)
989 struct frame *f = XFRAME (frame);
990 if (FRAME_WINDOW_P (f)
991 && FRAME_X_DISPLAY_INFO (f)->n_fonts > CLEAR_FONT_TABLE_NFONTS)
992 free_all_realized_faces (frame);
995 else
997 /* Clear GCs of realized faces. */
998 FOR_EACH_FRAME (tail, frame)
1000 f = XFRAME (frame);
1001 if (FRAME_WINDOW_P (f))
1003 clear_face_gcs (FRAME_FACE_CACHE (f));
1004 clear_image_cache (f, 0);
1008 #endif /* HAVE_WINDOW_SYSTEM */
1012 DEFUN ("clear-face-cache", Fclear_face_cache, Sclear_face_cache, 0, 1, 0,
1013 doc: /* Clear face caches on all frames.
1014 Optional THOROUGHLY non-nil means try to free unused fonts, too. */)
1015 (thoroughly)
1016 Lisp_Object thoroughly;
1018 clear_face_cache (!NILP (thoroughly));
1019 ++face_change_count;
1020 ++windows_or_buffers_changed;
1021 return Qnil;
1026 #ifdef HAVE_WINDOW_SYSTEM
1029 /* Remove fonts from the font table of DPYINFO except for the default
1030 ASCII fonts of frames on that display. Called from clear_face_cache
1031 from time to time. */
1033 static void
1034 clear_font_table (dpyinfo)
1035 struct x_display_info *dpyinfo;
1037 int i;
1039 /* Free those fonts that are not used by frames on DPYINFO. */
1040 for (i = 0; i < dpyinfo->n_fonts; ++i)
1042 struct font_info *font_info = dpyinfo->font_table + i;
1043 Lisp_Object tail, frame;
1045 /* Check if slot is already free. */
1046 if (font_info->name == NULL)
1047 continue;
1049 /* Don't free a default font of some frame. */
1050 FOR_EACH_FRAME (tail, frame)
1052 struct frame *f = XFRAME (frame);
1053 if (FRAME_WINDOW_P (f)
1054 && font_info->font == FRAME_FONT (f))
1055 break;
1058 if (!NILP (tail))
1059 continue;
1061 /* Free names. */
1062 if (font_info->full_name != font_info->name)
1063 xfree (font_info->full_name);
1064 xfree (font_info->name);
1066 /* Free the font. */
1067 BLOCK_INPUT;
1068 #ifdef HAVE_X_WINDOWS
1069 XFreeFont (dpyinfo->display, font_info->font);
1070 #endif
1071 #ifdef WINDOWSNT
1072 w32_unload_font (dpyinfo, font_info->font);
1073 #endif
1074 #ifdef MAC_OS
1075 mac_unload_font (dpyinfo, font_info->font);
1076 #endif
1077 UNBLOCK_INPUT;
1079 /* Mark font table slot free. */
1080 font_info->font = NULL;
1081 font_info->name = font_info->full_name = NULL;
1085 #endif /* HAVE_WINDOW_SYSTEM */
1089 /***********************************************************************
1090 X Pixmaps
1091 ***********************************************************************/
1093 #ifdef HAVE_WINDOW_SYSTEM
1095 DEFUN ("bitmap-spec-p", Fbitmap_spec_p, Sbitmap_spec_p, 1, 1, 0,
1096 doc: /* Value is non-nil if OBJECT is a valid bitmap specification.
1097 A bitmap specification is either a string, a file name, or a list
1098 \(WIDTH HEIGHT DATA) where WIDTH is the pixel width of the bitmap,
1099 HEIGHT is its height, and DATA is a string containing the bits of
1100 the pixmap. Bits are stored row by row, each row occupies
1101 \(WIDTH + 7)/8 bytes. */)
1102 (object)
1103 Lisp_Object object;
1105 int pixmap_p = 0;
1107 if (STRINGP (object))
1108 /* If OBJECT is a string, it's a file name. */
1109 pixmap_p = 1;
1110 else if (CONSP (object))
1112 /* Otherwise OBJECT must be (WIDTH HEIGHT DATA), WIDTH and
1113 HEIGHT must be integers > 0, and DATA must be string large
1114 enough to hold a bitmap of the specified size. */
1115 Lisp_Object width, height, data;
1117 height = width = data = Qnil;
1119 if (CONSP (object))
1121 width = XCAR (object);
1122 object = XCDR (object);
1123 if (CONSP (object))
1125 height = XCAR (object);
1126 object = XCDR (object);
1127 if (CONSP (object))
1128 data = XCAR (object);
1132 if (NATNUMP (width) && NATNUMP (height) && STRINGP (data))
1134 int bytes_per_row = ((XFASTINT (width) + BITS_PER_CHAR - 1)
1135 / BITS_PER_CHAR);
1136 if (SBYTES (data) >= bytes_per_row * XINT (height))
1137 pixmap_p = 1;
1141 return pixmap_p ? Qt : Qnil;
1145 /* Load a bitmap according to NAME (which is either a file name or a
1146 pixmap spec) for use on frame F. Value is the bitmap_id (see
1147 xfns.c). If NAME is nil, return with a bitmap id of zero. If
1148 bitmap cannot be loaded, display a message saying so, and return
1149 zero. Store the bitmap width in *W_PTR and its height in *H_PTR,
1150 if these pointers are not null. */
1152 static int
1153 load_pixmap (f, name, w_ptr, h_ptr)
1154 FRAME_PTR f;
1155 Lisp_Object name;
1156 unsigned int *w_ptr, *h_ptr;
1158 int bitmap_id;
1160 if (NILP (name))
1161 return 0;
1163 CHECK_TYPE (!NILP (Fbitmap_spec_p (name)), Qbitmap_spec_p, name);
1165 BLOCK_INPUT;
1166 if (CONSP (name))
1168 /* Decode a bitmap spec into a bitmap. */
1170 int h, w;
1171 Lisp_Object bits;
1173 w = XINT (Fcar (name));
1174 h = XINT (Fcar (Fcdr (name)));
1175 bits = Fcar (Fcdr (Fcdr (name)));
1177 bitmap_id = x_create_bitmap_from_data (f, SDATA (bits),
1178 w, h);
1180 else
1182 /* It must be a string -- a file name. */
1183 bitmap_id = x_create_bitmap_from_file (f, name);
1185 UNBLOCK_INPUT;
1187 if (bitmap_id < 0)
1189 add_to_log ("Invalid or undefined bitmap `%s'", name, Qnil);
1190 bitmap_id = 0;
1192 if (w_ptr)
1193 *w_ptr = 0;
1194 if (h_ptr)
1195 *h_ptr = 0;
1197 else
1199 #if GLYPH_DEBUG
1200 ++npixmaps_allocated;
1201 #endif
1202 if (w_ptr)
1203 *w_ptr = x_bitmap_width (f, bitmap_id);
1205 if (h_ptr)
1206 *h_ptr = x_bitmap_height (f, bitmap_id);
1209 return bitmap_id;
1212 #endif /* HAVE_WINDOW_SYSTEM */
1216 /***********************************************************************
1217 Fonts
1218 ***********************************************************************/
1220 #ifdef HAVE_WINDOW_SYSTEM
1222 /* Load font of face FACE which is used on frame F to display
1223 character C. The name of the font to load is determined by lface
1224 and fontset of FACE. */
1226 static void
1227 load_face_font (f, face, c)
1228 struct frame *f;
1229 struct face *face;
1230 int c;
1232 struct font_info *font_info = NULL;
1233 char *font_name;
1234 int needs_overstrike;
1236 face->font_info_id = -1;
1237 face->font = NULL;
1239 font_name = choose_face_font (f, face->lface, face->fontset, c,
1240 &needs_overstrike);
1241 if (!font_name)
1242 return;
1244 BLOCK_INPUT;
1245 font_info = FS_LOAD_FACE_FONT (f, c, font_name, face);
1246 UNBLOCK_INPUT;
1248 if (font_info)
1250 face->font_info_id = font_info->font_idx;
1251 face->font = font_info->font;
1252 face->font_name = font_info->full_name;
1253 face->overstrike = needs_overstrike;
1254 if (face->gc)
1256 BLOCK_INPUT;
1257 x_free_gc (f, face->gc);
1258 face->gc = 0;
1259 UNBLOCK_INPUT;
1262 else
1263 add_to_log ("Unable to load font %s",
1264 build_string (font_name), Qnil);
1265 xfree (font_name);
1268 #endif /* HAVE_WINDOW_SYSTEM */
1272 /***********************************************************************
1273 X Colors
1274 ***********************************************************************/
1276 /* Parse RGB_LIST, and fill in the RGB fields of COLOR.
1277 RGB_LIST should contain (at least) 3 lisp integers.
1278 Return 0 if there's a problem with RGB_LIST, otherwise return 1. */
1280 static int
1281 parse_rgb_list (rgb_list, color)
1282 Lisp_Object rgb_list;
1283 XColor *color;
1285 #define PARSE_RGB_LIST_FIELD(field) \
1286 if (CONSP (rgb_list) && INTEGERP (XCAR (rgb_list))) \
1288 color->field = XINT (XCAR (rgb_list)); \
1289 rgb_list = XCDR (rgb_list); \
1291 else \
1292 return 0;
1294 PARSE_RGB_LIST_FIELD (red);
1295 PARSE_RGB_LIST_FIELD (green);
1296 PARSE_RGB_LIST_FIELD (blue);
1298 return 1;
1302 /* Lookup on frame F the color described by the lisp string COLOR.
1303 The resulting tty color is returned in TTY_COLOR; if STD_COLOR is
1304 non-zero, then the `standard' definition of the same color is
1305 returned in it. */
1307 static int
1308 tty_lookup_color (f, color, tty_color, std_color)
1309 struct frame *f;
1310 Lisp_Object color;
1311 XColor *tty_color, *std_color;
1313 Lisp_Object frame, color_desc;
1315 if (!STRINGP (color) || NILP (Ffboundp (Qtty_color_desc)))
1316 return 0;
1318 XSETFRAME (frame, f);
1320 color_desc = call2 (Qtty_color_desc, color, frame);
1321 if (CONSP (color_desc) && CONSP (XCDR (color_desc)))
1323 Lisp_Object rgb;
1325 if (! INTEGERP (XCAR (XCDR (color_desc))))
1326 return 0;
1328 tty_color->pixel = XINT (XCAR (XCDR (color_desc)));
1330 rgb = XCDR (XCDR (color_desc));
1331 if (! parse_rgb_list (rgb, tty_color))
1332 return 0;
1334 /* Should we fill in STD_COLOR too? */
1335 if (std_color)
1337 /* Default STD_COLOR to the same as TTY_COLOR. */
1338 *std_color = *tty_color;
1340 /* Do a quick check to see if the returned descriptor is
1341 actually _exactly_ equal to COLOR, otherwise we have to
1342 lookup STD_COLOR separately. If it's impossible to lookup
1343 a standard color, we just give up and use TTY_COLOR. */
1344 if ((!STRINGP (XCAR (color_desc))
1345 || NILP (Fstring_equal (color, XCAR (color_desc))))
1346 && !NILP (Ffboundp (Qtty_color_standard_values)))
1348 /* Look up STD_COLOR separately. */
1349 rgb = call1 (Qtty_color_standard_values, color);
1350 if (! parse_rgb_list (rgb, std_color))
1351 return 0;
1355 return 1;
1357 else if (NILP (Fsymbol_value (intern ("tty-defined-color-alist"))))
1358 /* We were called early during startup, and the colors are not
1359 yet set up in tty-defined-color-alist. Don't return a failure
1360 indication, since this produces the annoying "Unable to
1361 load color" messages in the *Messages* buffer. */
1362 return 1;
1363 else
1364 /* tty-color-desc seems to have returned a bad value. */
1365 return 0;
1368 /* A version of defined_color for non-X frames. */
1371 tty_defined_color (f, color_name, color_def, alloc)
1372 struct frame *f;
1373 char *color_name;
1374 XColor *color_def;
1375 int alloc;
1377 int status = 1;
1379 /* Defaults. */
1380 color_def->pixel = FACE_TTY_DEFAULT_COLOR;
1381 color_def->red = 0;
1382 color_def->blue = 0;
1383 color_def->green = 0;
1385 if (*color_name)
1386 status = tty_lookup_color (f, build_string (color_name), color_def, 0);
1388 if (color_def->pixel == FACE_TTY_DEFAULT_COLOR && *color_name)
1390 if (strcmp (color_name, "unspecified-fg") == 0)
1391 color_def->pixel = FACE_TTY_DEFAULT_FG_COLOR;
1392 else if (strcmp (color_name, "unspecified-bg") == 0)
1393 color_def->pixel = FACE_TTY_DEFAULT_BG_COLOR;
1396 if (color_def->pixel != FACE_TTY_DEFAULT_COLOR)
1397 status = 1;
1399 return status;
1403 /* Decide if color named COLOR_NAME is valid for the display
1404 associated with the frame F; if so, return the rgb values in
1405 COLOR_DEF. If ALLOC is nonzero, allocate a new colormap cell.
1407 This does the right thing for any type of frame. */
1410 defined_color (f, color_name, color_def, alloc)
1411 struct frame *f;
1412 char *color_name;
1413 XColor *color_def;
1414 int alloc;
1416 if (!FRAME_WINDOW_P (f))
1417 return tty_defined_color (f, color_name, color_def, alloc);
1418 #ifdef HAVE_X_WINDOWS
1419 else if (FRAME_X_P (f))
1420 return x_defined_color (f, color_name, color_def, alloc);
1421 #endif
1422 #ifdef WINDOWSNT
1423 else if (FRAME_W32_P (f))
1424 return w32_defined_color (f, color_name, color_def, alloc);
1425 #endif
1426 #ifdef MAC_OS
1427 else if (FRAME_MAC_P (f))
1428 return mac_defined_color (f, color_name, color_def, alloc);
1429 #endif
1430 else
1431 abort ();
1435 /* Given the index IDX of a tty color on frame F, return its name, a
1436 Lisp string. */
1438 Lisp_Object
1439 tty_color_name (f, idx)
1440 struct frame *f;
1441 int idx;
1443 if (idx >= 0 && !NILP (Ffboundp (Qtty_color_by_index)))
1445 Lisp_Object frame;
1446 Lisp_Object coldesc;
1448 XSETFRAME (frame, f);
1449 coldesc = call2 (Qtty_color_by_index, make_number (idx), frame);
1451 if (!NILP (coldesc))
1452 return XCAR (coldesc);
1454 #ifdef MSDOS
1455 /* We can have an MSDOG frame under -nw for a short window of
1456 opportunity before internal_terminal_init is called. DTRT. */
1457 if (FRAME_MSDOS_P (f) && !inhibit_window_system)
1458 return msdos_stdcolor_name (idx);
1459 #endif
1461 if (idx == FACE_TTY_DEFAULT_FG_COLOR)
1462 return build_string (unspecified_fg);
1463 if (idx == FACE_TTY_DEFAULT_BG_COLOR)
1464 return build_string (unspecified_bg);
1466 #ifdef WINDOWSNT
1467 return vga_stdcolor_name (idx);
1468 #endif
1470 return Qunspecified;
1474 /* Return non-zero if COLOR_NAME is a shade of gray (or white or
1475 black) on frame F.
1477 The criterion implemented here is not a terribly sophisticated one. */
1479 static int
1480 face_color_gray_p (f, color_name)
1481 struct frame *f;
1482 char *color_name;
1484 XColor color;
1485 int gray_p;
1487 if (defined_color (f, color_name, &color, 0))
1488 gray_p = (/* Any color sufficiently close to black counts as grey. */
1489 (color.red < 5000 && color.green < 5000 && color.blue < 5000)
1491 ((eabs (color.red - color.green)
1492 < max (color.red, color.green) / 20)
1493 && (eabs (color.green - color.blue)
1494 < max (color.green, color.blue) / 20)
1495 && (eabs (color.blue - color.red)
1496 < max (color.blue, color.red) / 20)));
1497 else
1498 gray_p = 0;
1500 return gray_p;
1504 /* Return non-zero if color COLOR_NAME can be displayed on frame F.
1505 BACKGROUND_P non-zero means the color will be used as background
1506 color. */
1508 static int
1509 face_color_supported_p (f, color_name, background_p)
1510 struct frame *f;
1511 char *color_name;
1512 int background_p;
1514 Lisp_Object frame;
1515 XColor not_used;
1517 XSETFRAME (frame, f);
1518 return
1519 #ifdef HAVE_WINDOW_SYSTEM
1520 FRAME_WINDOW_P (f)
1521 ? (!NILP (Fxw_display_color_p (frame))
1522 || xstricmp (color_name, "black") == 0
1523 || xstricmp (color_name, "white") == 0
1524 || (background_p
1525 && face_color_gray_p (f, color_name))
1526 || (!NILP (Fx_display_grayscale_p (frame))
1527 && face_color_gray_p (f, color_name)))
1529 #endif
1530 tty_defined_color (f, color_name, &not_used, 0);
1534 DEFUN ("color-gray-p", Fcolor_gray_p, Scolor_gray_p, 1, 2, 0,
1535 doc: /* Return non-nil if COLOR is a shade of gray (or white or black).
1536 FRAME specifies the frame and thus the display for interpreting COLOR.
1537 If FRAME is nil or omitted, use the selected frame. */)
1538 (color, frame)
1539 Lisp_Object color, frame;
1541 struct frame *f;
1543 CHECK_STRING (color);
1544 if (NILP (frame))
1545 frame = selected_frame;
1546 else
1547 CHECK_FRAME (frame);
1548 f = XFRAME (frame);
1549 return face_color_gray_p (f, SDATA (color)) ? Qt : Qnil;
1553 DEFUN ("color-supported-p", Fcolor_supported_p,
1554 Scolor_supported_p, 1, 3, 0,
1555 doc: /* Return non-nil if COLOR can be displayed on FRAME.
1556 BACKGROUND-P non-nil means COLOR is used as a background.
1557 Otherwise, this function tells whether it can be used as a foreground.
1558 If FRAME is nil or omitted, use the selected frame.
1559 COLOR must be a valid color name. */)
1560 (color, frame, background_p)
1561 Lisp_Object frame, color, background_p;
1563 struct frame *f;
1565 CHECK_STRING (color);
1566 if (NILP (frame))
1567 frame = selected_frame;
1568 else
1569 CHECK_FRAME (frame);
1570 f = XFRAME (frame);
1571 if (face_color_supported_p (f, SDATA (color), !NILP (background_p)))
1572 return Qt;
1573 return Qnil;
1577 /* Load color with name NAME for use by face FACE on frame F.
1578 TARGET_INDEX must be one of LFACE_FOREGROUND_INDEX,
1579 LFACE_BACKGROUND_INDEX, LFACE_UNDERLINE_INDEX, LFACE_OVERLINE_INDEX,
1580 LFACE_STRIKE_THROUGH_INDEX, or LFACE_BOX_INDEX. Value is the
1581 pixel color. If color cannot be loaded, display a message, and
1582 return the foreground, background or underline color of F, but
1583 record that fact in flags of the face so that we don't try to free
1584 these colors. */
1586 unsigned long
1587 load_color (f, face, name, target_index)
1588 struct frame *f;
1589 struct face *face;
1590 Lisp_Object name;
1591 enum lface_attribute_index target_index;
1593 XColor color;
1595 xassert (STRINGP (name));
1596 xassert (target_index == LFACE_FOREGROUND_INDEX
1597 || target_index == LFACE_BACKGROUND_INDEX
1598 || target_index == LFACE_UNDERLINE_INDEX
1599 || target_index == LFACE_OVERLINE_INDEX
1600 || target_index == LFACE_STRIKE_THROUGH_INDEX
1601 || target_index == LFACE_BOX_INDEX);
1603 /* if the color map is full, defined_color will return a best match
1604 to the values in an existing cell. */
1605 if (!defined_color (f, SDATA (name), &color, 1))
1607 add_to_log ("Unable to load color \"%s\"", name, Qnil);
1609 switch (target_index)
1611 case LFACE_FOREGROUND_INDEX:
1612 face->foreground_defaulted_p = 1;
1613 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1614 break;
1616 case LFACE_BACKGROUND_INDEX:
1617 face->background_defaulted_p = 1;
1618 color.pixel = FRAME_BACKGROUND_PIXEL (f);
1619 break;
1621 case LFACE_UNDERLINE_INDEX:
1622 face->underline_defaulted_p = 1;
1623 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1624 break;
1626 case LFACE_OVERLINE_INDEX:
1627 face->overline_color_defaulted_p = 1;
1628 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1629 break;
1631 case LFACE_STRIKE_THROUGH_INDEX:
1632 face->strike_through_color_defaulted_p = 1;
1633 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1634 break;
1636 case LFACE_BOX_INDEX:
1637 face->box_color_defaulted_p = 1;
1638 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1639 break;
1641 default:
1642 abort ();
1645 #if GLYPH_DEBUG
1646 else
1647 ++ncolors_allocated;
1648 #endif
1650 return color.pixel;
1654 #ifdef HAVE_WINDOW_SYSTEM
1656 /* Load colors for face FACE which is used on frame F. Colors are
1657 specified by slots LFACE_BACKGROUND_INDEX and LFACE_FOREGROUND_INDEX
1658 of ATTRS. If the background color specified is not supported on F,
1659 try to emulate gray colors with a stipple from Vface_default_stipple. */
1661 static void
1662 load_face_colors (f, face, attrs)
1663 struct frame *f;
1664 struct face *face;
1665 Lisp_Object *attrs;
1667 Lisp_Object fg, bg;
1669 bg = attrs[LFACE_BACKGROUND_INDEX];
1670 fg = attrs[LFACE_FOREGROUND_INDEX];
1672 /* Swap colors if face is inverse-video. */
1673 if (EQ (attrs[LFACE_INVERSE_INDEX], Qt))
1675 Lisp_Object tmp;
1676 tmp = fg;
1677 fg = bg;
1678 bg = tmp;
1681 /* Check for support for foreground, not for background because
1682 face_color_supported_p is smart enough to know that grays are
1683 "supported" as background because we are supposed to use stipple
1684 for them. */
1685 if (!face_color_supported_p (f, SDATA (bg), 0)
1686 && !NILP (Fbitmap_spec_p (Vface_default_stipple)))
1688 x_destroy_bitmap (f, face->stipple);
1689 face->stipple = load_pixmap (f, Vface_default_stipple,
1690 &face->pixmap_w, &face->pixmap_h);
1693 face->background = load_color (f, face, bg, LFACE_BACKGROUND_INDEX);
1694 face->foreground = load_color (f, face, fg, LFACE_FOREGROUND_INDEX);
1698 /* Free color PIXEL on frame F. */
1700 void
1701 unload_color (f, pixel)
1702 struct frame *f;
1703 unsigned long pixel;
1705 #ifdef HAVE_X_WINDOWS
1706 if (pixel != -1)
1708 BLOCK_INPUT;
1709 x_free_colors (f, &pixel, 1);
1710 UNBLOCK_INPUT;
1712 #endif
1716 /* Free colors allocated for FACE. */
1718 static void
1719 free_face_colors (f, face)
1720 struct frame *f;
1721 struct face *face;
1723 #ifdef HAVE_X_WINDOWS
1724 if (face->colors_copied_bitwise_p)
1725 return;
1727 BLOCK_INPUT;
1729 if (!face->foreground_defaulted_p)
1731 x_free_colors (f, &face->foreground, 1);
1732 IF_DEBUG (--ncolors_allocated);
1735 if (!face->background_defaulted_p)
1737 x_free_colors (f, &face->background, 1);
1738 IF_DEBUG (--ncolors_allocated);
1741 if (face->underline_p
1742 && !face->underline_defaulted_p)
1744 x_free_colors (f, &face->underline_color, 1);
1745 IF_DEBUG (--ncolors_allocated);
1748 if (face->overline_p
1749 && !face->overline_color_defaulted_p)
1751 x_free_colors (f, &face->overline_color, 1);
1752 IF_DEBUG (--ncolors_allocated);
1755 if (face->strike_through_p
1756 && !face->strike_through_color_defaulted_p)
1758 x_free_colors (f, &face->strike_through_color, 1);
1759 IF_DEBUG (--ncolors_allocated);
1762 if (face->box != FACE_NO_BOX
1763 && !face->box_color_defaulted_p)
1765 x_free_colors (f, &face->box_color, 1);
1766 IF_DEBUG (--ncolors_allocated);
1769 UNBLOCK_INPUT;
1770 #endif /* HAVE_X_WINDOWS */
1773 #endif /* HAVE_WINDOW_SYSTEM */
1777 /***********************************************************************
1778 XLFD Font Names
1779 ***********************************************************************/
1781 /* An enumerator for each field of an XLFD font name. */
1783 enum xlfd_field
1785 XLFD_FOUNDRY,
1786 XLFD_FAMILY,
1787 XLFD_WEIGHT,
1788 XLFD_SLANT,
1789 XLFD_SWIDTH,
1790 XLFD_ADSTYLE,
1791 XLFD_PIXEL_SIZE,
1792 XLFD_POINT_SIZE,
1793 XLFD_RESX,
1794 XLFD_RESY,
1795 XLFD_SPACING,
1796 XLFD_AVGWIDTH,
1797 XLFD_REGISTRY,
1798 XLFD_ENCODING,
1799 XLFD_LAST
1802 /* An enumerator for each possible slant value of a font. Taken from
1803 the XLFD specification. */
1805 enum xlfd_slant
1807 XLFD_SLANT_UNKNOWN,
1808 XLFD_SLANT_ROMAN,
1809 XLFD_SLANT_ITALIC,
1810 XLFD_SLANT_OBLIQUE,
1811 XLFD_SLANT_REVERSE_ITALIC,
1812 XLFD_SLANT_REVERSE_OBLIQUE,
1813 XLFD_SLANT_OTHER
1816 /* Relative font weight according to XLFD documentation. */
1818 enum xlfd_weight
1820 XLFD_WEIGHT_UNKNOWN,
1821 XLFD_WEIGHT_ULTRA_LIGHT, /* 10 */
1822 XLFD_WEIGHT_EXTRA_LIGHT, /* 20 */
1823 XLFD_WEIGHT_LIGHT, /* 30 */
1824 XLFD_WEIGHT_SEMI_LIGHT, /* 40: SemiLight, Book, ... */
1825 XLFD_WEIGHT_MEDIUM, /* 50: Medium, Normal, Regular, ... */
1826 XLFD_WEIGHT_SEMI_BOLD, /* 60: SemiBold, DemiBold, ... */
1827 XLFD_WEIGHT_BOLD, /* 70: Bold, ... */
1828 XLFD_WEIGHT_EXTRA_BOLD, /* 80: ExtraBold, Heavy, ... */
1829 XLFD_WEIGHT_ULTRA_BOLD /* 90: UltraBold, Black, ... */
1832 /* Relative proportionate width. */
1834 enum xlfd_swidth
1836 XLFD_SWIDTH_UNKNOWN,
1837 XLFD_SWIDTH_ULTRA_CONDENSED, /* 10 */
1838 XLFD_SWIDTH_EXTRA_CONDENSED, /* 20 */
1839 XLFD_SWIDTH_CONDENSED, /* 30: Condensed, Narrow, Compressed, ... */
1840 XLFD_SWIDTH_SEMI_CONDENSED, /* 40: semicondensed */
1841 XLFD_SWIDTH_MEDIUM, /* 50: Medium, Normal, Regular, ... */
1842 XLFD_SWIDTH_SEMI_EXPANDED, /* 60: SemiExpanded, DemiExpanded, ... */
1843 XLFD_SWIDTH_EXPANDED, /* 70: Expanded... */
1844 XLFD_SWIDTH_EXTRA_EXPANDED, /* 80: ExtraExpanded, Wide... */
1845 XLFD_SWIDTH_ULTRA_EXPANDED /* 90: UltraExpanded... */
1848 /* Structure used for tables mapping XLFD weight, slant, and width
1849 names to numeric and symbolic values. */
1851 struct table_entry
1853 char *name;
1854 int numeric;
1855 Lisp_Object *symbol;
1858 /* Table of XLFD slant names and their numeric and symbolic
1859 representations. This table must be sorted by slant names in
1860 ascending order. */
1862 static struct table_entry slant_table[] =
1864 {"i", XLFD_SLANT_ITALIC, &Qitalic},
1865 {"o", XLFD_SLANT_OBLIQUE, &Qoblique},
1866 {"ot", XLFD_SLANT_OTHER, &Qitalic},
1867 {"r", XLFD_SLANT_ROMAN, &Qnormal},
1868 {"ri", XLFD_SLANT_REVERSE_ITALIC, &Qreverse_italic},
1869 {"ro", XLFD_SLANT_REVERSE_OBLIQUE, &Qreverse_oblique}
1872 /* Table of XLFD weight names. This table must be sorted by weight
1873 names in ascending order. */
1875 static struct table_entry weight_table[] =
1877 {"black", XLFD_WEIGHT_ULTRA_BOLD, &Qultra_bold},
1878 {"bold", XLFD_WEIGHT_BOLD, &Qbold},
1879 {"book", XLFD_WEIGHT_SEMI_LIGHT, &Qsemi_light},
1880 {"demi", XLFD_WEIGHT_SEMI_BOLD, &Qsemi_bold},
1881 {"demibold", XLFD_WEIGHT_SEMI_BOLD, &Qsemi_bold},
1882 {"extralight", XLFD_WEIGHT_EXTRA_LIGHT, &Qextra_light},
1883 {"extrabold", XLFD_WEIGHT_EXTRA_BOLD, &Qextra_bold},
1884 {"heavy", XLFD_WEIGHT_EXTRA_BOLD, &Qextra_bold},
1885 {"light", XLFD_WEIGHT_LIGHT, &Qlight},
1886 {"medium", XLFD_WEIGHT_MEDIUM, &Qnormal},
1887 {"normal", XLFD_WEIGHT_MEDIUM, &Qnormal},
1888 {"regular", XLFD_WEIGHT_MEDIUM, &Qnormal},
1889 {"semibold", XLFD_WEIGHT_SEMI_BOLD, &Qsemi_bold},
1890 {"semilight", XLFD_WEIGHT_SEMI_LIGHT, &Qsemi_light},
1891 {"ultralight", XLFD_WEIGHT_ULTRA_LIGHT, &Qultra_light},
1892 {"ultrabold", XLFD_WEIGHT_ULTRA_BOLD, &Qultra_bold}
1895 /* Table of XLFD width names. This table must be sorted by width
1896 names in ascending order. */
1898 static struct table_entry swidth_table[] =
1900 {"compressed", XLFD_SWIDTH_CONDENSED, &Qcondensed},
1901 {"condensed", XLFD_SWIDTH_CONDENSED, &Qcondensed},
1902 {"demiexpanded", XLFD_SWIDTH_SEMI_EXPANDED, &Qsemi_expanded},
1903 {"expanded", XLFD_SWIDTH_EXPANDED, &Qexpanded},
1904 {"extracondensed", XLFD_SWIDTH_EXTRA_CONDENSED, &Qextra_condensed},
1905 {"extraexpanded", XLFD_SWIDTH_EXTRA_EXPANDED, &Qextra_expanded},
1906 {"medium", XLFD_SWIDTH_MEDIUM, &Qnormal},
1907 {"narrow", XLFD_SWIDTH_CONDENSED, &Qcondensed},
1908 {"normal", XLFD_SWIDTH_MEDIUM, &Qnormal},
1909 {"regular", XLFD_SWIDTH_MEDIUM, &Qnormal},
1910 {"semicondensed", XLFD_SWIDTH_SEMI_CONDENSED, &Qsemi_condensed},
1911 {"semiexpanded", XLFD_SWIDTH_SEMI_EXPANDED, &Qsemi_expanded},
1912 {"ultracondensed", XLFD_SWIDTH_ULTRA_CONDENSED, &Qultra_condensed},
1913 {"ultraexpanded", XLFD_SWIDTH_ULTRA_EXPANDED, &Qultra_expanded},
1914 {"wide", XLFD_SWIDTH_EXTRA_EXPANDED, &Qextra_expanded}
1917 /* Structure used to hold the result of splitting font names in XLFD
1918 format into their fields. */
1920 struct font_name
1922 /* The original name which is modified destructively by
1923 split_font_name. The pointer is kept here to be able to free it
1924 if it was allocated from the heap. */
1925 char *name;
1927 /* Font name fields. Each vector element points into `name' above.
1928 Fields are NUL-terminated. */
1929 char *fields[XLFD_LAST];
1931 /* Numeric values for those fields that interest us. See
1932 split_font_name for which these are. */
1933 int numeric[XLFD_LAST];
1935 /* If the original name matches one of Vface_font_rescale_alist,
1936 the value is the corresponding rescale ratio. Otherwise, the
1937 value is 1.0. */
1938 double rescale_ratio;
1940 /* Lower value mean higher priority. */
1941 int registry_priority;
1944 /* The frame in effect when sorting font names. Set temporarily in
1945 sort_fonts so that it is available in font comparison functions. */
1947 static struct frame *font_frame;
1949 /* Order by which font selection chooses fonts. The default values
1950 mean `first, find a best match for the font width, then for the
1951 font height, then for weight, then for slant.' This variable can be
1952 set via set-face-font-sort-order. */
1954 #ifdef MAC_OS
1955 static int font_sort_order[4] = {
1956 XLFD_SWIDTH, XLFD_POINT_SIZE, XLFD_WEIGHT, XLFD_SLANT
1958 #else
1959 static int font_sort_order[4];
1960 #endif
1962 /* Look up FONT.fields[FIELD_INDEX] in TABLE which has DIM entries.
1963 TABLE must be sorted by TABLE[i]->name in ascending order. Value
1964 is a pointer to the matching table entry or null if no table entry
1965 matches. */
1967 static struct table_entry *
1968 xlfd_lookup_field_contents (table, dim, font, field_index)
1969 struct table_entry *table;
1970 int dim;
1971 struct font_name *font;
1972 int field_index;
1974 /* Function split_font_name converts fields to lower-case, so there
1975 is no need to use xstrlwr or xstricmp here. */
1976 char *s = font->fields[field_index];
1977 int low, mid, high, cmp;
1979 low = 0;
1980 high = dim - 1;
1982 while (low <= high)
1984 mid = (low + high) / 2;
1985 cmp = strcmp (table[mid].name, s);
1987 if (cmp < 0)
1988 low = mid + 1;
1989 else if (cmp > 0)
1990 high = mid - 1;
1991 else
1992 return table + mid;
1995 return NULL;
1999 /* Return a numeric representation for font name field
2000 FONT.fields[FIELD_INDEX]. The field is looked up in TABLE which
2001 has DIM entries. Value is the numeric value found or DFLT if no
2002 table entry matches. This function is used to translate weight,
2003 slant, and swidth names of XLFD font names to numeric values. */
2005 static INLINE int
2006 xlfd_numeric_value (table, dim, font, field_index, dflt)
2007 struct table_entry *table;
2008 int dim;
2009 struct font_name *font;
2010 int field_index;
2011 int dflt;
2013 struct table_entry *p;
2014 p = xlfd_lookup_field_contents (table, dim, font, field_index);
2015 return p ? p->numeric : dflt;
2019 /* Return a symbolic representation for font name field
2020 FONT.fields[FIELD_INDEX]. The field is looked up in TABLE which
2021 has DIM entries. Value is the symbolic value found or DFLT if no
2022 table entry matches. This function is used to translate weight,
2023 slant, and swidth names of XLFD font names to symbols. */
2025 static INLINE Lisp_Object
2026 xlfd_symbolic_value (table, dim, font, field_index, dflt)
2027 struct table_entry *table;
2028 int dim;
2029 struct font_name *font;
2030 int field_index;
2031 Lisp_Object dflt;
2033 struct table_entry *p;
2034 p = xlfd_lookup_field_contents (table, dim, font, field_index);
2035 return p ? *p->symbol : dflt;
2039 /* Return a numeric value for the slant of the font given by FONT. */
2041 static INLINE int
2042 xlfd_numeric_slant (font)
2043 struct font_name *font;
2045 return xlfd_numeric_value (slant_table, DIM (slant_table),
2046 font, XLFD_SLANT, XLFD_SLANT_ROMAN);
2050 /* Return a symbol representing the weight of the font given by FONT. */
2052 static INLINE Lisp_Object
2053 xlfd_symbolic_slant (font)
2054 struct font_name *font;
2056 return xlfd_symbolic_value (slant_table, DIM (slant_table),
2057 font, XLFD_SLANT, Qnormal);
2061 /* Return a numeric value for the weight of the font given by FONT. */
2063 static INLINE int
2064 xlfd_numeric_weight (font)
2065 struct font_name *font;
2067 return xlfd_numeric_value (weight_table, DIM (weight_table),
2068 font, XLFD_WEIGHT, XLFD_WEIGHT_MEDIUM);
2072 /* Return a symbol representing the slant of the font given by FONT. */
2074 static INLINE Lisp_Object
2075 xlfd_symbolic_weight (font)
2076 struct font_name *font;
2078 return xlfd_symbolic_value (weight_table, DIM (weight_table),
2079 font, XLFD_WEIGHT, Qnormal);
2083 /* Return a numeric value for the swidth of the font whose XLFD font
2084 name fields are found in FONT. */
2086 static INLINE int
2087 xlfd_numeric_swidth (font)
2088 struct font_name *font;
2090 return xlfd_numeric_value (swidth_table, DIM (swidth_table),
2091 font, XLFD_SWIDTH, XLFD_SWIDTH_MEDIUM);
2095 /* Return a symbolic value for the swidth of FONT. */
2097 static INLINE Lisp_Object
2098 xlfd_symbolic_swidth (font)
2099 struct font_name *font;
2101 return xlfd_symbolic_value (swidth_table, DIM (swidth_table),
2102 font, XLFD_SWIDTH, Qnormal);
2106 /* Look up the entry of SYMBOL in the vector TABLE which has DIM
2107 entries. Value is a pointer to the matching table entry or null if
2108 no element of TABLE contains SYMBOL. */
2110 static struct table_entry *
2111 face_value (table, dim, symbol)
2112 struct table_entry *table;
2113 int dim;
2114 Lisp_Object symbol;
2116 int i;
2118 xassert (SYMBOLP (symbol));
2120 for (i = 0; i < dim; ++i)
2121 if (EQ (*table[i].symbol, symbol))
2122 break;
2124 return i < dim ? table + i : NULL;
2128 /* Return a numeric value for SYMBOL in the vector TABLE which has DIM
2129 entries. Value is -1 if SYMBOL is not found in TABLE. */
2131 static INLINE int
2132 face_numeric_value (table, dim, symbol)
2133 struct table_entry *table;
2134 int dim;
2135 Lisp_Object symbol;
2137 struct table_entry *p = face_value (table, dim, symbol);
2138 return p ? p->numeric : -1;
2142 /* Return a numeric value representing the weight specified by Lisp
2143 symbol WEIGHT. Value is one of the enumerators of enum
2144 xlfd_weight. */
2146 static INLINE int
2147 face_numeric_weight (weight)
2148 Lisp_Object weight;
2150 return face_numeric_value (weight_table, DIM (weight_table), weight);
2154 /* Return a numeric value representing the slant specified by Lisp
2155 symbol SLANT. Value is one of the enumerators of enum xlfd_slant. */
2157 static INLINE int
2158 face_numeric_slant (slant)
2159 Lisp_Object slant;
2161 return face_numeric_value (slant_table, DIM (slant_table), slant);
2165 /* Return a numeric value representing the swidth specified by Lisp
2166 symbol WIDTH. Value is one of the enumerators of enum xlfd_swidth. */
2168 static int
2169 face_numeric_swidth (width)
2170 Lisp_Object width;
2172 return face_numeric_value (swidth_table, DIM (swidth_table), width);
2176 #ifdef HAVE_WINDOW_SYSTEM
2178 /* Return non-zero if FONT is the name of a fixed-pitch font. */
2180 static INLINE int
2181 xlfd_fixed_p (font)
2182 struct font_name *font;
2184 /* Function split_font_name converts fields to lower-case, so there
2185 is no need to use tolower here. */
2186 return *font->fields[XLFD_SPACING] != 'p';
2190 /* Return the point size of FONT on frame F, measured in 1/10 pt.
2192 The actual height of the font when displayed on F depends on the
2193 resolution of both the font and frame. For example, a 10pt font
2194 designed for a 100dpi display will display larger than 10pt on a
2195 75dpi display. (It's not unusual to use fonts not designed for the
2196 display one is using. For example, some intlfonts are available in
2197 72dpi versions, only.)
2199 Value is the real point size of FONT on frame F, or 0 if it cannot
2200 be determined. */
2202 static INLINE int
2203 xlfd_point_size (f, font)
2204 struct frame *f;
2205 struct font_name *font;
2207 double resy = FRAME_X_DISPLAY_INFO (f)->resy;
2208 char *pixel_field = font->fields[XLFD_PIXEL_SIZE];
2209 double pixel;
2210 int real_pt;
2212 if (*pixel_field == '[')
2214 /* The pixel size field is `[A B C D]' which specifies
2215 a transformation matrix.
2217 A B 0
2218 C D 0
2219 0 0 1
2221 by which all glyphs of the font are transformed. The spec
2222 says that s scalar value N for the pixel size is equivalent
2223 to A = N * resx/resy, B = C = 0, D = N. */
2224 char *start = pixel_field + 1, *end;
2225 double matrix[4];
2226 int i;
2228 for (i = 0; i < 4; ++i)
2230 matrix[i] = strtod (start, &end);
2231 start = end;
2234 pixel = matrix[3];
2236 else
2237 pixel = atoi (pixel_field);
2239 if (pixel == 0)
2240 real_pt = 0;
2241 else
2242 real_pt = PT_PER_INCH * 10.0 * pixel / resy + 0.5;
2244 return real_pt;
2248 /* Return point size of PIXEL dots while considering Y-resultion (DPI)
2249 of frame F. This function is used to guess a point size of font
2250 when only the pixel height of the font is available. */
2252 static INLINE int
2253 pixel_point_size (f, pixel)
2254 struct frame *f;
2255 int pixel;
2257 double resy = FRAME_X_DISPLAY_INFO (f)->resy;
2258 double real_pt;
2259 int int_pt;
2261 /* As one inch is PT_PER_INCH points, PT_PER_INCH/RESY gives the
2262 point size of one dot. */
2263 real_pt = pixel * PT_PER_INCH / resy;
2264 int_pt = real_pt + 0.5;
2266 return int_pt;
2270 /* Return a rescaling ratio of a font of NAME. */
2272 static double
2273 font_rescale_ratio (name)
2274 char *name;
2276 Lisp_Object tail, elt;
2278 for (tail = Vface_font_rescale_alist; CONSP (tail); tail = XCDR (tail))
2280 elt = XCAR (tail);
2281 if (STRINGP (XCAR (elt)) && FLOATP (XCDR (elt))
2282 && fast_c_string_match_ignore_case (XCAR (elt), name) >= 0)
2283 return XFLOAT_DATA (XCDR (elt));
2285 return 1.0;
2289 /* Split XLFD font name FONT->name destructively into NUL-terminated,
2290 lower-case fields in FONT->fields. NUMERIC_P non-zero means
2291 compute numeric values for fields XLFD_POINT_SIZE, XLFD_SWIDTH,
2292 XLFD_RESY, XLFD_SLANT, and XLFD_WEIGHT in FONT->numeric. Value is
2293 zero if the font name doesn't have the format we expect. The
2294 expected format is a font name that starts with a `-' and has
2295 XLFD_LAST fields separated by `-'. */
2297 static int
2298 split_font_name (f, font, numeric_p)
2299 struct frame *f;
2300 struct font_name *font;
2301 int numeric_p;
2303 int i = 0;
2304 int success_p;
2305 double rescale_ratio;
2307 if (numeric_p)
2308 /* This must be done before splitting the font name. */
2309 rescale_ratio = font_rescale_ratio (font->name);
2311 if (*font->name == '-')
2313 char *p = xstrlwr (font->name) + 1;
2315 while (i < XLFD_LAST)
2317 font->fields[i] = p;
2318 ++i;
2320 /* Pixel and point size may be of the form `[....]'. For
2321 BNF, see XLFD spec, chapter 4. Negative values are
2322 indicated by tilde characters which we replace with
2323 `-' characters, here. */
2324 if (*p == '['
2325 && (i - 1 == XLFD_PIXEL_SIZE
2326 || i - 1 == XLFD_POINT_SIZE))
2328 char *start, *end;
2329 int j;
2331 for (++p; *p && *p != ']'; ++p)
2332 if (*p == '~')
2333 *p = '-';
2335 /* Check that the matrix contains 4 floating point
2336 numbers. */
2337 for (j = 0, start = font->fields[i - 1] + 1;
2338 j < 4;
2339 ++j, start = end)
2340 if (strtod (start, &end) == 0 && start == end)
2341 break;
2343 if (j < 4)
2344 break;
2347 while (*p && *p != '-')
2348 ++p;
2350 if (*p != '-')
2351 break;
2353 *p++ = 0;
2357 success_p = i == XLFD_LAST;
2359 /* If requested, and font name was in the expected format,
2360 compute numeric values for some fields. */
2361 if (numeric_p && success_p)
2363 font->numeric[XLFD_POINT_SIZE] = xlfd_point_size (f, font);
2364 font->numeric[XLFD_RESY] = atoi (font->fields[XLFD_RESY]);
2365 font->numeric[XLFD_SLANT] = xlfd_numeric_slant (font);
2366 font->numeric[XLFD_WEIGHT] = xlfd_numeric_weight (font);
2367 font->numeric[XLFD_SWIDTH] = xlfd_numeric_swidth (font);
2368 font->numeric[XLFD_AVGWIDTH] = atoi (font->fields[XLFD_AVGWIDTH]);
2369 font->rescale_ratio = rescale_ratio;
2372 /* Initialize it to zero. It will be overridden by font_list while
2373 trying alternate registries. */
2374 font->registry_priority = 0;
2376 return success_p;
2380 /* Build an XLFD font name from font name fields in FONT. Value is a
2381 pointer to the font name, which is allocated via xmalloc. */
2383 static char *
2384 build_font_name (font)
2385 struct font_name *font;
2387 int i;
2388 int size = 100;
2389 char *font_name = (char *) xmalloc (size);
2390 int total_length = 0;
2392 for (i = 0; i < XLFD_LAST; ++i)
2394 /* Add 1 because of the leading `-'. */
2395 int len = strlen (font->fields[i]) + 1;
2397 /* Reallocate font_name if necessary. Add 1 for the final
2398 NUL-byte. */
2399 if (total_length + len + 1 >= size)
2401 int new_size = max (2 * size, size + len + 1);
2402 int sz = new_size * sizeof *font_name;
2403 font_name = (char *) xrealloc (font_name, sz);
2404 size = new_size;
2407 font_name[total_length] = '-';
2408 bcopy (font->fields[i], font_name + total_length + 1, len - 1);
2409 total_length += len;
2412 font_name[total_length] = 0;
2413 return font_name;
2417 /* Free an array FONTS of N font_name structures. This frees FONTS
2418 itself and all `name' fields in its elements. */
2420 static INLINE void
2421 free_font_names (fonts, n)
2422 struct font_name *fonts;
2423 int n;
2425 while (n)
2426 xfree (fonts[--n].name);
2427 xfree (fonts);
2431 /* Sort vector FONTS of font_name structures which contains NFONTS
2432 elements using qsort and comparison function CMPFN. F is the frame
2433 on which the fonts will be used. The global variable font_frame
2434 is temporarily set to F to make it available in CMPFN. */
2436 static INLINE void
2437 sort_fonts (f, fonts, nfonts, cmpfn)
2438 struct frame *f;
2439 struct font_name *fonts;
2440 int nfonts;
2441 int (*cmpfn) P_ ((const void *, const void *));
2443 font_frame = f;
2444 qsort (fonts, nfonts, sizeof *fonts, cmpfn);
2445 font_frame = NULL;
2449 /* Get fonts matching PATTERN on frame F. If F is null, use the first
2450 display in x_display_list. FONTS is a pointer to a vector of
2451 NFONTS font_name structures. TRY_ALTERNATIVES_P non-zero means try
2452 alternative patterns from Valternate_fontname_alist if no fonts are
2453 found matching PATTERN.
2455 For all fonts found, set FONTS[i].name to the name of the font,
2456 allocated via xmalloc, and split font names into fields. Ignore
2457 fonts that we can't parse. Value is the number of fonts found. */
2459 static int
2460 x_face_list_fonts (f, pattern, pfonts, nfonts, try_alternatives_p)
2461 struct frame *f;
2462 char *pattern;
2463 struct font_name **pfonts;
2464 int nfonts, try_alternatives_p;
2466 int n, nignored;
2468 /* NTEMACS_TODO : currently this uses w32_list_fonts, but it may be
2469 better to do it the other way around. */
2470 Lisp_Object lfonts;
2471 Lisp_Object lpattern, tem;
2472 struct font_name *fonts = 0;
2473 int num_fonts = nfonts;
2475 *pfonts = 0;
2476 lpattern = build_string (pattern);
2478 /* Get the list of fonts matching PATTERN. */
2479 #ifdef WINDOWSNT
2480 BLOCK_INPUT;
2481 lfonts = w32_list_fonts (f, lpattern, 0, nfonts);
2482 UNBLOCK_INPUT;
2483 #else
2484 lfonts = x_list_fonts (f, lpattern, -1, nfonts);
2485 #endif
2487 if (nfonts < 0 && CONSP (lfonts))
2488 num_fonts = XFASTINT (Flength (lfonts));
2490 /* Make a copy of the font names we got from X, and
2491 split them into fields. */
2492 n = nignored = 0;
2493 for (tem = lfonts; CONSP (tem) && n < num_fonts; tem = XCDR (tem))
2495 Lisp_Object elt, tail;
2496 const char *name = SDATA (XCAR (tem));
2498 /* Ignore fonts matching a pattern from face-ignored-fonts. */
2499 for (tail = Vface_ignored_fonts; CONSP (tail); tail = XCDR (tail))
2501 elt = XCAR (tail);
2502 if (STRINGP (elt)
2503 && fast_c_string_match_ignore_case (elt, name) >= 0)
2504 break;
2506 if (!NILP (tail))
2508 ++nignored;
2509 continue;
2512 if (! fonts)
2514 *pfonts = (struct font_name *) xmalloc (num_fonts * sizeof **pfonts);
2515 fonts = *pfonts;
2518 /* Make a copy of the font name. */
2519 fonts[n].name = xstrdup (name);
2521 if (split_font_name (f, fonts + n, 1))
2523 if (font_scalable_p (fonts + n)
2524 && !may_use_scalable_font_p (name))
2526 ++nignored;
2527 xfree (fonts[n].name);
2529 else
2530 ++n;
2532 else
2533 xfree (fonts[n].name);
2536 /* If no fonts found, try patterns from Valternate_fontname_alist. */
2537 if (n == 0 && try_alternatives_p)
2539 Lisp_Object list = Valternate_fontname_alist;
2541 if (*pfonts)
2543 xfree (*pfonts);
2544 *pfonts = 0;
2547 while (CONSP (list))
2549 Lisp_Object entry = XCAR (list);
2550 if (CONSP (entry)
2551 && STRINGP (XCAR (entry))
2552 && strcmp (SDATA (XCAR (entry)), pattern) == 0)
2553 break;
2554 list = XCDR (list);
2557 if (CONSP (list))
2559 Lisp_Object patterns = XCAR (list);
2560 Lisp_Object name;
2562 while (CONSP (patterns)
2563 /* If list is screwed up, give up. */
2564 && (name = XCAR (patterns),
2565 STRINGP (name))
2566 /* Ignore patterns equal to PATTERN because we tried that
2567 already with no success. */
2568 && (strcmp (SDATA (name), pattern) == 0
2569 || (n = x_face_list_fonts (f, SDATA (name),
2570 pfonts, nfonts, 0),
2571 n == 0)))
2572 patterns = XCDR (patterns);
2576 return n;
2580 /* Check if a font matching pattern_offset_t on frame F is available
2581 or not. PATTERN may be a cons (FAMILY . REGISTRY), in which case,
2582 a font name pattern is generated from FAMILY and REGISTRY. */
2585 face_font_available_p (f, pattern)
2586 struct frame *f;
2587 Lisp_Object pattern;
2589 Lisp_Object fonts;
2591 if (! STRINGP (pattern))
2593 Lisp_Object family, registry;
2594 char *family_str, *registry_str, *pattern_str;
2596 CHECK_CONS (pattern);
2597 family = XCAR (pattern);
2598 if (NILP (family))
2599 family_str = "*";
2600 else
2602 CHECK_STRING (family);
2603 family_str = (char *) SDATA (family);
2605 registry = XCDR (pattern);
2606 if (NILP (registry))
2607 registry_str = "*";
2608 else
2610 CHECK_STRING (registry);
2611 registry_str = (char *) SDATA (registry);
2614 pattern_str = (char *) alloca (strlen (family_str)
2615 + strlen (registry_str)
2616 + 10);
2617 strcpy (pattern_str, index (family_str, '-') ? "-" : "-*-");
2618 strcat (pattern_str, family_str);
2619 strcat (pattern_str, "-*-");
2620 strcat (pattern_str, registry_str);
2621 if (!index (registry_str, '-'))
2623 if (registry_str[strlen (registry_str) - 1] == '*')
2624 strcat (pattern_str, "-*");
2625 else
2626 strcat (pattern_str, "*-*");
2628 pattern = build_string (pattern_str);
2631 /* Get the list of fonts matching PATTERN. */
2632 #ifdef WINDOWSNT
2633 BLOCK_INPUT;
2634 fonts = w32_list_fonts (f, pattern, 0, 1);
2635 UNBLOCK_INPUT;
2636 #else
2637 fonts = x_list_fonts (f, pattern, -1, 1);
2638 #endif
2639 return XINT (Flength (fonts));
2643 /* Determine fonts matching PATTERN on frame F. Sort resulting fonts
2644 using comparison function CMPFN. Value is the number of fonts
2645 found. If value is non-zero, *FONTS is set to a vector of
2646 font_name structures allocated from the heap containing matching
2647 fonts. Each element of *FONTS contains a name member that is also
2648 allocated from the heap. Font names in these structures are split
2649 into fields. Use free_font_names to free such an array. */
2651 static int
2652 sorted_font_list (f, pattern, cmpfn, fonts)
2653 struct frame *f;
2654 char *pattern;
2655 int (*cmpfn) P_ ((const void *, const void *));
2656 struct font_name **fonts;
2658 int nfonts;
2660 /* Get the list of fonts matching pattern. 100 should suffice. */
2661 nfonts = DEFAULT_FONT_LIST_LIMIT;
2662 if (INTEGERP (Vfont_list_limit))
2663 nfonts = XINT (Vfont_list_limit);
2665 *fonts = NULL;
2666 nfonts = x_face_list_fonts (f, pattern, fonts, nfonts, 1);
2668 /* Sort the resulting array and return it in *FONTS. If no
2669 fonts were found, make sure to set *FONTS to null. */
2670 if (nfonts)
2671 sort_fonts (f, *fonts, nfonts, cmpfn);
2672 else if (*fonts)
2674 xfree (*fonts);
2675 *fonts = NULL;
2678 return nfonts;
2682 /* Compare two font_name structures *A and *B. Value is analogous to
2683 strcmp. Sort order is given by the global variable
2684 font_sort_order. Font names are sorted so that, everything else
2685 being equal, fonts with a resolution closer to that of the frame on
2686 which they are used are listed first. The global variable
2687 font_frame is the frame on which we operate. */
2689 static int
2690 cmp_font_names (a, b)
2691 const void *a, *b;
2693 struct font_name *x = (struct font_name *) a;
2694 struct font_name *y = (struct font_name *) b;
2695 int cmp;
2697 /* All strings have been converted to lower-case by split_font_name,
2698 so we can use strcmp here. */
2699 cmp = strcmp (x->fields[XLFD_FAMILY], y->fields[XLFD_FAMILY]);
2700 if (cmp == 0)
2702 int i;
2704 for (i = 0; i < DIM (font_sort_order) && cmp == 0; ++i)
2706 int j = font_sort_order[i];
2707 cmp = x->numeric[j] - y->numeric[j];
2710 if (cmp == 0)
2712 /* Everything else being equal, we prefer fonts with an
2713 y-resolution closer to that of the frame. */
2714 int resy = FRAME_X_DISPLAY_INFO (font_frame)->resy;
2715 int x_resy = x->numeric[XLFD_RESY];
2716 int y_resy = y->numeric[XLFD_RESY];
2717 cmp = eabs (resy - x_resy) - eabs (resy - y_resy);
2721 return cmp;
2725 /* Get a sorted list of fonts of family FAMILY on frame F. If PATTERN
2726 is non-nil list fonts matching that pattern. Otherwise, if
2727 REGISTRY is non-nil return only fonts with that registry, otherwise
2728 return fonts of any registry. Set *FONTS to a vector of font_name
2729 structures allocated from the heap containing the fonts found.
2730 Value is the number of fonts found. */
2732 static int
2733 font_list_1 (f, pattern, family, registry, fonts)
2734 struct frame *f;
2735 Lisp_Object pattern, family, registry;
2736 struct font_name **fonts;
2738 char *pattern_str, *family_str, *registry_str;
2740 if (NILP (pattern))
2742 family_str = (NILP (family) ? "*" : (char *) SDATA (family));
2743 registry_str = (NILP (registry) ? "*" : (char *) SDATA (registry));
2745 pattern_str = (char *) alloca (strlen (family_str)
2746 + strlen (registry_str)
2747 + 10);
2748 strcpy (pattern_str, index (family_str, '-') ? "-" : "-*-");
2749 strcat (pattern_str, family_str);
2750 strcat (pattern_str, "-*-");
2751 strcat (pattern_str, registry_str);
2752 if (!index (registry_str, '-'))
2754 if (registry_str[strlen (registry_str) - 1] == '*')
2755 strcat (pattern_str, "-*");
2756 else
2757 strcat (pattern_str, "*-*");
2760 else
2761 pattern_str = (char *) SDATA (pattern);
2763 return sorted_font_list (f, pattern_str, cmp_font_names, fonts);
2767 /* Concatenate font list FONTS1 and FONTS2. FONTS1 and FONTS2
2768 contains NFONTS1 fonts and NFONTS2 fonts respectively. Return a
2769 pointer to a newly allocated font list. FONTS1 and FONTS2 are
2770 freed. */
2772 static struct font_name *
2773 concat_font_list (fonts1, nfonts1, fonts2, nfonts2)
2774 struct font_name *fonts1, *fonts2;
2775 int nfonts1, nfonts2;
2777 int new_nfonts = nfonts1 + nfonts2;
2778 struct font_name *new_fonts;
2780 new_fonts = (struct font_name *) xmalloc (sizeof *new_fonts * new_nfonts);
2781 bcopy (fonts1, new_fonts, sizeof *new_fonts * nfonts1);
2782 bcopy (fonts2, new_fonts + nfonts1, sizeof *new_fonts * nfonts2);
2783 xfree (fonts1);
2784 xfree (fonts2);
2785 return new_fonts;
2789 /* Get a sorted list of fonts of family FAMILY on frame F.
2791 If PATTERN is non-nil list fonts matching that pattern.
2793 If REGISTRY is non-nil, return fonts with that registry and the
2794 alternative registries from Vface_alternative_font_registry_alist.
2796 If REGISTRY is nil return fonts of any registry.
2798 Set *FONTS to a vector of font_name structures allocated from the
2799 heap containing the fonts found. Value is the number of fonts
2800 found. */
2802 static int
2803 font_list (f, pattern, family, registry, fonts)
2804 struct frame *f;
2805 Lisp_Object pattern, family, registry;
2806 struct font_name **fonts;
2808 int nfonts = font_list_1 (f, pattern, family, registry, fonts);
2810 if (!NILP (registry)
2811 && CONSP (Vface_alternative_font_registry_alist))
2813 Lisp_Object alter;
2815 alter = Fassoc (registry, Vface_alternative_font_registry_alist);
2816 if (CONSP (alter))
2818 int reg_prio, i;
2820 for (alter = XCDR (alter), reg_prio = 1;
2821 CONSP (alter);
2822 alter = XCDR (alter), reg_prio++)
2823 if (STRINGP (XCAR (alter)))
2825 int nfonts2;
2826 struct font_name *fonts2;
2828 nfonts2 = font_list_1 (f, pattern, family, XCAR (alter),
2829 &fonts2);
2830 for (i = 0; i < nfonts2; i++)
2831 fonts2[i].registry_priority = reg_prio;
2832 *fonts = (nfonts > 0
2833 ? concat_font_list (*fonts, nfonts, fonts2, nfonts2)
2834 : fonts2);
2835 nfonts += nfonts2;
2840 return nfonts;
2844 /* Remove elements from LIST whose cars are `equal'. Called from
2845 x-family-fonts and x-font-family-list to remove duplicate font
2846 entries. */
2848 static void
2849 remove_duplicates (list)
2850 Lisp_Object list;
2852 Lisp_Object tail = list;
2854 while (!NILP (tail) && !NILP (XCDR (tail)))
2856 Lisp_Object next = XCDR (tail);
2857 if (!NILP (Fequal (XCAR (next), XCAR (tail))))
2858 XSETCDR (tail, XCDR (next));
2859 else
2860 tail = XCDR (tail);
2865 DEFUN ("x-family-fonts", Fx_family_fonts, Sx_family_fonts, 0, 2, 0,
2866 doc: /* Return a list of available fonts of family FAMILY on FRAME.
2867 If FAMILY is omitted or nil, list all families.
2868 Otherwise, FAMILY must be a string, possibly containing wildcards
2869 `?' and `*'.
2870 If FRAME is omitted or nil, use the selected frame.
2871 Each element of the result is a vector [FAMILY WIDTH POINT-SIZE WEIGHT
2872 SLANT FIXED-P FULL REGISTRY-AND-ENCODING].
2873 FAMILY is the font family name. POINT-SIZE is the size of the
2874 font in 1/10 pt. WIDTH, WEIGHT, and SLANT are symbols describing the
2875 width, weight and slant of the font. These symbols are the same as for
2876 face attributes. FIXED-P is non-nil if the font is fixed-pitch.
2877 FULL is the full name of the font, and REGISTRY-AND-ENCODING is a string
2878 giving the registry and encoding of the font.
2879 The result list is sorted according to the current setting of
2880 the face font sort order. */)
2881 (family, frame)
2882 Lisp_Object family, frame;
2884 struct frame *f = check_x_frame (frame);
2885 struct font_name *fonts;
2886 int i, nfonts;
2887 Lisp_Object result;
2888 struct gcpro gcpro1;
2890 if (!NILP (family))
2891 CHECK_STRING (family);
2893 result = Qnil;
2894 GCPRO1 (result);
2895 nfonts = font_list (f, Qnil, family, Qnil, &fonts);
2896 for (i = nfonts - 1; i >= 0; --i)
2898 Lisp_Object v = Fmake_vector (make_number (8), Qnil);
2899 char *tem;
2901 ASET (v, 0, build_string (fonts[i].fields[XLFD_FAMILY]));
2902 ASET (v, 1, xlfd_symbolic_swidth (fonts + i));
2903 ASET (v, 2, make_number (xlfd_point_size (f, fonts + i)));
2904 ASET (v, 3, xlfd_symbolic_weight (fonts + i));
2905 ASET (v, 4, xlfd_symbolic_slant (fonts + i));
2906 ASET (v, 5, xlfd_fixed_p (fonts + i) ? Qt : Qnil);
2907 tem = build_font_name (fonts + i);
2908 ASET (v, 6, build_string (tem));
2909 sprintf (tem, "%s-%s", fonts[i].fields[XLFD_REGISTRY],
2910 fonts[i].fields[XLFD_ENCODING]);
2911 ASET (v, 7, build_string (tem));
2912 xfree (tem);
2914 result = Fcons (v, result);
2917 remove_duplicates (result);
2918 free_font_names (fonts, nfonts);
2919 UNGCPRO;
2920 return result;
2924 DEFUN ("x-font-family-list", Fx_font_family_list, Sx_font_family_list,
2925 0, 1, 0,
2926 doc: /* Return a list of available font families on FRAME.
2927 If FRAME is omitted or nil, use the selected frame.
2928 Value is a list of conses (FAMILY . FIXED-P) where FAMILY
2929 is a font family, and FIXED-P is non-nil if fonts of that family
2930 are fixed-pitch. */)
2931 (frame)
2932 Lisp_Object frame;
2934 struct frame *f = check_x_frame (frame);
2935 int nfonts, i;
2936 struct font_name *fonts;
2937 Lisp_Object result;
2938 struct gcpro gcpro1;
2939 int count = SPECPDL_INDEX ();
2941 /* Let's consider all fonts. */
2942 specbind (intern ("font-list-limit"), make_number (-1));
2943 nfonts = font_list (f, Qnil, Qnil, Qnil, &fonts);
2945 result = Qnil;
2946 GCPRO1 (result);
2947 for (i = nfonts - 1; i >= 0; --i)
2948 result = Fcons (Fcons (build_string (fonts[i].fields[XLFD_FAMILY]),
2949 xlfd_fixed_p (fonts + i) ? Qt : Qnil),
2950 result);
2952 remove_duplicates (result);
2953 free_font_names (fonts, nfonts);
2954 UNGCPRO;
2955 return unbind_to (count, result);
2959 DEFUN ("x-list-fonts", Fx_list_fonts, Sx_list_fonts, 1, 5, 0,
2960 doc: /* Return a list of the names of available fonts matching PATTERN.
2961 If optional arguments FACE and FRAME are specified, return only fonts
2962 the same size as FACE on FRAME.
2963 PATTERN is a string, perhaps with wildcard characters;
2964 the * character matches any substring, and
2965 the ? character matches any single character.
2966 PATTERN is case-insensitive.
2967 FACE is a face name--a symbol.
2969 The return value is a list of strings, suitable as arguments to
2970 set-face-font.
2972 Fonts Emacs can't use may or may not be excluded
2973 even if they match PATTERN and FACE.
2974 The optional fourth argument MAXIMUM sets a limit on how many
2975 fonts to match. The first MAXIMUM fonts are reported.
2976 The optional fifth argument WIDTH, if specified, is a number of columns
2977 occupied by a character of a font. In that case, return only fonts
2978 the WIDTH times as wide as FACE on FRAME. */)
2979 (pattern, face, frame, maximum, width)
2980 Lisp_Object pattern, face, frame, maximum, width;
2982 struct frame *f;
2983 int size;
2984 int maxnames;
2986 check_x ();
2987 CHECK_STRING (pattern);
2989 if (NILP (maximum))
2990 maxnames = -1;
2991 else
2993 CHECK_NATNUM (maximum);
2994 maxnames = XINT (maximum);
2997 if (!NILP (width))
2998 CHECK_NUMBER (width);
3000 /* We can't simply call check_x_frame because this function may be
3001 called before any frame is created. */
3002 f = frame_or_selected_frame (frame, 2);
3003 if (!FRAME_WINDOW_P (f))
3005 /* Perhaps we have not yet created any frame. */
3006 f = NULL;
3007 face = Qnil;
3010 /* Determine the width standard for comparison with the fonts we find. */
3012 if (NILP (face))
3013 size = 0;
3014 else
3016 /* This is of limited utility since it works with character
3017 widths. Keep it for compatibility. --gerd. */
3018 int face_id = lookup_named_face (f, face, 0, 0);
3019 struct face *face = (face_id < 0
3020 ? NULL
3021 : FACE_FROM_ID (f, face_id));
3023 #ifdef WINDOWSNT
3024 /* For historic reasons, FONT_WIDTH refers to average width on W32,
3025 not maximum as on X. Redefine here. */
3026 #undef FONT_WIDTH
3027 #define FONT_WIDTH FONT_MAX_WIDTH
3028 #endif
3030 if (face && face->font)
3031 size = FONT_WIDTH (face->font);
3032 else
3033 size = FONT_WIDTH (FRAME_FONT (f)); /* FRAME_COLUMN_WIDTH (f) */
3035 if (!NILP (width))
3036 size *= XINT (width);
3040 Lisp_Object args[2];
3042 args[0] = x_list_fonts (f, pattern, size, maxnames);
3043 if (f == NULL)
3044 /* We don't have to check fontsets. */
3045 return args[0];
3046 args[1] = list_fontsets (f, pattern, size);
3047 return Fnconc (2, args);
3051 #endif /* HAVE_WINDOW_SYSTEM */
3055 /***********************************************************************
3056 Lisp Faces
3057 ***********************************************************************/
3059 /* Access face attributes of face LFACE, a Lisp vector. */
3061 #define LFACE_FAMILY(LFACE) AREF ((LFACE), LFACE_FAMILY_INDEX)
3062 #define LFACE_HEIGHT(LFACE) AREF ((LFACE), LFACE_HEIGHT_INDEX)
3063 #define LFACE_WEIGHT(LFACE) AREF ((LFACE), LFACE_WEIGHT_INDEX)
3064 #define LFACE_SLANT(LFACE) AREF ((LFACE), LFACE_SLANT_INDEX)
3065 #define LFACE_UNDERLINE(LFACE) AREF ((LFACE), LFACE_UNDERLINE_INDEX)
3066 #define LFACE_INVERSE(LFACE) AREF ((LFACE), LFACE_INVERSE_INDEX)
3067 #define LFACE_FOREGROUND(LFACE) AREF ((LFACE), LFACE_FOREGROUND_INDEX)
3068 #define LFACE_BACKGROUND(LFACE) AREF ((LFACE), LFACE_BACKGROUND_INDEX)
3069 #define LFACE_STIPPLE(LFACE) AREF ((LFACE), LFACE_STIPPLE_INDEX)
3070 #define LFACE_SWIDTH(LFACE) AREF ((LFACE), LFACE_SWIDTH_INDEX)
3071 #define LFACE_OVERLINE(LFACE) AREF ((LFACE), LFACE_OVERLINE_INDEX)
3072 #define LFACE_STRIKE_THROUGH(LFACE) AREF ((LFACE), LFACE_STRIKE_THROUGH_INDEX)
3073 #define LFACE_BOX(LFACE) AREF ((LFACE), LFACE_BOX_INDEX)
3074 #define LFACE_FONT(LFACE) AREF ((LFACE), LFACE_FONT_INDEX)
3075 #define LFACE_INHERIT(LFACE) AREF ((LFACE), LFACE_INHERIT_INDEX)
3076 #define LFACE_AVGWIDTH(LFACE) AREF ((LFACE), LFACE_AVGWIDTH_INDEX)
3078 /* Non-zero if LFACE is a Lisp face. A Lisp face is a vector of size
3079 LFACE_VECTOR_SIZE which has the symbol `face' in slot 0. */
3081 #define LFACEP(LFACE) \
3082 (VECTORP (LFACE) \
3083 && XVECTOR (LFACE)->size == LFACE_VECTOR_SIZE \
3084 && EQ (AREF (LFACE, 0), Qface))
3087 #if GLYPH_DEBUG
3089 /* Check consistency of Lisp face attribute vector ATTRS. */
3091 static void
3092 check_lface_attrs (attrs)
3093 Lisp_Object *attrs;
3095 xassert (UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
3096 || IGNORE_DEFFACE_P (attrs[LFACE_FAMILY_INDEX])
3097 || STRINGP (attrs[LFACE_FAMILY_INDEX]));
3098 xassert (UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
3099 || IGNORE_DEFFACE_P (attrs[LFACE_SWIDTH_INDEX])
3100 || SYMBOLP (attrs[LFACE_SWIDTH_INDEX]));
3101 xassert (UNSPECIFIEDP (attrs[LFACE_AVGWIDTH_INDEX])
3102 || IGNORE_DEFFACE_P (attrs[LFACE_AVGWIDTH_INDEX])
3103 || INTEGERP (attrs[LFACE_AVGWIDTH_INDEX]));
3104 xassert (UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
3105 || IGNORE_DEFFACE_P (attrs[LFACE_HEIGHT_INDEX])
3106 || INTEGERP (attrs[LFACE_HEIGHT_INDEX])
3107 || FLOATP (attrs[LFACE_HEIGHT_INDEX])
3108 || FUNCTIONP (attrs[LFACE_HEIGHT_INDEX]));
3109 xassert (UNSPECIFIEDP (attrs[LFACE_WEIGHT_INDEX])
3110 || IGNORE_DEFFACE_P (attrs[LFACE_WEIGHT_INDEX])
3111 || SYMBOLP (attrs[LFACE_WEIGHT_INDEX]));
3112 xassert (UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX])
3113 || IGNORE_DEFFACE_P (attrs[LFACE_SLANT_INDEX])
3114 || SYMBOLP (attrs[LFACE_SLANT_INDEX]));
3115 xassert (UNSPECIFIEDP (attrs[LFACE_UNDERLINE_INDEX])
3116 || IGNORE_DEFFACE_P (attrs[LFACE_UNDERLINE_INDEX])
3117 || SYMBOLP (attrs[LFACE_UNDERLINE_INDEX])
3118 || STRINGP (attrs[LFACE_UNDERLINE_INDEX]));
3119 xassert (UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
3120 || IGNORE_DEFFACE_P (attrs[LFACE_OVERLINE_INDEX])
3121 || SYMBOLP (attrs[LFACE_OVERLINE_INDEX])
3122 || STRINGP (attrs[LFACE_OVERLINE_INDEX]));
3123 xassert (UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
3124 || IGNORE_DEFFACE_P (attrs[LFACE_STRIKE_THROUGH_INDEX])
3125 || SYMBOLP (attrs[LFACE_STRIKE_THROUGH_INDEX])
3126 || STRINGP (attrs[LFACE_STRIKE_THROUGH_INDEX]));
3127 xassert (UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
3128 || IGNORE_DEFFACE_P (attrs[LFACE_BOX_INDEX])
3129 || SYMBOLP (attrs[LFACE_BOX_INDEX])
3130 || STRINGP (attrs[LFACE_BOX_INDEX])
3131 || INTEGERP (attrs[LFACE_BOX_INDEX])
3132 || CONSP (attrs[LFACE_BOX_INDEX]));
3133 xassert (UNSPECIFIEDP (attrs[LFACE_INVERSE_INDEX])
3134 || IGNORE_DEFFACE_P (attrs[LFACE_INVERSE_INDEX])
3135 || SYMBOLP (attrs[LFACE_INVERSE_INDEX]));
3136 xassert (UNSPECIFIEDP (attrs[LFACE_FOREGROUND_INDEX])
3137 || IGNORE_DEFFACE_P (attrs[LFACE_FOREGROUND_INDEX])
3138 || STRINGP (attrs[LFACE_FOREGROUND_INDEX]));
3139 xassert (UNSPECIFIEDP (attrs[LFACE_BACKGROUND_INDEX])
3140 || IGNORE_DEFFACE_P (attrs[LFACE_BACKGROUND_INDEX])
3141 || STRINGP (attrs[LFACE_BACKGROUND_INDEX]));
3142 xassert (UNSPECIFIEDP (attrs[LFACE_INHERIT_INDEX])
3143 || IGNORE_DEFFACE_P (attrs[LFACE_INHERIT_INDEX])
3144 || NILP (attrs[LFACE_INHERIT_INDEX])
3145 || SYMBOLP (attrs[LFACE_INHERIT_INDEX])
3146 || CONSP (attrs[LFACE_INHERIT_INDEX]));
3147 #ifdef HAVE_WINDOW_SYSTEM
3148 xassert (UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
3149 || IGNORE_DEFFACE_P (attrs[LFACE_STIPPLE_INDEX])
3150 || SYMBOLP (attrs[LFACE_STIPPLE_INDEX])
3151 || !NILP (Fbitmap_spec_p (attrs[LFACE_STIPPLE_INDEX])));
3152 xassert (UNSPECIFIEDP (attrs[LFACE_FONT_INDEX])
3153 || IGNORE_DEFFACE_P (attrs[LFACE_FONT_INDEX])
3154 || NILP (attrs[LFACE_FONT_INDEX])
3155 || STRINGP (attrs[LFACE_FONT_INDEX]));
3156 #endif
3160 /* Check consistency of attributes of Lisp face LFACE (a Lisp vector). */
3162 static void
3163 check_lface (lface)
3164 Lisp_Object lface;
3166 if (!NILP (lface))
3168 xassert (LFACEP (lface));
3169 check_lface_attrs (XVECTOR (lface)->contents);
3173 #else /* GLYPH_DEBUG == 0 */
3175 #define check_lface_attrs(attrs) (void) 0
3176 #define check_lface(lface) (void) 0
3178 #endif /* GLYPH_DEBUG == 0 */
3182 /* Face-merge cycle checking. */
3184 /* A `named merge point' is simply a point during face-merging where we
3185 look up a face by name. We keep a stack of which named lookups we're
3186 currently processing so that we can easily detect cycles, using a
3187 linked- list of struct named_merge_point structures, typically
3188 allocated on the stack frame of the named lookup functions which are
3189 active (so no consing is required). */
3190 struct named_merge_point
3192 Lisp_Object face_name;
3193 struct named_merge_point *prev;
3197 /* If a face merging cycle is detected for FACE_NAME, return 0,
3198 otherwise add NEW_NAMED_MERGE_POINT, which is initialized using
3199 FACE_NAME, as the head of the linked list pointed to by
3200 NAMED_MERGE_POINTS, and return 1. */
3202 static INLINE int
3203 push_named_merge_point (struct named_merge_point *new_named_merge_point,
3204 Lisp_Object face_name,
3205 struct named_merge_point **named_merge_points)
3207 struct named_merge_point *prev;
3209 for (prev = *named_merge_points; prev; prev = prev->prev)
3210 if (EQ (face_name, prev->face_name))
3211 return 0;
3213 new_named_merge_point->face_name = face_name;
3214 new_named_merge_point->prev = *named_merge_points;
3216 *named_merge_points = new_named_merge_point;
3218 return 1;
3223 #if 0 /* Seems to be unused. */
3224 static Lisp_Object
3225 internal_resolve_face_name (nargs, args)
3226 int nargs;
3227 Lisp_Object *args;
3229 return Fget (args[0], args[1]);
3232 static Lisp_Object
3233 resolve_face_name_error (ignore)
3234 Lisp_Object ignore;
3236 return Qnil;
3238 #endif
3240 /* Resolve face name FACE_NAME. If FACE_NAME is a string, intern it
3241 to make it a symbol. If FACE_NAME is an alias for another face,
3242 return that face's name.
3244 Return default face in case of errors. */
3246 static Lisp_Object
3247 resolve_face_name (face_name, signal_p)
3248 Lisp_Object face_name;
3249 int signal_p;
3251 Lisp_Object orig_face;
3252 Lisp_Object tortoise, hare;
3254 if (STRINGP (face_name))
3255 face_name = intern (SDATA (face_name));
3257 if (NILP (face_name) || !SYMBOLP (face_name))
3258 return face_name;
3260 orig_face = face_name;
3261 tortoise = hare = face_name;
3263 while (1)
3265 face_name = hare;
3266 hare = Fget (hare, Qface_alias);
3267 if (NILP (hare) || !SYMBOLP (hare))
3268 break;
3270 face_name = hare;
3271 hare = Fget (hare, Qface_alias);
3272 if (NILP (hare) || !SYMBOLP (hare))
3273 break;
3275 tortoise = Fget (tortoise, Qface_alias);
3276 if (EQ (hare, tortoise))
3278 if (signal_p)
3279 xsignal1 (Qcircular_list, orig_face);
3280 return Qdefault;
3284 return face_name;
3288 /* Return the face definition of FACE_NAME on frame F. F null means
3289 return the definition for new frames. FACE_NAME may be a string or
3290 a symbol (apparently Emacs 20.2 allowed strings as face names in
3291 face text properties; Ediff uses that). If FACE_NAME is an alias
3292 for another face, return that face's definition. If SIGNAL_P is
3293 non-zero, signal an error if FACE_NAME is not a valid face name.
3294 If SIGNAL_P is zero, value is nil if FACE_NAME is not a valid face
3295 name. */
3297 static INLINE Lisp_Object
3298 lface_from_face_name (f, face_name, signal_p)
3299 struct frame *f;
3300 Lisp_Object face_name;
3301 int signal_p;
3303 Lisp_Object lface;
3305 face_name = resolve_face_name (face_name, signal_p);
3307 if (f)
3308 lface = assq_no_quit (face_name, f->face_alist);
3309 else
3310 lface = assq_no_quit (face_name, Vface_new_frame_defaults);
3312 if (CONSP (lface))
3313 lface = XCDR (lface);
3314 else if (signal_p)
3315 signal_error ("Invalid face", face_name);
3317 check_lface (lface);
3318 return lface;
3322 /* Get face attributes of face FACE_NAME from frame-local faces on
3323 frame F. Store the resulting attributes in ATTRS which must point
3324 to a vector of Lisp_Objects of size LFACE_VECTOR_SIZE. If SIGNAL_P
3325 is non-zero, signal an error if FACE_NAME does not name a face.
3326 Otherwise, value is zero if FACE_NAME is not a face. */
3328 static INLINE int
3329 get_lface_attributes (f, face_name, attrs, signal_p)
3330 struct frame *f;
3331 Lisp_Object face_name;
3332 Lisp_Object *attrs;
3333 int signal_p;
3335 Lisp_Object lface;
3336 int success_p;
3338 lface = lface_from_face_name (f, face_name, signal_p);
3339 if (!NILP (lface))
3341 bcopy (XVECTOR (lface)->contents, attrs,
3342 LFACE_VECTOR_SIZE * sizeof *attrs);
3343 success_p = 1;
3345 else
3346 success_p = 0;
3348 return success_p;
3352 /* Non-zero if all attributes in face attribute vector ATTRS are
3353 specified, i.e. are non-nil. */
3355 static int
3356 lface_fully_specified_p (attrs)
3357 Lisp_Object *attrs;
3359 int i;
3361 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3362 if (i != LFACE_FONT_INDEX && i != LFACE_INHERIT_INDEX
3363 && i != LFACE_AVGWIDTH_INDEX)
3364 if ((UNSPECIFIEDP (attrs[i]) || IGNORE_DEFFACE_P (attrs[i]))
3365 #ifdef MAC_OS
3366 /* MAC_TODO: No stipple support on Mac OS yet, this index is
3367 always unspecified. */
3368 && i != LFACE_STIPPLE_INDEX
3369 #endif
3371 break;
3373 return i == LFACE_VECTOR_SIZE;
3376 #ifdef HAVE_WINDOW_SYSTEM
3378 /* Set font-related attributes of Lisp face LFACE from the fullname of
3379 the font opened by FONTNAME. If FORCE_P is zero, set only
3380 unspecified attributes of LFACE. The exception is `font'
3381 attribute. It is set to FONTNAME as is regardless of FORCE_P.
3383 If FONTNAME is not available on frame F,
3384 return 0 if MAY_FAIL_P is non-zero, otherwise abort.
3385 If the fullname is not in a valid XLFD format,
3386 return 0 if MAY_FAIL_P is non-zero, otherwise set normal values
3387 in LFACE and return 1.
3388 Otherwise, return 1. */
3390 static int
3391 set_lface_from_font_name (f, lface, fontname, force_p, may_fail_p)
3392 struct frame *f;
3393 Lisp_Object lface;
3394 Lisp_Object fontname;
3395 int force_p, may_fail_p;
3397 struct font_name font;
3398 char *buffer;
3399 int pt;
3400 int have_xlfd_p;
3401 int fontset;
3402 char *font_name = SDATA (fontname);
3403 struct font_info *font_info;
3405 /* If FONTNAME is actually a fontset name, get ASCII font name of it. */
3406 fontset = fs_query_fontset (fontname, 0);
3407 if (fontset >= 0)
3408 font_name = SDATA (fontset_ascii (fontset));
3410 /* Check if FONT_NAME is surely available on the system. Usually
3411 FONT_NAME is already cached for the frame F and FS_LOAD_FONT
3412 returns quickly. But, even if FONT_NAME is not yet cached,
3413 caching it now is not futail because we anyway load the font
3414 later. */
3415 BLOCK_INPUT;
3416 font_info = FS_LOAD_FONT (f, 0, font_name, -1);
3417 UNBLOCK_INPUT;
3419 if (!font_info)
3421 if (may_fail_p)
3422 return 0;
3423 abort ();
3426 font.name = STRDUPA (font_info->full_name);
3427 have_xlfd_p = split_font_name (f, &font, 1);
3429 /* Set attributes only if unspecified, otherwise face defaults for
3430 new frames would never take effect. If we couldn't get a font
3431 name conforming to XLFD, set normal values. */
3433 if (force_p || UNSPECIFIEDP (LFACE_FAMILY (lface)))
3435 Lisp_Object val;
3436 if (have_xlfd_p)
3438 buffer = (char *) alloca (strlen (font.fields[XLFD_FAMILY])
3439 + strlen (font.fields[XLFD_FOUNDRY])
3440 + 2);
3441 sprintf (buffer, "%s-%s", font.fields[XLFD_FOUNDRY],
3442 font.fields[XLFD_FAMILY]);
3443 val = build_string (buffer);
3445 else
3446 val = build_string ("*");
3447 LFACE_FAMILY (lface) = val;
3450 if (force_p || UNSPECIFIEDP (LFACE_HEIGHT (lface)))
3452 if (have_xlfd_p)
3453 pt = xlfd_point_size (f, &font);
3454 else
3455 pt = pixel_point_size (f, font_info->height * 10);
3456 xassert (pt > 0);
3457 LFACE_HEIGHT (lface) = make_number (pt);
3460 if (force_p || UNSPECIFIEDP (LFACE_SWIDTH (lface)))
3461 LFACE_SWIDTH (lface)
3462 = have_xlfd_p ? xlfd_symbolic_swidth (&font) : Qnormal;
3464 if (force_p || UNSPECIFIEDP (LFACE_AVGWIDTH (lface)))
3465 LFACE_AVGWIDTH (lface)
3466 = (have_xlfd_p
3467 ? make_number (font.numeric[XLFD_AVGWIDTH])
3468 : Qunspecified);
3470 if (force_p || UNSPECIFIEDP (LFACE_WEIGHT (lface)))
3471 LFACE_WEIGHT (lface)
3472 = have_xlfd_p ? xlfd_symbolic_weight (&font) : Qnormal;
3474 if (force_p || UNSPECIFIEDP (LFACE_SLANT (lface)))
3475 LFACE_SLANT (lface)
3476 = have_xlfd_p ? xlfd_symbolic_slant (&font) : Qnormal;
3478 LFACE_FONT (lface) = fontname;
3480 return 1;
3483 #endif /* HAVE_WINDOW_SYSTEM */
3486 /* Merges the face height FROM with the face height TO, and returns the
3487 merged height. If FROM is an invalid height, then INVALID is
3488 returned instead. FROM and TO may be either absolute face heights or
3489 `relative' heights; the returned value is always an absolute height
3490 unless both FROM and TO are relative. GCPRO is a lisp value that
3491 will be protected from garbage-collection if this function makes a
3492 call into lisp. */
3494 Lisp_Object
3495 merge_face_heights (from, to, invalid)
3496 Lisp_Object from, to, invalid;
3498 Lisp_Object result = invalid;
3500 if (INTEGERP (from))
3501 /* FROM is absolute, just use it as is. */
3502 result = from;
3503 else if (FLOATP (from))
3504 /* FROM is a scale, use it to adjust TO. */
3506 if (INTEGERP (to))
3507 /* relative X absolute => absolute */
3508 result = make_number ((EMACS_INT)(XFLOAT_DATA (from) * XINT (to)));
3509 else if (FLOATP (to))
3510 /* relative X relative => relative */
3511 result = make_float (XFLOAT_DATA (from) * XFLOAT_DATA (to));
3512 else if (UNSPECIFIEDP (to))
3513 result = from;
3515 else if (FUNCTIONP (from))
3516 /* FROM is a function, which use to adjust TO. */
3518 /* Call function with current height as argument.
3519 From is the new height. */
3520 Lisp_Object args[2];
3522 args[0] = from;
3523 args[1] = to;
3524 result = safe_call (2, args);
3526 /* Ensure that if TO was absolute, so is the result. */
3527 if (INTEGERP (to) && !INTEGERP (result))
3528 result = invalid;
3531 return result;
3535 /* Merge two Lisp face attribute vectors on frame F, FROM and TO, and
3536 store the resulting attributes in TO, which must be already be
3537 completely specified and contain only absolute attributes. Every
3538 specified attribute of FROM overrides the corresponding attribute of
3539 TO; relative attributes in FROM are merged with the absolute value in
3540 TO and replace it. NAMED_MERGE_POINTS is used internally to detect
3541 loops in face inheritance; it should be 0 when called from other
3542 places. */
3544 static INLINE void
3545 merge_face_vectors (f, from, to, named_merge_points)
3546 struct frame *f;
3547 Lisp_Object *from, *to;
3548 struct named_merge_point *named_merge_points;
3550 int i;
3552 /* If FROM inherits from some other faces, merge their attributes into
3553 TO before merging FROM's direct attributes. Note that an :inherit
3554 attribute of `unspecified' is the same as one of nil; we never
3555 merge :inherit attributes, so nil is more correct, but lots of
3556 other code uses `unspecified' as a generic value for face attributes. */
3557 if (!UNSPECIFIEDP (from[LFACE_INHERIT_INDEX])
3558 && !NILP (from[LFACE_INHERIT_INDEX]))
3559 merge_face_ref (f, from[LFACE_INHERIT_INDEX], to, 0, named_merge_points);
3561 /* If TO specifies a :font attribute, and FROM specifies some
3562 font-related attribute, we need to clear TO's :font attribute
3563 (because it will be inconsistent with whatever FROM specifies, and
3564 FROM takes precedence). */
3565 if (!NILP (to[LFACE_FONT_INDEX])
3566 && (!UNSPECIFIEDP (from[LFACE_FAMILY_INDEX])
3567 || !UNSPECIFIEDP (from[LFACE_HEIGHT_INDEX])
3568 || !UNSPECIFIEDP (from[LFACE_WEIGHT_INDEX])
3569 || !UNSPECIFIEDP (from[LFACE_SLANT_INDEX])
3570 || !UNSPECIFIEDP (from[LFACE_SWIDTH_INDEX])
3571 || !UNSPECIFIEDP (from[LFACE_AVGWIDTH_INDEX])))
3572 to[LFACE_FONT_INDEX] = Qnil;
3574 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3575 if (!UNSPECIFIEDP (from[i]))
3577 if (i == LFACE_HEIGHT_INDEX && !INTEGERP (from[i]))
3578 to[i] = merge_face_heights (from[i], to[i], to[i]);
3579 else
3580 to[i] = from[i];
3583 /* TO is always an absolute face, which should inherit from nothing.
3584 We blindly copy the :inherit attribute above and fix it up here. */
3585 to[LFACE_INHERIT_INDEX] = Qnil;
3588 /* Merge the named face FACE_NAME on frame F, into the vector of face
3589 attributes TO. NAMED_MERGE_POINTS is used to detect loops in face
3590 inheritance. Returns true if FACE_NAME is a valid face name and
3591 merging succeeded. */
3593 static int
3594 merge_named_face (f, face_name, to, named_merge_points)
3595 struct frame *f;
3596 Lisp_Object face_name;
3597 Lisp_Object *to;
3598 struct named_merge_point *named_merge_points;
3600 struct named_merge_point named_merge_point;
3602 if (push_named_merge_point (&named_merge_point,
3603 face_name, &named_merge_points))
3605 struct gcpro gcpro1;
3606 Lisp_Object from[LFACE_VECTOR_SIZE];
3607 int ok = get_lface_attributes (f, face_name, from, 0);
3609 if (ok)
3611 GCPRO1 (named_merge_point.face_name);
3612 merge_face_vectors (f, from, to, named_merge_points);
3613 UNGCPRO;
3616 return ok;
3618 else
3619 return 0;
3623 /* Merge face attributes from the lisp `face reference' FACE_REF on
3624 frame F into the face attribute vector TO. If ERR_MSGS is non-zero,
3625 problems with FACE_REF cause an error message to be shown. Return
3626 non-zero if no errors occurred (regardless of the value of ERR_MSGS).
3627 NAMED_MERGE_POINTS is used to detect loops in face inheritance or
3628 list structure; it may be 0 for most callers.
3630 FACE_REF may be a single face specification or a list of such
3631 specifications. Each face specification can be:
3633 1. A symbol or string naming a Lisp face.
3635 2. A property list of the form (KEYWORD VALUE ...) where each
3636 KEYWORD is a face attribute name, and value is an appropriate value
3637 for that attribute.
3639 3. Conses or the form (FOREGROUND-COLOR . COLOR) or
3640 (BACKGROUND-COLOR . COLOR) where COLOR is a color name. This is
3641 for compatibility with 20.2.
3643 Face specifications earlier in lists take precedence over later
3644 specifications. */
3646 static int
3647 merge_face_ref (f, face_ref, to, err_msgs, named_merge_points)
3648 struct frame *f;
3649 Lisp_Object face_ref;
3650 Lisp_Object *to;
3651 int err_msgs;
3652 struct named_merge_point *named_merge_points;
3654 int ok = 1; /* Succeed without an error? */
3656 if (CONSP (face_ref))
3658 Lisp_Object first = XCAR (face_ref);
3660 if (EQ (first, Qforeground_color)
3661 || EQ (first, Qbackground_color))
3663 /* One of (FOREGROUND-COLOR . COLOR) or (BACKGROUND-COLOR
3664 . COLOR). COLOR must be a string. */
3665 Lisp_Object color_name = XCDR (face_ref);
3666 Lisp_Object color = first;
3668 if (STRINGP (color_name))
3670 if (EQ (color, Qforeground_color))
3671 to[LFACE_FOREGROUND_INDEX] = color_name;
3672 else
3673 to[LFACE_BACKGROUND_INDEX] = color_name;
3675 else
3677 if (err_msgs)
3678 add_to_log ("Invalid face color", color_name, Qnil);
3679 ok = 0;
3682 else if (SYMBOLP (first)
3683 && *SDATA (SYMBOL_NAME (first)) == ':')
3685 /* Assume this is the property list form. */
3686 while (CONSP (face_ref) && CONSP (XCDR (face_ref)))
3688 Lisp_Object keyword = XCAR (face_ref);
3689 Lisp_Object value = XCAR (XCDR (face_ref));
3690 int err = 0;
3692 /* Specifying `unspecified' is a no-op. */
3693 if (EQ (value, Qunspecified))
3695 else if (EQ (keyword, QCfamily))
3697 if (STRINGP (value))
3698 to[LFACE_FAMILY_INDEX] = value;
3699 else
3700 err = 1;
3702 else if (EQ (keyword, QCheight))
3704 Lisp_Object new_height =
3705 merge_face_heights (value, to[LFACE_HEIGHT_INDEX], Qnil);
3707 if (! NILP (new_height))
3708 to[LFACE_HEIGHT_INDEX] = new_height;
3709 else
3710 err = 1;
3712 else if (EQ (keyword, QCweight))
3714 if (SYMBOLP (value)
3715 && face_numeric_weight (value) >= 0)
3716 to[LFACE_WEIGHT_INDEX] = value;
3717 else
3718 err = 1;
3720 else if (EQ (keyword, QCslant))
3722 if (SYMBOLP (value)
3723 && face_numeric_slant (value) >= 0)
3724 to[LFACE_SLANT_INDEX] = value;
3725 else
3726 err = 1;
3728 else if (EQ (keyword, QCunderline))
3730 if (EQ (value, Qt)
3731 || NILP (value)
3732 || STRINGP (value))
3733 to[LFACE_UNDERLINE_INDEX] = value;
3734 else
3735 err = 1;
3737 else if (EQ (keyword, QCoverline))
3739 if (EQ (value, Qt)
3740 || NILP (value)
3741 || STRINGP (value))
3742 to[LFACE_OVERLINE_INDEX] = value;
3743 else
3744 err = 1;
3746 else if (EQ (keyword, QCstrike_through))
3748 if (EQ (value, Qt)
3749 || NILP (value)
3750 || STRINGP (value))
3751 to[LFACE_STRIKE_THROUGH_INDEX] = value;
3752 else
3753 err = 1;
3755 else if (EQ (keyword, QCbox))
3757 if (EQ (value, Qt))
3758 value = make_number (1);
3759 if (INTEGERP (value)
3760 || STRINGP (value)
3761 || CONSP (value)
3762 || NILP (value))
3763 to[LFACE_BOX_INDEX] = value;
3764 else
3765 err = 1;
3767 else if (EQ (keyword, QCinverse_video)
3768 || EQ (keyword, QCreverse_video))
3770 if (EQ (value, Qt) || NILP (value))
3771 to[LFACE_INVERSE_INDEX] = value;
3772 else
3773 err = 1;
3775 else if (EQ (keyword, QCforeground))
3777 if (STRINGP (value))
3778 to[LFACE_FOREGROUND_INDEX] = value;
3779 else
3780 err = 1;
3782 else if (EQ (keyword, QCbackground))
3784 if (STRINGP (value))
3785 to[LFACE_BACKGROUND_INDEX] = value;
3786 else
3787 err = 1;
3789 else if (EQ (keyword, QCstipple))
3791 #ifdef HAVE_X_WINDOWS
3792 Lisp_Object pixmap_p = Fbitmap_spec_p (value);
3793 if (!NILP (pixmap_p))
3794 to[LFACE_STIPPLE_INDEX] = value;
3795 else
3796 err = 1;
3797 #endif
3799 else if (EQ (keyword, QCwidth))
3801 if (SYMBOLP (value)
3802 && face_numeric_swidth (value) >= 0)
3803 to[LFACE_SWIDTH_INDEX] = value;
3804 else
3805 err = 1;
3807 else if (EQ (keyword, QCinherit))
3809 /* This is not really very useful; it's just like a
3810 normal face reference. */
3811 if (! merge_face_ref (f, value, to,
3812 err_msgs, named_merge_points))
3813 err = 1;
3815 else
3816 err = 1;
3818 if (err)
3820 add_to_log ("Invalid face attribute %S %S", keyword, value);
3821 ok = 0;
3824 face_ref = XCDR (XCDR (face_ref));
3827 else
3829 /* This is a list of face refs. Those at the beginning of the
3830 list take precedence over what follows, so we have to merge
3831 from the end backwards. */
3832 Lisp_Object next = XCDR (face_ref);
3834 if (! NILP (next))
3835 ok = merge_face_ref (f, next, to, err_msgs, named_merge_points);
3837 if (! merge_face_ref (f, first, to, err_msgs, named_merge_points))
3838 ok = 0;
3841 else
3843 /* FACE_REF ought to be a face name. */
3844 ok = merge_named_face (f, face_ref, to, named_merge_points);
3845 if (!ok && err_msgs)
3846 add_to_log ("Invalid face reference: %s", face_ref, Qnil);
3849 return ok;
3853 DEFUN ("internal-make-lisp-face", Finternal_make_lisp_face,
3854 Sinternal_make_lisp_face, 1, 2, 0,
3855 doc: /* Make FACE, a symbol, a Lisp face with all attributes nil.
3856 If FACE was not known as a face before, create a new one.
3857 If optional argument FRAME is specified, make a frame-local face
3858 for that frame. Otherwise operate on the global face definition.
3859 Value is a vector of face attributes. */)
3860 (face, frame)
3861 Lisp_Object face, frame;
3863 Lisp_Object global_lface, lface;
3864 struct frame *f;
3865 int i;
3867 CHECK_SYMBOL (face);
3868 global_lface = lface_from_face_name (NULL, face, 0);
3870 if (!NILP (frame))
3872 CHECK_LIVE_FRAME (frame);
3873 f = XFRAME (frame);
3874 lface = lface_from_face_name (f, face, 0);
3876 else
3877 f = NULL, lface = Qnil;
3879 /* Add a global definition if there is none. */
3880 if (NILP (global_lface))
3882 global_lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
3883 Qunspecified);
3884 AREF (global_lface, 0) = Qface;
3885 Vface_new_frame_defaults = Fcons (Fcons (face, global_lface),
3886 Vface_new_frame_defaults);
3888 /* Assign the new Lisp face a unique ID. The mapping from Lisp
3889 face id to Lisp face is given by the vector lface_id_to_name.
3890 The mapping from Lisp face to Lisp face id is given by the
3891 property `face' of the Lisp face name. */
3892 if (next_lface_id == lface_id_to_name_size)
3894 int new_size = max (50, 2 * lface_id_to_name_size);
3895 int sz = new_size * sizeof *lface_id_to_name;
3896 lface_id_to_name = (Lisp_Object *) xrealloc (lface_id_to_name, sz);
3897 lface_id_to_name_size = new_size;
3900 lface_id_to_name[next_lface_id] = face;
3901 Fput (face, Qface, make_number (next_lface_id));
3902 ++next_lface_id;
3904 else if (f == NULL)
3905 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3906 AREF (global_lface, i) = Qunspecified;
3908 /* Add a frame-local definition. */
3909 if (f)
3911 if (NILP (lface))
3913 lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
3914 Qunspecified);
3915 AREF (lface, 0) = Qface;
3916 f->face_alist = Fcons (Fcons (face, lface), f->face_alist);
3918 else
3919 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3920 AREF (lface, i) = Qunspecified;
3922 else
3923 lface = global_lface;
3925 /* Changing a named face means that all realized faces depending on
3926 that face are invalid. Since we cannot tell which realized faces
3927 depend on the face, make sure they are all removed. This is done
3928 by incrementing face_change_count. The next call to
3929 init_iterator will then free realized faces. */
3930 if (NILP (Fget (face, Qface_no_inherit)))
3932 ++face_change_count;
3933 ++windows_or_buffers_changed;
3936 xassert (LFACEP (lface));
3937 check_lface (lface);
3938 return lface;
3942 DEFUN ("internal-lisp-face-p", Finternal_lisp_face_p,
3943 Sinternal_lisp_face_p, 1, 2, 0,
3944 doc: /* Return non-nil if FACE names a face.
3945 If optional second argument FRAME is non-nil, check for the
3946 existence of a frame-local face with name FACE on that frame.
3947 Otherwise check for the existence of a global face. */)
3948 (face, frame)
3949 Lisp_Object face, frame;
3951 Lisp_Object lface;
3953 face = resolve_face_name (face, 1);
3955 if (!NILP (frame))
3957 CHECK_LIVE_FRAME (frame);
3958 lface = lface_from_face_name (XFRAME (frame), face, 0);
3960 else
3961 lface = lface_from_face_name (NULL, face, 0);
3963 return lface;
3967 DEFUN ("internal-copy-lisp-face", Finternal_copy_lisp_face,
3968 Sinternal_copy_lisp_face, 4, 4, 0,
3969 doc: /* Copy face FROM to TO.
3970 If FRAME is t, copy the global face definition of FROM.
3971 Otherwise, copy the frame-local definition of FROM on FRAME.
3972 If NEW-FRAME is a frame, copy that data into the frame-local
3973 definition of TO on NEW-FRAME. If NEW-FRAME is nil.
3974 FRAME controls where the data is copied to.
3976 The value is TO. */)
3977 (from, to, frame, new_frame)
3978 Lisp_Object from, to, frame, new_frame;
3980 Lisp_Object lface, copy;
3982 CHECK_SYMBOL (from);
3983 CHECK_SYMBOL (to);
3985 if (EQ (frame, Qt))
3987 /* Copy global definition of FROM. We don't make copies of
3988 strings etc. because 20.2 didn't do it either. */
3989 lface = lface_from_face_name (NULL, from, 1);
3990 copy = Finternal_make_lisp_face (to, Qnil);
3992 else
3994 /* Copy frame-local definition of FROM. */
3995 if (NILP (new_frame))
3996 new_frame = frame;
3997 CHECK_LIVE_FRAME (frame);
3998 CHECK_LIVE_FRAME (new_frame);
3999 lface = lface_from_face_name (XFRAME (frame), from, 1);
4000 copy = Finternal_make_lisp_face (to, new_frame);
4003 bcopy (XVECTOR (lface)->contents, XVECTOR (copy)->contents,
4004 LFACE_VECTOR_SIZE * sizeof (Lisp_Object));
4006 /* Changing a named face means that all realized faces depending on
4007 that face are invalid. Since we cannot tell which realized faces
4008 depend on the face, make sure they are all removed. This is done
4009 by incrementing face_change_count. The next call to
4010 init_iterator will then free realized faces. */
4011 if (NILP (Fget (to, Qface_no_inherit)))
4013 ++face_change_count;
4014 ++windows_or_buffers_changed;
4017 return to;
4021 DEFUN ("internal-set-lisp-face-attribute", Finternal_set_lisp_face_attribute,
4022 Sinternal_set_lisp_face_attribute, 3, 4, 0,
4023 doc: /* Set attribute ATTR of FACE to VALUE.
4024 FRAME being a frame means change the face on that frame.
4025 FRAME nil means change the face of the selected frame.
4026 FRAME t means change the default for new frames.
4027 FRAME 0 means change the face on all frames, and change the default
4028 for new frames. */)
4029 (face, attr, value, frame)
4030 Lisp_Object face, attr, value, frame;
4032 Lisp_Object lface;
4033 Lisp_Object old_value = Qnil;
4034 /* Set 1 if ATTR is QCfont. */
4035 int font_attr_p = 0;
4036 /* Set 1 if ATTR is one of font-related attributes other than QCfont. */
4037 int font_related_attr_p = 0;
4039 CHECK_SYMBOL (face);
4040 CHECK_SYMBOL (attr);
4042 face = resolve_face_name (face, 1);
4044 /* If FRAME is 0, change face on all frames, and change the
4045 default for new frames. */
4046 if (INTEGERP (frame) && XINT (frame) == 0)
4048 Lisp_Object tail;
4049 Finternal_set_lisp_face_attribute (face, attr, value, Qt);
4050 FOR_EACH_FRAME (tail, frame)
4051 Finternal_set_lisp_face_attribute (face, attr, value, frame);
4052 return face;
4055 /* Set lface to the Lisp attribute vector of FACE. */
4056 if (EQ (frame, Qt))
4058 lface = lface_from_face_name (NULL, face, 1);
4060 /* When updating face-new-frame-defaults, we put :ignore-defface
4061 where the caller wants `unspecified'. This forces the frame
4062 defaults to ignore the defface value. Otherwise, the defface
4063 will take effect, which is generally not what is intended.
4064 The value of that attribute will be inherited from some other
4065 face during face merging. See internal_merge_in_global_face. */
4066 if (UNSPECIFIEDP (value))
4067 value = Qignore_defface;
4069 else
4071 if (NILP (frame))
4072 frame = selected_frame;
4074 CHECK_LIVE_FRAME (frame);
4075 lface = lface_from_face_name (XFRAME (frame), face, 0);
4077 /* If a frame-local face doesn't exist yet, create one. */
4078 if (NILP (lface))
4079 lface = Finternal_make_lisp_face (face, frame);
4082 if (EQ (attr, QCfamily))
4084 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4086 CHECK_STRING (value);
4087 if (SCHARS (value) == 0)
4088 signal_error ("Invalid face family", value);
4090 old_value = LFACE_FAMILY (lface);
4091 LFACE_FAMILY (lface) = value;
4092 font_related_attr_p = 1;
4094 else if (EQ (attr, QCheight))
4096 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4098 Lisp_Object test;
4100 test = (EQ (face, Qdefault)
4101 ? value
4102 /* The default face must have an absolute size,
4103 otherwise, we do a test merge with a random
4104 height to see if VALUE's ok. */
4105 : merge_face_heights (value, make_number (10), Qnil));
4107 if (!INTEGERP (test) || XINT (test) <= 0)
4108 signal_error ("Invalid face height", value);
4111 old_value = LFACE_HEIGHT (lface);
4112 LFACE_HEIGHT (lface) = value;
4113 font_related_attr_p = 1;
4115 else if (EQ (attr, QCweight))
4117 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4119 CHECK_SYMBOL (value);
4120 if (face_numeric_weight (value) < 0)
4121 signal_error ("Invalid face weight", value);
4123 old_value = LFACE_WEIGHT (lface);
4124 LFACE_WEIGHT (lface) = value;
4125 font_related_attr_p = 1;
4127 else if (EQ (attr, QCslant))
4129 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4131 CHECK_SYMBOL (value);
4132 if (face_numeric_slant (value) < 0)
4133 signal_error ("Invalid face slant", value);
4135 old_value = LFACE_SLANT (lface);
4136 LFACE_SLANT (lface) = value;
4137 font_related_attr_p = 1;
4139 else if (EQ (attr, QCunderline))
4141 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4142 if ((SYMBOLP (value)
4143 && !EQ (value, Qt)
4144 && !EQ (value, Qnil))
4145 /* Underline color. */
4146 || (STRINGP (value)
4147 && SCHARS (value) == 0))
4148 signal_error ("Invalid face underline", value);
4150 old_value = LFACE_UNDERLINE (lface);
4151 LFACE_UNDERLINE (lface) = value;
4153 else if (EQ (attr, QCoverline))
4155 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4156 if ((SYMBOLP (value)
4157 && !EQ (value, Qt)
4158 && !EQ (value, Qnil))
4159 /* Overline color. */
4160 || (STRINGP (value)
4161 && SCHARS (value) == 0))
4162 signal_error ("Invalid face overline", value);
4164 old_value = LFACE_OVERLINE (lface);
4165 LFACE_OVERLINE (lface) = value;
4167 else if (EQ (attr, QCstrike_through))
4169 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4170 if ((SYMBOLP (value)
4171 && !EQ (value, Qt)
4172 && !EQ (value, Qnil))
4173 /* Strike-through color. */
4174 || (STRINGP (value)
4175 && SCHARS (value) == 0))
4176 signal_error ("Invalid face strike-through", value);
4178 old_value = LFACE_STRIKE_THROUGH (lface);
4179 LFACE_STRIKE_THROUGH (lface) = value;
4181 else if (EQ (attr, QCbox))
4183 int valid_p;
4185 /* Allow t meaning a simple box of width 1 in foreground color
4186 of the face. */
4187 if (EQ (value, Qt))
4188 value = make_number (1);
4190 if (UNSPECIFIEDP (value) || IGNORE_DEFFACE_P (value))
4191 valid_p = 1;
4192 else if (NILP (value))
4193 valid_p = 1;
4194 else if (INTEGERP (value))
4195 valid_p = XINT (value) != 0;
4196 else if (STRINGP (value))
4197 valid_p = SCHARS (value) > 0;
4198 else if (CONSP (value))
4200 Lisp_Object tem;
4202 tem = value;
4203 while (CONSP (tem))
4205 Lisp_Object k, v;
4207 k = XCAR (tem);
4208 tem = XCDR (tem);
4209 if (!CONSP (tem))
4210 break;
4211 v = XCAR (tem);
4212 tem = XCDR (tem);
4214 if (EQ (k, QCline_width))
4216 if (!INTEGERP (v) || XINT (v) == 0)
4217 break;
4219 else if (EQ (k, QCcolor))
4221 if (!NILP (v) && (!STRINGP (v) || SCHARS (v) == 0))
4222 break;
4224 else if (EQ (k, QCstyle))
4226 if (!EQ (v, Qpressed_button) && !EQ (v, Qreleased_button))
4227 break;
4229 else
4230 break;
4233 valid_p = NILP (tem);
4235 else
4236 valid_p = 0;
4238 if (!valid_p)
4239 signal_error ("Invalid face box", value);
4241 old_value = LFACE_BOX (lface);
4242 LFACE_BOX (lface) = value;
4244 else if (EQ (attr, QCinverse_video)
4245 || EQ (attr, QCreverse_video))
4247 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4249 CHECK_SYMBOL (value);
4250 if (!EQ (value, Qt) && !NILP (value))
4251 signal_error ("Invalid inverse-video face attribute value", value);
4253 old_value = LFACE_INVERSE (lface);
4254 LFACE_INVERSE (lface) = value;
4256 else if (EQ (attr, QCforeground))
4258 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4260 /* Don't check for valid color names here because it depends
4261 on the frame (display) whether the color will be valid
4262 when the face is realized. */
4263 CHECK_STRING (value);
4264 if (SCHARS (value) == 0)
4265 signal_error ("Empty foreground color value", value);
4267 old_value = LFACE_FOREGROUND (lface);
4268 LFACE_FOREGROUND (lface) = value;
4270 else if (EQ (attr, QCbackground))
4272 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4274 /* Don't check for valid color names here because it depends
4275 on the frame (display) whether the color will be valid
4276 when the face is realized. */
4277 CHECK_STRING (value);
4278 if (SCHARS (value) == 0)
4279 signal_error ("Empty background color value", value);
4281 old_value = LFACE_BACKGROUND (lface);
4282 LFACE_BACKGROUND (lface) = value;
4284 else if (EQ (attr, QCstipple))
4286 #ifdef HAVE_X_WINDOWS
4287 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value)
4288 && !NILP (value)
4289 && NILP (Fbitmap_spec_p (value)))
4290 signal_error ("Invalid stipple attribute", value);
4291 old_value = LFACE_STIPPLE (lface);
4292 LFACE_STIPPLE (lface) = value;
4293 #endif /* HAVE_X_WINDOWS */
4295 else if (EQ (attr, QCwidth))
4297 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4299 CHECK_SYMBOL (value);
4300 if (face_numeric_swidth (value) < 0)
4301 signal_error ("Invalid face width", value);
4303 old_value = LFACE_SWIDTH (lface);
4304 LFACE_SWIDTH (lface) = value;
4305 font_related_attr_p = 1;
4307 else if (EQ (attr, QCfont))
4309 #ifdef HAVE_WINDOW_SYSTEM
4310 if (EQ (frame, Qt) || FRAME_WINDOW_P (XFRAME (frame)))
4312 /* Set font-related attributes of the Lisp face from an XLFD
4313 font name. */
4314 struct frame *f;
4315 Lisp_Object tmp;
4317 if (EQ (frame, Qt))
4318 f = SELECTED_FRAME ();
4319 else
4320 f = check_x_frame (frame);
4322 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4324 CHECK_STRING (value);
4326 /* VALUE may be a fontset name or an alias of fontset. In
4327 such a case, use the base fontset name. */
4328 tmp = Fquery_fontset (value, Qnil);
4329 if (!NILP (tmp))
4330 value = tmp;
4332 if (!set_lface_from_font_name (f, lface, value, 1, 1))
4333 signal_error ("Invalid font or fontset name", value);
4336 font_attr_p = 1;
4338 #endif /* HAVE_WINDOW_SYSTEM */
4340 else if (EQ (attr, QCinherit))
4342 Lisp_Object tail;
4343 if (SYMBOLP (value))
4344 tail = Qnil;
4345 else
4346 for (tail = value; CONSP (tail); tail = XCDR (tail))
4347 if (!SYMBOLP (XCAR (tail)))
4348 break;
4349 if (NILP (tail))
4350 LFACE_INHERIT (lface) = value;
4351 else
4352 signal_error ("Invalid face inheritance", value);
4354 else if (EQ (attr, QCbold))
4356 old_value = LFACE_WEIGHT (lface);
4357 LFACE_WEIGHT (lface) = NILP (value) ? Qnormal : Qbold;
4358 font_related_attr_p = 1;
4360 else if (EQ (attr, QCitalic))
4362 old_value = LFACE_SLANT (lface);
4363 LFACE_SLANT (lface) = NILP (value) ? Qnormal : Qitalic;
4364 font_related_attr_p = 1;
4366 else
4367 signal_error ("Invalid face attribute name", attr);
4369 if (font_related_attr_p
4370 && !UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4371 /* If a font-related attribute other than QCfont is specified, the
4372 original `font' attribute nor that of default face is useless
4373 to determine a new font. Thus, we set it to nil so that font
4374 selection mechanism doesn't use it. */
4375 LFACE_FONT (lface) = Qnil;
4377 /* Changing a named face means that all realized faces depending on
4378 that face are invalid. Since we cannot tell which realized faces
4379 depend on the face, make sure they are all removed. This is done
4380 by incrementing face_change_count. The next call to
4381 init_iterator will then free realized faces. */
4382 if (!EQ (frame, Qt)
4383 && NILP (Fget (face, Qface_no_inherit))
4384 && (EQ (attr, QCfont)
4385 || NILP (Fequal (old_value, value))))
4387 ++face_change_count;
4388 ++windows_or_buffers_changed;
4391 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value)
4392 && NILP (Fequal (old_value, value)))
4394 Lisp_Object param;
4396 param = Qnil;
4398 if (EQ (face, Qdefault))
4400 #ifdef HAVE_WINDOW_SYSTEM
4401 /* Changed font-related attributes of the `default' face are
4402 reflected in changed `font' frame parameters. */
4403 if (FRAMEP (frame)
4404 && (font_related_attr_p || font_attr_p)
4405 && lface_fully_specified_p (XVECTOR (lface)->contents))
4406 set_font_frame_param (frame, lface);
4407 else
4408 #endif /* HAVE_WINDOW_SYSTEM */
4410 if (EQ (attr, QCforeground))
4411 param = Qforeground_color;
4412 else if (EQ (attr, QCbackground))
4413 param = Qbackground_color;
4415 #ifdef HAVE_WINDOW_SYSTEM
4416 #ifndef WINDOWSNT
4417 else if (EQ (face, Qscroll_bar))
4419 /* Changing the colors of `scroll-bar' sets frame parameters
4420 `scroll-bar-foreground' and `scroll-bar-background'. */
4421 if (EQ (attr, QCforeground))
4422 param = Qscroll_bar_foreground;
4423 else if (EQ (attr, QCbackground))
4424 param = Qscroll_bar_background;
4426 #endif /* not WINDOWSNT */
4427 else if (EQ (face, Qborder))
4429 /* Changing background color of `border' sets frame parameter
4430 `border-color'. */
4431 if (EQ (attr, QCbackground))
4432 param = Qborder_color;
4434 else if (EQ (face, Qcursor))
4436 /* Changing background color of `cursor' sets frame parameter
4437 `cursor-color'. */
4438 if (EQ (attr, QCbackground))
4439 param = Qcursor_color;
4441 else if (EQ (face, Qmouse))
4443 /* Changing background color of `mouse' sets frame parameter
4444 `mouse-color'. */
4445 if (EQ (attr, QCbackground))
4446 param = Qmouse_color;
4448 #endif /* HAVE_WINDOW_SYSTEM */
4449 else if (EQ (face, Qmenu))
4451 /* Indicate that we have to update the menu bar when
4452 realizing faces on FRAME. FRAME t change the
4453 default for new frames. We do this by setting
4454 setting the flag in new face caches */
4455 if (FRAMEP (frame))
4457 struct frame *f = XFRAME (frame);
4458 if (FRAME_FACE_CACHE (f) == NULL)
4459 FRAME_FACE_CACHE (f) = make_face_cache (f);
4460 FRAME_FACE_CACHE (f)->menu_face_changed_p = 1;
4462 else
4463 menu_face_changed_default = 1;
4466 if (!NILP (param))
4468 if (EQ (frame, Qt))
4469 /* Update `default-frame-alist', which is used for new frames. */
4471 store_in_alist (&Vdefault_frame_alist, param, value);
4473 else
4474 /* Update the current frame's parameters. */
4476 Lisp_Object cons;
4477 cons = XCAR (Vparam_value_alist);
4478 XSETCAR (cons, param);
4479 XSETCDR (cons, value);
4480 Fmodify_frame_parameters (frame, Vparam_value_alist);
4485 return face;
4489 #ifdef HAVE_WINDOW_SYSTEM
4491 /* Set the `font' frame parameter of FRAME determined from `default'
4492 face attributes LFACE. If a face or fontset name is explicitely
4493 specfied in LFACE, use it as is. Otherwise, determine a font name
4494 from the other font-related atrributes of LFACE. In that case, if
4495 there's no matching font, signals an error. */
4497 static void
4498 set_font_frame_param (frame, lface)
4499 Lisp_Object frame, lface;
4501 struct frame *f = XFRAME (frame);
4503 if (FRAME_WINDOW_P (f))
4505 Lisp_Object font_name;
4506 char *font;
4508 if (STRINGP (LFACE_FONT (lface)))
4509 font_name = LFACE_FONT (lface);
4510 else
4512 /* Choose a font name that reflects LFACE's attributes and has
4513 the registry and encoding pattern specified in the default
4514 fontset (3rd arg: -1) for ASCII characters (4th arg: 0). */
4515 font = choose_face_font (f, XVECTOR (lface)->contents, -1, 0, 0);
4516 if (!font)
4517 error ("No font matches the specified attribute");
4518 font_name = build_string (font);
4519 xfree (font);
4522 f->default_face_done_p = 0;
4523 Fmodify_frame_parameters (frame, Fcons (Fcons (Qfont, font_name), Qnil));
4528 /* Update the corresponding face when frame parameter PARAM on frame F
4529 has been assigned the value NEW_VALUE. */
4531 void
4532 update_face_from_frame_parameter (f, param, new_value)
4533 struct frame *f;
4534 Lisp_Object param, new_value;
4536 Lisp_Object face = Qnil;
4537 Lisp_Object lface;
4539 /* If there are no faces yet, give up. This is the case when called
4540 from Fx_create_frame, and we do the necessary things later in
4541 face-set-after-frame-defaults. */
4542 if (NILP (f->face_alist))
4543 return;
4545 if (EQ (param, Qforeground_color))
4547 face = Qdefault;
4548 lface = lface_from_face_name (f, face, 1);
4549 LFACE_FOREGROUND (lface) = (STRINGP (new_value)
4550 ? new_value : Qunspecified);
4551 realize_basic_faces (f);
4553 else if (EQ (param, Qbackground_color))
4555 Lisp_Object frame;
4557 /* Changing the background color might change the background
4558 mode, so that we have to load new defface specs.
4559 Call frame-set-background-mode to do that. */
4560 XSETFRAME (frame, f);
4561 call1 (Qframe_set_background_mode, frame);
4563 face = Qdefault;
4564 lface = lface_from_face_name (f, face, 1);
4565 LFACE_BACKGROUND (lface) = (STRINGP (new_value)
4566 ? new_value : Qunspecified);
4567 realize_basic_faces (f);
4569 else if (EQ (param, Qborder_color))
4571 face = Qborder;
4572 lface = lface_from_face_name (f, face, 1);
4573 LFACE_BACKGROUND (lface) = (STRINGP (new_value)
4574 ? new_value : Qunspecified);
4576 else if (EQ (param, Qcursor_color))
4578 face = Qcursor;
4579 lface = lface_from_face_name (f, face, 1);
4580 LFACE_BACKGROUND (lface) = (STRINGP (new_value)
4581 ? new_value : Qunspecified);
4583 else if (EQ (param, Qmouse_color))
4585 face = Qmouse;
4586 lface = lface_from_face_name (f, face, 1);
4587 LFACE_BACKGROUND (lface) = (STRINGP (new_value)
4588 ? new_value : Qunspecified);
4591 /* Changing a named face means that all realized faces depending on
4592 that face are invalid. Since we cannot tell which realized faces
4593 depend on the face, make sure they are all removed. This is done
4594 by incrementing face_change_count. The next call to
4595 init_iterator will then free realized faces. */
4596 if (!NILP (face)
4597 && NILP (Fget (face, Qface_no_inherit)))
4599 ++face_change_count;
4600 ++windows_or_buffers_changed;
4605 /* Get the value of X resource RESOURCE, class CLASS for the display
4606 of frame FRAME. This is here because ordinary `x-get-resource'
4607 doesn't take a frame argument. */
4609 DEFUN ("internal-face-x-get-resource", Finternal_face_x_get_resource,
4610 Sinternal_face_x_get_resource, 3, 3, 0, doc: /* */)
4611 (resource, class, frame)
4612 Lisp_Object resource, class, frame;
4614 Lisp_Object value = Qnil;
4615 CHECK_STRING (resource);
4616 CHECK_STRING (class);
4617 CHECK_LIVE_FRAME (frame);
4618 BLOCK_INPUT;
4619 value = display_x_get_resource (FRAME_X_DISPLAY_INFO (XFRAME (frame)),
4620 resource, class, Qnil, Qnil);
4621 UNBLOCK_INPUT;
4622 return value;
4626 /* Return resource string VALUE as a boolean value, i.e. nil, or t.
4627 If VALUE is "on" or "true", return t. If VALUE is "off" or
4628 "false", return nil. Otherwise, if SIGNAL_P is non-zero, signal an
4629 error; if SIGNAL_P is zero, return 0. */
4631 static Lisp_Object
4632 face_boolean_x_resource_value (value, signal_p)
4633 Lisp_Object value;
4634 int signal_p;
4636 Lisp_Object result = make_number (0);
4638 xassert (STRINGP (value));
4640 if (xstricmp (SDATA (value), "on") == 0
4641 || xstricmp (SDATA (value), "true") == 0)
4642 result = Qt;
4643 else if (xstricmp (SDATA (value), "off") == 0
4644 || xstricmp (SDATA (value), "false") == 0)
4645 result = Qnil;
4646 else if (xstricmp (SDATA (value), "unspecified") == 0)
4647 result = Qunspecified;
4648 else if (signal_p)
4649 signal_error ("Invalid face attribute value from X resource", value);
4651 return result;
4655 DEFUN ("internal-set-lisp-face-attribute-from-resource",
4656 Finternal_set_lisp_face_attribute_from_resource,
4657 Sinternal_set_lisp_face_attribute_from_resource,
4658 3, 4, 0, doc: /* */)
4659 (face, attr, value, frame)
4660 Lisp_Object face, attr, value, frame;
4662 CHECK_SYMBOL (face);
4663 CHECK_SYMBOL (attr);
4664 CHECK_STRING (value);
4666 if (xstricmp (SDATA (value), "unspecified") == 0)
4667 value = Qunspecified;
4668 else if (EQ (attr, QCheight))
4670 value = Fstring_to_number (value, make_number (10));
4671 if (XINT (value) <= 0)
4672 signal_error ("Invalid face height from X resource", value);
4674 else if (EQ (attr, QCbold) || EQ (attr, QCitalic))
4675 value = face_boolean_x_resource_value (value, 1);
4676 else if (EQ (attr, QCweight) || EQ (attr, QCslant) || EQ (attr, QCwidth))
4677 value = intern (SDATA (value));
4678 else if (EQ (attr, QCreverse_video) || EQ (attr, QCinverse_video))
4679 value = face_boolean_x_resource_value (value, 1);
4680 else if (EQ (attr, QCunderline)
4681 || EQ (attr, QCoverline)
4682 || EQ (attr, QCstrike_through))
4684 Lisp_Object boolean_value;
4686 /* If the result of face_boolean_x_resource_value is t or nil,
4687 VALUE does NOT specify a color. */
4688 boolean_value = face_boolean_x_resource_value (value, 0);
4689 if (SYMBOLP (boolean_value))
4690 value = boolean_value;
4692 else if (EQ (attr, QCbox) || EQ (attr, QCinherit))
4693 value = Fcar (Fread_from_string (value, Qnil, Qnil));
4695 return Finternal_set_lisp_face_attribute (face, attr, value, frame);
4698 #endif /* HAVE_WINDOW_SYSTEM */
4701 /***********************************************************************
4702 Menu face
4703 ***********************************************************************/
4705 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
4707 /* Make menus on frame F appear as specified by the `menu' face. */
4709 static void
4710 x_update_menu_appearance (f)
4711 struct frame *f;
4713 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
4714 XrmDatabase rdb;
4716 if (dpyinfo
4717 && (rdb = XrmGetDatabase (FRAME_X_DISPLAY (f)),
4718 rdb != NULL))
4720 char line[512];
4721 Lisp_Object lface = lface_from_face_name (f, Qmenu, 1);
4722 struct face *face = FACE_FROM_ID (f, MENU_FACE_ID);
4723 const char *myname = SDATA (Vx_resource_name);
4724 int changed_p = 0;
4725 #ifdef USE_MOTIF
4726 const char *popup_path = "popup_menu";
4727 #else
4728 const char *popup_path = "menu.popup";
4729 #endif
4731 if (STRINGP (LFACE_FOREGROUND (lface)))
4733 sprintf (line, "%s.%s*foreground: %s",
4734 myname, popup_path,
4735 SDATA (LFACE_FOREGROUND (lface)));
4736 XrmPutLineResource (&rdb, line);
4737 sprintf (line, "%s.pane.menubar*foreground: %s",
4738 myname, SDATA (LFACE_FOREGROUND (lface)));
4739 XrmPutLineResource (&rdb, line);
4740 changed_p = 1;
4743 if (STRINGP (LFACE_BACKGROUND (lface)))
4745 sprintf (line, "%s.%s*background: %s",
4746 myname, popup_path,
4747 SDATA (LFACE_BACKGROUND (lface)));
4748 XrmPutLineResource (&rdb, line);
4749 sprintf (line, "%s.pane.menubar*background: %s",
4750 myname, SDATA (LFACE_BACKGROUND (lface)));
4751 XrmPutLineResource (&rdb, line);
4752 changed_p = 1;
4755 if (face->font_name
4756 && (!UNSPECIFIEDP (LFACE_FAMILY (lface))
4757 || !UNSPECIFIEDP (LFACE_SWIDTH (lface))
4758 || !UNSPECIFIEDP (LFACE_AVGWIDTH (lface))
4759 || !UNSPECIFIEDP (LFACE_WEIGHT (lface))
4760 || !UNSPECIFIEDP (LFACE_SLANT (lface))
4761 || !UNSPECIFIEDP (LFACE_HEIGHT (lface))))
4763 #ifdef USE_MOTIF
4764 const char *suffix = "List";
4765 Bool motif = True;
4766 #else
4767 #if defined HAVE_X_I18N
4769 const char *suffix = "Set";
4770 #else
4771 const char *suffix = "";
4772 #endif
4773 Bool motif = False;
4774 #endif
4775 #if defined HAVE_X_I18N
4776 extern char *xic_create_fontsetname
4777 P_ ((char *base_fontname, Bool motif));
4778 char *fontsetname = xic_create_fontsetname (face->font_name, motif);
4779 #else
4780 char *fontsetname = face->font_name;
4781 #endif
4782 sprintf (line, "%s.pane.menubar*font%s: %s",
4783 myname, suffix, fontsetname);
4784 XrmPutLineResource (&rdb, line);
4785 sprintf (line, "%s.%s*font%s: %s",
4786 myname, popup_path, suffix, fontsetname);
4787 XrmPutLineResource (&rdb, line);
4788 changed_p = 1;
4789 if (fontsetname != face->font_name)
4790 xfree (fontsetname);
4793 if (changed_p && f->output_data.x->menubar_widget)
4794 free_frame_menubar (f);
4798 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
4801 DEFUN ("face-attribute-relative-p", Fface_attribute_relative_p,
4802 Sface_attribute_relative_p,
4803 2, 2, 0,
4804 doc: /* Check whether a face attribute value is relative.
4805 Specifically, this function returns t if the attribute ATTRIBUTE
4806 with the value VALUE is relative.
4808 A relative value is one that doesn't entirely override whatever is
4809 inherited from another face. For most possible attributes,
4810 the only relative value that users see is `unspecified'.
4811 However, for :height, floating point values are also relative. */)
4812 (attribute, value)
4813 Lisp_Object attribute, value;
4815 if (EQ (value, Qunspecified) || (EQ (value, Qignore_defface)))
4816 return Qt;
4817 else if (EQ (attribute, QCheight))
4818 return INTEGERP (value) ? Qnil : Qt;
4819 else
4820 return Qnil;
4823 DEFUN ("merge-face-attribute", Fmerge_face_attribute, Smerge_face_attribute,
4824 3, 3, 0,
4825 doc: /* Return face ATTRIBUTE VALUE1 merged with VALUE2.
4826 If VALUE1 or VALUE2 are absolute (see `face-attribute-relative-p'), then
4827 the result will be absolute, otherwise it will be relative. */)
4828 (attribute, value1, value2)
4829 Lisp_Object attribute, value1, value2;
4831 if (EQ (value1, Qunspecified) || EQ (value1, Qignore_defface))
4832 return value2;
4833 else if (EQ (attribute, QCheight))
4834 return merge_face_heights (value1, value2, value1);
4835 else
4836 return value1;
4840 DEFUN ("internal-get-lisp-face-attribute", Finternal_get_lisp_face_attribute,
4841 Sinternal_get_lisp_face_attribute,
4842 2, 3, 0,
4843 doc: /* Return face attribute KEYWORD of face SYMBOL.
4844 If SYMBOL does not name a valid Lisp face or KEYWORD isn't a valid
4845 face attribute name, signal an error.
4846 If the optional argument FRAME is given, report on face SYMBOL in that
4847 frame. If FRAME is t, report on the defaults for face SYMBOL (for new
4848 frames). If FRAME is omitted or nil, use the selected frame. */)
4849 (symbol, keyword, frame)
4850 Lisp_Object symbol, keyword, frame;
4852 Lisp_Object lface, value = Qnil;
4854 CHECK_SYMBOL (symbol);
4855 CHECK_SYMBOL (keyword);
4857 if (EQ (frame, Qt))
4858 lface = lface_from_face_name (NULL, symbol, 1);
4859 else
4861 if (NILP (frame))
4862 frame = selected_frame;
4863 CHECK_LIVE_FRAME (frame);
4864 lface = lface_from_face_name (XFRAME (frame), symbol, 1);
4867 if (EQ (keyword, QCfamily))
4868 value = LFACE_FAMILY (lface);
4869 else if (EQ (keyword, QCheight))
4870 value = LFACE_HEIGHT (lface);
4871 else if (EQ (keyword, QCweight))
4872 value = LFACE_WEIGHT (lface);
4873 else if (EQ (keyword, QCslant))
4874 value = LFACE_SLANT (lface);
4875 else if (EQ (keyword, QCunderline))
4876 value = LFACE_UNDERLINE (lface);
4877 else if (EQ (keyword, QCoverline))
4878 value = LFACE_OVERLINE (lface);
4879 else if (EQ (keyword, QCstrike_through))
4880 value = LFACE_STRIKE_THROUGH (lface);
4881 else if (EQ (keyword, QCbox))
4882 value = LFACE_BOX (lface);
4883 else if (EQ (keyword, QCinverse_video)
4884 || EQ (keyword, QCreverse_video))
4885 value = LFACE_INVERSE (lface);
4886 else if (EQ (keyword, QCforeground))
4887 value = LFACE_FOREGROUND (lface);
4888 else if (EQ (keyword, QCbackground))
4889 value = LFACE_BACKGROUND (lface);
4890 else if (EQ (keyword, QCstipple))
4891 value = LFACE_STIPPLE (lface);
4892 else if (EQ (keyword, QCwidth))
4893 value = LFACE_SWIDTH (lface);
4894 else if (EQ (keyword, QCinherit))
4895 value = LFACE_INHERIT (lface);
4896 else if (EQ (keyword, QCfont))
4897 value = LFACE_FONT (lface);
4898 else
4899 signal_error ("Invalid face attribute name", keyword);
4901 if (IGNORE_DEFFACE_P (value))
4902 return Qunspecified;
4904 return value;
4908 DEFUN ("internal-lisp-face-attribute-values",
4909 Finternal_lisp_face_attribute_values,
4910 Sinternal_lisp_face_attribute_values, 1, 1, 0,
4911 doc: /* Return a list of valid discrete values for face attribute ATTR.
4912 Value is nil if ATTR doesn't have a discrete set of valid values. */)
4913 (attr)
4914 Lisp_Object attr;
4916 Lisp_Object result = Qnil;
4918 CHECK_SYMBOL (attr);
4920 if (EQ (attr, QCweight)
4921 || EQ (attr, QCslant)
4922 || EQ (attr, QCwidth))
4924 /* Extract permissible symbols from tables. */
4925 struct table_entry *table;
4926 int i, dim;
4928 if (EQ (attr, QCweight))
4929 table = weight_table, dim = DIM (weight_table);
4930 else if (EQ (attr, QCslant))
4931 table = slant_table, dim = DIM (slant_table);
4932 else
4933 table = swidth_table, dim = DIM (swidth_table);
4935 for (i = 0; i < dim; ++i)
4937 Lisp_Object symbol = *table[i].symbol;
4938 Lisp_Object tail = result;
4940 while (!NILP (tail)
4941 && !EQ (XCAR (tail), symbol))
4942 tail = XCDR (tail);
4944 if (NILP (tail))
4945 result = Fcons (symbol, result);
4948 else if (EQ (attr, QCunderline))
4949 result = Fcons (Qt, Fcons (Qnil, Qnil));
4950 else if (EQ (attr, QCoverline))
4951 result = Fcons (Qt, Fcons (Qnil, Qnil));
4952 else if (EQ (attr, QCstrike_through))
4953 result = Fcons (Qt, Fcons (Qnil, Qnil));
4954 else if (EQ (attr, QCinverse_video) || EQ (attr, QCreverse_video))
4955 result = Fcons (Qt, Fcons (Qnil, Qnil));
4957 return result;
4961 DEFUN ("internal-merge-in-global-face", Finternal_merge_in_global_face,
4962 Sinternal_merge_in_global_face, 2, 2, 0,
4963 doc: /* Add attributes from frame-default definition of FACE to FACE on FRAME.
4964 Default face attributes override any local face attributes. */)
4965 (face, frame)
4966 Lisp_Object face, frame;
4968 int i;
4969 Lisp_Object global_lface, local_lface, *gvec, *lvec;
4971 CHECK_LIVE_FRAME (frame);
4972 global_lface = lface_from_face_name (NULL, face, 1);
4973 local_lface = lface_from_face_name (XFRAME (frame), face, 0);
4974 if (NILP (local_lface))
4975 local_lface = Finternal_make_lisp_face (face, frame);
4977 /* Make every specified global attribute override the local one.
4978 BEWARE!! This is only used from `face-set-after-frame-default' where
4979 the local frame is defined from default specs in `face-defface-spec'
4980 and those should be overridden by global settings. Hence the strange
4981 "global before local" priority. */
4982 lvec = XVECTOR (local_lface)->contents;
4983 gvec = XVECTOR (global_lface)->contents;
4984 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
4985 if (! UNSPECIFIEDP (gvec[i]))
4987 if (IGNORE_DEFFACE_P (gvec[i]))
4988 lvec[i] = Qunspecified;
4989 else
4990 lvec[i] = gvec[i];
4993 return Qnil;
4997 /* The following function is implemented for compatibility with 20.2.
4998 The function is used in x-resolve-fonts when it is asked to
4999 return fonts with the same size as the font of a face. This is
5000 done in fontset.el. */
5002 DEFUN ("face-font", Fface_font, Sface_font, 1, 2, 0,
5003 doc: /* Return the font name of face FACE, or nil if it is unspecified.
5004 If the optional argument FRAME is given, report on face FACE in that frame.
5005 If FRAME is t, report on the defaults for face FACE (for new frames).
5006 The font default for a face is either nil, or a list
5007 of the form (bold), (italic) or (bold italic).
5008 If FRAME is omitted or nil, use the selected frame. */)
5009 (face, frame)
5010 Lisp_Object face, frame;
5012 if (EQ (frame, Qt))
5014 Lisp_Object result = Qnil;
5015 Lisp_Object lface = lface_from_face_name (NULL, face, 1);
5017 if (!UNSPECIFIEDP (LFACE_WEIGHT (lface))
5018 && !EQ (LFACE_WEIGHT (lface), Qnormal))
5019 result = Fcons (Qbold, result);
5021 if (!UNSPECIFIEDP (LFACE_SLANT (lface))
5022 && !EQ (LFACE_SLANT (lface), Qnormal))
5023 result = Fcons (Qitalic, result);
5025 return result;
5027 else
5029 struct frame *f = frame_or_selected_frame (frame, 1);
5030 int face_id = lookup_named_face (f, face, 0, 1);
5031 struct face *face = FACE_FROM_ID (f, face_id);
5032 return face ? build_string (face->font_name) : Qnil;
5037 /* Compare face-attribute values v1 and v2 for equality. Value is non-zero if
5038 all attributes are `equal'. Tries to be fast because this function
5039 is called quite often. */
5041 static INLINE int
5042 face_attr_equal_p (v1, v2)
5043 Lisp_Object v1, v2;
5045 /* Type can differ, e.g. when one attribute is unspecified, i.e. nil,
5046 and the other is specified. */
5047 if (XTYPE (v1) != XTYPE (v2))
5048 return 0;
5050 if (EQ (v1, v2))
5051 return 1;
5053 switch (XTYPE (v1))
5055 case Lisp_String:
5056 if (SBYTES (v1) != SBYTES (v2))
5057 return 0;
5059 return bcmp (SDATA (v1), SDATA (v2), SBYTES (v1)) == 0;
5061 case Lisp_Int:
5062 case Lisp_Symbol:
5063 return 0;
5065 default:
5066 return !NILP (Fequal (v1, v2));
5071 /* Compare face vectors V1 and V2 for equality. Value is non-zero if
5072 all attributes are `equal'. Tries to be fast because this function
5073 is called quite often. */
5075 static INLINE int
5076 lface_equal_p (v1, v2)
5077 Lisp_Object *v1, *v2;
5079 int i, equal_p = 1;
5081 for (i = 1; i < LFACE_VECTOR_SIZE && equal_p; ++i)
5082 equal_p = face_attr_equal_p (v1[i], v2[i]);
5084 return equal_p;
5088 DEFUN ("internal-lisp-face-equal-p", Finternal_lisp_face_equal_p,
5089 Sinternal_lisp_face_equal_p, 2, 3, 0,
5090 doc: /* True if FACE1 and FACE2 are equal.
5091 If the optional argument FRAME is given, report on FACE1 and FACE2 in that frame.
5092 If FRAME is t, report on the defaults for FACE1 and FACE2 (for new frames).
5093 If FRAME is omitted or nil, use the selected frame. */)
5094 (face1, face2, frame)
5095 Lisp_Object face1, face2, frame;
5097 int equal_p;
5098 struct frame *f;
5099 Lisp_Object lface1, lface2;
5101 if (EQ (frame, Qt))
5102 f = NULL;
5103 else
5104 /* Don't use check_x_frame here because this function is called
5105 before X frames exist. At that time, if FRAME is nil,
5106 selected_frame will be used which is the frame dumped with
5107 Emacs. That frame is not an X frame. */
5108 f = frame_or_selected_frame (frame, 2);
5110 lface1 = lface_from_face_name (f, face1, 1);
5111 lface2 = lface_from_face_name (f, face2, 1);
5112 equal_p = lface_equal_p (XVECTOR (lface1)->contents,
5113 XVECTOR (lface2)->contents);
5114 return equal_p ? Qt : Qnil;
5118 DEFUN ("internal-lisp-face-empty-p", Finternal_lisp_face_empty_p,
5119 Sinternal_lisp_face_empty_p, 1, 2, 0,
5120 doc: /* True if FACE has no attribute specified.
5121 If the optional argument FRAME is given, report on face FACE in that frame.
5122 If FRAME is t, report on the defaults for face FACE (for new frames).
5123 If FRAME is omitted or nil, use the selected frame. */)
5124 (face, frame)
5125 Lisp_Object face, frame;
5127 struct frame *f;
5128 Lisp_Object lface;
5129 int i;
5131 if (NILP (frame))
5132 frame = selected_frame;
5133 CHECK_LIVE_FRAME (frame);
5134 f = XFRAME (frame);
5136 if (EQ (frame, Qt))
5137 lface = lface_from_face_name (NULL, face, 1);
5138 else
5139 lface = lface_from_face_name (f, face, 1);
5141 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
5142 if (!UNSPECIFIEDP (AREF (lface, i)))
5143 break;
5145 return i == LFACE_VECTOR_SIZE ? Qt : Qnil;
5149 DEFUN ("frame-face-alist", Fframe_face_alist, Sframe_face_alist,
5150 0, 1, 0,
5151 doc: /* Return an alist of frame-local faces defined on FRAME.
5152 For internal use only. */)
5153 (frame)
5154 Lisp_Object frame;
5156 struct frame *f = frame_or_selected_frame (frame, 0);
5157 return f->face_alist;
5161 /* Return a hash code for Lisp string STRING with case ignored. Used
5162 below in computing a hash value for a Lisp face. */
5164 static INLINE unsigned
5165 hash_string_case_insensitive (string)
5166 Lisp_Object string;
5168 const unsigned char *s;
5169 unsigned hash = 0;
5170 xassert (STRINGP (string));
5171 for (s = SDATA (string); *s; ++s)
5172 hash = (hash << 1) ^ tolower (*s);
5173 return hash;
5177 /* Return a hash code for face attribute vector V. */
5179 static INLINE unsigned
5180 lface_hash (v)
5181 Lisp_Object *v;
5183 return (hash_string_case_insensitive (v[LFACE_FAMILY_INDEX])
5184 ^ hash_string_case_insensitive (v[LFACE_FOREGROUND_INDEX])
5185 ^ hash_string_case_insensitive (v[LFACE_BACKGROUND_INDEX])
5186 ^ XFASTINT (v[LFACE_WEIGHT_INDEX])
5187 ^ XFASTINT (v[LFACE_SLANT_INDEX])
5188 ^ XFASTINT (v[LFACE_SWIDTH_INDEX])
5189 ^ XFASTINT (v[LFACE_HEIGHT_INDEX]));
5193 /* Return non-zero if LFACE1 and LFACE2 specify the same font (without
5194 considering charsets/registries). They do if they specify the same
5195 family, point size, weight, width, slant, and fontset. Both LFACE1
5196 and LFACE2 must be fully-specified. */
5198 static INLINE int
5199 lface_same_font_attributes_p (lface1, lface2)
5200 Lisp_Object *lface1, *lface2;
5202 xassert (lface_fully_specified_p (lface1)
5203 && lface_fully_specified_p (lface2));
5204 return (xstricmp (SDATA (lface1[LFACE_FAMILY_INDEX]),
5205 SDATA (lface2[LFACE_FAMILY_INDEX])) == 0
5206 && EQ (lface1[LFACE_HEIGHT_INDEX], lface2[LFACE_HEIGHT_INDEX])
5207 && EQ (lface1[LFACE_SWIDTH_INDEX], lface2[LFACE_SWIDTH_INDEX])
5208 && EQ (lface1[LFACE_AVGWIDTH_INDEX], lface2[LFACE_AVGWIDTH_INDEX])
5209 && EQ (lface1[LFACE_WEIGHT_INDEX], lface2[LFACE_WEIGHT_INDEX])
5210 && EQ (lface1[LFACE_SLANT_INDEX], lface2[LFACE_SLANT_INDEX])
5211 && (EQ (lface1[LFACE_FONT_INDEX], lface2[LFACE_FONT_INDEX])
5212 || (STRINGP (lface1[LFACE_FONT_INDEX])
5213 && STRINGP (lface2[LFACE_FONT_INDEX])
5214 && xstricmp (SDATA (lface1[LFACE_FONT_INDEX]),
5215 SDATA (lface2[LFACE_FONT_INDEX])))));
5220 /***********************************************************************
5221 Realized Faces
5222 ***********************************************************************/
5224 /* Allocate and return a new realized face for Lisp face attribute
5225 vector ATTR. */
5227 static struct face *
5228 make_realized_face (attr)
5229 Lisp_Object *attr;
5231 struct face *face = (struct face *) xmalloc (sizeof *face);
5232 bzero (face, sizeof *face);
5233 face->ascii_face = face;
5234 bcopy (attr, face->lface, sizeof face->lface);
5235 return face;
5239 /* Free realized face FACE, including its X resources. FACE may
5240 be null. */
5242 static void
5243 free_realized_face (f, face)
5244 struct frame *f;
5245 struct face *face;
5247 if (face)
5249 #ifdef HAVE_WINDOW_SYSTEM
5250 if (FRAME_WINDOW_P (f))
5252 /* Free fontset of FACE if it is ASCII face. */
5253 if (face->fontset >= 0 && face == face->ascii_face)
5254 free_face_fontset (f, face);
5255 if (face->gc)
5257 BLOCK_INPUT;
5258 x_free_gc (f, face->gc);
5259 face->gc = 0;
5260 UNBLOCK_INPUT;
5263 free_face_colors (f, face);
5264 x_destroy_bitmap (f, face->stipple);
5266 #endif /* HAVE_WINDOW_SYSTEM */
5268 xfree (face);
5273 /* Prepare face FACE for subsequent display on frame F. This
5274 allocated GCs if they haven't been allocated yet or have been freed
5275 by clearing the face cache. */
5277 void
5278 prepare_face_for_display (f, face)
5279 struct frame *f;
5280 struct face *face;
5282 #ifdef HAVE_WINDOW_SYSTEM
5283 xassert (FRAME_WINDOW_P (f));
5285 if (face->gc == 0)
5287 XGCValues xgcv;
5288 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
5290 xgcv.foreground = face->foreground;
5291 xgcv.background = face->background;
5292 #ifdef HAVE_X_WINDOWS
5293 xgcv.graphics_exposures = False;
5294 #endif
5295 /* The font of FACE may be null if we couldn't load it. */
5296 if (face->font)
5298 #ifdef HAVE_X_WINDOWS
5299 xgcv.font = face->font->fid;
5300 #endif
5301 #ifdef WINDOWSNT
5302 xgcv.font = face->font;
5303 #endif
5304 #ifdef MAC_OS
5305 xgcv.font = face->font;
5306 #endif
5307 mask |= GCFont;
5310 BLOCK_INPUT;
5311 #ifdef HAVE_X_WINDOWS
5312 if (face->stipple)
5314 xgcv.fill_style = FillOpaqueStippled;
5315 xgcv.stipple = x_bitmap_pixmap (f, face->stipple);
5316 mask |= GCFillStyle | GCStipple;
5318 #endif
5319 face->gc = x_create_gc (f, mask, &xgcv);
5320 UNBLOCK_INPUT;
5322 #endif /* HAVE_WINDOW_SYSTEM */
5326 /* Returns the `distance' between the colors X and Y. */
5328 static int
5329 color_distance (x, y)
5330 XColor *x, *y;
5332 /* This formula is from a paper title `Colour metric' by Thiadmer Riemersma.
5333 Quoting from that paper:
5335 This formula has results that are very close to L*u*v* (with the
5336 modified lightness curve) and, more importantly, it is a more even
5337 algorithm: it does not have a range of colours where it suddenly
5338 gives far from optimal results.
5340 See <http://www.compuphase.com/cmetric.htm> for more info. */
5342 long r = (x->red - y->red) >> 8;
5343 long g = (x->green - y->green) >> 8;
5344 long b = (x->blue - y->blue) >> 8;
5345 long r_mean = (x->red + y->red) >> 9;
5347 return
5348 (((512 + r_mean) * r * r) >> 8)
5349 + 4 * g * g
5350 + (((767 - r_mean) * b * b) >> 8);
5354 DEFUN ("color-distance", Fcolor_distance, Scolor_distance, 2, 3, 0,
5355 doc: /* Return an integer distance between COLOR1 and COLOR2 on FRAME.
5356 COLOR1 and COLOR2 may be either strings containing the color name,
5357 or lists of the form (RED GREEN BLUE).
5358 If FRAME is unspecified or nil, the current frame is used. */)
5359 (color1, color2, frame)
5360 Lisp_Object color1, color2, frame;
5362 struct frame *f;
5363 XColor cdef1, cdef2;
5365 if (NILP (frame))
5366 frame = selected_frame;
5367 CHECK_LIVE_FRAME (frame);
5368 f = XFRAME (frame);
5370 if (!(CONSP (color1) && parse_rgb_list (color1, &cdef1))
5371 && !(STRINGP (color1) && defined_color (f, SDATA (color1), &cdef1, 0)))
5372 signal_error ("Invalid color", color1);
5373 if (!(CONSP (color2) && parse_rgb_list (color2, &cdef2))
5374 && !(STRINGP (color2) && defined_color (f, SDATA (color2), &cdef2, 0)))
5375 signal_error ("Invalid color", color2);
5377 return make_number (color_distance (&cdef1, &cdef2));
5381 /***********************************************************************
5382 Face Cache
5383 ***********************************************************************/
5385 /* Return a new face cache for frame F. */
5387 static struct face_cache *
5388 make_face_cache (f)
5389 struct frame *f;
5391 struct face_cache *c;
5392 int size;
5394 c = (struct face_cache *) xmalloc (sizeof *c);
5395 bzero (c, sizeof *c);
5396 size = FACE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
5397 c->buckets = (struct face **) xmalloc (size);
5398 bzero (c->buckets, size);
5399 c->size = 50;
5400 c->faces_by_id = (struct face **) xmalloc (c->size * sizeof *c->faces_by_id);
5401 c->f = f;
5402 c->menu_face_changed_p = menu_face_changed_default;
5403 return c;
5407 /* Clear out all graphics contexts for all realized faces, except for
5408 the basic faces. This should be done from time to time just to avoid
5409 keeping too many graphics contexts that are no longer needed. */
5411 static void
5412 clear_face_gcs (c)
5413 struct face_cache *c;
5415 if (c && FRAME_WINDOW_P (c->f))
5417 #ifdef HAVE_WINDOW_SYSTEM
5418 int i;
5419 for (i = BASIC_FACE_ID_SENTINEL; i < c->used; ++i)
5421 struct face *face = c->faces_by_id[i];
5422 if (face && face->gc)
5424 BLOCK_INPUT;
5425 x_free_gc (c->f, face->gc);
5426 face->gc = 0;
5427 UNBLOCK_INPUT;
5430 #endif /* HAVE_WINDOW_SYSTEM */
5435 /* Free all realized faces in face cache C, including basic faces.
5436 C may be null. If faces are freed, make sure the frame's current
5437 matrix is marked invalid, so that a display caused by an expose
5438 event doesn't try to use faces we destroyed. */
5440 static void
5441 free_realized_faces (c)
5442 struct face_cache *c;
5444 if (c && c->used)
5446 int i, size;
5447 struct frame *f = c->f;
5449 /* We must block input here because we can't process X events
5450 safely while only some faces are freed, or when the frame's
5451 current matrix still references freed faces. */
5452 BLOCK_INPUT;
5454 for (i = 0; i < c->used; ++i)
5456 free_realized_face (f, c->faces_by_id[i]);
5457 c->faces_by_id[i] = NULL;
5460 c->used = 0;
5461 size = FACE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
5462 bzero (c->buckets, size);
5464 /* Must do a thorough redisplay the next time. Mark current
5465 matrices as invalid because they will reference faces freed
5466 above. This function is also called when a frame is
5467 destroyed. In this case, the root window of F is nil. */
5468 if (WINDOWP (f->root_window))
5470 clear_current_matrices (f);
5471 ++windows_or_buffers_changed;
5474 UNBLOCK_INPUT;
5479 /* Free all faces realized for multibyte characters on frame F that
5480 has FONTSET. */
5482 void
5483 free_realized_multibyte_face (f, fontset)
5484 struct frame *f;
5485 int fontset;
5487 struct face_cache *cache = FRAME_FACE_CACHE (f);
5488 struct face *face;
5489 int i;
5491 /* We must block input here because we can't process X events safely
5492 while only some faces are freed, or when the frame's current
5493 matrix still references freed faces. */
5494 BLOCK_INPUT;
5496 for (i = 0; i < cache->used; i++)
5498 face = cache->faces_by_id[i];
5499 if (face
5500 && face != face->ascii_face
5501 && face->fontset == fontset)
5503 uncache_face (cache, face);
5504 free_realized_face (f, face);
5508 /* Must do a thorough redisplay the next time. Mark current
5509 matrices as invalid because they will reference faces freed
5510 above. This function is also called when a frame is destroyed.
5511 In this case, the root window of F is nil. */
5512 if (WINDOWP (f->root_window))
5514 clear_current_matrices (f);
5515 ++windows_or_buffers_changed;
5518 UNBLOCK_INPUT;
5522 /* Free all realized faces on FRAME or on all frames if FRAME is nil.
5523 This is done after attributes of a named face have been changed,
5524 because we can't tell which realized faces depend on that face. */
5526 void
5527 free_all_realized_faces (frame)
5528 Lisp_Object frame;
5530 if (NILP (frame))
5532 Lisp_Object rest;
5533 FOR_EACH_FRAME (rest, frame)
5534 free_realized_faces (FRAME_FACE_CACHE (XFRAME (frame)));
5536 else
5537 free_realized_faces (FRAME_FACE_CACHE (XFRAME (frame)));
5541 /* Free face cache C and faces in it, including their X resources. */
5543 static void
5544 free_face_cache (c)
5545 struct face_cache *c;
5547 if (c)
5549 free_realized_faces (c);
5550 xfree (c->buckets);
5551 xfree (c->faces_by_id);
5552 xfree (c);
5557 /* Cache realized face FACE in face cache C. HASH is the hash value
5558 of FACE. If FACE->fontset >= 0, add the new face to the end of the
5559 collision list of the face hash table of C. This is done because
5560 otherwise lookup_face would find FACE for every character, even if
5561 faces with the same attributes but for specific characters exist. */
5563 static void
5564 cache_face (c, face, hash)
5565 struct face_cache *c;
5566 struct face *face;
5567 unsigned hash;
5569 int i = hash % FACE_CACHE_BUCKETS_SIZE;
5571 face->hash = hash;
5573 if (face->fontset >= 0)
5575 struct face *last = c->buckets[i];
5576 if (last)
5578 while (last->next)
5579 last = last->next;
5580 last->next = face;
5581 face->prev = last;
5582 face->next = NULL;
5584 else
5586 c->buckets[i] = face;
5587 face->prev = face->next = NULL;
5590 else
5592 face->prev = NULL;
5593 face->next = c->buckets[i];
5594 if (face->next)
5595 face->next->prev = face;
5596 c->buckets[i] = face;
5599 /* Find a free slot in C->faces_by_id and use the index of the free
5600 slot as FACE->id. */
5601 for (i = 0; i < c->used; ++i)
5602 if (c->faces_by_id[i] == NULL)
5603 break;
5604 face->id = i;
5606 /* Maybe enlarge C->faces_by_id. */
5607 if (i == c->used)
5609 if (c->used == c->size)
5611 int new_size, sz;
5612 new_size = min (2 * c->size, MAX_FACE_ID);
5613 if (new_size == c->size)
5614 abort (); /* Alternatives? ++kfs */
5615 sz = new_size * sizeof *c->faces_by_id;
5616 c->faces_by_id = (struct face **) xrealloc (c->faces_by_id, sz);
5617 c->size = new_size;
5619 c->used++;
5622 #if GLYPH_DEBUG
5623 /* Check that FACE got a unique id. */
5625 int j, n;
5626 struct face *face;
5628 for (j = n = 0; j < FACE_CACHE_BUCKETS_SIZE; ++j)
5629 for (face = c->buckets[j]; face; face = face->next)
5630 if (face->id == i)
5631 ++n;
5633 xassert (n == 1);
5635 #endif /* GLYPH_DEBUG */
5637 c->faces_by_id[i] = face;
5641 /* Remove face FACE from cache C. */
5643 static void
5644 uncache_face (c, face)
5645 struct face_cache *c;
5646 struct face *face;
5648 int i = face->hash % FACE_CACHE_BUCKETS_SIZE;
5650 if (face->prev)
5651 face->prev->next = face->next;
5652 else
5653 c->buckets[i] = face->next;
5655 if (face->next)
5656 face->next->prev = face->prev;
5658 c->faces_by_id[face->id] = NULL;
5659 if (face->id == c->used)
5660 --c->used;
5664 /* Look up a realized face with face attributes ATTR in the face cache
5665 of frame F. The face will be used to display character C. Value
5666 is the ID of the face found. If no suitable face is found, realize
5667 a new one. In that case, if C is a multibyte character, BASE_FACE
5668 is a face that has the same attributes. */
5670 INLINE int
5671 lookup_face (f, attr, c, base_face)
5672 struct frame *f;
5673 Lisp_Object *attr;
5674 int c;
5675 struct face *base_face;
5677 struct face_cache *cache = FRAME_FACE_CACHE (f);
5678 unsigned hash;
5679 int i;
5680 struct face *face;
5682 xassert (cache != NULL);
5683 check_lface_attrs (attr);
5685 /* Look up ATTR in the face cache. */
5686 hash = lface_hash (attr);
5687 i = hash % FACE_CACHE_BUCKETS_SIZE;
5689 for (face = cache->buckets[i]; face; face = face->next)
5690 if (face->hash == hash
5691 && (!FRAME_WINDOW_P (f)
5692 || FACE_SUITABLE_FOR_CHAR_P (face, c))
5693 && lface_equal_p (face->lface, attr))
5694 break;
5696 /* If not found, realize a new face. */
5697 if (face == NULL)
5698 face = realize_face (cache, attr, c, base_face, -1);
5700 #if GLYPH_DEBUG
5701 xassert (face == FACE_FROM_ID (f, face->id));
5703 /* When this function is called from face_for_char (in this case, C is
5704 a multibyte character), a fontset of a face returned by
5705 realize_face is not yet set, i.e. FACE_SUITABLE_FOR_CHAR_P (FACE,
5706 C) is not sutisfied. The fontset is set for this face by
5707 face_for_char later. */
5708 #if 0
5709 if (FRAME_WINDOW_P (f))
5710 xassert (FACE_SUITABLE_FOR_CHAR_P (face, c));
5711 #endif
5712 #endif /* GLYPH_DEBUG */
5714 return face->id;
5718 /* Return the face id of the realized face for named face SYMBOL on
5719 frame F suitable for displaying character C. Value is -1 if the
5720 face couldn't be determined, which might happen if the default face
5721 isn't realized and cannot be realized. */
5724 lookup_named_face (f, symbol, c, signal_p)
5725 struct frame *f;
5726 Lisp_Object symbol;
5727 int c;
5728 int signal_p;
5730 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5731 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
5732 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5734 if (default_face == NULL)
5736 if (!realize_basic_faces (f))
5737 return -1;
5738 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5739 if (default_face == NULL)
5740 abort (); /* realize_basic_faces must have set it up */
5743 if (!get_lface_attributes (f, symbol, symbol_attrs, signal_p))
5744 return -1;
5746 bcopy (default_face->lface, attrs, sizeof attrs);
5747 merge_face_vectors (f, symbol_attrs, attrs, 0);
5749 return lookup_face (f, attrs, c, NULL);
5753 /* Return the ID of the realized ASCII face of Lisp face with ID
5754 LFACE_ID on frame F. Value is -1 if LFACE_ID isn't valid. */
5757 ascii_face_of_lisp_face (f, lface_id)
5758 struct frame *f;
5759 int lface_id;
5761 int face_id;
5763 if (lface_id >= 0 && lface_id < lface_id_to_name_size)
5765 Lisp_Object face_name = lface_id_to_name[lface_id];
5766 face_id = lookup_named_face (f, face_name, 0, 1);
5768 else
5769 face_id = -1;
5771 return face_id;
5775 /* Return a face for charset ASCII that is like the face with id
5776 FACE_ID on frame F, but has a font that is STEPS steps smaller.
5777 STEPS < 0 means larger. Value is the id of the face. */
5780 smaller_face (f, face_id, steps)
5781 struct frame *f;
5782 int face_id, steps;
5784 #ifdef HAVE_WINDOW_SYSTEM
5785 struct face *face;
5786 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5787 int pt, last_pt, last_height;
5788 int delta;
5789 int new_face_id;
5790 struct face *new_face;
5792 /* If not called for an X frame, just return the original face. */
5793 if (FRAME_TERMCAP_P (f))
5794 return face_id;
5796 /* Try in increments of 1/2 pt. */
5797 delta = steps < 0 ? 5 : -5;
5798 steps = eabs (steps);
5800 face = FACE_FROM_ID (f, face_id);
5801 bcopy (face->lface, attrs, sizeof attrs);
5802 pt = last_pt = XFASTINT (attrs[LFACE_HEIGHT_INDEX]);
5803 new_face_id = face_id;
5804 last_height = FONT_HEIGHT (face->font);
5806 while (steps
5807 && pt + delta > 0
5808 /* Give up if we cannot find a font within 10pt. */
5809 && eabs (last_pt - pt) < 100)
5811 /* Look up a face for a slightly smaller/larger font. */
5812 pt += delta;
5813 attrs[LFACE_HEIGHT_INDEX] = make_number (pt);
5814 new_face_id = lookup_face (f, attrs, 0, NULL);
5815 new_face = FACE_FROM_ID (f, new_face_id);
5817 /* If height changes, count that as one step. */
5818 if ((delta < 0 && FONT_HEIGHT (new_face->font) < last_height)
5819 || (delta > 0 && FONT_HEIGHT (new_face->font) > last_height))
5821 --steps;
5822 last_height = FONT_HEIGHT (new_face->font);
5823 last_pt = pt;
5827 return new_face_id;
5829 #else /* not HAVE_WINDOW_SYSTEM */
5831 return face_id;
5833 #endif /* not HAVE_WINDOW_SYSTEM */
5837 /* Return a face for charset ASCII that is like the face with id
5838 FACE_ID on frame F, but has height HEIGHT. */
5841 face_with_height (f, face_id, height)
5842 struct frame *f;
5843 int face_id;
5844 int height;
5846 #ifdef HAVE_WINDOW_SYSTEM
5847 struct face *face;
5848 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5850 if (FRAME_TERMCAP_P (f)
5851 || height <= 0)
5852 return face_id;
5854 face = FACE_FROM_ID (f, face_id);
5855 bcopy (face->lface, attrs, sizeof attrs);
5856 attrs[LFACE_HEIGHT_INDEX] = make_number (height);
5857 face_id = lookup_face (f, attrs, 0, NULL);
5858 #endif /* HAVE_WINDOW_SYSTEM */
5860 return face_id;
5864 /* Return the face id of the realized face for named face SYMBOL on
5865 frame F suitable for displaying character C, and use attributes of
5866 the face FACE_ID for attributes that aren't completely specified by
5867 SYMBOL. This is like lookup_named_face, except that the default
5868 attributes come from FACE_ID, not from the default face. FACE_ID
5869 is assumed to be already realized. */
5872 lookup_derived_face (f, symbol, c, face_id, signal_p)
5873 struct frame *f;
5874 Lisp_Object symbol;
5875 int c;
5876 int face_id;
5877 int signal_p;
5879 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5880 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
5881 struct face *default_face = FACE_FROM_ID (f, face_id);
5883 if (!default_face)
5884 abort ();
5886 get_lface_attributes (f, symbol, symbol_attrs, signal_p);
5887 bcopy (default_face->lface, attrs, sizeof attrs);
5888 merge_face_vectors (f, symbol_attrs, attrs, 0);
5889 return lookup_face (f, attrs, c, default_face);
5892 DEFUN ("face-attributes-as-vector", Fface_attributes_as_vector,
5893 Sface_attributes_as_vector, 1, 1, 0,
5894 doc: /* Return a vector of face attributes corresponding to PLIST. */)
5895 (plist)
5896 Lisp_Object plist;
5898 Lisp_Object lface;
5899 lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
5900 Qunspecified);
5901 merge_face_ref (XFRAME (selected_frame), plist, XVECTOR (lface)->contents,
5902 1, 0);
5903 return lface;
5908 /***********************************************************************
5909 Face capability testing
5910 ***********************************************************************/
5913 /* If the distance (as returned by color_distance) between two colors is
5914 less than this, then they are considered the same, for determining
5915 whether a color is supported or not. The range of values is 0-65535. */
5917 #define TTY_SAME_COLOR_THRESHOLD 10000
5919 #ifdef HAVE_WINDOW_SYSTEM
5921 /* Return non-zero if all the face attributes in ATTRS are supported
5922 on the window-system frame F.
5924 The definition of `supported' is somewhat heuristic, but basically means
5925 that a face containing all the attributes in ATTRS, when merged with the
5926 default face for display, can be represented in a way that's
5928 \(1) different in appearance than the default face, and
5929 \(2) `close in spirit' to what the attributes specify, if not exact. */
5931 static int
5932 x_supports_face_attributes_p (f, attrs, def_face)
5933 struct frame *f;
5934 Lisp_Object *attrs;
5935 struct face *def_face;
5937 Lisp_Object *def_attrs = def_face->lface;
5939 /* Check that other specified attributes are different that the default
5940 face. */
5941 if ((!UNSPECIFIEDP (attrs[LFACE_UNDERLINE_INDEX])
5942 && face_attr_equal_p (attrs[LFACE_UNDERLINE_INDEX],
5943 def_attrs[LFACE_UNDERLINE_INDEX]))
5944 || (!UNSPECIFIEDP (attrs[LFACE_INVERSE_INDEX])
5945 && face_attr_equal_p (attrs[LFACE_INVERSE_INDEX],
5946 def_attrs[LFACE_INVERSE_INDEX]))
5947 || (!UNSPECIFIEDP (attrs[LFACE_FOREGROUND_INDEX])
5948 && face_attr_equal_p (attrs[LFACE_FOREGROUND_INDEX],
5949 def_attrs[LFACE_FOREGROUND_INDEX]))
5950 || (!UNSPECIFIEDP (attrs[LFACE_BACKGROUND_INDEX])
5951 && face_attr_equal_p (attrs[LFACE_BACKGROUND_INDEX],
5952 def_attrs[LFACE_BACKGROUND_INDEX]))
5953 || (!UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
5954 && face_attr_equal_p (attrs[LFACE_STIPPLE_INDEX],
5955 def_attrs[LFACE_STIPPLE_INDEX]))
5956 || (!UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
5957 && face_attr_equal_p (attrs[LFACE_OVERLINE_INDEX],
5958 def_attrs[LFACE_OVERLINE_INDEX]))
5959 || (!UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
5960 && face_attr_equal_p (attrs[LFACE_STRIKE_THROUGH_INDEX],
5961 def_attrs[LFACE_STRIKE_THROUGH_INDEX]))
5962 || (!UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
5963 && face_attr_equal_p (attrs[LFACE_BOX_INDEX],
5964 def_attrs[LFACE_BOX_INDEX])))
5965 return 0;
5967 /* Check font-related attributes, as those are the most commonly
5968 "unsupported" on a window-system (because of missing fonts). */
5969 if (!UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
5970 || !UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
5971 || !UNSPECIFIEDP (attrs[LFACE_WEIGHT_INDEX])
5972 || !UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX])
5973 || !UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
5974 || !UNSPECIFIEDP (attrs[LFACE_AVGWIDTH_INDEX]))
5976 struct face *face;
5977 Lisp_Object merged_attrs[LFACE_VECTOR_SIZE];
5979 bcopy (def_attrs, merged_attrs, sizeof merged_attrs);
5981 merge_face_vectors (f, attrs, merged_attrs, 0);
5983 face = FACE_FROM_ID (f, lookup_face (f, merged_attrs, 0, 0));
5985 if (! face)
5986 error ("Cannot make face");
5988 /* If the font is the same, then not supported. */
5989 if (face->font == def_face->font)
5990 return 0;
5993 /* Everything checks out, this face is supported. */
5994 return 1;
5997 #endif /* HAVE_WINDOW_SYSTEM */
5999 /* Return non-zero if all the face attributes in ATTRS are supported
6000 on the tty frame F.
6002 The definition of `supported' is somewhat heuristic, but basically means
6003 that a face containing all the attributes in ATTRS, when merged
6004 with the default face for display, can be represented in a way that's
6006 \(1) different in appearance than the default face, and
6007 \(2) `close in spirit' to what the attributes specify, if not exact.
6009 Point (2) implies that a `:weight black' attribute will be satisfied
6010 by any terminal that can display bold, and a `:foreground "yellow"' as
6011 long as the terminal can display a yellowish color, but `:slant italic'
6012 will _not_ be satisfied by the tty display code's automatic
6013 substitution of a `dim' face for italic. */
6015 static int
6016 tty_supports_face_attributes_p (f, attrs, def_face)
6017 struct frame *f;
6018 Lisp_Object *attrs;
6019 struct face *def_face;
6021 int weight;
6022 Lisp_Object val, fg, bg;
6023 XColor fg_tty_color, fg_std_color;
6024 XColor bg_tty_color, bg_std_color;
6025 unsigned test_caps = 0;
6026 Lisp_Object *def_attrs = def_face->lface;
6029 /* First check some easy-to-check stuff; ttys support none of the
6030 following attributes, so we can just return false if any are requested
6031 (even if `nominal' values are specified, we should still return false,
6032 as that will be the same value that the default face uses). We
6033 consider :slant unsupportable on ttys, even though the face code
6034 actually `fakes' them using a dim attribute if possible. This is
6035 because the faked result is too different from what the face
6036 specifies. */
6037 if (!UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
6038 || !UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
6039 || !UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
6040 || !UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
6041 || !UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
6042 || !UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
6043 || !UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
6044 || !UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX]))
6045 return 0;
6048 /* Test for terminal `capabilities' (non-color character attributes). */
6050 /* font weight (bold/dim) */
6051 weight = face_numeric_weight (attrs[LFACE_WEIGHT_INDEX]);
6052 if (weight >= 0)
6054 int def_weight = face_numeric_weight (def_attrs[LFACE_WEIGHT_INDEX]);
6056 if (weight > XLFD_WEIGHT_MEDIUM)
6058 if (def_weight > XLFD_WEIGHT_MEDIUM)
6059 return 0; /* same as default */
6060 test_caps = TTY_CAP_BOLD;
6062 else if (weight < XLFD_WEIGHT_MEDIUM)
6064 if (def_weight < XLFD_WEIGHT_MEDIUM)
6065 return 0; /* same as default */
6066 test_caps = TTY_CAP_DIM;
6068 else if (def_weight == XLFD_WEIGHT_MEDIUM)
6069 return 0; /* same as default */
6072 /* underlining */
6073 val = attrs[LFACE_UNDERLINE_INDEX];
6074 if (!UNSPECIFIEDP (val))
6076 if (STRINGP (val))
6077 return 0; /* ttys can't use colored underlines */
6078 else if (face_attr_equal_p (val, def_attrs[LFACE_UNDERLINE_INDEX]))
6079 return 0; /* same as default */
6080 else
6081 test_caps |= TTY_CAP_UNDERLINE;
6084 /* inverse video */
6085 val = attrs[LFACE_INVERSE_INDEX];
6086 if (!UNSPECIFIEDP (val))
6088 if (face_attr_equal_p (val, def_attrs[LFACE_INVERSE_INDEX]))
6089 return 0; /* same as default */
6090 else
6091 test_caps |= TTY_CAP_INVERSE;
6095 /* Color testing. */
6097 /* Default the color indices in FG_TTY_COLOR and BG_TTY_COLOR, since
6098 we use them when calling `tty_capable_p' below, even if the face
6099 specifies no colors. */
6100 fg_tty_color.pixel = FACE_TTY_DEFAULT_FG_COLOR;
6101 bg_tty_color.pixel = FACE_TTY_DEFAULT_BG_COLOR;
6103 /* Check if foreground color is close enough. */
6104 fg = attrs[LFACE_FOREGROUND_INDEX];
6105 if (STRINGP (fg))
6107 Lisp_Object def_fg = def_attrs[LFACE_FOREGROUND_INDEX];
6109 if (face_attr_equal_p (fg, def_fg))
6110 return 0; /* same as default */
6111 else if (! tty_lookup_color (f, fg, &fg_tty_color, &fg_std_color))
6112 return 0; /* not a valid color */
6113 else if (color_distance (&fg_tty_color, &fg_std_color)
6114 > TTY_SAME_COLOR_THRESHOLD)
6115 return 0; /* displayed color is too different */
6116 else
6117 /* Make sure the color is really different than the default. */
6119 XColor def_fg_color;
6120 if (tty_lookup_color (f, def_fg, &def_fg_color, 0)
6121 && (color_distance (&fg_tty_color, &def_fg_color)
6122 <= TTY_SAME_COLOR_THRESHOLD))
6123 return 0;
6127 /* Check if background color is close enough. */
6128 bg = attrs[LFACE_BACKGROUND_INDEX];
6129 if (STRINGP (bg))
6131 Lisp_Object def_bg = def_attrs[LFACE_BACKGROUND_INDEX];
6133 if (face_attr_equal_p (bg, def_bg))
6134 return 0; /* same as default */
6135 else if (! tty_lookup_color (f, bg, &bg_tty_color, &bg_std_color))
6136 return 0; /* not a valid color */
6137 else if (color_distance (&bg_tty_color, &bg_std_color)
6138 > TTY_SAME_COLOR_THRESHOLD)
6139 return 0; /* displayed color is too different */
6140 else
6141 /* Make sure the color is really different than the default. */
6143 XColor def_bg_color;
6144 if (tty_lookup_color (f, def_bg, &def_bg_color, 0)
6145 && (color_distance (&bg_tty_color, &def_bg_color)
6146 <= TTY_SAME_COLOR_THRESHOLD))
6147 return 0;
6151 /* If both foreground and background are requested, see if the
6152 distance between them is OK. We just check to see if the distance
6153 between the tty's foreground and background is close enough to the
6154 distance between the standard foreground and background. */
6155 if (STRINGP (fg) && STRINGP (bg))
6157 int delta_delta
6158 = (color_distance (&fg_std_color, &bg_std_color)
6159 - color_distance (&fg_tty_color, &bg_tty_color));
6160 if (delta_delta > TTY_SAME_COLOR_THRESHOLD
6161 || delta_delta < -TTY_SAME_COLOR_THRESHOLD)
6162 return 0;
6166 /* See if the capabilities we selected above are supported, with the
6167 given colors. */
6168 if (test_caps != 0 &&
6169 ! tty_capable_p (FRAME_TTY (f), test_caps, fg_tty_color.pixel, bg_tty_color.pixel))
6170 return 0;
6173 /* Hmmm, everything checks out, this terminal must support this face. */
6174 return 1;
6178 DEFUN ("display-supports-face-attributes-p",
6179 Fdisplay_supports_face_attributes_p, Sdisplay_supports_face_attributes_p,
6180 1, 2, 0,
6181 doc: /* Return non-nil if all the face attributes in ATTRIBUTES are supported.
6182 The optional argument DISPLAY can be a display name, a frame, or
6183 nil (meaning the selected frame's display).
6185 The definition of `supported' is somewhat heuristic, but basically means
6186 that a face containing all the attributes in ATTRIBUTES, when merged
6187 with the default face for display, can be represented in a way that's
6189 \(1) different in appearance than the default face, and
6190 \(2) `close in spirit' to what the attributes specify, if not exact.
6192 Point (2) implies that a `:weight black' attribute will be satisfied by
6193 any display that can display bold, and a `:foreground \"yellow\"' as long
6194 as it can display a yellowish color, but `:slant italic' will _not_ be
6195 satisfied by the tty display code's automatic substitution of a `dim'
6196 face for italic. */)
6197 (attributes, display)
6198 Lisp_Object attributes, display;
6200 int supports = 0, i;
6201 Lisp_Object frame;
6202 struct frame *f;
6203 struct face *def_face;
6204 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6206 if (noninteractive || !initialized)
6207 /* We may not be able to access low-level face information in batch
6208 mode, or before being dumped, and this function is not going to
6209 be very useful in those cases anyway, so just give up. */
6210 return Qnil;
6212 if (NILP (display))
6213 frame = selected_frame;
6214 else if (FRAMEP (display))
6215 frame = display;
6216 else
6218 /* Find any frame on DISPLAY. */
6219 Lisp_Object fl_tail;
6221 frame = Qnil;
6222 for (fl_tail = Vframe_list; CONSP (fl_tail); fl_tail = XCDR (fl_tail))
6224 frame = XCAR (fl_tail);
6225 if (!NILP (Fequal (Fcdr (Fassq (Qdisplay,
6226 XFRAME (frame)->param_alist)),
6227 display)))
6228 break;
6232 CHECK_LIVE_FRAME (frame);
6233 f = XFRAME (frame);
6235 for (i = 0; i < LFACE_VECTOR_SIZE; i++)
6236 attrs[i] = Qunspecified;
6237 merge_face_ref (f, attributes, attrs, 1, 0);
6239 def_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
6240 if (def_face == NULL)
6242 if (! realize_basic_faces (f))
6243 error ("Cannot realize default face");
6244 def_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
6245 if (def_face == NULL)
6246 abort (); /* realize_basic_faces must have set it up */
6249 /* Dispatch to the appropriate handler. */
6250 if (FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
6251 supports = tty_supports_face_attributes_p (f, attrs, def_face);
6252 #ifdef HAVE_WINDOW_SYSTEM
6253 else
6254 supports = x_supports_face_attributes_p (f, attrs, def_face);
6255 #endif
6257 return supports ? Qt : Qnil;
6261 /***********************************************************************
6262 Font selection
6263 ***********************************************************************/
6265 DEFUN ("internal-set-font-selection-order",
6266 Finternal_set_font_selection_order,
6267 Sinternal_set_font_selection_order, 1, 1, 0,
6268 doc: /* Set font selection order for face font selection to ORDER.
6269 ORDER must be a list of length 4 containing the symbols `:width',
6270 `:height', `:weight', and `:slant'. Face attributes appearing
6271 first in ORDER are matched first, e.g. if `:height' appears before
6272 `:weight' in ORDER, font selection first tries to find a font with
6273 a suitable height, and then tries to match the font weight.
6274 Value is ORDER. */)
6275 (order)
6276 Lisp_Object order;
6278 Lisp_Object list;
6279 int i;
6280 int indices[DIM (font_sort_order)];
6282 CHECK_LIST (order);
6283 bzero (indices, sizeof indices);
6284 i = 0;
6286 for (list = order;
6287 CONSP (list) && i < DIM (indices);
6288 list = XCDR (list), ++i)
6290 Lisp_Object attr = XCAR (list);
6291 int xlfd;
6293 if (EQ (attr, QCwidth))
6294 xlfd = XLFD_SWIDTH;
6295 else if (EQ (attr, QCheight))
6296 xlfd = XLFD_POINT_SIZE;
6297 else if (EQ (attr, QCweight))
6298 xlfd = XLFD_WEIGHT;
6299 else if (EQ (attr, QCslant))
6300 xlfd = XLFD_SLANT;
6301 else
6302 break;
6304 if (indices[i] != 0)
6305 break;
6306 indices[i] = xlfd;
6309 if (!NILP (list) || i != DIM (indices))
6310 signal_error ("Invalid font sort order", order);
6311 for (i = 0; i < DIM (font_sort_order); ++i)
6312 if (indices[i] == 0)
6313 signal_error ("Invalid font sort order", order);
6315 if (bcmp (indices, font_sort_order, sizeof indices) != 0)
6317 bcopy (indices, font_sort_order, sizeof font_sort_order);
6318 free_all_realized_faces (Qnil);
6321 return Qnil;
6325 DEFUN ("internal-set-alternative-font-family-alist",
6326 Finternal_set_alternative_font_family_alist,
6327 Sinternal_set_alternative_font_family_alist, 1, 1, 0,
6328 doc: /* Define alternative font families to try in face font selection.
6329 ALIST is an alist of (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...) entries.
6330 Each ALTERNATIVE is tried in order if no fonts of font family FAMILY can
6331 be found. Value is ALIST. */)
6332 (alist)
6333 Lisp_Object alist;
6335 CHECK_LIST (alist);
6336 Vface_alternative_font_family_alist = alist;
6337 free_all_realized_faces (Qnil);
6338 return alist;
6342 DEFUN ("internal-set-alternative-font-registry-alist",
6343 Finternal_set_alternative_font_registry_alist,
6344 Sinternal_set_alternative_font_registry_alist, 1, 1, 0,
6345 doc: /* Define alternative font registries to try in face font selection.
6346 ALIST is an alist of (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...) entries.
6347 Each ALTERNATIVE is tried in order if no fonts of font registry REGISTRY can
6348 be found. Value is ALIST. */)
6349 (alist)
6350 Lisp_Object alist;
6352 CHECK_LIST (alist);
6353 Vface_alternative_font_registry_alist = alist;
6354 free_all_realized_faces (Qnil);
6355 return alist;
6359 #ifdef HAVE_WINDOW_SYSTEM
6361 /* Value is non-zero if FONT is the name of a scalable font. The
6362 X11R6 XLFD spec says that point size, pixel size, and average width
6363 are zero for scalable fonts. Intlfonts contain at least one
6364 scalable font ("*-muleindian-1") for which this isn't true, so we
6365 just test average width. */
6367 static int
6368 font_scalable_p (font)
6369 struct font_name *font;
6371 char *s = font->fields[XLFD_AVGWIDTH];
6372 return (*s == '0' && *(s + 1) == '\0')
6373 #ifdef WINDOWSNT
6374 /* Windows implementation of XLFD is slightly broken for backward
6375 compatibility with previous broken versions, so test for
6376 wildcards as well as 0. */
6377 || *s == '*'
6378 #endif
6383 /* Ignore the difference of font point size less than this value. */
6385 #define FONT_POINT_SIZE_QUANTUM 5
6387 /* Value is non-zero if FONT1 is a better match for font attributes
6388 VALUES than FONT2. VALUES is an array of face attribute values in
6389 font sort order. COMPARE_PT_P zero means don't compare point
6390 sizes. AVGWIDTH, if not zero, is a specified font average width
6391 to compare with. */
6393 static int
6394 better_font_p (values, font1, font2, compare_pt_p, avgwidth)
6395 int *values;
6396 struct font_name *font1, *font2;
6397 int compare_pt_p, avgwidth;
6399 int i;
6401 /* Any font is better than no font. */
6402 if (! font1)
6403 return 0;
6404 if (! font2)
6405 return 1;
6407 for (i = 0; i < DIM (font_sort_order); ++i)
6409 int xlfd_idx = font_sort_order[i];
6411 if (compare_pt_p || xlfd_idx != XLFD_POINT_SIZE)
6413 int delta1, delta2;
6415 if (xlfd_idx == XLFD_POINT_SIZE)
6417 delta1 = eabs (values[i] - (font1->numeric[xlfd_idx]
6418 / font1->rescale_ratio));
6419 delta2 = eabs (values[i] - (font2->numeric[xlfd_idx]
6420 / font2->rescale_ratio));
6421 if (eabs (delta1 - delta2) < FONT_POINT_SIZE_QUANTUM)
6422 continue;
6424 else
6426 delta1 = eabs (values[i] - font1->numeric[xlfd_idx]);
6427 delta2 = eabs (values[i] - font2->numeric[xlfd_idx]);
6430 if (delta1 > delta2)
6431 return 0;
6432 else if (delta1 < delta2)
6433 return 1;
6434 else
6436 /* The difference may be equal because, e.g., the face
6437 specifies `italic' but we have only `regular' and
6438 `oblique'. Prefer `oblique' in this case. */
6439 if ((xlfd_idx == XLFD_WEIGHT || xlfd_idx == XLFD_SLANT)
6440 && font1->numeric[xlfd_idx] > values[i]
6441 && font2->numeric[xlfd_idx] < values[i])
6442 return 1;
6447 if (avgwidth)
6449 int delta1 = eabs (avgwidth - font1->numeric[XLFD_AVGWIDTH]);
6450 int delta2 = eabs (avgwidth - font2->numeric[XLFD_AVGWIDTH]);
6451 if (delta1 > delta2)
6452 return 0;
6453 else if (delta1 < delta2)
6454 return 1;
6457 if (! compare_pt_p)
6459 /* We prefer a real scalable font; i.e. not what autoscaled. */
6460 int auto_scaled_1 = (font1->numeric[XLFD_POINT_SIZE] == 0
6461 && font1->numeric[XLFD_RESY] > 0);
6462 int auto_scaled_2 = (font2->numeric[XLFD_POINT_SIZE] == 0
6463 && font2->numeric[XLFD_RESY] > 0);
6465 if (auto_scaled_1 != auto_scaled_2)
6466 return auto_scaled_2;
6469 return font1->registry_priority < font2->registry_priority;
6473 /* Value is non-zero if FONT is an exact match for face attributes in
6474 SPECIFIED. SPECIFIED is an array of face attribute values in font
6475 sort order. AVGWIDTH, if non-zero, is an average width to compare
6476 with. */
6478 static int
6479 exact_face_match_p (specified, font, avgwidth)
6480 int *specified;
6481 struct font_name *font;
6482 int avgwidth;
6484 int i;
6486 for (i = 0; i < DIM (font_sort_order); ++i)
6487 if (specified[i] != font->numeric[font_sort_order[i]])
6488 break;
6490 return (i == DIM (font_sort_order)
6491 && (avgwidth <= 0
6492 || avgwidth == font->numeric[XLFD_AVGWIDTH]));
6496 /* Value is the name of a scaled font, generated from scalable font
6497 FONT on frame F. SPECIFIED_PT is the point-size to scale FONT to.
6498 Value is allocated from heap. */
6500 static char *
6501 build_scalable_font_name (f, font, specified_pt)
6502 struct frame *f;
6503 struct font_name *font;
6504 int specified_pt;
6506 char pixel_size[20];
6507 int pixel_value;
6508 double resy = FRAME_X_DISPLAY_INFO (f)->resy;
6509 double pt;
6511 /* If scalable font is for a specific resolution, compute
6512 the point size we must specify from the resolution of
6513 the display and the specified resolution of the font. */
6514 if (font->numeric[XLFD_RESY] != 0)
6516 pt = resy / font->numeric[XLFD_RESY] * specified_pt + 0.5;
6517 pixel_value = font->numeric[XLFD_RESY] / (PT_PER_INCH * 10.0) * pt + 0.5;
6519 else
6521 pt = specified_pt;
6522 pixel_value = resy / (PT_PER_INCH * 10.0) * pt + 0.5;
6524 /* We may need a font of the different size. */
6525 pixel_value *= font->rescale_ratio;
6527 /* We should keep POINT_SIZE 0. Otherwise, X server can't open a
6528 font of the specified PIXEL_SIZE. */
6529 #if 0
6530 { /* Set point size of the font. */
6531 char point_size[20];
6532 sprintf (point_size, "%d", (int) pt);
6533 font->fields[XLFD_POINT_SIZE] = point_size;
6534 font->numeric[XLFD_POINT_SIZE] = pt;
6536 #endif
6538 /* Set pixel size. */
6539 sprintf (pixel_size, "%d", pixel_value);
6540 font->fields[XLFD_PIXEL_SIZE] = pixel_size;
6541 font->numeric[XLFD_PIXEL_SIZE] = pixel_value;
6543 /* If font doesn't specify its resolution, use the
6544 resolution of the display. */
6545 if (font->numeric[XLFD_RESY] == 0)
6547 char buffer[20];
6548 sprintf (buffer, "%d", (int) resy);
6549 font->fields[XLFD_RESY] = buffer;
6550 font->numeric[XLFD_RESY] = resy;
6553 if (strcmp (font->fields[XLFD_RESX], "0") == 0)
6555 char buffer[20];
6556 int resx = FRAME_X_DISPLAY_INFO (f)->resx;
6557 sprintf (buffer, "%d", resx);
6558 font->fields[XLFD_RESX] = buffer;
6559 font->numeric[XLFD_RESX] = resx;
6562 return build_font_name (font);
6566 /* Value is non-zero if we are allowed to use scalable font FONT. We
6567 can't run a Lisp function here since this function may be called
6568 with input blocked. */
6570 static int
6571 may_use_scalable_font_p (font)
6572 const char *font;
6574 if (EQ (Vscalable_fonts_allowed, Qt))
6575 return 1;
6576 else if (CONSP (Vscalable_fonts_allowed))
6578 Lisp_Object tail, regexp;
6580 for (tail = Vscalable_fonts_allowed; CONSP (tail); tail = XCDR (tail))
6582 regexp = XCAR (tail);
6583 if (STRINGP (regexp)
6584 && fast_c_string_match_ignore_case (regexp, font) >= 0)
6585 return 1;
6589 return 0;
6594 /* Return the name of the best matching font for face attributes ATTRS
6595 in the array of font_name structures FONTS which contains NFONTS
6596 elements. WIDTH_RATIO is a factor with which to multiply average
6597 widths if ATTRS specifies such a width.
6599 Value is a font name which is allocated from the heap. FONTS is
6600 freed by this function.
6602 If NEEDS_OVERSTRIKE is non-zero, a boolean is returned in it to
6603 indicate whether the resulting font should be drawn using overstrike
6604 to simulate bold-face. */
6606 static char *
6607 best_matching_font (f, attrs, fonts, nfonts, width_ratio, needs_overstrike)
6608 struct frame *f;
6609 Lisp_Object *attrs;
6610 struct font_name *fonts;
6611 int nfonts;
6612 int width_ratio;
6613 int *needs_overstrike;
6615 char *font_name;
6616 struct font_name *best;
6617 int i, pt = 0;
6618 int specified[5];
6619 int exact_p, avgwidth;
6621 if (nfonts == 0)
6622 return NULL;
6624 /* Make specified font attributes available in `specified',
6625 indexed by sort order. */
6626 for (i = 0; i < DIM (font_sort_order); ++i)
6628 int xlfd_idx = font_sort_order[i];
6630 if (xlfd_idx == XLFD_SWIDTH)
6631 specified[i] = face_numeric_swidth (attrs[LFACE_SWIDTH_INDEX]);
6632 else if (xlfd_idx == XLFD_POINT_SIZE)
6633 specified[i] = pt = XFASTINT (attrs[LFACE_HEIGHT_INDEX]);
6634 else if (xlfd_idx == XLFD_WEIGHT)
6635 specified[i] = face_numeric_weight (attrs[LFACE_WEIGHT_INDEX]);
6636 else if (xlfd_idx == XLFD_SLANT)
6637 specified[i] = face_numeric_slant (attrs[LFACE_SLANT_INDEX]);
6638 else
6639 abort ();
6642 avgwidth = (UNSPECIFIEDP (attrs[LFACE_AVGWIDTH_INDEX])
6644 : XFASTINT (attrs[LFACE_AVGWIDTH_INDEX]) * width_ratio);
6646 exact_p = 0;
6648 if (needs_overstrike)
6649 *needs_overstrike = 0;
6651 best = NULL;
6653 /* Find the best match among the non-scalable fonts. */
6654 for (i = 0; i < nfonts; ++i)
6655 if (!font_scalable_p (fonts + i)
6656 && better_font_p (specified, fonts + i, best, 1, avgwidth))
6658 best = fonts + i;
6660 exact_p = exact_face_match_p (specified, best, avgwidth);
6661 if (exact_p)
6662 break;
6665 /* Unless we found an exact match among non-scalable fonts, see if
6666 we can find a better match among scalable fonts. */
6667 if (!exact_p)
6669 /* A scalable font is better if
6671 1. its weight, slant, swidth attributes are better, or.
6673 2. the best non-scalable font doesn't have the required
6674 point size, and the scalable fonts weight, slant, swidth
6675 isn't worse. */
6677 int non_scalable_has_exact_height_p;
6679 if (best && best->numeric[XLFD_POINT_SIZE] == pt)
6680 non_scalable_has_exact_height_p = 1;
6681 else
6682 non_scalable_has_exact_height_p = 0;
6684 for (i = 0; i < nfonts; ++i)
6685 if (font_scalable_p (fonts + i))
6687 if (better_font_p (specified, fonts + i, best, 0, 0)
6688 || (!non_scalable_has_exact_height_p
6689 && !better_font_p (specified, best, fonts + i, 0, 0)))
6691 non_scalable_has_exact_height_p = 1;
6692 best = fonts + i;
6697 /* We should have found SOME font. */
6698 if (best == NULL)
6699 abort ();
6701 if (! exact_p && needs_overstrike)
6703 enum xlfd_weight want_weight = specified[XLFD_WEIGHT];
6704 enum xlfd_weight got_weight = best->numeric[XLFD_WEIGHT];
6706 if (want_weight > XLFD_WEIGHT_MEDIUM && want_weight > got_weight)
6708 /* We want a bold font, but didn't get one; try to use
6709 overstriking instead to simulate bold-face. However,
6710 don't overstrike an already-bold font unless the
6711 desired weight grossly exceeds the available weight. */
6712 if (got_weight > XLFD_WEIGHT_MEDIUM)
6713 *needs_overstrike = (want_weight - got_weight) > 2;
6714 else
6715 *needs_overstrike = 1;
6719 if (font_scalable_p (best))
6720 font_name = build_scalable_font_name (f, best, pt);
6721 else
6722 font_name = build_font_name (best);
6724 /* Free font_name structures. */
6725 free_font_names (fonts, nfonts);
6727 return font_name;
6731 /* Get a list of matching fonts on frame F, considering FAMILY
6732 and alternative font families from Vface_alternative_font_registry_alist.
6734 FAMILY is the font family whose alternatives are considered.
6736 REGISTRY, if a string, specifies a font registry and encoding to
6737 match. A value of nil means include fonts of any registry and
6738 encoding.
6740 Return in *FONTS a pointer to a vector of font_name structures for
6741 the fonts matched. Value is the number of fonts found. */
6743 static int
6744 try_alternative_families (f, family, registry, fonts)
6745 struct frame *f;
6746 Lisp_Object family, registry;
6747 struct font_name **fonts;
6749 Lisp_Object alter;
6750 int nfonts = 0;
6752 nfonts = font_list (f, Qnil, family, registry, fonts);
6753 if (nfonts == 0)
6755 /* Try alternative font families. */
6756 alter = Fassoc (family, Vface_alternative_font_family_alist);
6757 if (CONSP (alter))
6759 for (alter = XCDR (alter);
6760 CONSP (alter) && nfonts == 0;
6761 alter = XCDR (alter))
6763 if (STRINGP (XCAR (alter)))
6764 nfonts = font_list (f, Qnil, XCAR (alter), registry, fonts);
6768 /* Try all scalable fonts before giving up. */
6769 if (nfonts == 0 && ! EQ (Vscalable_fonts_allowed, Qt))
6771 int count = SPECPDL_INDEX ();
6772 specbind (Qscalable_fonts_allowed, Qt);
6773 nfonts = try_alternative_families (f, family, registry, fonts);
6774 unbind_to (count, Qnil);
6777 return nfonts;
6781 /* Get a list of matching fonts on frame F.
6783 FAMILY, if a string, specifies a font family derived from the fontset.
6784 It is only used if the face does not specify any family in ATTRS or
6785 if we cannot find any font of the face's family.
6787 REGISTRY, if a string, specifies a font registry and encoding to
6788 match. A value of nil means include fonts of any registry and
6789 encoding.
6791 If PREFER_FACE_FAMILY is nonzero, perfer face's family to FAMILY.
6792 Otherwise, prefer FAMILY.
6794 Return in *FONTS a pointer to a vector of font_name structures for
6795 the fonts matched. Value is the number of fonts found. */
6797 static int
6798 try_font_list (f, attrs, family, registry, fonts, prefer_face_family)
6799 struct frame *f;
6800 Lisp_Object *attrs;
6801 Lisp_Object family, registry;
6802 struct font_name **fonts;
6803 int prefer_face_family;
6805 int nfonts = 0;
6806 Lisp_Object face_family = attrs[LFACE_FAMILY_INDEX];
6807 Lisp_Object try_family;
6809 try_family = (prefer_face_family || NILP (family)) ? face_family : family;
6811 if (STRINGP (try_family))
6812 nfonts = try_alternative_families (f, try_family, registry, fonts);
6814 #ifdef MAC_OS
6815 if (nfonts == 0 && STRINGP (try_family) && STRINGP (registry))
6817 if (xstricmp (SDATA (registry), "mac-roman") == 0)
6818 /* When realizing the default face and a font spec does not
6819 matched exactly, Emacs looks for ones with the same registry
6820 as the default font. On the Mac, this is mac-roman, which
6821 does not work if the family is -etl-fixed, e.g. The
6822 following widens the choices and fixes that problem. */
6823 nfonts = try_alternative_families (f, try_family, Qnil, fonts);
6824 else if (SBYTES (try_family) > 0
6825 && SREF (try_family, SBYTES (try_family) - 1) != '*')
6826 /* Some Central European/Cyrillic font family names have the
6827 Roman counterpart name as their prefix. */
6828 nfonts = try_alternative_families (f, concat2 (try_family,
6829 build_string ("*")),
6830 registry, fonts);
6832 #endif
6834 if (EQ (try_family, family))
6835 family = face_family;
6837 if (nfonts == 0 && STRINGP (family))
6838 nfonts = try_alternative_families (f, family, registry, fonts);
6840 /* Try font family of the default face or "fixed". */
6841 if (nfonts == 0)
6843 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
6844 if (default_face)
6845 family = default_face->lface[LFACE_FAMILY_INDEX];
6846 else
6847 family = build_string ("fixed");
6848 nfonts = font_list (f, Qnil, family, registry, fonts);
6851 /* Try any family with the given registry. */
6852 if (nfonts == 0)
6853 nfonts = try_alternative_families (f, Qnil, registry, fonts);
6855 return nfonts;
6859 /* Return the fontset id of the base fontset name or alias name given
6860 by the fontset attribute of ATTRS. Value is -1 if the fontset
6861 attribute of ATTRS doesn't name a fontset. */
6863 static int
6864 face_fontset (attrs)
6865 Lisp_Object *attrs;
6867 Lisp_Object name;
6869 name = attrs[LFACE_FONT_INDEX];
6870 if (!STRINGP (name))
6871 return -1;
6872 return fs_query_fontset (name, 0);
6876 /* Choose a name of font to use on frame F to display character C with
6877 Lisp face attributes specified by ATTRS. The font name is
6878 determined by the font-related attributes in ATTRS and the name
6879 pattern for C in FONTSET. Value is the font name which is
6880 allocated from the heap and must be freed by the caller, or NULL if
6881 we can get no information about the font name of C. It is assured
6882 that we always get some information for a single byte
6883 character.
6885 If NEEDS_OVERSTRIKE is non-zero, a boolean is returned in it to
6886 indicate whether the resulting font should be drawn using overstrike
6887 to simulate bold-face. */
6889 static char *
6890 choose_face_font (f, attrs, fontset, c, needs_overstrike)
6891 struct frame *f;
6892 Lisp_Object *attrs;
6893 int fontset, c;
6894 int *needs_overstrike;
6896 Lisp_Object pattern;
6897 char *font_name = NULL;
6898 struct font_name *fonts;
6899 int nfonts, width_ratio;
6901 if (needs_overstrike)
6902 *needs_overstrike = 0;
6904 /* Get (foundry and) family name and registry (and encoding) name of
6905 a font for C. */
6906 pattern = fontset_font_pattern (f, fontset, c);
6907 if (NILP (pattern))
6909 xassert (!SINGLE_BYTE_CHAR_P (c));
6910 return NULL;
6913 /* If what we got is a name pattern, return it. */
6914 if (STRINGP (pattern))
6915 return xstrdup (SDATA (pattern));
6917 /* Get a list of fonts matching that pattern and choose the
6918 best match for the specified face attributes from it. */
6919 nfonts = try_font_list (f, attrs, XCAR (pattern), XCDR (pattern), &fonts,
6920 (SINGLE_BYTE_CHAR_P (c)
6921 || CHAR_CHARSET (c) == charset_latin_iso8859_1));
6922 width_ratio = (SINGLE_BYTE_CHAR_P (c)
6924 : CHARSET_WIDTH (CHAR_CHARSET (c)));
6925 font_name = best_matching_font (f, attrs, fonts, nfonts, width_ratio,
6926 needs_overstrike);
6927 return font_name;
6930 #endif /* HAVE_WINDOW_SYSTEM */
6934 /***********************************************************************
6935 Face Realization
6936 ***********************************************************************/
6938 /* Realize basic faces on frame F. Value is zero if frame parameters
6939 of F don't contain enough information needed to realize the default
6940 face. */
6942 static int
6943 realize_basic_faces (f)
6944 struct frame *f;
6946 int success_p = 0;
6947 int count = SPECPDL_INDEX ();
6949 /* Block input here so that we won't be surprised by an X expose
6950 event, for instance, without having the faces set up. */
6951 BLOCK_INPUT;
6952 specbind (Qscalable_fonts_allowed, Qt);
6954 if (realize_default_face (f))
6956 realize_named_face (f, Qmode_line, MODE_LINE_FACE_ID);
6957 realize_named_face (f, Qmode_line_inactive, MODE_LINE_INACTIVE_FACE_ID);
6958 realize_named_face (f, Qtool_bar, TOOL_BAR_FACE_ID);
6959 realize_named_face (f, Qfringe, FRINGE_FACE_ID);
6960 realize_named_face (f, Qheader_line, HEADER_LINE_FACE_ID);
6961 realize_named_face (f, Qscroll_bar, SCROLL_BAR_FACE_ID);
6962 realize_named_face (f, Qborder, BORDER_FACE_ID);
6963 realize_named_face (f, Qcursor, CURSOR_FACE_ID);
6964 realize_named_face (f, Qmouse, MOUSE_FACE_ID);
6965 realize_named_face (f, Qmenu, MENU_FACE_ID);
6966 realize_named_face (f, Qvertical_border, VERTICAL_BORDER_FACE_ID);
6968 /* Reflect changes in the `menu' face in menu bars. */
6969 if (FRAME_FACE_CACHE (f)->menu_face_changed_p)
6971 FRAME_FACE_CACHE (f)->menu_face_changed_p = 0;
6972 #ifdef USE_X_TOOLKIT
6973 if (FRAME_WINDOW_P (f))
6974 x_update_menu_appearance (f);
6975 #endif
6978 success_p = 1;
6981 unbind_to (count, Qnil);
6982 UNBLOCK_INPUT;
6983 return success_p;
6987 /* Realize the default face on frame F. If the face is not fully
6988 specified, make it fully-specified. Attributes of the default face
6989 that are not explicitly specified are taken from frame parameters. */
6991 static int
6992 realize_default_face (f)
6993 struct frame *f;
6995 struct face_cache *c = FRAME_FACE_CACHE (f);
6996 Lisp_Object lface;
6997 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6998 Lisp_Object frame_font;
6999 struct face *face;
7001 /* If the `default' face is not yet known, create it. */
7002 lface = lface_from_face_name (f, Qdefault, 0);
7003 if (NILP (lface))
7005 Lisp_Object frame;
7006 XSETFRAME (frame, f);
7007 lface = Finternal_make_lisp_face (Qdefault, frame);
7011 #ifdef HAVE_WINDOW_SYSTEM
7012 if (FRAME_WINDOW_P (f))
7014 /* Set frame_font to the value of the `font' frame parameter. */
7015 frame_font = Fassq (Qfont, f->param_alist);
7016 xassert (CONSP (frame_font) && STRINGP (XCDR (frame_font)));
7017 frame_font = XCDR (frame_font);
7018 set_lface_from_font_name (f, lface, frame_font,
7019 f->default_face_done_p, 1);
7020 f->default_face_done_p = 1;
7022 #endif /* HAVE_WINDOW_SYSTEM */
7024 if (!FRAME_WINDOW_P (f))
7026 LFACE_FAMILY (lface) = build_string ("default");
7027 LFACE_SWIDTH (lface) = Qnormal;
7028 LFACE_HEIGHT (lface) = make_number (1);
7029 if (UNSPECIFIEDP (LFACE_WEIGHT (lface)))
7030 LFACE_WEIGHT (lface) = Qnormal;
7031 if (UNSPECIFIEDP (LFACE_SLANT (lface)))
7032 LFACE_SLANT (lface) = Qnormal;
7033 LFACE_AVGWIDTH (lface) = Qunspecified;
7036 if (UNSPECIFIEDP (LFACE_UNDERLINE (lface)))
7037 LFACE_UNDERLINE (lface) = Qnil;
7039 if (UNSPECIFIEDP (LFACE_OVERLINE (lface)))
7040 LFACE_OVERLINE (lface) = Qnil;
7042 if (UNSPECIFIEDP (LFACE_STRIKE_THROUGH (lface)))
7043 LFACE_STRIKE_THROUGH (lface) = Qnil;
7045 if (UNSPECIFIEDP (LFACE_BOX (lface)))
7046 LFACE_BOX (lface) = Qnil;
7048 if (UNSPECIFIEDP (LFACE_INVERSE (lface)))
7049 LFACE_INVERSE (lface) = Qnil;
7051 if (UNSPECIFIEDP (LFACE_FOREGROUND (lface)))
7053 /* This function is called so early that colors are not yet
7054 set in the frame parameter list. */
7055 Lisp_Object color = Fassq (Qforeground_color, f->param_alist);
7057 if (CONSP (color) && STRINGP (XCDR (color)))
7058 LFACE_FOREGROUND (lface) = XCDR (color);
7059 else if (FRAME_WINDOW_P (f))
7060 return 0;
7061 else if (FRAME_INITIAL_P (f) || FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
7062 LFACE_FOREGROUND (lface) = build_string (unspecified_fg);
7063 else
7064 abort ();
7067 if (UNSPECIFIEDP (LFACE_BACKGROUND (lface)))
7069 /* This function is called so early that colors are not yet
7070 set in the frame parameter list. */
7071 Lisp_Object color = Fassq (Qbackground_color, f->param_alist);
7072 if (CONSP (color) && STRINGP (XCDR (color)))
7073 LFACE_BACKGROUND (lface) = XCDR (color);
7074 else if (FRAME_WINDOW_P (f))
7075 return 0;
7076 else if (FRAME_INITIAL_P (f) || FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
7077 LFACE_BACKGROUND (lface) = build_string (unspecified_bg);
7078 else
7079 abort ();
7082 if (UNSPECIFIEDP (LFACE_STIPPLE (lface)))
7083 LFACE_STIPPLE (lface) = Qnil;
7085 /* Realize the face; it must be fully-specified now. */
7086 xassert (lface_fully_specified_p (XVECTOR (lface)->contents));
7087 check_lface (lface);
7088 bcopy (XVECTOR (lface)->contents, attrs, sizeof attrs);
7089 face = realize_face (c, attrs, 0, NULL, DEFAULT_FACE_ID);
7091 #ifdef HAVE_WINDOW_SYSTEM
7092 #ifdef HAVE_X_WINDOWS
7093 if (FRAME_X_P (f) && face->font != FRAME_FONT (f))
7095 /* This can happen when making a frame on a display that does
7096 not support the default font. */
7097 if (!face->font)
7098 return 0;
7100 /* Otherwise, the font specified for the frame was not
7101 acceptable as a font for the default face (perhaps because
7102 auto-scaled fonts are rejected), so we must adjust the frame
7103 font. */
7104 x_set_font (f, build_string (face->font_name), Qnil);
7106 #endif /* HAVE_X_WINDOWS */
7107 #endif /* HAVE_WINDOW_SYSTEM */
7108 return 1;
7112 /* Realize basic faces other than the default face in face cache C.
7113 SYMBOL is the face name, ID is the face id the realized face must
7114 have. The default face must have been realized already. */
7116 static void
7117 realize_named_face (f, symbol, id)
7118 struct frame *f;
7119 Lisp_Object symbol;
7120 int id;
7122 struct face_cache *c = FRAME_FACE_CACHE (f);
7123 Lisp_Object lface = lface_from_face_name (f, symbol, 0);
7124 Lisp_Object attrs[LFACE_VECTOR_SIZE];
7125 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
7126 struct face *new_face;
7128 /* The default face must exist and be fully specified. */
7129 get_lface_attributes (f, Qdefault, attrs, 1);
7130 check_lface_attrs (attrs);
7131 xassert (lface_fully_specified_p (attrs));
7133 /* If SYMBOL isn't know as a face, create it. */
7134 if (NILP (lface))
7136 Lisp_Object frame;
7137 XSETFRAME (frame, f);
7138 lface = Finternal_make_lisp_face (symbol, frame);
7141 /* Merge SYMBOL's face with the default face. */
7142 get_lface_attributes (f, symbol, symbol_attrs, 1);
7143 merge_face_vectors (f, symbol_attrs, attrs, 0);
7145 /* Realize the face. */
7146 new_face = realize_face (c, attrs, 0, NULL, id);
7150 /* Realize the fully-specified face with attributes ATTRS in face
7151 cache CACHE for character C. If C is a multibyte character,
7152 BASE_FACE is a face that has the same attributes. Otherwise,
7153 BASE_FACE is ignored. If FORMER_FACE_ID is non-negative, it is an
7154 ID of face to remove before caching the new face. Value is a
7155 pointer to the newly created realized face. */
7157 static struct face *
7158 realize_face (cache, attrs, c, base_face, former_face_id)
7159 struct face_cache *cache;
7160 Lisp_Object *attrs;
7161 int c;
7162 struct face *base_face;
7163 int former_face_id;
7165 struct face *face;
7167 /* LFACE must be fully specified. */
7168 xassert (cache != NULL);
7169 check_lface_attrs (attrs);
7171 if (former_face_id >= 0 && cache->used > former_face_id)
7173 /* Remove the former face. */
7174 struct face *former_face = cache->faces_by_id[former_face_id];
7175 uncache_face (cache, former_face);
7176 free_realized_face (cache->f, former_face);
7179 if (FRAME_WINDOW_P (cache->f))
7180 face = realize_x_face (cache, attrs, c, base_face);
7181 else if (FRAME_TERMCAP_P (cache->f) || FRAME_MSDOS_P (cache->f))
7182 face = realize_tty_face (cache, attrs, c);
7183 else if (FRAME_INITIAL_P (cache->f))
7185 /* Create a dummy face. */
7186 face = make_realized_face (attrs);
7188 else
7189 abort ();
7191 /* Insert the new face. */
7192 cache_face (cache, face, lface_hash (attrs));
7193 #ifdef HAVE_WINDOW_SYSTEM
7194 if (FRAME_WINDOW_P (cache->f) && face->font == NULL)
7195 load_face_font (cache->f, face, c);
7196 #endif /* HAVE_WINDOW_SYSTEM */
7197 return face;
7201 /* Realize the fully-specified face with attributes ATTRS in face
7202 cache CACHE for character C. Do it for X frame CACHE->f. If C is
7203 a multibyte character, BASE_FACE is a face that has the same
7204 attributes. Otherwise, BASE_FACE is ignored. If the new face
7205 doesn't share font with the default face, a fontname is allocated
7206 from the heap and set in `font_name' of the new face, but it is not
7207 yet loaded here. Value is a pointer to the newly created realized
7208 face. */
7210 static struct face *
7211 realize_x_face (cache, attrs, c, base_face)
7212 struct face_cache *cache;
7213 Lisp_Object *attrs;
7214 int c;
7215 struct face *base_face;
7217 struct face *face = NULL;
7218 #ifdef HAVE_WINDOW_SYSTEM
7219 struct face *default_face;
7220 struct frame *f;
7221 Lisp_Object stipple, overline, strike_through, box;
7223 xassert (FRAME_WINDOW_P (cache->f));
7224 xassert (SINGLE_BYTE_CHAR_P (c)
7225 || base_face);
7227 /* Allocate a new realized face. */
7228 face = make_realized_face (attrs);
7230 f = cache->f;
7232 /* If C is a multibyte character, we share all face attirbutes with
7233 BASE_FACE including the realized fontset. But, we must load a
7234 different font. */
7235 if (!SINGLE_BYTE_CHAR_P (c))
7237 bcopy (base_face, face, sizeof *face);
7238 face->gc = 0;
7240 /* Don't try to free the colors copied bitwise from BASE_FACE. */
7241 face->colors_copied_bitwise_p = 1;
7243 /* to force realize_face to load font */
7244 face->font = NULL;
7245 return face;
7248 /* Now we are realizing a face for ASCII (and unibyte) characters. */
7250 /* Determine the font to use. Most of the time, the font will be
7251 the same as the font of the default face, so try that first. */
7252 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
7253 if (default_face
7254 && FACE_SUITABLE_FOR_CHAR_P (default_face, c)
7255 && lface_same_font_attributes_p (default_face->lface, attrs))
7257 face->font = default_face->font;
7258 face->fontset = default_face->fontset;
7259 face->font_info_id = default_face->font_info_id;
7260 face->font_name = default_face->font_name;
7261 face->ascii_face = face;
7263 /* But, as we can't share the fontset, make a new realized
7264 fontset that has the same base fontset as of the default
7265 face. */
7266 face->fontset
7267 = make_fontset_for_ascii_face (f, default_face->fontset);
7269 else
7271 /* If the face attribute ATTRS specifies a fontset, use it as
7272 the base of a new realized fontset. Otherwise, use the same
7273 base fontset as of the default face. The base determines
7274 registry and encoding of a font. It may also determine
7275 foundry and family. The other fields of font name pattern
7276 are constructed from ATTRS. */
7277 int fontset = face_fontset (attrs);
7279 if ((fontset == -1) && default_face)
7280 fontset = default_face->fontset;
7281 face->fontset = make_fontset_for_ascii_face (f, fontset);
7282 face->font = NULL; /* to force realize_face to load font */
7285 /* Load colors, and set remaining attributes. */
7287 load_face_colors (f, face, attrs);
7289 /* Set up box. */
7290 box = attrs[LFACE_BOX_INDEX];
7291 if (STRINGP (box))
7293 /* A simple box of line width 1 drawn in color given by
7294 the string. */
7295 face->box_color = load_color (f, face, attrs[LFACE_BOX_INDEX],
7296 LFACE_BOX_INDEX);
7297 face->box = FACE_SIMPLE_BOX;
7298 face->box_line_width = 1;
7300 else if (INTEGERP (box))
7302 /* Simple box of specified line width in foreground color of the
7303 face. */
7304 xassert (XINT (box) != 0);
7305 face->box = FACE_SIMPLE_BOX;
7306 face->box_line_width = XINT (box);
7307 face->box_color = face->foreground;
7308 face->box_color_defaulted_p = 1;
7310 else if (CONSP (box))
7312 /* `(:width WIDTH :color COLOR :shadow SHADOW)'. SHADOW
7313 being one of `raised' or `sunken'. */
7314 face->box = FACE_SIMPLE_BOX;
7315 face->box_color = face->foreground;
7316 face->box_color_defaulted_p = 1;
7317 face->box_line_width = 1;
7319 while (CONSP (box))
7321 Lisp_Object keyword, value;
7323 keyword = XCAR (box);
7324 box = XCDR (box);
7326 if (!CONSP (box))
7327 break;
7328 value = XCAR (box);
7329 box = XCDR (box);
7331 if (EQ (keyword, QCline_width))
7333 if (INTEGERP (value) && XINT (value) != 0)
7334 face->box_line_width = XINT (value);
7336 else if (EQ (keyword, QCcolor))
7338 if (STRINGP (value))
7340 face->box_color = load_color (f, face, value,
7341 LFACE_BOX_INDEX);
7342 face->use_box_color_for_shadows_p = 1;
7345 else if (EQ (keyword, QCstyle))
7347 if (EQ (value, Qreleased_button))
7348 face->box = FACE_RAISED_BOX;
7349 else if (EQ (value, Qpressed_button))
7350 face->box = FACE_SUNKEN_BOX;
7355 /* Text underline, overline, strike-through. */
7357 if (EQ (attrs[LFACE_UNDERLINE_INDEX], Qt))
7359 /* Use default color (same as foreground color). */
7360 face->underline_p = 1;
7361 face->underline_defaulted_p = 1;
7362 face->underline_color = 0;
7364 else if (STRINGP (attrs[LFACE_UNDERLINE_INDEX]))
7366 /* Use specified color. */
7367 face->underline_p = 1;
7368 face->underline_defaulted_p = 0;
7369 face->underline_color
7370 = load_color (f, face, attrs[LFACE_UNDERLINE_INDEX],
7371 LFACE_UNDERLINE_INDEX);
7373 else if (NILP (attrs[LFACE_UNDERLINE_INDEX]))
7375 face->underline_p = 0;
7376 face->underline_defaulted_p = 0;
7377 face->underline_color = 0;
7380 overline = attrs[LFACE_OVERLINE_INDEX];
7381 if (STRINGP (overline))
7383 face->overline_color
7384 = load_color (f, face, attrs[LFACE_OVERLINE_INDEX],
7385 LFACE_OVERLINE_INDEX);
7386 face->overline_p = 1;
7388 else if (EQ (overline, Qt))
7390 face->overline_color = face->foreground;
7391 face->overline_color_defaulted_p = 1;
7392 face->overline_p = 1;
7395 strike_through = attrs[LFACE_STRIKE_THROUGH_INDEX];
7396 if (STRINGP (strike_through))
7398 face->strike_through_color
7399 = load_color (f, face, attrs[LFACE_STRIKE_THROUGH_INDEX],
7400 LFACE_STRIKE_THROUGH_INDEX);
7401 face->strike_through_p = 1;
7403 else if (EQ (strike_through, Qt))
7405 face->strike_through_color = face->foreground;
7406 face->strike_through_color_defaulted_p = 1;
7407 face->strike_through_p = 1;
7410 stipple = attrs[LFACE_STIPPLE_INDEX];
7411 if (!NILP (stipple))
7412 face->stipple = load_pixmap (f, stipple, &face->pixmap_w, &face->pixmap_h);
7414 xassert (FACE_SUITABLE_FOR_CHAR_P (face, c));
7415 #endif /* HAVE_WINDOW_SYSTEM */
7416 return face;
7420 /* Map a specified color of face FACE on frame F to a tty color index.
7421 IDX is either LFACE_FOREGROUND_INDEX or LFACE_BACKGROUND_INDEX, and
7422 specifies which color to map. Set *DEFAULTED to 1 if mapping to the
7423 default foreground/background colors. */
7425 static void
7426 map_tty_color (f, face, idx, defaulted)
7427 struct frame *f;
7428 struct face *face;
7429 enum lface_attribute_index idx;
7430 int *defaulted;
7432 Lisp_Object frame, color, def;
7433 int foreground_p = idx == LFACE_FOREGROUND_INDEX;
7434 unsigned long default_pixel, default_other_pixel, pixel;
7436 xassert (idx == LFACE_FOREGROUND_INDEX || idx == LFACE_BACKGROUND_INDEX);
7438 if (foreground_p)
7440 pixel = default_pixel = FACE_TTY_DEFAULT_FG_COLOR;
7441 default_other_pixel = FACE_TTY_DEFAULT_BG_COLOR;
7443 else
7445 pixel = default_pixel = FACE_TTY_DEFAULT_BG_COLOR;
7446 default_other_pixel = FACE_TTY_DEFAULT_FG_COLOR;
7449 XSETFRAME (frame, f);
7450 color = face->lface[idx];
7452 if (STRINGP (color)
7453 && SCHARS (color)
7454 && CONSP (Vtty_defined_color_alist)
7455 && (def = assq_no_quit (color, call1 (Qtty_color_alist, frame)),
7456 CONSP (def)))
7458 /* Associations in tty-defined-color-alist are of the form
7459 (NAME INDEX R G B). We need the INDEX part. */
7460 pixel = XINT (XCAR (XCDR (def)));
7463 if (pixel == default_pixel && STRINGP (color))
7465 pixel = load_color (f, face, color, idx);
7467 #if defined (MSDOS) || defined (WINDOWSNT)
7468 /* If the foreground of the default face is the default color,
7469 use the foreground color defined by the frame. */
7470 #ifdef MSDOS
7471 if (FRAME_MSDOS_P (f))
7473 #endif /* MSDOS */
7474 if (pixel == default_pixel
7475 || pixel == FACE_TTY_DEFAULT_COLOR)
7477 if (foreground_p)
7478 pixel = FRAME_FOREGROUND_PIXEL (f);
7479 else
7480 pixel = FRAME_BACKGROUND_PIXEL (f);
7481 face->lface[idx] = tty_color_name (f, pixel);
7482 *defaulted = 1;
7484 else if (pixel == default_other_pixel)
7486 if (foreground_p)
7487 pixel = FRAME_BACKGROUND_PIXEL (f);
7488 else
7489 pixel = FRAME_FOREGROUND_PIXEL (f);
7490 face->lface[idx] = tty_color_name (f, pixel);
7491 *defaulted = 1;
7493 #ifdef MSDOS
7495 #endif
7496 #endif /* MSDOS or WINDOWSNT */
7499 if (foreground_p)
7500 face->foreground = pixel;
7501 else
7502 face->background = pixel;
7506 /* Realize the fully-specified face with attributes ATTRS in face
7507 cache CACHE for character C. Do it for TTY frame CACHE->f. Value is a
7508 pointer to the newly created realized face. */
7510 static struct face *
7511 realize_tty_face (cache, attrs, c)
7512 struct face_cache *cache;
7513 Lisp_Object *attrs;
7514 int c;
7516 struct face *face;
7517 int weight, slant;
7518 int face_colors_defaulted = 0;
7519 struct frame *f = cache->f;
7521 /* Frame must be a termcap frame. */
7522 xassert (FRAME_TERMCAP_P (cache->f) || FRAME_MSDOS_P (cache->f));
7524 /* Allocate a new realized face. */
7525 face = make_realized_face (attrs);
7526 face->font_name = FRAME_MSDOS_P (cache->f) ? "ms-dos" : "tty";
7528 /* Map face attributes to TTY appearances. We map slant to
7529 dimmed text because we want italic text to appear differently
7530 and because dimmed text is probably used infrequently. */
7531 weight = face_numeric_weight (attrs[LFACE_WEIGHT_INDEX]);
7532 slant = face_numeric_slant (attrs[LFACE_SLANT_INDEX]);
7534 if (weight > XLFD_WEIGHT_MEDIUM)
7535 face->tty_bold_p = 1;
7536 if (weight < XLFD_WEIGHT_MEDIUM || slant != XLFD_SLANT_ROMAN)
7537 face->tty_dim_p = 1;
7538 if (!NILP (attrs[LFACE_UNDERLINE_INDEX]))
7539 face->tty_underline_p = 1;
7540 if (!NILP (attrs[LFACE_INVERSE_INDEX]))
7541 face->tty_reverse_p = 1;
7543 /* Map color names to color indices. */
7544 map_tty_color (f, face, LFACE_FOREGROUND_INDEX, &face_colors_defaulted);
7545 map_tty_color (f, face, LFACE_BACKGROUND_INDEX, &face_colors_defaulted);
7547 /* Swap colors if face is inverse-video. If the colors are taken
7548 from the frame colors, they are already inverted, since the
7549 frame-creation function calls x-handle-reverse-video. */
7550 if (face->tty_reverse_p && !face_colors_defaulted)
7552 unsigned long tem = face->foreground;
7553 face->foreground = face->background;
7554 face->background = tem;
7557 if (tty_suppress_bold_inverse_default_colors_p
7558 && face->tty_bold_p
7559 && face->background == FACE_TTY_DEFAULT_FG_COLOR
7560 && face->foreground == FACE_TTY_DEFAULT_BG_COLOR)
7561 face->tty_bold_p = 0;
7563 return face;
7567 DEFUN ("tty-suppress-bold-inverse-default-colors",
7568 Ftty_suppress_bold_inverse_default_colors,
7569 Stty_suppress_bold_inverse_default_colors, 1, 1, 0,
7570 doc: /* Suppress/allow boldness of faces with inverse default colors.
7571 SUPPRESS non-nil means suppress it.
7572 This affects bold faces on TTYs whose foreground is the default background
7573 color of the display and whose background is the default foreground color.
7574 For such faces, the bold face attribute is ignored if this variable
7575 is non-nil. */)
7576 (suppress)
7577 Lisp_Object suppress;
7579 tty_suppress_bold_inverse_default_colors_p = !NILP (suppress);
7580 ++face_change_count;
7581 return suppress;
7586 /***********************************************************************
7587 Computing Faces
7588 ***********************************************************************/
7590 /* Return the ID of the face to use to display character CH with face
7591 property PROP on frame F in current_buffer. */
7594 compute_char_face (f, ch, prop)
7595 struct frame *f;
7596 int ch;
7597 Lisp_Object prop;
7599 int face_id;
7601 if (NILP (current_buffer->enable_multibyte_characters))
7602 ch = 0;
7604 if (NILP (prop))
7606 struct face *face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
7607 face_id = FACE_FOR_CHAR (f, face, ch);
7609 else
7611 Lisp_Object attrs[LFACE_VECTOR_SIZE];
7612 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
7613 bcopy (default_face->lface, attrs, sizeof attrs);
7614 merge_face_ref (f, prop, attrs, 1, 0);
7615 face_id = lookup_face (f, attrs, ch, NULL);
7618 return face_id;
7621 /* Return the face ID associated with buffer position POS for
7622 displaying ASCII characters. Return in *ENDPTR the position at
7623 which a different face is needed, as far as text properties and
7624 overlays are concerned. W is a window displaying current_buffer.
7626 REGION_BEG, REGION_END delimit the region, so it can be
7627 highlighted.
7629 LIMIT is a position not to scan beyond. That is to limit the time
7630 this function can take.
7632 If MOUSE is non-zero, use the character's mouse-face, not its face.
7634 The face returned is suitable for displaying ASCII characters. */
7637 face_at_buffer_position (w, pos, region_beg, region_end,
7638 endptr, limit, mouse)
7639 struct window *w;
7640 int pos;
7641 int region_beg, region_end;
7642 int *endptr;
7643 int limit;
7644 int mouse;
7646 struct frame *f = XFRAME (w->frame);
7647 Lisp_Object attrs[LFACE_VECTOR_SIZE];
7648 Lisp_Object prop, position;
7649 int i, noverlays;
7650 Lisp_Object *overlay_vec;
7651 Lisp_Object frame;
7652 int endpos;
7653 Lisp_Object propname = mouse ? Qmouse_face : Qface;
7654 Lisp_Object limit1, end;
7655 struct face *default_face;
7657 /* W must display the current buffer. We could write this function
7658 to use the frame and buffer of W, but right now it doesn't. */
7659 /* xassert (XBUFFER (w->buffer) == current_buffer); */
7661 XSETFRAME (frame, f);
7662 XSETFASTINT (position, pos);
7664 endpos = ZV;
7665 if (pos < region_beg && region_beg < endpos)
7666 endpos = region_beg;
7668 /* Get the `face' or `mouse_face' text property at POS, and
7669 determine the next position at which the property changes. */
7670 prop = Fget_text_property (position, propname, w->buffer);
7671 XSETFASTINT (limit1, (limit < endpos ? limit : endpos));
7672 end = Fnext_single_property_change (position, propname, w->buffer, limit1);
7673 if (INTEGERP (end))
7674 endpos = XINT (end);
7676 /* Look at properties from overlays. */
7678 int next_overlay;
7680 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, &next_overlay, 0);
7681 if (next_overlay < endpos)
7682 endpos = next_overlay;
7685 *endptr = endpos;
7687 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
7689 /* Optimize common cases where we can use the default face. */
7690 if (noverlays == 0
7691 && NILP (prop)
7692 && !(pos >= region_beg && pos < region_end))
7693 return DEFAULT_FACE_ID;
7695 /* Begin with attributes from the default face. */
7696 bcopy (default_face->lface, attrs, sizeof attrs);
7698 /* Merge in attributes specified via text properties. */
7699 if (!NILP (prop))
7700 merge_face_ref (f, prop, attrs, 1, 0);
7702 /* Now merge the overlay data. */
7703 noverlays = sort_overlays (overlay_vec, noverlays, w);
7704 for (i = 0; i < noverlays; i++)
7706 Lisp_Object oend;
7707 int oendpos;
7709 prop = Foverlay_get (overlay_vec[i], propname);
7710 if (!NILP (prop))
7711 merge_face_ref (f, prop, attrs, 1, 0);
7713 oend = OVERLAY_END (overlay_vec[i]);
7714 oendpos = OVERLAY_POSITION (oend);
7715 if (oendpos < endpos)
7716 endpos = oendpos;
7719 /* If in the region, merge in the region face. */
7720 if (pos >= region_beg && pos < region_end)
7722 merge_named_face (f, Qregion, attrs, 0);
7724 if (region_end < endpos)
7725 endpos = region_end;
7728 *endptr = endpos;
7730 /* Look up a realized face with the given face attributes,
7731 or realize a new one for ASCII characters. */
7732 return lookup_face (f, attrs, 0, NULL);
7735 /* Return the face ID at buffer position POS for displaying ASCII
7736 characters associated with overlay strings for overlay OVERLAY.
7738 Like face_at_buffer_position except for OVERLAY. Currently it
7739 simply disregards the `face' properties of all overlays. */
7742 face_for_overlay_string (w, pos, region_beg, region_end,
7743 endptr, limit, mouse, overlay)
7744 struct window *w;
7745 int pos;
7746 int region_beg, region_end;
7747 int *endptr;
7748 int limit;
7749 int mouse;
7750 Lisp_Object overlay;
7752 struct frame *f = XFRAME (w->frame);
7753 Lisp_Object attrs[LFACE_VECTOR_SIZE];
7754 Lisp_Object prop, position;
7755 int i, noverlays;
7756 Lisp_Object *overlay_vec;
7757 Lisp_Object frame;
7758 int endpos;
7759 Lisp_Object propname = mouse ? Qmouse_face : Qface;
7760 Lisp_Object limit1, end;
7761 struct face *default_face;
7763 /* W must display the current buffer. We could write this function
7764 to use the frame and buffer of W, but right now it doesn't. */
7765 /* xassert (XBUFFER (w->buffer) == current_buffer); */
7767 XSETFRAME (frame, f);
7768 XSETFASTINT (position, pos);
7770 endpos = ZV;
7771 if (pos < region_beg && region_beg < endpos)
7772 endpos = region_beg;
7774 /* Get the `face' or `mouse_face' text property at POS, and
7775 determine the next position at which the property changes. */
7776 prop = Fget_text_property (position, propname, w->buffer);
7777 XSETFASTINT (limit1, (limit < endpos ? limit : endpos));
7778 end = Fnext_single_property_change (position, propname, w->buffer, limit1);
7779 if (INTEGERP (end))
7780 endpos = XINT (end);
7782 *endptr = endpos;
7784 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
7786 /* Optimize common cases where we can use the default face. */
7787 if (NILP (prop)
7788 && !(pos >= region_beg && pos < region_end))
7789 return DEFAULT_FACE_ID;
7791 /* Begin with attributes from the default face. */
7792 bcopy (default_face->lface, attrs, sizeof attrs);
7794 /* Merge in attributes specified via text properties. */
7795 if (!NILP (prop))
7796 merge_face_ref (f, prop, attrs, 1, 0);
7798 /* If in the region, merge in the region face. */
7799 if (pos >= region_beg && pos < region_end)
7801 merge_named_face (f, Qregion, attrs, 0);
7803 if (region_end < endpos)
7804 endpos = region_end;
7807 *endptr = endpos;
7809 /* Look up a realized face with the given face attributes,
7810 or realize a new one for ASCII characters. */
7811 return lookup_face (f, attrs, 0, NULL);
7815 /* Compute the face at character position POS in Lisp string STRING on
7816 window W, for ASCII characters.
7818 If STRING is an overlay string, it comes from position BUFPOS in
7819 current_buffer, otherwise BUFPOS is zero to indicate that STRING is
7820 not an overlay string. W must display the current buffer.
7821 REGION_BEG and REGION_END give the start and end positions of the
7822 region; both are -1 if no region is visible.
7824 BASE_FACE_ID is the id of a face to merge with. For strings coming
7825 from overlays or the `display' property it is the face at BUFPOS.
7827 If MOUSE_P is non-zero, use the character's mouse-face, not its face.
7829 Set *ENDPTR to the next position where to check for faces in
7830 STRING; -1 if the face is constant from POS to the end of the
7831 string.
7833 Value is the id of the face to use. The face returned is suitable
7834 for displaying ASCII characters. */
7837 face_at_string_position (w, string, pos, bufpos, region_beg,
7838 region_end, endptr, base_face_id, mouse_p)
7839 struct window *w;
7840 Lisp_Object string;
7841 int pos, bufpos;
7842 int region_beg, region_end;
7843 int *endptr;
7844 enum face_id base_face_id;
7845 int mouse_p;
7847 Lisp_Object prop, position, end, limit;
7848 struct frame *f = XFRAME (WINDOW_FRAME (w));
7849 Lisp_Object attrs[LFACE_VECTOR_SIZE];
7850 struct face *base_face;
7851 int multibyte_p = STRING_MULTIBYTE (string);
7852 Lisp_Object prop_name = mouse_p ? Qmouse_face : Qface;
7854 /* Get the value of the face property at the current position within
7855 STRING. Value is nil if there is no face property. */
7856 XSETFASTINT (position, pos);
7857 prop = Fget_text_property (position, prop_name, string);
7859 /* Get the next position at which to check for faces. Value of end
7860 is nil if face is constant all the way to the end of the string.
7861 Otherwise it is a string position where to check faces next.
7862 Limit is the maximum position up to which to check for property
7863 changes in Fnext_single_property_change. Strings are usually
7864 short, so set the limit to the end of the string. */
7865 XSETFASTINT (limit, SCHARS (string));
7866 end = Fnext_single_property_change (position, prop_name, string, limit);
7867 if (INTEGERP (end))
7868 *endptr = XFASTINT (end);
7869 else
7870 *endptr = -1;
7872 base_face = FACE_FROM_ID (f, base_face_id);
7873 xassert (base_face);
7875 /* Optimize the default case that there is no face property and we
7876 are not in the region. */
7877 if (NILP (prop)
7878 && (base_face_id != DEFAULT_FACE_ID
7879 /* BUFPOS <= 0 means STRING is not an overlay string, so
7880 that the region doesn't have to be taken into account. */
7881 || bufpos <= 0
7882 || bufpos < region_beg
7883 || bufpos >= region_end)
7884 && (multibyte_p
7885 /* We can't realize faces for different charsets differently
7886 if we don't have fonts, so we can stop here if not working
7887 on a window-system frame. */
7888 || !FRAME_WINDOW_P (f)
7889 || FACE_SUITABLE_FOR_CHAR_P (base_face, 0)))
7890 return base_face->id;
7892 /* Begin with attributes from the base face. */
7893 bcopy (base_face->lface, attrs, sizeof attrs);
7895 /* Merge in attributes specified via text properties. */
7896 if (!NILP (prop))
7897 merge_face_ref (f, prop, attrs, 1, 0);
7899 /* If in the region, merge in the region face. */
7900 if (bufpos
7901 && bufpos >= region_beg
7902 && bufpos < region_end)
7903 merge_named_face (f, Qregion, attrs, 0);
7905 /* Look up a realized face with the given face attributes,
7906 or realize a new one for ASCII characters. */
7907 return lookup_face (f, attrs, 0, NULL);
7911 /* Merge a face into a realized face.
7913 F is frame where faces are (to be) realized.
7915 FACE_NAME is named face to merge.
7917 If FACE_NAME is nil, FACE_ID is face_id of realized face to merge.
7919 If FACE_NAME is t, FACE_ID is lface_id of face to merge.
7921 BASE_FACE_ID is realized face to merge into.
7923 Return new face id.
7927 merge_faces (f, face_name, face_id, base_face_id)
7928 struct frame *f;
7929 Lisp_Object face_name;
7930 int face_id, base_face_id;
7932 Lisp_Object attrs[LFACE_VECTOR_SIZE];
7933 struct face *base_face;
7935 base_face = FACE_FROM_ID (f, base_face_id);
7936 if (!base_face)
7937 return base_face_id;
7939 if (EQ (face_name, Qt))
7941 if (face_id < 0 || face_id >= lface_id_to_name_size)
7942 return base_face_id;
7943 face_name = lface_id_to_name[face_id];
7944 face_id = lookup_derived_face (f, face_name, 0, base_face_id, 1);
7945 if (face_id >= 0)
7946 return face_id;
7947 return base_face_id;
7950 /* Begin with attributes from the base face. */
7951 bcopy (base_face->lface, attrs, sizeof attrs);
7953 if (!NILP (face_name))
7955 if (!merge_named_face (f, face_name, attrs, 0))
7956 return base_face_id;
7958 else
7960 struct face *face;
7961 if (face_id < 0)
7962 return base_face_id;
7963 face = FACE_FROM_ID (f, face_id);
7964 if (!face)
7965 return base_face_id;
7966 merge_face_vectors (f, face->lface, attrs, 0);
7969 /* Look up a realized face with the given face attributes,
7970 or realize a new one for ASCII characters. */
7971 return lookup_face (f, attrs, 0, NULL);
7975 /***********************************************************************
7976 Tests
7977 ***********************************************************************/
7979 #if GLYPH_DEBUG
7981 /* Print the contents of the realized face FACE to stderr. */
7983 static void
7984 dump_realized_face (face)
7985 struct face *face;
7987 fprintf (stderr, "ID: %d\n", face->id);
7988 #ifdef HAVE_X_WINDOWS
7989 fprintf (stderr, "gc: %ld\n", (long) face->gc);
7990 #endif
7991 fprintf (stderr, "foreground: 0x%lx (%s)\n",
7992 face->foreground,
7993 SDATA (face->lface[LFACE_FOREGROUND_INDEX]));
7994 fprintf (stderr, "background: 0x%lx (%s)\n",
7995 face->background,
7996 SDATA (face->lface[LFACE_BACKGROUND_INDEX]));
7997 fprintf (stderr, "font_name: %s (%s)\n",
7998 face->font_name,
7999 SDATA (face->lface[LFACE_FAMILY_INDEX]));
8000 #ifdef HAVE_X_WINDOWS
8001 fprintf (stderr, "font = %p\n", face->font);
8002 #endif
8003 fprintf (stderr, "font_info_id = %d\n", face->font_info_id);
8004 fprintf (stderr, "fontset: %d\n", face->fontset);
8005 fprintf (stderr, "underline: %d (%s)\n",
8006 face->underline_p,
8007 SDATA (Fsymbol_name (face->lface[LFACE_UNDERLINE_INDEX])));
8008 fprintf (stderr, "hash: %d\n", face->hash);
8009 fprintf (stderr, "charset: %d\n", face->charset);
8013 DEFUN ("dump-face", Fdump_face, Sdump_face, 0, 1, 0, doc: /* */)
8015 Lisp_Object n;
8017 if (NILP (n))
8019 int i;
8021 fprintf (stderr, "font selection order: ");
8022 for (i = 0; i < DIM (font_sort_order); ++i)
8023 fprintf (stderr, "%d ", font_sort_order[i]);
8024 fprintf (stderr, "\n");
8026 fprintf (stderr, "alternative fonts: ");
8027 debug_print (Vface_alternative_font_family_alist);
8028 fprintf (stderr, "\n");
8030 for (i = 0; i < FRAME_FACE_CACHE (SELECTED_FRAME ())->used; ++i)
8031 Fdump_face (make_number (i));
8033 else
8035 struct face *face;
8036 CHECK_NUMBER (n);
8037 face = FACE_FROM_ID (SELECTED_FRAME (), XINT (n));
8038 if (face == NULL)
8039 error ("Not a valid face");
8040 dump_realized_face (face);
8043 return Qnil;
8047 DEFUN ("show-face-resources", Fshow_face_resources, Sshow_face_resources,
8048 0, 0, 0, doc: /* */)
8051 fprintf (stderr, "number of colors = %d\n", ncolors_allocated);
8052 fprintf (stderr, "number of pixmaps = %d\n", npixmaps_allocated);
8053 fprintf (stderr, "number of GCs = %d\n", ngcs);
8054 return Qnil;
8057 #endif /* GLYPH_DEBUG != 0 */
8061 /***********************************************************************
8062 Initialization
8063 ***********************************************************************/
8065 void
8066 syms_of_xfaces ()
8068 Qface = intern ("face");
8069 staticpro (&Qface);
8070 Qface_no_inherit = intern ("face-no-inherit");
8071 staticpro (&Qface_no_inherit);
8072 Qbitmap_spec_p = intern ("bitmap-spec-p");
8073 staticpro (&Qbitmap_spec_p);
8074 Qframe_set_background_mode = intern ("frame-set-background-mode");
8075 staticpro (&Qframe_set_background_mode);
8077 /* Lisp face attribute keywords. */
8078 QCfamily = intern (":family");
8079 staticpro (&QCfamily);
8080 QCheight = intern (":height");
8081 staticpro (&QCheight);
8082 QCweight = intern (":weight");
8083 staticpro (&QCweight);
8084 QCslant = intern (":slant");
8085 staticpro (&QCslant);
8086 QCunderline = intern (":underline");
8087 staticpro (&QCunderline);
8088 QCinverse_video = intern (":inverse-video");
8089 staticpro (&QCinverse_video);
8090 QCreverse_video = intern (":reverse-video");
8091 staticpro (&QCreverse_video);
8092 QCforeground = intern (":foreground");
8093 staticpro (&QCforeground);
8094 QCbackground = intern (":background");
8095 staticpro (&QCbackground);
8096 QCstipple = intern (":stipple");
8097 staticpro (&QCstipple);
8098 QCwidth = intern (":width");
8099 staticpro (&QCwidth);
8100 QCfont = intern (":font");
8101 staticpro (&QCfont);
8102 QCbold = intern (":bold");
8103 staticpro (&QCbold);
8104 QCitalic = intern (":italic");
8105 staticpro (&QCitalic);
8106 QCoverline = intern (":overline");
8107 staticpro (&QCoverline);
8108 QCstrike_through = intern (":strike-through");
8109 staticpro (&QCstrike_through);
8110 QCbox = intern (":box");
8111 staticpro (&QCbox);
8112 QCinherit = intern (":inherit");
8113 staticpro (&QCinherit);
8115 /* Symbols used for Lisp face attribute values. */
8116 QCcolor = intern (":color");
8117 staticpro (&QCcolor);
8118 QCline_width = intern (":line-width");
8119 staticpro (&QCline_width);
8120 QCstyle = intern (":style");
8121 staticpro (&QCstyle);
8122 Qreleased_button = intern ("released-button");
8123 staticpro (&Qreleased_button);
8124 Qpressed_button = intern ("pressed-button");
8125 staticpro (&Qpressed_button);
8126 Qnormal = intern ("normal");
8127 staticpro (&Qnormal);
8128 Qultra_light = intern ("ultra-light");
8129 staticpro (&Qultra_light);
8130 Qextra_light = intern ("extra-light");
8131 staticpro (&Qextra_light);
8132 Qlight = intern ("light");
8133 staticpro (&Qlight);
8134 Qsemi_light = intern ("semi-light");
8135 staticpro (&Qsemi_light);
8136 Qsemi_bold = intern ("semi-bold");
8137 staticpro (&Qsemi_bold);
8138 Qbold = intern ("bold");
8139 staticpro (&Qbold);
8140 Qextra_bold = intern ("extra-bold");
8141 staticpro (&Qextra_bold);
8142 Qultra_bold = intern ("ultra-bold");
8143 staticpro (&Qultra_bold);
8144 Qoblique = intern ("oblique");
8145 staticpro (&Qoblique);
8146 Qitalic = intern ("italic");
8147 staticpro (&Qitalic);
8148 Qreverse_oblique = intern ("reverse-oblique");
8149 staticpro (&Qreverse_oblique);
8150 Qreverse_italic = intern ("reverse-italic");
8151 staticpro (&Qreverse_italic);
8152 Qultra_condensed = intern ("ultra-condensed");
8153 staticpro (&Qultra_condensed);
8154 Qextra_condensed = intern ("extra-condensed");
8155 staticpro (&Qextra_condensed);
8156 Qcondensed = intern ("condensed");
8157 staticpro (&Qcondensed);
8158 Qsemi_condensed = intern ("semi-condensed");
8159 staticpro (&Qsemi_condensed);
8160 Qsemi_expanded = intern ("semi-expanded");
8161 staticpro (&Qsemi_expanded);
8162 Qexpanded = intern ("expanded");
8163 staticpro (&Qexpanded);
8164 Qextra_expanded = intern ("extra-expanded");
8165 staticpro (&Qextra_expanded);
8166 Qultra_expanded = intern ("ultra-expanded");
8167 staticpro (&Qultra_expanded);
8168 Qbackground_color = intern ("background-color");
8169 staticpro (&Qbackground_color);
8170 Qforeground_color = intern ("foreground-color");
8171 staticpro (&Qforeground_color);
8172 Qunspecified = intern ("unspecified");
8173 staticpro (&Qunspecified);
8174 Qignore_defface = intern (":ignore-defface");
8175 staticpro (&Qignore_defface);
8177 Qface_alias = intern ("face-alias");
8178 staticpro (&Qface_alias);
8179 Qdefault = intern ("default");
8180 staticpro (&Qdefault);
8181 Qtool_bar = intern ("tool-bar");
8182 staticpro (&Qtool_bar);
8183 Qregion = intern ("region");
8184 staticpro (&Qregion);
8185 Qfringe = intern ("fringe");
8186 staticpro (&Qfringe);
8187 Qheader_line = intern ("header-line");
8188 staticpro (&Qheader_line);
8189 Qscroll_bar = intern ("scroll-bar");
8190 staticpro (&Qscroll_bar);
8191 Qmenu = intern ("menu");
8192 staticpro (&Qmenu);
8193 Qcursor = intern ("cursor");
8194 staticpro (&Qcursor);
8195 Qborder = intern ("border");
8196 staticpro (&Qborder);
8197 Qmouse = intern ("mouse");
8198 staticpro (&Qmouse);
8199 Qmode_line_inactive = intern ("mode-line-inactive");
8200 staticpro (&Qmode_line_inactive);
8201 Qvertical_border = intern ("vertical-border");
8202 staticpro (&Qvertical_border);
8203 Qtty_color_desc = intern ("tty-color-desc");
8204 staticpro (&Qtty_color_desc);
8205 Qtty_color_standard_values = intern ("tty-color-standard-values");
8206 staticpro (&Qtty_color_standard_values);
8207 Qtty_color_by_index = intern ("tty-color-by-index");
8208 staticpro (&Qtty_color_by_index);
8209 Qtty_color_alist = intern ("tty-color-alist");
8210 staticpro (&Qtty_color_alist);
8211 Qscalable_fonts_allowed = intern ("scalable-fonts-allowed");
8212 staticpro (&Qscalable_fonts_allowed);
8214 Vparam_value_alist = Fcons (Fcons (Qnil, Qnil), Qnil);
8215 staticpro (&Vparam_value_alist);
8216 Vface_alternative_font_family_alist = Qnil;
8217 staticpro (&Vface_alternative_font_family_alist);
8218 Vface_alternative_font_registry_alist = Qnil;
8219 staticpro (&Vface_alternative_font_registry_alist);
8221 defsubr (&Sinternal_make_lisp_face);
8222 defsubr (&Sinternal_lisp_face_p);
8223 defsubr (&Sinternal_set_lisp_face_attribute);
8224 #ifdef HAVE_WINDOW_SYSTEM
8225 defsubr (&Sinternal_set_lisp_face_attribute_from_resource);
8226 #endif
8227 defsubr (&Scolor_gray_p);
8228 defsubr (&Scolor_supported_p);
8229 defsubr (&Sface_attribute_relative_p);
8230 defsubr (&Smerge_face_attribute);
8231 defsubr (&Sinternal_get_lisp_face_attribute);
8232 defsubr (&Sinternal_lisp_face_attribute_values);
8233 defsubr (&Sinternal_lisp_face_equal_p);
8234 defsubr (&Sinternal_lisp_face_empty_p);
8235 defsubr (&Sinternal_copy_lisp_face);
8236 defsubr (&Sinternal_merge_in_global_face);
8237 defsubr (&Sface_font);
8238 defsubr (&Sframe_face_alist);
8239 defsubr (&Sdisplay_supports_face_attributes_p);
8240 defsubr (&Scolor_distance);
8241 defsubr (&Sinternal_set_font_selection_order);
8242 defsubr (&Sinternal_set_alternative_font_family_alist);
8243 defsubr (&Sinternal_set_alternative_font_registry_alist);
8244 defsubr (&Sface_attributes_as_vector);
8245 #if GLYPH_DEBUG
8246 defsubr (&Sdump_face);
8247 defsubr (&Sshow_face_resources);
8248 #endif /* GLYPH_DEBUG */
8249 defsubr (&Sclear_face_cache);
8250 defsubr (&Stty_suppress_bold_inverse_default_colors);
8252 #if defined DEBUG_X_COLORS && defined HAVE_X_WINDOWS
8253 defsubr (&Sdump_colors);
8254 #endif
8256 DEFVAR_LISP ("font-list-limit", &Vfont_list_limit,
8257 doc: /* *Limit for font matching.
8258 If an integer > 0, font matching functions won't load more than
8259 that number of fonts when searching for a matching font. */);
8260 Vfont_list_limit = make_number (DEFAULT_FONT_LIST_LIMIT);
8262 DEFVAR_LISP ("face-new-frame-defaults", &Vface_new_frame_defaults,
8263 doc: /* List of global face definitions (for internal use only.) */);
8264 Vface_new_frame_defaults = Qnil;
8266 DEFVAR_LISP ("face-default-stipple", &Vface_default_stipple,
8267 doc: /* *Default stipple pattern used on monochrome displays.
8268 This stipple pattern is used on monochrome displays
8269 instead of shades of gray for a face background color.
8270 See `set-face-stipple' for possible values for this variable. */);
8271 Vface_default_stipple = build_string ("gray3");
8273 DEFVAR_LISP ("tty-defined-color-alist", &Vtty_defined_color_alist,
8274 doc: /* An alist of defined terminal colors and their RGB values. */);
8275 Vtty_defined_color_alist = Qnil;
8277 DEFVAR_LISP ("scalable-fonts-allowed", &Vscalable_fonts_allowed,
8278 doc: /* Allowed scalable fonts.
8279 A value of nil means don't allow any scalable fonts.
8280 A value of t means allow any scalable font.
8281 Otherwise, value must be a list of regular expressions. A font may be
8282 scaled if its name matches a regular expression in the list.
8283 Note that if value is nil, a scalable font might still be used, if no
8284 other font of the appropriate family and registry is available. */);
8285 Vscalable_fonts_allowed = Qnil;
8287 DEFVAR_LISP ("face-ignored-fonts", &Vface_ignored_fonts,
8288 doc: /* List of ignored fonts.
8289 Each element is a regular expression that matches names of fonts to
8290 ignore. */);
8291 Vface_ignored_fonts = Qnil;
8293 DEFVAR_LISP ("face-font-rescale-alist", &Vface_font_rescale_alist,
8294 doc: /* Alist of fonts vs the rescaling factors.
8295 Each element is a cons (FONT-NAME-PATTERN . RESCALE-RATIO), where
8296 FONT-NAME-PATTERN is a regular expression matching a font name, and
8297 RESCALE-RATIO is a floating point number to specify how much larger
8298 \(or smaller) font we should use. For instance, if a face requests
8299 a font of 10 point, we actually use a font of 10 * RESCALE-RATIO point. */);
8300 Vface_font_rescale_alist = Qnil;
8302 #ifdef HAVE_WINDOW_SYSTEM
8303 defsubr (&Sbitmap_spec_p);
8304 defsubr (&Sx_list_fonts);
8305 defsubr (&Sinternal_face_x_get_resource);
8306 defsubr (&Sx_family_fonts);
8307 defsubr (&Sx_font_family_list);
8308 #endif /* HAVE_WINDOW_SYSTEM */
8311 /* arch-tag: 8a0f7598-5517-408d-9ab3-1da6fcd4c749
8312 (do not change this comment) */