Mercurial > hg > xemacs-beta
view src/objects.c @ 665:fdefd0186b75
[xemacs-hg @ 2001-09-20 06:28:42 by ben]
The great integral types renaming.
The purpose of this is to rationalize the names used for various
integral types, so that they match their intended uses and follow
consist conventions, and eliminate types that were not semantically
different from each other.
The conventions are:
-- All integral types that measure quantities of anything are
signed. Some people disagree vociferously with this, but their
arguments are mostly theoretical, and are vastly outweighed by
the practical headaches of mixing signed and unsigned values,
and more importantly by the far increased likelihood of
inadvertent bugs: Because of the broken "viral" nature of
unsigned quantities in C (operations involving mixed
signed/unsigned are done unsigned, when exactly the opposite is
nearly always wanted), even a single error in declaring a
quantity unsigned that should be signed, or even the even more
subtle error of comparing signed and unsigned values and
forgetting the necessary cast, can be catastrophic, as
comparisons will yield wrong results. -Wsign-compare is turned
on specifically to catch this, but this tends to result in a
great number of warnings when mixing signed and unsigned, and
the casts are annoying. More has been written on this
elsewhere.
-- All such quantity types just mentioned boil down to EMACS_INT,
which is 32 bits on 32-bit machines and 64 bits on 64-bit
machines. This is guaranteed to be the same size as Lisp
objects of type `int', and (as far as I can tell) of size_t
(unsigned!) and ssize_t. The only type below that is not an
EMACS_INT is Hashcode, which is an unsigned value of the same
size as EMACS_INT.
-- Type names should be relatively short (no more than 10
characters or so), with the first letter capitalized and no
underscores if they can at all be avoided.
-- "count" == a zero-based measurement of some quantity. Includes
sizes, offsets, and indexes.
-- "bpos" == a one-based measurement of a position in a buffer.
"Charbpos" and "Bytebpos" count text in the buffer, rather than
bytes in memory; thus Bytebpos does not directly correspond to
the memory representation. Use "Membpos" for this.
-- "Char" refers to internal-format characters, not to the C type
"char", which is really a byte.
-- For the actual name changes, see the script below.
I ran the following script to do the conversion. (NOTE: This script
is idempotent. You can safely run it multiple times and it will
not screw up previous results -- in fact, it will do nothing if
nothing has changed. Thus, it can be run repeatedly as necessary
to handle patches coming in from old workspaces, or old branches.)
There are two tags, just before and just after the change:
`pre-integral-type-rename' and `post-integral-type-rename'. When
merging code from the main trunk into a branch, the best thing to
do is first merge up to `pre-integral-type-rename', then apply the
script and associated changes, then merge from
`post-integral-type-change' to the present. (Alternatively, just do
the merging in one operation; but you may then have a lot of
conflicts needing to be resolved by hand.)
Script `fixtypes.sh' follows:
----------------------------------- cut ------------------------------------
files="*.[ch] s/*.h m/*.h config.h.in ../configure.in Makefile.in.in ../lib-src/*.[ch] ../lwlib/*.[ch]"
gr Memory_Count Bytecount $files
gr Lstream_Data_Count Bytecount $files
gr Element_Count Elemcount $files
gr Hash_Code Hashcode $files
gr extcount bytecount $files
gr bufpos charbpos $files
gr bytind bytebpos $files
gr memind membpos $files
gr bufbyte intbyte $files
gr Extcount Bytecount $files
gr Bufpos Charbpos $files
gr Bytind Bytebpos $files
gr Memind Membpos $files
gr Bufbyte Intbyte $files
gr EXTCOUNT BYTECOUNT $files
gr BUFPOS CHARBPOS $files
gr BYTIND BYTEBPOS $files
gr MEMIND MEMBPOS $files
gr BUFBYTE INTBYTE $files
gr MEMORY_COUNT BYTECOUNT $files
gr LSTREAM_DATA_COUNT BYTECOUNT $files
gr ELEMENT_COUNT ELEMCOUNT $files
gr HASH_CODE HASHCODE $files
----------------------------------- cut ------------------------------------
`fixtypes.sh' is a Bourne-shell script; it uses 'gr':
----------------------------------- cut ------------------------------------
#!/bin/sh
# Usage is like this:
# gr FROM TO FILES ...
# globally replace FROM with TO in FILES. FROM and TO are regular expressions.
# backup files are stored in the `backup' directory.
from="$1"
to="$2"
shift 2
echo ${1+"$@"} | xargs global-replace "s/$from/$to/g"
----------------------------------- cut ------------------------------------
`gr' in turn uses a Perl script to do its real work,
`global-replace', which follows:
----------------------------------- cut ------------------------------------
: #-*- Perl -*-
### global-modify --- modify the contents of a file by a Perl expression
## Copyright (C) 1999 Martin Buchholz.
## Copyright (C) 2001 Ben Wing.
## Authors: Martin Buchholz <martin@xemacs.org>, Ben Wing <ben@xemacs.org>
## Maintainer: Ben Wing <ben@xemacs.org>
## Current Version: 1.0, May 5, 2001
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2, or (at your option)
# any later version.
#
# This program 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
# along with XEmacs; see the file COPYING. If not, write to the Free
# Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
# 02111-1307, USA.
eval 'exec perl -w -S $0 ${1+"$@"}'
if 0;
use strict;
use FileHandle;
use Carp;
use Getopt::Long;
use File::Basename;
(my $myName = $0) =~ s@.*/@@; my $usage="
Usage: $myName [--help] [--backup-dir=DIR] [--line-mode] [--hunk-mode]
PERLEXPR FILE ...
Globally modify a file, either line by line or in one big hunk.
Typical usage is like this:
[with GNU print, GNU xargs: guaranteed to handle spaces, quotes, etc.
in file names]
find . -name '*.[ch]' -print0 | xargs -0 $0 's/\bCONST\b/const/g'\n
[with non-GNU print, xargs]
find . -name '*.[ch]' -print | xargs $0 's/\bCONST\b/const/g'\n
The file is read in, either line by line (with --line-mode specified)
or in one big hunk (with --hunk-mode specified; it's the default), and
the Perl expression is then evalled with \$_ set to the line or hunk of
text, including the terminating newline if there is one. It should
destructively modify the value there, storing the changed result in \$_.
Files in which any modifications are made are backed up to the directory
specified using --backup-dir, or to `backup' by default. To disable this,
use --backup-dir= with no argument.
Hunk mode is the default because it is MUCH MUCH faster than line-by-line.
Use line-by-line only when it matters, e.g. you want to do a replacement
only once per line (the default without the `g' argument). Conversely,
when using hunk mode, *ALWAYS* use `g'; otherwise, you will only make one
replacement in the entire file!
";
my %options = ();
$Getopt::Long::ignorecase = 0;
&GetOptions (
\%options,
'help', 'backup-dir=s', 'line-mode', 'hunk-mode',
);
die $usage if $options{"help"} or @ARGV <= 1;
my $code = shift;
die $usage if grep (-d || ! -w, @ARGV);
sub SafeOpen {
open ((my $fh = new FileHandle), $_[0]);
confess "Can't open $_[0]: $!" if ! defined $fh;
return $fh;
}
sub SafeClose {
close $_[0] or confess "Can't close $_[0]: $!";
}
sub FileContents {
my $fh = SafeOpen ("< $_[0]");
my $olddollarslash = $/;
local $/ = undef;
my $contents = <$fh>;
$/ = $olddollarslash;
return $contents;
}
sub WriteStringToFile {
my $fh = SafeOpen ("> $_[0]");
binmode $fh;
print $fh $_[1] or confess "$_[0]: $!\n";
SafeClose $fh;
}
foreach my $file (@ARGV) {
my $changed_p = 0;
my $new_contents = "";
if ($options{"line-mode"}) {
my $fh = SafeOpen $file;
while (<$fh>) {
my $save_line = $_;
eval $code;
$changed_p = 1 if $save_line ne $_;
$new_contents .= $_;
}
} else {
my $orig_contents = $_ = FileContents $file;
eval $code;
if ($_ ne $orig_contents) {
$changed_p = 1;
$new_contents = $_;
}
}
if ($changed_p) {
my $backdir = $options{"backup-dir"};
$backdir = "backup" if !defined ($backdir);
if ($backdir) {
my ($name, $path, $suffix) = fileparse ($file, "");
my $backfulldir = $path . $backdir;
my $backfile = "$backfulldir/$name";
mkdir $backfulldir, 0755 unless -d $backfulldir;
print "modifying $file (original saved in $backfile)\n";
rename $file, $backfile;
}
WriteStringToFile ($file, $new_contents);
}
}
----------------------------------- cut ------------------------------------
In addition to those programs, I needed to fix up a few other
things, particularly relating to the duplicate definitions of
types, now that some types merged with others. Specifically:
1. in lisp.h, removed duplicate declarations of Bytecount. The
changed code should now look like this: (In each code snippet
below, the first and last lines are the same as the original, as
are all lines outside of those lines. That allows you to locate
the section to be replaced, and replace the stuff in that
section, verifying that there isn't anything new added that
would need to be kept.)
--------------------------------- snip -------------------------------------
/* Counts of bytes or chars */
typedef EMACS_INT Bytecount;
typedef EMACS_INT Charcount;
/* Counts of elements */
typedef EMACS_INT Elemcount;
/* Hash codes */
typedef unsigned long Hashcode;
/* ------------------------ dynamic arrays ------------------- */
--------------------------------- snip -------------------------------------
2. in lstream.h, removed duplicate declaration of Bytecount.
Rewrote the comment about this type. The changed code should
now look like this:
--------------------------------- snip -------------------------------------
#endif
/* The have been some arguments over the what the type should be that
specifies a count of bytes in a data block to be written out or read in,
using Lstream_read(), Lstream_write(), and related functions.
Originally it was long, which worked fine; Martin "corrected" these to
size_t and ssize_t on the grounds that this is theoretically cleaner and
is in keeping with the C standards. Unfortunately, this practice is
horribly error-prone due to design flaws in the way that mixed
signed/unsigned arithmetic happens. In fact, by doing this change,
Martin introduced a subtle but fatal error that caused the operation of
sending large mail messages to the SMTP server under Windows to fail.
By putting all values back to be signed, avoiding any signed/unsigned
mixing, the bug immediately went away. The type then in use was
Lstream_Data_Count, so that it be reverted cleanly if a vote came to
that. Now it is Bytecount.
Some earlier comments about why the type must be signed: This MUST BE
SIGNED, since it also is used in functions that return the number of
bytes actually read to or written from in an operation, and these
functions can return -1 to signal error.
Note that the standard Unix read() and write() functions define the
count going in as a size_t, which is UNSIGNED, and the count going
out as an ssize_t, which is SIGNED. This is a horrible design
flaw. Not only is it highly likely to lead to logic errors when a
-1 gets interpreted as a large positive number, but operations are
bound to fail in all sorts of horrible ways when a number in the
upper-half of the size_t range is passed in -- this number is
unrepresentable as an ssize_t, so code that checks to see how many
bytes are actually written (which is mandatory if you are dealing
with certain types of devices) will get completely screwed up.
--ben
*/
typedef enum lstream_buffering
--------------------------------- snip -------------------------------------
3. in dumper.c, there are four places, all inside of switch()
statements, where XD_BYTECOUNT appears twice as a case tag. In
each case, the two case blocks contain identical code, and you
should *REMOVE THE SECOND* and leave the first.
| author | ben |
|---|---|
| date | Thu, 20 Sep 2001 06:31:11 +0000 |
| parents | 190b164ddcac |
| children | 943eaba38521 |
line wrap: on
line source
/* Generic Objects and Functions. Copyright (C) 1995 Free Software Foundation, Inc. Copyright (C) 1995 Board of Trustees, University of Illinois. Copyright (C) 1995, 1996 Ben Wing. This file is part of XEmacs. XEmacs is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. XEmacs 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 along with XEmacs; see the file COPYING. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ /* Synched up with: Not in FSF. */ #include <config.h> #include "lisp.h" #include "device.h" #include "elhash.h" #include "faces.h" #include "frame.h" #include "objects.h" #include "specifier.h" #include "window.h" /* Objects that are substituted when an instantiation fails. If we leave in the Qunbound value, we will probably get crashes. */ Lisp_Object Vthe_null_color_instance, Vthe_null_font_instance; /* Authors: Ben Wing, Chuck Thompson */ void finalose (void *ptr) { Lisp_Object obj; XSETOBJ (obj, ptr); invalid_operation ("Can't dump an emacs containing window system objects", obj); } /**************************************************************************** * Color-Instance Object * ****************************************************************************/ Lisp_Object Qcolor_instancep; static Lisp_Object mark_color_instance (Lisp_Object obj) { Lisp_Color_Instance *c = XCOLOR_INSTANCE (obj); mark_object (c->name); if (!NILP (c->device)) /* Vthe_null_color_instance */ MAYBE_DEVMETH (XDEVICE (c->device), mark_color_instance, (c)); return c->device; } static void print_color_instance (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag) { char buf[100]; Lisp_Color_Instance *c = XCOLOR_INSTANCE (obj); if (print_readably) printing_unreadable_object ("#<color-instance 0x%x>", c->header.uid); write_c_string ("#<color-instance ", printcharfun); print_internal (c->name, printcharfun, 0); write_c_string (" on ", printcharfun); print_internal (c->device, printcharfun, 0); if (!NILP (c->device)) /* Vthe_null_color_instance */ MAYBE_DEVMETH (XDEVICE (c->device), print_color_instance, (c, printcharfun, escapeflag)); sprintf (buf, " 0x%x>", c->header.uid); write_c_string (buf, printcharfun); } static void finalize_color_instance (void *header, int for_disksave) { Lisp_Color_Instance *c = (Lisp_Color_Instance *) header; if (!NILP (c->device)) { if (for_disksave) finalose (c); MAYBE_DEVMETH (XDEVICE (c->device), finalize_color_instance, (c)); } } static int color_instance_equal (Lisp_Object obj1, Lisp_Object obj2, int depth) { Lisp_Color_Instance *c1 = XCOLOR_INSTANCE (obj1); Lisp_Color_Instance *c2 = XCOLOR_INSTANCE (obj2); return (c1 == c2) || (EQ (c1->device, c2->device) && DEVICEP (c1->device) && HAS_DEVMETH_P (XDEVICE (c1->device), color_instance_equal) && DEVMETH (XDEVICE (c1->device), color_instance_equal, (c1, c2, depth))); } static unsigned long color_instance_hash (Lisp_Object obj, int depth) { Lisp_Color_Instance *c = XCOLOR_INSTANCE (obj); struct device *d = DEVICEP (c->device) ? XDEVICE (c->device) : 0; return HASH2 ((unsigned long) d, !d ? LISP_HASH (obj) : DEVMETH_OR_GIVEN (d, color_instance_hash, (c, depth), LISP_HASH (obj))); } DEFINE_LRECORD_IMPLEMENTATION ("color-instance", color_instance, mark_color_instance, print_color_instance, finalize_color_instance, color_instance_equal, color_instance_hash, 0, Lisp_Color_Instance); DEFUN ("make-color-instance", Fmake_color_instance, 1, 3, 0, /* Return a new `color-instance' object named NAME (a string). Optional argument DEVICE specifies the device this object applies to and defaults to the selected device. An error is signaled if the color is unknown or cannot be allocated; however, if optional argument NOERROR is non-nil, nil is simply returned in this case. (And if NOERROR is other than t, a warning may be issued.) The returned object is a normal, first-class lisp object. The way you `deallocate' the color is the way you deallocate any other lisp object: you drop all pointers to it and allow it to be garbage collected. When these objects are GCed, the underlying window-system data (e.g. X object) is deallocated as well. */ (name, device, noerror)) { Lisp_Color_Instance *c; Lisp_Object val; int retval; CHECK_STRING (name); XSETDEVICE (device, decode_device (device)); c = alloc_lcrecord_type (Lisp_Color_Instance, &lrecord_color_instance); c->name = name; c->device = device; c->data = 0; retval = MAYBE_INT_DEVMETH (XDEVICE (device), initialize_color_instance, (c, name, device, decode_error_behavior_flag (noerror))); if (!retval) return Qnil; XSETCOLOR_INSTANCE (val, c); return val; } DEFUN ("color-instance-p", Fcolor_instance_p, 1, 1, 0, /* Return non-nil if OBJECT is a color instance. */ (object)) { return COLOR_INSTANCEP (object) ? Qt : Qnil; } DEFUN ("color-instance-name", Fcolor_instance_name, 1, 1, 0, /* Return the name used to allocate COLOR-INSTANCE. */ (color_instance)) { CHECK_COLOR_INSTANCE (color_instance); return XCOLOR_INSTANCE (color_instance)->name; } DEFUN ("color-instance-rgb-components", Fcolor_instance_rgb_components, 1, 1, 0, /* Return a three element list containing the red, green, and blue color components of COLOR-INSTANCE, or nil if unknown. Component values range from 0 to 65535. */ (color_instance)) { Lisp_Color_Instance *c; CHECK_COLOR_INSTANCE (color_instance); c = XCOLOR_INSTANCE (color_instance); if (NILP (c->device)) return Qnil; return MAYBE_LISP_DEVMETH (XDEVICE (c->device), color_instance_rgb_components, (c)); } DEFUN ("valid-color-name-p", Fvalid_color_name_p, 1, 2, 0, /* Return true if COLOR names a valid color for the current device. Valid color names for X are listed in the file /usr/lib/X11/rgb.txt, or whatever the equivalent is on your system. Valid color names for TTY are those which have an ISO 6429 (ANSI) sequence. In addition to being a color this may be one of a number of attributes such as `blink'. */ (color, device)) { struct device *d = decode_device (device); CHECK_STRING (color); return MAYBE_INT_DEVMETH (d, valid_color_name_p, (d, color)) ? Qt : Qnil; } /*************************************************************************** * Font-Instance Object * ***************************************************************************/ Lisp_Object Qfont_instancep; static Lisp_Object font_instance_truename_internal (Lisp_Object xfont, Error_Behavior errb); static Lisp_Object mark_font_instance (Lisp_Object obj) { Lisp_Font_Instance *f = XFONT_INSTANCE (obj); mark_object (f->name); if (!NILP (f->device)) /* Vthe_null_font_instance */ MAYBE_DEVMETH (XDEVICE (f->device), mark_font_instance, (f)); return f->device; } static void print_font_instance (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag) { char buf[200]; Lisp_Font_Instance *f = XFONT_INSTANCE (obj); if (print_readably) printing_unreadable_object ("#<font-instance 0x%x>", f->header.uid); write_c_string ("#<font-instance ", printcharfun); print_internal (f->name, printcharfun, 1); write_c_string (" on ", printcharfun); print_internal (f->device, printcharfun, 0); if (!NILP (f->device)) MAYBE_DEVMETH (XDEVICE (f->device), print_font_instance, (f, printcharfun, escapeflag)); sprintf (buf, " 0x%x>", f->header.uid); write_c_string (buf, printcharfun); } static void finalize_font_instance (void *header, int for_disksave) { Lisp_Font_Instance *f = (Lisp_Font_Instance *) header; if (!NILP (f->device)) { if (for_disksave) finalose (f); MAYBE_DEVMETH (XDEVICE (f->device), finalize_font_instance, (f)); } } /* Fonts are equal if they resolve to the same name. Since we call `font-truename' to do this, and since font-truename is lazy, this means the `equal' could cause XListFonts to be run the first time. */ static int font_instance_equal (Lisp_Object obj1, Lisp_Object obj2, int depth) { /* #### should this be moved into a device method? */ return internal_equal (font_instance_truename_internal (obj1, ERROR_ME_NOT), font_instance_truename_internal (obj2, ERROR_ME_NOT), depth + 1); } static unsigned long font_instance_hash (Lisp_Object obj, int depth) { return internal_hash (font_instance_truename_internal (obj, ERROR_ME_NOT), depth + 1); } DEFINE_LRECORD_IMPLEMENTATION ("font-instance", font_instance, mark_font_instance, print_font_instance, finalize_font_instance, font_instance_equal, font_instance_hash, 0, Lisp_Font_Instance); DEFUN ("make-font-instance", Fmake_font_instance, 1, 3, 0, /* Return a new `font-instance' object named NAME. DEVICE specifies the device this object applies to and defaults to the selected device. An error is signalled if the font is unknown or cannot be allocated; however, if NOERROR is non-nil, nil is simply returned in this case. The returned object is a normal, first-class lisp object. The way you `deallocate' the font is the way you deallocate any other lisp object: you drop all pointers to it and allow it to be garbage collected. When these objects are GCed, the underlying X data is deallocated as well. */ (name, device, noerror)) { Lisp_Font_Instance *f; Lisp_Object val; int retval = 0; Error_Behavior errb = decode_error_behavior_flag (noerror); if (ERRB_EQ (errb, ERROR_ME)) CHECK_STRING (name); else if (!STRINGP (name)) return Qnil; XSETDEVICE (device, decode_device (device)); f = alloc_lcrecord_type (Lisp_Font_Instance, &lrecord_font_instance); f->name = name; f->device = device; f->data = 0; /* Stick some default values here ... */ f->ascent = f->height = 1; f->descent = 0; f->width = 1; f->proportional_p = 0; retval = MAYBE_INT_DEVMETH (XDEVICE (device), initialize_font_instance, (f, name, device, errb)); if (!retval) return Qnil; XSETFONT_INSTANCE (val, f); return val; } DEFUN ("font-instance-p", Ffont_instance_p, 1, 1, 0, /* Return non-nil if OBJECT is a font instance. */ (object)) { return FONT_INSTANCEP (object) ? Qt : Qnil; } DEFUN ("font-instance-name", Ffont_instance_name, 1, 1, 0, /* Return the name used to allocate FONT-INSTANCE. */ (font_instance)) { CHECK_FONT_INSTANCE (font_instance); return XFONT_INSTANCE (font_instance)->name; } DEFUN ("font-instance-ascent", Ffont_instance_ascent, 1, 1, 0, /* Return the ascent in pixels of FONT-INSTANCE. The returned value is the maximum ascent for all characters in the font, where a character's ascent is the number of pixels above (and including) the baseline. */ (font_instance)) { CHECK_FONT_INSTANCE (font_instance); return make_int (XFONT_INSTANCE (font_instance)->ascent); } DEFUN ("font-instance-descent", Ffont_instance_descent, 1, 1, 0, /* Return the descent in pixels of FONT-INSTANCE. The returned value is the maximum descent for all characters in the font, where a character's descent is the number of pixels below the baseline. \(Many characters to do not have any descent. Typical characters with a descent are lowercase p and lowercase g.) */ (font_instance)) { CHECK_FONT_INSTANCE (font_instance); return make_int (XFONT_INSTANCE (font_instance)->descent); } DEFUN ("font-instance-width", Ffont_instance_width, 1, 1, 0, /* Return the width in pixels of FONT-INSTANCE. The returned value is the average width for all characters in the font. */ (font_instance)) { CHECK_FONT_INSTANCE (font_instance); return make_int (XFONT_INSTANCE (font_instance)->width); } DEFUN ("font-instance-proportional-p", Ffont_instance_proportional_p, 1, 1, 0, /* Return whether FONT-INSTANCE is proportional. This means that different characters in the font have different widths. */ (font_instance)) { CHECK_FONT_INSTANCE (font_instance); return XFONT_INSTANCE (font_instance)->proportional_p ? Qt : Qnil; } static Lisp_Object font_instance_truename_internal (Lisp_Object font_instance, Error_Behavior errb) { Lisp_Font_Instance *f = XFONT_INSTANCE (font_instance); if (NILP (f->device)) { maybe_signal_error (Qgui_error, "Couldn't determine font truename", font_instance, Qfont, errb); return Qnil; } return DEVMETH_OR_GIVEN (XDEVICE (f->device), font_instance_truename, (f, errb), f->name); } DEFUN ("font-instance-truename", Ffont_instance_truename, 1, 1, 0, /* Return the canonical name of FONT-INSTANCE. Font names are patterns which may match any number of fonts, of which the first found is used. This returns an unambiguous name for that font \(but not necessarily its only unambiguous name). */ (font_instance)) { CHECK_FONT_INSTANCE (font_instance); return font_instance_truename_internal (font_instance, ERROR_ME); } DEFUN ("font-instance-properties", Ffont_instance_properties, 1, 1, 0, /* Return the properties (an alist or nil) of FONT-INSTANCE. */ (font_instance)) { Lisp_Font_Instance *f; CHECK_FONT_INSTANCE (font_instance); f = XFONT_INSTANCE (font_instance); if (NILP (f->device)) return Qnil; return MAYBE_LISP_DEVMETH (XDEVICE (f->device), font_instance_properties, (f)); } DEFUN ("list-fonts", Flist_fonts, 1, 2, 0, /* Return a list of font names matching the given pattern. DEVICE specifies which device to search for names, and defaults to the currently selected device. */ (pattern, device)) { CHECK_STRING (pattern); XSETDEVICE (device, decode_device (device)); return MAYBE_LISP_DEVMETH (XDEVICE (device), list_fonts, (pattern, device)); } /**************************************************************************** Color Object ***************************************************************************/ DEFINE_SPECIFIER_TYPE (color); /* Qcolor defined in general.c */ static void color_create (Lisp_Object obj) { Lisp_Specifier *color = XCOLOR_SPECIFIER (obj); COLOR_SPECIFIER_FACE (color) = Qnil; COLOR_SPECIFIER_FACE_PROPERTY (color) = Qnil; } static void color_mark (Lisp_Object obj) { Lisp_Specifier *color = XCOLOR_SPECIFIER (obj); mark_object (COLOR_SPECIFIER_FACE (color)); mark_object (COLOR_SPECIFIER_FACE_PROPERTY (color)); } /* No equal or hash methods; ignore the face the color is based off of for `equal' */ static Lisp_Object color_instantiate (Lisp_Object specifier, Lisp_Object matchspec, Lisp_Object domain, Lisp_Object instantiator, Lisp_Object depth) { /* When called, we're inside of call_with_suspended_errors(), so we can freely error. */ Lisp_Object device = DOMAIN_DEVICE (domain); struct device *d = XDEVICE (device); if (COLOR_INSTANCEP (instantiator)) { /* If we are on the same device then we're done. Otherwise change the instantiator to the name used to generate the pixel and let the STRINGP case deal with it. */ if (NILP (device) /* Vthe_null_color_instance */ || EQ (device, XCOLOR_INSTANCE (instantiator)->device)) return instantiator; else instantiator = Fcolor_instance_name (instantiator); } if (STRINGP (instantiator)) { /* First, look to see if we can retrieve a cached value. */ Lisp_Object instance = Fgethash (instantiator, d->color_instance_cache, Qunbound); /* Otherwise, make a new one. */ if (UNBOUNDP (instance)) { /* make sure we cache the failures, too. */ instance = Fmake_color_instance (instantiator, device, Qt); Fputhash (instantiator, instance, d->color_instance_cache); } return NILP (instance) ? Qunbound : instance; } else if (VECTORP (instantiator)) { switch (XVECTOR_LENGTH (instantiator)) { case 0: if (DEVICE_TTY_P (d)) return Vthe_null_color_instance; else gui_error ("Color instantiator [] only valid on TTY's", device); case 1: if (NILP (COLOR_SPECIFIER_FACE (XCOLOR_SPECIFIER (specifier)))) gui_error ("Color specifier not attached to a face", instantiator); return (FACE_PROPERTY_INSTANCE_1 (Fget_face (XVECTOR_DATA (instantiator)[0]), COLOR_SPECIFIER_FACE_PROPERTY (XCOLOR_SPECIFIER (specifier)), domain, ERROR_ME, 0, depth)); case 2: return (FACE_PROPERTY_INSTANCE_1 (Fget_face (XVECTOR_DATA (instantiator)[0]), XVECTOR_DATA (instantiator)[1], domain, ERROR_ME, 0, depth)); default: abort (); } } else if (NILP (instantiator)) { if (DEVICE_TTY_P (d)) return Vthe_null_color_instance; else gui_error ("Color instantiator [] only valid on TTY's", device); } else abort (); /* The spec validation routines are screwed up. */ return Qunbound; } static void color_validate (Lisp_Object instantiator) { if (COLOR_INSTANCEP (instantiator) || STRINGP (instantiator)) return; if (VECTORP (instantiator)) { if (XVECTOR_LENGTH (instantiator) > 2) sferror ("Inheritance vector must be of size 0 - 2", instantiator); else if (XVECTOR_LENGTH (instantiator) > 0) { Lisp_Object face = XVECTOR_DATA (instantiator)[0]; Fget_face (face); if (XVECTOR_LENGTH (instantiator) == 2) { Lisp_Object field = XVECTOR_DATA (instantiator)[1]; if (!EQ (field, Qforeground) && !EQ (field, Qbackground)) invalid_constant ("Inheritance field must be `foreground' or `background'", field); } } } else invalid_argument ("Invalid color instantiator", instantiator); } static void color_after_change (Lisp_Object specifier, Lisp_Object locale) { Lisp_Object face = COLOR_SPECIFIER_FACE (XCOLOR_SPECIFIER (specifier)); Lisp_Object property = COLOR_SPECIFIER_FACE_PROPERTY (XCOLOR_SPECIFIER (specifier)); if (!NILP (face)) { face_property_was_changed (face, property, locale); if (BUFFERP (locale)) XBUFFER (locale)->buffer_local_face_property = 1; } } void set_color_attached_to (Lisp_Object obj, Lisp_Object face, Lisp_Object property) { Lisp_Specifier *color = XCOLOR_SPECIFIER (obj); COLOR_SPECIFIER_FACE (color) = face; COLOR_SPECIFIER_FACE_PROPERTY (color) = property; } DEFUN ("color-specifier-p", Fcolor_specifier_p, 1, 1, 0, /* Return t if OBJECT is a color specifier. See `make-color-specifier' for a description of possible color instantiators. */ (object)) { return COLOR_SPECIFIERP (object) ? Qt : Qnil; } /**************************************************************************** Font Object ***************************************************************************/ DEFINE_SPECIFIER_TYPE (font); /* Qfont defined in general.c */ static void font_create (Lisp_Object obj) { Lisp_Specifier *font = XFONT_SPECIFIER (obj); FONT_SPECIFIER_FACE (font) = Qnil; FONT_SPECIFIER_FACE_PROPERTY (font) = Qnil; } static void font_mark (Lisp_Object obj) { Lisp_Specifier *font = XFONT_SPECIFIER (obj); mark_object (FONT_SPECIFIER_FACE (font)); mark_object (FONT_SPECIFIER_FACE_PROPERTY (font)); } /* No equal or hash methods; ignore the face the font is based off of for `equal' */ #ifdef MULE int font_spec_matches_charset (struct device *d, Lisp_Object charset, const Intbyte *nonreloc, Lisp_Object reloc, Bytecount offset, Bytecount length) { return DEVMETH_OR_GIVEN (d, font_spec_matches_charset, (d, charset, nonreloc, reloc, offset, length), 1); } static void font_validate_matchspec (Lisp_Object matchspec) { Fget_charset (matchspec); } #endif /* MULE */ static Lisp_Object font_instantiate (Lisp_Object specifier, Lisp_Object matchspec, Lisp_Object domain, Lisp_Object instantiator, Lisp_Object depth) { /* When called, we're inside of call_with_suspended_errors(), so we can freely error. */ Lisp_Object device = DOMAIN_DEVICE (domain); struct device *d = XDEVICE (device); Lisp_Object instance; #ifdef MULE if (!UNBOUNDP (matchspec)) matchspec = Fget_charset (matchspec); #endif if (FONT_INSTANCEP (instantiator)) { if (NILP (device) || EQ (device, XFONT_INSTANCE (instantiator)->device)) { #ifdef MULE if (font_spec_matches_charset (d, matchspec, 0, Ffont_instance_truename (instantiator), 0, -1)) return instantiator; #else return instantiator; #endif } instantiator = Ffont_instance_name (instantiator); } if (STRINGP (instantiator)) { #ifdef MULE if (!UNBOUNDP (matchspec)) { /* The instantiator is a font spec that could match many different fonts. We need to find one of those fonts whose registry matches the registry of the charset in MATCHSPEC. This is potentially a very slow operation, as it involves doing an XListFonts() or equivalent to iterate over all possible fonts, and a regexp match on each one. So we cache the results. */ Lisp_Object matching_font = Qunbound; Lisp_Object hash_table = Fgethash (matchspec, d->charset_font_cache, Qunbound); if (UNBOUNDP (hash_table)) { /* need to make a sub hash table. */ hash_table = make_lisp_hash_table (20, HASH_TABLE_KEY_WEAK, HASH_TABLE_EQUAL); Fputhash (matchspec, hash_table, d->charset_font_cache); } else matching_font = Fgethash (instantiator, hash_table, Qunbound); if (UNBOUNDP (matching_font)) { /* make sure we cache the failures, too. */ matching_font = DEVMETH_OR_GIVEN (d, find_charset_font, (device, instantiator, matchspec), instantiator); Fputhash (instantiator, matching_font, hash_table); } if (NILP (matching_font)) return Qunbound; instantiator = matching_font; } #endif /* MULE */ /* First, look to see if we can retrieve a cached value. */ instance = Fgethash (instantiator, d->font_instance_cache, Qunbound); /* Otherwise, make a new one. */ if (UNBOUNDP (instance)) { /* make sure we cache the failures, too. */ instance = Fmake_font_instance (instantiator, device, Qt); Fputhash (instantiator, instance, d->font_instance_cache); } return NILP (instance) ? Qunbound : instance; } else if (VECTORP (instantiator)) { assert (XVECTOR_LENGTH (instantiator) == 1); return (face_property_matching_instance (Fget_face (XVECTOR_DATA (instantiator)[0]), Qfont, matchspec, domain, ERROR_ME, 0, depth)); } else if (NILP (instantiator)) return Qunbound; else abort (); /* Eh? */ return Qunbound; } static void font_validate (Lisp_Object instantiator) { if (FONT_INSTANCEP (instantiator) || STRINGP (instantiator)) return; if (VECTORP (instantiator)) { if (XVECTOR_LENGTH (instantiator) != 1) { sferror ("Vector length must be one for font inheritance", instantiator); } Fget_face (XVECTOR_DATA (instantiator)[0]); } else invalid_argument ("Must be string, vector, or font-instance", instantiator); } static void font_after_change (Lisp_Object specifier, Lisp_Object locale) { Lisp_Object face = FONT_SPECIFIER_FACE (XFONT_SPECIFIER (specifier)); Lisp_Object property = FONT_SPECIFIER_FACE_PROPERTY (XFONT_SPECIFIER (specifier)); if (!NILP (face)) { face_property_was_changed (face, property, locale); if (BUFFERP (locale)) XBUFFER (locale)->buffer_local_face_property = 1; } } void set_font_attached_to (Lisp_Object obj, Lisp_Object face, Lisp_Object property) { Lisp_Specifier *font = XFONT_SPECIFIER (obj); FONT_SPECIFIER_FACE (font) = face; FONT_SPECIFIER_FACE_PROPERTY (font) = property; } DEFUN ("font-specifier-p", Ffont_specifier_p, 1, 1, 0, /* Return non-nil if OBJECT is a font specifier. See `make-font-specifier' for a description of possible font instantiators. */ (object)) { return FONT_SPECIFIERP (object) ? Qt : Qnil; } /***************************************************************************** Face Boolean Object ****************************************************************************/ DEFINE_SPECIFIER_TYPE (face_boolean); Lisp_Object Qface_boolean; static void face_boolean_create (Lisp_Object obj) { Lisp_Specifier *face_boolean = XFACE_BOOLEAN_SPECIFIER (obj); FACE_BOOLEAN_SPECIFIER_FACE (face_boolean) = Qnil; FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY (face_boolean) = Qnil; } static void face_boolean_mark (Lisp_Object obj) { Lisp_Specifier *face_boolean = XFACE_BOOLEAN_SPECIFIER (obj); mark_object (FACE_BOOLEAN_SPECIFIER_FACE (face_boolean)); mark_object (FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY (face_boolean)); } /* No equal or hash methods; ignore the face the face-boolean is based off of for `equal' */ static Lisp_Object face_boolean_instantiate (Lisp_Object specifier, Lisp_Object matchspec, Lisp_Object domain, Lisp_Object instantiator, Lisp_Object depth) { /* When called, we're inside of call_with_suspended_errors(), so we can freely error. */ if (NILP (instantiator) || EQ (instantiator, Qt)) return instantiator; else if (VECTORP (instantiator)) { Lisp_Object retval; Lisp_Object prop; int instantiator_len = XVECTOR_LENGTH (instantiator); assert (instantiator_len >= 1 && instantiator_len <= 3); if (instantiator_len > 1) prop = XVECTOR_DATA (instantiator)[1]; else { if (NILP (FACE_BOOLEAN_SPECIFIER_FACE (XFACE_BOOLEAN_SPECIFIER (specifier)))) gui_error ("Face-boolean specifier not attached to a face", instantiator); prop = FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY (XFACE_BOOLEAN_SPECIFIER (specifier)); } retval = (FACE_PROPERTY_INSTANCE_1 (Fget_face (XVECTOR_DATA (instantiator)[0]), prop, domain, ERROR_ME, 0, depth)); if (instantiator_len == 3 && !NILP (XVECTOR_DATA (instantiator)[2])) retval = NILP (retval) ? Qt : Qnil; return retval; } else abort (); /* Eh? */ return Qunbound; } static void face_boolean_validate (Lisp_Object instantiator) { if (NILP (instantiator) || EQ (instantiator, Qt)) return; else if (VECTORP (instantiator) && (XVECTOR_LENGTH (instantiator) >= 1 && XVECTOR_LENGTH (instantiator) <= 3)) { Lisp_Object face = XVECTOR_DATA (instantiator)[0]; Fget_face (face); if (XVECTOR_LENGTH (instantiator) > 1) { Lisp_Object field = XVECTOR_DATA (instantiator)[1]; if (!EQ (field, Qunderline) && !EQ (field, Qstrikethru) && !EQ (field, Qhighlight) && !EQ (field, Qdim) && !EQ (field, Qblinking) && !EQ (field, Qreverse)) invalid_constant ("Invalid face-boolean inheritance field", field); } } else if (VECTORP (instantiator)) sferror ("Wrong length for face-boolean inheritance spec", instantiator); else invalid_argument ("Face-boolean instantiator must be nil, t, or vector", instantiator); } static void face_boolean_after_change (Lisp_Object specifier, Lisp_Object locale) { Lisp_Object face = FACE_BOOLEAN_SPECIFIER_FACE (XFACE_BOOLEAN_SPECIFIER (specifier)); Lisp_Object property = FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY (XFACE_BOOLEAN_SPECIFIER (specifier)); if (!NILP (face)) { face_property_was_changed (face, property, locale); if (BUFFERP (locale)) XBUFFER (locale)->buffer_local_face_property = 1; } } void set_face_boolean_attached_to (Lisp_Object obj, Lisp_Object face, Lisp_Object property) { Lisp_Specifier *face_boolean = XFACE_BOOLEAN_SPECIFIER (obj); FACE_BOOLEAN_SPECIFIER_FACE (face_boolean) = face; FACE_BOOLEAN_SPECIFIER_FACE_PROPERTY (face_boolean) = property; } DEFUN ("face-boolean-specifier-p", Fface_boolean_specifier_p, 1, 1, 0, /* Return non-nil if OBJECT is a face-boolean specifier. See `make-face-boolean-specifier' for a description of possible face-boolean instantiators. */ (object)) { return FACE_BOOLEAN_SPECIFIERP (object) ? Qt : Qnil; } /************************************************************************/ /* initialization */ /************************************************************************/ void syms_of_objects (void) { INIT_LRECORD_IMPLEMENTATION (color_instance); INIT_LRECORD_IMPLEMENTATION (font_instance); DEFSUBR (Fcolor_specifier_p); DEFSUBR (Ffont_specifier_p); DEFSUBR (Fface_boolean_specifier_p); DEFSYMBOL_MULTIWORD_PREDICATE (Qcolor_instancep); DEFSUBR (Fmake_color_instance); DEFSUBR (Fcolor_instance_p); DEFSUBR (Fcolor_instance_name); DEFSUBR (Fcolor_instance_rgb_components); DEFSUBR (Fvalid_color_name_p); DEFSYMBOL_MULTIWORD_PREDICATE (Qfont_instancep); DEFSUBR (Fmake_font_instance); DEFSUBR (Ffont_instance_p); DEFSUBR (Ffont_instance_name); DEFSUBR (Ffont_instance_ascent); DEFSUBR (Ffont_instance_descent); DEFSUBR (Ffont_instance_width); DEFSUBR (Ffont_instance_proportional_p); DEFSUBR (Ffont_instance_truename); DEFSUBR (Ffont_instance_properties); DEFSUBR (Flist_fonts); /* Qcolor, Qfont defined in general.c */ DEFSYMBOL (Qface_boolean); } static const struct lrecord_description color_specifier_description[] = { { XD_LISP_OBJECT, specifier_data_offset + offsetof (struct color_specifier, face) }, { XD_LISP_OBJECT, specifier_data_offset + offsetof (struct color_specifier, face_property) }, { XD_END } }; static const struct lrecord_description font_specifier_description[] = { { XD_LISP_OBJECT, specifier_data_offset + offsetof (struct font_specifier, face) }, { XD_LISP_OBJECT, specifier_data_offset + offsetof (struct font_specifier, face_property) }, { XD_END } }; static const struct lrecord_description face_boolean_specifier_description[] = { { XD_LISP_OBJECT, specifier_data_offset + offsetof (struct face_boolean_specifier, face) }, { XD_LISP_OBJECT, specifier_data_offset + offsetof (struct face_boolean_specifier, face_property) }, { XD_END } }; void specifier_type_create_objects (void) { INITIALIZE_SPECIFIER_TYPE_WITH_DATA (color, "color", "color-specifier-p"); INITIALIZE_SPECIFIER_TYPE_WITH_DATA (font, "font", "font-specifier-p"); INITIALIZE_SPECIFIER_TYPE_WITH_DATA (face_boolean, "face-boolean", "face-boolean-specifier-p"); SPECIFIER_HAS_METHOD (color, instantiate); SPECIFIER_HAS_METHOD (font, instantiate); SPECIFIER_HAS_METHOD (face_boolean, instantiate); SPECIFIER_HAS_METHOD (color, validate); SPECIFIER_HAS_METHOD (font, validate); SPECIFIER_HAS_METHOD (face_boolean, validate); SPECIFIER_HAS_METHOD (color, create); SPECIFIER_HAS_METHOD (font, create); SPECIFIER_HAS_METHOD (face_boolean, create); SPECIFIER_HAS_METHOD (color, mark); SPECIFIER_HAS_METHOD (font, mark); SPECIFIER_HAS_METHOD (face_boolean, mark); SPECIFIER_HAS_METHOD (color, after_change); SPECIFIER_HAS_METHOD (font, after_change); SPECIFIER_HAS_METHOD (face_boolean, after_change); #ifdef MULE SPECIFIER_HAS_METHOD (font, validate_matchspec); #endif } void reinit_specifier_type_create_objects (void) { REINITIALIZE_SPECIFIER_TYPE (color); REINITIALIZE_SPECIFIER_TYPE (font); REINITIALIZE_SPECIFIER_TYPE (face_boolean); } void reinit_vars_of_objects (void) { staticpro_nodump (&Vthe_null_color_instance); { Lisp_Color_Instance *c = alloc_lcrecord_type (Lisp_Color_Instance, &lrecord_color_instance); c->name = Qnil; c->device = Qnil; c->data = 0; XSETCOLOR_INSTANCE (Vthe_null_color_instance, c); } staticpro_nodump (&Vthe_null_font_instance); { Lisp_Font_Instance *f = alloc_lcrecord_type (Lisp_Font_Instance, &lrecord_font_instance); f->name = Qnil; f->device = Qnil; f->data = 0; f->ascent = f->height = 0; f->descent = 0; f->width = 0; f->proportional_p = 0; XSETFONT_INSTANCE (Vthe_null_font_instance, f); } } void vars_of_objects (void) { reinit_vars_of_objects (); }