xfaces.c 196 KB
Newer Older
Gerd Moellmann's avatar
Gerd Moellmann committed
1
/* xfaces.c -- "Face" primitives.
Glenn Morris's avatar
Glenn Morris committed
2

3
Copyright (C) 1993-1994, 1998-2011  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4

Jim Blandy's avatar
Jim Blandy committed
5 6
This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

Gerd Moellmann's avatar
Gerd Moellmann committed
20 21 22 23 24 25 26 27
/* New face implementation by Gerd Moellmann <gerd@gnu.org>.  */

/* Faces.

   When using Emacs with X, the display style of characters can be
   changed by defining `faces'.  Each face can specify the following
   display attributes:

28
   1. Font family name.
29

Kenichi Handa's avatar
Kenichi Handa committed
30 31 32
   2. Font foundary name.

   3. Relative proportionate width, aka character set width or set
Gerd Moellmann's avatar
Gerd Moellmann committed
33
   width (swidth), e.g. `semi-compressed'.
34

Kenichi Handa's avatar
Kenichi Handa committed
35
   4. Font height in 1/10pt.
36

Kenichi Handa's avatar
Kenichi Handa committed
37
   5. Font weight, e.g. `bold'.
38

Kenichi Handa's avatar
Kenichi Handa committed
39
   6. Font slant, e.g. `italic'.
40

Kenichi Handa's avatar
Kenichi Handa committed
41
   7. Foreground color.
42

Kenichi Handa's avatar
Kenichi Handa committed
43
   8. Background color.
Gerd Moellmann's avatar
Gerd Moellmann committed
44

Kenichi Handa's avatar
Kenichi Handa committed
45
   9. Whether or not characters should be underlined, and in what color.
Gerd Moellmann's avatar
Gerd Moellmann committed
46

Kenichi Handa's avatar
Kenichi Handa committed
47
   10. Whether or not characters should be displayed in inverse video.
Gerd Moellmann's avatar
Gerd Moellmann committed
48

Kenichi Handa's avatar
Kenichi Handa committed
49
   11. A background stipple, a bitmap.
Gerd Moellmann's avatar
Gerd Moellmann committed
50

Kenichi Handa's avatar
Kenichi Handa committed
51
   12. Whether or not characters should be overlined, and in what color.
Gerd Moellmann's avatar
Gerd Moellmann committed
52

Kenichi Handa's avatar
Kenichi Handa committed
53
   13. Whether or not characters should be strike-through, and in what
Gerd Moellmann's avatar
Gerd Moellmann committed
54 55
   color.

Kenichi Handa's avatar
Kenichi Handa committed
56
   14. Whether or not a box should be drawn around characters, the box
Gerd Moellmann's avatar
Gerd Moellmann committed
57 58
   type, and, for simple boxes, in what color.

Kenichi Handa's avatar
Kenichi Handa committed
59
   15. Font-spec, or nil.  This is a special attribute.
60 61 62 63 64 65 66 67

   A font-spec is a collection of font attributes (specs).

   When this attribute is specified, the face uses a font matching
   with the specs as is except for what overwritten by the specs in
   the fontset (see below).  In addition, the other font-related
   attributes (1st thru 5th) are updated from the spec.

68
   On the other hand, if one of the other font-related attributes are
69
   specified, the correspoinding specs in this attribute is set to nil.
70

Miles Bader's avatar
Miles Bader committed
71 72
   15. A face name or list of face names from which to inherit attributes.

73 74 75 76
   16. A specified average font width, which is invisible from Lisp,
   and is used to ensure that a font specified on the command line,
   for example, can be matched exactly.

77 78 79 80 81
   17. A fontset name.  This is another special attribute.

   A fontset is a mappings from characters to font-specs, and the
   specs overwrite the font-spec in the 14th attribute.

Kenichi Handa's avatar
Kenichi Handa committed
82

Gerd Moellmann's avatar
Gerd Moellmann committed
83 84 85 86
   Faces are frame-local by nature because Emacs allows to define the
   same named face (face names are symbols) differently for different
   frames.  Each frame has an alist of face definitions for all named
   faces.  The value of a named face in such an alist is a Lisp vector
87 88
   with the symbol `face' in slot 0, and a slot for each of the face
   attributes mentioned above.
Gerd Moellmann's avatar
Gerd Moellmann committed
89 90 91 92

   There is also a global face alist `Vface_new_frame_defaults'.  Face
   definitions from this list are used to initialize faces of newly
   created frames.
93

Gerd Moellmann's avatar
Gerd Moellmann committed
94
   A face doesn't have to specify all attributes.  Those not specified
95 96
   have a value of `unspecified'.  Faces specifying all attributes but
   the 14th are called `fully-specified'.
Gerd Moellmann's avatar
Gerd Moellmann committed
97 98 99 100 101 102 103 104 105 106 107 108 109


   Face merging.

   The display style of a given character in the text is determined by
   combining several faces.  This process is called `face merging'.
   Any aspect of the display style that isn't specified by overlays or
   text properties is taken from the `default' face.  Since it is made
   sure that the default face is always fully-specified, face merging
   always results in a fully-specified face.


   Face realization.
110

Gerd Moellmann's avatar
Gerd Moellmann committed
111 112 113 114 115 116 117
   After all face attributes for a character have been determined by
   merging faces of that character, that face is `realized'.  The
   realization process maps face attributes to what is physically
   available on the system where Emacs runs.  The result is a
   `realized face' in form of a struct face which is stored in the
   face cache of the frame on which it was realized.

118 119 120 121
   Face realization is done in the context of the character to display
   because different fonts may be used for different characters.  In
   other words, for characters that have different font
   specifications, different realized faces are needed to display
Gerd Moellmann's avatar
Gerd Moellmann committed
122 123
   them.

124 125 126 127 128 129 130 131 132 133
   Font specification is done by fontsets.  See the comment in
   fontset.c for the details.  In the current implementation, all ASCII
   characters share the same font in a fontset.

   Faces are at first realized for ASCII characters, and, at that
   time, assigned a specific realized fontset.  Hereafter, we call
   such a face as `ASCII face'.  When a face for a multibyte character
   is realized, it inherits (thus shares) a fontset of an ASCII face
   that has the same attributes other than font-related ones.

Kenichi Handa's avatar
Kenichi Handa committed
134
   Thus, all realized faces have a realized fontset.
Gerd Moellmann's avatar
Gerd Moellmann committed
135 136 137 138


   Unibyte text.

139 140 141 142 143
   Unibyte text (i.e. raw 8-bit characters) is displayed with the same
   font as ASCII characters.  That is because it is expected that
   unibyte text users specify a font that is suitable both for ASCII
   and raw 8-bit characters.

Gerd Moellmann's avatar
Gerd Moellmann committed
144 145 146 147

   Font selection.

   Font selection tries to find the best available matching font for a
148
   given (character, face) combination.
Gerd Moellmann's avatar
Gerd Moellmann committed
149

150 151 152 153 154 155
   If the face specifies a fontset name, that fontset determines a
   pattern for fonts of the given character.  If the face specifies a
   font name or the other font-related attributes, a fontset is
   realized from the default fontset.  In that case, that
   specification determines a pattern for ASCII characters and the
   default fontset determines a pattern for multibyte characters.
Gerd Moellmann's avatar
Gerd Moellmann committed
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171

   Available fonts on the system on which Emacs runs are then matched
   against the font pattern.  The result of font selection is the best
   match for the given face attributes in this font list.

   Font selection can be influenced by the user.

   1. The user can specify the relative importance he gives the face
   attributes width, height, weight, and slant by setting
   face-font-selection-order (faces.el) to a list of face attribute
   names.  The default is '(:width :height :weight :slant), and means
   that font selection first tries to find a good match for the font
   width specified by a face, then---within fonts with that
   width---tries to find a best match for the specified font height,
   etc.

172
   2. Setting face-font-family-alternatives allows the user to
Gerd Moellmann's avatar
Gerd Moellmann committed
173 174 175
   specify alternative font families to try if a family specified by a
   face doesn't exist.

176 177 178 179 180 181 182
   3. Setting face-font-registry-alternatives allows the user to
   specify all alternative font registries to try for a face
   specifying a registry.

   4. Setting face-ignored-fonts allows the user to ignore specific
   fonts.

Gerd Moellmann's avatar
Gerd Moellmann committed
183

Stefan Monnier's avatar
Typos.  
Stefan Monnier committed
184
   Character composition.
185 186 187 188 189 190 191 192

   Usually, the realization process is already finished when Emacs
   actually reflects the desired glyph matrix on the screen.  However,
   on displaying a composition (sequence of characters to be composed
   on the screen), a suitable font for the components of the
   composition is selected and realized while drawing them on the
   screen, i.e.  the realization process is delayed but in principle
   the same.
Gerd Moellmann's avatar
Gerd Moellmann committed
193

194

Gerd Moellmann's avatar
Gerd Moellmann committed
195 196 197 198 199 200 201
   Initialization of basic faces.

   The faces `default', `modeline' are considered `basic faces'.
   When redisplay happens the first time for a newly created frame,
   basic faces are realized for CHARSET_ASCII.  Frame parameters are
   used to fill in unspecified attributes of the default face.  */

202
#include <config.h>
Kenichi Handa's avatar
Kenichi Handa committed
203
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
204 205
#include <sys/types.h>
#include <sys/stat.h>
206
#include <stdio.h>              /* This needs to be before termchar.h */
207
#include <setjmp.h>
208

Jim Blandy's avatar
Jim Blandy committed
209
#include "lisp.h"
210
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
211
#include "charset.h"
212
#include "keyboard.h"
213
#include "frame.h"
214
#include "termhooks.h"
215

Morten Welinder's avatar
Morten Welinder committed
216
#ifdef HAVE_X_WINDOWS
Jim Blandy's avatar
Jim Blandy committed
217
#include "xterm.h"
218 219 220 221
#ifdef USE_MOTIF
#include <Xm/Xm.h>
#include <Xm/XmStrDefs.h>
#endif /* USE_MOTIF */
222
#endif /* HAVE_X_WINDOWS */
Gerd Moellmann's avatar
Gerd Moellmann committed
223

Morten Welinder's avatar
Morten Welinder committed
224 225 226
#ifdef MSDOS
#include "dosfns.h"
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
227

228 229 230 231 232
#ifdef WINDOWSNT
#include "w32term.h"
#include "fontset.h"
/* Redefine X specifics to W32 equivalents to avoid cluttering the
   code with #ifdef blocks. */
233
#undef FRAME_X_DISPLAY_INFO
234 235 236 237 238
#define FRAME_X_DISPLAY_INFO FRAME_W32_DISPLAY_INFO
#define x_display_info w32_display_info
#define FRAME_X_FONT_TABLE FRAME_W32_FONT_TABLE
#define check_x check_w32
#define GCGraphicsExposures 0
239
#endif /* WINDOWSNT */
240

241 242 243 244 245 246 247 248 249 250
#ifdef HAVE_NS
#include "nsterm.h"
#undef FRAME_X_DISPLAY_INFO
#define FRAME_X_DISPLAY_INFO FRAME_NS_DISPLAY_INFO
#define x_display_info ns_display_info
#define FRAME_X_FONT_TABLE FRAME_NS_FONT_TABLE
#define check_x check_ns
#define GCGraphicsExposures 0
#endif /* HAVE_NS */

Jim Blandy's avatar
Jim Blandy committed
251
#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
252
#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
253
#include "blockinput.h"
254
#include "window.h"
Karl Heuer's avatar
Karl Heuer committed
255
#include "intervals.h"
256
#include "termchar.h"
Jim Blandy's avatar
Jim Blandy committed
257

Kenichi Handa's avatar
Kenichi Handa committed
258
#include "font.h"
259
#ifdef HAVE_WINDOW_SYSTEM
260 261
#include "fontset.h"
#endif /* HAVE_WINDOW_SYSTEM */
Kenichi Handa's avatar
Kenichi Handa committed
262

Morten Welinder's avatar
Morten Welinder committed
263
#ifdef HAVE_X_WINDOWS
Gerd Moellmann's avatar
Gerd Moellmann committed
264 265

/* Compensate for a bug in Xos.h on some systems, on which it requires
266 267 268 269
   time.h.  On some such systems, Xos.h tries to redefine struct
   timeval and struct timezone if USG is #defined while it is
   #included.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
270
#ifdef XOS_NEEDS_TIME_H
271
#include <time.h>
272 273 274
#undef USG
#include <X11/Xos.h>
#define USG
275
#define __TIMEVAL__
276 277
#if defined USG || defined __TIMEVAL__ /* Don't warn about unused macros.  */
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
278 279 280
#else /* not XOS_NEEDS_TIME_H */
#include <X11/Xos.h>
#endif /* not XOS_NEEDS_TIME_H */
281

Gerd Moellmann's avatar
Gerd Moellmann committed
282
#endif /* HAVE_X_WINDOWS */
283

Gerd Moellmann's avatar
Gerd Moellmann committed
284
#include <ctype.h>
Jim Blandy's avatar
Jim Blandy committed
285

Gerd Moellmann's avatar
Gerd Moellmann committed
286 287 288 289
/* Number of pt per inch (from the TeXbook).  */

#define PT_PER_INCH 72.27

Gerd Moellmann's avatar
Gerd Moellmann committed
290 291 292 293
/* Non-zero if face attribute ATTR is unspecified.  */

#define UNSPECIFIEDP(ATTR) EQ ((ATTR), Qunspecified)

294 295 296 297
/* Non-zero if face attribute ATTR is `ignore-defface'.  */

#define IGNORE_DEFFACE_P(ATTR) EQ ((ATTR), Qignore_defface)

Gerd Moellmann's avatar
Gerd Moellmann committed
298 299 300 301
/* Value is the number of elements of VECTOR.  */

#define DIM(VECTOR) (sizeof (VECTOR) / sizeof *(VECTOR))

302
/* Size of hash table of realized faces in face caches (should be a
Gerd Moellmann's avatar
Gerd Moellmann committed
303 304 305 306 307 308
   prime number).  */

#define FACE_CACHE_BUCKETS_SIZE 1001

/* Keyword symbols used for face attribute names.  */

309 310 311 312 313 314 315 316 317
Lisp_Object QCfamily, QCheight, QCweight, QCslant;
static Lisp_Object QCunderline;
static Lisp_Object QCinverse_video, QCstipple;
Lisp_Object QCforeground, QCbackground;
Lisp_Object QCwidth;
static Lisp_Object QCfont, QCbold, QCitalic;
static Lisp_Object QCreverse_video;
static Lisp_Object QCoverline, QCstrike_through, QCbox, QCinherit;
static Lisp_Object QCfontset;
Gerd Moellmann's avatar
Gerd Moellmann committed
318 319 320

/* Symbols used for attribute values.  */

321
Lisp_Object Qnormal;
322 323
Lisp_Object Qbold;
static Lisp_Object Qultra_light, Qextra_light, Qlight;
324
static Lisp_Object Qsemi_light, Qsemi_bold, Qextra_bold, Qultra_bold;
325 326 327 328 329 330
static Lisp_Object Qoblique, Qreverse_oblique, Qreverse_italic;
Lisp_Object Qitalic;
static Lisp_Object Qultra_condensed, Qextra_condensed;
Lisp_Object Qcondensed;
static Lisp_Object Qsemi_condensed, Qsemi_expanded, Qextra_expanded;
Lisp_Object Qexpanded;
331 332 333
static Lisp_Object Qultra_expanded;
static Lisp_Object Qreleased_button, Qpressed_button;
static Lisp_Object QCstyle, QCcolor, QCline_width;
334
Lisp_Object Qunspecified;	/* used in dosfns.c */
335
static Lisp_Object Qignore_defface;
336 337

char unspecified_fg[] = "unspecified-fg", unspecified_bg[] = "unspecified-bg";
Gerd Moellmann's avatar
Gerd Moellmann committed
338

339
/* The name of the function to call when the background of the frame
340
   has changed, frame_set_background_mode.  */
341

342
static Lisp_Object Qframe_set_background_mode;
343

Gerd Moellmann's avatar
Gerd Moellmann committed
344 345
/* Names of basic faces.  */

346 347 348 349 350 351
Lisp_Object Qdefault, Qtool_bar, Qfringe;
static Lisp_Object Qregion;
Lisp_Object Qheader_line, Qscroll_bar, Qcursor;
static Lisp_Object Qborder, Qmouse, Qmenu;
Lisp_Object Qmode_line_inactive;
static Lisp_Object Qvertical_border;
352

353 354 355 356
/* The symbol `face-alias'.  A symbols having that property is an
   alias for another face.  Value of the property is the name of
   the aliased face.  */

357
static Lisp_Object Qface_alias;
358

Gerd Moellmann's avatar
Gerd Moellmann committed
359 360 361 362 363 364
/* Alist of alternative font families.  Each element is of the form
   (FAMILY FAMILY1 FAMILY2 ...).  If fonts of FAMILY can't be loaded,
   try FAMILY1, then FAMILY2, ...  */

Lisp_Object Vface_alternative_font_family_alist;

365 366 367 368 369 370
/* Alist of alternative font registries.  Each element is of the form
   (REGISTRY REGISTRY1 REGISTRY2...).  If fonts of REGISTRY can't be
   loaded, try REGISTRY1, then REGISTRY2, ...  */

Lisp_Object Vface_alternative_font_registry_alist;

Gerd Moellmann's avatar
Gerd Moellmann committed
371 372 373 374 375 376
/* Allowed scalable fonts.  A value of nil means don't allow any
   scalable fonts.  A value of t means allow the use of any scalable
   font.  Otherwise, value must be a list of regular expressions.  A
   font may be scaled if its name matches a regular expression in the
   list.  */

377
static Lisp_Object Qscalable_fonts_allowed;
378

Gerd Moellmann's avatar
Gerd Moellmann committed
379 380
#define DEFAULT_FONT_LIST_LIMIT 100

Gerd Moellmann's avatar
Gerd Moellmann committed
381 382 383 384 385 386 387
/* The symbols `foreground-color' and `background-color' which can be
   used as part of a `face' property.  This is for compatibility with
   Emacs 20.2.  */

Lisp_Object Qforeground_color, Qbackground_color;

/* The symbols `face' and `mouse-face' used as text properties.  */
Jim Blandy's avatar
Jim Blandy committed
388

389
Lisp_Object Qface;
Gerd Moellmann's avatar
Gerd Moellmann committed
390

Kim F. Storm's avatar
Kim F. Storm committed
391 392
/* Property for basic faces which other faces cannot inherit.  */

393
static Lisp_Object Qface_no_inherit;
Kim F. Storm's avatar
Kim F. Storm committed
394

Gerd Moellmann's avatar
Gerd Moellmann committed
395 396
/* Error symbol for wrong_type_argument in load_pixmap.  */

397
static Lisp_Object Qbitmap_spec_p;
Jim Blandy's avatar
Jim Blandy committed
398

Gerd Moellmann's avatar
Gerd Moellmann committed
399
/* The next ID to assign to Lisp faces.  */
400

Gerd Moellmann's avatar
Gerd Moellmann committed
401
static int next_lface_id;
Jim Blandy's avatar
Jim Blandy committed
402

Gerd Moellmann's avatar
Gerd Moellmann committed
403
/* A vector mapping Lisp face Id's to face names.  */
Jim Blandy's avatar
Jim Blandy committed
404

Gerd Moellmann's avatar
Gerd Moellmann committed
405 406
static Lisp_Object *lface_id_to_name;
static int lface_id_to_name_size;
Jim Blandy's avatar
Jim Blandy committed
407

408 409
/* TTY color-related functions (defined in tty-colors.el).  */

410
static Lisp_Object Qtty_color_desc, Qtty_color_by_index, Qtty_color_standard_values;
Gerd Moellmann's avatar
Gerd Moellmann committed
411

412 413
/* The name of the function used to compute colors on TTYs.  */

414
static Lisp_Object Qtty_color_alist;
415

Gerd Moellmann's avatar
Gerd Moellmann committed
416 417 418 419 420 421 422 423 424 425 426 427 428
/* Counter for calls to clear_face_cache.  If this counter reaches
   CLEAR_FONT_TABLE_COUNT, and a frame has more than
   CLEAR_FONT_TABLE_NFONTS load, unused fonts are freed.  */

static int clear_font_table_count;
#define CLEAR_FONT_TABLE_COUNT	100
#define CLEAR_FONT_TABLE_NFONTS	10

/* Non-zero means face attributes have been changed since the last
   redisplay.  Used in redisplay_internal.  */

int face_change_count;

429 430 431 432 433
/* Non-zero means don't display bold text if a face's foreground
   and background colors are the inverse of the default colors of the
   display.   This is a kluge to suppress `bold black' foreground text
   which is hard to read on an LCD monitor.  */

434
static int tty_suppress_bold_inverse_default_colors_p;
435

436 437 438 439 440
/* A list of the form `((x . y))' used to avoid consing in
   Finternal_set_lisp_face_attribute.  */

static Lisp_Object Vparam_value_alist;

Gerd Moellmann's avatar
Gerd Moellmann committed
441 442 443 444 445 446 447 448
/* The total number of colors currently allocated.  */

#if GLYPH_DEBUG
static int ncolors_allocated;
static int npixmaps_allocated;
static int ngcs;
#endif

449 450 451
/* Non-zero means the definition of the `menu' face for new frames has
   been changed.  */

452
static int menu_face_changed_default;
Gerd Moellmann's avatar
Gerd Moellmann committed
453 454 455 456 457


/* Function prototypes.  */

struct table_entry;
458
struct named_merge_point;
Gerd Moellmann's avatar
Gerd Moellmann committed
459

460
static void map_tty_color (struct frame *, struct face *,
Andreas Schwab's avatar
Andreas Schwab committed
461
			   enum lface_attribute_index, int *);
462 463 464
static Lisp_Object resolve_face_name (Lisp_Object, int);
static void set_font_frame_param (Lisp_Object, Lisp_Object);
static int get_lface_attributes (struct frame *, Lisp_Object, Lisp_Object *,
Andreas Schwab's avatar
Andreas Schwab committed
465
				 int, struct named_merge_point *);
466 467
static ptrdiff_t load_pixmap (struct frame *, Lisp_Object,
			      unsigned *, unsigned *);
468 469 470
static struct frame *frame_or_selected_frame (Lisp_Object, int);
static void load_face_colors (struct frame *, struct face *, Lisp_Object *);
static void free_face_colors (struct frame *, struct face *);
471
static int face_color_gray_p (struct frame *, const char *);
472
static struct face *realize_face (struct face_cache *, Lisp_Object *,
Andreas Schwab's avatar
Andreas Schwab committed
473
				  int);
474
static struct face *realize_non_ascii_face (struct frame *, Lisp_Object,
Andreas Schwab's avatar
Andreas Schwab committed
475
					    struct face *);
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
static struct face *realize_x_face (struct face_cache *, Lisp_Object *);
static struct face *realize_tty_face (struct face_cache *, Lisp_Object *);
static int realize_basic_faces (struct frame *);
static int realize_default_face (struct frame *);
static void realize_named_face (struct frame *, Lisp_Object, int);
static int lface_fully_specified_p (Lisp_Object *);
static int lface_equal_p (Lisp_Object *, Lisp_Object *);
static unsigned hash_string_case_insensitive (Lisp_Object);
static unsigned lface_hash (Lisp_Object *);
static int lface_same_font_attributes_p (Lisp_Object *, Lisp_Object *);
static struct face_cache *make_face_cache (struct frame *);
static void clear_face_gcs (struct face_cache *);
static void free_face_cache (struct face_cache *);
static int face_fontset (Lisp_Object *);
static void merge_face_vectors (struct frame *, Lisp_Object *, Lisp_Object*,
Andreas Schwab's avatar
Andreas Schwab committed
491
				struct named_merge_point *);
492
static int merge_face_ref (struct frame *, Lisp_Object, Lisp_Object *,
Andreas Schwab's avatar
Andreas Schwab committed
493
			   int, struct named_merge_point *);
494
static int set_lface_from_font (struct frame *, Lisp_Object, Lisp_Object,
Andreas Schwab's avatar
Andreas Schwab committed
495
				int);
496 497 498 499
static Lisp_Object lface_from_face_name (struct frame *, Lisp_Object, int);
static struct face *make_realized_face (Lisp_Object *);
static void cache_face (struct face_cache *, struct face *, unsigned);
static void uncache_face (struct face_cache *, struct face *);
Gerd Moellmann's avatar
Gerd Moellmann committed
500

501
#ifdef HAVE_WINDOW_SYSTEM
Gerd Moellmann's avatar
Gerd Moellmann committed
502

503 504
static GC x_create_gc (struct frame *, unsigned long, XGCValues *);
static void x_free_gc (struct frame *, GC);
Gerd Moellmann's avatar
Gerd Moellmann committed
505

506
#ifdef USE_X_TOOLKIT
507
static void x_update_menu_appearance (struct frame *);
Pavel Janík's avatar
Pavel Janík committed
508

509
extern void free_frame_menubar (struct frame *);
510 511
#endif /* USE_X_TOOLKIT */

512
#endif /* HAVE_WINDOW_SYSTEM */
Jim Blandy's avatar
Jim Blandy committed
513

514

Gerd Moellmann's avatar
Gerd Moellmann committed
515 516 517
/***********************************************************************
			      Utilities
 ***********************************************************************/
Jim Blandy's avatar
Jim Blandy committed
518

Morten Welinder's avatar
Morten Welinder committed
519
#ifdef HAVE_X_WINDOWS
520

521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
#ifdef DEBUG_X_COLORS

/* The following is a poor mans infrastructure for debugging X color
   allocation problems on displays with PseudoColor-8.  Some X servers
   like 3.3.5 XF86_SVGA with Matrox cards apparently don't implement
   color reference counts completely so that they don't signal an
   error when a color is freed whose reference count is already 0.
   Other X servers do.  To help me debug this, the following code
   implements a simple reference counting schema of its own, for a
   single display/screen.  --gerd.  */

/* Reference counts for pixel colors.  */

int color_count[256];

/* Register color PIXEL as allocated.  */

void
Andreas Schwab's avatar
Andreas Schwab committed
539
register_color (unsigned long pixel)
540 541 542 543 544 545 546 547 548
{
  xassert (pixel < 256);
  ++color_count[pixel];
}


/* Register color PIXEL as deallocated.  */

void
Andreas Schwab's avatar
Andreas Schwab committed
549
unregister_color (unsigned long pixel)
550 551 552 553 554 555 556 557 558 559 560 561
{
  xassert (pixel < 256);
  if (color_count[pixel] > 0)
    --color_count[pixel];
  else
    abort ();
}


/* Register N colors from PIXELS as deallocated.  */

void
Andreas Schwab's avatar
Andreas Schwab committed
562
unregister_colors (unsigned long *pixels, int n)
563 564 565 566 567 568
{
  int i;
  for (i = 0; i < n; ++i)
    unregister_color (pixels[i]);
}

569

Paul Eggert's avatar
Paul Eggert committed
570
DEFUN ("dump-colors", Fdump_colors, Sdump_colors, 0, 0, 0,
571
       doc: /* Dump currently allocated colors to stderr.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
572
  (void)
573 574 575 576
{
  int i, n;

  fputc ('\n', stderr);
577

578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
  for (i = n = 0; i < sizeof color_count / sizeof color_count[0]; ++i)
    if (color_count[i])
      {
	fprintf (stderr, "%3d: %5d", i, color_count[i]);
	++n;
	if (n % 5 == 0)
	  fputc ('\n', stderr);
	else
	  fputc ('\t', stderr);
      }

  if (n % 5 != 0)
    fputc ('\n', stderr);
  return Qnil;
}

594 595
#endif /* DEBUG_X_COLORS */

596

597 598 599 600 601
/* Free colors used on frame F.  PIXELS is an array of NPIXELS pixel
   color values.  Interrupt input must be blocked when this function
   is called.  */

void
602
x_free_colors (struct frame *f, long unsigned int *pixels, int npixels)
603 604 605 606 607 608 609
{
  int class = FRAME_X_DISPLAY_INFO (f)->visual->class;

  /* If display has an immutable color map, freeing colors is not
     necessary and some servers don't allow it.  So don't do it.  */
  if (class != StaticColor && class != StaticGray && class != TrueColor)
    {
610
#ifdef DEBUG_X_COLORS
611
      unregister_colors (pixels, npixels);
612
#endif
613 614
      XFreeColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
		   pixels, npixels, 0);
615 616 617 618
    }
}


619 620
#ifdef USE_X_TOOLKIT

621 622 623 624 625
/* Free colors used on frame F.  PIXELS is an array of NPIXELS pixel
   color values.  Interrupt input must be blocked when this function
   is called.  */

void
Andreas Schwab's avatar
Andreas Schwab committed
626 627
x_free_dpy_colors (Display *dpy, Screen *screen, Colormap cmap,
		   long unsigned int *pixels, int npixels)
628 629 630 631 632 633 634 635
{
  struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
  int class = dpyinfo->visual->class;

  /* If display has an immutable color map, freeing colors is not
     necessary and some servers don't allow it.  So don't do it.  */
  if (class != StaticColor && class != StaticGray && class != TrueColor)
    {
636
#ifdef DEBUG_X_COLORS
637
      unregister_colors (pixels, npixels);
638
#endif
639
      XFreeColors (dpy, cmap, pixels, npixels, 0);
640 641
    }
}
642
#endif /* USE_X_TOOLKIT */
643

Gerd Moellmann's avatar
Gerd Moellmann committed
644 645 646
/* Create and return a GC for use on frame F.  GC values and mask
   are given by XGCV and MASK.  */

Paul Eggert's avatar
Paul Eggert committed
647
static inline GC
648
x_create_gc (struct frame *f, long unsigned int mask, XGCValues *xgcv)
Jim Blandy's avatar
Jim Blandy committed
649 650
{
  GC gc;
Gerd Moellmann's avatar
Gerd Moellmann committed
651 652 653 654 655 656
  BLOCK_INPUT;
  gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), mask, xgcv);
  UNBLOCK_INPUT;
  IF_DEBUG (++ngcs);
  return gc;
}
Jim Blandy's avatar
Jim Blandy committed
657

658

Gerd Moellmann's avatar
Gerd Moellmann committed
659 660
/* Free GC which was used on frame F.  */

Paul Eggert's avatar
Paul Eggert committed
661
static inline void
662
x_free_gc (struct frame *f, GC gc)
Gerd Moellmann's avatar
Gerd Moellmann committed
663
{
664
  eassert (interrupt_input_blocked);
665
  IF_DEBUG (xassert (--ngcs >= 0));
Gerd Moellmann's avatar
Gerd Moellmann committed
666 667
  XFreeGC (FRAME_X_DISPLAY (f), gc);
}
668

Gerd Moellmann's avatar
Gerd Moellmann committed
669
#endif /* HAVE_X_WINDOWS */
670

671 672 673
#ifdef WINDOWSNT
/* W32 emulation of GCs */

Paul Eggert's avatar
Paul Eggert committed
674
static inline GC
675
x_create_gc (struct frame *f, unsigned long mask, XGCValues *xgcv)
676 677 678 679 680 681 682 683 684 685 686 687
{
  GC gc;
  BLOCK_INPUT;
  gc = XCreateGC (NULL, FRAME_W32_WINDOW (f), mask, xgcv);
  UNBLOCK_INPUT;
  IF_DEBUG (++ngcs);
  return gc;
}


/* Free GC which was used on frame F.  */

Paul Eggert's avatar
Paul Eggert committed
688
static inline void
689
x_free_gc (struct frame *f, GC gc)
690
{
691
  IF_DEBUG (xassert (--ngcs >= 0));
692 693 694 695
  xfree (gc);
}

#endif  /* WINDOWSNT */
696

697 698 699
#ifdef HAVE_NS
/* NS emulation of GCs */

Paul Eggert's avatar
Paul Eggert committed
700
static inline GC
701
x_create_gc (struct frame *f,
Andreas Schwab's avatar
Andreas Schwab committed
702 703
	     unsigned long mask,
	     XGCValues *xgcv)
704 705 706
{
  GC gc = xmalloc (sizeof (*gc));
  if (gc)
707
    memcpy (gc, xgcv, sizeof (XGCValues));
708 709 710
  return gc;
}

Paul Eggert's avatar
Paul Eggert committed
711
static inline void
712
x_free_gc (struct frame *f, GC gc)
713
{
714
  xfree (gc);
715 716 717
}
#endif  /* HAVE_NS */

718 719
/* Like strcasecmp/stricmp.  Used to compare parts of font names which
   are in ISO8859-1.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
720 721

int
722
xstrcasecmp (const char *s1, const char *s2)
Gerd Moellmann's avatar
Gerd Moellmann committed
723 724
{
  while (*s1 && *s2)
725
    {
726 727 728 729
      unsigned char b1 = *s1;
      unsigned char b2 = *s2;
      unsigned char c1 = tolower (b1);
      unsigned char c2 = tolower (b2);
Gerd Moellmann's avatar
Gerd Moellmann committed
730 731 732
      if (c1 != c2)
	return c1 < c2 ? -1 : 1;
      ++s1, ++s2;
733
    }
734

Gerd Moellmann's avatar
Gerd Moellmann committed
735 736 737 738
  if (*s1 == 0)
    return *s2 == 0 ? 0 : -1;
  return 1;
}
739 740


741 742 743 744 745
/* If FRAME is nil, return a pointer to the selected frame.
   Otherwise, check that FRAME is a live frame, and return a pointer
   to it.  NPARAM is the parameter number of FRAME, for
   CHECK_LIVE_FRAME.  This is here because it's a frequent pattern in
   Lisp function definitions.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
746

Paul Eggert's avatar
Paul Eggert committed
747
static inline struct frame *
748
frame_or_selected_frame (Lisp_Object frame, int nparam)
Gerd Moellmann's avatar
Gerd Moellmann committed
749 750
{
  if (NILP (frame))
751
    frame = selected_frame;
752

753
  CHECK_LIVE_FRAME (frame);
754
  return XFRAME (frame);
755
}
Gerd Moellmann's avatar
Gerd Moellmann committed
756

757

Gerd Moellmann's avatar
Gerd Moellmann committed
758 759 760
/***********************************************************************
			   Frames and faces
 ***********************************************************************/
761

Gerd Moellmann's avatar
Gerd Moellmann committed
762
/* Initialize face cache and basic faces for frame F.  */
763

Gerd Moellmann's avatar
Gerd Moellmann committed
764
void
765
init_frame_faces (struct frame *f)
766
{
Gerd Moellmann's avatar
Gerd Moellmann committed
767 768 769
  /* Make a face cache, if F doesn't have one.  */
  if (FRAME_FACE_CACHE (f) == NULL)
    FRAME_FACE_CACHE (f) = make_face_cache (f);
770

771
#ifdef HAVE_WINDOW_SYSTEM
Gerd Moellmann's avatar
Gerd Moellmann committed
772
  /* Make the image cache.  */
773
  if (FRAME_WINDOW_P (f))
Gerd Moellmann's avatar
Gerd Moellmann committed
774
    {
Chong Yidong's avatar
Chong Yidong committed
775 776 777
      /* We initialize the image cache when creating the first frame
	 on a terminal, and not during terminal creation.  This way,
	 `x-open-connection' on a tty won't create an image cache.  */
778 779 780
      if (FRAME_IMAGE_CACHE (f) == NULL)
	FRAME_IMAGE_CACHE (f) = make_image_cache ();
      ++FRAME_IMAGE_CACHE (f)->refcount;
Gerd Moellmann's avatar
Gerd Moellmann committed
781
    }
782
#endif /* HAVE_WINDOW_SYSTEM */
783

784
  /* Realize basic faces.  Must have enough information in frame
Gerd Moellmann's avatar
Gerd Moellmann committed
785 786 787
     parameters to realize basic faces at this point.  */
#ifdef HAVE_X_WINDOWS
  if (!FRAME_X_P (f) || FRAME_X_WINDOW (f))
788 789 790
#endif
#ifdef WINDOWSNT
  if (!FRAME_WINDOW_P (f) || FRAME_W32_WINDOW (f))
Andrew Choi's avatar
Andrew Choi committed
791
#endif
792 793
#ifdef HAVE_NS
  if (!FRAME_NS_P (f) || FRAME_NS_WINDOW (f))
Gerd Moellmann's avatar
Gerd Moellmann committed
794 795
#endif
    if (!realize_basic_faces (f))
Andreas Schwab's avatar
Andreas Schwab committed
796
	abort ();
Gerd Moellmann's avatar
Gerd Moellmann committed
797
}
798 799


800
/* Free face cache of frame F.  Called from delete_frame.  */
801

Gerd Moellmann's avatar
Gerd Moellmann committed
802
void
803
free_frame_faces (struct frame *f)
804
{
Gerd Moellmann's avatar
Gerd Moellmann committed
805
  struct face_cache *face_cache = FRAME_FACE_CACHE (f);
806

Gerd Moellmann's avatar
Gerd Moellmann committed
807 808 809 810 811
  if (face_cache)
    {
      free_face_cache (face_cache);
      FRAME_FACE_CACHE (f) = NULL;
    }
812

813 814
#ifdef HAVE_WINDOW_SYSTEM
  if (FRAME_WINDOW_P (f))
815
    {
816
      struct image_cache *image_cache = FRAME_IMAGE_CACHE (f);
Gerd Moellmann's avatar
Gerd Moellmann committed
817
      if (image_cache)
818
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
819 820 821
	  --image_cache->refcount;
	  if (image_cache->refcount == 0)
	    free_image_cache (f);
822 823
	}
    }
824
#endif /* HAVE_WINDOW_SYSTEM */
825 826
}

Gerd Moellmann's avatar
Gerd Moellmann committed
827

828 829 830 831
/* Clear face caches, and recompute basic faces for frame F.  Call
   this after changing frame parameters on which those faces depend,
   or when realized faces have been freed due to changing attributes
   of named faces. */
Gerd Moellmann's avatar
Gerd Moellmann committed
832 833

void
834
recompute_basic_faces (struct frame *f)
835
{
Gerd Moellmann's avatar
Gerd Moellmann committed
836 837
  if (FRAME_FACE_CACHE (f))
    {
838
      clear_face_cache (0);
839 840
      if (!realize_basic_faces (f))
	abort ();
Gerd Moellmann's avatar
Gerd Moellmann committed
841 842
    }
}
843 844


Gerd Moellmann's avatar
Gerd Moellmann committed
845 846
/* Clear the face caches of all frames.  CLEAR_FONTS_P non-zero means
   try to free unused fonts, too.  */
847

848
void
849
clear_face_cache (int clear_fonts_p)
850
{
851
#ifdef HAVE_WINDOW_SYSTEM
Gerd Moellmann's avatar
Gerd Moellmann committed
852
  Lisp_Object tail, frame;
853

Gerd Moellmann's avatar
Gerd Moellmann committed
854 855
  if (clear_fonts_p
      || ++clear_font_table_count == CLEAR_FONT_TABLE_COUNT)
856
    {
857 858 859 860 861
#if 0
      /* Not yet implemented.  */
      clear_font_cache (frame);
#endif

Gerd Moellmann's avatar
Gerd Moellmann committed
862 863 864 865
      /* From time to time see if we can unload some fonts.  This also
	 frees all realized faces on all frames.  Fonts needed by
	 faces will be loaded again when faces are realized again.  */
      clear_font_table_count = 0;
866

Gerd Moellmann's avatar
Gerd Moellmann committed
867
      FOR_EACH_FRAME (tail, frame)
868
	{
869
	  struct frame *f = XFRAME (frame);
870
	  if (FRAME_WINDOW_P (f)
Gerd Moellmann's avatar
Gerd Moellmann committed
871
	      && FRAME_X_DISPLAY_INFO (f)->n_fonts > CLEAR_FONT_TABLE_NFONTS)
872
	    free_all_realized_faces (frame);
Gerd Moellmann's avatar
Gerd Moellmann committed
873 874 875 876 877 878 879
	}
    }
  else
    {
      /* Clear GCs of realized faces.  */
      FOR_EACH_FRAME (tail, frame)
	{
880
	  struct frame *f = XFRAME (frame);
881
	  if (FRAME_WINDOW_P (f))
Gerd Moellmann's avatar
Gerd Moellmann committed
882
	      clear_face_gcs (FRAME_FACE_CACHE (f));
883
	}
884
      clear_image_caches (Qnil);
885
    }
886
#endif /* HAVE_WINDOW_SYSTEM */
887 888
}

Gerd Moellmann's avatar
Gerd Moellmann committed
889

Paul Eggert's avatar
Paul Eggert committed
890
DEFUN ("clear-face-cache", Fclear_face_cache, Sclear_face_cache, 0, 1, 0,
891 892
       doc: /* Clear face caches on all frames.
Optional THOROUGHLY non-nil means try to free unused fonts, too.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
893
  (Lisp_Object thoroughly)
894
{
895
  clear_face_cache (!NILP (thoroughly));
896 897
  ++face_change_count;
  ++windows_or_buffers_changed;
Gerd Moellmann's avatar
Gerd Moellmann committed
898 899 900 901 902 903 904 905
  return Qnil;
}


/***********************************************************************
			      X Pixmaps
 ***********************************************************************/

906
#ifdef HAVE_WINDOW_SYSTEM
Gerd Moellmann's avatar
Gerd Moellmann committed
907

908
DEFUN ("bitmap-spec-p", Fbitmap_spec_p, Sbitmap_spec_p, 1, 1, 0,
909
       doc: /* Value is non-nil if OBJECT is a valid bitmap specification.
Gerd Moellmann's avatar
Gerd Moellmann committed
910 911 912 913
A bitmap specification is either a string, a file name, or a list
\(WIDTH HEIGHT DATA) where WIDTH is the pixel width of the bitmap,
HEIGHT is its height, and DATA is a string containing the bits of
the pixmap.  Bits are stored row by row, each row occupies
914
\(WIDTH + 7)/8 bytes.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
915
  (Lisp_Object object)
Gerd Moellmann's avatar
Gerd Moellmann committed
916
{
917
  int pixmap_p = 0;
918

919 920 921 922 923 924 925 926 927 928 929
  if (STRINGP (object))
    /* If OBJECT is a string, it's a file name.  */
    pixmap_p = 1;
  else if (CONSP (object))
    {
      /* Otherwise OBJECT must be (WIDTH HEIGHT DATA), WIDTH and
	 HEIGHT must be integers > 0, and DATA must be string large
	 enough to hold a bitmap of the specified size.  */
      Lisp_Object width, height, data;

      height = width = data = Qnil;
930

931 932 933 934 935 936 937 938 939 940 941 942
      if (CONSP (object))
	{
	  width = XCAR (object);
	  object = XCDR (object);
	  if (CONSP (object))
	    {
	      height = XCAR (object);
	      object = XCDR (object);
	      if (CONSP (object))
		data = XCAR (object);
	    }
	}
943

944 945 946
      if (STRINGP (data)
	  && INTEGERP (width) && 0 < XINT (width)
	  && INTEGERP (height) && 0 < XINT (height))
947
	{
948 949 950
	  EMACS_INT bytes_per_row = ((XINT (width) + BITS_PER_CHAR - 1)
				     / BITS_PER_CHAR);
	  if (XINT (height) <= SBYTES (data) / bytes_per_row)
951 952 953 954