Mercurial > hg > xemacs-beta
view src/file-coding.h @ 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 | af57a77cbc92 |
| children | 943eaba38521 |
line wrap: on
line source
/* Header for code conversion stuff Copyright (C) 1991, 1995 Free Software Foundation, Inc. Copyright (C) 1995 Sun Microsystems, Inc. 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: Mule 2.3. Not in FSF. */ /* 91.10.09 written by K.Handa <handa@etl.go.jp> */ /* Rewritten by Ben Wing <ben@xemacs.org>. */ #ifndef INCLUDED_file_coding_h_ #define INCLUDED_file_coding_h_ struct decoding_stream; struct encoding_stream; /* Coding system types. These go into the TYPE field of a Lisp_Coding_System. */ enum coding_system_type { CODESYS_AUTODETECT, /* Automatic conversion. */ #ifdef MULE CODESYS_SHIFT_JIS, /* Shift-JIS; Hankaku (half-width) KANA is also supported. */ CODESYS_ISO2022, /* Any ISO2022-compliant coding system. Includes JIS, EUC, CTEXT */ CODESYS_BIG5, /* BIG5 (used for Taiwanese). */ CODESYS_UCS4, /* ISO 10646 UCS-4 */ CODESYS_UTF8, /* ISO 10646 UTF-8 */ CODESYS_CCL, /* Converter written in CCL. */ #endif CODESYS_NO_CONVERSION /* "No conversion"; used for binary files. We use quotes because there really is some conversion being applied, but it appears to the user as if the text is read in without conversion. */ #ifdef DEBUG_XEMACS ,CODESYS_INTERNAL /* Raw (internally-formatted) data. */ #endif }; enum eol_type { EOL_AUTODETECT, EOL_LF, EOL_CRLF, EOL_CR }; typedef enum eol_type eol_type_t; #ifdef MULE typedef struct charset_conversion_spec charset_conversion_spec; struct charset_conversion_spec { Lisp_Object from_charset; Lisp_Object to_charset; }; typedef struct { Dynarr_declare (charset_conversion_spec); } charset_conversion_spec_dynarr; #endif struct Lisp_Coding_System { struct lcrecord_header header; /* Name and doc string of this coding system. */ Lisp_Object name; Lisp_Object doc_string; /* This is the major type of the coding system -- one of Big5, ISO2022, Shift-JIS, etc. See the constants above. */ enum coding_system_type type; /* Mnemonic string displayed in the modeline when this coding system is active for a particular buffer. */ Lisp_Object mnemonic; Lisp_Object post_read_conversion; Lisp_Object pre_write_conversion; eol_type_t eol_type; /* Subsidiary coding systems that specify a particular type of EOL marking, rather than autodetecting it. These will only be non-nil if (eol_type == EOL_AUTODETECT). */ Lisp_Object eol_lf; Lisp_Object eol_crlf; Lisp_Object eol_cr; #ifdef MULE struct { /* What are the charsets to be initially designated to G0, G1, G2, G3? If t, no charset is initially designated. If nil, no charset is initially designated and no charset is allowed to be designated. */ Lisp_Object initial_charset[4]; /* If true, a designation escape sequence needs to be sent on output for the charset in G[0-3] before that charset is used. */ unsigned char force_charset_on_output[4]; charset_conversion_spec_dynarr *input_conv; charset_conversion_spec_dynarr *output_conv; unsigned int shoort :1; /* C makes you speak Dutch */ unsigned int no_ascii_eol :1; unsigned int no_ascii_cntl :1; unsigned int seven :1; unsigned int lock_shift :1; unsigned int no_iso6429 :1; unsigned int escape_quoted :1; } iso2022; struct { /* For a CCL coding system, these specify the CCL programs used for decoding (input) and encoding (output). */ Lisp_Object decode; Lisp_Object encode; } ccl; #endif }; typedef struct Lisp_Coding_System Lisp_Coding_System; DECLARE_LRECORD (coding_system, Lisp_Coding_System); #define XCODING_SYSTEM(x) XRECORD (x, coding_system, Lisp_Coding_System) #define XSETCODING_SYSTEM(x, p) XSETRECORD (x, p, coding_system) #define wrap_coding_system(p) wrap_record (p, coding_system) #define CODING_SYSTEMP(x) RECORDP (x, coding_system) #define CHECK_CODING_SYSTEM(x) CHECK_RECORD (x, coding_system) #define CONCHECK_CODING_SYSTEM(x) CONCHECK_RECORD (x, coding_system) #define CODING_SYSTEM_NAME(codesys) ((codesys)->name) #define CODING_SYSTEM_DOC_STRING(codesys) ((codesys)->doc_string) #define CODING_SYSTEM_TYPE(codesys) ((codesys)->type) #define CODING_SYSTEM_MNEMONIC(codesys) ((codesys)->mnemonic) #define CODING_SYSTEM_POST_READ_CONVERSION(codesys) \ ((codesys)->post_read_conversion) #define CODING_SYSTEM_PRE_WRITE_CONVERSION(codesys) \ ((codesys)->pre_write_conversion) #define CODING_SYSTEM_EOL_TYPE(codesys) ((codesys)->eol_type) #define CODING_SYSTEM_EOL_LF(codesys) ((codesys)->eol_lf) #define CODING_SYSTEM_EOL_CRLF(codesys) ((codesys)->eol_crlf) #define CODING_SYSTEM_EOL_CR(codesys) ((codesys)->eol_cr) #ifdef MULE #define CODING_SYSTEM_ISO2022_INITIAL_CHARSET(codesys, g) \ ((codesys)->iso2022.initial_charset[g]) #define CODING_SYSTEM_ISO2022_FORCE_CHARSET_ON_OUTPUT(codesys, g) \ ((codesys)->iso2022.force_charset_on_output[g]) #define CODING_SYSTEM_ISO2022_SHORT(codesys) ((codesys)->iso2022.shoort) #define CODING_SYSTEM_ISO2022_NO_ASCII_EOL(codesys) \ ((codesys)->iso2022.no_ascii_eol) #define CODING_SYSTEM_ISO2022_NO_ASCII_CNTL(codesys) \ ((codesys)->iso2022.no_ascii_cntl) #define CODING_SYSTEM_ISO2022_SEVEN(codesys) ((codesys)->iso2022.seven) #define CODING_SYSTEM_ISO2022_LOCK_SHIFT(codesys) \ ((codesys)->iso2022.lock_shift) #define CODING_SYSTEM_ISO2022_NO_ISO6429(codesys) \ ((codesys)->iso2022.no_iso6429) #define CODING_SYSTEM_ISO2022_ESCAPE_QUOTED(codesys) \ ((codesys)->iso2022.escape_quoted) #define CODING_SYSTEM_CCL_DECODE(codesys) ((codesys)->ccl.decode) #define CODING_SYSTEM_CCL_ENCODE(codesys) ((codesys)->ccl.encode) #endif /* MULE */ #define XCODING_SYSTEM_NAME(codesys) \ CODING_SYSTEM_NAME (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_DOC_STRING(codesys) \ CODING_SYSTEM_DOC_STRING (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_TYPE(codesys) \ CODING_SYSTEM_TYPE (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_MNEMONIC(codesys) \ CODING_SYSTEM_MNEMONIC (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_POST_READ_CONVERSION(codesys) \ CODING_SYSTEM_POST_READ_CONVERSION (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_PRE_WRITE_CONVERSION(codesys) \ CODING_SYSTEM_PRE_WRITE_CONVERSION (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_EOL_TYPE(codesys) \ CODING_SYSTEM_EOL_TYPE (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_EOL_LF(codesys) \ CODING_SYSTEM_EOL_LF (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_EOL_CRLF(codesys) \ CODING_SYSTEM_EOL_CRLF (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_EOL_CR(codesys) \ CODING_SYSTEM_EOL_CR (XCODING_SYSTEM (codesys)) #ifdef MULE #define XCODING_SYSTEM_ISO2022_INITIAL_CHARSET(codesys, g) \ CODING_SYSTEM_ISO2022_INITIAL_CHARSET (XCODING_SYSTEM (codesys), g) #define XCODING_SYSTEM_ISO2022_FORCE_CHARSET_ON_OUTPUT(codesys, g) \ CODING_SYSTEM_ISO2022_FORCE_CHARSET_ON_OUTPUT (XCODING_SYSTEM (codesys), g) #define XCODING_SYSTEM_ISO2022_SHORT(codesys) \ CODING_SYSTEM_ISO2022_SHORT (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_ISO2022_NO_ASCII_EOL(codesys) \ CODING_SYSTEM_ISO2022_NO_ASCII_EOL (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_ISO2022_NO_ASCII_CNTL(codesys) \ CODING_SYSTEM_ISO2022_NO_ASCII_CNTL (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_ISO2022_SEVEN(codesys) \ CODING_SYSTEM_ISO2022_SEVEN (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_ISO2022_LOCK_SHIFT(codesys) \ CODING_SYSTEM_ISO2022_LOCK_SHIFT (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_ISO2022_NO_ISO6429(codesys) \ CODING_SYSTEM_ISO2022_NO_ISO6429 (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_ISO2022_ESCAPE_QUOTED(codesys) \ CODING_SYSTEM_ISO2022_ESCAPE_QUOTED (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_CCL_DECODE(codesys) \ CODING_SYSTEM_CCL_DECODE (XCODING_SYSTEM (codesys)) #define XCODING_SYSTEM_CCL_ENCODE(codesys) \ CODING_SYSTEM_CCL_ENCODE (XCODING_SYSTEM (codesys)) #endif /* MULE */ EXFUN (Fcoding_category_list, 0); EXFUN (Fcoding_category_system, 1); EXFUN (Fcoding_priority_list, 0); EXFUN (Fcoding_system_doc_string, 1); EXFUN (Fcoding_system_list, 0); EXFUN (Fcoding_system_name, 1); EXFUN (Fcoding_system_p, 1); EXFUN (Fcoding_system_property, 2); EXFUN (Fcoding_system_type, 1); EXFUN (Fcopy_coding_system, 2); EXFUN (Fdecode_big5_char, 1); EXFUN (Fdecode_coding_region, 4); EXFUN (Fdecode_shift_jis_char, 1); EXFUN (Fdetect_coding_region, 3); EXFUN (Fencode_big5_char, 1); EXFUN (Fencode_coding_region, 4); EXFUN (Fencode_shift_jis_char, 1); EXFUN (Ffind_coding_system, 1); EXFUN (Fget_coding_system, 1); EXFUN (Fmake_coding_system, 4); EXFUN (Fset_coding_category_system, 2); EXFUN (Fset_coding_priority_list, 1); EXFUN (Fsubsidiary_coding_system, 2); extern Lisp_Object Qucs4, Qutf8; extern Lisp_Object Qbig5, Qccl, Qcharset_g0; extern Lisp_Object Qcharset_g1, Qcharset_g2, Qcharset_g3, Qcoding_system_error; extern Lisp_Object Qcoding_systemp, Qcr, Qcrlf, Qdecode, Qencode; extern Lisp_Object Qeol_cr, Qeol_crlf, Qeol_lf, Qeol_type, Qescape_quoted; extern Lisp_Object Qforce_g0_on_output, Qforce_g1_on_output; extern Lisp_Object Qforce_g2_on_output, Qforce_g3_on_output; extern Lisp_Object Qinput_charset_conversion, Qiso2022, Qlf, Qlock_shift; extern Lisp_Object Qmnemonic, Qno_ascii_cntl, Qno_ascii_eol, Qno_conversion; extern Lisp_Object Qraw_text; extern Lisp_Object Qno_iso6429, Qoutput_charset_conversion; extern Lisp_Object Qpost_read_conversion, Qpre_write_conversion, Qseven; extern Lisp_Object Qshift_jis, Qshort, Vcoding_system_for_read; extern Lisp_Object Vcoding_system_for_write, Vcoding_system_hash_table; extern Lisp_Object Vfile_name_coding_system, Vkeyboard_coding_system; extern Lisp_Object Vterminal_coding_system; /* Flags indicating current state while converting code. */ /* Used by everyone. */ #define CODING_STATE_END (1 << 0) /* If set, this is the last chunk of data being processed. When this is finished, output any necessary terminating control characters, escape sequences, etc. */ #define CODING_STATE_CR (1 << 1) /* If set, we just saw a CR. */ /* Used by Big 5 on output. */ #ifdef MULE #define CODING_STATE_BIG5_1 (1 << 2) /* If set, we just encountered LEADING_BYTE_BIG5_1. */ #define CODING_STATE_BIG5_2 (1 << 3) /* If set, we just encountered LEADING_BYTE_BIG5_2. */ /* Used by ISO2022 on input and output. */ #define CODING_STATE_R2L (1 << 4) /* If set, the current directionality is right-to-left. Otherwise, it's left-to-right. */ /* Used by ISO2022 on input. */ #define CODING_STATE_ESCAPE (1 << 5) /* If set, we're currently parsing an escape sequence and the upper 16 bits should be looked at to indicate what partial escape sequence we've seen so far. Otherwise, we're running through actual text. */ #define CODING_STATE_SS2 (1 << 6) /* If set, G2 is invoked into GL, but only for the next character. */ #define CODING_STATE_SS3 (1 << 7) /* If set, G3 is invoked into GL, but only for the next character. If both CODING_STATE_SS2 and CODING_STATE_SS3 are set, CODING_STATE_SS2 overrides; but this probably indicates an error in the text encoding. */ #ifdef ENABLE_COMPOSITE_CHARS #define CODING_STATE_COMPOSITE (1 << 8) /* If set, we're currently processing a composite character (i.e. a character constructed by overstriking two or more characters). */ #endif /* ENABLE_COMPOSITE_CHARS */ /* CODING_STATE_ISO2022_LOCK is the mask of flags that remain on until explicitly turned off when in the ISO2022 encoder/decoder. Other flags are turned off at the end of processing each character or escape sequence. */ #ifdef ENABLE_COMPOSITE_CHARS # define CODING_STATE_ISO2022_LOCK \ (CODING_STATE_END | CODING_STATE_COMPOSITE | CODING_STATE_R2L) #else # define CODING_STATE_ISO2022_LOCK (CODING_STATE_END | CODING_STATE_R2L) #endif #define CODING_STATE_BIG5_LOCK CODING_STATE_END /* Flags indicating what we've seen so far when parsing an ISO2022 escape sequence. */ enum iso_esc_flag { /* Partial sequences */ ISO_ESC_NOTHING, /* Nothing has been seen. */ ISO_ESC, /* We've seen ESC. */ ISO_ESC_2_4, /* We've seen ESC $. This indicates that we're designating a multi-byte, rather than a single-byte, character set. */ ISO_ESC_2_8, /* We've seen ESC 0x28, i.e. ESC (. This means designate a 94-character character set into G0. */ ISO_ESC_2_9, /* We've seen ESC 0x29 -- designate a 94-character character set into G1. */ ISO_ESC_2_10, /* We've seen ESC 0x2A. */ ISO_ESC_2_11, /* We've seen ESC 0x2B. */ ISO_ESC_2_12, /* We've seen ESC 0x2C -- designate a 96-character character set into G0. (This is not ISO2022-standard. The following 96-character control sequences are standard, though.) */ ISO_ESC_2_13, /* We've seen ESC 0x2D -- designate a 96-character character set into G1. */ ISO_ESC_2_14, /* We've seen ESC 0x2E. */ ISO_ESC_2_15, /* We've seen ESC 0x2F. */ ISO_ESC_2_4_8, /* We've seen ESC $ 0x28 -- designate a 94^N character set into G0. */ ISO_ESC_2_4_9, /* We've seen ESC $ 0x29. */ ISO_ESC_2_4_10, /* We've seen ESC $ 0x2A. */ ISO_ESC_2_4_11, /* We've seen ESC $ 0x2B. */ ISO_ESC_2_4_12, /* We've seen ESC $ 0x2C. */ ISO_ESC_2_4_13, /* We've seen ESC $ 0x2D. */ ISO_ESC_2_4_14, /* We've seen ESC $ 0x2E. */ ISO_ESC_2_4_15, /* We've seen ESC $ 0x2F. */ ISO_ESC_5_11, /* We've seen ESC [ or 0x9B. This starts a directionality-control sequence. The next character must be 0, 1, 2, or ]. */ ISO_ESC_5_11_0, /* We've seen 0x9B 0. The next character must be ]. */ ISO_ESC_5_11_1, /* We've seen 0x9B 1. The next character must be ]. */ ISO_ESC_5_11_2, /* We've seen 0x9B 2. The next character must be ]. */ /* Full sequences. */ #ifdef ENABLE_COMPOSITE_CHARS ISO_ESC_START_COMPOSITE, /* Private usage for START COMPOSING */ ISO_ESC_END_COMPOSITE, /* Private usage for END COMPOSING */ #endif /* ENABLE_COMPOSITE_CHARS */ ISO_ESC_SINGLE_SHIFT, /* We've seen a complete single-shift sequence. */ ISO_ESC_LOCKING_SHIFT,/* We've seen a complete locking-shift sequence. */ ISO_ESC_DESIGNATE, /* We've seen a complete designation sequence. */ ISO_ESC_DIRECTIONALITY,/* We've seen a complete ISO6429 directionality sequence. */ ISO_ESC_LITERAL /* We've seen a literal character ala escape-quoting. */ }; /* Macros to define code of control characters for ISO2022's functions. */ /* code */ /* function */ #define ISO_CODE_LF 0x0A /* line-feed */ #define ISO_CODE_CR 0x0D /* carriage-return */ #define ISO_CODE_SO 0x0E /* shift-out */ #define ISO_CODE_SI 0x0F /* shift-in */ #define ISO_CODE_ESC 0x1B /* escape */ #define ISO_CODE_DEL 0x7F /* delete */ #define ISO_CODE_SS2 0x8E /* single-shift-2 */ #define ISO_CODE_SS3 0x8F /* single-shift-3 */ #define ISO_CODE_CSI 0x9B /* control-sequence-introduce */ #endif /* MULE */ /* Distinguishable categories of encodings. This list determines the initial priority of the categories. For better or worse, currently Mule files are encoded in 7-bit ISO 2022. For this reason, under Mule ISO_7 gets highest priority. Putting NO_CONVERSION second prevents "binary corruption" in the default case in all but the (presumably) extremely rare case of a binary file which contains redundant escape sequences but no 8-bit characters. The remaining priorities are based on perceived "internationalization political correctness." An exception is UCS-4 at the bottom, since basically everything is compatible with UCS-4, but it is likely to be very rare as an external encoding. */ enum coding_category_type { /* must be a contiguous range of values 0 -- CODING_CATEGORY_LAST - 1 */ #ifdef MULE CODING_CATEGORY_ISO_7, /* ISO2022 system using only seven-bit bytes, no locking shift */ CODING_CATEGORY_NO_CONVERSION, CODING_CATEGORY_UTF8, CODING_CATEGORY_ISO_8_1, /* ISO2022 system using eight-bit bytes, no locking shift, no designation sequences, one-dimension characters in the upper half. */ CODING_CATEGORY_ISO_8_2, /* ISO2022 system using eight-bit bytes, no locking shift, no designation sequences, two-dimension characters in the upper half. */ CODING_CATEGORY_ISO_8_DESIGNATE, /* ISO2022 system using eight-bit bytes, no locking shift, no single shift, using designation to switch charsets */ CODING_CATEGORY_ISO_LOCK_SHIFT, /* ISO2022 system using locking shift */ CODING_CATEGORY_SHIFT_JIS, CODING_CATEGORY_BIG5, CODING_CATEGORY_UCS4, #else /* not MULE */ CODING_CATEGORY_NO_CONVERSION, #endif /* MULE */ CODING_CATEGORY_LAST /* not a real coding category */ }; #ifdef MULE #define CODING_CATEGORY_SHIFT_JIS_MASK \ (1 << CODING_CATEGORY_SHIFT_JIS) #define CODING_CATEGORY_ISO_7_MASK \ (1 << CODING_CATEGORY_ISO_7) #define CODING_CATEGORY_ISO_8_DESIGNATE_MASK \ (1 << CODING_CATEGORY_ISO_8_DESIGNATE) #define CODING_CATEGORY_ISO_8_1_MASK \ (1 << CODING_CATEGORY_ISO_8_1) #define CODING_CATEGORY_ISO_8_2_MASK \ (1 << CODING_CATEGORY_ISO_8_2) #define CODING_CATEGORY_ISO_LOCK_SHIFT_MASK \ (1 << CODING_CATEGORY_ISO_LOCK_SHIFT) #define CODING_CATEGORY_BIG5_MASK \ (1 << CODING_CATEGORY_BIG5) #define CODING_CATEGORY_UCS4_MASK \ (1 << CODING_CATEGORY_UCS4) #define CODING_CATEGORY_UTF8_MASK \ (1 << CODING_CATEGORY_UTF8) #endif #define CODING_CATEGORY_NO_CONVERSION_MASK \ (1 << CODING_CATEGORY_NO_CONVERSION) #define CODING_CATEGORY_NOT_FINISHED_MASK \ (1 << 30) #ifdef MULE /* Convert shift-JIS code (sj1, sj2) into internal string representation (c1, c2). (The leading byte is assumed.) */ #define DECODE_SJIS(sj1, sj2, c1, c2) \ do { \ int I1 = sj1, I2 = sj2; \ if (I2 >= 0x9f) \ c1 = (I1 << 1) - ((I1 >= 0xe0) ? 0xe0 : 0x60), \ c2 = I2 + 2; \ else \ c1 = (I1 << 1) - ((I1 >= 0xe0) ? 0xe1 : 0x61), \ c2 = I2 + ((I2 >= 0x7f) ? 0x60 : 0x61); \ } while (0) /* Convert the internal string representation of a Shift-JIS character (c1, c2) into Shift-JIS code (sj1, sj2). The leading byte is assumed. */ #define ENCODE_SJIS(c1, c2, sj1, sj2) \ do { \ int I1 = c1, I2 = c2; \ if (I1 & 1) \ sj1 = (I1 >> 1) + ((I1 < 0xdf) ? 0x31 : 0x71), \ sj2 = I2 - ((I2 >= 0xe0) ? 0x60 : 0x61); \ else \ sj1 = (I1 >> 1) + ((I1 < 0xdf) ? 0x30 : 0x70), \ sj2 = I2 - 2; \ } while (0) #endif /* MULE */ Lisp_Object make_decoding_input_stream (Lstream *stream, Lisp_Object codesys); Lisp_Object make_encoding_input_stream (Lstream *stream, Lisp_Object codesys); Lisp_Object make_decoding_output_stream (Lstream *stream, Lisp_Object codesys); Lisp_Object make_encoding_output_stream (Lstream *stream, Lisp_Object codesys); Lisp_Object decoding_stream_coding_system (Lstream *stream); Lisp_Object encoding_stream_coding_system (Lstream *stream); void set_decoding_stream_coding_system (Lstream *stream, Lisp_Object codesys); void set_encoding_stream_coding_system (Lstream *stream, Lisp_Object codesys); void determine_real_coding_system (Lstream *stream, Lisp_Object *codesys_in_out, eol_type_t *eol_type_in_out); #ifndef MULE #define MIN_LEADING_BYTE 0x80 /* These need special treatment in a string and/or character */ #ifdef ENABLE_COMPOSITE_CHARS #define LEADING_BYTE_COMPOSITE 0x80 /* for a composite character */ #endif #define LEADING_BYTE_CONTROL_1 0x8F /* represent normal 80-9F */ #define LEADING_BYTE_LATIN_ISO8859_1 0x81 /* Right half of ISO 8859-1 */ #define BYTE_C1_P(c) ((unsigned int) ((unsigned int) (c) - 0x80) < 0x20) #define INTBYTE_FIRST_BYTE_P(c) ((c) < 0xA0) #define INTBYTE_LEADING_BYTE_P(c) BYTE_C1_P (c) #endif /* not MULE */ #endif /* INCLUDED_file_coding_h_ */