1 /* Generic Objects and Functions.
2 Copyright (C) 1995 Free Software Foundation, Inc.
3 Copyright (C) 1995 Board of Trustees, University of Illinois.
4 Copyright (C) 1995, 1996 Ben Wing.
6 This file is part of XEmacs.
8 XEmacs is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with XEmacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 /* Synched up with: Not in FSF. */
33 #include "specifier.h"
36 /* Objects that are substituted when an instantiation fails.
37 If we leave in the Qunbound value, we will probably get crashes. */
38 Lisp_Object Vthe_null_color_instance, Vthe_null_font_instance;
40 /* Authors: Ben Wing, Chuck Thompson */
46 XSETOBJ (obj, Lisp_Type_Record, ptr);
49 ("Can't dump an emacs containing window system objects", obj);
53 /****************************************************************************
54 * Color-Instance Object *
55 ****************************************************************************/
57 Lisp_Object Qcolor_instancep;
60 mark_color_instance (Lisp_Object obj, void (*markobj) (Lisp_Object))
62 struct Lisp_Color_Instance *c = XCOLOR_INSTANCE (obj);
64 if (!NILP (c->device)) /* Vthe_null_color_instance */
65 MAYBE_DEVMETH (XDEVICE (c->device), mark_color_instance, (c, markobj));
71 print_color_instance (Lisp_Object obj, Lisp_Object printcharfun,
75 struct Lisp_Color_Instance *c = XCOLOR_INSTANCE (obj);
77 error ("printing unreadable object #<color-instance 0x%x>",
79 write_c_string ("#<color-instance ", printcharfun);
80 print_internal (c->name, printcharfun, 0);
81 write_c_string (" on ", printcharfun);
82 print_internal (c->device, printcharfun, 0);
83 if (!NILP (c->device)) /* Vthe_null_color_instance */
84 MAYBE_DEVMETH (XDEVICE (c->device), print_color_instance,
85 (c, printcharfun, escapeflag));
86 sprintf (buf, " 0x%x>", c->header.uid);
87 write_c_string (buf, printcharfun);
91 finalize_color_instance (void *header, int for_disksave)
93 struct Lisp_Color_Instance *c = (struct Lisp_Color_Instance *) header;
95 if (!NILP (c->device))
97 if (for_disksave) finalose (c);
98 MAYBE_DEVMETH (XDEVICE (c->device), finalize_color_instance, (c));
103 color_instance_equal (Lisp_Object obj1, Lisp_Object obj2, int depth)
105 struct Lisp_Color_Instance *c1 = XCOLOR_INSTANCE (obj1);
106 struct Lisp_Color_Instance *c2 = XCOLOR_INSTANCE (obj2);
109 ((EQ (c1->device, c2->device)) &&
110 DEVICEP (c1->device) &&
111 HAS_DEVMETH_P (XDEVICE (c1->device), color_instance_equal) &&
112 DEVMETH (XDEVICE (c1->device), color_instance_equal, (c1, c2, depth)));
116 color_instance_hash (Lisp_Object obj, int depth)
118 struct Lisp_Color_Instance *c = XCOLOR_INSTANCE (obj);
119 struct device *d = DEVICEP (c->device) ? XDEVICE (c->device) : 0;
121 return HASH2 ((unsigned long) d,
123 : DEVMETH_OR_GIVEN (d, color_instance_hash, (c, depth),
127 DEFINE_LRECORD_IMPLEMENTATION ("color-instance", color_instance,
128 mark_color_instance, print_color_instance,
129 finalize_color_instance, color_instance_equal,
131 struct Lisp_Color_Instance);
133 DEFUN ("make-color-instance", Fmake_color_instance, 1, 3, 0, /*
134 Return a new `color-instance' object named NAME (a string).
136 Optional argument DEVICE specifies the device this object applies to
137 and defaults to the selected device.
139 An error is signaled if the color is unknown or cannot be allocated;
140 however, if optional argument NO-ERROR is non-nil, nil is simply
141 returned in this case. (And if NO-ERROR is other than t, a warning may
144 The returned object is a normal, first-class lisp object. The way you
145 `deallocate' the color is the way you deallocate any other lisp object:
146 you drop all pointers to it and allow it to be garbage collected. When
147 these objects are GCed, the underlying window-system data (e.g. X object)
148 is deallocated as well.
150 (name, device, no_error))
152 struct Lisp_Color_Instance *c;
157 XSETDEVICE (device, decode_device (device));
159 c = alloc_lcrecord_type (struct Lisp_Color_Instance, lrecord_color_instance);
164 retval = MAYBE_INT_DEVMETH (XDEVICE (device), initialize_color_instance,
166 decode_error_behavior_flag (no_error)));
170 XSETCOLOR_INSTANCE (val, c);
174 DEFUN ("color-instance-p", Fcolor_instance_p, 1, 1, 0, /*
175 Return non-nil if OBJECT is a color instance.
179 return COLOR_INSTANCEP (object) ? Qt : Qnil;
182 DEFUN ("color-instance-name", Fcolor_instance_name, 1, 1, 0, /*
183 Return the name used to allocate COLOR-INSTANCE.
187 CHECK_COLOR_INSTANCE (color_instance);
188 return XCOLOR_INSTANCE (color_instance)->name;
191 DEFUN ("color-instance-rgb-components", Fcolor_instance_rgb_components, 1, 1, 0, /*
192 Return a three element list containing the red, green, and blue
193 color components of COLOR-INSTANCE, or nil if unknown.
194 Component values range from 0 to 65535.
198 struct Lisp_Color_Instance *c;
200 CHECK_COLOR_INSTANCE (color_instance);
201 c = XCOLOR_INSTANCE (color_instance);
203 if (NILP (c->device))
206 return MAYBE_LISP_DEVMETH (XDEVICE (c->device),
207 color_instance_rgb_components,
211 DEFUN ("valid-color-name-p", Fvalid_color_name_p, 1, 2, 0, /*
212 Return true if COLOR names a valid color for the current device.
214 Valid color names for X are listed in the file /usr/lib/X11/rgb.txt, or
215 whatever the equivalent is on your system.
217 Valid color names for TTY are those which have an ISO 6429 (ANSI) sequence.
218 In addition to being a color this may be one of a number of attributes
223 struct device *d = decode_device (device);
225 CHECK_STRING (color);
226 return MAYBE_INT_DEVMETH (d, valid_color_name_p, (d, color)) ? Qt : Qnil;
230 /***************************************************************************
231 * Font-Instance Object *
232 ***************************************************************************/
234 Lisp_Object Qfont_instancep;
236 static Lisp_Object font_instance_truename_internal (Lisp_Object xfont,
237 Error_behavior errb);
240 mark_font_instance (Lisp_Object obj, void (*markobj) (Lisp_Object))
242 struct Lisp_Font_Instance *f = XFONT_INSTANCE (obj);
245 if (!NILP (f->device)) /* Vthe_null_font_instance */
246 MAYBE_DEVMETH (XDEVICE (f->device), mark_font_instance, (f, markobj));
252 print_font_instance (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
255 struct Lisp_Font_Instance *f = XFONT_INSTANCE (obj);
257 error ("printing unreadable object #<font-instance 0x%x>", f->header.uid);
258 write_c_string ("#<font-instance ", printcharfun);
259 print_internal (f->name, printcharfun, 1);
260 write_c_string (" on ", printcharfun);
261 print_internal (f->device, printcharfun, 0);
262 MAYBE_DEVMETH (XDEVICE (f->device), print_font_instance,
263 (f, printcharfun, escapeflag));
264 sprintf (buf, " 0x%x>", f->header.uid);
265 write_c_string (buf, printcharfun);
269 finalize_font_instance (void *header, int for_disksave)
271 struct Lisp_Font_Instance *f = (struct Lisp_Font_Instance *) header;
273 if (!NILP (f->device))
275 if (for_disksave) finalose (f);
276 MAYBE_DEVMETH (XDEVICE (f->device), finalize_font_instance, (f));
280 /* Fonts are equal if they resolve to the same name.
281 Since we call `font-truename' to do this, and since font-truename is lazy,
282 this means the `equal' could cause XListFonts to be run the first time.
285 font_instance_equal (Lisp_Object obj1, Lisp_Object obj2, int depth)
287 /* #### should this be moved into a device method? */
288 return internal_equal (font_instance_truename_internal (obj1, ERROR_ME_NOT),
289 font_instance_truename_internal (obj2, ERROR_ME_NOT),
294 font_instance_hash (Lisp_Object obj, int depth)
296 return internal_hash (font_instance_truename_internal (obj, ERROR_ME_NOT),
300 DEFINE_LRECORD_IMPLEMENTATION ("font-instance", font_instance,
301 mark_font_instance, print_font_instance,
302 finalize_font_instance, font_instance_equal,
303 font_instance_hash, struct Lisp_Font_Instance);
305 DEFUN ("make-font-instance", Fmake_font_instance, 1, 3, 0, /*
306 Return a new `font-instance' object named NAME.
307 DEVICE specifies the device this object applies to and defaults to the
308 selected device. An error is signalled if the font is unknown or cannot
309 be allocated; however, if NOERROR is non-nil, nil is simply returned in
312 The returned object is a normal, first-class lisp object. The way you
313 `deallocate' the font is the way you deallocate any other lisp object:
314 you drop all pointers to it and allow it to be garbage collected. When
315 these objects are GCed, the underlying X data is deallocated as well.
317 (name, device, no_error))
319 struct Lisp_Font_Instance *f;
322 Error_behavior errb = decode_error_behavior_flag (no_error);
324 if (ERRB_EQ (errb, ERROR_ME))
326 else if (!STRINGP (name))
329 XSETDEVICE (device, decode_device (device));
331 f = alloc_lcrecord_type (struct Lisp_Font_Instance, lrecord_font_instance);
337 /* Stick some default values here ... */
338 f->ascent = f->height = 1;
341 f->proportional_p = 0;
343 retval = MAYBE_INT_DEVMETH (XDEVICE (device), initialize_font_instance,
344 (f, name, device, errb));
349 XSETFONT_INSTANCE (val, f);
353 DEFUN ("font-instance-p", Ffont_instance_p, 1, 1, 0, /*
354 Return non-nil if OBJECT is a font instance.
358 return FONT_INSTANCEP (object) ? Qt : Qnil;
361 DEFUN ("font-instance-name", Ffont_instance_name, 1, 1, 0, /*
362 Return the name used to allocate FONT-INSTANCE.
366 CHECK_FONT_INSTANCE (font_instance);
367 return XFONT_INSTANCE (font_instance)->name;
370 DEFUN ("font-instance-ascent", Ffont_instance_ascent, 1, 1, 0, /*
371 Return the ascent in pixels of FONT-INSTANCE.
372 The returned value is the maximum ascent for all characters in the font,
373 where a character's ascent is the number of pixels above (and including)
378 CHECK_FONT_INSTANCE (font_instance);
379 return make_int (XFONT_INSTANCE (font_instance)->ascent);
382 DEFUN ("font-instance-descent", Ffont_instance_descent, 1, 1, 0, /*
383 Return the descent in pixels of FONT-INSTANCE.
384 The returned value is the maximum descent for all characters in the font,
385 where a character's descent is the number of pixels below the baseline.
386 \(Many characters to do not have any descent. Typical characters with a
387 descent are lowercase p and lowercase g.)
391 CHECK_FONT_INSTANCE (font_instance);
392 return make_int (XFONT_INSTANCE (font_instance)->descent);
395 DEFUN ("font-instance-width", Ffont_instance_width, 1, 1, 0, /*
396 Return the width in pixels of FONT-INSTANCE.
397 The returned value is the average width for all characters in the font.
401 CHECK_FONT_INSTANCE (font_instance);
402 return make_int (XFONT_INSTANCE (font_instance)->width);
405 DEFUN ("font-instance-proportional-p", Ffont_instance_proportional_p, 1, 1, 0, /*
406 Return whether FONT-INSTANCE is proportional.
407 This means that different characters in the font have different widths.
411 CHECK_FONT_INSTANCE (font_instance);
412 return XFONT_INSTANCE (font_instance)->proportional_p ? Qt : Qnil;
416 font_instance_truename_internal (Lisp_Object font_instance,
419 struct Lisp_Font_Instance *f = XFONT_INSTANCE (font_instance);
420 struct device *d = XDEVICE (f->device);
421 return DEVMETH_OR_GIVEN (d, font_instance_truename, (f, errb), f->name);
424 DEFUN ("font-instance-truename", Ffont_instance_truename, 1, 1, 0, /*
425 Return the canonical name of FONT-INSTANCE.
426 Font names are patterns which may match any number of fonts, of which
427 the first found is used. This returns an unambiguous name for that font
428 \(but not necessarily its only unambiguous name).
432 CHECK_FONT_INSTANCE (font_instance);
433 return font_instance_truename_internal (font_instance, ERROR_ME);
436 DEFUN ("font-instance-properties", Ffont_instance_properties, 1, 1, 0, /*
437 Return the properties (an alist or nil) of FONT-INSTANCE.
441 struct Lisp_Font_Instance *f;
443 CHECK_FONT_INSTANCE (font_instance);
444 f = XFONT_INSTANCE (font_instance);
446 return MAYBE_LISP_DEVMETH (XDEVICE (f->device),
447 font_instance_properties, (f));
450 DEFUN ("list-fonts", Flist_fonts, 1, 2, 0, /*
451 Return a list of font names matching the given pattern.
452 DEVICE specifies which device to search for names, and defaults to the
453 currently selected device.
457 CHECK_STRING (pattern);
458 XSETDEVICE (device, decode_device (device));
460 return MAYBE_LISP_DEVMETH (XDEVICE (device), list_fonts, (pattern, device));
464 /****************************************************************************
466 ***************************************************************************/
467 DEFINE_SPECIFIER_TYPE (color);
468 /* Qcolor defined in general.c */
471 color_create (Lisp_Object obj)
473 struct Lisp_Specifier *color = XCOLOR_SPECIFIER (obj);
475 COLOR_SPECIFIER_FACE (color) = Qnil;
476 COLOR_SPECIFIER_FACE_PROPERTY (color) = Qnil;
480 color_mark (Lisp_Object obj, void (*markobj) (Lisp_Object))
482 struct Lisp_Specifier *color = XCOLOR_SPECIFIER (obj);
484 markobj (COLOR_SPECIFIER_FACE (color));
485 markobj (COLOR_SPECIFIER_FACE_PROPERTY (color));
488 /* No equal or hash methods; ignore the face the color is based off
492 color_instantiate (Lisp_Object specifier, Lisp_Object matchspec,
493 Lisp_Object domain, Lisp_Object instantiator,
496 /* When called, we're inside of call_with_suspended_errors(),
497 so we can freely error. */
498 Lisp_Object device = DFW_DEVICE (domain);
499 struct device *d = XDEVICE (device);
501 if (COLOR_INSTANCEP (instantiator))
503 /* If we are on the same device then we're done. Otherwise change
504 the instantiator to the name used to generate the pixel and let the
505 STRINGP case deal with it. */
506 if (NILP (device) /* Vthe_null_color_instance */
507 || EQ (device, XCOLOR_INSTANCE (instantiator)->device))
510 instantiator = Fcolor_instance_name (instantiator);
513 if (STRINGP (instantiator))
515 /* First, look to see if we can retrieve a cached value. */
516 Lisp_Object instance =
517 Fgethash (instantiator, d->color_instance_cache, Qunbound);
518 /* Otherwise, make a new one. */
519 if (UNBOUNDP (instance))
521 /* make sure we cache the failures, too. */
522 instance = Fmake_color_instance (instantiator, device, Qt);
523 Fputhash (instantiator, instance, d->color_instance_cache);
526 return NILP (instance) ? Qunbound : instance;
528 else if (VECTORP (instantiator))
530 switch (XVECTOR_LENGTH (instantiator))
533 if (DEVICE_TTY_P (d))
534 return Vthe_null_color_instance;
536 signal_simple_error ("Color instantiator [] only valid on TTY's",
540 if (NILP (COLOR_SPECIFIER_FACE (XCOLOR_SPECIFIER (specifier))))
541 signal_simple_error ("Color specifier not attached to a face",
543 return (FACE_PROPERTY_INSTANCE_1
544 (Fget_face (XVECTOR_DATA (instantiator)[0]),
545 COLOR_SPECIFIER_FACE_PROPERTY (XCOLOR_SPECIFIER (specifier)),
546 domain, ERROR_ME, 0, depth));
549 return (FACE_PROPERTY_INSTANCE_1
550 (Fget_face (XVECTOR_DATA (instantiator)[0]),
551 XVECTOR_DATA (instantiator)[1], domain, ERROR_ME, 0, depth));
557 else if (NILP (instantiator))
559 if (DEVICE_TTY_P (d))
560 return Vthe_null_color_instance;
562 signal_simple_error ("Color instantiator [] only valid on TTY's",
566 abort (); /* The spec validation routines are screwed up. */
572 color_validate (Lisp_Object instantiator)
574 if (COLOR_INSTANCEP (instantiator) || STRINGP (instantiator))
576 if (VECTORP (instantiator))
578 if (XVECTOR_LENGTH (instantiator) > 2)
579 signal_simple_error ("Inheritance vector must be of size 0 - 2",
581 else if (XVECTOR_LENGTH (instantiator) > 0)
583 Lisp_Object face = XVECTOR_DATA (instantiator)[0];
586 if (XVECTOR_LENGTH (instantiator) == 2)
588 Lisp_Object field = XVECTOR_DATA (instantiator)[1];
589 if (!EQ (field, Qforeground) && !EQ (field, Qbackground))
591 ("Inheritance field must be `foreground' or `background'",
597 signal_simple_error ("Invalid color instantiator", instantiator);
601 color_after_change (Lisp_Object specifier, Lisp_Object locale)
603 Lisp_Object face = COLOR_SPECIFIER_FACE (XCOLOR_SPECIFIER (specifier));
604 Lisp_Object property =
605 COLOR_SPECIFIER_FACE_PROPERTY (XCOLOR_SPECIFIER (specifier));
607 face_property_was_changed (face, property, locale);
611 set_color_attached_to (Lisp_Object obj, Lisp_Object face, Lisp_Object property)
613 struct Lisp_Specifier *color = XCOLOR_SPECIFIER (obj);
615 COLOR_SPECIFIER_FACE (color) = face;
616 COLOR_SPECIFIER_FACE_PROPERTY (color) = property;
619 DEFUN ("color-specifier-p", Fcolor_specifier_p, 1, 1, 0, /*
620 Return t if OBJECT is a color specifier.
622 Valid instantiators for color specifiers are:
624 -- a string naming a color (e.g. under X this might be "lightseagreen2"
626 -- a color instance (use that instance directly if the device matches,
627 or use the string that generated it)
628 -- a vector of no elements (only on TTY's; this means to set no color
629 at all, thus using the "natural" color of the terminal's text)
630 -- a vector of one or two elements: a face to inherit from, and
631 optionally a symbol naming which property of that face to inherit,
632 either `foreground' or `background' (if omitted, defaults to the same
633 property that this color specifier is used for; if this specifier is
634 not part of a face, the instantiator would not be valid)
638 return COLOR_SPECIFIERP (object) ? Qt : Qnil;
642 /****************************************************************************
644 ***************************************************************************/
645 DEFINE_SPECIFIER_TYPE (font);
646 /* Qfont defined in general.c */
649 font_create (Lisp_Object obj)
651 struct Lisp_Specifier *font = XFONT_SPECIFIER (obj);
653 FONT_SPECIFIER_FACE (font) = Qnil;
654 FONT_SPECIFIER_FACE_PROPERTY (font) = Qnil;
658 font_mark (Lisp_Object obj, void (*markobj) (Lisp_Object))
660 struct Lisp_Specifier *font = XFONT_SPECIFIER (obj);
662 markobj (FONT_SPECIFIER_FACE (font));
663 markobj (FONT_SPECIFIER_FACE_PROPERTY (font));
666 /* No equal or hash methods; ignore the face the font is based off
672 font_spec_matches_charset (struct device *d, Lisp_Object charset,
673 CONST Bufbyte *nonreloc, Lisp_Object reloc,
674 Bytecount offset, Bytecount length)
676 return DEVMETH_OR_GIVEN (d, font_spec_matches_charset,
677 (d, charset, nonreloc, reloc, offset, length),
682 font_validate_matchspec (Lisp_Object matchspec)
684 Fget_charset (matchspec);
691 font_instantiate (Lisp_Object specifier, Lisp_Object matchspec,
692 Lisp_Object domain, Lisp_Object instantiator,
695 /* When called, we're inside of call_with_suspended_errors(),
696 so we can freely error. */
697 Lisp_Object device = DFW_DEVICE (domain);
698 struct device *d = XDEVICE (device);
699 Lisp_Object instance;
702 if (!UNBOUNDP (matchspec))
703 matchspec = Fget_charset (matchspec);
706 if (FONT_INSTANCEP (instantiator))
709 || EQ (device, XFONT_INSTANCE (instantiator)->device))
712 if (font_spec_matches_charset (d, matchspec, 0,
713 Ffont_instance_truename
721 instantiator = Ffont_instance_name (instantiator);
724 if (STRINGP (instantiator))
727 if (!UNBOUNDP (matchspec))
729 /* The instantiator is a font spec that could match many
730 different fonts. We need to find one of those fonts
731 whose registry matches the registry of the charset in
732 MATCHSPEC. This is potentially a very slow operation,
733 as it involves doing an XListFonts() or equivalent to
734 iterate over all possible fonts, and a regexp match
735 on each one. So we cache the results. */
736 Lisp_Object matching_font = Qunbound;
737 Lisp_Object hash_table = Fgethash (matchspec, d->charset_font_cache,
739 if (UNBOUNDP (hash_table))
741 /* need to make a sub hash table. */
742 hash_table = make_lisp_hash_table (20, HASH_TABLE_KEY_WEAK,
744 Fputhash (matchspec, hash_table, d->charset_font_cache);
747 matching_font = Fgethash (instantiator, hash_table, Qunbound);
749 if (UNBOUNDP (matching_font))
751 /* make sure we cache the failures, too. */
753 DEVMETH_OR_GIVEN (d, find_charset_font,
754 (device, instantiator, matchspec),
756 Fputhash (instantiator, matching_font, hash_table);
758 if (NILP (matching_font))
760 instantiator = matching_font;
764 /* First, look to see if we can retrieve a cached value. */
765 instance = Fgethash (instantiator, d->font_instance_cache, Qunbound);
766 /* Otherwise, make a new one. */
767 if (UNBOUNDP (instance))
769 /* make sure we cache the failures, too. */
770 instance = Fmake_font_instance (instantiator, device, Qt);
771 Fputhash (instantiator, instance, d->font_instance_cache);
774 return NILP (instance) ? Qunbound : instance;
776 else if (VECTORP (instantiator))
778 assert (XVECTOR_LENGTH (instantiator) == 1);
779 return (face_property_matching_instance
780 (Fget_face (XVECTOR_DATA (instantiator)[0]), Qfont,
781 matchspec, domain, ERROR_ME, 0, depth));
783 else if (NILP (instantiator))
792 font_validate (Lisp_Object instantiator)
794 if (FONT_INSTANCEP (instantiator) || STRINGP (instantiator))
796 if (VECTORP (instantiator))
798 if (XVECTOR_LENGTH (instantiator) != 1)
801 ("Vector length must be one for font inheritance", instantiator);
803 Fget_face (XVECTOR_DATA (instantiator)[0]);
806 signal_simple_error ("Must be string, vector, or font-instance",
811 font_after_change (Lisp_Object specifier, Lisp_Object locale)
813 Lisp_Object face = FONT_SPECIFIER_FACE (XFONT_SPECIFIER (specifier));
814 Lisp_Object property =
815 FONT_SPECIFIER_FACE_PROPERTY (XFONT_SPECIFIER (specifier));
817 face_property_was_changed (face, property, locale);
821 set_font_attached_to (Lisp_Object obj, Lisp_Object face, Lisp_Object property)
823 struct Lisp_Specifier *font = XFONT_SPECIFIER (obj);
825 FONT_SPECIFIER_FACE (font) = face;
826 FONT_SPECIFIER_FACE_PROPERTY (font) = property;
829 DEFUN ("font-specifier-p", Ffont_specifier_p, 1, 1, 0, /*
830 Return non-nil if OBJECT is a font specifier.
832 Valid instantiators for font specifiers are:
834 -- a string naming a font (e.g. under X this might be
835 "-*-courier-medium-r-*-*-*-140-*-*-*-*-iso8859-*" for a 14-point
836 upright medium-weight Courier font)
837 -- a font instance (use that instance directly if the device matches,
838 or use the string that generated it)
839 -- a vector of no elements (only on TTY's; this means to set no font
840 at all, thus using the "natural" font of the terminal's text)
841 -- a vector of one element (a face to inherit from)
845 return FONT_SPECIFIERP (object) ? Qt : Qnil;
849 /*****************************************************************************
851 ****************************************************************************/
852 DEFINE_SPECIFIER_TYPE (face_boolean);
853 Lisp_Object Qface_boolean;
856 face_boolean_create (Lisp_Object obj)
858 struct Lisp_Specifier *face_boolean = XFACE_BOOLEAN_SPECIFIER (obj);
860 FACE_BOOLEAN_SPECIFIER_FACE (face_boolean) = Qnil;
861 FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY (face_boolean) = Qnil;
865 face_boolean_mark (Lisp_Object obj, void (*markobj) (Lisp_Object))
867 struct Lisp_Specifier *face_boolean = XFACE_BOOLEAN_SPECIFIER (obj);
869 markobj (FACE_BOOLEAN_SPECIFIER_FACE (face_boolean));
870 markobj (FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY (face_boolean));
873 /* No equal or hash methods; ignore the face the face-boolean is based off
877 face_boolean_instantiate (Lisp_Object specifier, Lisp_Object matchspec,
878 Lisp_Object domain, Lisp_Object instantiator,
881 /* When called, we're inside of call_with_suspended_errors(),
882 so we can freely error. */
883 if (NILP (instantiator) || EQ (instantiator, Qt))
885 else if (VECTORP (instantiator))
889 int instantiator_len = XVECTOR_LENGTH (instantiator);
891 assert (instantiator_len >= 1 && instantiator_len <= 3);
892 if (instantiator_len > 1)
893 prop = XVECTOR_DATA (instantiator)[1];
896 if (NILP (FACE_BOOLEAN_SPECIFIER_FACE
897 (XFACE_BOOLEAN_SPECIFIER (specifier))))
899 ("Face-boolean specifier not attached to a face", instantiator);
900 prop = FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY
901 (XFACE_BOOLEAN_SPECIFIER (specifier));
904 retval = (FACE_PROPERTY_INSTANCE_1
905 (Fget_face (XVECTOR_DATA (instantiator)[0]),
906 prop, domain, ERROR_ME, 0, depth));
908 if (instantiator_len == 3 && !NILP (XVECTOR_DATA (instantiator)[2]))
909 retval = NILP (retval) ? Qt : Qnil;
920 face_boolean_validate (Lisp_Object instantiator)
922 if (NILP (instantiator) || EQ (instantiator, Qt))
924 else if (VECTORP (instantiator) &&
925 (XVECTOR_LENGTH (instantiator) >= 1 &&
926 XVECTOR_LENGTH (instantiator) <= 3))
928 Lisp_Object face = XVECTOR_DATA (instantiator)[0];
932 if (XVECTOR_LENGTH (instantiator) > 1)
934 Lisp_Object field = XVECTOR_DATA (instantiator)[1];
935 if (!EQ (field, Qunderline)
936 && !EQ (field, Qstrikethru)
937 && !EQ (field, Qhighlight)
939 && !EQ (field, Qblinking)
940 && !EQ (field, Qreverse))
941 signal_simple_error ("Invalid face-boolean inheritance field",
945 else if (VECTORP (instantiator))
946 signal_simple_error ("Wrong length for face-boolean inheritance spec",
949 signal_simple_error ("Face-boolean instantiator must be nil, t, or vector",
954 face_boolean_after_change (Lisp_Object specifier, Lisp_Object locale)
957 FACE_BOOLEAN_SPECIFIER_FACE (XFACE_BOOLEAN_SPECIFIER (specifier));
958 Lisp_Object property =
959 FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY (XFACE_BOOLEAN_SPECIFIER (specifier));
961 face_property_was_changed (face, property, locale);
965 set_face_boolean_attached_to (Lisp_Object obj, Lisp_Object face,
966 Lisp_Object property)
968 struct Lisp_Specifier *face_boolean = XFACE_BOOLEAN_SPECIFIER (obj);
970 FACE_BOOLEAN_SPECIFIER_FACE (face_boolean) = face;
971 FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY (face_boolean) = property;
974 DEFUN ("face-boolean-specifier-p", Fface_boolean_specifier_p, 1, 1, 0, /*
975 Return non-nil if OBJECT is a face-boolean specifier.
977 Valid instantiators for face-boolean specifiers are
980 -- a vector of two or three elements: a face to inherit from,
981 optionally a symbol naming the property of that face to inherit from
982 (if omitted, defaults to the same property that this face-boolean
983 specifier is used for; if this specifier is not part of a face,
984 the instantiator would not be valid), and optionally a value which,
985 if non-nil, means to invert the sense of the inherited property.
989 return FACE_BOOLEAN_SPECIFIERP (object) ? Qt : Qnil;
993 /************************************************************************/
995 /************************************************************************/
998 syms_of_objects (void)
1000 DEFSUBR (Fcolor_specifier_p);
1001 DEFSUBR (Ffont_specifier_p);
1002 DEFSUBR (Fface_boolean_specifier_p);
1004 defsymbol (&Qcolor_instancep, "color-instance-p");
1005 DEFSUBR (Fmake_color_instance);
1006 DEFSUBR (Fcolor_instance_p);
1007 DEFSUBR (Fcolor_instance_name);
1008 DEFSUBR (Fcolor_instance_rgb_components);
1009 DEFSUBR (Fvalid_color_name_p);
1011 defsymbol (&Qfont_instancep, "font-instance-p");
1012 DEFSUBR (Fmake_font_instance);
1013 DEFSUBR (Ffont_instance_p);
1014 DEFSUBR (Ffont_instance_name);
1015 DEFSUBR (Ffont_instance_ascent);
1016 DEFSUBR (Ffont_instance_descent);
1017 DEFSUBR (Ffont_instance_width);
1018 DEFSUBR (Ffont_instance_proportional_p);
1019 DEFSUBR (Ffont_instance_truename);
1020 DEFSUBR (Ffont_instance_properties);
1021 DEFSUBR (Flist_fonts);
1023 /* Qcolor, Qfont defined in general.c */
1024 defsymbol (&Qface_boolean, "face-boolean");
1028 specifier_type_create_objects (void)
1030 INITIALIZE_SPECIFIER_TYPE_WITH_DATA (color, "color", "color-specifier-p");
1031 INITIALIZE_SPECIFIER_TYPE_WITH_DATA (font, "font", "font-specifier-p");
1032 INITIALIZE_SPECIFIER_TYPE_WITH_DATA (face_boolean, "face-boolean",
1033 "face-boolean-specifier-p");
1035 SPECIFIER_HAS_METHOD (color, instantiate);
1036 SPECIFIER_HAS_METHOD (font, instantiate);
1037 SPECIFIER_HAS_METHOD (face_boolean, instantiate);
1039 SPECIFIER_HAS_METHOD (color, validate);
1040 SPECIFIER_HAS_METHOD (font, validate);
1041 SPECIFIER_HAS_METHOD (face_boolean, validate);
1043 SPECIFIER_HAS_METHOD (color, create);
1044 SPECIFIER_HAS_METHOD (font, create);
1045 SPECIFIER_HAS_METHOD (face_boolean, create);
1047 SPECIFIER_HAS_METHOD (color, mark);
1048 SPECIFIER_HAS_METHOD (font, mark);
1049 SPECIFIER_HAS_METHOD (face_boolean, mark);
1051 SPECIFIER_HAS_METHOD (color, after_change);
1052 SPECIFIER_HAS_METHOD (font, after_change);
1053 SPECIFIER_HAS_METHOD (face_boolean, after_change);
1056 SPECIFIER_HAS_METHOD (font, validate_matchspec);
1061 vars_of_objects (void)
1063 staticpro (&Vthe_null_color_instance);
1065 struct Lisp_Color_Instance *c =
1066 alloc_lcrecord_type (struct Lisp_Color_Instance, lrecord_color_instance);
1071 XSETCOLOR_INSTANCE (Vthe_null_color_instance, c);
1074 staticpro (&Vthe_null_font_instance);
1076 struct Lisp_Font_Instance *f =
1077 alloc_lcrecord_type (struct Lisp_Font_Instance, lrecord_font_instance);
1082 f->ascent = f->height = 0;
1085 f->proportional_p = 0;
1087 XSETFONT_INSTANCE (Vthe_null_font_instance, f);