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,
130 color_instance_hash, 0,
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 if (!NILP (f->device))
263 MAYBE_DEVMETH (XDEVICE (f->device), print_font_instance,
264 (f, printcharfun, escapeflag));
265 sprintf (buf, " 0x%x>", f->header.uid);
266 write_c_string (buf, printcharfun);
270 finalize_font_instance (void *header, int for_disksave)
272 struct Lisp_Font_Instance *f = (struct Lisp_Font_Instance *) header;
274 if (!NILP (f->device))
276 if (for_disksave) finalose (f);
277 MAYBE_DEVMETH (XDEVICE (f->device), finalize_font_instance, (f));
281 /* Fonts are equal if they resolve to the same name.
282 Since we call `font-truename' to do this, and since font-truename is lazy,
283 this means the `equal' could cause XListFonts to be run the first time.
286 font_instance_equal (Lisp_Object obj1, Lisp_Object obj2, int depth)
288 /* #### should this be moved into a device method? */
289 return internal_equal (font_instance_truename_internal (obj1, ERROR_ME_NOT),
290 font_instance_truename_internal (obj2, ERROR_ME_NOT),
295 font_instance_hash (Lisp_Object obj, int depth)
297 return internal_hash (font_instance_truename_internal (obj, ERROR_ME_NOT),
301 DEFINE_LRECORD_IMPLEMENTATION ("font-instance", font_instance,
302 mark_font_instance, print_font_instance,
303 finalize_font_instance, font_instance_equal,
304 font_instance_hash, 0, struct Lisp_Font_Instance);
306 DEFUN ("make-font-instance", Fmake_font_instance, 1, 3, 0, /*
307 Return a new `font-instance' object named NAME.
308 DEVICE specifies the device this object applies to and defaults to the
309 selected device. An error is signalled if the font is unknown or cannot
310 be allocated; however, if NOERROR is non-nil, nil is simply returned in
313 The returned object is a normal, first-class lisp object. The way you
314 `deallocate' the font is the way you deallocate any other lisp object:
315 you drop all pointers to it and allow it to be garbage collected. When
316 these objects are GCed, the underlying X data is deallocated as well.
318 (name, device, no_error))
320 struct Lisp_Font_Instance *f;
323 Error_behavior errb = decode_error_behavior_flag (no_error);
325 if (ERRB_EQ (errb, ERROR_ME))
327 else if (!STRINGP (name))
330 XSETDEVICE (device, decode_device (device));
332 f = alloc_lcrecord_type (struct Lisp_Font_Instance, &lrecord_font_instance);
338 /* Stick some default values here ... */
339 f->ascent = f->height = 1;
342 f->proportional_p = 0;
344 retval = MAYBE_INT_DEVMETH (XDEVICE (device), initialize_font_instance,
345 (f, name, device, errb));
350 XSETFONT_INSTANCE (val, f);
354 DEFUN ("font-instance-p", Ffont_instance_p, 1, 1, 0, /*
355 Return non-nil if OBJECT is a font instance.
359 return FONT_INSTANCEP (object) ? Qt : Qnil;
362 DEFUN ("font-instance-name", Ffont_instance_name, 1, 1, 0, /*
363 Return the name used to allocate FONT-INSTANCE.
367 CHECK_FONT_INSTANCE (font_instance);
368 return XFONT_INSTANCE (font_instance)->name;
371 DEFUN ("font-instance-ascent", Ffont_instance_ascent, 1, 1, 0, /*
372 Return the ascent in pixels of FONT-INSTANCE.
373 The returned value is the maximum ascent for all characters in the font,
374 where a character's ascent is the number of pixels above (and including)
379 CHECK_FONT_INSTANCE (font_instance);
380 return make_int (XFONT_INSTANCE (font_instance)->ascent);
383 DEFUN ("font-instance-descent", Ffont_instance_descent, 1, 1, 0, /*
384 Return the descent in pixels of FONT-INSTANCE.
385 The returned value is the maximum descent for all characters in the font,
386 where a character's descent is the number of pixels below the baseline.
387 \(Many characters to do not have any descent. Typical characters with a
388 descent are lowercase p and lowercase g.)
392 CHECK_FONT_INSTANCE (font_instance);
393 return make_int (XFONT_INSTANCE (font_instance)->descent);
396 DEFUN ("font-instance-width", Ffont_instance_width, 1, 1, 0, /*
397 Return the width in pixels of FONT-INSTANCE.
398 The returned value is the average width for all characters in the font.
402 CHECK_FONT_INSTANCE (font_instance);
403 return make_int (XFONT_INSTANCE (font_instance)->width);
406 DEFUN ("font-instance-proportional-p", Ffont_instance_proportional_p, 1, 1, 0, /*
407 Return whether FONT-INSTANCE is proportional.
408 This means that different characters in the font have different widths.
412 CHECK_FONT_INSTANCE (font_instance);
413 return XFONT_INSTANCE (font_instance)->proportional_p ? Qt : Qnil;
417 font_instance_truename_internal (Lisp_Object font_instance,
420 struct Lisp_Font_Instance *f = XFONT_INSTANCE (font_instance);
422 if (NILP (f->device))
424 maybe_signal_simple_error ("Couldn't determine font truename",
425 font_instance, Qfont, errb);
429 return DEVMETH_OR_GIVEN (XDEVICE (f->device),
430 font_instance_truename, (f, errb), f->name);
433 DEFUN ("font-instance-truename", Ffont_instance_truename, 1, 1, 0, /*
434 Return the canonical name of FONT-INSTANCE.
435 Font names are patterns which may match any number of fonts, of which
436 the first found is used. This returns an unambiguous name for that font
437 \(but not necessarily its only unambiguous name).
441 CHECK_FONT_INSTANCE (font_instance);
442 return font_instance_truename_internal (font_instance, ERROR_ME);
445 DEFUN ("font-instance-properties", Ffont_instance_properties, 1, 1, 0, /*
446 Return the properties (an alist or nil) of FONT-INSTANCE.
450 struct Lisp_Font_Instance *f;
452 CHECK_FONT_INSTANCE (font_instance);
453 f = XFONT_INSTANCE (font_instance);
455 if (NILP (f->device))
458 return MAYBE_LISP_DEVMETH (XDEVICE (f->device),
459 font_instance_properties, (f));
462 DEFUN ("list-fonts", Flist_fonts, 1, 2, 0, /*
463 Return a list of font names matching the given pattern.
464 DEVICE specifies which device to search for names, and defaults to the
465 currently selected device.
469 CHECK_STRING (pattern);
470 XSETDEVICE (device, decode_device (device));
472 return MAYBE_LISP_DEVMETH (XDEVICE (device), list_fonts, (pattern, device));
476 /****************************************************************************
478 ***************************************************************************/
479 DEFINE_SPECIFIER_TYPE (color);
480 /* Qcolor defined in general.c */
483 color_create (Lisp_Object obj)
485 struct Lisp_Specifier *color = XCOLOR_SPECIFIER (obj);
487 COLOR_SPECIFIER_FACE (color) = Qnil;
488 COLOR_SPECIFIER_FACE_PROPERTY (color) = Qnil;
492 color_mark (Lisp_Object obj, void (*markobj) (Lisp_Object))
494 struct Lisp_Specifier *color = XCOLOR_SPECIFIER (obj);
496 markobj (COLOR_SPECIFIER_FACE (color));
497 markobj (COLOR_SPECIFIER_FACE_PROPERTY (color));
500 /* No equal or hash methods; ignore the face the color is based off
504 color_instantiate (Lisp_Object specifier, Lisp_Object matchspec,
505 Lisp_Object domain, Lisp_Object instantiator,
508 /* When called, we're inside of call_with_suspended_errors(),
509 so we can freely error. */
510 Lisp_Object device = DFW_DEVICE (domain);
511 struct device *d = XDEVICE (device);
513 if (COLOR_INSTANCEP (instantiator))
515 /* If we are on the same device then we're done. Otherwise change
516 the instantiator to the name used to generate the pixel and let the
517 STRINGP case deal with it. */
518 if (NILP (device) /* Vthe_null_color_instance */
519 || EQ (device, XCOLOR_INSTANCE (instantiator)->device))
522 instantiator = Fcolor_instance_name (instantiator);
525 if (STRINGP (instantiator))
527 /* First, look to see if we can retrieve a cached value. */
528 Lisp_Object instance =
529 Fgethash (instantiator, d->color_instance_cache, Qunbound);
530 /* Otherwise, make a new one. */
531 if (UNBOUNDP (instance))
533 /* make sure we cache the failures, too. */
534 instance = Fmake_color_instance (instantiator, device, Qt);
535 Fputhash (instantiator, instance, d->color_instance_cache);
538 return NILP (instance) ? Qunbound : instance;
540 else if (VECTORP (instantiator))
542 switch (XVECTOR_LENGTH (instantiator))
545 if (DEVICE_TTY_P (d))
546 return Vthe_null_color_instance;
548 signal_simple_error ("Color instantiator [] only valid on TTY's",
552 if (NILP (COLOR_SPECIFIER_FACE (XCOLOR_SPECIFIER (specifier))))
553 signal_simple_error ("Color specifier not attached to a face",
555 return (FACE_PROPERTY_INSTANCE_1
556 (Fget_face (XVECTOR_DATA (instantiator)[0]),
557 COLOR_SPECIFIER_FACE_PROPERTY (XCOLOR_SPECIFIER (specifier)),
558 domain, ERROR_ME, 0, depth));
561 return (FACE_PROPERTY_INSTANCE_1
562 (Fget_face (XVECTOR_DATA (instantiator)[0]),
563 XVECTOR_DATA (instantiator)[1], domain, ERROR_ME, 0, depth));
569 else if (NILP (instantiator))
571 if (DEVICE_TTY_P (d))
572 return Vthe_null_color_instance;
574 signal_simple_error ("Color instantiator [] only valid on TTY's",
578 abort (); /* The spec validation routines are screwed up. */
584 color_validate (Lisp_Object instantiator)
586 if (COLOR_INSTANCEP (instantiator) || STRINGP (instantiator))
588 if (VECTORP (instantiator))
590 if (XVECTOR_LENGTH (instantiator) > 2)
591 signal_simple_error ("Inheritance vector must be of size 0 - 2",
593 else if (XVECTOR_LENGTH (instantiator) > 0)
595 Lisp_Object face = XVECTOR_DATA (instantiator)[0];
598 if (XVECTOR_LENGTH (instantiator) == 2)
600 Lisp_Object field = XVECTOR_DATA (instantiator)[1];
601 if (!EQ (field, Qforeground) && !EQ (field, Qbackground))
603 ("Inheritance field must be `foreground' or `background'",
609 signal_simple_error ("Invalid color instantiator", instantiator);
613 color_after_change (Lisp_Object specifier, Lisp_Object locale)
615 Lisp_Object face = COLOR_SPECIFIER_FACE (XCOLOR_SPECIFIER (specifier));
616 Lisp_Object property =
617 COLOR_SPECIFIER_FACE_PROPERTY (XCOLOR_SPECIFIER (specifier));
619 face_property_was_changed (face, property, locale);
623 set_color_attached_to (Lisp_Object obj, Lisp_Object face, Lisp_Object property)
625 struct Lisp_Specifier *color = XCOLOR_SPECIFIER (obj);
627 COLOR_SPECIFIER_FACE (color) = face;
628 COLOR_SPECIFIER_FACE_PROPERTY (color) = property;
631 DEFUN ("color-specifier-p", Fcolor_specifier_p, 1, 1, 0, /*
632 Return t if OBJECT is a color specifier.
634 Valid instantiators for color specifiers are:
636 -- a string naming a color (e.g. under X this might be "lightseagreen2"
638 -- a color instance (use that instance directly if the device matches,
639 or use the string that generated it)
640 -- a vector of no elements (only on TTY's; this means to set no color
641 at all, thus using the "natural" color of the terminal's text)
642 -- a vector of one or two elements: a face to inherit from, and
643 optionally a symbol naming which property of that face to inherit,
644 either `foreground' or `background' (if omitted, defaults to the same
645 property that this color specifier is used for; if this specifier is
646 not part of a face, the instantiator would not be valid)
650 return COLOR_SPECIFIERP (object) ? Qt : Qnil;
654 /****************************************************************************
656 ***************************************************************************/
657 DEFINE_SPECIFIER_TYPE (font);
658 /* Qfont defined in general.c */
661 font_create (Lisp_Object obj)
663 struct Lisp_Specifier *font = XFONT_SPECIFIER (obj);
665 FONT_SPECIFIER_FACE (font) = Qnil;
666 FONT_SPECIFIER_FACE_PROPERTY (font) = Qnil;
670 font_mark (Lisp_Object obj, void (*markobj) (Lisp_Object))
672 struct Lisp_Specifier *font = XFONT_SPECIFIER (obj);
674 markobj (FONT_SPECIFIER_FACE (font));
675 markobj (FONT_SPECIFIER_FACE_PROPERTY (font));
678 /* No equal or hash methods; ignore the face the font is based off
684 font_spec_matches_charset (struct device *d, Lisp_Object charset,
685 CONST Bufbyte *nonreloc, Lisp_Object reloc,
686 Bytecount offset, Bytecount length)
688 return DEVMETH_OR_GIVEN (d, font_spec_matches_charset,
689 (d, charset, nonreloc, reloc, offset, length),
694 font_validate_matchspec (Lisp_Object matchspec)
696 Fget_charset (matchspec);
703 font_instantiate (Lisp_Object specifier, Lisp_Object matchspec,
704 Lisp_Object domain, Lisp_Object instantiator,
707 /* When called, we're inside of call_with_suspended_errors(),
708 so we can freely error. */
709 Lisp_Object device = DFW_DEVICE (domain);
710 struct device *d = XDEVICE (device);
711 Lisp_Object instance;
714 if (!UNBOUNDP (matchspec))
715 matchspec = Fget_charset (matchspec);
718 if (FONT_INSTANCEP (instantiator))
721 || EQ (device, XFONT_INSTANCE (instantiator)->device))
724 if (font_spec_matches_charset (d, matchspec, 0,
725 Ffont_instance_truename
733 instantiator = Ffont_instance_name (instantiator);
736 if (STRINGP (instantiator))
739 if (!UNBOUNDP (matchspec))
741 /* The instantiator is a font spec that could match many
742 different fonts. We need to find one of those fonts
743 whose registry matches the registry of the charset in
744 MATCHSPEC. This is potentially a very slow operation,
745 as it involves doing an XListFonts() or equivalent to
746 iterate over all possible fonts, and a regexp match
747 on each one. So we cache the results. */
748 Lisp_Object matching_font = Qunbound;
749 Lisp_Object hash_table = Fgethash (matchspec, d->charset_font_cache,
751 if (UNBOUNDP (hash_table))
753 /* need to make a sub hash table. */
754 hash_table = make_lisp_hash_table (20, HASH_TABLE_KEY_WEAK,
756 Fputhash (matchspec, hash_table, d->charset_font_cache);
759 matching_font = Fgethash (instantiator, hash_table, Qunbound);
761 if (UNBOUNDP (matching_font))
763 /* make sure we cache the failures, too. */
765 DEVMETH_OR_GIVEN (d, find_charset_font,
766 (device, instantiator, matchspec),
768 Fputhash (instantiator, matching_font, hash_table);
770 if (NILP (matching_font))
772 instantiator = matching_font;
776 /* First, look to see if we can retrieve a cached value. */
777 instance = Fgethash (instantiator, d->font_instance_cache, Qunbound);
778 /* Otherwise, make a new one. */
779 if (UNBOUNDP (instance))
781 /* make sure we cache the failures, too. */
782 instance = Fmake_font_instance (instantiator, device, Qt);
783 Fputhash (instantiator, instance, d->font_instance_cache);
786 return NILP (instance) ? Qunbound : instance;
788 else if (VECTORP (instantiator))
790 assert (XVECTOR_LENGTH (instantiator) == 1);
791 return (face_property_matching_instance
792 (Fget_face (XVECTOR_DATA (instantiator)[0]), Qfont,
793 matchspec, domain, ERROR_ME, 0, depth));
795 else if (NILP (instantiator))
804 font_validate (Lisp_Object instantiator)
806 if (FONT_INSTANCEP (instantiator) || STRINGP (instantiator))
808 if (VECTORP (instantiator))
810 if (XVECTOR_LENGTH (instantiator) != 1)
813 ("Vector length must be one for font inheritance", instantiator);
815 Fget_face (XVECTOR_DATA (instantiator)[0]);
818 signal_simple_error ("Must be string, vector, or font-instance",
823 font_after_change (Lisp_Object specifier, Lisp_Object locale)
825 Lisp_Object face = FONT_SPECIFIER_FACE (XFONT_SPECIFIER (specifier));
826 Lisp_Object property =
827 FONT_SPECIFIER_FACE_PROPERTY (XFONT_SPECIFIER (specifier));
829 face_property_was_changed (face, property, locale);
833 set_font_attached_to (Lisp_Object obj, Lisp_Object face, Lisp_Object property)
835 struct Lisp_Specifier *font = XFONT_SPECIFIER (obj);
837 FONT_SPECIFIER_FACE (font) = face;
838 FONT_SPECIFIER_FACE_PROPERTY (font) = property;
841 DEFUN ("font-specifier-p", Ffont_specifier_p, 1, 1, 0, /*
842 Return non-nil if OBJECT is a font specifier.
844 Valid instantiators for font specifiers are:
846 -- a string naming a font (e.g. under X this might be
847 "-*-courier-medium-r-*-*-*-140-*-*-*-*-iso8859-*" for a 14-point
848 upright medium-weight Courier font)
849 -- a font instance (use that instance directly if the device matches,
850 or use the string that generated it)
851 -- a vector of no elements (only on TTY's; this means to set no font
852 at all, thus using the "natural" font of the terminal's text)
853 -- a vector of one element (a face to inherit from)
857 return FONT_SPECIFIERP (object) ? Qt : Qnil;
861 /*****************************************************************************
863 ****************************************************************************/
864 DEFINE_SPECIFIER_TYPE (face_boolean);
865 Lisp_Object Qface_boolean;
868 face_boolean_create (Lisp_Object obj)
870 struct Lisp_Specifier *face_boolean = XFACE_BOOLEAN_SPECIFIER (obj);
872 FACE_BOOLEAN_SPECIFIER_FACE (face_boolean) = Qnil;
873 FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY (face_boolean) = Qnil;
877 face_boolean_mark (Lisp_Object obj, void (*markobj) (Lisp_Object))
879 struct Lisp_Specifier *face_boolean = XFACE_BOOLEAN_SPECIFIER (obj);
881 markobj (FACE_BOOLEAN_SPECIFIER_FACE (face_boolean));
882 markobj (FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY (face_boolean));
885 /* No equal or hash methods; ignore the face the face-boolean is based off
889 face_boolean_instantiate (Lisp_Object specifier, Lisp_Object matchspec,
890 Lisp_Object domain, Lisp_Object instantiator,
893 /* When called, we're inside of call_with_suspended_errors(),
894 so we can freely error. */
895 if (NILP (instantiator) || EQ (instantiator, Qt))
897 else if (VECTORP (instantiator))
901 int instantiator_len = XVECTOR_LENGTH (instantiator);
903 assert (instantiator_len >= 1 && instantiator_len <= 3);
904 if (instantiator_len > 1)
905 prop = XVECTOR_DATA (instantiator)[1];
908 if (NILP (FACE_BOOLEAN_SPECIFIER_FACE
909 (XFACE_BOOLEAN_SPECIFIER (specifier))))
911 ("Face-boolean specifier not attached to a face", instantiator);
912 prop = FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY
913 (XFACE_BOOLEAN_SPECIFIER (specifier));
916 retval = (FACE_PROPERTY_INSTANCE_1
917 (Fget_face (XVECTOR_DATA (instantiator)[0]),
918 prop, domain, ERROR_ME, 0, depth));
920 if (instantiator_len == 3 && !NILP (XVECTOR_DATA (instantiator)[2]))
921 retval = NILP (retval) ? Qt : Qnil;
932 face_boolean_validate (Lisp_Object instantiator)
934 if (NILP (instantiator) || EQ (instantiator, Qt))
936 else if (VECTORP (instantiator) &&
937 (XVECTOR_LENGTH (instantiator) >= 1 &&
938 XVECTOR_LENGTH (instantiator) <= 3))
940 Lisp_Object face = XVECTOR_DATA (instantiator)[0];
944 if (XVECTOR_LENGTH (instantiator) > 1)
946 Lisp_Object field = XVECTOR_DATA (instantiator)[1];
947 if (!EQ (field, Qunderline)
948 && !EQ (field, Qstrikethru)
949 && !EQ (field, Qhighlight)
951 && !EQ (field, Qblinking)
952 && !EQ (field, Qreverse))
953 signal_simple_error ("Invalid face-boolean inheritance field",
957 else if (VECTORP (instantiator))
958 signal_simple_error ("Wrong length for face-boolean inheritance spec",
961 signal_simple_error ("Face-boolean instantiator must be nil, t, or vector",
966 face_boolean_after_change (Lisp_Object specifier, Lisp_Object locale)
969 FACE_BOOLEAN_SPECIFIER_FACE (XFACE_BOOLEAN_SPECIFIER (specifier));
970 Lisp_Object property =
971 FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY (XFACE_BOOLEAN_SPECIFIER (specifier));
973 face_property_was_changed (face, property, locale);
977 set_face_boolean_attached_to (Lisp_Object obj, Lisp_Object face,
978 Lisp_Object property)
980 struct Lisp_Specifier *face_boolean = XFACE_BOOLEAN_SPECIFIER (obj);
982 FACE_BOOLEAN_SPECIFIER_FACE (face_boolean) = face;
983 FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY (face_boolean) = property;
986 DEFUN ("face-boolean-specifier-p", Fface_boolean_specifier_p, 1, 1, 0, /*
987 Return non-nil if OBJECT is a face-boolean specifier.
989 Valid instantiators for face-boolean specifiers are
992 -- a vector of two or three elements: a face to inherit from,
993 optionally a symbol naming the property of that face to inherit from
994 (if omitted, defaults to the same property that this face-boolean
995 specifier is used for; if this specifier is not part of a face,
996 the instantiator would not be valid), and optionally a value which,
997 if non-nil, means to invert the sense of the inherited property.
1001 return FACE_BOOLEAN_SPECIFIERP (object) ? Qt : Qnil;
1005 /************************************************************************/
1006 /* initialization */
1007 /************************************************************************/
1010 syms_of_objects (void)
1012 DEFSUBR (Fcolor_specifier_p);
1013 DEFSUBR (Ffont_specifier_p);
1014 DEFSUBR (Fface_boolean_specifier_p);
1016 defsymbol (&Qcolor_instancep, "color-instance-p");
1017 DEFSUBR (Fmake_color_instance);
1018 DEFSUBR (Fcolor_instance_p);
1019 DEFSUBR (Fcolor_instance_name);
1020 DEFSUBR (Fcolor_instance_rgb_components);
1021 DEFSUBR (Fvalid_color_name_p);
1023 defsymbol (&Qfont_instancep, "font-instance-p");
1024 DEFSUBR (Fmake_font_instance);
1025 DEFSUBR (Ffont_instance_p);
1026 DEFSUBR (Ffont_instance_name);
1027 DEFSUBR (Ffont_instance_ascent);
1028 DEFSUBR (Ffont_instance_descent);
1029 DEFSUBR (Ffont_instance_width);
1030 DEFSUBR (Ffont_instance_proportional_p);
1031 DEFSUBR (Ffont_instance_truename);
1032 DEFSUBR (Ffont_instance_properties);
1033 DEFSUBR (Flist_fonts);
1035 /* Qcolor, Qfont defined in general.c */
1036 defsymbol (&Qface_boolean, "face-boolean");
1040 specifier_type_create_objects (void)
1042 INITIALIZE_SPECIFIER_TYPE_WITH_DATA (color, "color", "color-specifier-p");
1043 INITIALIZE_SPECIFIER_TYPE_WITH_DATA (font, "font", "font-specifier-p");
1044 INITIALIZE_SPECIFIER_TYPE_WITH_DATA (face_boolean, "face-boolean",
1045 "face-boolean-specifier-p");
1047 SPECIFIER_HAS_METHOD (color, instantiate);
1048 SPECIFIER_HAS_METHOD (font, instantiate);
1049 SPECIFIER_HAS_METHOD (face_boolean, instantiate);
1051 SPECIFIER_HAS_METHOD (color, validate);
1052 SPECIFIER_HAS_METHOD (font, validate);
1053 SPECIFIER_HAS_METHOD (face_boolean, validate);
1055 SPECIFIER_HAS_METHOD (color, create);
1056 SPECIFIER_HAS_METHOD (font, create);
1057 SPECIFIER_HAS_METHOD (face_boolean, create);
1059 SPECIFIER_HAS_METHOD (color, mark);
1060 SPECIFIER_HAS_METHOD (font, mark);
1061 SPECIFIER_HAS_METHOD (face_boolean, mark);
1063 SPECIFIER_HAS_METHOD (color, after_change);
1064 SPECIFIER_HAS_METHOD (font, after_change);
1065 SPECIFIER_HAS_METHOD (face_boolean, after_change);
1068 SPECIFIER_HAS_METHOD (font, validate_matchspec);
1073 vars_of_objects (void)
1075 staticpro (&Vthe_null_color_instance);
1077 struct Lisp_Color_Instance *c =
1078 alloc_lcrecord_type (struct Lisp_Color_Instance, &lrecord_color_instance);
1083 XSETCOLOR_INSTANCE (Vthe_null_color_instance, c);
1086 staticpro (&Vthe_null_font_instance);
1088 struct Lisp_Font_Instance *f =
1089 alloc_lcrecord_type (struct Lisp_Font_Instance, &lrecord_font_instance);
1094 f->ascent = f->height = 0;
1097 f->proportional_p = 0;
1099 XSETFONT_INSTANCE (Vthe_null_font_instance, f);