Mercurial > hg > xemacs-beta
annotate src/console-x.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 | b39c14581166 |
children | e38acbeb1cae |
rev | line source |
---|---|
428 | 1 /* Console functions for X windows. |
2 Copyright (C) 1996 Ben Wing. | |
3 | |
4 This file is part of XEmacs. | |
5 | |
6 XEmacs is free software; you can redistribute it and/or modify it | |
7 under the terms of the GNU General Public License as published by the | |
8 Free Software Foundation; either version 2, or (at your option) any | |
9 later version. | |
10 | |
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
14 for more details. | |
15 | |
16 You should have received a copy of the GNU General Public License | |
17 along with XEmacs; see the file COPYING. If not, write to | |
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
19 Boston, MA 02111-1307, USA. */ | |
20 | |
21 /* Synched up with: Not in FSF. */ | |
22 | |
442 | 23 /* This file Mule-ized by Ben Wing, 7-10-00. */ |
24 | |
428 | 25 /* Authorship: |
26 | |
27 Ben Wing: January 1996, for 19.14. | |
28 */ | |
29 | |
30 #include <config.h> | |
31 #include "lisp.h" | |
32 | |
33 #include "console-x.h" | |
442 | 34 #include "buffer.h" |
428 | 35 #include "process.h" /* canonicalize_host_name */ |
36 #include "redisplay.h" /* for display_arg */ | |
37 | |
38 DEFINE_CONSOLE_TYPE (x); | |
39 | |
40 static int | |
41 x_initially_selected_for_input (struct console *con) | |
42 { | |
43 return 1; | |
44 } | |
45 | |
444 | 46 /* Parse a DISPLAY specification like "host:10.0" or ":0" */ |
428 | 47 static void |
48 split_up_display_spec (Lisp_Object display, int *hostname_length, | |
49 int *display_length, int *screen_length) | |
50 { | |
665 | 51 Intbyte *beg = XSTRING_DATA (display); |
52 Intbyte *end = beg + XSTRING_LENGTH (display); | |
53 Intbyte *p = end; | |
428 | 54 |
444 | 55 while (p > beg) |
428 | 56 { |
444 | 57 DEC_CHARPTR (p); |
58 if (charptr_emchar (p) == ':') | |
59 { | |
60 *hostname_length = p - beg; | |
428 | 61 |
444 | 62 while (p < end - 1) |
63 { | |
64 INC_CHARPTR (p); | |
65 if (charptr_emchar (p) == '.') | |
66 { | |
67 *display_length = p - beg - *hostname_length; | |
68 *screen_length = end - p; | |
69 return; | |
70 } | |
71 } | |
72 /* No '.' found. */ | |
73 *display_length = XSTRING_LENGTH (display) - *hostname_length; | |
74 *screen_length = 0; | |
75 return; | |
76 } | |
428 | 77 } |
78 | |
444 | 79 /* No ':' found. */ |
80 *hostname_length = XSTRING_LENGTH (display); | |
81 *display_length = 0; | |
82 *screen_length = 0; | |
428 | 83 } |
84 | |
85 /* Remember, in all of the following functions, we have to verify | |
86 the integrity of our input, because the generic functions don't. */ | |
87 | |
88 static Lisp_Object | |
578 | 89 x_device_to_console_connection (Lisp_Object connection, Error_Behavior errb) |
428 | 90 { |
91 /* Strip the trailing .# off of the connection, if it's there. */ | |
92 | |
93 if (NILP (connection)) | |
94 return Qnil; | |
95 else | |
96 { | |
97 int hostname_length, display_length, screen_length; | |
98 | |
99 if (!ERRB_EQ (errb, ERROR_ME)) | |
100 { | |
101 if (!STRINGP (connection)) | |
102 return Qunbound; | |
103 } | |
104 else | |
105 CHECK_STRING (connection); | |
106 | |
107 split_up_display_spec (connection, &hostname_length, &display_length, | |
108 &screen_length); | |
109 connection = make_string (XSTRING_DATA (connection), | |
110 hostname_length + display_length); | |
111 } | |
112 | |
113 return connection; | |
114 } | |
115 | |
116 static Lisp_Object | |
117 get_display_arg_connection (void) | |
118 { | |
442 | 119 const Extbyte *disp_name; |
428 | 120 |
121 /* If the user didn't explicitly specify a display to use when | |
122 they called make-x-device, then we first check to see if a | |
123 display was specified on the command line with -display. If | |
124 so, we set disp_name to it. Otherwise we use XDisplayName to | |
125 see what DISPLAY is set to. XtOpenDisplay knows how to do | |
126 both of these things, but we need to know the name to use. */ | |
127 if (display_arg) | |
128 { | |
129 int elt; | |
130 int argc; | |
442 | 131 Extbyte **argv; |
428 | 132 Lisp_Object conn; |
133 | |
134 make_argc_argv (Vx_initial_argv_list, &argc, &argv); | |
135 | |
136 disp_name = NULL; | |
137 for (elt = 0; elt < argc; elt++) | |
138 { | |
139 if (!strcmp (argv[elt], "-d") || !strcmp (argv[elt], "-display")) | |
140 { | |
141 if (elt + 1 == argc) | |
142 { | |
143 suppress_early_error_handler_backtrace = 1; | |
563 | 144 invalid_argument ("-display specified with no arg", Qunbound); |
428 | 145 } |
146 else | |
147 { | |
148 disp_name = argv[elt + 1]; | |
149 break; | |
150 } | |
151 } | |
152 } | |
153 | |
154 /* assert: display_arg is only set if we found the display | |
155 arg earlier so we can't fail to find it now. */ | |
156 assert (disp_name != NULL); | |
442 | 157 conn = build_ext_string (disp_name, Qcommand_argument_encoding); |
428 | 158 free_argc_argv (argv); |
159 return conn; | |
160 } | |
161 else | |
442 | 162 return build_ext_string (XDisplayName (0), Qx_display_name_encoding); |
428 | 163 } |
164 | |
165 /* "semi-canonicalize" means convert to a nicer form for printing, but | |
166 don't completely canonicalize (into some likely ugly form) */ | |
167 | |
168 static Lisp_Object | |
169 x_semi_canonicalize_console_connection (Lisp_Object connection, | |
578 | 170 Error_Behavior errb) |
428 | 171 { |
172 struct gcpro gcpro1; | |
173 | |
174 GCPRO1 (connection); | |
175 | |
176 if (NILP (connection)) | |
177 connection = get_display_arg_connection (); | |
178 else | |
179 { | |
180 if (!ERRB_EQ (errb, ERROR_ME)) | |
181 { | |
182 if (!STRINGP (connection)) | |
183 RETURN_UNGCPRO (Qunbound); | |
184 } | |
185 else | |
186 CHECK_STRING (connection); | |
187 } | |
188 | |
189 | |
190 /* Be lenient, allow people to specify a device connection instead of | |
191 a console connection -- e.g. "foo:0.0" instead of "foo:0". This | |
192 only happens in `find-console' and `get-console'. */ | |
193 connection = x_device_to_console_connection (connection, errb); | |
194 | |
195 /* Check for a couple of standard special cases */ | |
444 | 196 if (string_char (XSTRING (connection), 0) == ':') |
428 | 197 connection = concat2 (build_string ("localhost"), connection); |
444 | 198 else |
199 { | |
200 /* connection =~ s/^unix:/localhost:/; */ | |
665 | 201 const Intbyte *p = XSTRING_DATA (connection); |
202 const Intbyte *end = XSTRING_DATA (connection) + XSTRING_LENGTH (connection); | |
647 | 203 int i; |
444 | 204 |
647 | 205 for (i = 0; i < (int) sizeof ("unix:") - 1; i++) |
444 | 206 { |
207 if (p == end || charptr_emchar (p) != "unix:"[i]) | |
208 goto ok; | |
209 INC_CHARPTR (p); | |
210 } | |
211 | |
212 connection = concat2 (build_string ("localhost:"), | |
213 make_string (p, end - p)); | |
214 } | |
215 ok: | |
428 | 216 |
217 RETURN_UNGCPRO (connection); | |
218 } | |
219 | |
220 static Lisp_Object | |
578 | 221 x_canonicalize_console_connection (Lisp_Object connection, Error_Behavior errb) |
428 | 222 { |
223 Lisp_Object hostname = Qnil; | |
224 struct gcpro gcpro1, gcpro2; | |
225 | |
226 GCPRO2 (connection, hostname); | |
227 | |
228 connection = x_semi_canonicalize_console_connection (connection, errb); | |
229 if (UNBOUNDP (connection)) | |
230 RETURN_UNGCPRO (Qunbound); | |
231 | |
232 { | |
233 int hostname_length, display_length, screen_length; | |
234 | |
235 split_up_display_spec (connection, &hostname_length, &display_length, | |
236 &screen_length); | |
237 hostname = Fsubstring (connection, Qzero, make_int (hostname_length)); | |
238 hostname = canonicalize_host_name (hostname); | |
239 connection = concat2 (hostname, | |
240 make_string (XSTRING_DATA (connection) | |
241 + hostname_length, display_length)); | |
242 } | |
243 | |
244 RETURN_UNGCPRO (connection); | |
245 } | |
246 | |
247 static Lisp_Object | |
248 x_semi_canonicalize_device_connection (Lisp_Object connection, | |
578 | 249 Error_Behavior errb) |
428 | 250 { |
251 int hostname_length, display_length, screen_length; | |
252 struct gcpro gcpro1; | |
253 | |
254 GCPRO1 (connection); | |
255 if (NILP (connection)) | |
256 connection = get_display_arg_connection (); | |
257 else | |
258 { | |
259 if (!ERRB_EQ (errb, ERROR_ME)) | |
260 { | |
261 if (!STRINGP (connection)) | |
262 RETURN_UNGCPRO (Qunbound); | |
263 } | |
264 else | |
265 CHECK_STRING (connection); | |
266 } | |
267 | |
268 split_up_display_spec (connection, &hostname_length, &display_length, | |
269 &screen_length); | |
270 | |
271 if (!screen_length) | |
272 connection = concat2 (connection, build_string (".0")); | |
273 RETURN_UNGCPRO (connection); | |
274 } | |
275 | |
276 static Lisp_Object | |
578 | 277 x_canonicalize_device_connection (Lisp_Object connection, Error_Behavior errb) |
428 | 278 { |
279 int hostname_length, display_length, screen_length; | |
280 Lisp_Object screen_str = Qnil; | |
281 struct gcpro gcpro1, gcpro2; | |
282 | |
283 GCPRO2 (screen_str, connection); | |
284 connection = x_semi_canonicalize_device_connection (connection, errb); | |
285 if (UNBOUNDP (connection)) | |
286 RETURN_UNGCPRO (Qunbound); | |
287 | |
288 split_up_display_spec (connection, &hostname_length, &display_length, | |
289 &screen_length); | |
290 | |
444 | 291 screen_str = make_string (XSTRING_DATA (connection) |
292 + hostname_length + display_length, screen_length); | |
428 | 293 connection = x_canonicalize_console_connection (connection, errb); |
294 | |
295 RETURN_UNGCPRO (concat2 (connection, screen_str)); | |
296 } | |
297 | |
298 void | |
299 console_type_create_x (void) | |
300 { | |
301 INITIALIZE_CONSOLE_TYPE (x, "x", "console-x-p"); | |
302 | |
303 CONSOLE_HAS_METHOD (x, semi_canonicalize_console_connection); | |
304 CONSOLE_HAS_METHOD (x, canonicalize_console_connection); | |
305 CONSOLE_HAS_METHOD (x, semi_canonicalize_device_connection); | |
306 CONSOLE_HAS_METHOD (x, canonicalize_device_connection); | |
307 CONSOLE_HAS_METHOD (x, device_to_console_connection); | |
308 CONSOLE_HAS_METHOD (x, initially_selected_for_input); | |
309 } | |
310 | |
311 | |
312 void | |
313 reinit_console_type_create_x (void) | |
314 { | |
315 REINITIALIZE_CONSOLE_TYPE (x); | |
316 } |