Correct typo.
[emacs.git] / src / xfaces.c
blob418d8922bb31b2ea18d16717d56627228b14faba
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>
199 #include "lisp.h"
200 #include "charset.h"
201 #include "keyboard.h"
202 #include "frame.h"
204 #ifdef HAVE_WINDOW_SYSTEM
205 #include "fontset.h"
206 #endif /* HAVE_WINDOW_SYSTEM */
208 #ifdef HAVE_X_WINDOWS
209 #include "xterm.h"
210 #ifdef USE_MOTIF
211 #include <Xm/Xm.h>
212 #include <Xm/XmStrDefs.h>
213 #endif /* USE_MOTIF */
214 #endif /* HAVE_X_WINDOWS */
216 #ifdef MSDOS
217 #include "dosfns.h"
218 #endif
220 #ifdef WINDOWSNT
221 #include "w32term.h"
222 #include "fontset.h"
223 /* Redefine X specifics to W32 equivalents to avoid cluttering the
224 code with #ifdef blocks. */
225 #undef FRAME_X_DISPLAY_INFO
226 #define FRAME_X_DISPLAY_INFO FRAME_W32_DISPLAY_INFO
227 #define x_display_info w32_display_info
228 #define FRAME_X_FONT_TABLE FRAME_W32_FONT_TABLE
229 #define check_x check_w32
230 #define x_list_fonts w32_list_fonts
231 #define GCGraphicsExposures 0
232 #endif /* WINDOWSNT */
234 #ifdef MAC_OS
235 #include "macterm.h"
236 #define x_display_info mac_display_info
237 #define check_x check_mac
238 #endif /* MAC_OS */
240 #include "buffer.h"
241 #include "dispextern.h"
242 #include "blockinput.h"
243 #include "window.h"
244 #include "intervals.h"
246 #ifdef HAVE_X_WINDOWS
248 /* Compensate for a bug in Xos.h on some systems, on which it requires
249 time.h. On some such systems, Xos.h tries to redefine struct
250 timeval and struct timezone if USG is #defined while it is
251 #included. */
253 #ifdef XOS_NEEDS_TIME_H
254 #include <time.h>
255 #undef USG
256 #include <X11/Xos.h>
257 #define USG
258 #define __TIMEVAL__
259 #else /* not XOS_NEEDS_TIME_H */
260 #include <X11/Xos.h>
261 #endif /* not XOS_NEEDS_TIME_H */
263 #endif /* HAVE_X_WINDOWS */
265 #include <ctype.h>
267 #undef abs
268 #define abs(X) ((X) < 0 ? -(X) : (X))
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 BLOCK_INPUT;
748 IF_DEBUG (xassert (--ngcs >= 0));
749 XFreeGC (FRAME_X_DISPLAY (f), gc);
750 UNBLOCK_INPUT;
753 #endif /* HAVE_X_WINDOWS */
755 #ifdef WINDOWSNT
756 /* W32 emulation of GCs */
758 static INLINE GC
759 x_create_gc (f, mask, xgcv)
760 struct frame *f;
761 unsigned long mask;
762 XGCValues *xgcv;
764 GC gc;
765 BLOCK_INPUT;
766 gc = XCreateGC (NULL, FRAME_W32_WINDOW (f), mask, xgcv);
767 UNBLOCK_INPUT;
768 IF_DEBUG (++ngcs);
769 return gc;
773 /* Free GC which was used on frame F. */
775 static INLINE void
776 x_free_gc (f, gc)
777 struct frame *f;
778 GC gc;
780 BLOCK_INPUT;
781 IF_DEBUG (xassert (--ngcs >= 0));
782 xfree (gc);
783 UNBLOCK_INPUT;
786 #endif /* WINDOWSNT */
788 #ifdef MAC_OS
789 /* Mac OS emulation of GCs */
791 static INLINE GC
792 x_create_gc (f, mask, xgcv)
793 struct frame *f;
794 unsigned long mask;
795 XGCValues *xgcv;
797 GC gc;
798 BLOCK_INPUT;
799 gc = XCreateGC (FRAME_MAC_DISPLAY (f), FRAME_MAC_WINDOW (f), mask, xgcv);
800 UNBLOCK_INPUT;
801 IF_DEBUG (++ngcs);
802 return gc;
805 static INLINE void
806 x_free_gc (f, gc)
807 struct frame *f;
808 GC gc;
810 BLOCK_INPUT;
811 IF_DEBUG (xassert (--ngcs >= 0));
812 XFreeGC (FRAME_MAC_DISPLAY (f), gc);
813 UNBLOCK_INPUT;
816 #endif /* MAC_OS */
818 /* Like stricmp. Used to compare parts of font names which are in
819 ISO8859-1. */
822 xstricmp (s1, s2)
823 const unsigned char *s1, *s2;
825 while (*s1 && *s2)
827 unsigned char c1 = tolower (*s1);
828 unsigned char c2 = tolower (*s2);
829 if (c1 != c2)
830 return c1 < c2 ? -1 : 1;
831 ++s1, ++s2;
834 if (*s1 == 0)
835 return *s2 == 0 ? 0 : -1;
836 return 1;
840 /* Like strlwr, which might not always be available. */
842 static unsigned char *
843 xstrlwr (s)
844 unsigned char *s;
846 unsigned char *p = s;
848 for (p = s; *p; ++p)
849 /* On Mac OS X 10.3, tolower also converts non-ASCII characters
850 for some locales. */
851 if (isascii (*p))
852 *p = tolower (*p);
854 return s;
858 /* If FRAME is nil, return a pointer to the selected frame.
859 Otherwise, check that FRAME is a live frame, and return a pointer
860 to it. NPARAM is the parameter number of FRAME, for
861 CHECK_LIVE_FRAME. This is here because it's a frequent pattern in
862 Lisp function definitions. */
864 static INLINE struct frame *
865 frame_or_selected_frame (frame, nparam)
866 Lisp_Object frame;
867 int nparam;
869 if (NILP (frame))
870 frame = selected_frame;
872 CHECK_LIVE_FRAME (frame);
873 return XFRAME (frame);
877 /***********************************************************************
878 Frames and faces
879 ***********************************************************************/
881 /* Initialize face cache and basic faces for frame F. */
883 void
884 init_frame_faces (f)
885 struct frame *f;
887 /* Make a face cache, if F doesn't have one. */
888 if (FRAME_FACE_CACHE (f) == NULL)
889 FRAME_FACE_CACHE (f) = make_face_cache (f);
891 #ifdef HAVE_WINDOW_SYSTEM
892 /* Make the image cache. */
893 if (FRAME_WINDOW_P (f))
895 if (FRAME_X_IMAGE_CACHE (f) == NULL)
896 FRAME_X_IMAGE_CACHE (f) = make_image_cache ();
897 ++FRAME_X_IMAGE_CACHE (f)->refcount;
899 #endif /* HAVE_WINDOW_SYSTEM */
901 /* Realize basic faces. Must have enough information in frame
902 parameters to realize basic faces at this point. */
903 #ifdef HAVE_X_WINDOWS
904 if (!FRAME_X_P (f) || FRAME_X_WINDOW (f))
905 #endif
906 #ifdef WINDOWSNT
907 if (!FRAME_WINDOW_P (f) || FRAME_W32_WINDOW (f))
908 #endif
909 #ifdef MAC_OS
910 if (!FRAME_MAC_P (f) || FRAME_MAC_WINDOW (f))
911 #endif
912 if (!realize_basic_faces (f))
913 abort ();
917 /* Free face cache of frame F. Called from Fdelete_frame. */
919 void
920 free_frame_faces (f)
921 struct frame *f;
923 struct face_cache *face_cache = FRAME_FACE_CACHE (f);
925 if (face_cache)
927 free_face_cache (face_cache);
928 FRAME_FACE_CACHE (f) = NULL;
931 #ifdef HAVE_WINDOW_SYSTEM
932 if (FRAME_WINDOW_P (f))
934 struct image_cache *image_cache = FRAME_X_IMAGE_CACHE (f);
935 if (image_cache)
937 --image_cache->refcount;
938 if (image_cache->refcount == 0)
939 free_image_cache (f);
942 #endif /* HAVE_WINDOW_SYSTEM */
946 /* Clear face caches, and recompute basic faces for frame F. Call
947 this after changing frame parameters on which those faces depend,
948 or when realized faces have been freed due to changing attributes
949 of named faces. */
951 void
952 recompute_basic_faces (f)
953 struct frame *f;
955 if (FRAME_FACE_CACHE (f))
957 clear_face_cache (0);
958 if (!realize_basic_faces (f))
959 abort ();
964 /* Clear the face caches of all frames. CLEAR_FONTS_P non-zero means
965 try to free unused fonts, too. */
967 void
968 clear_face_cache (clear_fonts_p)
969 int clear_fonts_p;
971 #ifdef HAVE_WINDOW_SYSTEM
972 Lisp_Object tail, frame;
973 struct frame *f;
975 if (clear_fonts_p
976 || ++clear_font_table_count == CLEAR_FONT_TABLE_COUNT)
978 struct x_display_info *dpyinfo;
980 /* Fonts are common for frames on one display, i.e. on
981 one X screen. */
982 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
983 if (dpyinfo->n_fonts > CLEAR_FONT_TABLE_NFONTS)
984 clear_font_table (dpyinfo);
986 /* From time to time see if we can unload some fonts. This also
987 frees all realized faces on all frames. Fonts needed by
988 faces will be loaded again when faces are realized again. */
989 clear_font_table_count = 0;
991 FOR_EACH_FRAME (tail, frame)
993 struct frame *f = XFRAME (frame);
994 if (FRAME_WINDOW_P (f)
995 && FRAME_X_DISPLAY_INFO (f)->n_fonts > CLEAR_FONT_TABLE_NFONTS)
996 free_all_realized_faces (frame);
999 else
1001 /* Clear GCs of realized faces. */
1002 FOR_EACH_FRAME (tail, frame)
1004 f = XFRAME (frame);
1005 if (FRAME_WINDOW_P (f))
1007 clear_face_gcs (FRAME_FACE_CACHE (f));
1008 clear_image_cache (f, 0);
1012 #endif /* HAVE_WINDOW_SYSTEM */
1016 DEFUN ("clear-face-cache", Fclear_face_cache, Sclear_face_cache, 0, 1, 0,
1017 doc: /* Clear face caches on all frames.
1018 Optional THOROUGHLY non-nil means try to free unused fonts, too. */)
1019 (thoroughly)
1020 Lisp_Object thoroughly;
1022 clear_face_cache (!NILP (thoroughly));
1023 ++face_change_count;
1024 ++windows_or_buffers_changed;
1025 return Qnil;
1030 #ifdef HAVE_WINDOW_SYSTEM
1033 /* Remove fonts from the font table of DPYINFO except for the default
1034 ASCII fonts of frames on that display. Called from clear_face_cache
1035 from time to time. */
1037 static void
1038 clear_font_table (dpyinfo)
1039 struct x_display_info *dpyinfo;
1041 int i;
1043 /* Free those fonts that are not used by frames on DPYINFO. */
1044 for (i = 0; i < dpyinfo->n_fonts; ++i)
1046 struct font_info *font_info = dpyinfo->font_table + i;
1047 Lisp_Object tail, frame;
1049 /* Check if slot is already free. */
1050 if (font_info->name == NULL)
1051 continue;
1053 /* Don't free a default font of some frame. */
1054 FOR_EACH_FRAME (tail, frame)
1056 struct frame *f = XFRAME (frame);
1057 if (FRAME_WINDOW_P (f)
1058 && font_info->font == FRAME_FONT (f))
1059 break;
1062 if (!NILP (tail))
1063 continue;
1065 /* Free names. */
1066 if (font_info->full_name != font_info->name)
1067 xfree (font_info->full_name);
1068 xfree (font_info->name);
1070 /* Free the font. */
1071 BLOCK_INPUT;
1072 #ifdef HAVE_X_WINDOWS
1073 XFreeFont (dpyinfo->display, font_info->font);
1074 #endif
1075 #ifdef WINDOWSNT
1076 w32_unload_font (dpyinfo, font_info->font);
1077 #endif
1078 #ifdef MAC_OS
1079 mac_unload_font (dpyinfo, font_info->font);
1080 #endif
1081 UNBLOCK_INPUT;
1083 /* Mark font table slot free. */
1084 font_info->font = NULL;
1085 font_info->name = font_info->full_name = NULL;
1089 #endif /* HAVE_WINDOW_SYSTEM */
1093 /***********************************************************************
1094 X Pixmaps
1095 ***********************************************************************/
1097 #ifdef HAVE_WINDOW_SYSTEM
1099 DEFUN ("bitmap-spec-p", Fbitmap_spec_p, Sbitmap_spec_p, 1, 1, 0,
1100 doc: /* Value is non-nil if OBJECT is a valid bitmap specification.
1101 A bitmap specification is either a string, a file name, or a list
1102 \(WIDTH HEIGHT DATA) where WIDTH is the pixel width of the bitmap,
1103 HEIGHT is its height, and DATA is a string containing the bits of
1104 the pixmap. Bits are stored row by row, each row occupies
1105 \(WIDTH + 7)/8 bytes. */)
1106 (object)
1107 Lisp_Object object;
1109 int pixmap_p = 0;
1111 if (STRINGP (object))
1112 /* If OBJECT is a string, it's a file name. */
1113 pixmap_p = 1;
1114 else if (CONSP (object))
1116 /* Otherwise OBJECT must be (WIDTH HEIGHT DATA), WIDTH and
1117 HEIGHT must be integers > 0, and DATA must be string large
1118 enough to hold a bitmap of the specified size. */
1119 Lisp_Object width, height, data;
1121 height = width = data = Qnil;
1123 if (CONSP (object))
1125 width = XCAR (object);
1126 object = XCDR (object);
1127 if (CONSP (object))
1129 height = XCAR (object);
1130 object = XCDR (object);
1131 if (CONSP (object))
1132 data = XCAR (object);
1136 if (NATNUMP (width) && NATNUMP (height) && STRINGP (data))
1138 int bytes_per_row = ((XFASTINT (width) + BITS_PER_CHAR - 1)
1139 / BITS_PER_CHAR);
1140 if (SBYTES (data) >= bytes_per_row * XINT (height))
1141 pixmap_p = 1;
1145 return pixmap_p ? Qt : Qnil;
1149 /* Load a bitmap according to NAME (which is either a file name or a
1150 pixmap spec) for use on frame F. Value is the bitmap_id (see
1151 xfns.c). If NAME is nil, return with a bitmap id of zero. If
1152 bitmap cannot be loaded, display a message saying so, and return
1153 zero. Store the bitmap width in *W_PTR and its height in *H_PTR,
1154 if these pointers are not null. */
1156 static int
1157 load_pixmap (f, name, w_ptr, h_ptr)
1158 FRAME_PTR f;
1159 Lisp_Object name;
1160 unsigned int *w_ptr, *h_ptr;
1162 int bitmap_id;
1164 if (NILP (name))
1165 return 0;
1167 CHECK_TYPE (!NILP (Fbitmap_spec_p (name)), Qbitmap_spec_p, name);
1169 BLOCK_INPUT;
1170 if (CONSP (name))
1172 /* Decode a bitmap spec into a bitmap. */
1174 int h, w;
1175 Lisp_Object bits;
1177 w = XINT (Fcar (name));
1178 h = XINT (Fcar (Fcdr (name)));
1179 bits = Fcar (Fcdr (Fcdr (name)));
1181 bitmap_id = x_create_bitmap_from_data (f, SDATA (bits),
1182 w, h);
1184 else
1186 /* It must be a string -- a file name. */
1187 bitmap_id = x_create_bitmap_from_file (f, name);
1189 UNBLOCK_INPUT;
1191 if (bitmap_id < 0)
1193 add_to_log ("Invalid or undefined bitmap `%s'", name, Qnil);
1194 bitmap_id = 0;
1196 if (w_ptr)
1197 *w_ptr = 0;
1198 if (h_ptr)
1199 *h_ptr = 0;
1201 else
1203 #if GLYPH_DEBUG
1204 ++npixmaps_allocated;
1205 #endif
1206 if (w_ptr)
1207 *w_ptr = x_bitmap_width (f, bitmap_id);
1209 if (h_ptr)
1210 *h_ptr = x_bitmap_height (f, bitmap_id);
1213 return bitmap_id;
1216 #endif /* HAVE_WINDOW_SYSTEM */
1220 /***********************************************************************
1221 Fonts
1222 ***********************************************************************/
1224 #ifdef HAVE_WINDOW_SYSTEM
1226 /* Load font of face FACE which is used on frame F to display
1227 character C. The name of the font to load is determined by lface
1228 and fontset of FACE. */
1230 static void
1231 load_face_font (f, face, c)
1232 struct frame *f;
1233 struct face *face;
1234 int c;
1236 struct font_info *font_info = NULL;
1237 char *font_name;
1238 int needs_overstrike;
1240 face->font_info_id = -1;
1241 face->font = NULL;
1243 font_name = choose_face_font (f, face->lface, face->fontset, c,
1244 &needs_overstrike);
1245 if (!font_name)
1246 return;
1248 BLOCK_INPUT;
1249 font_info = FS_LOAD_FACE_FONT (f, c, font_name, face);
1250 UNBLOCK_INPUT;
1252 if (font_info)
1254 face->font_info_id = font_info->font_idx;
1255 face->font = font_info->font;
1256 face->font_name = font_info->full_name;
1257 face->overstrike = needs_overstrike;
1258 if (face->gc)
1260 x_free_gc (f, face->gc);
1261 face->gc = 0;
1264 else
1265 add_to_log ("Unable to load font %s",
1266 build_string (font_name), Qnil);
1267 xfree (font_name);
1270 #endif /* HAVE_WINDOW_SYSTEM */
1274 /***********************************************************************
1275 X Colors
1276 ***********************************************************************/
1278 /* Parse RGB_LIST, and fill in the RGB fields of COLOR.
1279 RGB_LIST should contain (at least) 3 lisp integers.
1280 Return 0 if there's a problem with RGB_LIST, otherwise return 1. */
1282 static int
1283 parse_rgb_list (rgb_list, color)
1284 Lisp_Object rgb_list;
1285 XColor *color;
1287 #define PARSE_RGB_LIST_FIELD(field) \
1288 if (CONSP (rgb_list) && INTEGERP (XCAR (rgb_list))) \
1290 color->field = XINT (XCAR (rgb_list)); \
1291 rgb_list = XCDR (rgb_list); \
1293 else \
1294 return 0;
1296 PARSE_RGB_LIST_FIELD (red);
1297 PARSE_RGB_LIST_FIELD (green);
1298 PARSE_RGB_LIST_FIELD (blue);
1300 return 1;
1304 /* Lookup on frame F the color described by the lisp string COLOR.
1305 The resulting tty color is returned in TTY_COLOR; if STD_COLOR is
1306 non-zero, then the `standard' definition of the same color is
1307 returned in it. */
1309 static int
1310 tty_lookup_color (f, color, tty_color, std_color)
1311 struct frame *f;
1312 Lisp_Object color;
1313 XColor *tty_color, *std_color;
1315 Lisp_Object frame, color_desc;
1317 if (!STRINGP (color) || NILP (Ffboundp (Qtty_color_desc)))
1318 return 0;
1320 XSETFRAME (frame, f);
1322 color_desc = call2 (Qtty_color_desc, color, frame);
1323 if (CONSP (color_desc) && CONSP (XCDR (color_desc)))
1325 Lisp_Object rgb;
1327 if (! INTEGERP (XCAR (XCDR (color_desc))))
1328 return 0;
1330 tty_color->pixel = XINT (XCAR (XCDR (color_desc)));
1332 rgb = XCDR (XCDR (color_desc));
1333 if (! parse_rgb_list (rgb, tty_color))
1334 return 0;
1336 /* Should we fill in STD_COLOR too? */
1337 if (std_color)
1339 /* Default STD_COLOR to the same as TTY_COLOR. */
1340 *std_color = *tty_color;
1342 /* Do a quick check to see if the returned descriptor is
1343 actually _exactly_ equal to COLOR, otherwise we have to
1344 lookup STD_COLOR separately. If it's impossible to lookup
1345 a standard color, we just give up and use TTY_COLOR. */
1346 if ((!STRINGP (XCAR (color_desc))
1347 || NILP (Fstring_equal (color, XCAR (color_desc))))
1348 && !NILP (Ffboundp (Qtty_color_standard_values)))
1350 /* Look up STD_COLOR separately. */
1351 rgb = call1 (Qtty_color_standard_values, color);
1352 if (! parse_rgb_list (rgb, std_color))
1353 return 0;
1357 return 1;
1359 else if (NILP (Fsymbol_value (intern ("tty-defined-color-alist"))))
1360 /* We were called early during startup, and the colors are not
1361 yet set up in tty-defined-color-alist. Don't return a failure
1362 indication, since this produces the annoying "Unable to
1363 load color" messages in the *Messages* buffer. */
1364 return 1;
1365 else
1366 /* tty-color-desc seems to have returned a bad value. */
1367 return 0;
1370 /* A version of defined_color for non-X frames. */
1373 tty_defined_color (f, color_name, color_def, alloc)
1374 struct frame *f;
1375 char *color_name;
1376 XColor *color_def;
1377 int alloc;
1379 int status = 1;
1381 /* Defaults. */
1382 color_def->pixel = FACE_TTY_DEFAULT_COLOR;
1383 color_def->red = 0;
1384 color_def->blue = 0;
1385 color_def->green = 0;
1387 if (*color_name)
1388 status = tty_lookup_color (f, build_string (color_name), color_def, 0);
1390 if (color_def->pixel == FACE_TTY_DEFAULT_COLOR && *color_name)
1392 if (strcmp (color_name, "unspecified-fg") == 0)
1393 color_def->pixel = FACE_TTY_DEFAULT_FG_COLOR;
1394 else if (strcmp (color_name, "unspecified-bg") == 0)
1395 color_def->pixel = FACE_TTY_DEFAULT_BG_COLOR;
1398 if (color_def->pixel != FACE_TTY_DEFAULT_COLOR)
1399 status = 1;
1401 return status;
1405 /* Decide if color named COLOR_NAME is valid for the display
1406 associated with the frame F; if so, return the rgb values in
1407 COLOR_DEF. If ALLOC is nonzero, allocate a new colormap cell.
1409 This does the right thing for any type of frame. */
1412 defined_color (f, color_name, color_def, alloc)
1413 struct frame *f;
1414 char *color_name;
1415 XColor *color_def;
1416 int alloc;
1418 if (!FRAME_WINDOW_P (f))
1419 return tty_defined_color (f, color_name, color_def, alloc);
1420 #ifdef HAVE_X_WINDOWS
1421 else if (FRAME_X_P (f))
1422 return x_defined_color (f, color_name, color_def, alloc);
1423 #endif
1424 #ifdef WINDOWSNT
1425 else if (FRAME_W32_P (f))
1426 return w32_defined_color (f, color_name, color_def, alloc);
1427 #endif
1428 #ifdef MAC_OS
1429 else if (FRAME_MAC_P (f))
1430 return mac_defined_color (f, color_name, color_def, alloc);
1431 #endif
1432 else
1433 abort ();
1437 /* Given the index IDX of a tty color on frame F, return its name, a
1438 Lisp string. */
1440 Lisp_Object
1441 tty_color_name (f, idx)
1442 struct frame *f;
1443 int idx;
1445 if (idx >= 0 && !NILP (Ffboundp (Qtty_color_by_index)))
1447 Lisp_Object frame;
1448 Lisp_Object coldesc;
1450 XSETFRAME (frame, f);
1451 coldesc = call2 (Qtty_color_by_index, make_number (idx), frame);
1453 if (!NILP (coldesc))
1454 return XCAR (coldesc);
1456 #ifdef MSDOS
1457 /* We can have an MSDOG frame under -nw for a short window of
1458 opportunity before internal_terminal_init is called. DTRT. */
1459 if (FRAME_MSDOS_P (f) && !inhibit_window_system)
1460 return msdos_stdcolor_name (idx);
1461 #endif
1463 if (idx == FACE_TTY_DEFAULT_FG_COLOR)
1464 return build_string (unspecified_fg);
1465 if (idx == FACE_TTY_DEFAULT_BG_COLOR)
1466 return build_string (unspecified_bg);
1468 #ifdef WINDOWSNT
1469 return vga_stdcolor_name (idx);
1470 #endif
1472 return Qunspecified;
1476 /* Return non-zero if COLOR_NAME is a shade of gray (or white or
1477 black) on frame F.
1479 The criterion implemented here is not a terribly sophisticated one. */
1481 static int
1482 face_color_gray_p (f, color_name)
1483 struct frame *f;
1484 char *color_name;
1486 XColor color;
1487 int gray_p;
1489 if (defined_color (f, color_name, &color, 0))
1490 gray_p = (/* Any color sufficiently close to black counts as grey. */
1491 (color.red < 5000 && color.green < 5000 && color.blue < 5000)
1493 ((abs (color.red - color.green)
1494 < max (color.red, color.green) / 20)
1495 && (abs (color.green - color.blue)
1496 < max (color.green, color.blue) / 20)
1497 && (abs (color.blue - color.red)
1498 < max (color.blue, color.red) / 20)));
1499 else
1500 gray_p = 0;
1502 return gray_p;
1506 /* Return non-zero if color COLOR_NAME can be displayed on frame F.
1507 BACKGROUND_P non-zero means the color will be used as background
1508 color. */
1510 static int
1511 face_color_supported_p (f, color_name, background_p)
1512 struct frame *f;
1513 char *color_name;
1514 int background_p;
1516 Lisp_Object frame;
1517 XColor not_used;
1519 XSETFRAME (frame, f);
1520 return
1521 #ifdef HAVE_WINDOW_SYSTEM
1522 FRAME_WINDOW_P (f)
1523 ? (!NILP (Fxw_display_color_p (frame))
1524 || xstricmp (color_name, "black") == 0
1525 || xstricmp (color_name, "white") == 0
1526 || (background_p
1527 && face_color_gray_p (f, color_name))
1528 || (!NILP (Fx_display_grayscale_p (frame))
1529 && face_color_gray_p (f, color_name)))
1531 #endif
1532 tty_defined_color (f, color_name, &not_used, 0);
1536 DEFUN ("color-gray-p", Fcolor_gray_p, Scolor_gray_p, 1, 2, 0,
1537 doc: /* Return non-nil if COLOR is a shade of gray (or white or black).
1538 FRAME specifies the frame and thus the display for interpreting COLOR.
1539 If FRAME is nil or omitted, use the selected frame. */)
1540 (color, frame)
1541 Lisp_Object color, frame;
1543 struct frame *f;
1545 CHECK_STRING (color);
1546 if (NILP (frame))
1547 frame = selected_frame;
1548 else
1549 CHECK_FRAME (frame);
1550 f = XFRAME (frame);
1551 return face_color_gray_p (f, SDATA (color)) ? Qt : Qnil;
1555 DEFUN ("color-supported-p", Fcolor_supported_p,
1556 Scolor_supported_p, 1, 3, 0,
1557 doc: /* Return non-nil if COLOR can be displayed on FRAME.
1558 BACKGROUND-P non-nil means COLOR is used as a background.
1559 Otherwise, this function tells whether it can be used as a foreground.
1560 If FRAME is nil or omitted, use the selected frame.
1561 COLOR must be a valid color name. */)
1562 (color, frame, background_p)
1563 Lisp_Object frame, color, background_p;
1565 struct frame *f;
1567 CHECK_STRING (color);
1568 if (NILP (frame))
1569 frame = selected_frame;
1570 else
1571 CHECK_FRAME (frame);
1572 f = XFRAME (frame);
1573 if (face_color_supported_p (f, SDATA (color), !NILP (background_p)))
1574 return Qt;
1575 return Qnil;
1579 /* Load color with name NAME for use by face FACE on frame F.
1580 TARGET_INDEX must be one of LFACE_FOREGROUND_INDEX,
1581 LFACE_BACKGROUND_INDEX, LFACE_UNDERLINE_INDEX, LFACE_OVERLINE_INDEX,
1582 LFACE_STRIKE_THROUGH_INDEX, or LFACE_BOX_INDEX. Value is the
1583 pixel color. If color cannot be loaded, display a message, and
1584 return the foreground, background or underline color of F, but
1585 record that fact in flags of the face so that we don't try to free
1586 these colors. */
1588 unsigned long
1589 load_color (f, face, name, target_index)
1590 struct frame *f;
1591 struct face *face;
1592 Lisp_Object name;
1593 enum lface_attribute_index target_index;
1595 XColor color;
1597 xassert (STRINGP (name));
1598 xassert (target_index == LFACE_FOREGROUND_INDEX
1599 || target_index == LFACE_BACKGROUND_INDEX
1600 || target_index == LFACE_UNDERLINE_INDEX
1601 || target_index == LFACE_OVERLINE_INDEX
1602 || target_index == LFACE_STRIKE_THROUGH_INDEX
1603 || target_index == LFACE_BOX_INDEX);
1605 /* if the color map is full, defined_color will return a best match
1606 to the values in an existing cell. */
1607 if (!defined_color (f, SDATA (name), &color, 1))
1609 add_to_log ("Unable to load color \"%s\"", name, Qnil);
1611 switch (target_index)
1613 case LFACE_FOREGROUND_INDEX:
1614 face->foreground_defaulted_p = 1;
1615 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1616 break;
1618 case LFACE_BACKGROUND_INDEX:
1619 face->background_defaulted_p = 1;
1620 color.pixel = FRAME_BACKGROUND_PIXEL (f);
1621 break;
1623 case LFACE_UNDERLINE_INDEX:
1624 face->underline_defaulted_p = 1;
1625 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1626 break;
1628 case LFACE_OVERLINE_INDEX:
1629 face->overline_color_defaulted_p = 1;
1630 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1631 break;
1633 case LFACE_STRIKE_THROUGH_INDEX:
1634 face->strike_through_color_defaulted_p = 1;
1635 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1636 break;
1638 case LFACE_BOX_INDEX:
1639 face->box_color_defaulted_p = 1;
1640 color.pixel = FRAME_FOREGROUND_PIXEL (f);
1641 break;
1643 default:
1644 abort ();
1647 #if GLYPH_DEBUG
1648 else
1649 ++ncolors_allocated;
1650 #endif
1652 return color.pixel;
1656 #ifdef HAVE_WINDOW_SYSTEM
1658 /* Load colors for face FACE which is used on frame F. Colors are
1659 specified by slots LFACE_BACKGROUND_INDEX and LFACE_FOREGROUND_INDEX
1660 of ATTRS. If the background color specified is not supported on F,
1661 try to emulate gray colors with a stipple from Vface_default_stipple. */
1663 static void
1664 load_face_colors (f, face, attrs)
1665 struct frame *f;
1666 struct face *face;
1667 Lisp_Object *attrs;
1669 Lisp_Object fg, bg;
1671 bg = attrs[LFACE_BACKGROUND_INDEX];
1672 fg = attrs[LFACE_FOREGROUND_INDEX];
1674 /* Swap colors if face is inverse-video. */
1675 if (EQ (attrs[LFACE_INVERSE_INDEX], Qt))
1677 Lisp_Object tmp;
1678 tmp = fg;
1679 fg = bg;
1680 bg = tmp;
1683 /* Check for support for foreground, not for background because
1684 face_color_supported_p is smart enough to know that grays are
1685 "supported" as background because we are supposed to use stipple
1686 for them. */
1687 if (!face_color_supported_p (f, SDATA (bg), 0)
1688 && !NILP (Fbitmap_spec_p (Vface_default_stipple)))
1690 x_destroy_bitmap (f, face->stipple);
1691 face->stipple = load_pixmap (f, Vface_default_stipple,
1692 &face->pixmap_w, &face->pixmap_h);
1695 face->background = load_color (f, face, bg, LFACE_BACKGROUND_INDEX);
1696 face->foreground = load_color (f, face, fg, LFACE_FOREGROUND_INDEX);
1700 /* Free color PIXEL on frame F. */
1702 void
1703 unload_color (f, pixel)
1704 struct frame *f;
1705 unsigned long pixel;
1707 #ifdef HAVE_X_WINDOWS
1708 if (pixel != -1)
1710 BLOCK_INPUT;
1711 x_free_colors (f, &pixel, 1);
1712 UNBLOCK_INPUT;
1714 #endif
1718 /* Free colors allocated for FACE. */
1720 static void
1721 free_face_colors (f, face)
1722 struct frame *f;
1723 struct face *face;
1725 #ifdef HAVE_X_WINDOWS
1726 if (face->colors_copied_bitwise_p)
1727 return;
1729 BLOCK_INPUT;
1731 if (!face->foreground_defaulted_p)
1733 x_free_colors (f, &face->foreground, 1);
1734 IF_DEBUG (--ncolors_allocated);
1737 if (!face->background_defaulted_p)
1739 x_free_colors (f, &face->background, 1);
1740 IF_DEBUG (--ncolors_allocated);
1743 if (face->underline_p
1744 && !face->underline_defaulted_p)
1746 x_free_colors (f, &face->underline_color, 1);
1747 IF_DEBUG (--ncolors_allocated);
1750 if (face->overline_p
1751 && !face->overline_color_defaulted_p)
1753 x_free_colors (f, &face->overline_color, 1);
1754 IF_DEBUG (--ncolors_allocated);
1757 if (face->strike_through_p
1758 && !face->strike_through_color_defaulted_p)
1760 x_free_colors (f, &face->strike_through_color, 1);
1761 IF_DEBUG (--ncolors_allocated);
1764 if (face->box != FACE_NO_BOX
1765 && !face->box_color_defaulted_p)
1767 x_free_colors (f, &face->box_color, 1);
1768 IF_DEBUG (--ncolors_allocated);
1771 UNBLOCK_INPUT;
1772 #endif /* HAVE_X_WINDOWS */
1775 #endif /* HAVE_WINDOW_SYSTEM */
1779 /***********************************************************************
1780 XLFD Font Names
1781 ***********************************************************************/
1783 /* An enumerator for each field of an XLFD font name. */
1785 enum xlfd_field
1787 XLFD_FOUNDRY,
1788 XLFD_FAMILY,
1789 XLFD_WEIGHT,
1790 XLFD_SLANT,
1791 XLFD_SWIDTH,
1792 XLFD_ADSTYLE,
1793 XLFD_PIXEL_SIZE,
1794 XLFD_POINT_SIZE,
1795 XLFD_RESX,
1796 XLFD_RESY,
1797 XLFD_SPACING,
1798 XLFD_AVGWIDTH,
1799 XLFD_REGISTRY,
1800 XLFD_ENCODING,
1801 XLFD_LAST
1804 /* An enumerator for each possible slant value of a font. Taken from
1805 the XLFD specification. */
1807 enum xlfd_slant
1809 XLFD_SLANT_UNKNOWN,
1810 XLFD_SLANT_ROMAN,
1811 XLFD_SLANT_ITALIC,
1812 XLFD_SLANT_OBLIQUE,
1813 XLFD_SLANT_REVERSE_ITALIC,
1814 XLFD_SLANT_REVERSE_OBLIQUE,
1815 XLFD_SLANT_OTHER
1818 /* Relative font weight according to XLFD documentation. */
1820 enum xlfd_weight
1822 XLFD_WEIGHT_UNKNOWN,
1823 XLFD_WEIGHT_ULTRA_LIGHT, /* 10 */
1824 XLFD_WEIGHT_EXTRA_LIGHT, /* 20 */
1825 XLFD_WEIGHT_LIGHT, /* 30 */
1826 XLFD_WEIGHT_SEMI_LIGHT, /* 40: SemiLight, Book, ... */
1827 XLFD_WEIGHT_MEDIUM, /* 50: Medium, Normal, Regular, ... */
1828 XLFD_WEIGHT_SEMI_BOLD, /* 60: SemiBold, DemiBold, ... */
1829 XLFD_WEIGHT_BOLD, /* 70: Bold, ... */
1830 XLFD_WEIGHT_EXTRA_BOLD, /* 80: ExtraBold, Heavy, ... */
1831 XLFD_WEIGHT_ULTRA_BOLD /* 90: UltraBold, Black, ... */
1834 /* Relative proportionate width. */
1836 enum xlfd_swidth
1838 XLFD_SWIDTH_UNKNOWN,
1839 XLFD_SWIDTH_ULTRA_CONDENSED, /* 10 */
1840 XLFD_SWIDTH_EXTRA_CONDENSED, /* 20 */
1841 XLFD_SWIDTH_CONDENSED, /* 30: Condensed, Narrow, Compressed, ... */
1842 XLFD_SWIDTH_SEMI_CONDENSED, /* 40: semicondensed */
1843 XLFD_SWIDTH_MEDIUM, /* 50: Medium, Normal, Regular, ... */
1844 XLFD_SWIDTH_SEMI_EXPANDED, /* 60: SemiExpanded, DemiExpanded, ... */
1845 XLFD_SWIDTH_EXPANDED, /* 70: Expanded... */
1846 XLFD_SWIDTH_EXTRA_EXPANDED, /* 80: ExtraExpanded, Wide... */
1847 XLFD_SWIDTH_ULTRA_EXPANDED /* 90: UltraExpanded... */
1850 /* Structure used for tables mapping XLFD weight, slant, and width
1851 names to numeric and symbolic values. */
1853 struct table_entry
1855 char *name;
1856 int numeric;
1857 Lisp_Object *symbol;
1860 /* Table of XLFD slant names and their numeric and symbolic
1861 representations. This table must be sorted by slant names in
1862 ascending order. */
1864 static struct table_entry slant_table[] =
1866 {"i", XLFD_SLANT_ITALIC, &Qitalic},
1867 {"o", XLFD_SLANT_OBLIQUE, &Qoblique},
1868 {"ot", XLFD_SLANT_OTHER, &Qitalic},
1869 {"r", XLFD_SLANT_ROMAN, &Qnormal},
1870 {"ri", XLFD_SLANT_REVERSE_ITALIC, &Qreverse_italic},
1871 {"ro", XLFD_SLANT_REVERSE_OBLIQUE, &Qreverse_oblique}
1874 /* Table of XLFD weight names. This table must be sorted by weight
1875 names in ascending order. */
1877 static struct table_entry weight_table[] =
1879 {"black", XLFD_WEIGHT_ULTRA_BOLD, &Qultra_bold},
1880 {"bold", XLFD_WEIGHT_BOLD, &Qbold},
1881 {"book", XLFD_WEIGHT_SEMI_LIGHT, &Qsemi_light},
1882 {"demi", XLFD_WEIGHT_SEMI_BOLD, &Qsemi_bold},
1883 {"demibold", XLFD_WEIGHT_SEMI_BOLD, &Qsemi_bold},
1884 {"extralight", XLFD_WEIGHT_EXTRA_LIGHT, &Qextra_light},
1885 {"extrabold", XLFD_WEIGHT_EXTRA_BOLD, &Qextra_bold},
1886 {"heavy", XLFD_WEIGHT_EXTRA_BOLD, &Qextra_bold},
1887 {"light", XLFD_WEIGHT_LIGHT, &Qlight},
1888 {"medium", XLFD_WEIGHT_MEDIUM, &Qnormal},
1889 {"normal", XLFD_WEIGHT_MEDIUM, &Qnormal},
1890 {"regular", XLFD_WEIGHT_MEDIUM, &Qnormal},
1891 {"semibold", XLFD_WEIGHT_SEMI_BOLD, &Qsemi_bold},
1892 {"semilight", XLFD_WEIGHT_SEMI_LIGHT, &Qsemi_light},
1893 {"ultralight", XLFD_WEIGHT_ULTRA_LIGHT, &Qultra_light},
1894 {"ultrabold", XLFD_WEIGHT_ULTRA_BOLD, &Qultra_bold}
1897 /* Table of XLFD width names. This table must be sorted by width
1898 names in ascending order. */
1900 static struct table_entry swidth_table[] =
1902 {"compressed", XLFD_SWIDTH_CONDENSED, &Qcondensed},
1903 {"condensed", XLFD_SWIDTH_CONDENSED, &Qcondensed},
1904 {"demiexpanded", XLFD_SWIDTH_SEMI_EXPANDED, &Qsemi_expanded},
1905 {"expanded", XLFD_SWIDTH_EXPANDED, &Qexpanded},
1906 {"extracondensed", XLFD_SWIDTH_EXTRA_CONDENSED, &Qextra_condensed},
1907 {"extraexpanded", XLFD_SWIDTH_EXTRA_EXPANDED, &Qextra_expanded},
1908 {"medium", XLFD_SWIDTH_MEDIUM, &Qnormal},
1909 {"narrow", XLFD_SWIDTH_CONDENSED, &Qcondensed},
1910 {"normal", XLFD_SWIDTH_MEDIUM, &Qnormal},
1911 {"regular", XLFD_SWIDTH_MEDIUM, &Qnormal},
1912 {"semicondensed", XLFD_SWIDTH_SEMI_CONDENSED, &Qsemi_condensed},
1913 {"semiexpanded", XLFD_SWIDTH_SEMI_EXPANDED, &Qsemi_expanded},
1914 {"ultracondensed", XLFD_SWIDTH_ULTRA_CONDENSED, &Qultra_condensed},
1915 {"ultraexpanded", XLFD_SWIDTH_ULTRA_EXPANDED, &Qultra_expanded},
1916 {"wide", XLFD_SWIDTH_EXTRA_EXPANDED, &Qextra_expanded}
1919 /* Structure used to hold the result of splitting font names in XLFD
1920 format into their fields. */
1922 struct font_name
1924 /* The original name which is modified destructively by
1925 split_font_name. The pointer is kept here to be able to free it
1926 if it was allocated from the heap. */
1927 char *name;
1929 /* Font name fields. Each vector element points into `name' above.
1930 Fields are NUL-terminated. */
1931 char *fields[XLFD_LAST];
1933 /* Numeric values for those fields that interest us. See
1934 split_font_name for which these are. */
1935 int numeric[XLFD_LAST];
1937 /* If the original name matches one of Vface_font_rescale_alist,
1938 the value is the corresponding rescale ratio. Otherwise, the
1939 value is 1.0. */
1940 double rescale_ratio;
1942 /* Lower value mean higher priority. */
1943 int registry_priority;
1946 /* The frame in effect when sorting font names. Set temporarily in
1947 sort_fonts so that it is available in font comparison functions. */
1949 static struct frame *font_frame;
1951 /* Order by which font selection chooses fonts. The default values
1952 mean `first, find a best match for the font width, then for the
1953 font height, then for weight, then for slant.' This variable can be
1954 set via set-face-font-sort-order. */
1956 #ifdef MAC_OS
1957 static int font_sort_order[4] = {
1958 XLFD_SWIDTH, XLFD_POINT_SIZE, XLFD_WEIGHT, XLFD_SLANT
1960 #else
1961 static int font_sort_order[4];
1962 #endif
1964 /* Look up FONT.fields[FIELD_INDEX] in TABLE which has DIM entries.
1965 TABLE must be sorted by TABLE[i]->name in ascending order. Value
1966 is a pointer to the matching table entry or null if no table entry
1967 matches. */
1969 static struct table_entry *
1970 xlfd_lookup_field_contents (table, dim, font, field_index)
1971 struct table_entry *table;
1972 int dim;
1973 struct font_name *font;
1974 int field_index;
1976 /* Function split_font_name converts fields to lower-case, so there
1977 is no need to use xstrlwr or xstricmp here. */
1978 char *s = font->fields[field_index];
1979 int low, mid, high, cmp;
1981 low = 0;
1982 high = dim - 1;
1984 while (low <= high)
1986 mid = (low + high) / 2;
1987 cmp = strcmp (table[mid].name, s);
1989 if (cmp < 0)
1990 low = mid + 1;
1991 else if (cmp > 0)
1992 high = mid - 1;
1993 else
1994 return table + mid;
1997 return NULL;
2001 /* Return a numeric representation for font name field
2002 FONT.fields[FIELD_INDEX]. The field is looked up in TABLE which
2003 has DIM entries. Value is the numeric value found or DFLT if no
2004 table entry matches. This function is used to translate weight,
2005 slant, and swidth names of XLFD font names to numeric values. */
2007 static INLINE int
2008 xlfd_numeric_value (table, dim, font, field_index, dflt)
2009 struct table_entry *table;
2010 int dim;
2011 struct font_name *font;
2012 int field_index;
2013 int dflt;
2015 struct table_entry *p;
2016 p = xlfd_lookup_field_contents (table, dim, font, field_index);
2017 return p ? p->numeric : dflt;
2021 /* Return a symbolic representation for font name field
2022 FONT.fields[FIELD_INDEX]. The field is looked up in TABLE which
2023 has DIM entries. Value is the symbolic value found or DFLT if no
2024 table entry matches. This function is used to translate weight,
2025 slant, and swidth names of XLFD font names to symbols. */
2027 static INLINE Lisp_Object
2028 xlfd_symbolic_value (table, dim, font, field_index, dflt)
2029 struct table_entry *table;
2030 int dim;
2031 struct font_name *font;
2032 int field_index;
2033 Lisp_Object dflt;
2035 struct table_entry *p;
2036 p = xlfd_lookup_field_contents (table, dim, font, field_index);
2037 return p ? *p->symbol : dflt;
2041 /* Return a numeric value for the slant of the font given by FONT. */
2043 static INLINE int
2044 xlfd_numeric_slant (font)
2045 struct font_name *font;
2047 return xlfd_numeric_value (slant_table, DIM (slant_table),
2048 font, XLFD_SLANT, XLFD_SLANT_ROMAN);
2052 /* Return a symbol representing the weight of the font given by FONT. */
2054 static INLINE Lisp_Object
2055 xlfd_symbolic_slant (font)
2056 struct font_name *font;
2058 return xlfd_symbolic_value (slant_table, DIM (slant_table),
2059 font, XLFD_SLANT, Qnormal);
2063 /* Return a numeric value for the weight of the font given by FONT. */
2065 static INLINE int
2066 xlfd_numeric_weight (font)
2067 struct font_name *font;
2069 return xlfd_numeric_value (weight_table, DIM (weight_table),
2070 font, XLFD_WEIGHT, XLFD_WEIGHT_MEDIUM);
2074 /* Return a symbol representing the slant of the font given by FONT. */
2076 static INLINE Lisp_Object
2077 xlfd_symbolic_weight (font)
2078 struct font_name *font;
2080 return xlfd_symbolic_value (weight_table, DIM (weight_table),
2081 font, XLFD_WEIGHT, Qnormal);
2085 /* Return a numeric value for the swidth of the font whose XLFD font
2086 name fields are found in FONT. */
2088 static INLINE int
2089 xlfd_numeric_swidth (font)
2090 struct font_name *font;
2092 return xlfd_numeric_value (swidth_table, DIM (swidth_table),
2093 font, XLFD_SWIDTH, XLFD_SWIDTH_MEDIUM);
2097 /* Return a symbolic value for the swidth of FONT. */
2099 static INLINE Lisp_Object
2100 xlfd_symbolic_swidth (font)
2101 struct font_name *font;
2103 return xlfd_symbolic_value (swidth_table, DIM (swidth_table),
2104 font, XLFD_SWIDTH, Qnormal);
2108 /* Look up the entry of SYMBOL in the vector TABLE which has DIM
2109 entries. Value is a pointer to the matching table entry or null if
2110 no element of TABLE contains SYMBOL. */
2112 static struct table_entry *
2113 face_value (table, dim, symbol)
2114 struct table_entry *table;
2115 int dim;
2116 Lisp_Object symbol;
2118 int i;
2120 xassert (SYMBOLP (symbol));
2122 for (i = 0; i < dim; ++i)
2123 if (EQ (*table[i].symbol, symbol))
2124 break;
2126 return i < dim ? table + i : NULL;
2130 /* Return a numeric value for SYMBOL in the vector TABLE which has DIM
2131 entries. Value is -1 if SYMBOL is not found in TABLE. */
2133 static INLINE int
2134 face_numeric_value (table, dim, symbol)
2135 struct table_entry *table;
2136 int dim;
2137 Lisp_Object symbol;
2139 struct table_entry *p = face_value (table, dim, symbol);
2140 return p ? p->numeric : -1;
2144 /* Return a numeric value representing the weight specified by Lisp
2145 symbol WEIGHT. Value is one of the enumerators of enum
2146 xlfd_weight. */
2148 static INLINE int
2149 face_numeric_weight (weight)
2150 Lisp_Object weight;
2152 return face_numeric_value (weight_table, DIM (weight_table), weight);
2156 /* Return a numeric value representing the slant specified by Lisp
2157 symbol SLANT. Value is one of the enumerators of enum xlfd_slant. */
2159 static INLINE int
2160 face_numeric_slant (slant)
2161 Lisp_Object slant;
2163 return face_numeric_value (slant_table, DIM (slant_table), slant);
2167 /* Return a numeric value representing the swidth specified by Lisp
2168 symbol WIDTH. Value is one of the enumerators of enum xlfd_swidth. */
2170 static int
2171 face_numeric_swidth (width)
2172 Lisp_Object width;
2174 return face_numeric_value (swidth_table, DIM (swidth_table), width);
2178 #ifdef HAVE_WINDOW_SYSTEM
2180 /* Return non-zero if FONT is the name of a fixed-pitch font. */
2182 static INLINE int
2183 xlfd_fixed_p (font)
2184 struct font_name *font;
2186 /* Function split_font_name converts fields to lower-case, so there
2187 is no need to use tolower here. */
2188 return *font->fields[XLFD_SPACING] != 'p';
2192 /* Return the point size of FONT on frame F, measured in 1/10 pt.
2194 The actual height of the font when displayed on F depends on the
2195 resolution of both the font and frame. For example, a 10pt font
2196 designed for a 100dpi display will display larger than 10pt on a
2197 75dpi display. (It's not unusual to use fonts not designed for the
2198 display one is using. For example, some intlfonts are available in
2199 72dpi versions, only.)
2201 Value is the real point size of FONT on frame F, or 0 if it cannot
2202 be determined. */
2204 static INLINE int
2205 xlfd_point_size (f, font)
2206 struct frame *f;
2207 struct font_name *font;
2209 double resy = FRAME_X_DISPLAY_INFO (f)->resy;
2210 char *pixel_field = font->fields[XLFD_PIXEL_SIZE];
2211 double pixel;
2212 int real_pt;
2214 if (*pixel_field == '[')
2216 /* The pixel size field is `[A B C D]' which specifies
2217 a transformation matrix.
2219 A B 0
2220 C D 0
2221 0 0 1
2223 by which all glyphs of the font are transformed. The spec
2224 says that s scalar value N for the pixel size is equivalent
2225 to A = N * resx/resy, B = C = 0, D = N. */
2226 char *start = pixel_field + 1, *end;
2227 double matrix[4];
2228 int i;
2230 for (i = 0; i < 4; ++i)
2232 matrix[i] = strtod (start, &end);
2233 start = end;
2236 pixel = matrix[3];
2238 else
2239 pixel = atoi (pixel_field);
2241 if (pixel == 0)
2242 real_pt = 0;
2243 else
2244 real_pt = PT_PER_INCH * 10.0 * pixel / resy + 0.5;
2246 return real_pt;
2250 /* Return point size of PIXEL dots while considering Y-resultion (DPI)
2251 of frame F. This function is used to guess a point size of font
2252 when only the pixel height of the font is available. */
2254 static INLINE int
2255 pixel_point_size (f, pixel)
2256 struct frame *f;
2257 int pixel;
2259 double resy = FRAME_X_DISPLAY_INFO (f)->resy;
2260 double real_pt;
2261 int int_pt;
2263 /* As one inch is PT_PER_INCH points, PT_PER_INCH/RESY gives the
2264 point size of one dot. */
2265 real_pt = pixel * PT_PER_INCH / resy;
2266 int_pt = real_pt + 0.5;
2268 return int_pt;
2272 /* Return a rescaling ratio of a font of NAME. */
2274 static double
2275 font_rescale_ratio (name)
2276 char *name;
2278 Lisp_Object tail, elt;
2280 for (tail = Vface_font_rescale_alist; CONSP (tail); tail = XCDR (tail))
2282 elt = XCAR (tail);
2283 if (STRINGP (XCAR (elt)) && FLOATP (XCDR (elt))
2284 && fast_c_string_match_ignore_case (XCAR (elt), name) >= 0)
2285 return XFLOAT_DATA (XCDR (elt));
2287 return 1.0;
2291 /* Split XLFD font name FONT->name destructively into NUL-terminated,
2292 lower-case fields in FONT->fields. NUMERIC_P non-zero means
2293 compute numeric values for fields XLFD_POINT_SIZE, XLFD_SWIDTH,
2294 XLFD_RESY, XLFD_SLANT, and XLFD_WEIGHT in FONT->numeric. Value is
2295 zero if the font name doesn't have the format we expect. The
2296 expected format is a font name that starts with a `-' and has
2297 XLFD_LAST fields separated by `-'. */
2299 static int
2300 split_font_name (f, font, numeric_p)
2301 struct frame *f;
2302 struct font_name *font;
2303 int numeric_p;
2305 int i = 0;
2306 int success_p;
2307 double rescale_ratio;
2309 if (numeric_p)
2310 /* This must be done before splitting the font name. */
2311 rescale_ratio = font_rescale_ratio (font->name);
2313 if (*font->name == '-')
2315 char *p = xstrlwr (font->name) + 1;
2317 while (i < XLFD_LAST)
2319 font->fields[i] = p;
2320 ++i;
2322 /* Pixel and point size may be of the form `[....]'. For
2323 BNF, see XLFD spec, chapter 4. Negative values are
2324 indicated by tilde characters which we replace with
2325 `-' characters, here. */
2326 if (*p == '['
2327 && (i - 1 == XLFD_PIXEL_SIZE
2328 || i - 1 == XLFD_POINT_SIZE))
2330 char *start, *end;
2331 int j;
2333 for (++p; *p && *p != ']'; ++p)
2334 if (*p == '~')
2335 *p = '-';
2337 /* Check that the matrix contains 4 floating point
2338 numbers. */
2339 for (j = 0, start = font->fields[i - 1] + 1;
2340 j < 4;
2341 ++j, start = end)
2342 if (strtod (start, &end) == 0 && start == end)
2343 break;
2345 if (j < 4)
2346 break;
2349 while (*p && *p != '-')
2350 ++p;
2352 if (*p != '-')
2353 break;
2355 *p++ = 0;
2359 success_p = i == XLFD_LAST;
2361 /* If requested, and font name was in the expected format,
2362 compute numeric values for some fields. */
2363 if (numeric_p && success_p)
2365 font->numeric[XLFD_POINT_SIZE] = xlfd_point_size (f, font);
2366 font->numeric[XLFD_RESY] = atoi (font->fields[XLFD_RESY]);
2367 font->numeric[XLFD_SLANT] = xlfd_numeric_slant (font);
2368 font->numeric[XLFD_WEIGHT] = xlfd_numeric_weight (font);
2369 font->numeric[XLFD_SWIDTH] = xlfd_numeric_swidth (font);
2370 font->numeric[XLFD_AVGWIDTH] = atoi (font->fields[XLFD_AVGWIDTH]);
2371 font->rescale_ratio = rescale_ratio;
2374 /* Initialize it to zero. It will be overridden by font_list while
2375 trying alternate registries. */
2376 font->registry_priority = 0;
2378 return success_p;
2382 /* Build an XLFD font name from font name fields in FONT. Value is a
2383 pointer to the font name, which is allocated via xmalloc. */
2385 static char *
2386 build_font_name (font)
2387 struct font_name *font;
2389 int i;
2390 int size = 100;
2391 char *font_name = (char *) xmalloc (size);
2392 int total_length = 0;
2394 for (i = 0; i < XLFD_LAST; ++i)
2396 /* Add 1 because of the leading `-'. */
2397 int len = strlen (font->fields[i]) + 1;
2399 /* Reallocate font_name if necessary. Add 1 for the final
2400 NUL-byte. */
2401 if (total_length + len + 1 >= size)
2403 int new_size = max (2 * size, size + len + 1);
2404 int sz = new_size * sizeof *font_name;
2405 font_name = (char *) xrealloc (font_name, sz);
2406 size = new_size;
2409 font_name[total_length] = '-';
2410 bcopy (font->fields[i], font_name + total_length + 1, len - 1);
2411 total_length += len;
2414 font_name[total_length] = 0;
2415 return font_name;
2419 /* Free an array FONTS of N font_name structures. This frees FONTS
2420 itself and all `name' fields in its elements. */
2422 static INLINE void
2423 free_font_names (fonts, n)
2424 struct font_name *fonts;
2425 int n;
2427 while (n)
2428 xfree (fonts[--n].name);
2429 xfree (fonts);
2433 /* Sort vector FONTS of font_name structures which contains NFONTS
2434 elements using qsort and comparison function CMPFN. F is the frame
2435 on which the fonts will be used. The global variable font_frame
2436 is temporarily set to F to make it available in CMPFN. */
2438 static INLINE void
2439 sort_fonts (f, fonts, nfonts, cmpfn)
2440 struct frame *f;
2441 struct font_name *fonts;
2442 int nfonts;
2443 int (*cmpfn) P_ ((const void *, const void *));
2445 font_frame = f;
2446 qsort (fonts, nfonts, sizeof *fonts, cmpfn);
2447 font_frame = NULL;
2451 /* Get fonts matching PATTERN on frame F. If F is null, use the first
2452 display in x_display_list. FONTS is a pointer to a vector of
2453 NFONTS font_name structures. TRY_ALTERNATIVES_P non-zero means try
2454 alternative patterns from Valternate_fontname_alist if no fonts are
2455 found matching PATTERN.
2457 For all fonts found, set FONTS[i].name to the name of the font,
2458 allocated via xmalloc, and split font names into fields. Ignore
2459 fonts that we can't parse. Value is the number of fonts found. */
2461 static int
2462 x_face_list_fonts (f, pattern, pfonts, nfonts, try_alternatives_p)
2463 struct frame *f;
2464 char *pattern;
2465 struct font_name **pfonts;
2466 int nfonts, try_alternatives_p;
2468 int n, nignored;
2470 /* NTEMACS_TODO : currently this uses w32_list_fonts, but it may be
2471 better to do it the other way around. */
2472 Lisp_Object lfonts;
2473 Lisp_Object lpattern, tem;
2474 struct font_name *fonts = 0;
2475 int num_fonts = nfonts;
2477 *pfonts = 0;
2478 lpattern = build_string (pattern);
2480 /* Get the list of fonts matching PATTERN. */
2481 #ifdef WINDOWSNT
2482 BLOCK_INPUT;
2483 lfonts = w32_list_fonts (f, lpattern, 0, nfonts);
2484 UNBLOCK_INPUT;
2485 #else
2486 lfonts = x_list_fonts (f, lpattern, -1, nfonts);
2487 #endif
2489 if (nfonts < 0 && CONSP (lfonts))
2490 num_fonts = XFASTINT (Flength (lfonts));
2492 /* Make a copy of the font names we got from X, and
2493 split them into fields. */
2494 n = nignored = 0;
2495 for (tem = lfonts; CONSP (tem) && n < num_fonts; tem = XCDR (tem))
2497 Lisp_Object elt, tail;
2498 const char *name = SDATA (XCAR (tem));
2500 /* Ignore fonts matching a pattern from face-ignored-fonts. */
2501 for (tail = Vface_ignored_fonts; CONSP (tail); tail = XCDR (tail))
2503 elt = XCAR (tail);
2504 if (STRINGP (elt)
2505 && fast_c_string_match_ignore_case (elt, name) >= 0)
2506 break;
2508 if (!NILP (tail))
2510 ++nignored;
2511 continue;
2514 if (! fonts)
2516 *pfonts = (struct font_name *) xmalloc (num_fonts * sizeof **pfonts);
2517 fonts = *pfonts;
2520 /* Make a copy of the font name. */
2521 fonts[n].name = xstrdup (name);
2523 if (split_font_name (f, fonts + n, 1))
2525 if (font_scalable_p (fonts + n)
2526 && !may_use_scalable_font_p (name))
2528 ++nignored;
2529 xfree (fonts[n].name);
2531 else
2532 ++n;
2534 else
2535 xfree (fonts[n].name);
2538 /* If no fonts found, try patterns from Valternate_fontname_alist. */
2539 if (n == 0 && try_alternatives_p)
2541 Lisp_Object list = Valternate_fontname_alist;
2543 if (*pfonts)
2545 xfree (*pfonts);
2546 *pfonts = 0;
2549 while (CONSP (list))
2551 Lisp_Object entry = XCAR (list);
2552 if (CONSP (entry)
2553 && STRINGP (XCAR (entry))
2554 && strcmp (SDATA (XCAR (entry)), pattern) == 0)
2555 break;
2556 list = XCDR (list);
2559 if (CONSP (list))
2561 Lisp_Object patterns = XCAR (list);
2562 Lisp_Object name;
2564 while (CONSP (patterns)
2565 /* If list is screwed up, give up. */
2566 && (name = XCAR (patterns),
2567 STRINGP (name))
2568 /* Ignore patterns equal to PATTERN because we tried that
2569 already with no success. */
2570 && (strcmp (SDATA (name), pattern) == 0
2571 || (n = x_face_list_fonts (f, SDATA (name),
2572 pfonts, nfonts, 0),
2573 n == 0)))
2574 patterns = XCDR (patterns);
2578 return n;
2582 /* Check if a font matching pattern_offset_t on frame F is available
2583 or not. PATTERN may be a cons (FAMILY . REGISTRY), in which case,
2584 a font name pattern is generated from FAMILY and REGISTRY. */
2587 face_font_available_p (f, pattern)
2588 struct frame *f;
2589 Lisp_Object pattern;
2591 Lisp_Object fonts;
2593 if (! STRINGP (pattern))
2595 Lisp_Object family, registry;
2596 char *family_str, *registry_str, *pattern_str;
2598 CHECK_CONS (pattern);
2599 family = XCAR (pattern);
2600 if (NILP (family))
2601 family_str = "*";
2602 else
2604 CHECK_STRING (family);
2605 family_str = (char *) SDATA (family);
2607 registry = XCDR (pattern);
2608 if (NILP (registry))
2609 registry_str = "*";
2610 else
2612 CHECK_STRING (registry);
2613 registry_str = (char *) SDATA (registry);
2616 pattern_str = (char *) alloca (strlen (family_str)
2617 + strlen (registry_str)
2618 + 10);
2619 strcpy (pattern_str, index (family_str, '-') ? "-" : "-*-");
2620 strcat (pattern_str, family_str);
2621 strcat (pattern_str, "-*-");
2622 strcat (pattern_str, registry_str);
2623 if (!index (registry_str, '-'))
2625 if (registry_str[strlen (registry_str) - 1] == '*')
2626 strcat (pattern_str, "-*");
2627 else
2628 strcat (pattern_str, "*-*");
2630 pattern = build_string (pattern_str);
2633 /* Get the list of fonts matching PATTERN. */
2634 #ifdef WINDOWSNT
2635 BLOCK_INPUT;
2636 fonts = w32_list_fonts (f, pattern, 0, 1);
2637 UNBLOCK_INPUT;
2638 #else
2639 fonts = x_list_fonts (f, pattern, -1, 1);
2640 #endif
2641 return XINT (Flength (fonts));
2645 /* Determine fonts matching PATTERN on frame F. Sort resulting fonts
2646 using comparison function CMPFN. Value is the number of fonts
2647 found. If value is non-zero, *FONTS is set to a vector of
2648 font_name structures allocated from the heap containing matching
2649 fonts. Each element of *FONTS contains a name member that is also
2650 allocated from the heap. Font names in these structures are split
2651 into fields. Use free_font_names to free such an array. */
2653 static int
2654 sorted_font_list (f, pattern, cmpfn, fonts)
2655 struct frame *f;
2656 char *pattern;
2657 int (*cmpfn) P_ ((const void *, const void *));
2658 struct font_name **fonts;
2660 int nfonts;
2662 /* Get the list of fonts matching pattern. 100 should suffice. */
2663 nfonts = DEFAULT_FONT_LIST_LIMIT;
2664 if (INTEGERP (Vfont_list_limit))
2665 nfonts = XINT (Vfont_list_limit);
2667 *fonts = NULL;
2668 nfonts = x_face_list_fonts (f, pattern, fonts, nfonts, 1);
2670 /* Sort the resulting array and return it in *FONTS. If no
2671 fonts were found, make sure to set *FONTS to null. */
2672 if (nfonts)
2673 sort_fonts (f, *fonts, nfonts, cmpfn);
2674 else if (*fonts)
2676 xfree (*fonts);
2677 *fonts = NULL;
2680 return nfonts;
2684 /* Compare two font_name structures *A and *B. Value is analogous to
2685 strcmp. Sort order is given by the global variable
2686 font_sort_order. Font names are sorted so that, everything else
2687 being equal, fonts with a resolution closer to that of the frame on
2688 which they are used are listed first. The global variable
2689 font_frame is the frame on which we operate. */
2691 static int
2692 cmp_font_names (a, b)
2693 const void *a, *b;
2695 struct font_name *x = (struct font_name *) a;
2696 struct font_name *y = (struct font_name *) b;
2697 int cmp;
2699 /* All strings have been converted to lower-case by split_font_name,
2700 so we can use strcmp here. */
2701 cmp = strcmp (x->fields[XLFD_FAMILY], y->fields[XLFD_FAMILY]);
2702 if (cmp == 0)
2704 int i;
2706 for (i = 0; i < DIM (font_sort_order) && cmp == 0; ++i)
2708 int j = font_sort_order[i];
2709 cmp = x->numeric[j] - y->numeric[j];
2712 if (cmp == 0)
2714 /* Everything else being equal, we prefer fonts with an
2715 y-resolution closer to that of the frame. */
2716 int resy = FRAME_X_DISPLAY_INFO (font_frame)->resy;
2717 int x_resy = x->numeric[XLFD_RESY];
2718 int y_resy = y->numeric[XLFD_RESY];
2719 cmp = abs (resy - x_resy) - abs (resy - y_resy);
2723 return cmp;
2727 /* Get a sorted list of fonts of family FAMILY on frame F. If PATTERN
2728 is non-nil list fonts matching that pattern. Otherwise, if
2729 REGISTRY is non-nil return only fonts with that registry, otherwise
2730 return fonts of any registry. Set *FONTS to a vector of font_name
2731 structures allocated from the heap containing the fonts found.
2732 Value is the number of fonts found. */
2734 static int
2735 font_list_1 (f, pattern, family, registry, fonts)
2736 struct frame *f;
2737 Lisp_Object pattern, family, registry;
2738 struct font_name **fonts;
2740 char *pattern_str, *family_str, *registry_str;
2742 if (NILP (pattern))
2744 family_str = (NILP (family) ? "*" : (char *) SDATA (family));
2745 registry_str = (NILP (registry) ? "*" : (char *) SDATA (registry));
2747 pattern_str = (char *) alloca (strlen (family_str)
2748 + strlen (registry_str)
2749 + 10);
2750 strcpy (pattern_str, index (family_str, '-') ? "-" : "-*-");
2751 strcat (pattern_str, family_str);
2752 strcat (pattern_str, "-*-");
2753 strcat (pattern_str, registry_str);
2754 if (!index (registry_str, '-'))
2756 if (registry_str[strlen (registry_str) - 1] == '*')
2757 strcat (pattern_str, "-*");
2758 else
2759 strcat (pattern_str, "*-*");
2762 else
2763 pattern_str = (char *) SDATA (pattern);
2765 return sorted_font_list (f, pattern_str, cmp_font_names, fonts);
2769 /* Concatenate font list FONTS1 and FONTS2. FONTS1 and FONTS2
2770 contains NFONTS1 fonts and NFONTS2 fonts respectively. Return a
2771 pointer to a newly allocated font list. FONTS1 and FONTS2 are
2772 freed. */
2774 static struct font_name *
2775 concat_font_list (fonts1, nfonts1, fonts2, nfonts2)
2776 struct font_name *fonts1, *fonts2;
2777 int nfonts1, nfonts2;
2779 int new_nfonts = nfonts1 + nfonts2;
2780 struct font_name *new_fonts;
2782 new_fonts = (struct font_name *) xmalloc (sizeof *new_fonts * new_nfonts);
2783 bcopy (fonts1, new_fonts, sizeof *new_fonts * nfonts1);
2784 bcopy (fonts2, new_fonts + nfonts1, sizeof *new_fonts * nfonts2);
2785 xfree (fonts1);
2786 xfree (fonts2);
2787 return new_fonts;
2791 /* Get a sorted list of fonts of family FAMILY on frame F.
2793 If PATTERN is non-nil list fonts matching that pattern.
2795 If REGISTRY is non-nil, return fonts with that registry and the
2796 alternative registries from Vface_alternative_font_registry_alist.
2798 If REGISTRY is nil return fonts of any registry.
2800 Set *FONTS to a vector of font_name structures allocated from the
2801 heap containing the fonts found. Value is the number of fonts
2802 found. */
2804 static int
2805 font_list (f, pattern, family, registry, fonts)
2806 struct frame *f;
2807 Lisp_Object pattern, family, registry;
2808 struct font_name **fonts;
2810 int nfonts = font_list_1 (f, pattern, family, registry, fonts);
2812 if (!NILP (registry)
2813 && CONSP (Vface_alternative_font_registry_alist))
2815 Lisp_Object alter;
2817 alter = Fassoc (registry, Vface_alternative_font_registry_alist);
2818 if (CONSP (alter))
2820 int reg_prio, i;
2822 for (alter = XCDR (alter), reg_prio = 1;
2823 CONSP (alter);
2824 alter = XCDR (alter), reg_prio++)
2825 if (STRINGP (XCAR (alter)))
2827 int nfonts2;
2828 struct font_name *fonts2;
2830 nfonts2 = font_list_1 (f, pattern, family, XCAR (alter),
2831 &fonts2);
2832 for (i = 0; i < nfonts2; i++)
2833 fonts2[i].registry_priority = reg_prio;
2834 *fonts = (nfonts > 0
2835 ? concat_font_list (*fonts, nfonts, fonts2, nfonts2)
2836 : fonts2);
2837 nfonts += nfonts2;
2842 return nfonts;
2846 /* Remove elements from LIST whose cars are `equal'. Called from
2847 x-family-fonts and x-font-family-list to remove duplicate font
2848 entries. */
2850 static void
2851 remove_duplicates (list)
2852 Lisp_Object list;
2854 Lisp_Object tail = list;
2856 while (!NILP (tail) && !NILP (XCDR (tail)))
2858 Lisp_Object next = XCDR (tail);
2859 if (!NILP (Fequal (XCAR (next), XCAR (tail))))
2860 XSETCDR (tail, XCDR (next));
2861 else
2862 tail = XCDR (tail);
2867 DEFUN ("x-family-fonts", Fx_family_fonts, Sx_family_fonts, 0, 2, 0,
2868 doc: /* Return a list of available fonts of family FAMILY on FRAME.
2869 If FAMILY is omitted or nil, list all families.
2870 Otherwise, FAMILY must be a string, possibly containing wildcards
2871 `?' and `*'.
2872 If FRAME is omitted or nil, use the selected frame.
2873 Each element of the result is a vector [FAMILY WIDTH POINT-SIZE WEIGHT
2874 SLANT FIXED-P FULL REGISTRY-AND-ENCODING].
2875 FAMILY is the font family name. POINT-SIZE is the size of the
2876 font in 1/10 pt. WIDTH, WEIGHT, and SLANT are symbols describing the
2877 width, weight and slant of the font. These symbols are the same as for
2878 face attributes. FIXED-P is non-nil if the font is fixed-pitch.
2879 FULL is the full name of the font, and REGISTRY-AND-ENCODING is a string
2880 giving the registry and encoding of the font.
2881 The result list is sorted according to the current setting of
2882 the face font sort order. */)
2883 (family, frame)
2884 Lisp_Object family, frame;
2886 struct frame *f = check_x_frame (frame);
2887 struct font_name *fonts;
2888 int i, nfonts;
2889 Lisp_Object result;
2890 struct gcpro gcpro1;
2892 if (!NILP (family))
2893 CHECK_STRING (family);
2895 result = Qnil;
2896 GCPRO1 (result);
2897 nfonts = font_list (f, Qnil, family, Qnil, &fonts);
2898 for (i = nfonts - 1; i >= 0; --i)
2900 Lisp_Object v = Fmake_vector (make_number (8), Qnil);
2901 char *tem;
2903 ASET (v, 0, build_string (fonts[i].fields[XLFD_FAMILY]));
2904 ASET (v, 1, xlfd_symbolic_swidth (fonts + i));
2905 ASET (v, 2, make_number (xlfd_point_size (f, fonts + i)));
2906 ASET (v, 3, xlfd_symbolic_weight (fonts + i));
2907 ASET (v, 4, xlfd_symbolic_slant (fonts + i));
2908 ASET (v, 5, xlfd_fixed_p (fonts + i) ? Qt : Qnil);
2909 tem = build_font_name (fonts + i);
2910 ASET (v, 6, build_string (tem));
2911 sprintf (tem, "%s-%s", fonts[i].fields[XLFD_REGISTRY],
2912 fonts[i].fields[XLFD_ENCODING]);
2913 ASET (v, 7, build_string (tem));
2914 xfree (tem);
2916 result = Fcons (v, result);
2919 remove_duplicates (result);
2920 free_font_names (fonts, nfonts);
2921 UNGCPRO;
2922 return result;
2926 DEFUN ("x-font-family-list", Fx_font_family_list, Sx_font_family_list,
2927 0, 1, 0,
2928 doc: /* Return a list of available font families on FRAME.
2929 If FRAME is omitted or nil, use the selected frame.
2930 Value is a list of conses (FAMILY . FIXED-P) where FAMILY
2931 is a font family, and FIXED-P is non-nil if fonts of that family
2932 are fixed-pitch. */)
2933 (frame)
2934 Lisp_Object frame;
2936 struct frame *f = check_x_frame (frame);
2937 int nfonts, i;
2938 struct font_name *fonts;
2939 Lisp_Object result;
2940 struct gcpro gcpro1;
2941 int count = SPECPDL_INDEX ();
2943 /* Let's consider all fonts. */
2944 specbind (intern ("font-list-limit"), make_number (-1));
2945 nfonts = font_list (f, Qnil, Qnil, Qnil, &fonts);
2947 result = Qnil;
2948 GCPRO1 (result);
2949 for (i = nfonts - 1; i >= 0; --i)
2950 result = Fcons (Fcons (build_string (fonts[i].fields[XLFD_FAMILY]),
2951 xlfd_fixed_p (fonts + i) ? Qt : Qnil),
2952 result);
2954 remove_duplicates (result);
2955 free_font_names (fonts, nfonts);
2956 UNGCPRO;
2957 return unbind_to (count, result);
2961 DEFUN ("x-list-fonts", Fx_list_fonts, Sx_list_fonts, 1, 5, 0,
2962 doc: /* Return a list of the names of available fonts matching PATTERN.
2963 If optional arguments FACE and FRAME are specified, return only fonts
2964 the same size as FACE on FRAME.
2965 PATTERN is a string, perhaps with wildcard characters;
2966 the * character matches any substring, and
2967 the ? character matches any single character.
2968 PATTERN is case-insensitive.
2969 FACE is a face name--a symbol.
2971 The return value is a list of strings, suitable as arguments to
2972 set-face-font.
2974 Fonts Emacs can't use may or may not be excluded
2975 even if they match PATTERN and FACE.
2976 The optional fourth argument MAXIMUM sets a limit on how many
2977 fonts to match. The first MAXIMUM fonts are reported.
2978 The optional fifth argument WIDTH, if specified, is a number of columns
2979 occupied by a character of a font. In that case, return only fonts
2980 the WIDTH times as wide as FACE on FRAME. */)
2981 (pattern, face, frame, maximum, width)
2982 Lisp_Object pattern, face, frame, maximum, width;
2984 struct frame *f;
2985 int size;
2986 int maxnames;
2988 check_x ();
2989 CHECK_STRING (pattern);
2991 if (NILP (maximum))
2992 maxnames = -1;
2993 else
2995 CHECK_NATNUM (maximum);
2996 maxnames = XINT (maximum);
2999 if (!NILP (width))
3000 CHECK_NUMBER (width);
3002 /* We can't simply call check_x_frame because this function may be
3003 called before any frame is created. */
3004 f = frame_or_selected_frame (frame, 2);
3005 if (!FRAME_WINDOW_P (f))
3007 /* Perhaps we have not yet created any frame. */
3008 f = NULL;
3009 face = Qnil;
3012 /* Determine the width standard for comparison with the fonts we find. */
3014 if (NILP (face))
3015 size = 0;
3016 else
3018 /* This is of limited utility since it works with character
3019 widths. Keep it for compatibility. --gerd. */
3020 int face_id = lookup_named_face (f, face, 0, 0);
3021 struct face *face = (face_id < 0
3022 ? NULL
3023 : FACE_FROM_ID (f, face_id));
3025 #ifdef WINDOWSNT
3026 /* For historic reasons, FONT_WIDTH refers to average width on W32,
3027 not maximum as on X. Redefine here. */
3028 #undef FONT_WIDTH
3029 #define FONT_WIDTH FONT_MAX_WIDTH
3030 #endif
3032 if (face && face->font)
3033 size = FONT_WIDTH (face->font);
3034 else
3035 size = FONT_WIDTH (FRAME_FONT (f)); /* FRAME_COLUMN_WIDTH (f) */
3037 if (!NILP (width))
3038 size *= XINT (width);
3042 Lisp_Object args[2];
3044 args[0] = x_list_fonts (f, pattern, size, maxnames);
3045 if (f == NULL)
3046 /* We don't have to check fontsets. */
3047 return args[0];
3048 args[1] = list_fontsets (f, pattern, size);
3049 return Fnconc (2, args);
3053 #endif /* HAVE_WINDOW_SYSTEM */
3057 /***********************************************************************
3058 Lisp Faces
3059 ***********************************************************************/
3061 /* Access face attributes of face LFACE, a Lisp vector. */
3063 #define LFACE_FAMILY(LFACE) AREF ((LFACE), LFACE_FAMILY_INDEX)
3064 #define LFACE_HEIGHT(LFACE) AREF ((LFACE), LFACE_HEIGHT_INDEX)
3065 #define LFACE_WEIGHT(LFACE) AREF ((LFACE), LFACE_WEIGHT_INDEX)
3066 #define LFACE_SLANT(LFACE) AREF ((LFACE), LFACE_SLANT_INDEX)
3067 #define LFACE_UNDERLINE(LFACE) AREF ((LFACE), LFACE_UNDERLINE_INDEX)
3068 #define LFACE_INVERSE(LFACE) AREF ((LFACE), LFACE_INVERSE_INDEX)
3069 #define LFACE_FOREGROUND(LFACE) AREF ((LFACE), LFACE_FOREGROUND_INDEX)
3070 #define LFACE_BACKGROUND(LFACE) AREF ((LFACE), LFACE_BACKGROUND_INDEX)
3071 #define LFACE_STIPPLE(LFACE) AREF ((LFACE), LFACE_STIPPLE_INDEX)
3072 #define LFACE_SWIDTH(LFACE) AREF ((LFACE), LFACE_SWIDTH_INDEX)
3073 #define LFACE_OVERLINE(LFACE) AREF ((LFACE), LFACE_OVERLINE_INDEX)
3074 #define LFACE_STRIKE_THROUGH(LFACE) AREF ((LFACE), LFACE_STRIKE_THROUGH_INDEX)
3075 #define LFACE_BOX(LFACE) AREF ((LFACE), LFACE_BOX_INDEX)
3076 #define LFACE_FONT(LFACE) AREF ((LFACE), LFACE_FONT_INDEX)
3077 #define LFACE_INHERIT(LFACE) AREF ((LFACE), LFACE_INHERIT_INDEX)
3078 #define LFACE_AVGWIDTH(LFACE) AREF ((LFACE), LFACE_AVGWIDTH_INDEX)
3080 /* Non-zero if LFACE is a Lisp face. A Lisp face is a vector of size
3081 LFACE_VECTOR_SIZE which has the symbol `face' in slot 0. */
3083 #define LFACEP(LFACE) \
3084 (VECTORP (LFACE) \
3085 && XVECTOR (LFACE)->size == LFACE_VECTOR_SIZE \
3086 && EQ (AREF (LFACE, 0), Qface))
3089 #if GLYPH_DEBUG
3091 /* Check consistency of Lisp face attribute vector ATTRS. */
3093 static void
3094 check_lface_attrs (attrs)
3095 Lisp_Object *attrs;
3097 xassert (UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
3098 || IGNORE_DEFFACE_P (attrs[LFACE_FAMILY_INDEX])
3099 || STRINGP (attrs[LFACE_FAMILY_INDEX]));
3100 xassert (UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
3101 || IGNORE_DEFFACE_P (attrs[LFACE_SWIDTH_INDEX])
3102 || SYMBOLP (attrs[LFACE_SWIDTH_INDEX]));
3103 xassert (UNSPECIFIEDP (attrs[LFACE_AVGWIDTH_INDEX])
3104 || IGNORE_DEFFACE_P (attrs[LFACE_AVGWIDTH_INDEX])
3105 || INTEGERP (attrs[LFACE_AVGWIDTH_INDEX]));
3106 xassert (UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
3107 || IGNORE_DEFFACE_P (attrs[LFACE_HEIGHT_INDEX])
3108 || INTEGERP (attrs[LFACE_HEIGHT_INDEX])
3109 || FLOATP (attrs[LFACE_HEIGHT_INDEX])
3110 || FUNCTIONP (attrs[LFACE_HEIGHT_INDEX]));
3111 xassert (UNSPECIFIEDP (attrs[LFACE_WEIGHT_INDEX])
3112 || IGNORE_DEFFACE_P (attrs[LFACE_WEIGHT_INDEX])
3113 || SYMBOLP (attrs[LFACE_WEIGHT_INDEX]));
3114 xassert (UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX])
3115 || IGNORE_DEFFACE_P (attrs[LFACE_SLANT_INDEX])
3116 || SYMBOLP (attrs[LFACE_SLANT_INDEX]));
3117 xassert (UNSPECIFIEDP (attrs[LFACE_UNDERLINE_INDEX])
3118 || IGNORE_DEFFACE_P (attrs[LFACE_UNDERLINE_INDEX])
3119 || SYMBOLP (attrs[LFACE_UNDERLINE_INDEX])
3120 || STRINGP (attrs[LFACE_UNDERLINE_INDEX]));
3121 xassert (UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
3122 || IGNORE_DEFFACE_P (attrs[LFACE_OVERLINE_INDEX])
3123 || SYMBOLP (attrs[LFACE_OVERLINE_INDEX])
3124 || STRINGP (attrs[LFACE_OVERLINE_INDEX]));
3125 xassert (UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
3126 || IGNORE_DEFFACE_P (attrs[LFACE_STRIKE_THROUGH_INDEX])
3127 || SYMBOLP (attrs[LFACE_STRIKE_THROUGH_INDEX])
3128 || STRINGP (attrs[LFACE_STRIKE_THROUGH_INDEX]));
3129 xassert (UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
3130 || IGNORE_DEFFACE_P (attrs[LFACE_BOX_INDEX])
3131 || SYMBOLP (attrs[LFACE_BOX_INDEX])
3132 || STRINGP (attrs[LFACE_BOX_INDEX])
3133 || INTEGERP (attrs[LFACE_BOX_INDEX])
3134 || CONSP (attrs[LFACE_BOX_INDEX]));
3135 xassert (UNSPECIFIEDP (attrs[LFACE_INVERSE_INDEX])
3136 || IGNORE_DEFFACE_P (attrs[LFACE_INVERSE_INDEX])
3137 || SYMBOLP (attrs[LFACE_INVERSE_INDEX]));
3138 xassert (UNSPECIFIEDP (attrs[LFACE_FOREGROUND_INDEX])
3139 || IGNORE_DEFFACE_P (attrs[LFACE_FOREGROUND_INDEX])
3140 || STRINGP (attrs[LFACE_FOREGROUND_INDEX]));
3141 xassert (UNSPECIFIEDP (attrs[LFACE_BACKGROUND_INDEX])
3142 || IGNORE_DEFFACE_P (attrs[LFACE_BACKGROUND_INDEX])
3143 || STRINGP (attrs[LFACE_BACKGROUND_INDEX]));
3144 xassert (UNSPECIFIEDP (attrs[LFACE_INHERIT_INDEX])
3145 || IGNORE_DEFFACE_P (attrs[LFACE_INHERIT_INDEX])
3146 || NILP (attrs[LFACE_INHERIT_INDEX])
3147 || SYMBOLP (attrs[LFACE_INHERIT_INDEX])
3148 || CONSP (attrs[LFACE_INHERIT_INDEX]));
3149 #ifdef HAVE_WINDOW_SYSTEM
3150 xassert (UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
3151 || IGNORE_DEFFACE_P (attrs[LFACE_STIPPLE_INDEX])
3152 || SYMBOLP (attrs[LFACE_STIPPLE_INDEX])
3153 || !NILP (Fbitmap_spec_p (attrs[LFACE_STIPPLE_INDEX])));
3154 xassert (UNSPECIFIEDP (attrs[LFACE_FONT_INDEX])
3155 || IGNORE_DEFFACE_P (attrs[LFACE_FONT_INDEX])
3156 || NILP (attrs[LFACE_FONT_INDEX])
3157 || STRINGP (attrs[LFACE_FONT_INDEX]));
3158 #endif
3162 /* Check consistency of attributes of Lisp face LFACE (a Lisp vector). */
3164 static void
3165 check_lface (lface)
3166 Lisp_Object lface;
3168 if (!NILP (lface))
3170 xassert (LFACEP (lface));
3171 check_lface_attrs (XVECTOR (lface)->contents);
3175 #else /* GLYPH_DEBUG == 0 */
3177 #define check_lface_attrs(attrs) (void) 0
3178 #define check_lface(lface) (void) 0
3180 #endif /* GLYPH_DEBUG == 0 */
3184 /* Face-merge cycle checking. */
3186 /* A `named merge point' is simply a point during face-merging where we
3187 look up a face by name. We keep a stack of which named lookups we're
3188 currently processing so that we can easily detect cycles, using a
3189 linked- list of struct named_merge_point structures, typically
3190 allocated on the stack frame of the named lookup functions which are
3191 active (so no consing is required). */
3192 struct named_merge_point
3194 Lisp_Object face_name;
3195 struct named_merge_point *prev;
3199 /* If a face merging cycle is detected for FACE_NAME, return 0,
3200 otherwise add NEW_NAMED_MERGE_POINT, which is initialized using
3201 FACE_NAME, as the head of the linked list pointed to by
3202 NAMED_MERGE_POINTS, and return 1. */
3204 static INLINE int
3205 push_named_merge_point (struct named_merge_point *new_named_merge_point,
3206 Lisp_Object face_name,
3207 struct named_merge_point **named_merge_points)
3209 struct named_merge_point *prev;
3211 for (prev = *named_merge_points; prev; prev = prev->prev)
3212 if (EQ (face_name, prev->face_name))
3213 return 0;
3215 new_named_merge_point->face_name = face_name;
3216 new_named_merge_point->prev = *named_merge_points;
3218 *named_merge_points = new_named_merge_point;
3220 return 1;
3226 /* Resolve face name FACE_NAME. If FACE_NAME is a string, intern it
3227 to make it a symbol. If FACE_NAME is an alias for another face,
3228 return that face's name.
3230 Return default face in case of errors. */
3232 static Lisp_Object
3233 resolve_face_name (face_name, signal_p)
3234 Lisp_Object face_name;
3235 int signal_p;
3237 Lisp_Object orig_face;
3238 Lisp_Object tortoise, hare;
3240 if (STRINGP (face_name))
3241 face_name = intern (SDATA (face_name));
3243 if (NILP (face_name) || !SYMBOLP (face_name))
3244 return face_name;
3246 orig_face = face_name;
3247 tortoise = hare = face_name;
3249 while (1)
3251 face_name = hare;
3252 hare = Fget (hare, Qface_alias);
3253 if (NILP (hare) || !SYMBOLP (hare))
3254 break;
3256 face_name = hare;
3257 hare = Fget (hare, Qface_alias);
3258 if (NILP (hare) || !SYMBOLP (hare))
3259 break;
3261 tortoise = Fget (tortoise, Qface_alias);
3262 if (EQ (hare, tortoise))
3264 if (signal_p)
3265 xsignal1 (Qcircular_list, orig_face);
3266 return Qdefault;
3270 return face_name;
3274 /* Return the face definition of FACE_NAME on frame F. F null means
3275 return the definition for new frames. FACE_NAME may be a string or
3276 a symbol (apparently Emacs 20.2 allowed strings as face names in
3277 face text properties; Ediff uses that). If FACE_NAME is an alias
3278 for another face, return that face's definition. If SIGNAL_P is
3279 non-zero, signal an error if FACE_NAME is not a valid face name.
3280 If SIGNAL_P is zero, value is nil if FACE_NAME is not a valid face
3281 name. */
3283 static INLINE Lisp_Object
3284 lface_from_face_name (f, face_name, signal_p)
3285 struct frame *f;
3286 Lisp_Object face_name;
3287 int signal_p;
3289 Lisp_Object lface;
3291 face_name = resolve_face_name (face_name, signal_p);
3293 if (f)
3294 lface = assq_no_quit (face_name, f->face_alist);
3295 else
3296 lface = assq_no_quit (face_name, Vface_new_frame_defaults);
3298 if (CONSP (lface))
3299 lface = XCDR (lface);
3300 else if (signal_p)
3301 signal_error ("Invalid face", face_name);
3303 check_lface (lface);
3304 return lface;
3308 /* Get face attributes of face FACE_NAME from frame-local faces on
3309 frame F. Store the resulting attributes in ATTRS which must point
3310 to a vector of Lisp_Objects of size LFACE_VECTOR_SIZE. If SIGNAL_P
3311 is non-zero, signal an error if FACE_NAME does not name a face.
3312 Otherwise, value is zero if FACE_NAME is not a face. */
3314 static INLINE int
3315 get_lface_attributes (f, face_name, attrs, signal_p)
3316 struct frame *f;
3317 Lisp_Object face_name;
3318 Lisp_Object *attrs;
3319 int signal_p;
3321 Lisp_Object lface;
3322 int success_p;
3324 lface = lface_from_face_name (f, face_name, signal_p);
3325 if (!NILP (lface))
3327 bcopy (XVECTOR (lface)->contents, attrs,
3328 LFACE_VECTOR_SIZE * sizeof *attrs);
3329 success_p = 1;
3331 else
3332 success_p = 0;
3334 return success_p;
3338 /* Non-zero if all attributes in face attribute vector ATTRS are
3339 specified, i.e. are non-nil. */
3341 static int
3342 lface_fully_specified_p (attrs)
3343 Lisp_Object *attrs;
3345 int i;
3347 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3348 if (i != LFACE_FONT_INDEX && i != LFACE_INHERIT_INDEX
3349 && i != LFACE_AVGWIDTH_INDEX)
3350 if ((UNSPECIFIEDP (attrs[i]) || IGNORE_DEFFACE_P (attrs[i]))
3351 #ifdef MAC_OS
3352 /* MAC_TODO: No stipple support on Mac OS yet, this index is
3353 always unspecified. */
3354 && i != LFACE_STIPPLE_INDEX
3355 #endif
3357 break;
3359 return i == LFACE_VECTOR_SIZE;
3362 #ifdef HAVE_WINDOW_SYSTEM
3364 /* Set font-related attributes of Lisp face LFACE from the fullname of
3365 the font opened by FONTNAME. If FORCE_P is zero, set only
3366 unspecified attributes of LFACE. The exception is `font'
3367 attribute. It is set to FONTNAME as is regardless of FORCE_P.
3369 If FONTNAME is not available on frame F,
3370 return 0 if MAY_FAIL_P is non-zero, otherwise abort.
3371 If the fullname is not in a valid XLFD format,
3372 return 0 if MAY_FAIL_P is non-zero, otherwise set normal values
3373 in LFACE and return 1.
3374 Otherwise, return 1. */
3376 static int
3377 set_lface_from_font_name (f, lface, fontname, force_p, may_fail_p)
3378 struct frame *f;
3379 Lisp_Object lface;
3380 Lisp_Object fontname;
3381 int force_p, may_fail_p;
3383 struct font_name font;
3384 char *buffer;
3385 int pt;
3386 int have_xlfd_p;
3387 int fontset;
3388 char *font_name = SDATA (fontname);
3389 struct font_info *font_info;
3391 /* If FONTNAME is actually a fontset name, get ASCII font name of it. */
3392 fontset = fs_query_fontset (fontname, 0);
3393 if (fontset >= 0)
3394 font_name = SDATA (fontset_ascii (fontset));
3396 /* Check if FONT_NAME is surely available on the system. Usually
3397 FONT_NAME is already cached for the frame F and FS_LOAD_FONT
3398 returns quickly. But, even if FONT_NAME is not yet cached,
3399 caching it now is not futail because we anyway load the font
3400 later. */
3401 BLOCK_INPUT;
3402 font_info = FS_LOAD_FONT (f, 0, font_name, -1);
3403 UNBLOCK_INPUT;
3405 if (!font_info)
3407 if (may_fail_p)
3408 return 0;
3409 abort ();
3412 font.name = STRDUPA (font_info->full_name);
3413 have_xlfd_p = split_font_name (f, &font, 1);
3415 /* Set attributes only if unspecified, otherwise face defaults for
3416 new frames would never take effect. If we couldn't get a font
3417 name conforming to XLFD, set normal values. */
3419 if (force_p || UNSPECIFIEDP (LFACE_FAMILY (lface)))
3421 Lisp_Object val;
3422 if (have_xlfd_p)
3424 buffer = (char *) alloca (strlen (font.fields[XLFD_FAMILY])
3425 + strlen (font.fields[XLFD_FOUNDRY])
3426 + 2);
3427 sprintf (buffer, "%s-%s", font.fields[XLFD_FOUNDRY],
3428 font.fields[XLFD_FAMILY]);
3429 val = build_string (buffer);
3431 else
3432 val = build_string ("*");
3433 LFACE_FAMILY (lface) = val;
3436 if (force_p || UNSPECIFIEDP (LFACE_HEIGHT (lface)))
3438 if (have_xlfd_p)
3439 pt = xlfd_point_size (f, &font);
3440 else
3441 pt = pixel_point_size (f, font_info->height * 10);
3442 xassert (pt > 0);
3443 LFACE_HEIGHT (lface) = make_number (pt);
3446 if (force_p || UNSPECIFIEDP (LFACE_SWIDTH (lface)))
3447 LFACE_SWIDTH (lface)
3448 = have_xlfd_p ? xlfd_symbolic_swidth (&font) : Qnormal;
3450 if (force_p || UNSPECIFIEDP (LFACE_AVGWIDTH (lface)))
3451 LFACE_AVGWIDTH (lface)
3452 = (have_xlfd_p
3453 ? make_number (font.numeric[XLFD_AVGWIDTH])
3454 : Qunspecified);
3456 if (force_p || UNSPECIFIEDP (LFACE_WEIGHT (lface)))
3457 LFACE_WEIGHT (lface)
3458 = have_xlfd_p ? xlfd_symbolic_weight (&font) : Qnormal;
3460 if (force_p || UNSPECIFIEDP (LFACE_SLANT (lface)))
3461 LFACE_SLANT (lface)
3462 = have_xlfd_p ? xlfd_symbolic_slant (&font) : Qnormal;
3464 LFACE_FONT (lface) = fontname;
3466 return 1;
3469 #endif /* HAVE_WINDOW_SYSTEM */
3472 /* Merges the face height FROM with the face height TO, and returns the
3473 merged height. If FROM is an invalid height, then INVALID is
3474 returned instead. FROM and TO may be either absolute face heights or
3475 `relative' heights; the returned value is always an absolute height
3476 unless both FROM and TO are relative. GCPRO is a lisp value that
3477 will be protected from garbage-collection if this function makes a
3478 call into lisp. */
3480 Lisp_Object
3481 merge_face_heights (from, to, invalid)
3482 Lisp_Object from, to, invalid;
3484 Lisp_Object result = invalid;
3486 if (INTEGERP (from))
3487 /* FROM is absolute, just use it as is. */
3488 result = from;
3489 else if (FLOATP (from))
3490 /* FROM is a scale, use it to adjust TO. */
3492 if (INTEGERP (to))
3493 /* relative X absolute => absolute */
3494 result = make_number ((EMACS_INT)(XFLOAT_DATA (from) * XINT (to)));
3495 else if (FLOATP (to))
3496 /* relative X relative => relative */
3497 result = make_float (XFLOAT_DATA (from) * XFLOAT_DATA (to));
3498 else if (UNSPECIFIEDP (to))
3499 result = from;
3501 else if (FUNCTIONP (from))
3502 /* FROM is a function, which use to adjust TO. */
3504 /* Call function with current height as argument.
3505 From is the new height. */
3506 Lisp_Object args[2];
3508 args[0] = from;
3509 args[1] = to;
3510 result = safe_call (2, args);
3512 /* Ensure that if TO was absolute, so is the result. */
3513 if (INTEGERP (to) && !INTEGERP (result))
3514 result = invalid;
3517 return result;
3521 /* Merge two Lisp face attribute vectors on frame F, FROM and TO, and
3522 store the resulting attributes in TO, which must be already be
3523 completely specified and contain only absolute attributes. Every
3524 specified attribute of FROM overrides the corresponding attribute of
3525 TO; relative attributes in FROM are merged with the absolute value in
3526 TO and replace it. NAMED_MERGE_POINTS is used internally to detect
3527 loops in face inheritance; it should be 0 when called from other
3528 places. */
3530 static INLINE void
3531 merge_face_vectors (f, from, to, named_merge_points)
3532 struct frame *f;
3533 Lisp_Object *from, *to;
3534 struct named_merge_point *named_merge_points;
3536 int i;
3538 /* If FROM inherits from some other faces, merge their attributes into
3539 TO before merging FROM's direct attributes. Note that an :inherit
3540 attribute of `unspecified' is the same as one of nil; we never
3541 merge :inherit attributes, so nil is more correct, but lots of
3542 other code uses `unspecified' as a generic value for face attributes. */
3543 if (!UNSPECIFIEDP (from[LFACE_INHERIT_INDEX])
3544 && !NILP (from[LFACE_INHERIT_INDEX]))
3545 merge_face_ref (f, from[LFACE_INHERIT_INDEX], to, 0, named_merge_points);
3547 /* If TO specifies a :font attribute, and FROM specifies some
3548 font-related attribute, we need to clear TO's :font attribute
3549 (because it will be inconsistent with whatever FROM specifies, and
3550 FROM takes precedence). */
3551 if (!NILP (to[LFACE_FONT_INDEX])
3552 && (!UNSPECIFIEDP (from[LFACE_FAMILY_INDEX])
3553 || !UNSPECIFIEDP (from[LFACE_HEIGHT_INDEX])
3554 || !UNSPECIFIEDP (from[LFACE_WEIGHT_INDEX])
3555 || !UNSPECIFIEDP (from[LFACE_SLANT_INDEX])
3556 || !UNSPECIFIEDP (from[LFACE_SWIDTH_INDEX])
3557 || !UNSPECIFIEDP (from[LFACE_AVGWIDTH_INDEX])))
3558 to[LFACE_FONT_INDEX] = Qnil;
3560 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3561 if (!UNSPECIFIEDP (from[i]))
3563 if (i == LFACE_HEIGHT_INDEX && !INTEGERP (from[i]))
3564 to[i] = merge_face_heights (from[i], to[i], to[i]);
3565 else
3566 to[i] = from[i];
3569 /* TO is always an absolute face, which should inherit from nothing.
3570 We blindly copy the :inherit attribute above and fix it up here. */
3571 to[LFACE_INHERIT_INDEX] = Qnil;
3574 /* Merge the named face FACE_NAME on frame F, into the vector of face
3575 attributes TO. NAMED_MERGE_POINTS is used to detect loops in face
3576 inheritance. Returns true if FACE_NAME is a valid face name and
3577 merging succeeded. */
3579 static int
3580 merge_named_face (f, face_name, to, named_merge_points)
3581 struct frame *f;
3582 Lisp_Object face_name;
3583 Lisp_Object *to;
3584 struct named_merge_point *named_merge_points;
3586 struct named_merge_point named_merge_point;
3588 if (push_named_merge_point (&named_merge_point,
3589 face_name, &named_merge_points))
3591 struct gcpro gcpro1;
3592 Lisp_Object from[LFACE_VECTOR_SIZE];
3593 int ok = get_lface_attributes (f, face_name, from, 0);
3595 if (ok)
3597 GCPRO1 (named_merge_point.face_name);
3598 merge_face_vectors (f, from, to, named_merge_points);
3599 UNGCPRO;
3602 return ok;
3604 else
3605 return 0;
3609 /* Merge face attributes from the lisp `face reference' FACE_REF on
3610 frame F into the face attribute vector TO. If ERR_MSGS is non-zero,
3611 problems with FACE_REF cause an error message to be shown. Return
3612 non-zero if no errors occurred (regardless of the value of ERR_MSGS).
3613 NAMED_MERGE_POINTS is used to detect loops in face inheritance or
3614 list structure; it may be 0 for most callers.
3616 FACE_REF may be a single face specification or a list of such
3617 specifications. Each face specification can be:
3619 1. A symbol or string naming a Lisp face.
3621 2. A property list of the form (KEYWORD VALUE ...) where each
3622 KEYWORD is a face attribute name, and value is an appropriate value
3623 for that attribute.
3625 3. Conses or the form (FOREGROUND-COLOR . COLOR) or
3626 (BACKGROUND-COLOR . COLOR) where COLOR is a color name. This is
3627 for compatibility with 20.2.
3629 Face specifications earlier in lists take precedence over later
3630 specifications. */
3632 static int
3633 merge_face_ref (f, face_ref, to, err_msgs, named_merge_points)
3634 struct frame *f;
3635 Lisp_Object face_ref;
3636 Lisp_Object *to;
3637 int err_msgs;
3638 struct named_merge_point *named_merge_points;
3640 int ok = 1; /* Succeed without an error? */
3642 if (CONSP (face_ref))
3644 Lisp_Object first = XCAR (face_ref);
3646 if (EQ (first, Qforeground_color)
3647 || EQ (first, Qbackground_color))
3649 /* One of (FOREGROUND-COLOR . COLOR) or (BACKGROUND-COLOR
3650 . COLOR). COLOR must be a string. */
3651 Lisp_Object color_name = XCDR (face_ref);
3652 Lisp_Object color = first;
3654 if (STRINGP (color_name))
3656 if (EQ (color, Qforeground_color))
3657 to[LFACE_FOREGROUND_INDEX] = color_name;
3658 else
3659 to[LFACE_BACKGROUND_INDEX] = color_name;
3661 else
3663 if (err_msgs)
3664 add_to_log ("Invalid face color", color_name, Qnil);
3665 ok = 0;
3668 else if (SYMBOLP (first)
3669 && *SDATA (SYMBOL_NAME (first)) == ':')
3671 /* Assume this is the property list form. */
3672 while (CONSP (face_ref) && CONSP (XCDR (face_ref)))
3674 Lisp_Object keyword = XCAR (face_ref);
3675 Lisp_Object value = XCAR (XCDR (face_ref));
3676 int err = 0;
3678 /* Specifying `unspecified' is a no-op. */
3679 if (EQ (value, Qunspecified))
3681 else if (EQ (keyword, QCfamily))
3683 if (STRINGP (value))
3684 to[LFACE_FAMILY_INDEX] = value;
3685 else
3686 err = 1;
3688 else if (EQ (keyword, QCheight))
3690 Lisp_Object new_height =
3691 merge_face_heights (value, to[LFACE_HEIGHT_INDEX], Qnil);
3693 if (! NILP (new_height))
3694 to[LFACE_HEIGHT_INDEX] = new_height;
3695 else
3696 err = 1;
3698 else if (EQ (keyword, QCweight))
3700 if (SYMBOLP (value)
3701 && face_numeric_weight (value) >= 0)
3702 to[LFACE_WEIGHT_INDEX] = value;
3703 else
3704 err = 1;
3706 else if (EQ (keyword, QCslant))
3708 if (SYMBOLP (value)
3709 && face_numeric_slant (value) >= 0)
3710 to[LFACE_SLANT_INDEX] = value;
3711 else
3712 err = 1;
3714 else if (EQ (keyword, QCunderline))
3716 if (EQ (value, Qt)
3717 || NILP (value)
3718 || STRINGP (value))
3719 to[LFACE_UNDERLINE_INDEX] = value;
3720 else
3721 err = 1;
3723 else if (EQ (keyword, QCoverline))
3725 if (EQ (value, Qt)
3726 || NILP (value)
3727 || STRINGP (value))
3728 to[LFACE_OVERLINE_INDEX] = value;
3729 else
3730 err = 1;
3732 else if (EQ (keyword, QCstrike_through))
3734 if (EQ (value, Qt)
3735 || NILP (value)
3736 || STRINGP (value))
3737 to[LFACE_STRIKE_THROUGH_INDEX] = value;
3738 else
3739 err = 1;
3741 else if (EQ (keyword, QCbox))
3743 if (EQ (value, Qt))
3744 value = make_number (1);
3745 if (INTEGERP (value)
3746 || STRINGP (value)
3747 || CONSP (value)
3748 || NILP (value))
3749 to[LFACE_BOX_INDEX] = value;
3750 else
3751 err = 1;
3753 else if (EQ (keyword, QCinverse_video)
3754 || EQ (keyword, QCreverse_video))
3756 if (EQ (value, Qt) || NILP (value))
3757 to[LFACE_INVERSE_INDEX] = value;
3758 else
3759 err = 1;
3761 else if (EQ (keyword, QCforeground))
3763 if (STRINGP (value))
3764 to[LFACE_FOREGROUND_INDEX] = value;
3765 else
3766 err = 1;
3768 else if (EQ (keyword, QCbackground))
3770 if (STRINGP (value))
3771 to[LFACE_BACKGROUND_INDEX] = value;
3772 else
3773 err = 1;
3775 else if (EQ (keyword, QCstipple))
3777 #ifdef HAVE_X_WINDOWS
3778 Lisp_Object pixmap_p = Fbitmap_spec_p (value);
3779 if (!NILP (pixmap_p))
3780 to[LFACE_STIPPLE_INDEX] = value;
3781 else
3782 err = 1;
3783 #endif
3785 else if (EQ (keyword, QCwidth))
3787 if (SYMBOLP (value)
3788 && face_numeric_swidth (value) >= 0)
3789 to[LFACE_SWIDTH_INDEX] = value;
3790 else
3791 err = 1;
3793 else if (EQ (keyword, QCinherit))
3795 /* This is not really very useful; it's just like a
3796 normal face reference. */
3797 if (! merge_face_ref (f, value, to,
3798 err_msgs, named_merge_points))
3799 err = 1;
3801 else
3802 err = 1;
3804 if (err)
3806 add_to_log ("Invalid face attribute %S %S", keyword, value);
3807 ok = 0;
3810 face_ref = XCDR (XCDR (face_ref));
3813 else
3815 /* This is a list of face refs. Those at the beginning of the
3816 list take precedence over what follows, so we have to merge
3817 from the end backwards. */
3818 Lisp_Object next = XCDR (face_ref);
3820 if (! NILP (next))
3821 ok = merge_face_ref (f, next, to, err_msgs, named_merge_points);
3823 if (! merge_face_ref (f, first, to, err_msgs, named_merge_points))
3824 ok = 0;
3827 else
3829 /* FACE_REF ought to be a face name. */
3830 ok = merge_named_face (f, face_ref, to, named_merge_points);
3831 if (!ok && err_msgs)
3832 add_to_log ("Invalid face reference: %s", face_ref, Qnil);
3835 return ok;
3839 DEFUN ("internal-make-lisp-face", Finternal_make_lisp_face,
3840 Sinternal_make_lisp_face, 1, 2, 0,
3841 doc: /* Make FACE, a symbol, a Lisp face with all attributes nil.
3842 If FACE was not known as a face before, create a new one.
3843 If optional argument FRAME is specified, make a frame-local face
3844 for that frame. Otherwise operate on the global face definition.
3845 Value is a vector of face attributes. */)
3846 (face, frame)
3847 Lisp_Object face, frame;
3849 Lisp_Object global_lface, lface;
3850 struct frame *f;
3851 int i;
3853 CHECK_SYMBOL (face);
3854 global_lface = lface_from_face_name (NULL, face, 0);
3856 if (!NILP (frame))
3858 CHECK_LIVE_FRAME (frame);
3859 f = XFRAME (frame);
3860 lface = lface_from_face_name (f, face, 0);
3862 else
3863 f = NULL, lface = Qnil;
3865 /* Add a global definition if there is none. */
3866 if (NILP (global_lface))
3868 global_lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
3869 Qunspecified);
3870 AREF (global_lface, 0) = Qface;
3871 Vface_new_frame_defaults = Fcons (Fcons (face, global_lface),
3872 Vface_new_frame_defaults);
3874 /* Assign the new Lisp face a unique ID. The mapping from Lisp
3875 face id to Lisp face is given by the vector lface_id_to_name.
3876 The mapping from Lisp face to Lisp face id is given by the
3877 property `face' of the Lisp face name. */
3878 if (next_lface_id == lface_id_to_name_size)
3880 int new_size = max (50, 2 * lface_id_to_name_size);
3881 int sz = new_size * sizeof *lface_id_to_name;
3882 lface_id_to_name = (Lisp_Object *) xrealloc (lface_id_to_name, sz);
3883 lface_id_to_name_size = new_size;
3886 lface_id_to_name[next_lface_id] = face;
3887 Fput (face, Qface, make_number (next_lface_id));
3888 ++next_lface_id;
3890 else if (f == NULL)
3891 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3892 AREF (global_lface, i) = Qunspecified;
3894 /* Add a frame-local definition. */
3895 if (f)
3897 if (NILP (lface))
3899 lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
3900 Qunspecified);
3901 AREF (lface, 0) = Qface;
3902 f->face_alist = Fcons (Fcons (face, lface), f->face_alist);
3904 else
3905 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
3906 AREF (lface, i) = Qunspecified;
3908 else
3909 lface = global_lface;
3911 /* Changing a named face means that all realized faces depending on
3912 that face are invalid. Since we cannot tell which realized faces
3913 depend on the face, make sure they are all removed. This is done
3914 by incrementing face_change_count. The next call to
3915 init_iterator will then free realized faces. */
3916 if (NILP (Fget (face, Qface_no_inherit)))
3918 ++face_change_count;
3919 ++windows_or_buffers_changed;
3922 xassert (LFACEP (lface));
3923 check_lface (lface);
3924 return lface;
3928 DEFUN ("internal-lisp-face-p", Finternal_lisp_face_p,
3929 Sinternal_lisp_face_p, 1, 2, 0,
3930 doc: /* Return non-nil if FACE names a face.
3931 If optional second argument FRAME is non-nil, check for the
3932 existence of a frame-local face with name FACE on that frame.
3933 Otherwise check for the existence of a global face. */)
3934 (face, frame)
3935 Lisp_Object face, frame;
3937 Lisp_Object lface;
3939 if (!NILP (frame))
3941 CHECK_LIVE_FRAME (frame);
3942 lface = lface_from_face_name (XFRAME (frame), face, 0);
3944 else
3945 lface = lface_from_face_name (NULL, face, 0);
3947 return lface;
3951 DEFUN ("internal-copy-lisp-face", Finternal_copy_lisp_face,
3952 Sinternal_copy_lisp_face, 4, 4, 0,
3953 doc: /* Copy face FROM to TO.
3954 If FRAME is t, copy the global face definition of FROM.
3955 Otherwise, copy the frame-local definition of FROM on FRAME.
3956 If NEW-FRAME is a frame, copy that data into the frame-local
3957 definition of TO on NEW-FRAME. If NEW-FRAME is nil.
3958 FRAME controls where the data is copied to.
3960 The value is TO. */)
3961 (from, to, frame, new_frame)
3962 Lisp_Object from, to, frame, new_frame;
3964 Lisp_Object lface, copy;
3966 CHECK_SYMBOL (from);
3967 CHECK_SYMBOL (to);
3969 if (EQ (frame, Qt))
3971 /* Copy global definition of FROM. We don't make copies of
3972 strings etc. because 20.2 didn't do it either. */
3973 lface = lface_from_face_name (NULL, from, 1);
3974 copy = Finternal_make_lisp_face (to, Qnil);
3976 else
3978 /* Copy frame-local definition of FROM. */
3979 if (NILP (new_frame))
3980 new_frame = frame;
3981 CHECK_LIVE_FRAME (frame);
3982 CHECK_LIVE_FRAME (new_frame);
3983 lface = lface_from_face_name (XFRAME (frame), from, 1);
3984 copy = Finternal_make_lisp_face (to, new_frame);
3987 bcopy (XVECTOR (lface)->contents, XVECTOR (copy)->contents,
3988 LFACE_VECTOR_SIZE * sizeof (Lisp_Object));
3990 /* Changing a named face means that all realized faces depending on
3991 that face are invalid. Since we cannot tell which realized faces
3992 depend on the face, make sure they are all removed. This is done
3993 by incrementing face_change_count. The next call to
3994 init_iterator will then free realized faces. */
3995 if (NILP (Fget (to, Qface_no_inherit)))
3997 ++face_change_count;
3998 ++windows_or_buffers_changed;
4001 return to;
4005 DEFUN ("internal-set-lisp-face-attribute", Finternal_set_lisp_face_attribute,
4006 Sinternal_set_lisp_face_attribute, 3, 4, 0,
4007 doc: /* Set attribute ATTR of FACE to VALUE.
4008 FRAME being a frame means change the face on that frame.
4009 FRAME nil means change the face of the selected frame.
4010 FRAME t means change the default for new frames.
4011 FRAME 0 means change the face on all frames, and change the default
4012 for new frames. */)
4013 (face, attr, value, frame)
4014 Lisp_Object face, attr, value, frame;
4016 Lisp_Object lface;
4017 Lisp_Object old_value = Qnil;
4018 /* Set 1 if ATTR is QCfont. */
4019 int font_attr_p = 0;
4020 /* Set 1 if ATTR is one of font-related attributes other than QCfont. */
4021 int font_related_attr_p = 0;
4023 CHECK_SYMBOL (face);
4024 CHECK_SYMBOL (attr);
4026 face = resolve_face_name (face, 1);
4028 /* If FRAME is 0, change face on all frames, and change the
4029 default for new frames. */
4030 if (INTEGERP (frame) && XINT (frame) == 0)
4032 Lisp_Object tail;
4033 Finternal_set_lisp_face_attribute (face, attr, value, Qt);
4034 FOR_EACH_FRAME (tail, frame)
4035 Finternal_set_lisp_face_attribute (face, attr, value, frame);
4036 return face;
4039 /* Set lface to the Lisp attribute vector of FACE. */
4040 if (EQ (frame, Qt))
4042 lface = lface_from_face_name (NULL, face, 1);
4044 /* When updating face-new-frame-defaults, we put :ignore-defface
4045 where the caller wants `unspecified'. This forces the frame
4046 defaults to ignore the defface value. Otherwise, the defface
4047 will take effect, which is generally not what is intended.
4048 The value of that attribute will be inherited from some other
4049 face during face merging. See internal_merge_in_global_face. */
4050 if (UNSPECIFIEDP (value))
4051 value = Qignore_defface;
4053 else
4055 if (NILP (frame))
4056 frame = selected_frame;
4058 CHECK_LIVE_FRAME (frame);
4059 lface = lface_from_face_name (XFRAME (frame), face, 0);
4061 /* If a frame-local face doesn't exist yet, create one. */
4062 if (NILP (lface))
4063 lface = Finternal_make_lisp_face (face, frame);
4066 if (EQ (attr, QCfamily))
4068 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4070 CHECK_STRING (value);
4071 if (SCHARS (value) == 0)
4072 signal_error ("Invalid face family", value);
4074 old_value = LFACE_FAMILY (lface);
4075 LFACE_FAMILY (lface) = value;
4076 font_related_attr_p = 1;
4078 else if (EQ (attr, QCheight))
4080 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4082 Lisp_Object test;
4084 test = (EQ (face, Qdefault)
4085 ? value
4086 /* The default face must have an absolute size,
4087 otherwise, we do a test merge with a random
4088 height to see if VALUE's ok. */
4089 : merge_face_heights (value, make_number (10), Qnil));
4091 if (!INTEGERP (test) || XINT (test) <= 0)
4092 signal_error ("Invalid face height", value);
4095 old_value = LFACE_HEIGHT (lface);
4096 LFACE_HEIGHT (lface) = value;
4097 font_related_attr_p = 1;
4099 else if (EQ (attr, QCweight))
4101 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4103 CHECK_SYMBOL (value);
4104 if (face_numeric_weight (value) < 0)
4105 signal_error ("Invalid face weight", value);
4107 old_value = LFACE_WEIGHT (lface);
4108 LFACE_WEIGHT (lface) = value;
4109 font_related_attr_p = 1;
4111 else if (EQ (attr, QCslant))
4113 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4115 CHECK_SYMBOL (value);
4116 if (face_numeric_slant (value) < 0)
4117 signal_error ("Invalid face slant", value);
4119 old_value = LFACE_SLANT (lface);
4120 LFACE_SLANT (lface) = value;
4121 font_related_attr_p = 1;
4123 else if (EQ (attr, QCunderline))
4125 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4126 if ((SYMBOLP (value)
4127 && !EQ (value, Qt)
4128 && !EQ (value, Qnil))
4129 /* Underline color. */
4130 || (STRINGP (value)
4131 && SCHARS (value) == 0))
4132 signal_error ("Invalid face underline", value);
4134 old_value = LFACE_UNDERLINE (lface);
4135 LFACE_UNDERLINE (lface) = value;
4137 else if (EQ (attr, QCoverline))
4139 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4140 if ((SYMBOLP (value)
4141 && !EQ (value, Qt)
4142 && !EQ (value, Qnil))
4143 /* Overline color. */
4144 || (STRINGP (value)
4145 && SCHARS (value) == 0))
4146 signal_error ("Invalid face overline", value);
4148 old_value = LFACE_OVERLINE (lface);
4149 LFACE_OVERLINE (lface) = value;
4151 else if (EQ (attr, QCstrike_through))
4153 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4154 if ((SYMBOLP (value)
4155 && !EQ (value, Qt)
4156 && !EQ (value, Qnil))
4157 /* Strike-through color. */
4158 || (STRINGP (value)
4159 && SCHARS (value) == 0))
4160 signal_error ("Invalid face strike-through", value);
4162 old_value = LFACE_STRIKE_THROUGH (lface);
4163 LFACE_STRIKE_THROUGH (lface) = value;
4165 else if (EQ (attr, QCbox))
4167 int valid_p;
4169 /* Allow t meaning a simple box of width 1 in foreground color
4170 of the face. */
4171 if (EQ (value, Qt))
4172 value = make_number (1);
4174 if (UNSPECIFIEDP (value) || IGNORE_DEFFACE_P (value))
4175 valid_p = 1;
4176 else if (NILP (value))
4177 valid_p = 1;
4178 else if (INTEGERP (value))
4179 valid_p = XINT (value) != 0;
4180 else if (STRINGP (value))
4181 valid_p = SCHARS (value) > 0;
4182 else if (CONSP (value))
4184 Lisp_Object tem;
4186 tem = value;
4187 while (CONSP (tem))
4189 Lisp_Object k, v;
4191 k = XCAR (tem);
4192 tem = XCDR (tem);
4193 if (!CONSP (tem))
4194 break;
4195 v = XCAR (tem);
4196 tem = XCDR (tem);
4198 if (EQ (k, QCline_width))
4200 if (!INTEGERP (v) || XINT (v) == 0)
4201 break;
4203 else if (EQ (k, QCcolor))
4205 if (!NILP (v) && (!STRINGP (v) || SCHARS (v) == 0))
4206 break;
4208 else if (EQ (k, QCstyle))
4210 if (!EQ (v, Qpressed_button) && !EQ (v, Qreleased_button))
4211 break;
4213 else
4214 break;
4217 valid_p = NILP (tem);
4219 else
4220 valid_p = 0;
4222 if (!valid_p)
4223 signal_error ("Invalid face box", value);
4225 old_value = LFACE_BOX (lface);
4226 LFACE_BOX (lface) = value;
4228 else if (EQ (attr, QCinverse_video)
4229 || EQ (attr, QCreverse_video))
4231 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4233 CHECK_SYMBOL (value);
4234 if (!EQ (value, Qt) && !NILP (value))
4235 signal_error ("Invalid inverse-video face attribute value", value);
4237 old_value = LFACE_INVERSE (lface);
4238 LFACE_INVERSE (lface) = value;
4240 else if (EQ (attr, QCforeground))
4242 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4244 /* Don't check for valid color names here because it depends
4245 on the frame (display) whether the color will be valid
4246 when the face is realized. */
4247 CHECK_STRING (value);
4248 if (SCHARS (value) == 0)
4249 signal_error ("Empty foreground color value", value);
4251 old_value = LFACE_FOREGROUND (lface);
4252 LFACE_FOREGROUND (lface) = value;
4254 else if (EQ (attr, QCbackground))
4256 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4258 /* Don't check for valid color names here because it depends
4259 on the frame (display) whether the color will be valid
4260 when the face is realized. */
4261 CHECK_STRING (value);
4262 if (SCHARS (value) == 0)
4263 signal_error ("Empty background color value", value);
4265 old_value = LFACE_BACKGROUND (lface);
4266 LFACE_BACKGROUND (lface) = value;
4268 else if (EQ (attr, QCstipple))
4270 #ifdef HAVE_X_WINDOWS
4271 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value)
4272 && !NILP (value)
4273 && NILP (Fbitmap_spec_p (value)))
4274 signal_error ("Invalid stipple attribute", value);
4275 old_value = LFACE_STIPPLE (lface);
4276 LFACE_STIPPLE (lface) = value;
4277 #endif /* HAVE_X_WINDOWS */
4279 else if (EQ (attr, QCwidth))
4281 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4283 CHECK_SYMBOL (value);
4284 if (face_numeric_swidth (value) < 0)
4285 signal_error ("Invalid face width", value);
4287 old_value = LFACE_SWIDTH (lface);
4288 LFACE_SWIDTH (lface) = value;
4289 font_related_attr_p = 1;
4291 else if (EQ (attr, QCfont))
4293 #ifdef HAVE_WINDOW_SYSTEM
4294 if (EQ (frame, Qt) || FRAME_WINDOW_P (XFRAME (frame)))
4296 /* Set font-related attributes of the Lisp face from an XLFD
4297 font name. */
4298 struct frame *f;
4299 Lisp_Object tmp;
4301 if (EQ (frame, Qt))
4302 f = SELECTED_FRAME ();
4303 else
4304 f = check_x_frame (frame);
4306 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4308 CHECK_STRING (value);
4310 /* VALUE may be a fontset name or an alias of fontset. In
4311 such a case, use the base fontset name. */
4312 tmp = Fquery_fontset (value, Qnil);
4313 if (!NILP (tmp))
4314 value = tmp;
4316 if (!set_lface_from_font_name (f, lface, value, 1, 1))
4317 signal_error ("Invalid font or fontset name", value);
4320 font_attr_p = 1;
4322 #endif /* HAVE_WINDOW_SYSTEM */
4324 else if (EQ (attr, QCinherit))
4326 Lisp_Object tail;
4327 if (SYMBOLP (value))
4328 tail = Qnil;
4329 else
4330 for (tail = value; CONSP (tail); tail = XCDR (tail))
4331 if (!SYMBOLP (XCAR (tail)))
4332 break;
4333 if (NILP (tail))
4334 LFACE_INHERIT (lface) = value;
4335 else
4336 signal_error ("Invalid face inheritance", value);
4338 else if (EQ (attr, QCbold))
4340 old_value = LFACE_WEIGHT (lface);
4341 LFACE_WEIGHT (lface) = NILP (value) ? Qnormal : Qbold;
4342 font_related_attr_p = 1;
4344 else if (EQ (attr, QCitalic))
4346 old_value = LFACE_SLANT (lface);
4347 LFACE_SLANT (lface) = NILP (value) ? Qnormal : Qitalic;
4348 font_related_attr_p = 1;
4350 else
4351 signal_error ("Invalid face attribute name", attr);
4353 if (font_related_attr_p
4354 && !UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value))
4355 /* If a font-related attribute other than QCfont is specified, the
4356 original `font' attribute nor that of default face is useless
4357 to determine a new font. Thus, we set it to nil so that font
4358 selection mechanism doesn't use it. */
4359 LFACE_FONT (lface) = Qnil;
4361 /* Changing a named face means that all realized faces depending on
4362 that face are invalid. Since we cannot tell which realized faces
4363 depend on the face, make sure they are all removed. This is done
4364 by incrementing face_change_count. The next call to
4365 init_iterator will then free realized faces. */
4366 if (!EQ (frame, Qt)
4367 && NILP (Fget (face, Qface_no_inherit))
4368 && (EQ (attr, QCfont)
4369 || NILP (Fequal (old_value, value))))
4371 ++face_change_count;
4372 ++windows_or_buffers_changed;
4375 if (!UNSPECIFIEDP (value) && !IGNORE_DEFFACE_P (value)
4376 && NILP (Fequal (old_value, value)))
4378 Lisp_Object param;
4380 param = Qnil;
4382 if (EQ (face, Qdefault))
4384 #ifdef HAVE_WINDOW_SYSTEM
4385 /* Changed font-related attributes of the `default' face are
4386 reflected in changed `font' frame parameters. */
4387 if (FRAMEP (frame)
4388 && (font_related_attr_p || font_attr_p)
4389 && lface_fully_specified_p (XVECTOR (lface)->contents))
4390 set_font_frame_param (frame, lface);
4391 else
4392 #endif /* HAVE_WINDOW_SYSTEM */
4394 if (EQ (attr, QCforeground))
4395 param = Qforeground_color;
4396 else if (EQ (attr, QCbackground))
4397 param = Qbackground_color;
4399 #ifdef HAVE_WINDOW_SYSTEM
4400 #ifndef WINDOWSNT
4401 else if (EQ (face, Qscroll_bar))
4403 /* Changing the colors of `scroll-bar' sets frame parameters
4404 `scroll-bar-foreground' and `scroll-bar-background'. */
4405 if (EQ (attr, QCforeground))
4406 param = Qscroll_bar_foreground;
4407 else if (EQ (attr, QCbackground))
4408 param = Qscroll_bar_background;
4410 #endif /* not WINDOWSNT */
4411 else if (EQ (face, Qborder))
4413 /* Changing background color of `border' sets frame parameter
4414 `border-color'. */
4415 if (EQ (attr, QCbackground))
4416 param = Qborder_color;
4418 else if (EQ (face, Qcursor))
4420 /* Changing background color of `cursor' sets frame parameter
4421 `cursor-color'. */
4422 if (EQ (attr, QCbackground))
4423 param = Qcursor_color;
4425 else if (EQ (face, Qmouse))
4427 /* Changing background color of `mouse' sets frame parameter
4428 `mouse-color'. */
4429 if (EQ (attr, QCbackground))
4430 param = Qmouse_color;
4432 #endif /* HAVE_WINDOW_SYSTEM */
4433 else if (EQ (face, Qmenu))
4435 /* Indicate that we have to update the menu bar when
4436 realizing faces on FRAME. FRAME t change the
4437 default for new frames. We do this by setting
4438 setting the flag in new face caches */
4439 if (FRAMEP (frame))
4441 struct frame *f = XFRAME (frame);
4442 if (FRAME_FACE_CACHE (f) == NULL)
4443 FRAME_FACE_CACHE (f) = make_face_cache (f);
4444 FRAME_FACE_CACHE (f)->menu_face_changed_p = 1;
4446 else
4447 menu_face_changed_default = 1;
4450 if (!NILP (param))
4452 if (EQ (frame, Qt))
4453 /* Update `default-frame-alist', which is used for new frames. */
4455 store_in_alist (&Vdefault_frame_alist, param, value);
4457 else
4458 /* Update the current frame's parameters. */
4460 Lisp_Object cons;
4461 cons = XCAR (Vparam_value_alist);
4462 XSETCAR (cons, param);
4463 XSETCDR (cons, value);
4464 Fmodify_frame_parameters (frame, Vparam_value_alist);
4469 return face;
4473 #ifdef HAVE_WINDOW_SYSTEM
4475 /* Set the `font' frame parameter of FRAME determined from `default'
4476 face attributes LFACE. If a face or fontset name is explicitely
4477 specfied in LFACE, use it as is. Otherwise, determine a font name
4478 from the other font-related atrributes of LFACE. In that case, if
4479 there's no matching font, signals an error. */
4481 static void
4482 set_font_frame_param (frame, lface)
4483 Lisp_Object frame, lface;
4485 struct frame *f = XFRAME (frame);
4487 if (FRAME_WINDOW_P (f))
4489 Lisp_Object font_name;
4490 char *font;
4492 if (STRINGP (LFACE_FONT (lface)))
4493 font_name = LFACE_FONT (lface);
4494 else
4496 /* Choose a font name that reflects LFACE's attributes and has
4497 the registry and encoding pattern specified in the default
4498 fontset (3rd arg: -1) for ASCII characters (4th arg: 0). */
4499 font = choose_face_font (f, XVECTOR (lface)->contents, -1, 0, 0);
4500 if (!font)
4501 error ("No font matches the specified attribute");
4502 font_name = build_string (font);
4503 xfree (font);
4506 f->default_face_done_p = 0;
4507 Fmodify_frame_parameters (frame, Fcons (Fcons (Qfont, font_name), Qnil));
4512 /* Update the corresponding face when frame parameter PARAM on frame F
4513 has been assigned the value NEW_VALUE. */
4515 void
4516 update_face_from_frame_parameter (f, param, new_value)
4517 struct frame *f;
4518 Lisp_Object param, new_value;
4520 Lisp_Object face = Qnil;
4521 Lisp_Object lface;
4523 /* If there are no faces yet, give up. This is the case when called
4524 from Fx_create_frame, and we do the necessary things later in
4525 face-set-after-frame-defaults. */
4526 if (NILP (f->face_alist))
4527 return;
4529 if (EQ (param, Qforeground_color))
4531 face = Qdefault;
4532 lface = lface_from_face_name (f, face, 1);
4533 LFACE_FOREGROUND (lface) = (STRINGP (new_value)
4534 ? new_value : Qunspecified);
4535 realize_basic_faces (f);
4537 else if (EQ (param, Qbackground_color))
4539 Lisp_Object frame;
4541 /* Changing the background color might change the background
4542 mode, so that we have to load new defface specs.
4543 Call frame-set-background-mode to do that. */
4544 XSETFRAME (frame, f);
4545 call1 (Qframe_set_background_mode, frame);
4547 face = Qdefault;
4548 lface = lface_from_face_name (f, face, 1);
4549 LFACE_BACKGROUND (lface) = (STRINGP (new_value)
4550 ? new_value : Qunspecified);
4551 realize_basic_faces (f);
4553 else if (EQ (param, Qborder_color))
4555 face = Qborder;
4556 lface = lface_from_face_name (f, face, 1);
4557 LFACE_BACKGROUND (lface) = (STRINGP (new_value)
4558 ? new_value : Qunspecified);
4560 else if (EQ (param, Qcursor_color))
4562 face = Qcursor;
4563 lface = lface_from_face_name (f, face, 1);
4564 LFACE_BACKGROUND (lface) = (STRINGP (new_value)
4565 ? new_value : Qunspecified);
4567 else if (EQ (param, Qmouse_color))
4569 face = Qmouse;
4570 lface = lface_from_face_name (f, face, 1);
4571 LFACE_BACKGROUND (lface) = (STRINGP (new_value)
4572 ? new_value : Qunspecified);
4575 /* Changing a named face means that all realized faces depending on
4576 that face are invalid. Since we cannot tell which realized faces
4577 depend on the face, make sure they are all removed. This is done
4578 by incrementing face_change_count. The next call to
4579 init_iterator will then free realized faces. */
4580 if (!NILP (face)
4581 && NILP (Fget (face, Qface_no_inherit)))
4583 ++face_change_count;
4584 ++windows_or_buffers_changed;
4589 /* Get the value of X resource RESOURCE, class CLASS for the display
4590 of frame FRAME. This is here because ordinary `x-get-resource'
4591 doesn't take a frame argument. */
4593 DEFUN ("internal-face-x-get-resource", Finternal_face_x_get_resource,
4594 Sinternal_face_x_get_resource, 3, 3, 0, doc: /* */)
4595 (resource, class, frame)
4596 Lisp_Object resource, class, frame;
4598 Lisp_Object value = Qnil;
4599 CHECK_STRING (resource);
4600 CHECK_STRING (class);
4601 CHECK_LIVE_FRAME (frame);
4602 BLOCK_INPUT;
4603 value = display_x_get_resource (FRAME_X_DISPLAY_INFO (XFRAME (frame)),
4604 resource, class, Qnil, Qnil);
4605 UNBLOCK_INPUT;
4606 return value;
4610 /* Return resource string VALUE as a boolean value, i.e. nil, or t.
4611 If VALUE is "on" or "true", return t. If VALUE is "off" or
4612 "false", return nil. Otherwise, if SIGNAL_P is non-zero, signal an
4613 error; if SIGNAL_P is zero, return 0. */
4615 static Lisp_Object
4616 face_boolean_x_resource_value (value, signal_p)
4617 Lisp_Object value;
4618 int signal_p;
4620 Lisp_Object result = make_number (0);
4622 xassert (STRINGP (value));
4624 if (xstricmp (SDATA (value), "on") == 0
4625 || xstricmp (SDATA (value), "true") == 0)
4626 result = Qt;
4627 else if (xstricmp (SDATA (value), "off") == 0
4628 || xstricmp (SDATA (value), "false") == 0)
4629 result = Qnil;
4630 else if (xstricmp (SDATA (value), "unspecified") == 0)
4631 result = Qunspecified;
4632 else if (signal_p)
4633 signal_error ("Invalid face attribute value from X resource", value);
4635 return result;
4639 DEFUN ("internal-set-lisp-face-attribute-from-resource",
4640 Finternal_set_lisp_face_attribute_from_resource,
4641 Sinternal_set_lisp_face_attribute_from_resource,
4642 3, 4, 0, doc: /* */)
4643 (face, attr, value, frame)
4644 Lisp_Object face, attr, value, frame;
4646 CHECK_SYMBOL (face);
4647 CHECK_SYMBOL (attr);
4648 CHECK_STRING (value);
4650 if (xstricmp (SDATA (value), "unspecified") == 0)
4651 value = Qunspecified;
4652 else if (EQ (attr, QCheight))
4654 value = Fstring_to_number (value, make_number (10));
4655 if (XINT (value) <= 0)
4656 signal_error ("Invalid face height from X resource", value);
4658 else if (EQ (attr, QCbold) || EQ (attr, QCitalic))
4659 value = face_boolean_x_resource_value (value, 1);
4660 else if (EQ (attr, QCweight) || EQ (attr, QCslant) || EQ (attr, QCwidth))
4661 value = intern (SDATA (value));
4662 else if (EQ (attr, QCreverse_video) || EQ (attr, QCinverse_video))
4663 value = face_boolean_x_resource_value (value, 1);
4664 else if (EQ (attr, QCunderline)
4665 || EQ (attr, QCoverline)
4666 || EQ (attr, QCstrike_through))
4668 Lisp_Object boolean_value;
4670 /* If the result of face_boolean_x_resource_value is t or nil,
4671 VALUE does NOT specify a color. */
4672 boolean_value = face_boolean_x_resource_value (value, 0);
4673 if (SYMBOLP (boolean_value))
4674 value = boolean_value;
4676 else if (EQ (attr, QCbox) || EQ (attr, QCinherit))
4677 value = Fcar (Fread_from_string (value, Qnil, Qnil));
4679 return Finternal_set_lisp_face_attribute (face, attr, value, frame);
4682 #endif /* HAVE_WINDOW_SYSTEM */
4685 /***********************************************************************
4686 Menu face
4687 ***********************************************************************/
4689 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
4691 /* Make menus on frame F appear as specified by the `menu' face. */
4693 static void
4694 x_update_menu_appearance (f)
4695 struct frame *f;
4697 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
4698 XrmDatabase rdb;
4700 if (dpyinfo
4701 && (rdb = XrmGetDatabase (FRAME_X_DISPLAY (f)),
4702 rdb != NULL))
4704 char line[512];
4705 Lisp_Object lface = lface_from_face_name (f, Qmenu, 1);
4706 struct face *face = FACE_FROM_ID (f, MENU_FACE_ID);
4707 const char *myname = SDATA (Vx_resource_name);
4708 int changed_p = 0;
4709 #ifdef USE_MOTIF
4710 const char *popup_path = "popup_menu";
4711 #else
4712 const char *popup_path = "menu.popup";
4713 #endif
4715 if (STRINGP (LFACE_FOREGROUND (lface)))
4717 sprintf (line, "%s.%s*foreground: %s",
4718 myname, popup_path,
4719 SDATA (LFACE_FOREGROUND (lface)));
4720 XrmPutLineResource (&rdb, line);
4721 sprintf (line, "%s.pane.menubar*foreground: %s",
4722 myname, SDATA (LFACE_FOREGROUND (lface)));
4723 XrmPutLineResource (&rdb, line);
4724 changed_p = 1;
4727 if (STRINGP (LFACE_BACKGROUND (lface)))
4729 sprintf (line, "%s.%s*background: %s",
4730 myname, popup_path,
4731 SDATA (LFACE_BACKGROUND (lface)));
4732 XrmPutLineResource (&rdb, line);
4733 sprintf (line, "%s.pane.menubar*background: %s",
4734 myname, SDATA (LFACE_BACKGROUND (lface)));
4735 XrmPutLineResource (&rdb, line);
4736 changed_p = 1;
4739 if (face->font_name
4740 && (!UNSPECIFIEDP (LFACE_FAMILY (lface))
4741 || !UNSPECIFIEDP (LFACE_SWIDTH (lface))
4742 || !UNSPECIFIEDP (LFACE_AVGWIDTH (lface))
4743 || !UNSPECIFIEDP (LFACE_WEIGHT (lface))
4744 || !UNSPECIFIEDP (LFACE_SLANT (lface))
4745 || !UNSPECIFIEDP (LFACE_HEIGHT (lface))))
4747 #ifdef USE_MOTIF
4748 const char *suffix = "List";
4749 Bool motif = True;
4750 #else
4751 #if defined HAVE_X_I18N
4753 const char *suffix = "Set";
4754 #else
4755 const char *suffix = "";
4756 #endif
4757 Bool motif = False;
4758 #endif
4759 #if defined HAVE_X_I18N
4760 extern char *xic_create_fontsetname
4761 P_ ((char *base_fontname, Bool motif));
4762 char *fontsetname = xic_create_fontsetname (face->font_name, motif);
4763 #else
4764 char *fontsetname = face->font_name;
4765 #endif
4766 sprintf (line, "%s.pane.menubar*font%s: %s",
4767 myname, suffix, fontsetname);
4768 XrmPutLineResource (&rdb, line);
4769 sprintf (line, "%s.%s*font%s: %s",
4770 myname, popup_path, suffix, fontsetname);
4771 XrmPutLineResource (&rdb, line);
4772 changed_p = 1;
4773 if (fontsetname != face->font_name)
4774 xfree (fontsetname);
4777 if (changed_p && f->output_data.x->menubar_widget)
4778 free_frame_menubar (f);
4782 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
4785 DEFUN ("face-attribute-relative-p", Fface_attribute_relative_p,
4786 Sface_attribute_relative_p,
4787 2, 2, 0,
4788 doc: /* Check whether a face attribute value is relative.
4789 Specifically, this function returns t if the attribute ATTRIBUTE
4790 with the value VALUE is relative.
4792 A relative value is one that doesn't entirely override whatever is
4793 inherited from another face. For most possible attributes,
4794 the only relative value that users see is `unspecified'.
4795 However, for :height, floating point values are also relative. */)
4796 (attribute, value)
4797 Lisp_Object attribute, value;
4799 if (EQ (value, Qunspecified) || (EQ (value, Qignore_defface)))
4800 return Qt;
4801 else if (EQ (attribute, QCheight))
4802 return INTEGERP (value) ? Qnil : Qt;
4803 else
4804 return Qnil;
4807 DEFUN ("merge-face-attribute", Fmerge_face_attribute, Smerge_face_attribute,
4808 3, 3, 0,
4809 doc: /* Return face ATTRIBUTE VALUE1 merged with VALUE2.
4810 If VALUE1 or VALUE2 are absolute (see `face-attribute-relative-p'), then
4811 the result will be absolute, otherwise it will be relative. */)
4812 (attribute, value1, value2)
4813 Lisp_Object attribute, value1, value2;
4815 if (EQ (value1, Qunspecified) || EQ (value1, Qignore_defface))
4816 return value2;
4817 else if (EQ (attribute, QCheight))
4818 return merge_face_heights (value1, value2, value1);
4819 else
4820 return value1;
4824 DEFUN ("internal-get-lisp-face-attribute", Finternal_get_lisp_face_attribute,
4825 Sinternal_get_lisp_face_attribute,
4826 2, 3, 0,
4827 doc: /* Return face attribute KEYWORD of face SYMBOL.
4828 If SYMBOL does not name a valid Lisp face or KEYWORD isn't a valid
4829 face attribute name, signal an error.
4830 If the optional argument FRAME is given, report on face SYMBOL in that
4831 frame. If FRAME is t, report on the defaults for face SYMBOL (for new
4832 frames). If FRAME is omitted or nil, use the selected frame. */)
4833 (symbol, keyword, frame)
4834 Lisp_Object symbol, keyword, frame;
4836 Lisp_Object lface, value = Qnil;
4838 CHECK_SYMBOL (symbol);
4839 CHECK_SYMBOL (keyword);
4841 if (EQ (frame, Qt))
4842 lface = lface_from_face_name (NULL, symbol, 1);
4843 else
4845 if (NILP (frame))
4846 frame = selected_frame;
4847 CHECK_LIVE_FRAME (frame);
4848 lface = lface_from_face_name (XFRAME (frame), symbol, 1);
4851 if (EQ (keyword, QCfamily))
4852 value = LFACE_FAMILY (lface);
4853 else if (EQ (keyword, QCheight))
4854 value = LFACE_HEIGHT (lface);
4855 else if (EQ (keyword, QCweight))
4856 value = LFACE_WEIGHT (lface);
4857 else if (EQ (keyword, QCslant))
4858 value = LFACE_SLANT (lface);
4859 else if (EQ (keyword, QCunderline))
4860 value = LFACE_UNDERLINE (lface);
4861 else if (EQ (keyword, QCoverline))
4862 value = LFACE_OVERLINE (lface);
4863 else if (EQ (keyword, QCstrike_through))
4864 value = LFACE_STRIKE_THROUGH (lface);
4865 else if (EQ (keyword, QCbox))
4866 value = LFACE_BOX (lface);
4867 else if (EQ (keyword, QCinverse_video)
4868 || EQ (keyword, QCreverse_video))
4869 value = LFACE_INVERSE (lface);
4870 else if (EQ (keyword, QCforeground))
4871 value = LFACE_FOREGROUND (lface);
4872 else if (EQ (keyword, QCbackground))
4873 value = LFACE_BACKGROUND (lface);
4874 else if (EQ (keyword, QCstipple))
4875 value = LFACE_STIPPLE (lface);
4876 else if (EQ (keyword, QCwidth))
4877 value = LFACE_SWIDTH (lface);
4878 else if (EQ (keyword, QCinherit))
4879 value = LFACE_INHERIT (lface);
4880 else if (EQ (keyword, QCfont))
4881 value = LFACE_FONT (lface);
4882 else
4883 signal_error ("Invalid face attribute name", keyword);
4885 if (IGNORE_DEFFACE_P (value))
4886 return Qunspecified;
4888 return value;
4892 DEFUN ("internal-lisp-face-attribute-values",
4893 Finternal_lisp_face_attribute_values,
4894 Sinternal_lisp_face_attribute_values, 1, 1, 0,
4895 doc: /* Return a list of valid discrete values for face attribute ATTR.
4896 Value is nil if ATTR doesn't have a discrete set of valid values. */)
4897 (attr)
4898 Lisp_Object attr;
4900 Lisp_Object result = Qnil;
4902 CHECK_SYMBOL (attr);
4904 if (EQ (attr, QCweight)
4905 || EQ (attr, QCslant)
4906 || EQ (attr, QCwidth))
4908 /* Extract permissible symbols from tables. */
4909 struct table_entry *table;
4910 int i, dim;
4912 if (EQ (attr, QCweight))
4913 table = weight_table, dim = DIM (weight_table);
4914 else if (EQ (attr, QCslant))
4915 table = slant_table, dim = DIM (slant_table);
4916 else
4917 table = swidth_table, dim = DIM (swidth_table);
4919 for (i = 0; i < dim; ++i)
4921 Lisp_Object symbol = *table[i].symbol;
4922 Lisp_Object tail = result;
4924 while (!NILP (tail)
4925 && !EQ (XCAR (tail), symbol))
4926 tail = XCDR (tail);
4928 if (NILP (tail))
4929 result = Fcons (symbol, result);
4932 else if (EQ (attr, QCunderline))
4933 result = Fcons (Qt, Fcons (Qnil, Qnil));
4934 else if (EQ (attr, QCoverline))
4935 result = Fcons (Qt, Fcons (Qnil, Qnil));
4936 else if (EQ (attr, QCstrike_through))
4937 result = Fcons (Qt, Fcons (Qnil, Qnil));
4938 else if (EQ (attr, QCinverse_video) || EQ (attr, QCreverse_video))
4939 result = Fcons (Qt, Fcons (Qnil, Qnil));
4941 return result;
4945 DEFUN ("internal-merge-in-global-face", Finternal_merge_in_global_face,
4946 Sinternal_merge_in_global_face, 2, 2, 0,
4947 doc: /* Add attributes from frame-default definition of FACE to FACE on FRAME.
4948 Default face attributes override any local face attributes. */)
4949 (face, frame)
4950 Lisp_Object face, frame;
4952 int i;
4953 Lisp_Object global_lface, local_lface, *gvec, *lvec;
4955 CHECK_LIVE_FRAME (frame);
4956 global_lface = lface_from_face_name (NULL, face, 1);
4957 local_lface = lface_from_face_name (XFRAME (frame), face, 0);
4958 if (NILP (local_lface))
4959 local_lface = Finternal_make_lisp_face (face, frame);
4961 /* Make every specified global attribute override the local one.
4962 BEWARE!! This is only used from `face-set-after-frame-default' where
4963 the local frame is defined from default specs in `face-defface-spec'
4964 and those should be overridden by global settings. Hence the strange
4965 "global before local" priority. */
4966 lvec = XVECTOR (local_lface)->contents;
4967 gvec = XVECTOR (global_lface)->contents;
4968 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
4969 if (! UNSPECIFIEDP (gvec[i]))
4971 if (IGNORE_DEFFACE_P (gvec[i]))
4972 lvec[i] = Qunspecified;
4973 else
4974 lvec[i] = gvec[i];
4977 return Qnil;
4981 /* The following function is implemented for compatibility with 20.2.
4982 The function is used in x-resolve-fonts when it is asked to
4983 return fonts with the same size as the font of a face. This is
4984 done in fontset.el. */
4986 DEFUN ("face-font", Fface_font, Sface_font, 1, 2, 0,
4987 doc: /* Return the font name of face FACE, or nil if it is unspecified.
4988 If the optional argument FRAME is given, report on face FACE in that frame.
4989 If FRAME is t, report on the defaults for face FACE (for new frames).
4990 The font default for a face is either nil, or a list
4991 of the form (bold), (italic) or (bold italic).
4992 If FRAME is omitted or nil, use the selected frame. */)
4993 (face, frame)
4994 Lisp_Object face, frame;
4996 if (EQ (frame, Qt))
4998 Lisp_Object result = Qnil;
4999 Lisp_Object lface = lface_from_face_name (NULL, face, 1);
5001 if (!UNSPECIFIEDP (LFACE_WEIGHT (lface))
5002 && !EQ (LFACE_WEIGHT (lface), Qnormal))
5003 result = Fcons (Qbold, result);
5005 if (!UNSPECIFIEDP (LFACE_SLANT (lface))
5006 && !EQ (LFACE_SLANT (lface), Qnormal))
5007 result = Fcons (Qitalic, result);
5009 return result;
5011 else
5013 struct frame *f = frame_or_selected_frame (frame, 1);
5014 int face_id = lookup_named_face (f, face, 0, 1);
5015 struct face *face = FACE_FROM_ID (f, face_id);
5016 return face ? build_string (face->font_name) : Qnil;
5021 /* Compare face-attribute values v1 and v2 for equality. Value is non-zero if
5022 all attributes are `equal'. Tries to be fast because this function
5023 is called quite often. */
5025 static INLINE int
5026 face_attr_equal_p (v1, v2)
5027 Lisp_Object v1, v2;
5029 /* Type can differ, e.g. when one attribute is unspecified, i.e. nil,
5030 and the other is specified. */
5031 if (XTYPE (v1) != XTYPE (v2))
5032 return 0;
5034 if (EQ (v1, v2))
5035 return 1;
5037 switch (XTYPE (v1))
5039 case Lisp_String:
5040 if (SBYTES (v1) != SBYTES (v2))
5041 return 0;
5043 return bcmp (SDATA (v1), SDATA (v2), SBYTES (v1)) == 0;
5045 case Lisp_Int:
5046 case Lisp_Symbol:
5047 return 0;
5049 default:
5050 return !NILP (Fequal (v1, v2));
5055 /* Compare face vectors V1 and V2 for equality. Value is non-zero if
5056 all attributes are `equal'. Tries to be fast because this function
5057 is called quite often. */
5059 static INLINE int
5060 lface_equal_p (v1, v2)
5061 Lisp_Object *v1, *v2;
5063 int i, equal_p = 1;
5065 for (i = 1; i < LFACE_VECTOR_SIZE && equal_p; ++i)
5066 equal_p = face_attr_equal_p (v1[i], v2[i]);
5068 return equal_p;
5072 DEFUN ("internal-lisp-face-equal-p", Finternal_lisp_face_equal_p,
5073 Sinternal_lisp_face_equal_p, 2, 3, 0,
5074 doc: /* True if FACE1 and FACE2 are equal.
5075 If the optional argument FRAME is given, report on FACE1 and FACE2 in that frame.
5076 If FRAME is t, report on the defaults for FACE1 and FACE2 (for new frames).
5077 If FRAME is omitted or nil, use the selected frame. */)
5078 (face1, face2, frame)
5079 Lisp_Object face1, face2, frame;
5081 int equal_p;
5082 struct frame *f;
5083 Lisp_Object lface1, lface2;
5085 if (EQ (frame, Qt))
5086 f = NULL;
5087 else
5088 /* Don't use check_x_frame here because this function is called
5089 before X frames exist. At that time, if FRAME is nil,
5090 selected_frame will be used which is the frame dumped with
5091 Emacs. That frame is not an X frame. */
5092 f = frame_or_selected_frame (frame, 2);
5094 lface1 = lface_from_face_name (f, face1, 1);
5095 lface2 = lface_from_face_name (f, face2, 1);
5096 equal_p = lface_equal_p (XVECTOR (lface1)->contents,
5097 XVECTOR (lface2)->contents);
5098 return equal_p ? Qt : Qnil;
5102 DEFUN ("internal-lisp-face-empty-p", Finternal_lisp_face_empty_p,
5103 Sinternal_lisp_face_empty_p, 1, 2, 0,
5104 doc: /* True if FACE has no attribute specified.
5105 If the optional argument FRAME is given, report on face FACE in that frame.
5106 If FRAME is t, report on the defaults for face FACE (for new frames).
5107 If FRAME is omitted or nil, use the selected frame. */)
5108 (face, frame)
5109 Lisp_Object face, frame;
5111 struct frame *f;
5112 Lisp_Object lface;
5113 int i;
5115 if (NILP (frame))
5116 frame = selected_frame;
5117 CHECK_LIVE_FRAME (frame);
5118 f = XFRAME (frame);
5120 if (EQ (frame, Qt))
5121 lface = lface_from_face_name (NULL, face, 1);
5122 else
5123 lface = lface_from_face_name (f, face, 1);
5125 for (i = 1; i < LFACE_VECTOR_SIZE; ++i)
5126 if (!UNSPECIFIEDP (AREF (lface, i)))
5127 break;
5129 return i == LFACE_VECTOR_SIZE ? Qt : Qnil;
5133 DEFUN ("frame-face-alist", Fframe_face_alist, Sframe_face_alist,
5134 0, 1, 0,
5135 doc: /* Return an alist of frame-local faces defined on FRAME.
5136 For internal use only. */)
5137 (frame)
5138 Lisp_Object frame;
5140 struct frame *f = frame_or_selected_frame (frame, 0);
5141 return f->face_alist;
5145 /* Return a hash code for Lisp string STRING with case ignored. Used
5146 below in computing a hash value for a Lisp face. */
5148 static INLINE unsigned
5149 hash_string_case_insensitive (string)
5150 Lisp_Object string;
5152 const unsigned char *s;
5153 unsigned hash = 0;
5154 xassert (STRINGP (string));
5155 for (s = SDATA (string); *s; ++s)
5156 hash = (hash << 1) ^ tolower (*s);
5157 return hash;
5161 /* Return a hash code for face attribute vector V. */
5163 static INLINE unsigned
5164 lface_hash (v)
5165 Lisp_Object *v;
5167 return (hash_string_case_insensitive (v[LFACE_FAMILY_INDEX])
5168 ^ hash_string_case_insensitive (v[LFACE_FOREGROUND_INDEX])
5169 ^ hash_string_case_insensitive (v[LFACE_BACKGROUND_INDEX])
5170 ^ XFASTINT (v[LFACE_WEIGHT_INDEX])
5171 ^ XFASTINT (v[LFACE_SLANT_INDEX])
5172 ^ XFASTINT (v[LFACE_SWIDTH_INDEX])
5173 ^ XFASTINT (v[LFACE_HEIGHT_INDEX]));
5177 /* Return non-zero if LFACE1 and LFACE2 specify the same font (without
5178 considering charsets/registries). They do if they specify the same
5179 family, point size, weight, width, slant, and fontset. Both LFACE1
5180 and LFACE2 must be fully-specified. */
5182 static INLINE int
5183 lface_same_font_attributes_p (lface1, lface2)
5184 Lisp_Object *lface1, *lface2;
5186 xassert (lface_fully_specified_p (lface1)
5187 && lface_fully_specified_p (lface2));
5188 return (xstricmp (SDATA (lface1[LFACE_FAMILY_INDEX]),
5189 SDATA (lface2[LFACE_FAMILY_INDEX])) == 0
5190 && EQ (lface1[LFACE_HEIGHT_INDEX], lface2[LFACE_HEIGHT_INDEX])
5191 && EQ (lface1[LFACE_SWIDTH_INDEX], lface2[LFACE_SWIDTH_INDEX])
5192 && EQ (lface1[LFACE_AVGWIDTH_INDEX], lface2[LFACE_AVGWIDTH_INDEX])
5193 && EQ (lface1[LFACE_WEIGHT_INDEX], lface2[LFACE_WEIGHT_INDEX])
5194 && EQ (lface1[LFACE_SLANT_INDEX], lface2[LFACE_SLANT_INDEX])
5195 && (EQ (lface1[LFACE_FONT_INDEX], lface2[LFACE_FONT_INDEX])
5196 || (STRINGP (lface1[LFACE_FONT_INDEX])
5197 && STRINGP (lface2[LFACE_FONT_INDEX])
5198 && xstricmp (SDATA (lface1[LFACE_FONT_INDEX]),
5199 SDATA (lface2[LFACE_FONT_INDEX])))));
5204 /***********************************************************************
5205 Realized Faces
5206 ***********************************************************************/
5208 /* Allocate and return a new realized face for Lisp face attribute
5209 vector ATTR. */
5211 static struct face *
5212 make_realized_face (attr)
5213 Lisp_Object *attr;
5215 struct face *face = (struct face *) xmalloc (sizeof *face);
5216 bzero (face, sizeof *face);
5217 face->ascii_face = face;
5218 bcopy (attr, face->lface, sizeof face->lface);
5219 return face;
5223 /* Free realized face FACE, including its X resources. FACE may
5224 be null. */
5226 static void
5227 free_realized_face (f, face)
5228 struct frame *f;
5229 struct face *face;
5231 if (face)
5233 #ifdef HAVE_WINDOW_SYSTEM
5234 if (FRAME_WINDOW_P (f))
5236 /* Free fontset of FACE if it is ASCII face. */
5237 if (face->fontset >= 0 && face == face->ascii_face)
5238 free_face_fontset (f, face);
5239 if (face->gc)
5241 x_free_gc (f, face->gc);
5242 face->gc = 0;
5245 free_face_colors (f, face);
5246 x_destroy_bitmap (f, face->stipple);
5248 #endif /* HAVE_WINDOW_SYSTEM */
5250 xfree (face);
5255 /* Prepare face FACE for subsequent display on frame F. This
5256 allocated GCs if they haven't been allocated yet or have been freed
5257 by clearing the face cache. */
5259 void
5260 prepare_face_for_display (f, face)
5261 struct frame *f;
5262 struct face *face;
5264 #ifdef HAVE_WINDOW_SYSTEM
5265 xassert (FRAME_WINDOW_P (f));
5267 if (face->gc == 0)
5269 XGCValues xgcv;
5270 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
5272 xgcv.foreground = face->foreground;
5273 xgcv.background = face->background;
5274 #ifdef HAVE_X_WINDOWS
5275 xgcv.graphics_exposures = False;
5276 #endif
5277 /* The font of FACE may be null if we couldn't load it. */
5278 if (face->font)
5280 #ifdef HAVE_X_WINDOWS
5281 xgcv.font = face->font->fid;
5282 #endif
5283 #ifdef WINDOWSNT
5284 xgcv.font = face->font;
5285 #endif
5286 #ifdef MAC_OS
5287 xgcv.font = face->font;
5288 #endif
5289 mask |= GCFont;
5292 BLOCK_INPUT;
5293 #ifdef HAVE_X_WINDOWS
5294 if (face->stipple)
5296 xgcv.fill_style = FillOpaqueStippled;
5297 xgcv.stipple = x_bitmap_pixmap (f, face->stipple);
5298 mask |= GCFillStyle | GCStipple;
5300 #endif
5301 face->gc = x_create_gc (f, mask, &xgcv);
5302 UNBLOCK_INPUT;
5304 #endif /* HAVE_WINDOW_SYSTEM */
5308 /* Returns the `distance' between the colors X and Y. */
5310 static int
5311 color_distance (x, y)
5312 XColor *x, *y;
5314 /* This formula is from a paper title `Colour metric' by Thiadmer Riemersma.
5315 Quoting from that paper:
5317 This formula has results that are very close to L*u*v* (with the
5318 modified lightness curve) and, more importantly, it is a more even
5319 algorithm: it does not have a range of colours where it suddenly
5320 gives far from optimal results.
5322 See <http://www.compuphase.com/cmetric.htm> for more info. */
5324 long r = (x->red - y->red) >> 8;
5325 long g = (x->green - y->green) >> 8;
5326 long b = (x->blue - y->blue) >> 8;
5327 long r_mean = (x->red + y->red) >> 9;
5329 return
5330 (((512 + r_mean) * r * r) >> 8)
5331 + 4 * g * g
5332 + (((767 - r_mean) * b * b) >> 8);
5336 DEFUN ("color-distance", Fcolor_distance, Scolor_distance, 2, 3, 0,
5337 doc: /* Return an integer distance between COLOR1 and COLOR2 on FRAME.
5338 COLOR1 and COLOR2 may be either strings containing the color name,
5339 or lists of the form (RED GREEN BLUE).
5340 If FRAME is unspecified or nil, the current frame is used. */)
5341 (color1, color2, frame)
5342 Lisp_Object color1, color2, frame;
5344 struct frame *f;
5345 XColor cdef1, cdef2;
5347 if (NILP (frame))
5348 frame = selected_frame;
5349 CHECK_LIVE_FRAME (frame);
5350 f = XFRAME (frame);
5352 if (!(CONSP (color1) && parse_rgb_list (color1, &cdef1))
5353 && !(STRINGP (color1) && defined_color (f, SDATA (color1), &cdef1, 0)))
5354 signal_error ("Invalid color", color1);
5355 if (!(CONSP (color2) && parse_rgb_list (color2, &cdef2))
5356 && !(STRINGP (color2) && defined_color (f, SDATA (color2), &cdef2, 0)))
5357 signal_error ("Invalid color", color2);
5359 return make_number (color_distance (&cdef1, &cdef2));
5363 /***********************************************************************
5364 Face Cache
5365 ***********************************************************************/
5367 /* Return a new face cache for frame F. */
5369 static struct face_cache *
5370 make_face_cache (f)
5371 struct frame *f;
5373 struct face_cache *c;
5374 int size;
5376 c = (struct face_cache *) xmalloc (sizeof *c);
5377 bzero (c, sizeof *c);
5378 size = FACE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
5379 c->buckets = (struct face **) xmalloc (size);
5380 bzero (c->buckets, size);
5381 c->size = 50;
5382 c->faces_by_id = (struct face **) xmalloc (c->size * sizeof *c->faces_by_id);
5383 c->f = f;
5384 c->menu_face_changed_p = menu_face_changed_default;
5385 return c;
5389 /* Clear out all graphics contexts for all realized faces, except for
5390 the basic faces. This should be done from time to time just to avoid
5391 keeping too many graphics contexts that are no longer needed. */
5393 static void
5394 clear_face_gcs (c)
5395 struct face_cache *c;
5397 if (c && FRAME_WINDOW_P (c->f))
5399 #ifdef HAVE_WINDOW_SYSTEM
5400 int i;
5401 for (i = BASIC_FACE_ID_SENTINEL; i < c->used; ++i)
5403 struct face *face = c->faces_by_id[i];
5404 if (face && face->gc)
5406 x_free_gc (c->f, face->gc);
5407 face->gc = 0;
5410 #endif /* HAVE_WINDOW_SYSTEM */
5415 /* Free all realized faces in face cache C, including basic faces.
5416 C may be null. If faces are freed, make sure the frame's current
5417 matrix is marked invalid, so that a display caused by an expose
5418 event doesn't try to use faces we destroyed. */
5420 static void
5421 free_realized_faces (c)
5422 struct face_cache *c;
5424 if (c && c->used)
5426 int i, size;
5427 struct frame *f = c->f;
5429 /* We must block input here because we can't process X events
5430 safely while only some faces are freed, or when the frame's
5431 current matrix still references freed faces. */
5432 BLOCK_INPUT;
5434 for (i = 0; i < c->used; ++i)
5436 free_realized_face (f, c->faces_by_id[i]);
5437 c->faces_by_id[i] = NULL;
5440 c->used = 0;
5441 size = FACE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
5442 bzero (c->buckets, size);
5444 /* Must do a thorough redisplay the next time. Mark current
5445 matrices as invalid because they will reference faces freed
5446 above. This function is also called when a frame is
5447 destroyed. In this case, the root window of F is nil. */
5448 if (WINDOWP (f->root_window))
5450 clear_current_matrices (f);
5451 ++windows_or_buffers_changed;
5454 UNBLOCK_INPUT;
5459 /* Free all faces realized for multibyte characters on frame F that
5460 has FONTSET. */
5462 void
5463 free_realized_multibyte_face (f, fontset)
5464 struct frame *f;
5465 int fontset;
5467 struct face_cache *cache = FRAME_FACE_CACHE (f);
5468 struct face *face;
5469 int i;
5471 /* We must block input here because we can't process X events safely
5472 while only some faces are freed, or when the frame's current
5473 matrix still references freed faces. */
5474 BLOCK_INPUT;
5476 for (i = 0; i < cache->used; i++)
5478 face = cache->faces_by_id[i];
5479 if (face
5480 && face != face->ascii_face
5481 && face->fontset == fontset)
5483 uncache_face (cache, face);
5484 free_realized_face (f, face);
5488 /* Must do a thorough redisplay the next time. Mark current
5489 matrices as invalid because they will reference faces freed
5490 above. This function is also called when a frame is destroyed.
5491 In this case, the root window of F is nil. */
5492 if (WINDOWP (f->root_window))
5494 clear_current_matrices (f);
5495 ++windows_or_buffers_changed;
5498 UNBLOCK_INPUT;
5502 /* Free all realized faces on FRAME or on all frames if FRAME is nil.
5503 This is done after attributes of a named face have been changed,
5504 because we can't tell which realized faces depend on that face. */
5506 void
5507 free_all_realized_faces (frame)
5508 Lisp_Object frame;
5510 if (NILP (frame))
5512 Lisp_Object rest;
5513 FOR_EACH_FRAME (rest, frame)
5514 free_realized_faces (FRAME_FACE_CACHE (XFRAME (frame)));
5516 else
5517 free_realized_faces (FRAME_FACE_CACHE (XFRAME (frame)));
5521 /* Free face cache C and faces in it, including their X resources. */
5523 static void
5524 free_face_cache (c)
5525 struct face_cache *c;
5527 if (c)
5529 free_realized_faces (c);
5530 xfree (c->buckets);
5531 xfree (c->faces_by_id);
5532 xfree (c);
5537 /* Cache realized face FACE in face cache C. HASH is the hash value
5538 of FACE. If FACE->fontset >= 0, add the new face to the end of the
5539 collision list of the face hash table of C. This is done because
5540 otherwise lookup_face would find FACE for every character, even if
5541 faces with the same attributes but for specific characters exist. */
5543 static void
5544 cache_face (c, face, hash)
5545 struct face_cache *c;
5546 struct face *face;
5547 unsigned hash;
5549 int i = hash % FACE_CACHE_BUCKETS_SIZE;
5551 face->hash = hash;
5553 if (face->fontset >= 0)
5555 struct face *last = c->buckets[i];
5556 if (last)
5558 while (last->next)
5559 last = last->next;
5560 last->next = face;
5561 face->prev = last;
5562 face->next = NULL;
5564 else
5566 c->buckets[i] = face;
5567 face->prev = face->next = NULL;
5570 else
5572 face->prev = NULL;
5573 face->next = c->buckets[i];
5574 if (face->next)
5575 face->next->prev = face;
5576 c->buckets[i] = face;
5579 /* Find a free slot in C->faces_by_id and use the index of the free
5580 slot as FACE->id. */
5581 for (i = 0; i < c->used; ++i)
5582 if (c->faces_by_id[i] == NULL)
5583 break;
5584 face->id = i;
5586 /* Maybe enlarge C->faces_by_id. */
5587 if (i == c->used)
5589 if (c->used == c->size)
5591 int new_size, sz;
5592 new_size = min (2 * c->size, MAX_FACE_ID);
5593 if (new_size == c->size)
5594 abort (); /* Alternatives? ++kfs */
5595 sz = new_size * sizeof *c->faces_by_id;
5596 c->faces_by_id = (struct face **) xrealloc (c->faces_by_id, sz);
5597 c->size = new_size;
5599 c->used++;
5602 #if GLYPH_DEBUG
5603 /* Check that FACE got a unique id. */
5605 int j, n;
5606 struct face *face;
5608 for (j = n = 0; j < FACE_CACHE_BUCKETS_SIZE; ++j)
5609 for (face = c->buckets[j]; face; face = face->next)
5610 if (face->id == i)
5611 ++n;
5613 xassert (n == 1);
5615 #endif /* GLYPH_DEBUG */
5617 c->faces_by_id[i] = face;
5621 /* Remove face FACE from cache C. */
5623 static void
5624 uncache_face (c, face)
5625 struct face_cache *c;
5626 struct face *face;
5628 int i = face->hash % FACE_CACHE_BUCKETS_SIZE;
5630 if (face->prev)
5631 face->prev->next = face->next;
5632 else
5633 c->buckets[i] = face->next;
5635 if (face->next)
5636 face->next->prev = face->prev;
5638 c->faces_by_id[face->id] = NULL;
5639 if (face->id == c->used)
5640 --c->used;
5644 /* Look up a realized face with face attributes ATTR in the face cache
5645 of frame F. The face will be used to display character C. Value
5646 is the ID of the face found. If no suitable face is found, realize
5647 a new one. In that case, if C is a multibyte character, BASE_FACE
5648 is a face that has the same attributes. */
5650 INLINE int
5651 lookup_face (f, attr, c, base_face)
5652 struct frame *f;
5653 Lisp_Object *attr;
5654 int c;
5655 struct face *base_face;
5657 struct face_cache *cache = FRAME_FACE_CACHE (f);
5658 unsigned hash;
5659 int i;
5660 struct face *face;
5662 xassert (cache != NULL);
5663 check_lface_attrs (attr);
5665 /* Look up ATTR in the face cache. */
5666 hash = lface_hash (attr);
5667 i = hash % FACE_CACHE_BUCKETS_SIZE;
5669 for (face = cache->buckets[i]; face; face = face->next)
5670 if (face->hash == hash
5671 && (!FRAME_WINDOW_P (f)
5672 || FACE_SUITABLE_FOR_CHAR_P (face, c))
5673 && lface_equal_p (face->lface, attr))
5674 break;
5676 /* If not found, realize a new face. */
5677 if (face == NULL)
5678 face = realize_face (cache, attr, c, base_face, -1);
5680 #if GLYPH_DEBUG
5681 xassert (face == FACE_FROM_ID (f, face->id));
5683 /* When this function is called from face_for_char (in this case, C is
5684 a multibyte character), a fontset of a face returned by
5685 realize_face is not yet set, i.e. FACE_SUITABLE_FOR_CHAR_P (FACE,
5686 C) is not sutisfied. The fontset is set for this face by
5687 face_for_char later. */
5688 #if 0
5689 if (FRAME_WINDOW_P (f))
5690 xassert (FACE_SUITABLE_FOR_CHAR_P (face, c));
5691 #endif
5692 #endif /* GLYPH_DEBUG */
5694 return face->id;
5698 /* Return the face id of the realized face for named face SYMBOL on
5699 frame F suitable for displaying character C. Value is -1 if the
5700 face couldn't be determined, which might happen if the default face
5701 isn't realized and cannot be realized. */
5704 lookup_named_face (f, symbol, c, signal_p)
5705 struct frame *f;
5706 Lisp_Object symbol;
5707 int c;
5708 int signal_p;
5710 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5711 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
5712 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5714 if (default_face == NULL)
5716 if (!realize_basic_faces (f))
5717 return -1;
5718 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
5719 if (default_face == NULL)
5720 abort (); /* realize_basic_faces must have set it up */
5723 if (!get_lface_attributes (f, symbol, symbol_attrs, signal_p))
5724 return -1;
5726 bcopy (default_face->lface, attrs, sizeof attrs);
5727 merge_face_vectors (f, symbol_attrs, attrs, 0);
5729 return lookup_face (f, attrs, c, NULL);
5733 /* Return the ID of the realized ASCII face of Lisp face with ID
5734 LFACE_ID on frame F. Value is -1 if LFACE_ID isn't valid. */
5737 ascii_face_of_lisp_face (f, lface_id)
5738 struct frame *f;
5739 int lface_id;
5741 int face_id;
5743 if (lface_id >= 0 && lface_id < lface_id_to_name_size)
5745 Lisp_Object face_name = lface_id_to_name[lface_id];
5746 face_id = lookup_named_face (f, face_name, 0, 1);
5748 else
5749 face_id = -1;
5751 return face_id;
5755 /* Return a face for charset ASCII that is like the face with id
5756 FACE_ID on frame F, but has a font that is STEPS steps smaller.
5757 STEPS < 0 means larger. Value is the id of the face. */
5760 smaller_face (f, face_id, steps)
5761 struct frame *f;
5762 int face_id, steps;
5764 #ifdef HAVE_WINDOW_SYSTEM
5765 struct face *face;
5766 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5767 int pt, last_pt, last_height;
5768 int delta;
5769 int new_face_id;
5770 struct face *new_face;
5772 /* If not called for an X frame, just return the original face. */
5773 if (FRAME_TERMCAP_P (f))
5774 return face_id;
5776 /* Try in increments of 1/2 pt. */
5777 delta = steps < 0 ? 5 : -5;
5778 steps = abs (steps);
5780 face = FACE_FROM_ID (f, face_id);
5781 bcopy (face->lface, attrs, sizeof attrs);
5782 pt = last_pt = XFASTINT (attrs[LFACE_HEIGHT_INDEX]);
5783 new_face_id = face_id;
5784 last_height = FONT_HEIGHT (face->font);
5786 while (steps
5787 && pt + delta > 0
5788 /* Give up if we cannot find a font within 10pt. */
5789 && abs (last_pt - pt) < 100)
5791 /* Look up a face for a slightly smaller/larger font. */
5792 pt += delta;
5793 attrs[LFACE_HEIGHT_INDEX] = make_number (pt);
5794 new_face_id = lookup_face (f, attrs, 0, NULL);
5795 new_face = FACE_FROM_ID (f, new_face_id);
5797 /* If height changes, count that as one step. */
5798 if ((delta < 0 && FONT_HEIGHT (new_face->font) < last_height)
5799 || (delta > 0 && FONT_HEIGHT (new_face->font) > last_height))
5801 --steps;
5802 last_height = FONT_HEIGHT (new_face->font);
5803 last_pt = pt;
5807 return new_face_id;
5809 #else /* not HAVE_WINDOW_SYSTEM */
5811 return face_id;
5813 #endif /* not HAVE_WINDOW_SYSTEM */
5817 /* Return a face for charset ASCII that is like the face with id
5818 FACE_ID on frame F, but has height HEIGHT. */
5821 face_with_height (f, face_id, height)
5822 struct frame *f;
5823 int face_id;
5824 int height;
5826 #ifdef HAVE_WINDOW_SYSTEM
5827 struct face *face;
5828 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5830 if (FRAME_TERMCAP_P (f)
5831 || height <= 0)
5832 return face_id;
5834 face = FACE_FROM_ID (f, face_id);
5835 bcopy (face->lface, attrs, sizeof attrs);
5836 attrs[LFACE_HEIGHT_INDEX] = make_number (height);
5837 face_id = lookup_face (f, attrs, 0, NULL);
5838 #endif /* HAVE_WINDOW_SYSTEM */
5840 return face_id;
5844 /* Return the face id of the realized face for named face SYMBOL on
5845 frame F suitable for displaying character C, and use attributes of
5846 the face FACE_ID for attributes that aren't completely specified by
5847 SYMBOL. This is like lookup_named_face, except that the default
5848 attributes come from FACE_ID, not from the default face. FACE_ID
5849 is assumed to be already realized. */
5852 lookup_derived_face (f, symbol, c, face_id, signal_p)
5853 struct frame *f;
5854 Lisp_Object symbol;
5855 int c;
5856 int face_id;
5857 int signal_p;
5859 Lisp_Object attrs[LFACE_VECTOR_SIZE];
5860 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
5861 struct face *default_face = FACE_FROM_ID (f, face_id);
5863 if (!default_face)
5864 abort ();
5866 get_lface_attributes (f, symbol, symbol_attrs, signal_p);
5867 bcopy (default_face->lface, attrs, sizeof attrs);
5868 merge_face_vectors (f, symbol_attrs, attrs, 0);
5869 return lookup_face (f, attrs, c, default_face);
5872 DEFUN ("face-attributes-as-vector", Fface_attributes_as_vector,
5873 Sface_attributes_as_vector, 1, 1, 0,
5874 doc: /* Return a vector of face attributes corresponding to PLIST. */)
5875 (plist)
5876 Lisp_Object plist;
5878 Lisp_Object lface;
5879 lface = Fmake_vector (make_number (LFACE_VECTOR_SIZE),
5880 Qunspecified);
5881 merge_face_ref (XFRAME (selected_frame), plist, XVECTOR (lface)->contents,
5882 1, 0);
5883 return lface;
5888 /***********************************************************************
5889 Face capability testing
5890 ***********************************************************************/
5893 /* If the distance (as returned by color_distance) between two colors is
5894 less than this, then they are considered the same, for determining
5895 whether a color is supported or not. The range of values is 0-65535. */
5897 #define TTY_SAME_COLOR_THRESHOLD 10000
5899 #ifdef HAVE_WINDOW_SYSTEM
5901 /* Return non-zero if all the face attributes in ATTRS are supported
5902 on the window-system frame F.
5904 The definition of `supported' is somewhat heuristic, but basically means
5905 that a face containing all the attributes in ATTRS, when merged with the
5906 default face for display, can be represented in a way that's
5908 \(1) different in appearance than the default face, and
5909 \(2) `close in spirit' to what the attributes specify, if not exact. */
5911 static int
5912 x_supports_face_attributes_p (f, attrs, def_face)
5913 struct frame *f;
5914 Lisp_Object *attrs;
5915 struct face *def_face;
5917 Lisp_Object *def_attrs = def_face->lface;
5919 /* Check that other specified attributes are different that the default
5920 face. */
5921 if ((!UNSPECIFIEDP (attrs[LFACE_UNDERLINE_INDEX])
5922 && face_attr_equal_p (attrs[LFACE_UNDERLINE_INDEX],
5923 def_attrs[LFACE_UNDERLINE_INDEX]))
5924 || (!UNSPECIFIEDP (attrs[LFACE_INVERSE_INDEX])
5925 && face_attr_equal_p (attrs[LFACE_INVERSE_INDEX],
5926 def_attrs[LFACE_INVERSE_INDEX]))
5927 || (!UNSPECIFIEDP (attrs[LFACE_FOREGROUND_INDEX])
5928 && face_attr_equal_p (attrs[LFACE_FOREGROUND_INDEX],
5929 def_attrs[LFACE_FOREGROUND_INDEX]))
5930 || (!UNSPECIFIEDP (attrs[LFACE_BACKGROUND_INDEX])
5931 && face_attr_equal_p (attrs[LFACE_BACKGROUND_INDEX],
5932 def_attrs[LFACE_BACKGROUND_INDEX]))
5933 || (!UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
5934 && face_attr_equal_p (attrs[LFACE_STIPPLE_INDEX],
5935 def_attrs[LFACE_STIPPLE_INDEX]))
5936 || (!UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
5937 && face_attr_equal_p (attrs[LFACE_OVERLINE_INDEX],
5938 def_attrs[LFACE_OVERLINE_INDEX]))
5939 || (!UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
5940 && face_attr_equal_p (attrs[LFACE_STRIKE_THROUGH_INDEX],
5941 def_attrs[LFACE_STRIKE_THROUGH_INDEX]))
5942 || (!UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
5943 && face_attr_equal_p (attrs[LFACE_BOX_INDEX],
5944 def_attrs[LFACE_BOX_INDEX])))
5945 return 0;
5947 /* Check font-related attributes, as those are the most commonly
5948 "unsupported" on a window-system (because of missing fonts). */
5949 if (!UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
5950 || !UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
5951 || !UNSPECIFIEDP (attrs[LFACE_WEIGHT_INDEX])
5952 || !UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX])
5953 || !UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
5954 || !UNSPECIFIEDP (attrs[LFACE_AVGWIDTH_INDEX]))
5956 struct face *face;
5957 Lisp_Object merged_attrs[LFACE_VECTOR_SIZE];
5959 bcopy (def_attrs, merged_attrs, sizeof merged_attrs);
5961 merge_face_vectors (f, attrs, merged_attrs, 0);
5963 face = FACE_FROM_ID (f, lookup_face (f, merged_attrs, 0, 0));
5965 if (! face)
5966 error ("Cannot make face");
5968 /* If the font is the same, then not supported. */
5969 if (face->font == def_face->font)
5970 return 0;
5973 /* Everything checks out, this face is supported. */
5974 return 1;
5977 #endif /* HAVE_WINDOW_SYSTEM */
5979 /* Return non-zero if all the face attributes in ATTRS are supported
5980 on the tty frame F.
5982 The definition of `supported' is somewhat heuristic, but basically means
5983 that a face containing all the attributes in ATTRS, when merged
5984 with the default face for display, can be represented in a way that's
5986 \(1) different in appearance than the default face, and
5987 \(2) `close in spirit' to what the attributes specify, if not exact.
5989 Point (2) implies that a `:weight black' attribute will be satisfied
5990 by any terminal that can display bold, and a `:foreground "yellow"' as
5991 long as the terminal can display a yellowish color, but `:slant italic'
5992 will _not_ be satisfied by the tty display code's automatic
5993 substitution of a `dim' face for italic. */
5995 static int
5996 tty_supports_face_attributes_p (f, attrs, def_face)
5997 struct frame *f;
5998 Lisp_Object *attrs;
5999 struct face *def_face;
6001 int weight;
6002 Lisp_Object val, fg, bg;
6003 XColor fg_tty_color, fg_std_color;
6004 XColor bg_tty_color, bg_std_color;
6005 unsigned test_caps = 0;
6006 Lisp_Object *def_attrs = def_face->lface;
6009 /* First check some easy-to-check stuff; ttys support none of the
6010 following attributes, so we can just return false if any are requested
6011 (even if `nominal' values are specified, we should still return false,
6012 as that will be the same value that the default face uses). We
6013 consider :slant unsupportable on ttys, even though the face code
6014 actually `fakes' them using a dim attribute if possible. This is
6015 because the faked result is too different from what the face
6016 specifies. */
6017 if (!UNSPECIFIEDP (attrs[LFACE_FAMILY_INDEX])
6018 || !UNSPECIFIEDP (attrs[LFACE_STIPPLE_INDEX])
6019 || !UNSPECIFIEDP (attrs[LFACE_HEIGHT_INDEX])
6020 || !UNSPECIFIEDP (attrs[LFACE_SWIDTH_INDEX])
6021 || !UNSPECIFIEDP (attrs[LFACE_OVERLINE_INDEX])
6022 || !UNSPECIFIEDP (attrs[LFACE_STRIKE_THROUGH_INDEX])
6023 || !UNSPECIFIEDP (attrs[LFACE_BOX_INDEX])
6024 || !UNSPECIFIEDP (attrs[LFACE_SLANT_INDEX]))
6025 return 0;
6028 /* Test for terminal `capabilities' (non-color character attributes). */
6030 /* font weight (bold/dim) */
6031 weight = face_numeric_weight (attrs[LFACE_WEIGHT_INDEX]);
6032 if (weight >= 0)
6034 int def_weight = face_numeric_weight (def_attrs[LFACE_WEIGHT_INDEX]);
6036 if (weight > XLFD_WEIGHT_MEDIUM)
6038 if (def_weight > XLFD_WEIGHT_MEDIUM)
6039 return 0; /* same as default */
6040 test_caps = TTY_CAP_BOLD;
6042 else if (weight < XLFD_WEIGHT_MEDIUM)
6044 if (def_weight < XLFD_WEIGHT_MEDIUM)
6045 return 0; /* same as default */
6046 test_caps = TTY_CAP_DIM;
6048 else if (def_weight == XLFD_WEIGHT_MEDIUM)
6049 return 0; /* same as default */
6052 /* underlining */
6053 val = attrs[LFACE_UNDERLINE_INDEX];
6054 if (!UNSPECIFIEDP (val))
6056 if (STRINGP (val))
6057 return 0; /* ttys can't use colored underlines */
6058 else if (face_attr_equal_p (val, def_attrs[LFACE_UNDERLINE_INDEX]))
6059 return 0; /* same as default */
6060 else
6061 test_caps |= TTY_CAP_UNDERLINE;
6064 /* inverse video */
6065 val = attrs[LFACE_INVERSE_INDEX];
6066 if (!UNSPECIFIEDP (val))
6068 if (face_attr_equal_p (val, def_attrs[LFACE_INVERSE_INDEX]))
6069 return 0; /* same as default */
6070 else
6071 test_caps |= TTY_CAP_INVERSE;
6075 /* Color testing. */
6077 /* Default the color indices in FG_TTY_COLOR and BG_TTY_COLOR, since
6078 we use them when calling `tty_capable_p' below, even if the face
6079 specifies no colors. */
6080 fg_tty_color.pixel = FACE_TTY_DEFAULT_FG_COLOR;
6081 bg_tty_color.pixel = FACE_TTY_DEFAULT_BG_COLOR;
6083 /* Check if foreground color is close enough. */
6084 fg = attrs[LFACE_FOREGROUND_INDEX];
6085 if (STRINGP (fg))
6087 Lisp_Object def_fg = def_attrs[LFACE_FOREGROUND_INDEX];
6089 if (face_attr_equal_p (fg, def_fg))
6090 return 0; /* same as default */
6091 else if (! tty_lookup_color (f, fg, &fg_tty_color, &fg_std_color))
6092 return 0; /* not a valid color */
6093 else if (color_distance (&fg_tty_color, &fg_std_color)
6094 > TTY_SAME_COLOR_THRESHOLD)
6095 return 0; /* displayed color is too different */
6096 else
6097 /* Make sure the color is really different than the default. */
6099 XColor def_fg_color;
6100 if (tty_lookup_color (f, def_fg, &def_fg_color, 0)
6101 && (color_distance (&fg_tty_color, &def_fg_color)
6102 <= TTY_SAME_COLOR_THRESHOLD))
6103 return 0;
6107 /* Check if background color is close enough. */
6108 bg = attrs[LFACE_BACKGROUND_INDEX];
6109 if (STRINGP (bg))
6111 Lisp_Object def_bg = def_attrs[LFACE_BACKGROUND_INDEX];
6113 if (face_attr_equal_p (bg, def_bg))
6114 return 0; /* same as default */
6115 else if (! tty_lookup_color (f, bg, &bg_tty_color, &bg_std_color))
6116 return 0; /* not a valid color */
6117 else if (color_distance (&bg_tty_color, &bg_std_color)
6118 > TTY_SAME_COLOR_THRESHOLD)
6119 return 0; /* displayed color is too different */
6120 else
6121 /* Make sure the color is really different than the default. */
6123 XColor def_bg_color;
6124 if (tty_lookup_color (f, def_bg, &def_bg_color, 0)
6125 && (color_distance (&bg_tty_color, &def_bg_color)
6126 <= TTY_SAME_COLOR_THRESHOLD))
6127 return 0;
6131 /* If both foreground and background are requested, see if the
6132 distance between them is OK. We just check to see if the distance
6133 between the tty's foreground and background is close enough to the
6134 distance between the standard foreground and background. */
6135 if (STRINGP (fg) && STRINGP (bg))
6137 int delta_delta
6138 = (color_distance (&fg_std_color, &bg_std_color)
6139 - color_distance (&fg_tty_color, &bg_tty_color));
6140 if (delta_delta > TTY_SAME_COLOR_THRESHOLD
6141 || delta_delta < -TTY_SAME_COLOR_THRESHOLD)
6142 return 0;
6146 /* See if the capabilities we selected above are supported, with the
6147 given colors. */
6148 if (test_caps != 0 &&
6149 ! tty_capable_p (f, test_caps, fg_tty_color.pixel, bg_tty_color.pixel))
6150 return 0;
6153 /* Hmmm, everything checks out, this terminal must support this face. */
6154 return 1;
6158 DEFUN ("display-supports-face-attributes-p",
6159 Fdisplay_supports_face_attributes_p, Sdisplay_supports_face_attributes_p,
6160 1, 2, 0,
6161 doc: /* Return non-nil if all the face attributes in ATTRIBUTES are supported.
6162 The optional argument DISPLAY can be a display name, a frame, or
6163 nil (meaning the selected frame's display).
6165 The definition of `supported' is somewhat heuristic, but basically means
6166 that a face containing all the attributes in ATTRIBUTES, when merged
6167 with the default face for display, can be represented in a way that's
6169 \(1) different in appearance than the default face, and
6170 \(2) `close in spirit' to what the attributes specify, if not exact.
6172 Point (2) implies that a `:weight black' attribute will be satisfied by
6173 any display that can display bold, and a `:foreground \"yellow\"' as long
6174 as it can display a yellowish color, but `:slant italic' will _not_ be
6175 satisfied by the tty display code's automatic substitution of a `dim'
6176 face for italic. */)
6177 (attributes, display)
6178 Lisp_Object attributes, display;
6180 int supports = 0, i;
6181 Lisp_Object frame;
6182 struct frame *f;
6183 struct face *def_face;
6184 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6186 if (noninteractive || !initialized)
6187 /* We may not be able to access low-level face information in batch
6188 mode, or before being dumped, and this function is not going to
6189 be very useful in those cases anyway, so just give up. */
6190 return Qnil;
6192 if (NILP (display))
6193 frame = selected_frame;
6194 else if (FRAMEP (display))
6195 frame = display;
6196 else
6198 /* Find any frame on DISPLAY. */
6199 Lisp_Object fl_tail;
6201 frame = Qnil;
6202 for (fl_tail = Vframe_list; CONSP (fl_tail); fl_tail = XCDR (fl_tail))
6204 frame = XCAR (fl_tail);
6205 if (!NILP (Fequal (Fcdr (Fassq (Qdisplay,
6206 XFRAME (frame)->param_alist)),
6207 display)))
6208 break;
6212 CHECK_LIVE_FRAME (frame);
6213 f = XFRAME (frame);
6215 for (i = 0; i < LFACE_VECTOR_SIZE; i++)
6216 attrs[i] = Qunspecified;
6217 merge_face_ref (f, attributes, attrs, 1, 0);
6219 def_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
6220 if (def_face == NULL)
6222 if (! realize_basic_faces (f))
6223 error ("Cannot realize default face");
6224 def_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
6225 if (def_face == NULL)
6226 abort (); /* realize_basic_faces must have set it up */
6229 /* Dispatch to the appropriate handler. */
6230 if (FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
6231 supports = tty_supports_face_attributes_p (f, attrs, def_face);
6232 #ifdef HAVE_WINDOW_SYSTEM
6233 else
6234 supports = x_supports_face_attributes_p (f, attrs, def_face);
6235 #endif
6237 return supports ? Qt : Qnil;
6241 /***********************************************************************
6242 Font selection
6243 ***********************************************************************/
6245 DEFUN ("internal-set-font-selection-order",
6246 Finternal_set_font_selection_order,
6247 Sinternal_set_font_selection_order, 1, 1, 0,
6248 doc: /* Set font selection order for face font selection to ORDER.
6249 ORDER must be a list of length 4 containing the symbols `:width',
6250 `:height', `:weight', and `:slant'. Face attributes appearing
6251 first in ORDER are matched first, e.g. if `:height' appears before
6252 `:weight' in ORDER, font selection first tries to find a font with
6253 a suitable height, and then tries to match the font weight.
6254 Value is ORDER. */)
6255 (order)
6256 Lisp_Object order;
6258 Lisp_Object list;
6259 int i;
6260 int indices[DIM (font_sort_order)];
6262 CHECK_LIST (order);
6263 bzero (indices, sizeof indices);
6264 i = 0;
6266 for (list = order;
6267 CONSP (list) && i < DIM (indices);
6268 list = XCDR (list), ++i)
6270 Lisp_Object attr = XCAR (list);
6271 int xlfd;
6273 if (EQ (attr, QCwidth))
6274 xlfd = XLFD_SWIDTH;
6275 else if (EQ (attr, QCheight))
6276 xlfd = XLFD_POINT_SIZE;
6277 else if (EQ (attr, QCweight))
6278 xlfd = XLFD_WEIGHT;
6279 else if (EQ (attr, QCslant))
6280 xlfd = XLFD_SLANT;
6281 else
6282 break;
6284 if (indices[i] != 0)
6285 break;
6286 indices[i] = xlfd;
6289 if (!NILP (list) || i != DIM (indices))
6290 signal_error ("Invalid font sort order", order);
6291 for (i = 0; i < DIM (font_sort_order); ++i)
6292 if (indices[i] == 0)
6293 signal_error ("Invalid font sort order", order);
6295 if (bcmp (indices, font_sort_order, sizeof indices) != 0)
6297 bcopy (indices, font_sort_order, sizeof font_sort_order);
6298 free_all_realized_faces (Qnil);
6301 return Qnil;
6305 DEFUN ("internal-set-alternative-font-family-alist",
6306 Finternal_set_alternative_font_family_alist,
6307 Sinternal_set_alternative_font_family_alist, 1, 1, 0,
6308 doc: /* Define alternative font families to try in face font selection.
6309 ALIST is an alist of (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...) entries.
6310 Each ALTERNATIVE is tried in order if no fonts of font family FAMILY can
6311 be found. Value is ALIST. */)
6312 (alist)
6313 Lisp_Object alist;
6315 CHECK_LIST (alist);
6316 Vface_alternative_font_family_alist = alist;
6317 free_all_realized_faces (Qnil);
6318 return alist;
6322 DEFUN ("internal-set-alternative-font-registry-alist",
6323 Finternal_set_alternative_font_registry_alist,
6324 Sinternal_set_alternative_font_registry_alist, 1, 1, 0,
6325 doc: /* Define alternative font registries to try in face font selection.
6326 ALIST is an alist of (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...) entries.
6327 Each ALTERNATIVE is tried in order if no fonts of font registry REGISTRY can
6328 be found. Value is ALIST. */)
6329 (alist)
6330 Lisp_Object alist;
6332 CHECK_LIST (alist);
6333 Vface_alternative_font_registry_alist = alist;
6334 free_all_realized_faces (Qnil);
6335 return alist;
6339 #ifdef HAVE_WINDOW_SYSTEM
6341 /* Value is non-zero if FONT is the name of a scalable font. The
6342 X11R6 XLFD spec says that point size, pixel size, and average width
6343 are zero for scalable fonts. Intlfonts contain at least one
6344 scalable font ("*-muleindian-1") for which this isn't true, so we
6345 just test average width. */
6347 static int
6348 font_scalable_p (font)
6349 struct font_name *font;
6351 char *s = font->fields[XLFD_AVGWIDTH];
6352 return (*s == '0' && *(s + 1) == '\0')
6353 #ifdef WINDOWSNT
6354 /* Windows implementation of XLFD is slightly broken for backward
6355 compatibility with previous broken versions, so test for
6356 wildcards as well as 0. */
6357 || *s == '*'
6358 #endif
6363 /* Ignore the difference of font point size less than this value. */
6365 #define FONT_POINT_SIZE_QUANTUM 5
6367 /* Value is non-zero if FONT1 is a better match for font attributes
6368 VALUES than FONT2. VALUES is an array of face attribute values in
6369 font sort order. COMPARE_PT_P zero means don't compare point
6370 sizes. AVGWIDTH, if not zero, is a specified font average width
6371 to compare with. */
6373 static int
6374 better_font_p (values, font1, font2, compare_pt_p, avgwidth)
6375 int *values;
6376 struct font_name *font1, *font2;
6377 int compare_pt_p, avgwidth;
6379 int i;
6381 /* Any font is better than no font. */
6382 if (! font1)
6383 return 0;
6384 if (! font2)
6385 return 1;
6387 for (i = 0; i < DIM (font_sort_order); ++i)
6389 int xlfd_idx = font_sort_order[i];
6391 if (compare_pt_p || xlfd_idx != XLFD_POINT_SIZE)
6393 int delta1, delta2;
6395 if (xlfd_idx == XLFD_POINT_SIZE)
6397 delta1 = abs (values[i] - (font1->numeric[xlfd_idx]
6398 / font1->rescale_ratio));
6399 delta2 = abs (values[i] - (font2->numeric[xlfd_idx]
6400 / font2->rescale_ratio));
6401 if (abs (delta1 - delta2) < FONT_POINT_SIZE_QUANTUM)
6402 continue;
6404 else
6406 delta1 = abs (values[i] - font1->numeric[xlfd_idx]);
6407 delta2 = abs (values[i] - font2->numeric[xlfd_idx]);
6410 if (delta1 > delta2)
6411 return 0;
6412 else if (delta1 < delta2)
6413 return 1;
6414 else
6416 /* The difference may be equal because, e.g., the face
6417 specifies `italic' but we have only `regular' and
6418 `oblique'. Prefer `oblique' in this case. */
6419 if ((xlfd_idx == XLFD_WEIGHT || xlfd_idx == XLFD_SLANT)
6420 && font1->numeric[xlfd_idx] > values[i]
6421 && font2->numeric[xlfd_idx] < values[i])
6422 return 1;
6427 if (avgwidth)
6429 int delta1 = abs (avgwidth - font1->numeric[XLFD_AVGWIDTH]);
6430 int delta2 = abs (avgwidth - font2->numeric[XLFD_AVGWIDTH]);
6431 if (delta1 > delta2)
6432 return 0;
6433 else if (delta1 < delta2)
6434 return 1;
6437 if (! compare_pt_p)
6439 /* We prefer a real scalable font; i.e. not what autoscaled. */
6440 int auto_scaled_1 = (font1->numeric[XLFD_POINT_SIZE] == 0
6441 && font1->numeric[XLFD_RESY] > 0);
6442 int auto_scaled_2 = (font2->numeric[XLFD_POINT_SIZE] == 0
6443 && font2->numeric[XLFD_RESY] > 0);
6445 if (auto_scaled_1 != auto_scaled_2)
6446 return auto_scaled_2;
6449 return font1->registry_priority < font2->registry_priority;
6453 /* Value is non-zero if FONT is an exact match for face attributes in
6454 SPECIFIED. SPECIFIED is an array of face attribute values in font
6455 sort order. AVGWIDTH, if non-zero, is an average width to compare
6456 with. */
6458 static int
6459 exact_face_match_p (specified, font, avgwidth)
6460 int *specified;
6461 struct font_name *font;
6462 int avgwidth;
6464 int i;
6466 for (i = 0; i < DIM (font_sort_order); ++i)
6467 if (specified[i] != font->numeric[font_sort_order[i]])
6468 break;
6470 return (i == DIM (font_sort_order)
6471 && (avgwidth <= 0
6472 || avgwidth == font->numeric[XLFD_AVGWIDTH]));
6476 /* Value is the name of a scaled font, generated from scalable font
6477 FONT on frame F. SPECIFIED_PT is the point-size to scale FONT to.
6478 Value is allocated from heap. */
6480 static char *
6481 build_scalable_font_name (f, font, specified_pt)
6482 struct frame *f;
6483 struct font_name *font;
6484 int specified_pt;
6486 char pixel_size[20];
6487 int pixel_value;
6488 double resy = FRAME_X_DISPLAY_INFO (f)->resy;
6489 double pt;
6491 /* If scalable font is for a specific resolution, compute
6492 the point size we must specify from the resolution of
6493 the display and the specified resolution of the font. */
6494 if (font->numeric[XLFD_RESY] != 0)
6496 pt = resy / font->numeric[XLFD_RESY] * specified_pt + 0.5;
6497 pixel_value = font->numeric[XLFD_RESY] / (PT_PER_INCH * 10.0) * pt + 0.5;
6499 else
6501 pt = specified_pt;
6502 pixel_value = resy / (PT_PER_INCH * 10.0) * pt + 0.5;
6504 /* We may need a font of the different size. */
6505 pixel_value *= font->rescale_ratio;
6507 /* We should keep POINT_SIZE 0. Otherwise, X server can't open a
6508 font of the specified PIXEL_SIZE. */
6509 #if 0
6510 { /* Set point size of the font. */
6511 char point_size[20];
6512 sprintf (point_size, "%d", (int) pt);
6513 font->fields[XLFD_POINT_SIZE] = point_size;
6514 font->numeric[XLFD_POINT_SIZE] = pt;
6516 #endif
6518 /* Set pixel size. */
6519 sprintf (pixel_size, "%d", pixel_value);
6520 font->fields[XLFD_PIXEL_SIZE] = pixel_size;
6521 font->numeric[XLFD_PIXEL_SIZE] = pixel_value;
6523 /* If font doesn't specify its resolution, use the
6524 resolution of the display. */
6525 if (font->numeric[XLFD_RESY] == 0)
6527 char buffer[20];
6528 sprintf (buffer, "%d", (int) resy);
6529 font->fields[XLFD_RESY] = buffer;
6530 font->numeric[XLFD_RESY] = resy;
6533 if (strcmp (font->fields[XLFD_RESX], "0") == 0)
6535 char buffer[20];
6536 int resx = FRAME_X_DISPLAY_INFO (f)->resx;
6537 sprintf (buffer, "%d", resx);
6538 font->fields[XLFD_RESX] = buffer;
6539 font->numeric[XLFD_RESX] = resx;
6542 return build_font_name (font);
6546 /* Value is non-zero if we are allowed to use scalable font FONT. We
6547 can't run a Lisp function here since this function may be called
6548 with input blocked. */
6550 static int
6551 may_use_scalable_font_p (font)
6552 const char *font;
6554 if (EQ (Vscalable_fonts_allowed, Qt))
6555 return 1;
6556 else if (CONSP (Vscalable_fonts_allowed))
6558 Lisp_Object tail, regexp;
6560 for (tail = Vscalable_fonts_allowed; CONSP (tail); tail = XCDR (tail))
6562 regexp = XCAR (tail);
6563 if (STRINGP (regexp)
6564 && fast_c_string_match_ignore_case (regexp, font) >= 0)
6565 return 1;
6569 return 0;
6574 /* Return the name of the best matching font for face attributes ATTRS
6575 in the array of font_name structures FONTS which contains NFONTS
6576 elements. WIDTH_RATIO is a factor with which to multiply average
6577 widths if ATTRS specifies such a width.
6579 Value is a font name which is allocated from the heap. FONTS is
6580 freed by this function.
6582 If NEEDS_OVERSTRIKE is non-zero, a boolean is returned in it to
6583 indicate whether the resulting font should be drawn using overstrike
6584 to simulate bold-face. */
6586 static char *
6587 best_matching_font (f, attrs, fonts, nfonts, width_ratio, needs_overstrike)
6588 struct frame *f;
6589 Lisp_Object *attrs;
6590 struct font_name *fonts;
6591 int nfonts;
6592 int width_ratio;
6593 int *needs_overstrike;
6595 char *font_name;
6596 struct font_name *best;
6597 int i, pt = 0;
6598 int specified[5];
6599 int exact_p, avgwidth;
6601 if (nfonts == 0)
6602 return NULL;
6604 /* Make specified font attributes available in `specified',
6605 indexed by sort order. */
6606 for (i = 0; i < DIM (font_sort_order); ++i)
6608 int xlfd_idx = font_sort_order[i];
6610 if (xlfd_idx == XLFD_SWIDTH)
6611 specified[i] = face_numeric_swidth (attrs[LFACE_SWIDTH_INDEX]);
6612 else if (xlfd_idx == XLFD_POINT_SIZE)
6613 specified[i] = pt = XFASTINT (attrs[LFACE_HEIGHT_INDEX]);
6614 else if (xlfd_idx == XLFD_WEIGHT)
6615 specified[i] = face_numeric_weight (attrs[LFACE_WEIGHT_INDEX]);
6616 else if (xlfd_idx == XLFD_SLANT)
6617 specified[i] = face_numeric_slant (attrs[LFACE_SLANT_INDEX]);
6618 else
6619 abort ();
6622 avgwidth = (UNSPECIFIEDP (attrs[LFACE_AVGWIDTH_INDEX])
6624 : XFASTINT (attrs[LFACE_AVGWIDTH_INDEX]) * width_ratio);
6626 exact_p = 0;
6628 if (needs_overstrike)
6629 *needs_overstrike = 0;
6631 best = NULL;
6633 /* Find the best match among the non-scalable fonts. */
6634 for (i = 0; i < nfonts; ++i)
6635 if (!font_scalable_p (fonts + i)
6636 && better_font_p (specified, fonts + i, best, 1, avgwidth))
6638 best = fonts + i;
6640 exact_p = exact_face_match_p (specified, best, avgwidth);
6641 if (exact_p)
6642 break;
6645 /* Unless we found an exact match among non-scalable fonts, see if
6646 we can find a better match among scalable fonts. */
6647 if (!exact_p)
6649 /* A scalable font is better if
6651 1. its weight, slant, swidth attributes are better, or.
6653 2. the best non-scalable font doesn't have the required
6654 point size, and the scalable fonts weight, slant, swidth
6655 isn't worse. */
6657 int non_scalable_has_exact_height_p;
6659 if (best && best->numeric[XLFD_POINT_SIZE] == pt)
6660 non_scalable_has_exact_height_p = 1;
6661 else
6662 non_scalable_has_exact_height_p = 0;
6664 for (i = 0; i < nfonts; ++i)
6665 if (font_scalable_p (fonts + i))
6667 if (better_font_p (specified, fonts + i, best, 0, 0)
6668 || (!non_scalable_has_exact_height_p
6669 && !better_font_p (specified, best, fonts + i, 0, 0)))
6671 non_scalable_has_exact_height_p = 1;
6672 best = fonts + i;
6677 /* We should have found SOME font. */
6678 if (best == NULL)
6679 abort ();
6681 if (! exact_p && needs_overstrike)
6683 enum xlfd_weight want_weight = specified[XLFD_WEIGHT];
6684 enum xlfd_weight got_weight = best->numeric[XLFD_WEIGHT];
6686 if (want_weight > XLFD_WEIGHT_MEDIUM && want_weight > got_weight)
6688 /* We want a bold font, but didn't get one; try to use
6689 overstriking instead to simulate bold-face. However,
6690 don't overstrike an already-bold font unless the
6691 desired weight grossly exceeds the available weight. */
6692 if (got_weight > XLFD_WEIGHT_MEDIUM)
6693 *needs_overstrike = (want_weight - got_weight) > 2;
6694 else
6695 *needs_overstrike = 1;
6699 if (font_scalable_p (best))
6700 font_name = build_scalable_font_name (f, best, pt);
6701 else
6702 font_name = build_font_name (best);
6704 /* Free font_name structures. */
6705 free_font_names (fonts, nfonts);
6707 return font_name;
6711 /* Get a list of matching fonts on frame F, considering FAMILY
6712 and alternative font families from Vface_alternative_font_registry_alist.
6714 FAMILY is the font family whose alternatives are considered.
6716 REGISTRY, if a string, specifies a font registry and encoding to
6717 match. A value of nil means include fonts of any registry and
6718 encoding.
6720 Return in *FONTS a pointer to a vector of font_name structures for
6721 the fonts matched. Value is the number of fonts found. */
6723 static int
6724 try_alternative_families (f, family, registry, fonts)
6725 struct frame *f;
6726 Lisp_Object family, registry;
6727 struct font_name **fonts;
6729 Lisp_Object alter;
6730 int nfonts = 0;
6732 nfonts = font_list (f, Qnil, family, registry, fonts);
6733 if (nfonts == 0)
6735 /* Try alternative font families. */
6736 alter = Fassoc (family, Vface_alternative_font_family_alist);
6737 if (CONSP (alter))
6739 for (alter = XCDR (alter);
6740 CONSP (alter) && nfonts == 0;
6741 alter = XCDR (alter))
6743 if (STRINGP (XCAR (alter)))
6744 nfonts = font_list (f, Qnil, XCAR (alter), registry, fonts);
6748 /* Try all scalable fonts before giving up. */
6749 if (nfonts == 0 && ! EQ (Vscalable_fonts_allowed, Qt))
6751 int count = SPECPDL_INDEX ();
6752 specbind (Qscalable_fonts_allowed, Qt);
6753 nfonts = try_alternative_families (f, family, registry, fonts);
6754 unbind_to (count, Qnil);
6757 return nfonts;
6761 /* Get a list of matching fonts on frame F.
6763 FAMILY, if a string, specifies a font family derived from the fontset.
6764 It is only used if the face does not specify any family in ATTRS or
6765 if we cannot find any font of the face's family.
6767 REGISTRY, if a string, specifies a font registry and encoding to
6768 match. A value of nil means include fonts of any registry and
6769 encoding.
6771 If PREFER_FACE_FAMILY is nonzero, perfer face's family to FAMILY.
6772 Otherwise, prefer FAMILY.
6774 Return in *FONTS a pointer to a vector of font_name structures for
6775 the fonts matched. Value is the number of fonts found. */
6777 static int
6778 try_font_list (f, attrs, family, registry, fonts, prefer_face_family)
6779 struct frame *f;
6780 Lisp_Object *attrs;
6781 Lisp_Object family, registry;
6782 struct font_name **fonts;
6783 int prefer_face_family;
6785 int nfonts = 0;
6786 Lisp_Object face_family = attrs[LFACE_FAMILY_INDEX];
6787 Lisp_Object try_family;
6789 try_family = (prefer_face_family || NILP (family)) ? face_family : family;
6791 if (STRINGP (try_family))
6792 nfonts = try_alternative_families (f, try_family, registry, fonts);
6794 #ifdef MAC_OS
6795 if (nfonts == 0 && STRINGP (try_family) && STRINGP (registry))
6797 if (xstricmp (SDATA (registry), "mac-roman") == 0)
6798 /* When realizing the default face and a font spec does not
6799 matched exactly, Emacs looks for ones with the same registry
6800 as the default font. On the Mac, this is mac-roman, which
6801 does not work if the family is -etl-fixed, e.g. The
6802 following widens the choices and fixes that problem. */
6803 nfonts = try_alternative_families (f, try_family, Qnil, fonts);
6804 else if (SBYTES (try_family) > 0
6805 && SREF (try_family, SBYTES (try_family) - 1) != '*')
6806 /* Some Central European/Cyrillic font family names have the
6807 Roman counterpart name as their prefix. */
6808 nfonts = try_alternative_families (f, concat2 (try_family,
6809 build_string ("*")),
6810 registry, fonts);
6812 #endif
6814 if (EQ (try_family, family))
6815 family = face_family;
6817 if (nfonts == 0 && STRINGP (family))
6818 nfonts = try_alternative_families (f, family, registry, fonts);
6820 /* Try font family of the default face or "fixed". */
6821 if (nfonts == 0)
6823 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
6824 if (default_face)
6825 family = default_face->lface[LFACE_FAMILY_INDEX];
6826 else
6827 family = build_string ("fixed");
6828 nfonts = font_list (f, Qnil, family, registry, fonts);
6831 /* Try any family with the given registry. */
6832 if (nfonts == 0)
6833 nfonts = try_alternative_families (f, Qnil, registry, fonts);
6835 return nfonts;
6839 /* Return the fontset id of the base fontset name or alias name given
6840 by the fontset attribute of ATTRS. Value is -1 if the fontset
6841 attribute of ATTRS doesn't name a fontset. */
6843 static int
6844 face_fontset (attrs)
6845 Lisp_Object *attrs;
6847 Lisp_Object name;
6849 name = attrs[LFACE_FONT_INDEX];
6850 if (!STRINGP (name))
6851 return -1;
6852 return fs_query_fontset (name, 0);
6856 /* Choose a name of font to use on frame F to display character C with
6857 Lisp face attributes specified by ATTRS. The font name is
6858 determined by the font-related attributes in ATTRS and the name
6859 pattern for C in FONTSET. Value is the font name which is
6860 allocated from the heap and must be freed by the caller, or NULL if
6861 we can get no information about the font name of C. It is assured
6862 that we always get some information for a single byte
6863 character.
6865 If NEEDS_OVERSTRIKE is non-zero, a boolean is returned in it to
6866 indicate whether the resulting font should be drawn using overstrike
6867 to simulate bold-face. */
6869 static char *
6870 choose_face_font (f, attrs, fontset, c, needs_overstrike)
6871 struct frame *f;
6872 Lisp_Object *attrs;
6873 int fontset, c;
6874 int *needs_overstrike;
6876 Lisp_Object pattern;
6877 char *font_name = NULL;
6878 struct font_name *fonts;
6879 int nfonts, width_ratio;
6881 if (needs_overstrike)
6882 *needs_overstrike = 0;
6884 /* Get (foundry and) family name and registry (and encoding) name of
6885 a font for C. */
6886 pattern = fontset_font_pattern (f, fontset, c);
6887 if (NILP (pattern))
6889 xassert (!SINGLE_BYTE_CHAR_P (c));
6890 return NULL;
6893 /* If what we got is a name pattern, return it. */
6894 if (STRINGP (pattern))
6895 return xstrdup (SDATA (pattern));
6897 /* Get a list of fonts matching that pattern and choose the
6898 best match for the specified face attributes from it. */
6899 nfonts = try_font_list (f, attrs, XCAR (pattern), XCDR (pattern), &fonts,
6900 (SINGLE_BYTE_CHAR_P (c)
6901 || CHAR_CHARSET (c) == charset_latin_iso8859_1));
6902 width_ratio = (SINGLE_BYTE_CHAR_P (c)
6904 : CHARSET_WIDTH (CHAR_CHARSET (c)));
6905 font_name = best_matching_font (f, attrs, fonts, nfonts, width_ratio,
6906 needs_overstrike);
6907 return font_name;
6910 #endif /* HAVE_WINDOW_SYSTEM */
6914 /***********************************************************************
6915 Face Realization
6916 ***********************************************************************/
6918 /* Realize basic faces on frame F. Value is zero if frame parameters
6919 of F don't contain enough information needed to realize the default
6920 face. */
6922 static int
6923 realize_basic_faces (f)
6924 struct frame *f;
6926 int success_p = 0;
6927 int count = SPECPDL_INDEX ();
6929 /* Block input here so that we won't be surprised by an X expose
6930 event, for instance, without having the faces set up. */
6931 BLOCK_INPUT;
6932 specbind (Qscalable_fonts_allowed, Qt);
6934 if (realize_default_face (f))
6936 realize_named_face (f, Qmode_line, MODE_LINE_FACE_ID);
6937 realize_named_face (f, Qmode_line_inactive, MODE_LINE_INACTIVE_FACE_ID);
6938 realize_named_face (f, Qtool_bar, TOOL_BAR_FACE_ID);
6939 realize_named_face (f, Qfringe, FRINGE_FACE_ID);
6940 realize_named_face (f, Qheader_line, HEADER_LINE_FACE_ID);
6941 realize_named_face (f, Qscroll_bar, SCROLL_BAR_FACE_ID);
6942 realize_named_face (f, Qborder, BORDER_FACE_ID);
6943 realize_named_face (f, Qcursor, CURSOR_FACE_ID);
6944 realize_named_face (f, Qmouse, MOUSE_FACE_ID);
6945 realize_named_face (f, Qmenu, MENU_FACE_ID);
6946 realize_named_face (f, Qvertical_border, VERTICAL_BORDER_FACE_ID);
6948 /* Reflect changes in the `menu' face in menu bars. */
6949 if (FRAME_FACE_CACHE (f)->menu_face_changed_p)
6951 FRAME_FACE_CACHE (f)->menu_face_changed_p = 0;
6952 #ifdef USE_X_TOOLKIT
6953 x_update_menu_appearance (f);
6954 #endif
6957 success_p = 1;
6960 unbind_to (count, Qnil);
6961 UNBLOCK_INPUT;
6962 return success_p;
6966 /* Realize the default face on frame F. If the face is not fully
6967 specified, make it fully-specified. Attributes of the default face
6968 that are not explicitly specified are taken from frame parameters. */
6970 static int
6971 realize_default_face (f)
6972 struct frame *f;
6974 struct face_cache *c = FRAME_FACE_CACHE (f);
6975 Lisp_Object lface;
6976 Lisp_Object attrs[LFACE_VECTOR_SIZE];
6977 Lisp_Object frame_font;
6978 struct face *face;
6980 /* If the `default' face is not yet known, create it. */
6981 lface = lface_from_face_name (f, Qdefault, 0);
6982 if (NILP (lface))
6984 Lisp_Object frame;
6985 XSETFRAME (frame, f);
6986 lface = Finternal_make_lisp_face (Qdefault, frame);
6990 #ifdef HAVE_WINDOW_SYSTEM
6991 if (FRAME_WINDOW_P (f))
6993 /* Set frame_font to the value of the `font' frame parameter. */
6994 frame_font = Fassq (Qfont, f->param_alist);
6995 xassert (CONSP (frame_font) && STRINGP (XCDR (frame_font)));
6996 frame_font = XCDR (frame_font);
6997 set_lface_from_font_name (f, lface, frame_font,
6998 f->default_face_done_p, 1);
6999 f->default_face_done_p = 1;
7001 #endif /* HAVE_WINDOW_SYSTEM */
7003 if (!FRAME_WINDOW_P (f))
7005 LFACE_FAMILY (lface) = build_string ("default");
7006 LFACE_SWIDTH (lface) = Qnormal;
7007 LFACE_HEIGHT (lface) = make_number (1);
7008 if (UNSPECIFIEDP (LFACE_WEIGHT (lface)))
7009 LFACE_WEIGHT (lface) = Qnormal;
7010 if (UNSPECIFIEDP (LFACE_SLANT (lface)))
7011 LFACE_SLANT (lface) = Qnormal;
7012 LFACE_AVGWIDTH (lface) = Qunspecified;
7015 if (UNSPECIFIEDP (LFACE_UNDERLINE (lface)))
7016 LFACE_UNDERLINE (lface) = Qnil;
7018 if (UNSPECIFIEDP (LFACE_OVERLINE (lface)))
7019 LFACE_OVERLINE (lface) = Qnil;
7021 if (UNSPECIFIEDP (LFACE_STRIKE_THROUGH (lface)))
7022 LFACE_STRIKE_THROUGH (lface) = Qnil;
7024 if (UNSPECIFIEDP (LFACE_BOX (lface)))
7025 LFACE_BOX (lface) = Qnil;
7027 if (UNSPECIFIEDP (LFACE_INVERSE (lface)))
7028 LFACE_INVERSE (lface) = Qnil;
7030 if (UNSPECIFIEDP (LFACE_FOREGROUND (lface)))
7032 /* This function is called so early that colors are not yet
7033 set in the frame parameter list. */
7034 Lisp_Object color = Fassq (Qforeground_color, f->param_alist);
7036 if (CONSP (color) && STRINGP (XCDR (color)))
7037 LFACE_FOREGROUND (lface) = XCDR (color);
7038 else if (FRAME_WINDOW_P (f))
7039 return 0;
7040 else if (FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
7041 LFACE_FOREGROUND (lface) = build_string (unspecified_fg);
7042 else
7043 abort ();
7046 if (UNSPECIFIEDP (LFACE_BACKGROUND (lface)))
7048 /* This function is called so early that colors are not yet
7049 set in the frame parameter list. */
7050 Lisp_Object color = Fassq (Qbackground_color, f->param_alist);
7051 if (CONSP (color) && STRINGP (XCDR (color)))
7052 LFACE_BACKGROUND (lface) = XCDR (color);
7053 else if (FRAME_WINDOW_P (f))
7054 return 0;
7055 else if (FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
7056 LFACE_BACKGROUND (lface) = build_string (unspecified_bg);
7057 else
7058 abort ();
7061 if (UNSPECIFIEDP (LFACE_STIPPLE (lface)))
7062 LFACE_STIPPLE (lface) = Qnil;
7064 /* Realize the face; it must be fully-specified now. */
7065 xassert (lface_fully_specified_p (XVECTOR (lface)->contents));
7066 check_lface (lface);
7067 bcopy (XVECTOR (lface)->contents, attrs, sizeof attrs);
7068 face = realize_face (c, attrs, 0, NULL, DEFAULT_FACE_ID);
7070 #ifdef HAVE_WINDOW_SYSTEM
7071 #ifdef HAVE_X_WINDOWS
7072 if (face->font != FRAME_FONT (f))
7074 /* This can happen when making a frame on a display that does
7075 not support the default font. */
7076 if (!face->font)
7077 return 0;
7079 /* Otherwise, the font specified for the frame was not
7080 acceptable as a font for the default face (perhaps because
7081 auto-scaled fonts are rejected), so we must adjust the frame
7082 font. */
7083 x_set_font (f, build_string (face->font_name), Qnil);
7085 #endif /* HAVE_X_WINDOWS */
7086 #endif /* HAVE_WINDOW_SYSTEM */
7087 return 1;
7091 /* Realize basic faces other than the default face in face cache C.
7092 SYMBOL is the face name, ID is the face id the realized face must
7093 have. The default face must have been realized already. */
7095 static void
7096 realize_named_face (f, symbol, id)
7097 struct frame *f;
7098 Lisp_Object symbol;
7099 int id;
7101 struct face_cache *c = FRAME_FACE_CACHE (f);
7102 Lisp_Object lface = lface_from_face_name (f, symbol, 0);
7103 Lisp_Object attrs[LFACE_VECTOR_SIZE];
7104 Lisp_Object symbol_attrs[LFACE_VECTOR_SIZE];
7105 struct face *new_face;
7107 /* The default face must exist and be fully specified. */
7108 get_lface_attributes (f, Qdefault, attrs, 1);
7109 check_lface_attrs (attrs);
7110 xassert (lface_fully_specified_p (attrs));
7112 /* If SYMBOL isn't know as a face, create it. */
7113 if (NILP (lface))
7115 Lisp_Object frame;
7116 XSETFRAME (frame, f);
7117 lface = Finternal_make_lisp_face (symbol, frame);
7120 /* Merge SYMBOL's face with the default face. */
7121 get_lface_attributes (f, symbol, symbol_attrs, 1);
7122 merge_face_vectors (f, symbol_attrs, attrs, 0);
7124 /* Realize the face. */
7125 new_face = realize_face (c, attrs, 0, NULL, id);
7129 /* Realize the fully-specified face with attributes ATTRS in face
7130 cache CACHE for character C. If C is a multibyte character,
7131 BASE_FACE is a face that has the same attributes. Otherwise,
7132 BASE_FACE is ignored. If FORMER_FACE_ID is non-negative, it is an
7133 ID of face to remove before caching the new face. Value is a
7134 pointer to the newly created realized face. */
7136 static struct face *
7137 realize_face (cache, attrs, c, base_face, former_face_id)
7138 struct face_cache *cache;
7139 Lisp_Object *attrs;
7140 int c;
7141 struct face *base_face;
7142 int former_face_id;
7144 struct face *face;
7146 /* LFACE must be fully specified. */
7147 xassert (cache != NULL);
7148 check_lface_attrs (attrs);
7150 if (former_face_id >= 0 && cache->used > former_face_id)
7152 /* Remove the former face. */
7153 struct face *former_face = cache->faces_by_id[former_face_id];
7154 uncache_face (cache, former_face);
7155 free_realized_face (cache->f, former_face);
7158 if (FRAME_WINDOW_P (cache->f))
7159 face = realize_x_face (cache, attrs, c, base_face);
7160 else if (FRAME_TERMCAP_P (cache->f) || FRAME_MSDOS_P (cache->f))
7161 face = realize_tty_face (cache, attrs, c);
7162 else
7163 abort ();
7165 /* Insert the new face. */
7166 cache_face (cache, face, lface_hash (attrs));
7167 #ifdef HAVE_WINDOW_SYSTEM
7168 if (FRAME_WINDOW_P (cache->f) && face->font == NULL)
7169 load_face_font (cache->f, face, c);
7170 #endif /* HAVE_WINDOW_SYSTEM */
7171 return face;
7175 /* Realize the fully-specified face with attributes ATTRS in face
7176 cache CACHE for character C. Do it for X frame CACHE->f. If C is
7177 a multibyte character, BASE_FACE is a face that has the same
7178 attributes. Otherwise, BASE_FACE is ignored. If the new face
7179 doesn't share font with the default face, a fontname is allocated
7180 from the heap and set in `font_name' of the new face, but it is not
7181 yet loaded here. Value is a pointer to the newly created realized
7182 face. */
7184 static struct face *
7185 realize_x_face (cache, attrs, c, base_face)
7186 struct face_cache *cache;
7187 Lisp_Object *attrs;
7188 int c;
7189 struct face *base_face;
7191 struct face *face = NULL;
7192 #ifdef HAVE_WINDOW_SYSTEM
7193 struct face *default_face;
7194 struct frame *f;
7195 Lisp_Object stipple, overline, strike_through, box;
7197 xassert (FRAME_WINDOW_P (cache->f));
7198 xassert (SINGLE_BYTE_CHAR_P (c)
7199 || base_face);
7201 /* Allocate a new realized face. */
7202 face = make_realized_face (attrs);
7204 f = cache->f;
7206 /* If C is a multibyte character, we share all face attirbutes with
7207 BASE_FACE including the realized fontset. But, we must load a
7208 different font. */
7209 if (!SINGLE_BYTE_CHAR_P (c))
7211 bcopy (base_face, face, sizeof *face);
7212 face->gc = 0;
7214 /* Don't try to free the colors copied bitwise from BASE_FACE. */
7215 face->colors_copied_bitwise_p = 1;
7217 /* to force realize_face to load font */
7218 face->font = NULL;
7219 return face;
7222 /* Now we are realizing a face for ASCII (and unibyte) characters. */
7224 /* Determine the font to use. Most of the time, the font will be
7225 the same as the font of the default face, so try that first. */
7226 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
7227 if (default_face
7228 && FACE_SUITABLE_FOR_CHAR_P (default_face, c)
7229 && lface_same_font_attributes_p (default_face->lface, attrs))
7231 face->font = default_face->font;
7232 face->fontset = default_face->fontset;
7233 face->font_info_id = default_face->font_info_id;
7234 face->font_name = default_face->font_name;
7235 face->ascii_face = face;
7237 /* But, as we can't share the fontset, make a new realized
7238 fontset that has the same base fontset as of the default
7239 face. */
7240 face->fontset
7241 = make_fontset_for_ascii_face (f, default_face->fontset);
7243 else
7245 /* If the face attribute ATTRS specifies a fontset, use it as
7246 the base of a new realized fontset. Otherwise, use the same
7247 base fontset as of the default face. The base determines
7248 registry and encoding of a font. It may also determine
7249 foundry and family. The other fields of font name pattern
7250 are constructed from ATTRS. */
7251 int fontset = face_fontset (attrs);
7253 if ((fontset == -1) && default_face)
7254 fontset = default_face->fontset;
7255 face->fontset = make_fontset_for_ascii_face (f, fontset);
7256 face->font = NULL; /* to force realize_face to load font */
7259 /* Load colors, and set remaining attributes. */
7261 load_face_colors (f, face, attrs);
7263 /* Set up box. */
7264 box = attrs[LFACE_BOX_INDEX];
7265 if (STRINGP (box))
7267 /* A simple box of line width 1 drawn in color given by
7268 the string. */
7269 face->box_color = load_color (f, face, attrs[LFACE_BOX_INDEX],
7270 LFACE_BOX_INDEX);
7271 face->box = FACE_SIMPLE_BOX;
7272 face->box_line_width = 1;
7274 else if (INTEGERP (box))
7276 /* Simple box of specified line width in foreground color of the
7277 face. */
7278 xassert (XINT (box) != 0);
7279 face->box = FACE_SIMPLE_BOX;
7280 face->box_line_width = XINT (box);
7281 face->box_color = face->foreground;
7282 face->box_color_defaulted_p = 1;
7284 else if (CONSP (box))
7286 /* `(:width WIDTH :color COLOR :shadow SHADOW)'. SHADOW
7287 being one of `raised' or `sunken'. */
7288 face->box = FACE_SIMPLE_BOX;
7289 face->box_color = face->foreground;
7290 face->box_color_defaulted_p = 1;
7291 face->box_line_width = 1;
7293 while (CONSP (box))
7295 Lisp_Object keyword, value;
7297 keyword = XCAR (box);
7298 box = XCDR (box);
7300 if (!CONSP (box))
7301 break;
7302 value = XCAR (box);
7303 box = XCDR (box);
7305 if (EQ (keyword, QCline_width))
7307 if (INTEGERP (value) && XINT (value) != 0)
7308 face->box_line_width = XINT (value);
7310 else if (EQ (keyword, QCcolor))
7312 if (STRINGP (value))
7314 face->box_color = load_color (f, face, value,
7315 LFACE_BOX_INDEX);
7316 face->use_box_color_for_shadows_p = 1;
7319 else if (EQ (keyword, QCstyle))
7321 if (EQ (value, Qreleased_button))
7322 face->box = FACE_RAISED_BOX;
7323 else if (EQ (value, Qpressed_button))
7324 face->box = FACE_SUNKEN_BOX;
7329 /* Text underline, overline, strike-through. */
7331 if (EQ (attrs[LFACE_UNDERLINE_INDEX], Qt))
7333 /* Use default color (same as foreground color). */
7334 face->underline_p = 1;
7335 face->underline_defaulted_p = 1;
7336 face->underline_color = 0;
7338 else if (STRINGP (attrs[LFACE_UNDERLINE_INDEX]))
7340 /* Use specified color. */
7341 face->underline_p = 1;
7342 face->underline_defaulted_p = 0;
7343 face->underline_color
7344 = load_color (f, face, attrs[LFACE_UNDERLINE_INDEX],
7345 LFACE_UNDERLINE_INDEX);
7347 else if (NILP (attrs[LFACE_UNDERLINE_INDEX]))
7349 face->underline_p = 0;
7350 face->underline_defaulted_p = 0;
7351 face->underline_color = 0;
7354 overline = attrs[LFACE_OVERLINE_INDEX];
7355 if (STRINGP (overline))
7357 face->overline_color
7358 = load_color (f, face, attrs[LFACE_OVERLINE_INDEX],
7359 LFACE_OVERLINE_INDEX);
7360 face->overline_p = 1;
7362 else if (EQ (overline, Qt))
7364 face->overline_color = face->foreground;
7365 face->overline_color_defaulted_p = 1;
7366 face->overline_p = 1;
7369 strike_through = attrs[LFACE_STRIKE_THROUGH_INDEX];
7370 if (STRINGP (strike_through))
7372 face->strike_through_color
7373 = load_color (f, face, attrs[LFACE_STRIKE_THROUGH_INDEX],
7374 LFACE_STRIKE_THROUGH_INDEX);
7375 face->strike_through_p = 1;
7377 else if (EQ (strike_through, Qt))
7379 face->strike_through_color = face->foreground;
7380 face->strike_through_color_defaulted_p = 1;
7381 face->strike_through_p = 1;
7384 stipple = attrs[LFACE_STIPPLE_INDEX];
7385 if (!NILP (stipple))
7386 face->stipple = load_pixmap (f, stipple, &face->pixmap_w, &face->pixmap_h);
7388 xassert (FACE_SUITABLE_FOR_CHAR_P (face, c));
7389 #endif /* HAVE_WINDOW_SYSTEM */
7390 return face;
7394 /* Map a specified color of face FACE on frame F to a tty color index.
7395 IDX is either LFACE_FOREGROUND_INDEX or LFACE_BACKGROUND_INDEX, and
7396 specifies which color to map. Set *DEFAULTED to 1 if mapping to the
7397 default foreground/background colors. */
7399 static void
7400 map_tty_color (f, face, idx, defaulted)
7401 struct frame *f;
7402 struct face *face;
7403 enum lface_attribute_index idx;
7404 int *defaulted;
7406 Lisp_Object frame, color, def;
7407 int foreground_p = idx == LFACE_FOREGROUND_INDEX;
7408 unsigned long default_pixel, default_other_pixel, pixel;
7410 xassert (idx == LFACE_FOREGROUND_INDEX || idx == LFACE_BACKGROUND_INDEX);
7412 if (foreground_p)
7414 pixel = default_pixel = FACE_TTY_DEFAULT_FG_COLOR;
7415 default_other_pixel = FACE_TTY_DEFAULT_BG_COLOR;
7417 else
7419 pixel = default_pixel = FACE_TTY_DEFAULT_BG_COLOR;
7420 default_other_pixel = FACE_TTY_DEFAULT_FG_COLOR;
7423 XSETFRAME (frame, f);
7424 color = face->lface[idx];
7426 if (STRINGP (color)
7427 && SCHARS (color)
7428 && CONSP (Vtty_defined_color_alist)
7429 && (def = assq_no_quit (color, call1 (Qtty_color_alist, frame)),
7430 CONSP (def)))
7432 /* Associations in tty-defined-color-alist are of the form
7433 (NAME INDEX R G B). We need the INDEX part. */
7434 pixel = XINT (XCAR (XCDR (def)));
7437 if (pixel == default_pixel && STRINGP (color))
7439 pixel = load_color (f, face, color, idx);
7441 #if defined (MSDOS) || defined (WINDOWSNT)
7442 /* If the foreground of the default face is the default color,
7443 use the foreground color defined by the frame. */
7444 #ifdef MSDOS
7445 if (FRAME_MSDOS_P (f))
7447 #endif /* MSDOS */
7448 if (pixel == default_pixel
7449 || pixel == FACE_TTY_DEFAULT_COLOR)
7451 if (foreground_p)
7452 pixel = FRAME_FOREGROUND_PIXEL (f);
7453 else
7454 pixel = FRAME_BACKGROUND_PIXEL (f);
7455 face->lface[idx] = tty_color_name (f, pixel);
7456 *defaulted = 1;
7458 else if (pixel == default_other_pixel)
7460 if (foreground_p)
7461 pixel = FRAME_BACKGROUND_PIXEL (f);
7462 else
7463 pixel = FRAME_FOREGROUND_PIXEL (f);
7464 face->lface[idx] = tty_color_name (f, pixel);
7465 *defaulted = 1;
7467 #ifdef MSDOS
7469 #endif
7470 #endif /* MSDOS or WINDOWSNT */
7473 if (foreground_p)
7474 face->foreground = pixel;
7475 else
7476 face->background = pixel;
7480 /* Realize the fully-specified face with attributes ATTRS in face
7481 cache CACHE for character C. Do it for TTY frame CACHE->f. Value is a
7482 pointer to the newly created realized face. */
7484 static struct face *
7485 realize_tty_face (cache, attrs, c)
7486 struct face_cache *cache;
7487 Lisp_Object *attrs;
7488 int c;
7490 struct face *face;
7491 int weight, slant;
7492 int face_colors_defaulted = 0;
7493 struct frame *f = cache->f;
7495 /* Frame must be a termcap frame. */
7496 xassert (FRAME_TERMCAP_P (cache->f) || FRAME_MSDOS_P (cache->f));
7498 /* Allocate a new realized face. */
7499 face = make_realized_face (attrs);
7500 face->font_name = FRAME_MSDOS_P (cache->f) ? "ms-dos" : "tty";
7502 /* Map face attributes to TTY appearances. We map slant to
7503 dimmed text because we want italic text to appear differently
7504 and because dimmed text is probably used infrequently. */
7505 weight = face_numeric_weight (attrs[LFACE_WEIGHT_INDEX]);
7506 slant = face_numeric_slant (attrs[LFACE_SLANT_INDEX]);
7508 if (weight > XLFD_WEIGHT_MEDIUM)
7509 face->tty_bold_p = 1;
7510 if (weight < XLFD_WEIGHT_MEDIUM || slant != XLFD_SLANT_ROMAN)
7511 face->tty_dim_p = 1;
7512 if (!NILP (attrs[LFACE_UNDERLINE_INDEX]))
7513 face->tty_underline_p = 1;
7514 if (!NILP (attrs[LFACE_INVERSE_INDEX]))
7515 face->tty_reverse_p = 1;
7517 /* Map color names to color indices. */
7518 map_tty_color (f, face, LFACE_FOREGROUND_INDEX, &face_colors_defaulted);
7519 map_tty_color (f, face, LFACE_BACKGROUND_INDEX, &face_colors_defaulted);
7521 /* Swap colors if face is inverse-video. If the colors are taken
7522 from the frame colors, they are already inverted, since the
7523 frame-creation function calls x-handle-reverse-video. */
7524 if (face->tty_reverse_p && !face_colors_defaulted)
7526 unsigned long tem = face->foreground;
7527 face->foreground = face->background;
7528 face->background = tem;
7531 if (tty_suppress_bold_inverse_default_colors_p
7532 && face->tty_bold_p
7533 && face->background == FACE_TTY_DEFAULT_FG_COLOR
7534 && face->foreground == FACE_TTY_DEFAULT_BG_COLOR)
7535 face->tty_bold_p = 0;
7537 return face;
7541 DEFUN ("tty-suppress-bold-inverse-default-colors",
7542 Ftty_suppress_bold_inverse_default_colors,
7543 Stty_suppress_bold_inverse_default_colors, 1, 1, 0,
7544 doc: /* Suppress/allow boldness of faces with inverse default colors.
7545 SUPPRESS non-nil means suppress it.
7546 This affects bold faces on TTYs whose foreground is the default background
7547 color of the display and whose background is the default foreground color.
7548 For such faces, the bold face attribute is ignored if this variable
7549 is non-nil. */)
7550 (suppress)
7551 Lisp_Object suppress;
7553 tty_suppress_bold_inverse_default_colors_p = !NILP (suppress);
7554 ++face_change_count;
7555 return suppress;
7560 /***********************************************************************
7561 Computing Faces
7562 ***********************************************************************/
7564 /* Return the ID of the face to use to display character CH with face
7565 property PROP on frame F in current_buffer. */
7568 compute_char_face (f, ch, prop)
7569 struct frame *f;
7570 int ch;
7571 Lisp_Object prop;
7573 int face_id;
7575 if (NILP (current_buffer->enable_multibyte_characters))
7576 ch = 0;
7578 if (NILP (prop))
7580 struct face *face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
7581 face_id = FACE_FOR_CHAR (f, face, ch);
7583 else
7585 Lisp_Object attrs[LFACE_VECTOR_SIZE];
7586 struct face *default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
7587 bcopy (default_face->lface, attrs, sizeof attrs);
7588 merge_face_ref (f, prop, attrs, 1, 0);
7589 face_id = lookup_face (f, attrs, ch, NULL);
7592 return face_id;
7595 /* Return the face ID associated with buffer position POS for
7596 displaying ASCII characters. Return in *ENDPTR the position at
7597 which a different face is needed, as far as text properties and
7598 overlays are concerned. W is a window displaying current_buffer.
7600 REGION_BEG, REGION_END delimit the region, so it can be
7601 highlighted.
7603 LIMIT is a position not to scan beyond. That is to limit the time
7604 this function can take.
7606 If MOUSE is non-zero, use the character's mouse-face, not its face.
7608 The face returned is suitable for displaying ASCII characters. */
7611 face_at_buffer_position (w, pos, region_beg, region_end,
7612 endptr, limit, mouse)
7613 struct window *w;
7614 int pos;
7615 int region_beg, region_end;
7616 int *endptr;
7617 int limit;
7618 int mouse;
7620 struct frame *f = XFRAME (w->frame);
7621 Lisp_Object attrs[LFACE_VECTOR_SIZE];
7622 Lisp_Object prop, position;
7623 int i, noverlays;
7624 Lisp_Object *overlay_vec;
7625 Lisp_Object frame;
7626 int endpos;
7627 Lisp_Object propname = mouse ? Qmouse_face : Qface;
7628 Lisp_Object limit1, end;
7629 struct face *default_face;
7631 /* W must display the current buffer. We could write this function
7632 to use the frame and buffer of W, but right now it doesn't. */
7633 /* xassert (XBUFFER (w->buffer) == current_buffer); */
7635 XSETFRAME (frame, f);
7636 XSETFASTINT (position, pos);
7638 endpos = ZV;
7639 if (pos < region_beg && region_beg < endpos)
7640 endpos = region_beg;
7642 /* Get the `face' or `mouse_face' text property at POS, and
7643 determine the next position at which the property changes. */
7644 prop = Fget_text_property (position, propname, w->buffer);
7645 XSETFASTINT (limit1, (limit < endpos ? limit : endpos));
7646 end = Fnext_single_property_change (position, propname, w->buffer, limit1);
7647 if (INTEGERP (end))
7648 endpos = XINT (end);
7650 /* Look at properties from overlays. */
7652 int next_overlay;
7654 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, &next_overlay, 0);
7655 if (next_overlay < endpos)
7656 endpos = next_overlay;
7659 *endptr = endpos;
7661 default_face = FACE_FROM_ID (f, DEFAULT_FACE_ID);
7663 /* Optimize common cases where we can use the default face. */
7664 if (noverlays == 0
7665 && NILP (prop)
7666 && !(pos >= region_beg && pos < region_end))
7667 return DEFAULT_FACE_ID;
7669 /* Begin with attributes from the default face. */
7670 bcopy (default_face->lface, attrs, sizeof attrs);
7672 /* Merge in attributes specified via text properties. */
7673 if (!NILP (prop))
7674 merge_face_ref (f, prop, attrs, 1, 0);
7676 /* Now merge the overlay data. */
7677 noverlays = sort_overlays (overlay_vec, noverlays, w);
7678 for (i = 0; i < noverlays; i++)
7680 Lisp_Object oend;
7681 int oendpos;
7683 prop = Foverlay_get (overlay_vec[i], propname);
7684 if (!NILP (prop))
7685 merge_face_ref (f, prop, attrs, 1, 0);
7687 oend = OVERLAY_END (overlay_vec[i]);
7688 oendpos = OVERLAY_POSITION (oend);
7689 if (oendpos < endpos)
7690 endpos = oendpos;
7693 /* If in the region, merge in the region face. */
7694 if (pos >= region_beg && pos < region_end)
7696 merge_named_face (f, Qregion, attrs, 0);
7698 if (region_end < endpos)
7699 endpos = region_end;
7702 *endptr = endpos;
7704 /* Look up a realized face with the given face attributes,
7705 or realize a new one for ASCII characters. */
7706 return lookup_face (f, attrs, 0, NULL);
7710 /* Compute the face at character position POS in Lisp string STRING on
7711 window W, for ASCII characters.
7713 If STRING is an overlay string, it comes from position BUFPOS in
7714 current_buffer, otherwise BUFPOS is zero to indicate that STRING is
7715 not an overlay string. W must display the current buffer.
7716 REGION_BEG and REGION_END give the start and end positions of the
7717 region; both are -1 if no region is visible.
7719 BASE_FACE_ID is the id of a face to merge with. For strings coming
7720 from overlays or the `display' property it is the face at BUFPOS.
7722 If MOUSE_P is non-zero, use the character's mouse-face, not its face.
7724 Set *ENDPTR to the next position where to check for faces in
7725 STRING; -1 if the face is constant from POS to the end of the
7726 string.
7728 Value is the id of the face to use. The face returned is suitable
7729 for displaying ASCII characters. */
7732 face_at_string_position (w, string, pos, bufpos, region_beg,
7733 region_end, endptr, base_face_id, mouse_p)
7734 struct window *w;
7735 Lisp_Object string;
7736 int pos, bufpos;
7737 int region_beg, region_end;
7738 int *endptr;
7739 enum face_id base_face_id;
7740 int mouse_p;
7742 Lisp_Object prop, position, end, limit;
7743 struct frame *f = XFRAME (WINDOW_FRAME (w));
7744 Lisp_Object attrs[LFACE_VECTOR_SIZE];
7745 struct face *base_face;
7746 int multibyte_p = STRING_MULTIBYTE (string);
7747 Lisp_Object prop_name = mouse_p ? Qmouse_face : Qface;
7749 /* Get the value of the face property at the current position within
7750 STRING. Value is nil if there is no face property. */
7751 XSETFASTINT (position, pos);
7752 prop = Fget_text_property (position, prop_name, string);
7754 /* Get the next position at which to check for faces. Value of end
7755 is nil if face is constant all the way to the end of the string.
7756 Otherwise it is a string position where to check faces next.
7757 Limit is the maximum position up to which to check for property
7758 changes in Fnext_single_property_change. Strings are usually
7759 short, so set the limit to the end of the string. */
7760 XSETFASTINT (limit, SCHARS (string));
7761 end = Fnext_single_property_change (position, prop_name, string, limit);
7762 if (INTEGERP (end))
7763 *endptr = XFASTINT (end);
7764 else
7765 *endptr = -1;
7767 base_face = FACE_FROM_ID (f, base_face_id);
7768 xassert (base_face);
7770 /* Optimize the default case that there is no face property and we
7771 are not in the region. */
7772 if (NILP (prop)
7773 && (base_face_id != DEFAULT_FACE_ID
7774 /* BUFPOS <= 0 means STRING is not an overlay string, so
7775 that the region doesn't have to be taken into account. */
7776 || bufpos <= 0
7777 || bufpos < region_beg
7778 || bufpos >= region_end)
7779 && (multibyte_p
7780 /* We can't realize faces for different charsets differently
7781 if we don't have fonts, so we can stop here if not working
7782 on a window-system frame. */
7783 || !FRAME_WINDOW_P (f)
7784 || FACE_SUITABLE_FOR_CHAR_P (base_face, 0)))
7785 return base_face->id;
7787 /* Begin with attributes from the base face. */
7788 bcopy (base_face->lface, attrs, sizeof attrs);
7790 /* Merge in attributes specified via text properties. */
7791 if (!NILP (prop))
7792 merge_face_ref (f, prop, attrs, 1, 0);
7794 /* If in the region, merge in the region face. */
7795 if (bufpos
7796 && bufpos >= region_beg
7797 && bufpos < region_end)
7798 merge_named_face (f, Qregion, attrs, 0);
7800 /* Look up a realized face with the given face attributes,
7801 or realize a new one for ASCII characters. */
7802 return lookup_face (f, attrs, 0, NULL);
7806 /* Merge a face into a realized face.
7808 F is frame where faces are (to be) realized.
7810 FACE_NAME is named face to merge.
7812 If FACE_NAME is nil, FACE_ID is face_id of realized face to merge.
7814 If FACE_NAME is t, FACE_ID is lface_id of face to merge.
7816 BASE_FACE_ID is realized face to merge into.
7818 Return new face id.
7822 merge_faces (f, face_name, face_id, base_face_id)
7823 struct frame *f;
7824 Lisp_Object face_name;
7825 int face_id, base_face_id;
7827 Lisp_Object attrs[LFACE_VECTOR_SIZE];
7828 struct face *base_face;
7830 base_face = FACE_FROM_ID (f, base_face_id);
7831 if (!base_face)
7832 return base_face_id;
7834 if (EQ (face_name, Qt))
7836 if (face_id < 0 || face_id >= lface_id_to_name_size)
7837 return base_face_id;
7838 face_name = lface_id_to_name[face_id];
7839 face_id = lookup_derived_face (f, face_name, 0, base_face_id, 1);
7840 if (face_id >= 0)
7841 return face_id;
7842 return base_face_id;
7845 /* Begin with attributes from the base face. */
7846 bcopy (base_face->lface, attrs, sizeof attrs);
7848 if (!NILP (face_name))
7850 if (!merge_named_face (f, face_name, attrs, 0))
7851 return base_face_id;
7853 else
7855 struct face *face;
7856 if (face_id < 0)
7857 return base_face_id;
7858 face = FACE_FROM_ID (f, face_id);
7859 if (!face)
7860 return base_face_id;
7861 merge_face_vectors (f, face->lface, attrs, 0);
7864 /* Look up a realized face with the given face attributes,
7865 or realize a new one for ASCII characters. */
7866 return lookup_face (f, attrs, 0, NULL);
7870 /***********************************************************************
7871 Tests
7872 ***********************************************************************/
7874 #if GLYPH_DEBUG
7876 /* Print the contents of the realized face FACE to stderr. */
7878 static void
7879 dump_realized_face (face)
7880 struct face *face;
7882 fprintf (stderr, "ID: %d\n", face->id);
7883 #ifdef HAVE_X_WINDOWS
7884 fprintf (stderr, "gc: %ld\n", (long) face->gc);
7885 #endif
7886 fprintf (stderr, "foreground: 0x%lx (%s)\n",
7887 face->foreground,
7888 SDATA (face->lface[LFACE_FOREGROUND_INDEX]));
7889 fprintf (stderr, "background: 0x%lx (%s)\n",
7890 face->background,
7891 SDATA (face->lface[LFACE_BACKGROUND_INDEX]));
7892 fprintf (stderr, "font_name: %s (%s)\n",
7893 face->font_name,
7894 SDATA (face->lface[LFACE_FAMILY_INDEX]));
7895 #ifdef HAVE_X_WINDOWS
7896 fprintf (stderr, "font = %p\n", face->font);
7897 #endif
7898 fprintf (stderr, "font_info_id = %d\n", face->font_info_id);
7899 fprintf (stderr, "fontset: %d\n", face->fontset);
7900 fprintf (stderr, "underline: %d (%s)\n",
7901 face->underline_p,
7902 SDATA (Fsymbol_name (face->lface[LFACE_UNDERLINE_INDEX])));
7903 fprintf (stderr, "hash: %d\n", face->hash);
7904 fprintf (stderr, "charset: %d\n", face->charset);
7908 DEFUN ("dump-face", Fdump_face, Sdump_face, 0, 1, 0, doc: /* */)
7910 Lisp_Object n;
7912 if (NILP (n))
7914 int i;
7916 fprintf (stderr, "font selection order: ");
7917 for (i = 0; i < DIM (font_sort_order); ++i)
7918 fprintf (stderr, "%d ", font_sort_order[i]);
7919 fprintf (stderr, "\n");
7921 fprintf (stderr, "alternative fonts: ");
7922 debug_print (Vface_alternative_font_family_alist);
7923 fprintf (stderr, "\n");
7925 for (i = 0; i < FRAME_FACE_CACHE (SELECTED_FRAME ())->used; ++i)
7926 Fdump_face (make_number (i));
7928 else
7930 struct face *face;
7931 CHECK_NUMBER (n);
7932 face = FACE_FROM_ID (SELECTED_FRAME (), XINT (n));
7933 if (face == NULL)
7934 error ("Not a valid face");
7935 dump_realized_face (face);
7938 return Qnil;
7942 DEFUN ("show-face-resources", Fshow_face_resources, Sshow_face_resources,
7943 0, 0, 0, doc: /* */)
7946 fprintf (stderr, "number of colors = %d\n", ncolors_allocated);
7947 fprintf (stderr, "number of pixmaps = %d\n", npixmaps_allocated);
7948 fprintf (stderr, "number of GCs = %d\n", ngcs);
7949 return Qnil;
7952 #endif /* GLYPH_DEBUG != 0 */
7956 /***********************************************************************
7957 Initialization
7958 ***********************************************************************/
7960 void
7961 syms_of_xfaces ()
7963 Qface = intern ("face");
7964 staticpro (&Qface);
7965 Qface_no_inherit = intern ("face-no-inherit");
7966 staticpro (&Qface_no_inherit);
7967 Qbitmap_spec_p = intern ("bitmap-spec-p");
7968 staticpro (&Qbitmap_spec_p);
7969 Qframe_set_background_mode = intern ("frame-set-background-mode");
7970 staticpro (&Qframe_set_background_mode);
7972 /* Lisp face attribute keywords. */
7973 QCfamily = intern (":family");
7974 staticpro (&QCfamily);
7975 QCheight = intern (":height");
7976 staticpro (&QCheight);
7977 QCweight = intern (":weight");
7978 staticpro (&QCweight);
7979 QCslant = intern (":slant");
7980 staticpro (&QCslant);
7981 QCunderline = intern (":underline");
7982 staticpro (&QCunderline);
7983 QCinverse_video = intern (":inverse-video");
7984 staticpro (&QCinverse_video);
7985 QCreverse_video = intern (":reverse-video");
7986 staticpro (&QCreverse_video);
7987 QCforeground = intern (":foreground");
7988 staticpro (&QCforeground);
7989 QCbackground = intern (":background");
7990 staticpro (&QCbackground);
7991 QCstipple = intern (":stipple");
7992 staticpro (&QCstipple);
7993 QCwidth = intern (":width");
7994 staticpro (&QCwidth);
7995 QCfont = intern (":font");
7996 staticpro (&QCfont);
7997 QCbold = intern (":bold");
7998 staticpro (&QCbold);
7999 QCitalic = intern (":italic");
8000 staticpro (&QCitalic);
8001 QCoverline = intern (":overline");
8002 staticpro (&QCoverline);
8003 QCstrike_through = intern (":strike-through");
8004 staticpro (&QCstrike_through);
8005 QCbox = intern (":box");
8006 staticpro (&QCbox);
8007 QCinherit = intern (":inherit");
8008 staticpro (&QCinherit);
8010 /* Symbols used for Lisp face attribute values. */
8011 QCcolor = intern (":color");
8012 staticpro (&QCcolor);
8013 QCline_width = intern (":line-width");
8014 staticpro (&QCline_width);
8015 QCstyle = intern (":style");
8016 staticpro (&QCstyle);
8017 Qreleased_button = intern ("released-button");
8018 staticpro (&Qreleased_button);
8019 Qpressed_button = intern ("pressed-button");
8020 staticpro (&Qpressed_button);
8021 Qnormal = intern ("normal");
8022 staticpro (&Qnormal);
8023 Qultra_light = intern ("ultra-light");
8024 staticpro (&Qultra_light);
8025 Qextra_light = intern ("extra-light");
8026 staticpro (&Qextra_light);
8027 Qlight = intern ("light");
8028 staticpro (&Qlight);
8029 Qsemi_light = intern ("semi-light");
8030 staticpro (&Qsemi_light);
8031 Qsemi_bold = intern ("semi-bold");
8032 staticpro (&Qsemi_bold);
8033 Qbold = intern ("bold");
8034 staticpro (&Qbold);
8035 Qextra_bold = intern ("extra-bold");
8036 staticpro (&Qextra_bold);
8037 Qultra_bold = intern ("ultra-bold");
8038 staticpro (&Qultra_bold);
8039 Qoblique = intern ("oblique");
8040 staticpro (&Qoblique);
8041 Qitalic = intern ("italic");
8042 staticpro (&Qitalic);
8043 Qreverse_oblique = intern ("reverse-oblique");
8044 staticpro (&Qreverse_oblique);
8045 Qreverse_italic = intern ("reverse-italic");
8046 staticpro (&Qreverse_italic);
8047 Qultra_condensed = intern ("ultra-condensed");
8048 staticpro (&Qultra_condensed);
8049 Qextra_condensed = intern ("extra-condensed");
8050 staticpro (&Qextra_condensed);
8051 Qcondensed = intern ("condensed");
8052 staticpro (&Qcondensed);
8053 Qsemi_condensed = intern ("semi-condensed");
8054 staticpro (&Qsemi_condensed);
8055 Qsemi_expanded = intern ("semi-expanded");
8056 staticpro (&Qsemi_expanded);
8057 Qexpanded = intern ("expanded");
8058 staticpro (&Qexpanded);
8059 Qextra_expanded = intern ("extra-expanded");
8060 staticpro (&Qextra_expanded);
8061 Qultra_expanded = intern ("ultra-expanded");
8062 staticpro (&Qultra_expanded);
8063 Qbackground_color = intern ("background-color");
8064 staticpro (&Qbackground_color);
8065 Qforeground_color = intern ("foreground-color");
8066 staticpro (&Qforeground_color);
8067 Qunspecified = intern ("unspecified");
8068 staticpro (&Qunspecified);
8069 Qignore_defface = intern (":ignore-defface");
8070 staticpro (&Qignore_defface);
8072 Qface_alias = intern ("face-alias");
8073 staticpro (&Qface_alias);
8074 Qdefault = intern ("default");
8075 staticpro (&Qdefault);
8076 Qtool_bar = intern ("tool-bar");
8077 staticpro (&Qtool_bar);
8078 Qregion = intern ("region");
8079 staticpro (&Qregion);
8080 Qfringe = intern ("fringe");
8081 staticpro (&Qfringe);
8082 Qheader_line = intern ("header-line");
8083 staticpro (&Qheader_line);
8084 Qscroll_bar = intern ("scroll-bar");
8085 staticpro (&Qscroll_bar);
8086 Qmenu = intern ("menu");
8087 staticpro (&Qmenu);
8088 Qcursor = intern ("cursor");
8089 staticpro (&Qcursor);
8090 Qborder = intern ("border");
8091 staticpro (&Qborder);
8092 Qmouse = intern ("mouse");
8093 staticpro (&Qmouse);
8094 Qmode_line_inactive = intern ("mode-line-inactive");
8095 staticpro (&Qmode_line_inactive);
8096 Qvertical_border = intern ("vertical-border");
8097 staticpro (&Qvertical_border);
8098 Qtty_color_desc = intern ("tty-color-desc");
8099 staticpro (&Qtty_color_desc);
8100 Qtty_color_standard_values = intern ("tty-color-standard-values");
8101 staticpro (&Qtty_color_standard_values);
8102 Qtty_color_by_index = intern ("tty-color-by-index");
8103 staticpro (&Qtty_color_by_index);
8104 Qtty_color_alist = intern ("tty-color-alist");
8105 staticpro (&Qtty_color_alist);
8106 Qscalable_fonts_allowed = intern ("scalable-fonts-allowed");
8107 staticpro (&Qscalable_fonts_allowed);
8109 Vparam_value_alist = Fcons (Fcons (Qnil, Qnil), Qnil);
8110 staticpro (&Vparam_value_alist);
8111 Vface_alternative_font_family_alist = Qnil;
8112 staticpro (&Vface_alternative_font_family_alist);
8113 Vface_alternative_font_registry_alist = Qnil;
8114 staticpro (&Vface_alternative_font_registry_alist);
8116 defsubr (&Sinternal_make_lisp_face);
8117 defsubr (&Sinternal_lisp_face_p);
8118 defsubr (&Sinternal_set_lisp_face_attribute);
8119 #ifdef HAVE_WINDOW_SYSTEM
8120 defsubr (&Sinternal_set_lisp_face_attribute_from_resource);
8121 #endif
8122 defsubr (&Scolor_gray_p);
8123 defsubr (&Scolor_supported_p);
8124 defsubr (&Sface_attribute_relative_p);
8125 defsubr (&Smerge_face_attribute);
8126 defsubr (&Sinternal_get_lisp_face_attribute);
8127 defsubr (&Sinternal_lisp_face_attribute_values);
8128 defsubr (&Sinternal_lisp_face_equal_p);
8129 defsubr (&Sinternal_lisp_face_empty_p);
8130 defsubr (&Sinternal_copy_lisp_face);
8131 defsubr (&Sinternal_merge_in_global_face);
8132 defsubr (&Sface_font);
8133 defsubr (&Sframe_face_alist);
8134 defsubr (&Sdisplay_supports_face_attributes_p);
8135 defsubr (&Scolor_distance);
8136 defsubr (&Sinternal_set_font_selection_order);
8137 defsubr (&Sinternal_set_alternative_font_family_alist);
8138 defsubr (&Sinternal_set_alternative_font_registry_alist);
8139 defsubr (&Sface_attributes_as_vector);
8140 #if GLYPH_DEBUG
8141 defsubr (&Sdump_face);
8142 defsubr (&Sshow_face_resources);
8143 #endif /* GLYPH_DEBUG */
8144 defsubr (&Sclear_face_cache);
8145 defsubr (&Stty_suppress_bold_inverse_default_colors);
8147 #if defined DEBUG_X_COLORS && defined HAVE_X_WINDOWS
8148 defsubr (&Sdump_colors);
8149 #endif
8151 DEFVAR_LISP ("font-list-limit", &Vfont_list_limit,
8152 doc: /* *Limit for font matching.
8153 If an integer > 0, font matching functions won't load more than
8154 that number of fonts when searching for a matching font. */);
8155 Vfont_list_limit = make_number (DEFAULT_FONT_LIST_LIMIT);
8157 DEFVAR_LISP ("face-new-frame-defaults", &Vface_new_frame_defaults,
8158 doc: /* List of global face definitions (for internal use only.) */);
8159 Vface_new_frame_defaults = Qnil;
8161 DEFVAR_LISP ("face-default-stipple", &Vface_default_stipple,
8162 doc: /* *Default stipple pattern used on monochrome displays.
8163 This stipple pattern is used on monochrome displays
8164 instead of shades of gray for a face background color.
8165 See `set-face-stipple' for possible values for this variable. */);
8166 Vface_default_stipple = build_string ("gray3");
8168 DEFVAR_LISP ("tty-defined-color-alist", &Vtty_defined_color_alist,
8169 doc: /* An alist of defined terminal colors and their RGB values. */);
8170 Vtty_defined_color_alist = Qnil;
8172 DEFVAR_LISP ("scalable-fonts-allowed", &Vscalable_fonts_allowed,
8173 doc: /* Allowed scalable fonts.
8174 A value of nil means don't allow any scalable fonts.
8175 A value of t means allow any scalable font.
8176 Otherwise, value must be a list of regular expressions. A font may be
8177 scaled if its name matches a regular expression in the list.
8178 Note that if value is nil, a scalable font might still be used, if no
8179 other font of the appropriate family and registry is available. */);
8180 Vscalable_fonts_allowed = Qnil;
8182 DEFVAR_LISP ("face-ignored-fonts", &Vface_ignored_fonts,
8183 doc: /* List of ignored fonts.
8184 Each element is a regular expression that matches names of fonts to
8185 ignore. */);
8186 Vface_ignored_fonts = Qnil;
8188 DEFVAR_LISP ("face-font-rescale-alist", &Vface_font_rescale_alist,
8189 doc: /* Alist of fonts vs the rescaling factors.
8190 Each element is a cons (FONT-NAME-PATTERN . RESCALE-RATIO), where
8191 FONT-NAME-PATTERN is a regular expression matching a font name, and
8192 RESCALE-RATIO is a floating point number to specify how much larger
8193 \(or smaller) font we should use. For instance, if a face requests
8194 a font of 10 point, we actually use a font of 10 * RESCALE-RATIO point. */);
8195 Vface_font_rescale_alist = Qnil;
8197 #ifdef HAVE_WINDOW_SYSTEM
8198 defsubr (&Sbitmap_spec_p);
8199 defsubr (&Sx_list_fonts);
8200 defsubr (&Sinternal_face_x_get_resource);
8201 defsubr (&Sx_family_fonts);
8202 defsubr (&Sx_font_family_list);
8203 #endif /* HAVE_WINDOW_SYSTEM */
8206 /* arch-tag: 8a0f7598-5517-408d-9ab3-1da6fcd4c749
8207 (do not change this comment) */