|
428
|
1 @c -*-texinfo-*-
|
|
|
2 @c This is part of the XEmacs Lisp Reference Manual.
|
|
775
|
3 @c Copyright (C) 1996 Ben Wing, 2001-2002 Free Software Foundation.
|
|
428
|
4 @c See the file lispref.texi for copying conditions.
|
|
|
5 @setfilename ../../info/internationalization.info
|
|
|
6 @node MULE, Tips, Internationalization, top
|
|
|
7 @chapter MULE
|
|
|
8
|
|
442
|
9 @dfn{MULE} is the name originally given to the version of GNU Emacs
|
|
428
|
10 extended for multi-lingual (and in particular Asian-language) support.
|
|
442
|
11 ``MULE'' is short for ``MUlti-Lingual Emacs''. It is an extension and
|
|
|
12 complete rewrite of Nemacs (``Nihon Emacs'' where ``Nihon'' is the
|
|
|
13 Japanese word for ``Japan''), which only provided support for Japanese.
|
|
|
14 XEmacs refers to its multi-lingual support as @dfn{MULE support} since
|
|
|
15 it is based on @dfn{MULE}.
|
|
428
|
16
|
|
|
17 @menu
|
|
|
18 * Internationalization Terminology::
|
|
|
19 Definition of various internationalization terms.
|
|
|
20 * Charsets:: Sets of related characters.
|
|
|
21 * MULE Characters:: Working with characters in XEmacs/MULE.
|
|
|
22 * Composite Characters:: Making new characters by overstriking other ones.
|
|
|
23 * Coding Systems:: Ways of representing a string of chars using integers.
|
|
|
24 * CCL:: A special language for writing fast converters.
|
|
|
25 * Category Tables:: Subdividing charsets into groups.
|
|
775
|
26 * Unicode Support:: The universal coded character set.
|
|
1183
|
27 * Charset Unification:: Handling overlapping character sets.
|
|
|
28 * Charsets and Coding Systems:: Tables and reference information.
|
|
428
|
29 @end menu
|
|
|
30
|
|
442
|
31 @node Internationalization Terminology, Charsets, , MULE
|
|
428
|
32 @section Internationalization Terminology
|
|
|
33
|
|
442
|
34 In internationalization terminology, a string of text is divided up
|
|
428
|
35 into @dfn{characters}, which are the printable units that make up the
|
|
|
36 text. A single character is (for example) a capital @samp{A}, the
|
|
442
|
37 number @samp{2}, a Katakana character, a Hangul character, a Kanji
|
|
|
38 ideograph (an @dfn{ideograph} is a ``picture'' character, such as is
|
|
|
39 used in Japanese Kanji, Chinese Hanzi, and Korean Hanja; typically there
|
|
|
40 are thousands of such ideographs in each language), etc. The basic
|
|
|
41 property of a character is that it is the smallest unit of text with
|
|
1261
|
42 semantic significance in text processing---i.e., characters are abstract
|
|
|
43 units defined by their meaning, not by their exact appearance.
|
|
442
|
44
|
|
|
45 Human beings normally process text visually, so to a first approximation
|
|
|
46 a character may be identified with its shape. Note that the same
|
|
|
47 character may be drawn by two different people (or in two different
|
|
|
48 fonts) in slightly different ways, although the "basic shape" will be the
|
|
|
49 same. But consider the works of Scott Kim; human beings can recognize
|
|
|
50 hugely variant shapes as the "same" character. Sometimes, especially
|
|
|
51 where characters are extremely complicated to write, completely
|
|
|
52 different shapes may be defined as the "same" character in national
|
|
|
53 standards. The Taiwanese variant of Hanzi is generally the most
|
|
444
|
54 complicated; over the centuries, the Japanese, Koreans, and the People's
|
|
442
|
55 Republic of China have adopted simplifications of the shape, but the
|
|
|
56 line of descent from the original shape is recorded, and the meanings
|
|
|
57 and pronunciation of different forms of the same character are
|
|
|
58 considered to be identical within each language. (Of course, it may
|
|
|
59 take a specialist to recognize the related form; the point is that the
|
|
|
60 relations are standardized, despite the differing shapes.)
|
|
428
|
61
|
|
|
62 In some cases, the differences will be significant enough that it is
|
|
|
63 actually possible to identify two or more distinct shapes that both
|
|
|
64 represent the same character. For example, the lowercase letters
|
|
440
|
65 @samp{a} and @samp{g} each have two distinct possible shapes---the
|
|
428
|
66 @samp{a} can optionally have a curved tail projecting off the top, and
|
|
|
67 the @samp{g} can be formed either of two loops, or of one loop and a
|
|
|
68 tail hanging off the bottom. Such distinct possible shapes of a
|
|
|
69 character are called @dfn{glyphs}. The important characteristic of two
|
|
|
70 glyphs making up the same character is that the choice between one or
|
|
|
71 the other is purely stylistic and has no linguistic effect on a word
|
|
|
72 (this is the reason why a capital @samp{A} and lowercase @samp{a}
|
|
440
|
73 are different characters rather than different glyphs---e.g.
|
|
428
|
74 @samp{Aspen} is a city while @samp{aspen} is a kind of tree).
|
|
|
75
|
|
|
76 Note that @dfn{character} and @dfn{glyph} are used differently
|
|
|
77 here than elsewhere in XEmacs.
|
|
|
78
|
|
442
|
79 A @dfn{character set} is essentially a set of related characters. ASCII,
|
|
428
|
80 for example, is a set of 94 characters (or 128, if you count
|
|
|
81 non-printing characters). Other character sets are ISO8859-1 (ASCII
|
|
|
82 plus various accented characters and other international symbols),
|
|
442
|
83 JIS X 0201 (ASCII, more or less, plus half-width Katakana), JIS X 0208
|
|
|
84 (Japanese Kanji), JIS X 0212 (a second set of less-used Japanese Kanji),
|
|
428
|
85 GB2312 (Mainland Chinese Hanzi), etc.
|
|
|
86
|
|
442
|
87 The definition of a character set will implicitly or explicitly give
|
|
|
88 it an @dfn{ordering}, a way of assigning a number to each character in
|
|
|
89 the set. For many character sets, there is a natural ordering, for
|
|
|
90 example the ``ABC'' ordering of the Roman letters. But it is not clear
|
|
|
91 whether digits should come before or after the letters, and in fact
|
|
|
92 different European languages treat the ordering of accented characters
|
|
|
93 differently. It is useful to use the natural order where available, of
|
|
|
94 course. The number assigned to any particular character is called the
|
|
|
95 character's @dfn{code point}. (Within a given character set, each
|
|
|
96 character has a unique code point. Thus the word "set" is ill-chosen;
|
|
|
97 different orderings of the same characters are different character sets.
|
|
|
98 Identifying characters is simple enough for alphabetic character sets,
|
|
|
99 but the difference in ordering can cause great headaches when the same
|
|
|
100 thousands of characters are used by different cultures as in the Hanzi.)
|
|
428
|
101
|
|
1261
|
102 It's important to understand that a character is defined not by any
|
|
|
103 number attached to it, but by its meaning. For example, ASCII and
|
|
|
104 EBCDIC are two charsets containing exactly the same characters
|
|
|
105 (lowercase and uppercase letters, numbers 0 through 9, particular
|
|
|
106 punctuation marks) but with different numberings. The @samp{comma}
|
|
|
107 character in ASCII and EBCDIC, for instance, is the same character
|
|
|
108 despite having a different numbering. Conversely, when comparing ASCII
|
|
|
109 and JIS-Roman, which look the same except that the latter has a yen sign
|
|
|
110 substituted for the backslash, we would say that the backslash and yen
|
|
|
111 sign are @emph{not} the same characters, despite having the same number
|
|
|
112 (95) and despite the fact that all other characters are present in both
|
|
|
113 charsets, with the same numbering. ASCII and JIS-Roman, then, do
|
|
|
114 @emph{not} have exactly the same characters in them (ASCII has a
|
|
|
115 backslash character but no yen-sign character, and vice-versa for
|
|
|
116 JIS-Roman), unlike ASCII and EBCDIC, even though the numberings in ASCII
|
|
|
117 and JIS-Roman are closer.
|
|
|
118
|
|
|
119 Sometimes, a code point is not a single number, but instead a group of
|
|
|
120 numbers, called @dfn{position codes}. In such cases, the number of
|
|
|
121 position codes required to index a particular character in a character
|
|
|
122 set is called the @dfn{dimension} of the character set. Character sets
|
|
|
123 indexed by more than one position code typically use byte-sized position
|
|
|
124 codes. Small character sets, e.g. ASCII, invariably use a single
|
|
|
125 position code, but for larger character sets, the choice of whether to
|
|
|
126 use multiple position codes or a single large (16-bit or 32-bit) number
|
|
|
127 is arbitrary. Unicode typically uses a single large number, but
|
|
|
128 language-specific or "national" character sets often use multiple
|
|
|
129 (usually two) position codes. For example, JIS X 0208, i.e. Japanese
|
|
|
130 Kanji, has thousands of characters, and is of dimension two -- every
|
|
|
131 character is indexed by two position codes, each in the range 1 through
|
|
|
132 94. (This number ``94'' is not a coincidence; it is the same as the
|
|
|
133 number of printable characters in ASCII, and was chosen so that JIS
|
|
|
134 characters could be directly encoded using two printable ASCII
|
|
|
135 characters.) Note that the choice of the range here is somewhat
|
|
|
136 arbitrary -- it could just as easily be 0 through 93, 2 through 95, etc.
|
|
|
137 In fact, the range for JIS position codes (and for other character sets
|
|
|
138 modeled after it) is often given as range 33 through 126, so as to
|
|
|
139 directly match ASCII printing characters.
|
|
428
|
140
|
|
|
141 An @dfn{encoding} is a way of numerically representing characters from
|
|
|
142 one or more character sets into a stream of like-sized numerical values
|
|
1261
|
143 called @dfn{words} -- typically 8-bit bytes, but sometimes 16-bit or
|
|
|
144 32-bit quantities. It's very important to clearly distinguish between
|
|
|
145 charsets and encodings. For a simple charset like ASCII, there is only
|
|
|
146 one encoding normally used -- each character is represented by a single
|
|
|
147 byte, with the same value as its code point. For more complicated
|
|
|
148 charsets, however, or when a single encoding needs to represent more
|
|
|
149 than charset, things are not so obvious. Unicode version 2, for
|
|
|
150 example, is a large charset with thousands of characters, each indexed
|
|
|
151 by a 16-bit number, often represented in hex, e.g. 0x05D0 for the Hebrew
|
|
|
152 letter "aleph". One obvious encoding (actually two encodings, depending
|
|
|
153 on which of the two possible byte orderings is chosen) simply uses two
|
|
|
154 bytes per character. This encoding is convenient for internal
|
|
|
155 processing of Unicode text; however, it's incompatible with ASCII, and
|
|
|
156 thus external text (files, e-mail, etc.) that is encoded this way is
|
|
|
157 completely uninterpretable by programs lacking Unicode support. For
|
|
|
158 this reason, a different, ASCII-compatible encoding, e.g. UTF-8, is
|
|
|
159 usually used for external text. UTF-8 represents Unicode characters
|
|
|
160 with one to three bytes (often extended to six bytes to handle
|
|
|
161 characters with up to 31-bit indices). Unicode characters 00 to 7F
|
|
|
162 (identical with ASCII) are directly represented with one byte, and other
|
|
|
163 characters with two or more bytes, each in the range 80 to FF.
|
|
|
164 Applications that don't understand Unicode will still be able to process
|
|
|
165 ASCII characters represented in UTF-8-encoded text, and will typically
|
|
|
166 ignore (and hopefully preserve) the high-bit characters.
|
|
|
167
|
|
|
168 Naive use of code points is also not possible if more than one
|
|
|
169 character set is to be used in the encoding. For example, printed
|
|
442
|
170 Japanese text typically requires characters from multiple character sets
|
|
|
171 -- ASCII, JIS X 0208, and JIS X 0212, to be specific. Each of these is
|
|
1261
|
172 indexed using one or more position codes in the range 1 through 94 (or
|
|
|
173 33 through 126), so the position codes could not be used directly or
|
|
|
174 there would be no way to tell which character was meant. Different
|
|
|
175 Japanese encodings handle this differently -- JIS uses special escape
|
|
|
176 characters to denote different character sets; EUC sets the high bit of
|
|
|
177 the position codes for JIS X 0208 and JIS X 0212, and puts a special
|
|
|
178 extra byte before each JIS X 0212 character; etc.
|
|
|
179
|
|
|
180 The encodings described above are all 7-bit or 8-bit encodings. The
|
|
|
181 fixed-width Unicode encoding previous described, however, is sometimes
|
|
|
182 considered to be a 16-bit encoding, in which case the issue of byte
|
|
|
183 ordering does not come up. (Imagine, for example, that the text is
|
|
|
184 represented as an array of shorts.) Similarly, Unicode version 3 (which
|
|
|
185 has characters with indices above 0xFFFF), and other very large
|
|
|
186 character sets, may be represented internally as 32-bit encodings,
|
|
|
187 i.e. arrays of ints. However, it does not make too much sense to talk
|
|
|
188 about 16-bit or 32-bit encodings for external data, since nowadays 8-bit
|
|
|
189 data is a universal standard -- the closest you can get is fixed-width
|
|
|
190 encodings using two or four bytes to encode 16-bit or 32-bit values. (A
|
|
|
191 "7-bit" encoding is used when it cannot be guaranteed that the high bit
|
|
|
192 of 8-bit data will be correctly preserved. Some e-mail gateways, for
|
|
|
193 example, strip the high bit of text passing through them. These same
|
|
|
194 gateways often handle non-printable characters incorrectly, and so 7-bit
|
|
|
195 encodings usually avoid using bytes with such values.)
|
|
442
|
196
|
|
|
197 A general method of handling text using multiple character sets
|
|
|
198 (whether for multilingual text, or simply text in an extremely
|
|
|
199 complicated single language like Japanese) is defined in the
|
|
|
200 international standard ISO 2022. ISO 2022 will be discussed in more
|
|
|
201 detail later (@pxref{ISO 2022}), but for now suffice it to say that text
|
|
|
202 needs control functions (at least spacing), and if escape sequences are
|
|
|
203 to be used, an escape sequence introducer. It was decided to make all
|
|
|
204 text streams compatible with ASCII in the sense that the codes 0--31
|
|
|
205 (and 128-159) would always be control codes, never graphic characters,
|
|
|
206 and where defined by the character set the @samp{SPC} character would be
|
|
|
207 assigned code 32, and @samp{DEL} would be assigned 127. Thus there are
|
|
|
208 94 code points remaining if 7 bits are used. This is the reason that
|
|
|
209 most character sets are defined using position codes in the range 1
|
|
|
210 through 94. Then ISO 2022 compatible encodings are produced by shifting
|
|
|
211 the position codes 1 to 94 into character codes 33 to 126, or (if 8 bit
|
|
|
212 codes are available) into character codes 161 to 254.
|
|
428
|
213
|
|
|
214 Encodings are classified as either @dfn{modal} or @dfn{non-modal}. In
|
|
442
|
215 a @dfn{modal encoding}, there are multiple states that the encoding can
|
|
|
216 be in, and the interpretation of the values in the stream depends on the
|
|
428
|
217 current global state of the encoding. Special values in the encoding,
|
|
|
218 called @dfn{escape sequences}, are used to change the global state.
|
|
|
219 JIS, for example, is a modal encoding. The bytes @samp{ESC $ B}
|
|
|
220 indicate that, from then on, bytes are to be interpreted as position
|
|
442
|
221 codes for JIS X 0208, rather than as ASCII. This effect is cancelled
|
|
428
|
222 using the bytes @samp{ESC ( B}, which mean ``switch from whatever the
|
|
442
|
223 current state is to ASCII''. To switch to JIS X 0212, the escape
|
|
|
224 sequence @samp{ESC $ ( D}. (Note that here, as is common, the escape
|
|
|
225 sequences do in fact begin with @samp{ESC}. This is not necessarily the
|
|
|
226 case, however. Some encodings use control characters called "locking
|
|
|
227 shifts" (effect persists until cancelled) to switch character sets.)
|
|
428
|
228
|
|
442
|
229 A @dfn{non-modal encoding} has no global state that extends past the
|
|
428
|
230 character currently being interpreted. EUC, for example, is a
|
|
442
|
231 non-modal encoding. Characters in JIS X 0208 are encoded by setting
|
|
|
232 the high bit of the position codes, and characters in JIS X 0212 are
|
|
428
|
233 encoded by doing the same but also prefixing the character with the
|
|
|
234 byte 0x8F.
|
|
|
235
|
|
|
236 The advantage of a modal encoding is that it is generally more
|
|
442
|
237 space-efficient, and is easily extendible because there are essentially
|
|
428
|
238 an arbitrary number of escape sequences that can be created. The
|
|
|
239 disadvantage, however, is that it is much more difficult to work with
|
|
|
240 if it is not being processed in a sequential manner. In the non-modal
|
|
|
241 EUC encoding, for example, the byte 0x41 always refers to the letter
|
|
|
242 @samp{A}; whereas in JIS, it could either be the letter @samp{A}, or
|
|
442
|
243 one of the two position codes in a JIS X 0208 character, or one of the
|
|
|
244 two position codes in a JIS X 0212 character. Determining exactly which
|
|
428
|
245 one is meant could be difficult and time-consuming if the previous
|
|
442
|
246 bytes in the string have not already been processed, or impossible if
|
|
|
247 they are drawn from an external stream that cannot be rewound.
|
|
428
|
248
|
|
|
249 Non-modal encodings are further divided into @dfn{fixed-width} and
|
|
|
250 @dfn{variable-width} formats. A fixed-width encoding always uses
|
|
|
251 the same number of words per character, whereas a variable-width
|
|
|
252 encoding does not. EUC is a good example of a variable-width
|
|
|
253 encoding: one to three bytes are used per character, depending on
|
|
|
254 the character set. 16-bit and 32-bit encodings are nearly always
|
|
|
255 fixed-width, and this is in fact one of the main reasons for using
|
|
|
256 an encoding with a larger word size. The advantages of fixed-width
|
|
|
257 encodings should be obvious. The advantages of variable-width
|
|
|
258 encodings are that they are generally more space-efficient and allow
|
|
442
|
259 for compatibility with existing 8-bit encodings such as ASCII. (For
|
|
|
260 example, in Unicode ASCII characters are simply promoted to a 16-bit
|
|
|
261 representation. That means that every ASCII character contains a
|
|
|
262 @samp{NUL} byte; evidently all of the standard string manipulation
|
|
|
263 functions will lose badly in a fixed-width Unicode environment.)
|
|
428
|
264
|
|
442
|
265 The bytes in an 8-bit encoding are often referred to as @dfn{octets}
|
|
|
266 rather than simply as bytes. This terminology dates back to the days
|
|
|
267 before 8-bit bytes were universal, when some computers had 9-bit bytes,
|
|
|
268 others had 10-bit bytes, etc.
|
|
428
|
269
|
|
442
|
270 @node Charsets, MULE Characters, Internationalization Terminology, MULE
|
|
428
|
271 @section Charsets
|
|
|
272
|
|
|
273 A @dfn{charset} in MULE is an object that encapsulates a
|
|
|
274 particular character set as well as an ordering of those characters.
|
|
|
275 Charsets are permanent objects and are named using symbols, like
|
|
|
276 faces.
|
|
|
277
|
|
|
278 @defun charsetp object
|
|
|
279 This function returns non-@code{nil} if @var{object} is a charset.
|
|
|
280 @end defun
|
|
|
281
|
|
|
282 @menu
|
|
|
283 * Charset Properties:: Properties of a charset.
|
|
|
284 * Basic Charset Functions:: Functions for working with charsets.
|
|
|
285 * Charset Property Functions:: Functions for accessing charset properties.
|
|
|
286 * Predefined Charsets:: Predefined charset objects.
|
|
|
287 @end menu
|
|
|
288
|
|
442
|
289 @node Charset Properties, Basic Charset Functions, , Charsets
|
|
428
|
290 @subsection Charset Properties
|
|
|
291
|
|
|
292 Charsets have the following properties:
|
|
|
293
|
|
|
294 @table @code
|
|
|
295 @item name
|
|
|
296 A symbol naming the charset. Every charset must have a different name;
|
|
|
297 this allows a charset to be referred to using its name rather than
|
|
|
298 the actual charset object.
|
|
|
299 @item doc-string
|
|
|
300 A documentation string describing the charset.
|
|
|
301 @item registry
|
|
|
302 A regular expression matching the font registry field for this character
|
|
|
303 set. For example, both the @code{ascii} and @code{latin-iso8859-1}
|
|
|
304 charsets use the registry @code{"ISO8859-1"}. This field is used to
|
|
|
305 choose an appropriate font when the user gives a general font
|
|
|
306 specification such as @samp{-*-courier-medium-r-*-140-*}, i.e. a
|
|
|
307 14-point upright medium-weight Courier font.
|
|
|
308 @item dimension
|
|
|
309 Number of position codes used to index a character in the character set.
|
|
|
310 XEmacs/MULE can only handle character sets of dimension 1 or 2.
|
|
|
311 This property defaults to 1.
|
|
|
312 @item chars
|
|
|
313 Number of characters in each dimension. In XEmacs/MULE, the only
|
|
|
314 allowed values are 94 or 96. (There are a couple of pre-defined
|
|
|
315 character sets, such as ASCII, that do not follow this, but you cannot
|
|
|
316 define new ones like this.) Defaults to 94. Note that if the dimension
|
|
|
317 is 2, the character set thus described is 94x94 or 96x96.
|
|
|
318 @item columns
|
|
|
319 Number of columns used to display a character in this charset.
|
|
|
320 Only used in TTY mode. (Under X, the actual width of a character
|
|
|
321 can be derived from the font used to display the characters.)
|
|
|
322 If unspecified, defaults to the dimension. (This is almost
|
|
|
323 always the correct value, because character sets with dimension 2
|
|
|
324 are usually ideograph character sets, which need two columns to
|
|
|
325 display the intricate ideographs.)
|
|
|
326 @item direction
|
|
|
327 A symbol, either @code{l2r} (left-to-right) or @code{r2l}
|
|
|
328 (right-to-left). Defaults to @code{l2r}. This specifies the
|
|
|
329 direction that the text should be displayed in, and will be
|
|
|
330 left-to-right for most charsets but right-to-left for Hebrew
|
|
|
331 and Arabic. (Right-to-left display is not currently implemented.)
|
|
|
332 @item final
|
|
|
333 Final byte of the standard ISO 2022 escape sequence designating this
|
|
|
334 charset. Must be supplied. Each combination of (@var{dimension},
|
|
|
335 @var{chars}) defines a separate namespace for final bytes, and each
|
|
|
336 charset within a particular namespace must have a different final byte.
|
|
|
337 Note that ISO 2022 restricts the final byte to the range 0x30 - 0x7E if
|
|
|
338 dimension == 1, and 0x30 - 0x5F if dimension == 2. Note also that final
|
|
|
339 bytes in the range 0x30 - 0x3F are reserved for user-defined (not
|
|
|
340 official) character sets. For more information on ISO 2022, see @ref{Coding
|
|
|
341 Systems}.
|
|
|
342 @item graphic
|
|
|
343 0 (use left half of font on output) or 1 (use right half of font on
|
|
|
344 output). Defaults to 0. This specifies how to convert the position
|
|
|
345 codes that index a character in a character set into an index into the
|
|
|
346 font used to display the character set. With @code{graphic} set to 0,
|
|
|
347 position codes 33 through 126 map to font indices 33 through 126; with
|
|
|
348 it set to 1, position codes 33 through 126 map to font indices 161
|
|
|
349 through 254 (i.e. the same number but with the high bit set). For
|
|
|
350 example, for a font whose registry is ISO8859-1, the left half of the
|
|
|
351 font (octets 0x20 - 0x7F) is the @code{ascii} charset, while the right
|
|
|
352 half (octets 0xA0 - 0xFF) is the @code{latin-iso8859-1} charset.
|
|
|
353 @item ccl-program
|
|
|
354 A compiled CCL program used to convert a character in this charset into
|
|
|
355 an index into the font. This is in addition to the @code{graphic}
|
|
|
356 property. If a CCL program is defined, the position codes of a
|
|
|
357 character will first be processed according to @code{graphic} and
|
|
|
358 then passed through the CCL program, with the resulting values used
|
|
|
359 to index the font.
|
|
|
360
|
|
442
|
361 This is used, for example, in the Big5 character set (used in Taiwan).
|
|
428
|
362 This character set is not ISO-2022-compliant, and its size (94x157) does
|
|
|
363 not fit within the maximum 96x96 size of ISO-2022-compliant character
|
|
|
364 sets. As a result, XEmacs/MULE splits it (in a rather complex fashion,
|
|
|
365 so as to group the most commonly used characters together) into two
|
|
|
366 charset objects (@code{big5-1} and @code{big5-2}), each of size 94x94,
|
|
|
367 and each charset object uses a CCL program to convert the modified
|
|
|
368 position codes back into standard Big5 indices to retrieve a character
|
|
|
369 from a Big5 font.
|
|
|
370 @end table
|
|
|
371
|
|
442
|
372 Most of the above properties can only be set when the charset is
|
|
|
373 initialized, and cannot be changed later.
|
|
|
374 @xref{Charset Property Functions}.
|
|
428
|
375
|
|
442
|
376 @node Basic Charset Functions, Charset Property Functions, Charset Properties, Charsets
|
|
428
|
377 @subsection Basic Charset Functions
|
|
|
378
|
|
|
379 @defun find-charset charset-or-name
|
|
|
380 This function retrieves the charset of the given name. If
|
|
|
381 @var{charset-or-name} is a charset object, it is simply returned.
|
|
|
382 Otherwise, @var{charset-or-name} should be a symbol. If there is no
|
|
|
383 such charset, @code{nil} is returned. Otherwise the associated charset
|
|
|
384 object is returned.
|
|
|
385 @end defun
|
|
|
386
|
|
|
387 @defun get-charset name
|
|
|
388 This function retrieves the charset of the given name. Same as
|
|
|
389 @code{find-charset} except an error is signalled if there is no such
|
|
|
390 charset instead of returning @code{nil}.
|
|
|
391 @end defun
|
|
|
392
|
|
|
393 @defun charset-list
|
|
|
394 This function returns a list of the names of all defined charsets.
|
|
|
395 @end defun
|
|
|
396
|
|
|
397 @defun make-charset name doc-string props
|
|
|
398 This function defines a new character set. This function is for use
|
|
442
|
399 with MULE support. @var{name} is a symbol, the name by which the
|
|
428
|
400 character set is normally referred. @var{doc-string} is a string
|
|
|
401 describing the character set. @var{props} is a property list,
|
|
|
402 describing the specific nature of the character set. The recognized
|
|
|
403 properties are @code{registry}, @code{dimension}, @code{columns},
|
|
|
404 @code{chars}, @code{final}, @code{graphic}, @code{direction}, and
|
|
|
405 @code{ccl-program}, as previously described.
|
|
|
406 @end defun
|
|
|
407
|
|
|
408 @defun make-reverse-direction-charset charset new-name
|
|
|
409 This function makes a charset equivalent to @var{charset} but which goes
|
|
|
410 in the opposite direction. @var{new-name} is the name of the new
|
|
|
411 charset. The new charset is returned.
|
|
|
412 @end defun
|
|
|
413
|
|
|
414 @defun charset-from-attributes dimension chars final &optional direction
|
|
|
415 This function returns a charset with the given @var{dimension},
|
|
|
416 @var{chars}, @var{final}, and @var{direction}. If @var{direction} is
|
|
|
417 omitted, both directions will be checked (left-to-right will be returned
|
|
|
418 if character sets exist for both directions).
|
|
|
419 @end defun
|
|
|
420
|
|
|
421 @defun charset-reverse-direction-charset charset
|
|
|
422 This function returns the charset (if any) with the same dimension,
|
|
|
423 number of characters, and final byte as @var{charset}, but which is
|
|
|
424 displayed in the opposite direction.
|
|
|
425 @end defun
|
|
|
426
|
|
442
|
427 @node Charset Property Functions, Predefined Charsets, Basic Charset Functions, Charsets
|
|
428
|
428 @subsection Charset Property Functions
|
|
|
429
|
|
442
|
430 All of these functions accept either a charset name or charset object.
|
|
428
|
431
|
|
|
432 @defun charset-property charset prop
|
|
|
433 This function returns property @var{prop} of @var{charset}.
|
|
|
434 @xref{Charset Properties}.
|
|
|
435 @end defun
|
|
|
436
|
|
442
|
437 Convenience functions are also provided for retrieving individual
|
|
428
|
438 properties of a charset.
|
|
|
439
|
|
|
440 @defun charset-name charset
|
|
|
441 This function returns the name of @var{charset}. This will be a symbol.
|
|
|
442 @end defun
|
|
|
443
|
|
444
|
444 @defun charset-description charset
|
|
|
445 This function returns the documentation string of @var{charset}.
|
|
428
|
446 @end defun
|
|
|
447
|
|
|
448 @defun charset-registry charset
|
|
|
449 This function returns the registry of @var{charset}.
|
|
|
450 @end defun
|
|
|
451
|
|
|
452 @defun charset-dimension charset
|
|
|
453 This function returns the dimension of @var{charset}.
|
|
|
454 @end defun
|
|
|
455
|
|
|
456 @defun charset-chars charset
|
|
|
457 This function returns the number of characters per dimension of
|
|
|
458 @var{charset}.
|
|
|
459 @end defun
|
|
|
460
|
|
444
|
461 @defun charset-width charset
|
|
428
|
462 This function returns the number of display columns per character (in
|
|
|
463 TTY mode) of @var{charset}.
|
|
|
464 @end defun
|
|
|
465
|
|
|
466 @defun charset-direction charset
|
|
440
|
467 This function returns the display direction of @var{charset}---either
|
|
428
|
468 @code{l2r} or @code{r2l}.
|
|
|
469 @end defun
|
|
|
470
|
|
444
|
471 @defun charset-iso-final-char charset
|
|
428
|
472 This function returns the final byte of the ISO 2022 escape sequence
|
|
|
473 designating @var{charset}.
|
|
|
474 @end defun
|
|
|
475
|
|
444
|
476 @defun charset-iso-graphic-plane charset
|
|
428
|
477 This function returns either 0 or 1, depending on whether the position
|
|
|
478 codes of characters in @var{charset} map to the left or right half
|
|
|
479 of their font, respectively.
|
|
|
480 @end defun
|
|
|
481
|
|
|
482 @defun charset-ccl-program charset
|
|
|
483 This function returns the CCL program, if any, for converting
|
|
|
484 position codes of characters in @var{charset} into font indices.
|
|
|
485 @end defun
|
|
|
486
|
|
442
|
487 The only property of a charset that can currently be set after
|
|
428
|
488 the charset has been created is the CCL program.
|
|
|
489
|
|
|
490 @defun set-charset-ccl-program charset ccl-program
|
|
|
491 This function sets the @code{ccl-program} property of @var{charset} to
|
|
|
492 @var{ccl-program}.
|
|
|
493 @end defun
|
|
|
494
|
|
442
|
495 @node Predefined Charsets, , Charset Property Functions, Charsets
|
|
428
|
496 @subsection Predefined Charsets
|
|
|
497
|
|
442
|
498 The following charsets are predefined in the C code.
|
|
428
|
499
|
|
|
500 @example
|
|
|
501 Name Type Fi Gr Dir Registry
|
|
|
502 --------------------------------------------------------------
|
|
|
503 ascii 94 B 0 l2r ISO8859-1
|
|
|
504 control-1 94 0 l2r ---
|
|
|
505 latin-iso8859-1 94 A 1 l2r ISO8859-1
|
|
|
506 latin-iso8859-2 96 B 1 l2r ISO8859-2
|
|
|
507 latin-iso8859-3 96 C 1 l2r ISO8859-3
|
|
|
508 latin-iso8859-4 96 D 1 l2r ISO8859-4
|
|
|
509 cyrillic-iso8859-5 96 L 1 l2r ISO8859-5
|
|
|
510 arabic-iso8859-6 96 G 1 r2l ISO8859-6
|
|
|
511 greek-iso8859-7 96 F 1 l2r ISO8859-7
|
|
|
512 hebrew-iso8859-8 96 H 1 r2l ISO8859-8
|
|
|
513 latin-iso8859-9 96 M 1 l2r ISO8859-9
|
|
|
514 thai-tis620 96 T 1 l2r TIS620
|
|
|
515 katakana-jisx0201 94 I 1 l2r JISX0201.1976
|
|
|
516 latin-jisx0201 94 J 0 l2r JISX0201.1976
|
|
|
517 japanese-jisx0208-1978 94x94 @@ 0 l2r JISX0208.1978
|
|
|
518 japanese-jisx0208 94x94 B 0 l2r JISX0208.19(83|90)
|
|
|
519 japanese-jisx0212 94x94 D 0 l2r JISX0212
|
|
|
520 chinese-gb2312 94x94 A 0 l2r GB2312
|
|
|
521 chinese-cns11643-1 94x94 G 0 l2r CNS11643.1
|
|
|
522 chinese-cns11643-2 94x94 H 0 l2r CNS11643.2
|
|
|
523 chinese-big5-1 94x94 0 0 l2r Big5
|
|
|
524 chinese-big5-2 94x94 1 0 l2r Big5
|
|
|
525 korean-ksc5601 94x94 C 0 l2r KSC5601
|
|
|
526 composite 96x96 0 l2r ---
|
|
|
527 @end example
|
|
|
528
|
|
442
|
529 The following charsets are predefined in the Lisp code.
|
|
428
|
530
|
|
|
531 @example
|
|
|
532 Name Type Fi Gr Dir Registry
|
|
|
533 --------------------------------------------------------------
|
|
|
534 arabic-digit 94 2 0 l2r MuleArabic-0
|
|
|
535 arabic-1-column 94 3 0 r2l MuleArabic-1
|
|
|
536 arabic-2-column 94 4 0 r2l MuleArabic-2
|
|
|
537 sisheng 94 0 0 l2r sisheng_cwnn\|OMRON_UDC_ZH
|
|
|
538 chinese-cns11643-3 94x94 I 0 l2r CNS11643.1
|
|
|
539 chinese-cns11643-4 94x94 J 0 l2r CNS11643.1
|
|
|
540 chinese-cns11643-5 94x94 K 0 l2r CNS11643.1
|
|
|
541 chinese-cns11643-6 94x94 L 0 l2r CNS11643.1
|
|
|
542 chinese-cns11643-7 94x94 M 0 l2r CNS11643.1
|
|
|
543 ethiopic 94x94 2 0 l2r Ethio
|
|
|
544 ascii-r2l 94 B 0 r2l ISO8859-1
|
|
|
545 ipa 96 0 1 l2r MuleIPA
|
|
|
546 vietnamese-lower 96 1 1 l2r VISCII1.1
|
|
|
547 vietnamese-upper 96 2 1 l2r VISCII1.1
|
|
|
548 @end example
|
|
|
549
|
|
|
550 For all of the above charsets, the dimension and number of columns are
|
|
|
551 the same.
|
|
|
552
|
|
442
|
553 Note that ASCII, Control-1, and Composite are handled specially.
|
|
428
|
554 This is why some of the fields are blank; and some of the filled-in
|
|
|
555 fields (e.g. the type) are not really accurate.
|
|
|
556
|
|
442
|
557 @node MULE Characters, Composite Characters, Charsets, MULE
|
|
428
|
558 @section MULE Characters
|
|
|
559
|
|
|
560 @defun make-char charset arg1 &optional arg2
|
|
|
561 This function makes a multi-byte character from @var{charset} and octets
|
|
|
562 @var{arg1} and @var{arg2}.
|
|
|
563 @end defun
|
|
|
564
|
|
444
|
565 @defun char-charset character
|
|
|
566 This function returns the character set of char @var{character}.
|
|
428
|
567 @end defun
|
|
|
568
|
|
444
|
569 @defun char-octet character &optional n
|
|
428
|
570 This function returns the octet (i.e. position code) numbered @var{n}
|
|
444
|
571 (should be 0 or 1) of char @var{character}. @var{n} defaults to 0 if omitted.
|
|
428
|
572 @end defun
|
|
|
573
|
|
|
574 @defun find-charset-region start end &optional buffer
|
|
|
575 This function returns a list of the charsets in the region between
|
|
|
576 @var{start} and @var{end}. @var{buffer} defaults to the current buffer
|
|
|
577 if omitted.
|
|
|
578 @end defun
|
|
|
579
|
|
|
580 @defun find-charset-string string
|
|
|
581 This function returns a list of the charsets in @var{string}.
|
|
|
582 @end defun
|
|
|
583
|
|
442
|
584 @node Composite Characters, Coding Systems, MULE Characters, MULE
|
|
428
|
585 @section Composite Characters
|
|
|
586
|
|
442
|
587 Composite characters are not yet completely implemented.
|
|
428
|
588
|
|
|
589 @defun make-composite-char string
|
|
|
590 This function converts a string into a single composite character. The
|
|
|
591 character is the result of overstriking all the characters in the
|
|
|
592 string.
|
|
|
593 @end defun
|
|
|
594
|
|
444
|
595 @defun composite-char-string character
|
|
428
|
596 This function returns a string of the characters comprising a composite
|
|
|
597 character.
|
|
|
598 @end defun
|
|
|
599
|
|
|
600 @defun compose-region start end &optional buffer
|
|
|
601 This function composes the characters in the region from @var{start} to
|
|
|
602 @var{end} in @var{buffer} into one composite character. The composite
|
|
|
603 character replaces the composed characters. @var{buffer} defaults to
|
|
|
604 the current buffer if omitted.
|
|
|
605 @end defun
|
|
|
606
|
|
|
607 @defun decompose-region start end &optional buffer
|
|
|
608 This function decomposes any composite characters in the region from
|
|
|
609 @var{start} to @var{end} in @var{buffer}. This converts each composite
|
|
|
610 character into one or more characters, the individual characters out of
|
|
|
611 which the composite character was formed. Non-composite characters are
|
|
|
612 left as-is. @var{buffer} defaults to the current buffer if omitted.
|
|
|
613 @end defun
|
|
|
614
|
|
442
|
615 @node Coding Systems, CCL, Composite Characters, MULE
|
|
|
616 @section Coding Systems
|
|
|
617
|
|
|
618 A coding system is an object that defines how text containing multiple
|
|
|
619 character sets is encoded into a stream of (typically 8-bit) bytes. The
|
|
|
620 coding system is used to decode the stream into a series of characters
|
|
|
621 (which may be from multiple charsets) when the text is read from a file
|
|
|
622 or process, and is used to encode the text back into the same format
|
|
|
623 when it is written out to a file or process.
|
|
|
624
|
|
|
625 For example, many ISO-2022-compliant coding systems (such as Compound
|
|
|
626 Text, which is used for inter-client data under the X Window System) use
|
|
|
627 escape sequences to switch between different charsets -- Japanese Kanji,
|
|
|
628 for example, is invoked with @samp{ESC $ ( B}; ASCII is invoked with
|
|
|
629 @samp{ESC ( B}; and Cyrillic is invoked with @samp{ESC - L}. See
|
|
|
630 @code{make-coding-system} for more information.
|
|
|
631
|
|
|
632 Coding systems are normally identified using a symbol, and the symbol is
|
|
|
633 accepted in place of the actual coding system object whenever a coding
|
|
|
634 system is called for. (This is similar to how faces and charsets work.)
|
|
|
635
|
|
|
636 @defun coding-system-p object
|
|
|
637 This function returns non-@code{nil} if @var{object} is a coding system.
|
|
|
638 @end defun
|
|
428
|
639
|
|
442
|
640 @menu
|
|
|
641 * Coding System Types:: Classifying coding systems.
|
|
|
642 * ISO 2022:: An international standard for
|
|
|
643 charsets and encodings.
|
|
|
644 * EOL Conversion:: Dealing with different ways of denoting
|
|
|
645 the end of a line.
|
|
|
646 * Coding System Properties:: Properties of a coding system.
|
|
|
647 * Basic Coding System Functions:: Working with coding systems.
|
|
|
648 * Coding System Property Functions:: Retrieving a coding system's properties.
|
|
|
649 * Encoding and Decoding Text:: Encoding and decoding text.
|
|
|
650 * Detection of Textual Encoding:: Determining how text is encoded.
|
|
|
651 * Big5 and Shift-JIS Functions:: Special functions for these non-standard
|
|
|
652 encodings.
|
|
|
653 * Predefined Coding Systems:: Coding systems implemented by MULE.
|
|
|
654 @end menu
|
|
428
|
655
|
|
442
|
656 @node Coding System Types, ISO 2022, , Coding Systems
|
|
|
657 @subsection Coding System Types
|
|
|
658
|
|
|
659 The coding system type determines the basic algorithm XEmacs will use to
|
|
|
660 decode or encode a data stream. Character encodings will be converted
|
|
|
661 to the MULE encoding, escape sequences processed, and newline sequences
|
|
|
662 converted to XEmacs's internal representation. There are three basic
|
|
|
663 classes of coding system type: no-conversion, ISO-2022, and special.
|
|
|
664
|
|
|
665 No conversion allows you to look at the file's internal representation.
|
|
|
666 Since XEmacs is basically a text editor, "no conversion" does convert
|
|
|
667 newline conventions by default. (Use the 'binary coding-system if this
|
|
|
668 is not desired.)
|
|
428
|
669
|
|
442
|
670 ISO 2022 (@pxref{ISO 2022}) is the basic international standard regulating
|
|
|
671 use of "coded character sets for the exchange of data", ie, text
|
|
|
672 streams. ISO 2022 contains functions that make it possible to encode
|
|
|
673 text streams to comply with restrictions of the Internet mail system and
|
|
|
674 de facto restrictions of most file systems (eg, use of the separator
|
|
|
675 character in file names). Coding systems which are not ISO 2022
|
|
|
676 conformant can be difficult to handle. Perhaps more important, they are
|
|
|
677 not adaptable to multilingual information interchange, with the obvious
|
|
|
678 exception of ISO 10646 (Unicode). (Unicode is partially supported by
|
|
|
679 XEmacs with the addition of the Lisp package ucs-conv.)
|
|
|
680
|
|
|
681 The special class of coding systems includes automatic detection, CCL (a
|
|
|
682 "little language" embedded as an interpreter, useful for translating
|
|
|
683 between variants of a single character set), non-ISO-2022-conformant
|
|
|
684 encodings like Unicode, Shift JIS, and Big5, and MULE internal coding.
|
|
|
685 (NB: this list is based on XEmacs 21.2. Terminology may vary slightly
|
|
|
686 for other versions of XEmacs and for GNU Emacs 20.)
|
|
|
687
|
|
|
688 @table @code
|
|
|
689 @item no-conversion
|
|
|
690 No conversion, for binary files, and a few special cases of non-ISO-2022
|
|
|
691 coding systems where conversion is done by hook functions (usually
|
|
|
692 implemented in CCL). On output, graphic characters that are not in
|
|
|
693 ASCII or Latin-1 will be replaced by a @samp{?}. (For a
|
|
|
694 no-conversion-encoded buffer, these characters will only be present if
|
|
|
695 you explicitly insert them.)
|
|
|
696 @item iso2022
|
|
|
697 Any ISO-2022-compliant encoding. Among others, this includes JIS (the
|
|
|
698 Japanese encoding commonly used for e-mail), national variants of EUC
|
|
|
699 (the standard Unix encoding for Japanese and other languages), and
|
|
|
700 Compound Text (an encoding used in X11). You can specify more specific
|
|
|
701 information about the conversion with the @var{flags} argument.
|
|
|
702 @item ucs-4
|
|
|
703 ISO 10646 UCS-4 encoding. A 31-bit fixed-width superset of Unicode.
|
|
|
704 @item utf-8
|
|
|
705 ISO 10646 UTF-8 encoding. A ``file system safe'' transformation format
|
|
|
706 that can be used with both UCS-4 and Unicode.
|
|
|
707 @item undecided
|
|
|
708 Automatic conversion. XEmacs attempts to detect the coding system used
|
|
|
709 in the file.
|
|
|
710 @item shift-jis
|
|
|
711 Shift-JIS (a Japanese encoding commonly used in PC operating systems).
|
|
|
712 @item big5
|
|
|
713 Big5 (the encoding commonly used for Taiwanese).
|
|
|
714 @item ccl
|
|
|
715 The conversion is performed using a user-written pseudo-code program.
|
|
|
716 CCL (Code Conversion Language) is the name of this pseudo-code. For
|
|
|
717 example, CCL is used to map KOI8-R characters (an encoding for Russian
|
|
|
718 Cyrillic) to ISO8859-5 (the form used internally by MULE).
|
|
|
719 @item internal
|
|
|
720 Write out or read in the raw contents of the memory representing the
|
|
|
721 buffer's text. This is primarily useful for debugging purposes, and is
|
|
|
722 only enabled when XEmacs has been compiled with @code{DEBUG_XEMACS} set
|
|
|
723 (the @samp{--debug} configure option). @strong{Warning}: Reading in a
|
|
|
724 file using @code{internal} conversion can result in an internal
|
|
|
725 inconsistency in the memory representing a buffer's text, which will
|
|
|
726 produce unpredictable results and may cause XEmacs to crash. Under
|
|
|
727 normal circumstances you should never use @code{internal} conversion.
|
|
428
|
728 @end table
|
|
|
729
|
|
442
|
730 @node ISO 2022, EOL Conversion, Coding System Types, Coding Systems
|
|
|
731 @section ISO 2022
|
|
|
732
|
|
|
733 This section briefly describes the ISO 2022 encoding standard. A more
|
|
|
734 thorough treatment is available in the original document of ISO
|
|
|
735 2022 as well as various national standards (such as JIS X 0202).
|
|
428
|
736
|
|
442
|
737 Character sets (@dfn{charsets}) are classified into the following four
|
|
|
738 categories, according to the number of characters in the charset:
|
|
|
739 94-charset, 96-charset, 94x94-charset, and 96x96-charset. This means
|
|
|
740 that although an ISO 2022 coding system may have variable width
|
|
|
741 characters, each charset used is fixed-width (in contrast to the MULE
|
|
|
742 character set and UTF-8, for example).
|
|
|
743
|
|
|
744 ISO 2022 provides for switching between character sets via escape
|
|
|
745 sequences. This switching is somewhat complicated, because ISO 2022
|
|
|
746 provides for both legacy applications like Internet mail that accept
|
|
444
|
747 only 7 significant bits in some contexts (RFC 822 headers, for example),
|
|
442
|
748 and more modern "8-bit clean" applications. It also provides for
|
|
|
749 compact and transparent representation of languages like Japanese which
|
|
|
750 mix ASCII and a national script (even outside of computer programs).
|
|
428
|
751
|
|
442
|
752 First, ISO 2022 codified prevailing practice by dividing the code space
|
|
|
753 into "control" and "graphic" regions. The code points 0x00-0x1F and
|
|
|
754 0x80-0x9F are reserved for "control characters", while "graphic
|
|
|
755 characters" must be assigned to code points in the regions 0x20-0x7F and
|
|
|
756 0xA0-0xFF. The positions 0x20 and 0x7F are special, and under some
|
|
|
757 circumstances must be assigned the graphic character "ASCII SPACE" and
|
|
|
758 the control character "ASCII DEL" respectively.
|
|
428
|
759
|
|
442
|
760 The various regions are given the name C0 (0x00-0x1F), GL (0x20-0x7F),
|
|
|
761 C1 (0x80-0x9F), and GR (0xA0-0xFF). GL and GR stand for "graphic left"
|
|
|
762 and "graphic right", respectively, because of the standard method of
|
|
|
763 displaying graphic character sets in tables with the high byte indexing
|
|
444
|
764 columns and the low byte indexing rows. I don't find it very intuitive,
|
|
442
|
765 but these are called "registers".
|
|
|
766
|
|
|
767 An ISO 2022-conformant encoding for a graphic character set must use a
|
|
|
768 fixed number of bytes per character, and the values must fit into a
|
|
|
769 single register; that is, each byte must range over either 0x20-0x7F, or
|
|
|
770 0xA0-0xFF. It is not allowed to extend the range of the repertoire of a
|
|
|
771 character set by using both ranges at the same. This is why a standard
|
|
|
772 character set such as ISO 8859-1 is actually considered by ISO 2022 to
|
|
|
773 be an aggregation of two character sets, ASCII and LATIN-1, and why it
|
|
|
774 is technically incorrect to refer to ISO 8859-1 as "Latin 1". Also, a
|
|
|
775 single character's bytes must all be drawn from the same register; this
|
|
|
776 is why Shift JIS (for Japanese) and Big 5 (for Chinese) are not ISO
|
|
|
777 2022-compatible encodings.
|
|
428
|
778
|
|
442
|
779 The reason for this restriction becomes clear when you attempt to define
|
|
|
780 an efficient, robust encoding for a language like Japanese. Like ISO
|
|
|
781 8859, Japanese encodings are aggregations of several character sets. In
|
|
|
782 practice, the vast majority of characters are drawn from the "JIS Roman"
|
|
|
783 character set (a derivative of ASCII; it won't hurt to think of it as
|
|
|
784 ASCII) and the JIS X 0208 standard "basic Japanese" character set
|
|
|
785 including not only ideographic characters ("kanji") but syllabic
|
|
|
786 Japanese characters ("kana"), a wide variety of symbols, and many
|
|
|
787 alphabetic characters (Roman, Greek, and Cyrillic) as well. Although
|
|
|
788 JIS X 0208 includes the whole Roman alphabet, as a 2-byte code it is not
|
|
|
789 suited to programming; thus the inclusion of ASCII in the standard
|
|
|
790 Japanese encodings.
|
|
428
|
791
|
|
442
|
792 For normal Japanese text such as in newspapers, a broad repertoire of
|
|
|
793 approximately 3000 characters is used. Evidently this won't fit into
|
|
|
794 one byte; two must be used. But much of the text processed by Japanese
|
|
|
795 computers is computer source code, nearly all of which is ASCII. A not
|
|
|
796 insignificant portion of ordinary text is English (as such or as
|
|
|
797 borrowed Japanese vocabulary) or other languages which can represented
|
|
|
798 at least approximately in ASCII, as well. It seems reasonable then to
|
|
|
799 represent ASCII in one byte, and JIS X 0208 in two. And this is exactly
|
|
|
800 what the Extended Unix Code for Japanese (EUC-JP) does. ASCII is
|
|
|
801 invoked to the GL register, and JIS X 0208 is invoked to the GR
|
|
|
802 register. Thus, each byte can be tested for its character set by
|
|
|
803 looking at the high bit; if set, it is Japanese, if clear, it is ASCII.
|
|
|
804 Furthermore, since control characters like newline can never be part of
|
|
|
805 a graphic character, even in the case of corruption in transmission the
|
|
|
806 stream will be resynchronized at every line break, on the order of 60-80
|
|
|
807 bytes. This coding system requires no escape sequences or special
|
|
|
808 control codes to represent 99.9% of all Japanese text.
|
|
428
|
809
|
|
442
|
810 Note carefully the distinction between the character sets (ASCII and JIS
|
|
|
811 X 0208), the encoding (EUC-JP), and the coding system (ISO 2022). The
|
|
|
812 JIS X 0208 character set is used in three different encodings for
|
|
|
813 Japanese, but in ISO-2022-JP it is invoked into GL (so the high bit is
|
|
|
814 always clear), in EUC-JP it is invoked into GR (setting the high bit in
|
|
|
815 the process), and in Shift JIS the high bit may be set or reset, and the
|
|
|
816 significant bits are shifted within the 16-bit character so that the two
|
|
|
817 main character sets can coexist with a third (the "halfwidth katakana"
|
|
|
818 of JIS X 0201). As the name implies, the ISO-2022-JP encoding is also a
|
|
|
819 version of the ISO-2022 coding system.
|
|
428
|
820
|
|
442
|
821 In order to systematically treat subsidiary character sets (like the
|
|
|
822 "halfwidth katakana" already mentioned, and the "supplementary kanji" of
|
|
|
823 JIS X 0212), four further registers are defined: G0, G1, G2, and G3.
|
|
|
824 Unlike GL and GR, they are not logically distinguished by internal
|
|
|
825 format. Instead, the process of "invocation" mentioned earlier is
|
|
|
826 broken into two steps: first, a character set is @dfn{designated} to one
|
|
|
827 of the registers G0-G3 by use of an @dfn{escape sequence} of the form:
|
|
428
|
828
|
|
|
829 @example
|
|
440
|
830 ESC [@var{I}] @var{I} @var{F}
|
|
428
|
831 @end example
|
|
|
832
|
|
442
|
833 where @var{I} is an intermediate character or characters in the range
|
|
|
834 0x20 - 0x3F, and @var{F}, from the range 0x30-0x7Fm is the final
|
|
|
835 character identifying this charset. (Final characters in the range
|
|
|
836 0x30-0x3F are reserved for private use and will never have a publicly
|
|
|
837 registered meaning.)
|
|
|
838
|
|
|
839 Then that register is @dfn{invoked} to either GL or GR, either
|
|
|
840 automatically (designations to G0 normally involve invocation to GL as
|
|
|
841 well), or by use of shifting (affecting only the following character in
|
|
|
842 the data stream) or locking (effective until the next designation or
|
|
|
843 locking) control sequences. An encoding conformant to ISO 2022 is
|
|
|
844 typically defined by designating the initial contents of the G0-G3
|
|
901
|
845 registers, specifying a 7 or 8 bit environment, and specifying whether
|
|
442
|
846 further designations will be recognized.
|
|
|
847
|
|
|
848 Some examples of character sets and the registered final characters
|
|
|
849 @var{F} used to designate them:
|
|
428
|
850
|
|
442
|
851 @need 1000
|
|
|
852 @table @asis
|
|
|
853 @item 94-charset
|
|
|
854 ASCII (B), left (J) and right (I) half of JIS X 0201, ...
|
|
|
855 @item 96-charset
|
|
|
856 Latin-1 (A), Latin-2 (B), Latin-3 (C), ...
|
|
|
857 @item 94x94-charset
|
|
|
858 GB2312 (A), JIS X 0208 (B), KSC5601 (C), ...
|
|
|
859 @item 96x96-charset
|
|
|
860 none for the moment
|
|
|
861 @end table
|
|
|
862
|
|
|
863 The meanings of the various characters in these sequences, where not
|
|
|
864 specified by the ISO 2022 standard (such as the ESC character), are
|
|
|
865 assigned by @dfn{ECMA}, the European Computer Manufacturers Association.
|
|
|
866
|
|
|
867 The meaning of intermediate characters are:
|
|
428
|
868
|
|
|
869 @example
|
|
|
870 @group
|
|
440
|
871 $ [0x24]: indicate charset of dimension 2 (94x94 or 96x96).
|
|
|
872 ( [0x28]: designate to G0 a 94-charset whose final byte is @var{F}.
|
|
|
873 ) [0x29]: designate to G1 a 94-charset whose final byte is @var{F}.
|
|
|
874 * [0x2A]: designate to G2 a 94-charset whose final byte is @var{F}.
|
|
|
875 + [0x2B]: designate to G3 a 94-charset whose final byte is @var{F}.
|
|
442
|
876 , [0x2C]: designate to G0 a 96-charset whose final byte is @var{F}.
|
|
440
|
877 - [0x2D]: designate to G1 a 96-charset whose final byte is @var{F}.
|
|
|
878 . [0x2E]: designate to G2 a 96-charset whose final byte is @var{F}.
|
|
|
879 / [0x2F]: designate to G3 a 96-charset whose final byte is @var{F}.
|
|
428
|
880 @end group
|
|
|
881 @end example
|
|
|
882
|
|
442
|
883 The comma may be used in files read and written only by MULE, as a MULE
|
|
|
884 extension, but this is illegal in ISO 2022. (The reason is that in ISO
|
|
|
885 2022 G0 must be a 94-member character set, with 0x20 assigned the value
|
|
|
886 SPACE, and 0x7F assigned the value DEL.)
|
|
428
|
887
|
|
442
|
888 Here are examples of designations:
|
|
428
|
889
|
|
|
890 @example
|
|
|
891 @group
|
|
440
|
892 ESC ( B : designate to G0 ASCII
|
|
|
893 ESC - A : designate to G1 Latin-1
|
|
|
894 ESC $ ( A or ESC $ A : designate to G0 GB2312
|
|
|
895 ESC $ ( B or ESC $ B : designate to G0 JISX0208
|
|
|
896 ESC $ ) C : designate to G1 KSC5601
|
|
428
|
897 @end group
|
|
|
898 @end example
|
|
|
899
|
|
442
|
900 (The short forms used to designate GB2312 and JIS X 0208 are for
|
|
|
901 backwards compatibility; the long forms are preferred.)
|
|
|
902
|
|
|
903 To use a charset designated to G2 or G3, and to use a charset designated
|
|
428
|
904 to G1 in a 7-bit environment, you must explicitly invoke G1, G2, or G3
|
|
|
905 into GL. There are two types of invocation, Locking Shift (forever) and
|
|
|
906 Single Shift (one character only).
|
|
|
907
|
|
442
|
908 Locking Shift is done as follows:
|
|
428
|
909
|
|
|
910 @example
|
|
440
|
911 LS0 or SI (0x0F): invoke G0 into GL
|
|
|
912 LS1 or SO (0x0E): invoke G1 into GL
|
|
|
913 LS2: invoke G2 into GL
|
|
|
914 LS3: invoke G3 into GL
|
|
|
915 LS1R: invoke G1 into GR
|
|
|
916 LS2R: invoke G2 into GR
|
|
|
917 LS3R: invoke G3 into GR
|
|
428
|
918 @end example
|
|
|
919
|
|
442
|
920 Single Shift is done as follows:
|
|
428
|
921
|
|
|
922 @example
|
|
|
923 @group
|
|
440
|
924 SS2 or ESC N: invoke G2 into GL
|
|
|
925 SS3 or ESC O: invoke G3 into GL
|
|
428
|
926 @end group
|
|
|
927 @end example
|
|
|
928
|
|
442
|
929 The shift functions (such as LS1R and SS3) are represented by control
|
|
|
930 characters (from C1) in 8 bit environments and by escape sequences in 7
|
|
|
931 bit environments.
|
|
|
932
|
|
428
|
933 (#### Ben says: I think the above is slightly incorrect. It appears that
|
|
|
934 SS2 invokes G2 into GR and SS3 invokes G3 into GR, whereas ESC N and
|
|
444
|
935 ESC O behave as indicated. The above definitions will not parse
|
|
428
|
936 EUC-encoded text correctly, and it looks like the code in mule-coding.c
|
|
|
937 has similar problems.)
|
|
|
938
|
|
442
|
939 Evidently there are a lot of ISO-2022-compliant ways of encoding
|
|
|
940 multilingual text. Now, in the world, there exist many coding systems
|
|
|
941 such as X11's Compound Text, Japanese JUNET code, and so-called EUC
|
|
|
942 (Extended UNIX Code); all of these are variants of ISO 2022.
|
|
428
|
943
|
|
442
|
944 In MULE, we characterize a version of ISO 2022 by the following
|
|
|
945 attributes:
|
|
428
|
946
|
|
|
947 @enumerate
|
|
|
948 @item
|
|
442
|
949 The character sets initially designated to G0 thru G3.
|
|
428
|
950 @item
|
|
442
|
951 Whether short form designations are allowed for Japanese and Chinese.
|
|
428
|
952 @item
|
|
442
|
953 Whether ASCII should be designated to G0 before control characters.
|
|
428
|
954 @item
|
|
442
|
955 Whether ASCII should be designated to G0 at the end of line.
|
|
428
|
956 @item
|
|
|
957 7-bit environment or 8-bit environment.
|
|
|
958 @item
|
|
442
|
959 Whether Locking Shifts are used or not.
|
|
428
|
960 @item
|
|
442
|
961 Whether to use ASCII or the variant JIS X 0201-1976-Roman.
|
|
428
|
962 @item
|
|
442
|
963 Whether to use JIS X 0208-1983 or the older version JIS X 0208-1976.
|
|
428
|
964 @end enumerate
|
|
|
965
|
|
|
966 (The last two are only for Japanese.)
|
|
|
967
|
|
442
|
968 By specifying these attributes, you can create any variant
|
|
428
|
969 of ISO 2022.
|
|
|
970
|
|
442
|
971 Here are several examples:
|
|
428
|
972
|
|
|
973 @example
|
|
|
974 @group
|
|
442
|
975 ISO-2022-JP -- Coding system used in Japanese email (RFC 1463 #### check).
|
|
440
|
976 1. G0 <- ASCII, G1..3 <- never used
|
|
|
977 2. Yes.
|
|
|
978 3. Yes.
|
|
|
979 4. Yes.
|
|
|
980 5. 7-bit environment
|
|
|
981 6. No.
|
|
|
982 7. Use ASCII
|
|
442
|
983 8. Use JIS X 0208-1983
|
|
428
|
984 @end group
|
|
|
985
|
|
|
986 @group
|
|
442
|
987 ctext -- X11 Compound Text
|
|
|
988 1. G0 <- ASCII, G1 <- Latin-1, G2,3 <- never used.
|
|
440
|
989 2. No.
|
|
|
990 3. No.
|
|
|
991 4. Yes.
|
|
442
|
992 5. 8-bit environment.
|
|
440
|
993 6. No.
|
|
442
|
994 7. Use ASCII.
|
|
|
995 8. Use JIS X 0208-1983.
|
|
428
|
996 @end group
|
|
|
997
|
|
|
998 @group
|
|
442
|
999 euc-china -- Chinese EUC. Often called the "GB encoding", but that is
|
|
|
1000 technically incorrect.
|
|
|
1001 1. G0 <- ASCII, G1 <- GB 2312, G2,3 <- never used.
|
|
440
|
1002 2. No.
|
|
|
1003 3. Yes.
|
|
|
1004 4. Yes.
|
|
442
|
1005 5. 8-bit environment.
|
|
440
|
1006 6. No.
|
|
442
|
1007 7. Use ASCII.
|
|
|
1008 8. Use JIS X 0208-1983.
|
|
428
|
1009 @end group
|
|
|
1010
|
|
|
1011 @group
|
|
442
|
1012 ISO-2022-KR -- Coding system used in Korean email.
|
|
|
1013 1. G0 <- ASCII, G1 <- KSC 5601, G2,3 <- never used.
|
|
440
|
1014 2. No.
|
|
|
1015 3. Yes.
|
|
|
1016 4. Yes.
|
|
442
|
1017 5. 7-bit environment.
|
|
440
|
1018 6. Yes.
|
|
442
|
1019 7. Use ASCII.
|
|
|
1020 8. Use JIS X 0208-1983.
|
|
428
|
1021 @end group
|
|
|
1022 @end example
|
|
|
1023
|
|
442
|
1024 MULE creates all of these coding systems by default.
|
|
428
|
1025
|
|
442
|
1026 @node EOL Conversion, Coding System Properties, ISO 2022, Coding Systems
|
|
428
|
1027 @subsection EOL Conversion
|
|
|
1028
|
|
|
1029 @table @code
|
|
|
1030 @item nil
|
|
|
1031 Automatically detect the end-of-line type (LF, CRLF, or CR). Also
|
|
|
1032 generate subsidiary coding systems named @code{@var{name}-unix},
|
|
|
1033 @code{@var{name}-dos}, and @code{@var{name}-mac}, that are identical to
|
|
|
1034 this coding system but have an EOL-TYPE value of @code{lf}, @code{crlf},
|
|
|
1035 and @code{cr}, respectively.
|
|
|
1036 @item lf
|
|
|
1037 The end of a line is marked externally using ASCII LF. Since this is
|
|
|
1038 also the way that XEmacs represents an end-of-line internally,
|
|
|
1039 specifying this option results in no end-of-line conversion. This is
|
|
|
1040 the standard format for Unix text files.
|
|
|
1041 @item crlf
|
|
|
1042 The end of a line is marked externally using ASCII CRLF. This is the
|
|
|
1043 standard format for MS-DOS text files.
|
|
|
1044 @item cr
|
|
|
1045 The end of a line is marked externally using ASCII CR. This is the
|
|
|
1046 standard format for Macintosh text files.
|
|
|
1047 @item t
|
|
|
1048 Automatically detect the end-of-line type but do not generate subsidiary
|
|
|
1049 coding systems. (This value is converted to @code{nil} when stored
|
|
|
1050 internally, and @code{coding-system-property} will return @code{nil}.)
|
|
|
1051 @end table
|
|
|
1052
|
|
442
|
1053 @node Coding System Properties, Basic Coding System Functions, EOL Conversion, Coding Systems
|
|
428
|
1054 @subsection Coding System Properties
|
|
|
1055
|
|
|
1056 @table @code
|
|
|
1057 @item mnemonic
|
|
|
1058 String to be displayed in the modeline when this coding system is
|
|
|
1059 active.
|
|
|
1060
|
|
|
1061 @item eol-type
|
|
|
1062 End-of-line conversion to be used. It should be one of the types
|
|
|
1063 listed in @ref{EOL Conversion}.
|
|
|
1064
|
|
442
|
1065 @item eol-lf
|
|
444
|
1066 The coding system which is the same as this one, except that it uses the
|
|
442
|
1067 Unix line-breaking convention.
|
|
|
1068
|
|
|
1069 @item eol-crlf
|
|
444
|
1070 The coding system which is the same as this one, except that it uses the
|
|
442
|
1071 DOS line-breaking convention.
|
|
|
1072
|
|
|
1073 @item eol-cr
|
|
444
|
1074 The coding system which is the same as this one, except that it uses the
|
|
442
|
1075 Macintosh line-breaking convention.
|
|
|
1076
|
|
428
|
1077 @item post-read-conversion
|
|
|
1078 Function called after a file has been read in, to perform the decoding.
|
|
444
|
1079 Called with two arguments, @var{start} and @var{end}, denoting a region of
|
|
428
|
1080 the current buffer to be decoded.
|
|
|
1081
|
|
|
1082 @item pre-write-conversion
|
|
|
1083 Function called before a file is written out, to perform the encoding.
|
|
444
|
1084 Called with two arguments, @var{start} and @var{end}, denoting a region of
|
|
428
|
1085 the current buffer to be encoded.
|
|
|
1086 @end table
|
|
|
1087
|
|
442
|
1088 The following additional properties are recognized if @var{type} is
|
|
428
|
1089 @code{iso2022}:
|
|
|
1090
|
|
|
1091 @table @code
|
|
|
1092 @item charset-g0
|
|
|
1093 @itemx charset-g1
|
|
|
1094 @itemx charset-g2
|
|
|
1095 @itemx charset-g3
|
|
|
1096 The character set initially designated to the G0 - G3 registers.
|
|
|
1097 The value should be one of
|
|
|
1098
|
|
|
1099 @itemize @bullet
|
|
|
1100 @item
|
|
|
1101 A charset object (designate that character set)
|
|
|
1102 @item
|
|
|
1103 @code{nil} (do not ever use this register)
|
|
|
1104 @item
|
|
|
1105 @code{t} (no character set is initially designated to the register, but
|
|
|
1106 may be later on; this automatically sets the corresponding
|
|
|
1107 @code{force-g*-on-output} property)
|
|
|
1108 @end itemize
|
|
|
1109
|
|
|
1110 @item force-g0-on-output
|
|
|
1111 @itemx force-g1-on-output
|
|
|
1112 @itemx force-g2-on-output
|
|
|
1113 @itemx force-g3-on-output
|
|
|
1114 If non-@code{nil}, send an explicit designation sequence on output
|
|
|
1115 before using the specified register.
|
|
|
1116
|
|
|
1117 @item short
|
|
|
1118 If non-@code{nil}, use the short forms @samp{ESC $ @@}, @samp{ESC $ A},
|
|
|
1119 and @samp{ESC $ B} on output in place of the full designation sequences
|
|
|
1120 @samp{ESC $ ( @@}, @samp{ESC $ ( A}, and @samp{ESC $ ( B}.
|
|
|
1121
|
|
|
1122 @item no-ascii-eol
|
|
|
1123 If non-@code{nil}, don't designate ASCII to G0 at each end of line on
|
|
|
1124 output. Setting this to non-@code{nil} also suppresses other
|
|
|
1125 state-resetting that normally happens at the end of a line.
|
|
|
1126
|
|
|
1127 @item no-ascii-cntl
|
|
|
1128 If non-@code{nil}, don't designate ASCII to G0 before control chars on
|
|
|
1129 output.
|
|
|
1130
|
|
|
1131 @item seven
|
|
|
1132 If non-@code{nil}, use 7-bit environment on output. Otherwise, use 8-bit
|
|
|
1133 environment.
|
|
|
1134
|
|
|
1135 @item lock-shift
|
|
|
1136 If non-@code{nil}, use locking-shift (SO/SI) instead of single-shift or
|
|
|
1137 designation by escape sequence.
|
|
|
1138
|
|
|
1139 @item no-iso6429
|
|
|
1140 If non-@code{nil}, don't use ISO6429's direction specification.
|
|
|
1141
|
|
|
1142 @item escape-quoted
|
|
444
|
1143 If non-@code{nil}, literal control characters that are the same as the
|
|
428
|
1144 beginning of a recognized ISO 2022 or ISO 6429 escape sequence (in
|
|
|
1145 particular, ESC (0x1B), SO (0x0E), SI (0x0F), SS2 (0x8E), SS3 (0x8F),
|
|
|
1146 and CSI (0x9B)) are ``quoted'' with an escape character so that they can
|
|
|
1147 be properly distinguished from an escape sequence. (Note that doing
|
|
|
1148 this results in a non-portable encoding.) This encoding flag is used for
|
|
|
1149 byte-compiled files. Note that ESC is a good choice for a quoting
|
|
|
1150 character because there are no escape sequences whose second byte is a
|
|
|
1151 character from the Control-0 or Control-1 character sets; this is
|
|
|
1152 explicitly disallowed by the ISO 2022 standard.
|
|
|
1153
|
|
|
1154 @item input-charset-conversion
|
|
|
1155 A list of conversion specifications, specifying conversion of characters
|
|
|
1156 in one charset to another when decoding is performed. Each
|
|
|
1157 specification is a list of two elements: the source charset, and the
|
|
|
1158 destination charset.
|
|
|
1159
|
|
|
1160 @item output-charset-conversion
|
|
|
1161 A list of conversion specifications, specifying conversion of characters
|
|
|
1162 in one charset to another when encoding is performed. The form of each
|
|
|
1163 specification is the same as for @code{input-charset-conversion}.
|
|
|
1164 @end table
|
|
|
1165
|
|
442
|
1166 The following additional properties are recognized (and required) if
|
|
428
|
1167 @var{type} is @code{ccl}:
|
|
|
1168
|
|
|
1169 @table @code
|
|
|
1170 @item decode
|
|
|
1171 CCL program used for decoding (converting to internal format).
|
|
|
1172
|
|
|
1173 @item encode
|
|
|
1174 CCL program used for encoding (converting to external format).
|
|
|
1175 @end table
|
|
|
1176
|
|
442
|
1177 The following properties are used internally: @var{eol-cr},
|
|
|
1178 @var{eol-crlf}, @var{eol-lf}, and @var{base}.
|
|
|
1179
|
|
|
1180 @node Basic Coding System Functions, Coding System Property Functions, Coding System Properties, Coding Systems
|
|
428
|
1181 @subsection Basic Coding System Functions
|
|
|
1182
|
|
|
1183 @defun find-coding-system coding-system-or-name
|
|
|
1184 This function retrieves the coding system of the given name.
|
|
|
1185
|
|
442
|
1186 If @var{coding-system-or-name} is a coding-system object, it is simply
|
|
428
|
1187 returned. Otherwise, @var{coding-system-or-name} should be a symbol.
|
|
|
1188 If there is no such coding system, @code{nil} is returned. Otherwise
|
|
|
1189 the associated coding system object is returned.
|
|
|
1190 @end defun
|
|
|
1191
|
|
|
1192 @defun get-coding-system name
|
|
|
1193 This function retrieves the coding system of the given name. Same as
|
|
|
1194 @code{find-coding-system} except an error is signalled if there is no
|
|
|
1195 such coding system instead of returning @code{nil}.
|
|
|
1196 @end defun
|
|
|
1197
|
|
|
1198 @defun coding-system-list
|
|
|
1199 This function returns a list of the names of all defined coding systems.
|
|
|
1200 @end defun
|
|
|
1201
|
|
|
1202 @defun coding-system-name coding-system
|
|
|
1203 This function returns the name of the given coding system.
|
|
|
1204 @end defun
|
|
|
1205
|
|
442
|
1206 @defun coding-system-base coding-system
|
|
|
1207 Returns the base coding system (undecided EOL convention)
|
|
|
1208 coding system.
|
|
|
1209 @end defun
|
|
|
1210
|
|
428
|
1211 @defun make-coding-system name type &optional doc-string props
|
|
|
1212 This function registers symbol @var{name} as a coding system.
|
|
|
1213
|
|
|
1214 @var{type} describes the conversion method used and should be one of
|
|
|
1215 the types listed in @ref{Coding System Types}.
|
|
|
1216
|
|
|
1217 @var{doc-string} is a string describing the coding system.
|
|
|
1218
|
|
|
1219 @var{props} is a property list, describing the specific nature of the
|
|
|
1220 character set. Recognized properties are as in @ref{Coding System
|
|
|
1221 Properties}.
|
|
|
1222 @end defun
|
|
|
1223
|
|
|
1224 @defun copy-coding-system old-coding-system new-name
|
|
|
1225 This function copies @var{old-coding-system} to @var{new-name}. If
|
|
|
1226 @var{new-name} does not name an existing coding system, a new one will
|
|
|
1227 be created.
|
|
|
1228 @end defun
|
|
|
1229
|
|
|
1230 @defun subsidiary-coding-system coding-system eol-type
|
|
|
1231 This function returns the subsidiary coding system of
|
|
|
1232 @var{coding-system} with eol type @var{eol-type}.
|
|
|
1233 @end defun
|
|
|
1234
|
|
442
|
1235 @node Coding System Property Functions, Encoding and Decoding Text, Basic Coding System Functions, Coding Systems
|
|
428
|
1236 @subsection Coding System Property Functions
|
|
|
1237
|
|
|
1238 @defun coding-system-doc-string coding-system
|
|
|
1239 This function returns the doc string for @var{coding-system}.
|
|
|
1240 @end defun
|
|
|
1241
|
|
|
1242 @defun coding-system-type coding-system
|
|
|
1243 This function returns the type of @var{coding-system}.
|
|
|
1244 @end defun
|
|
|
1245
|
|
|
1246 @defun coding-system-property coding-system prop
|
|
|
1247 This function returns the @var{prop} property of @var{coding-system}.
|
|
|
1248 @end defun
|
|
|
1249
|
|
442
|
1250 @node Encoding and Decoding Text, Detection of Textual Encoding, Coding System Property Functions, Coding Systems
|
|
428
|
1251 @subsection Encoding and Decoding Text
|
|
|
1252
|
|
|
1253 @defun decode-coding-region start end coding-system &optional buffer
|
|
|
1254 This function decodes the text between @var{start} and @var{end} which
|
|
|
1255 is encoded in @var{coding-system}. This is useful if you've read in
|
|
|
1256 encoded text from a file without decoding it (e.g. you read in a
|
|
|
1257 JIS-formatted file but used the @code{binary} or @code{no-conversion} coding
|
|
|
1258 system, so that it shows up as @samp{^[$B!<!+^[(B}). The length of the
|
|
|
1259 encoded text is returned. @var{buffer} defaults to the current buffer
|
|
|
1260 if unspecified.
|
|
|
1261 @end defun
|
|
|
1262
|
|
|
1263 @defun encode-coding-region start end coding-system &optional buffer
|
|
|
1264 This function encodes the text between @var{start} and @var{end} using
|
|
|
1265 @var{coding-system}. This will, for example, convert Japanese
|
|
|
1266 characters into stuff such as @samp{^[$B!<!+^[(B} if you use the JIS
|
|
|
1267 encoding. The length of the encoded text is returned. @var{buffer}
|
|
|
1268 defaults to the current buffer if unspecified.
|
|
|
1269 @end defun
|
|
|
1270
|
|
442
|
1271 @node Detection of Textual Encoding, Big5 and Shift-JIS Functions, Encoding and Decoding Text, Coding Systems
|
|
428
|
1272 @subsection Detection of Textual Encoding
|
|
|
1273
|
|
|
1274 @defun coding-category-list
|
|
|
1275 This function returns a list of all recognized coding categories.
|
|
|
1276 @end defun
|
|
|
1277
|
|
|
1278 @defun set-coding-priority-list list
|
|
|
1279 This function changes the priority order of the coding categories.
|
|
|
1280 @var{list} should be a list of coding categories, in descending order of
|
|
|
1281 priority. Unspecified coding categories will be lower in priority than
|
|
|
1282 all specified ones, in the same relative order they were in previously.
|
|
|
1283 @end defun
|
|
|
1284
|
|
|
1285 @defun coding-priority-list
|
|
|
1286 This function returns a list of coding categories in descending order of
|
|
|
1287 priority.
|
|
|
1288 @end defun
|
|
|
1289
|
|
|
1290 @defun set-coding-category-system coding-category coding-system
|
|
|
1291 This function changes the coding system associated with a coding category.
|
|
|
1292 @end defun
|
|
|
1293
|
|
|
1294 @defun coding-category-system coding-category
|
|
|
1295 This function returns the coding system associated with a coding category.
|
|
|
1296 @end defun
|
|
|
1297
|
|
|
1298 @defun detect-coding-region start end &optional buffer
|
|
|
1299 This function detects coding system of the text in the region between
|
|
|
1300 @var{start} and @var{end}. Returned value is a list of possible coding
|
|
|
1301 systems ordered by priority. If only ASCII characters are found, it
|
|
|
1302 returns @code{autodetect} or one of its subsidiary coding systems
|
|
|
1303 according to a detected end-of-line type. Optional arg @var{buffer}
|
|
|
1304 defaults to the current buffer.
|
|
|
1305 @end defun
|
|
|
1306
|
|
442
|
1307 @node Big5 and Shift-JIS Functions, Predefined Coding Systems, Detection of Textual Encoding, Coding Systems
|
|
428
|
1308 @subsection Big5 and Shift-JIS Functions
|
|
|
1309
|
|
442
|
1310 These are special functions for working with the non-standard
|
|
428
|
1311 Shift-JIS and Big5 encodings.
|
|
|
1312
|
|
|
1313 @defun decode-shift-jis-char code
|
|
442
|
1314 This function decodes a JIS X 0208 character of Shift-JIS coding-system.
|
|
428
|
1315 @var{code} is the character code in Shift-JIS as a cons of type bytes.
|
|
|
1316 The corresponding character is returned.
|
|
|
1317 @end defun
|
|
|
1318
|
|
444
|
1319 @defun encode-shift-jis-char character
|
|
|
1320 This function encodes a JIS X 0208 character @var{character} to
|
|
|
1321 SHIFT-JIS coding-system. The corresponding character code in SHIFT-JIS
|
|
|
1322 is returned as a cons of two bytes.
|
|
428
|
1323 @end defun
|
|
|
1324
|
|
|
1325 @defun decode-big5-char code
|
|
|
1326 This function decodes a Big5 character @var{code} of BIG5 coding-system.
|
|
|
1327 @var{code} is the character code in BIG5. The corresponding character
|
|
|
1328 is returned.
|
|
|
1329 @end defun
|
|
|
1330
|
|
444
|
1331 @defun encode-big5-char character
|
|
|
1332 This function encodes the Big5 character @var{character} to BIG5
|
|
428
|
1333 coding-system. The corresponding character code in Big5 is returned.
|
|
|
1334 @end defun
|
|
|
1335
|
|
442
|
1336 @node Predefined Coding Systems, , Big5 and Shift-JIS Functions, Coding Systems
|
|
|
1337 @subsection Coding Systems Implemented
|
|
|
1338
|
|
|
1339 MULE initializes most of the commonly used coding systems at XEmacs's
|
|
|
1340 startup. A few others are initialized only when the relevant language
|
|
|
1341 environment is selected and support libraries are loaded. (NB: The
|
|
444
|
1342 following list is based on XEmacs 21.2.19, the development branch at the
|
|
442
|
1343 time of writing. The list may be somewhat different for other
|
|
|
1344 versions. Recent versions of GNU Emacs 20 implement a few more rare
|
|
|
1345 coding systems; work is being done to port these to XEmacs.)
|
|
|
1346
|
|
444
|
1347 Unfortunately, there is not a consistent naming convention for character
|
|
|
1348 sets, and for practical purposes coding systems often take their name
|
|
442
|
1349 from their principal character sets (ASCII, KOI8-R, Shift JIS). Others
|
|
444
|
1350 take their names from the coding system (ISO-2022-JP, EUC-KR), and a few
|
|
|
1351 from their non-text usages (internal, binary). To provide for this, and
|
|
442
|
1352 for the fact that many coding systems have several common names, an
|
|
|
1353 aliasing system is provided. Finally, some effort has been made to use
|
|
|
1354 names that are registered as MIME charsets (this is why the name
|
|
|
1355 'shift_jis contains that un-Lisp-y underscore).
|
|
|
1356
|
|
|
1357 There is a systematic naming convention regarding end-of-line (EOL)
|
|
|
1358 conventions for different systems. A coding system whose name ends in
|
|
|
1359 "-unix" forces the assumptions that lines are broken by newlines (0x0A).
|
|
|
1360 A coding system whose name ends in "-mac" forces the assumptions that
|
|
|
1361 lines are broken by ASCII CRs (0x0D). A coding system whose name ends
|
|
|
1362 in "-dos" forces the assumptions that lines are broken by CRLF sequences
|
|
|
1363 (0x0D 0x0A). These subsidiary coding systems are automatically derived
|
|
|
1364 from a base coding system. Use of the base coding system implies
|
|
|
1365 autodetection of the text file convention. (The fact that the -unix,
|
|
|
1366 -mac, and -dos are derived from a base system results in them showing up
|
|
|
1367 as "aliases" in `list-coding-systems'.) These subsidiaries have a
|
|
|
1368 consistent modeline indicator as well. "-dos" coding systems have ":T"
|
|
|
1369 appended to their modeline indicator, while "-mac" coding systems have
|
|
|
1370 ":t" appended (eg, "ISO8:t" for iso-2022-8-mac).
|
|
|
1371
|
|
|
1372 In the following table, each coding system is given with its mode line
|
|
|
1373 indicator in parentheses. Non-textual coding systems are listed first,
|
|
|
1374 followed by textual coding systems and their aliases. (The coding system
|
|
|
1375 subsidiary modeline indicators ":T" and ":t" will be omitted from the
|
|
|
1376 table of coding systems.)
|
|
|
1377
|
|
|
1378 ### SJT 1999-08-23 Maybe should order these by language? Definitely
|
|
|
1379 need language usage for the ISO-8859 family.
|
|
|
1380
|
|
|
1381 Note that although true coding system aliases have been implemented for
|
|
444
|
1382 XEmacs 21.2, the coding system initialization has not yet been converted
|
|
442
|
1383 as of 21.2.19. So coding systems described as aliases have the same
|
|
|
1384 properties as the aliased coding system, but will not be equal as Lisp
|
|
|
1385 objects.
|
|
|
1386
|
|
|
1387 @table @code
|
|
|
1388
|
|
|
1389 @item automatic-conversion
|
|
|
1390 @itemx undecided
|
|
|
1391 @itemx undecided-dos
|
|
|
1392 @itemx undecided-mac
|
|
|
1393 @itemx undecided-unix
|
|
|
1394
|
|
|
1395 Modeline indicator: @code{Auto}. A type @code{undecided} coding system.
|
|
|
1396 Attempts to determine an appropriate coding system from file contents or
|
|
|
1397 the environment.
|
|
|
1398
|
|
|
1399 @item raw-text
|
|
|
1400 @itemx no-conversion
|
|
|
1401 @itemx raw-text-dos
|
|
|
1402 @itemx raw-text-mac
|
|
|
1403 @itemx raw-text-unix
|
|
|
1404 @itemx no-conversion-dos
|
|
|
1405 @itemx no-conversion-mac
|
|
|
1406 @itemx no-conversion-unix
|
|
|
1407
|
|
|
1408 Modeline indicator: @code{Raw}. A type @code{no-conversion} coding system,
|
|
|
1409 which converts only line-break-codes. An implementation quirk means
|
|
|
1410 that this coding system is also used for ISO8859-1.
|
|
|
1411
|
|
|
1412 @item binary
|
|
|
1413 Modeline indicator: @code{Binary}. A type @code{no-conversion} coding
|
|
|
1414 system which does no character coding or EOL conversions. An alias for
|
|
|
1415 @code{raw-text-unix}.
|
|
|
1416
|
|
|
1417 @item alternativnyj
|
|
|
1418 @itemx alternativnyj-dos
|
|
|
1419 @itemx alternativnyj-mac
|
|
|
1420 @itemx alternativnyj-unix
|
|
|
1421
|
|
|
1422 Modeline indicator: @code{Cy.Alt}. A type @code{ccl} coding system used for
|
|
|
1423 Alternativnyj, an encoding of the Cyrillic alphabet.
|
|
|
1424
|
|
|
1425 @item big5
|
|
|
1426 @itemx big5-dos
|
|
|
1427 @itemx big5-mac
|
|
|
1428 @itemx big5-unix
|
|
|
1429
|
|
|
1430 Modeline indicator: @code{Zh/Big5}. A type @code{big5} coding system used for
|
|
|
1431 BIG5, the most common encoding of traditional Chinese as used in Taiwan.
|
|
|
1432
|
|
|
1433 @item cn-gb-2312
|
|
|
1434 @itemx cn-gb-2312-dos
|
|
|
1435 @itemx cn-gb-2312-mac
|
|
|
1436 @itemx cn-gb-2312-unix
|
|
|
1437
|
|
|
1438 Modeline indicator: @code{Zh-GB/EUC}. A type @code{iso2022} coding system used
|
|
|
1439 for simplified Chinese (as used in the People's Republic of China), with
|
|
|
1440 the @code{ascii} (G0), @code{chinese-gb2312} (G1), and @code{sisheng}
|
|
|
1441 (G2) character sets initially designated. Chinese EUC (Extended Unix
|
|
|
1442 Code).
|
|
|
1443
|
|
|
1444 @item ctext-hebrew
|
|
|
1445 @itemx ctext-hebrew-dos
|
|
|
1446 @itemx ctext-hebrew-mac
|
|
|
1447 @itemx ctext-hebrew-unix
|
|
|
1448
|
|
|
1449 Modeline indicator: @code{CText/Hbrw}. A type @code{iso2022} coding system
|
|
|
1450 with the @code{ascii} (G0) and @code{hebrew-iso8859-8} (G1) character
|
|
|
1451 sets initially designated for Hebrew.
|
|
|
1452
|
|
|
1453 @item ctext
|
|
|
1454 @itemx ctext-dos
|
|
|
1455 @itemx ctext-mac
|
|
|
1456 @itemx ctext-unix
|
|
|
1457
|
|
|
1458 Modeline indicator: @code{CText}. A type @code{iso2022} 8-bit coding system
|
|
|
1459 with the @code{ascii} (G0) and @code{latin-iso8859-1} (G1) character
|
|
|
1460 sets initially designated. X11 Compound Text Encoding. Often
|
|
|
1461 mistakenly recognized instead of EUC encodings; usual cause is
|
|
|
1462 inappropriate setting of @code{coding-priority-list}.
|
|
|
1463
|
|
|
1464 @item escape-quoted
|
|
|
1465
|
|
|
1466 Modeline indicator: @code{ESC/Quot}. A type @code{iso2022} 8-bit coding
|
|
|
1467 system with the @code{ascii} (G0) and @code{latin-iso8859-1} (G1)
|
|
|
1468 character sets initially designated and escape quoting. Unix EOL
|
|
|
1469 conversion (ie, no conversion). It is used for .ELC files.
|
|
|
1470
|
|
|
1471 @item euc-jp
|
|
|
1472 @itemx euc-jp-dos
|
|
|
1473 @itemx euc-jp-mac
|
|
|
1474 @itemx euc-jp-unix
|
|
|
1475
|
|
|
1476 Modeline indicator: @code{Ja/EUC}. A type @code{iso2022} 8-bit coding system
|
|
|
1477 with @code{ascii} (G0), @code{japanese-jisx0208} (G1),
|
|
|
1478 @code{katakana-jisx0201} (G2), and @code{japanese-jisx0212} (G3)
|
|
|
1479 initially designated. Japanese EUC (Extended Unix Code).
|
|
|
1480
|
|
|
1481 @item euc-kr
|
|
|
1482 @itemx euc-kr-dos
|
|
|
1483 @itemx euc-kr-mac
|
|
|
1484 @itemx euc-kr-unix
|
|
|
1485
|
|
|
1486 Modeline indicator: @code{ko/EUC}. A type @code{iso2022} 8-bit coding system
|
|
|
1487 with @code{ascii} (G0) and @code{korean-ksc5601} (G1) initially
|
|
|
1488 designated. Korean EUC (Extended Unix Code).
|
|
|
1489
|
|
|
1490 @item hz-gb-2312
|
|
|
1491 Modeline indicator: @code{Zh-GB/Hz}. A type @code{no-conversion} coding
|
|
|
1492 system with Unix EOL convention (ie, no conversion) using
|
|
|
1493 post-read-decode and pre-write-encode functions to translate the Hz/ZW
|
|
|
1494 coding system used for Chinese.
|
|
|
1495
|
|
|
1496 @item iso-2022-7bit
|
|
|
1497 @itemx iso-2022-7bit-unix
|
|
|
1498 @itemx iso-2022-7bit-dos
|
|
|
1499 @itemx iso-2022-7bit-mac
|
|
|
1500 @itemx iso-2022-7
|
|
|
1501
|
|
|
1502 Modeline indicator: @code{ISO7}. A type @code{iso2022} 7-bit coding system
|
|
|
1503 with @code{ascii} (G0) initially designated. Other character sets must
|
|
|
1504 be explicitly designated to be used.
|
|
|
1505
|
|
|
1506 @item iso-2022-7bit-ss2
|
|
|
1507 @itemx iso-2022-7bit-ss2-dos
|
|
|
1508 @itemx iso-2022-7bit-ss2-mac
|
|
|
1509 @itemx iso-2022-7bit-ss2-unix
|
|
|
1510
|
|
|
1511 Modeline indicator: @code{ISO7/SS}. A type @code{iso2022} 7-bit coding system
|
|
|
1512 with @code{ascii} (G0) initially designated. Other character sets must
|
|
|
1513 be explicitly designated to be used. SS2 is used to invoke a
|
|
|
1514 96-charset, one character at a time.
|
|
|
1515
|
|
|
1516 @item iso-2022-8
|
|
|
1517 @itemx iso-2022-8-dos
|
|
|
1518 @itemx iso-2022-8-mac
|
|
|
1519 @itemx iso-2022-8-unix
|
|
|
1520
|
|
|
1521 Modeline indicator: @code{ISO8}. A type @code{iso2022} 8-bit coding system
|
|
|
1522 with @code{ascii} (G0) and @code{latin-iso8859-1} (G1) initially
|
|
|
1523 designated. Other character sets must be explicitly designated to be
|
|
|
1524 used. No single-shift or locking-shift.
|
|
|
1525
|
|
|
1526 @item iso-2022-8bit-ss2
|
|
|
1527 @itemx iso-2022-8bit-ss2-dos
|
|
|
1528 @itemx iso-2022-8bit-ss2-mac
|
|
|
1529 @itemx iso-2022-8bit-ss2-unix
|
|
|
1530
|
|
|
1531 Modeline indicator: @code{ISO8/SS}. A type @code{iso2022} 8-bit coding system
|
|
|
1532 with @code{ascii} (G0) and @code{latin-iso8859-1} (G1) initially
|
|
|
1533 designated. Other character sets must be explicitly designated to be
|
|
|
1534 used. SS2 is used to invoke a 96-charset, one character at a time.
|
|
|
1535
|
|
|
1536 @item iso-2022-int-1
|
|
|
1537 @itemx iso-2022-int-1-dos
|
|
|
1538 @itemx iso-2022-int-1-mac
|
|
|
1539 @itemx iso-2022-int-1-unix
|
|
|
1540
|
|
|
1541 Modeline indicator: @code{INT-1}. A type @code{iso2022} 7-bit coding system
|
|
|
1542 with @code{ascii} (G0) and @code{korean-ksc5601} (G1) initially
|
|
|
1543 designated. ISO-2022-INT-1.
|
|
|
1544
|
|
|
1545 @item iso-2022-jp-1978-irv
|
|
|
1546 @itemx iso-2022-jp-1978-irv-dos
|
|
|
1547 @itemx iso-2022-jp-1978-irv-mac
|
|
|
1548 @itemx iso-2022-jp-1978-irv-unix
|
|
|
1549
|
|
|
1550 Modeline indicator: @code{Ja-78/7bit}. A type @code{iso2022} 7-bit coding
|
|
|
1551 system. For compatibility with old Japanese terminals; if you need to
|
|
|
1552 know, look at the source.
|
|
|
1553
|
|
|
1554 @item iso-2022-jp
|
|
|
1555 @itemx iso-2022-jp-2 (ISO7/SS)
|
|
|
1556 @itemx iso-2022-jp-dos
|
|
|
1557 @itemx iso-2022-jp-mac
|
|
|
1558 @itemx iso-2022-jp-unix
|
|
|
1559 @itemx iso-2022-jp-2-dos
|
|
|
1560 @itemx iso-2022-jp-2-mac
|
|
|
1561 @itemx iso-2022-jp-2-unix
|
|
|
1562
|
|
|
1563 Modeline indicator: @code{MULE/7bit}. A type @code{iso2022} 7-bit coding
|
|
|
1564 system with @code{ascii} (G0) initially designated, and complex
|
|
|
1565 specifications to insure backward compatibility with old Japanese
|
|
|
1566 systems. Used for communication with mail and news in Japan. The "-2"
|
|
|
1567 versions also use SS2 to invoke a 96-charset one character at a time.
|
|
|
1568
|
|
|
1569 @item iso-2022-kr
|
|
|
1570 Modeline indicator: @code{Ko/7bit} A type @code{iso2022} 7-bit coding
|
|
|
1571 system with @code{ascii} (G0) and @code{korean-ksc5601} (G1) initially
|
|
|
1572 designated. Used for e-mail in Korea.
|
|
|
1573
|
|
|
1574 @item iso-2022-lock
|
|
|
1575 @itemx iso-2022-lock-dos
|
|
|
1576 @itemx iso-2022-lock-mac
|
|
|
1577 @itemx iso-2022-lock-unix
|
|
|
1578
|
|
|
1579 Modeline indicator: @code{ISO7/Lock}. A type @code{iso2022} 7-bit coding
|
|
|
1580 system with @code{ascii} (G0) initially designated, using Locking-Shift
|
|
|
1581 to invoke a 96-charset.
|
|
|
1582
|
|
|
1583 @item iso-8859-1
|
|
|
1584 @itemx iso-8859-1-dos
|
|
|
1585 @itemx iso-8859-1-mac
|
|
|
1586 @itemx iso-8859-1-unix
|
|
|
1587
|
|
|
1588 Due to implementation, this is not a type @code{iso2022} coding system,
|
|
|
1589 but rather an alias for the @code{raw-text} coding system.
|
|
|
1590
|
|
|
1591 @item iso-8859-2
|
|
|
1592 @itemx iso-8859-2-dos
|
|
|
1593 @itemx iso-8859-2-mac
|
|
|
1594 @itemx iso-8859-2-unix
|
|
|
1595
|
|
|
1596 Modeline indicator: @code{MIME/Ltn-2}. A type @code{iso2022} coding
|
|
|
1597 system with @code{ascii} (G0) and @code{latin-iso8859-2} (G1) initially
|
|
|
1598 invoked.
|
|
|
1599
|
|
|
1600 @item iso-8859-3
|
|
|
1601 @itemx iso-8859-3-dos
|
|
|
1602 @itemx iso-8859-3-mac
|
|
|
1603 @itemx iso-8859-3-unix
|
|
|
1604
|
|
|
1605 Modeline indicator: @code{MIME/Ltn-3}. A type @code{iso2022} coding system
|
|
|
1606 with @code{ascii} (G0) and @code{latin-iso8859-3} (G1) initially
|
|
|
1607 invoked.
|
|
|
1608
|
|
|
1609 @item iso-8859-4
|
|
|
1610 @itemx iso-8859-4-dos
|
|
|
1611 @itemx iso-8859-4-mac
|
|
|
1612 @itemx iso-8859-4-unix
|
|
|
1613
|
|
|
1614 Modeline indicator: @code{MIME/Ltn-4}. A type @code{iso2022} coding system
|
|
|
1615 with @code{ascii} (G0) and @code{latin-iso8859-4} (G1) initially
|
|
|
1616 invoked.
|
|
|
1617
|
|
|
1618 @item iso-8859-5
|
|
|
1619 @itemx iso-8859-5-dos
|
|
|
1620 @itemx iso-8859-5-mac
|
|
|
1621 @itemx iso-8859-5-unix
|
|
|
1622
|
|
|
1623 Modeline indicator: @code{ISO8/Cyr}. A type @code{iso2022} coding system with
|
|
|
1624 @code{ascii} (G0) and @code{cyrillic-iso8859-5} (G1) initially invoked.
|
|
|
1625
|
|
|
1626 @item iso-8859-7
|
|
|
1627 @itemx iso-8859-7-dos
|
|
|
1628 @itemx iso-8859-7-mac
|
|
|
1629 @itemx iso-8859-7-unix
|
|
|
1630
|
|
|
1631 Modeline indicator: @code{Grk}. A type @code{iso2022} coding system with
|
|
|
1632 @code{ascii} (G0) and @code{greek-iso8859-7} (G1) initially invoked.
|
|
|
1633
|
|
|
1634 @item iso-8859-8
|
|
|
1635 @itemx iso-8859-8-dos
|
|
|
1636 @itemx iso-8859-8-mac
|
|
|
1637 @itemx iso-8859-8-unix
|
|
|
1638
|
|
|
1639 Modeline indicator: @code{MIME/Hbrw}. A type @code{iso2022} coding system with
|
|
|
1640 @code{ascii} (G0) and @code{hebrew-iso8859-8} (G1) initially invoked.
|
|
|
1641
|
|
|
1642 @item iso-8859-9
|
|
|
1643 @itemx iso-8859-9-dos
|
|
|
1644 @itemx iso-8859-9-mac
|
|
|
1645 @itemx iso-8859-9-unix
|
|
|
1646
|
|
|
1647 Modeline indicator: @code{MIME/Ltn-5}. A type @code{iso2022} coding system
|
|
|
1648 with @code{ascii} (G0) and @code{latin-iso8859-9} (G1) initially
|
|
|
1649 invoked.
|
|
|
1650
|
|
|
1651 @item koi8-r
|
|
|
1652 @itemx koi8-r-dos
|
|
|
1653 @itemx koi8-r-mac
|
|
|
1654 @itemx koi8-r-unix
|
|
|
1655
|
|
|
1656 Modeline indicator: @code{KOI8}. A type @code{ccl} coding-system used for
|
|
|
1657 KOI8-R, an encoding of the Cyrillic alphabet.
|
|
|
1658
|
|
|
1659 @item shift_jis
|
|
|
1660 @itemx shift_jis-dos
|
|
|
1661 @itemx shift_jis-mac
|
|
|
1662 @itemx shift_jis-unix
|
|
|
1663
|
|
|
1664 Modeline indicator: @code{Ja/SJIS}. A type @code{shift-jis} coding-system
|
|
|
1665 implementing the Shift-JIS encoding for Japanese. The underscore is to
|
|
|
1666 conform to the MIME charset implementing this encoding.
|
|
|
1667
|
|
|
1668 @item tis-620
|
|
|
1669 @itemx tis-620-dos
|
|
|
1670 @itemx tis-620-mac
|
|
|
1671 @itemx tis-620-unix
|
|
|
1672
|
|
|
1673 Modeline indicator: @code{TIS620}. A type @code{ccl} encoding for Thai. The
|
|
|
1674 external encoding is defined by TIS620, the internal encoding is
|
|
|
1675 peculiar to MULE, and called @code{thai-xtis}.
|
|
|
1676
|
|
|
1677 @item viqr
|
|
|
1678
|
|
|
1679 Modeline indicator: @code{VIQR}. A type @code{no-conversion} coding
|
|
|
1680 system with Unix EOL convention (ie, no conversion) using
|
|
|
1681 post-read-decode and pre-write-encode functions to translate the VIQR
|
|
|
1682 coding system for Vietnamese.
|
|
|
1683
|
|
|
1684 @item viscii
|
|
|
1685 @itemx viscii-dos
|
|
|
1686 @itemx viscii-mac
|
|
|
1687 @itemx viscii-unix
|
|
|
1688
|
|
|
1689 Modeline indicator: @code{VISCII}. A type @code{ccl} coding-system used
|
|
|
1690 for VISCII 1.1 for Vietnamese. Differs slightly from VSCII; VISCII is
|
|
|
1691 given priority by XEmacs.
|
|
|
1692
|
|
|
1693 @item vscii
|
|
|
1694 @itemx vscii-dos
|
|
|
1695 @itemx vscii-mac
|
|
|
1696 @itemx vscii-unix
|
|
|
1697
|
|
|
1698 Modeline indicator: @code{VSCII}. A type @code{ccl} coding-system used
|
|
|
1699 for VSCII 1.1 for Vietnamese. Differs slightly from VISCII, which is
|
|
|
1700 given priority by XEmacs. Use
|
|
|
1701 @code{(prefer-coding-system 'vietnamese-vscii)} to give priority to VSCII.
|
|
|
1702
|
|
|
1703 @end table
|
|
|
1704
|
|
428
|
1705 @node CCL, Category Tables, Coding Systems, MULE
|
|
|
1706 @section CCL
|
|
|
1707
|
|
442
|
1708 CCL (Code Conversion Language) is a simple structured programming
|
|
428
|
1709 language designed for character coding conversions. A CCL program is
|
|
|
1710 compiled to CCL code (represented by a vector of integers) and executed
|
|
|
1711 by the CCL interpreter embedded in Emacs. The CCL interpreter
|
|
|
1712 implements a virtual machine with 8 registers called @code{r0}, ...,
|
|
|
1713 @code{r7}, a number of control structures, and some I/O operators. Take
|
|
|
1714 care when using registers @code{r0} (used in implicit @dfn{set}
|
|
|
1715 statements) and especially @code{r7} (used internally by several
|
|
444
|
1716 statements and operations, especially for multiple return values and I/O
|
|
428
|
1717 operations).
|
|
|
1718
|
|
442
|
1719 CCL is used for code conversion during process I/O and file I/O for
|
|
428
|
1720 non-ISO2022 coding systems. (It is the only way for a user to specify a
|
|
|
1721 code conversion function.) It is also used for calculating the code
|
|
|
1722 point of an X11 font from a character code. However, since CCL is
|
|
|
1723 designed as a powerful programming language, it can be used for more
|
|
|
1724 generic calculation where efficiency is demanded. A combination of
|
|
|
1725 three or more arithmetic operations can be calculated faster by CCL than
|
|
|
1726 by Emacs Lisp.
|
|
|
1727
|
|
442
|
1728 @strong{Warning:} The code in @file{src/mule-ccl.c} and
|
|
428
|
1729 @file{$packages/lisp/mule-base/mule-ccl.el} is the definitive
|
|
|
1730 description of CCL's semantics. The previous version of this section
|
|
|
1731 contained several typos and obsolete names left from earlier versions of
|
|
|
1732 MULE, and many may remain. (I am not an experienced CCL programmer; the
|
|
|
1733 few who know CCL well find writing English painful.)
|
|
|
1734
|
|
442
|
1735 A CCL program transforms an input data stream into an output data
|
|
428
|
1736 stream. The input stream, held in a buffer of constant bytes, is left
|
|
|
1737 unchanged. The buffer may be filled by an external input operation,
|
|
|
1738 taken from an Emacs buffer, or taken from a Lisp string. The output
|
|
|
1739 buffer is a dynamic array of bytes, which can be written by an external
|
|
|
1740 output operation, inserted into an Emacs buffer, or returned as a Lisp
|
|
|
1741 string.
|
|
|
1742
|
|
442
|
1743 A CCL program is a (Lisp) list containing two or three members. The
|
|
428
|
1744 first member is the @dfn{buffer magnification}, which indicates the
|
|
|
1745 required minimum size of the output buffer as a multiple of the input
|
|
|
1746 buffer. It is followed by the @dfn{main block} which executes while
|
|
|
1747 there is input remaining, and an optional @dfn{EOF block} which is
|
|
|
1748 executed when the input is exhausted. Both the main block and the EOF
|
|
|
1749 block are CCL blocks.
|
|
|
1750
|
|
442
|
1751 A @dfn{CCL block} is either a CCL statement or list of CCL statements.
|
|
444
|
1752 A @dfn{CCL statement} is either a @dfn{set statement} (either an integer
|
|
428
|
1753 or an @dfn{assignment}, which is a list of a register to receive the
|
|
444
|
1754 assignment, an assignment operator, and an expression) or a @dfn{control
|
|
428
|
1755 statement} (a list starting with a keyword, whose allowable syntax
|
|
|
1756 depends on the keyword).
|
|
|
1757
|
|
|
1758 @menu
|
|
|
1759 * CCL Syntax:: CCL program syntax in BNF notation.
|
|
|
1760 * CCL Statements:: Semantics of CCL statements.
|
|
|
1761 * CCL Expressions:: Operators and expressions in CCL.
|
|
|
1762 * Calling CCL:: Running CCL programs.
|
|
|
1763 * CCL Examples:: The encoding functions for Big5 and KOI-8.
|
|
|
1764 @end menu
|
|
|
1765
|
|
442
|
1766 @node CCL Syntax, CCL Statements, , CCL
|
|
428
|
1767 @comment Node, Next, Previous, Up
|
|
|
1768 @subsection CCL Syntax
|
|
|
1769
|
|
442
|
1770 The full syntax of a CCL program in BNF notation:
|
|
428
|
1771
|
|
|
1772 @format
|
|
|
1773 CCL_PROGRAM :=
|
|
|
1774 (BUFFER_MAGNIFICATION
|
|
|
1775 CCL_MAIN_BLOCK
|
|
|
1776 [ CCL_EOF_BLOCK ])
|
|
|
1777
|
|
|
1778 BUFFER_MAGNIFICATION := integer
|
|
|
1779 CCL_MAIN_BLOCK := CCL_BLOCK
|
|
|
1780 CCL_EOF_BLOCK := CCL_BLOCK
|
|
|
1781
|
|
|
1782 CCL_BLOCK :=
|
|
|
1783 STATEMENT | (STATEMENT [STATEMENT ...])
|
|
|
1784 STATEMENT :=
|
|
|
1785 SET | IF | BRANCH | LOOP | REPEAT | BREAK | READ | WRITE
|
|
|
1786 | CALL | END
|
|
|
1787
|
|
|
1788 SET :=
|
|
|
1789 (REG = EXPRESSION)
|
|
|
1790 | (REG ASSIGNMENT_OPERATOR EXPRESSION)
|
|
|
1791 | integer
|
|
|
1792
|
|
|
1793 EXPRESSION := ARG | (EXPRESSION OPERATOR ARG)
|
|
|
1794
|
|
|
1795 IF := (if EXPRESSION CCL_BLOCK [CCL_BLOCK])
|
|
|
1796 BRANCH := (branch EXPRESSION CCL_BLOCK [CCL_BLOCK ...])
|
|
|
1797 LOOP := (loop STATEMENT [STATEMENT ...])
|
|
|
1798 BREAK := (break)
|
|
|
1799 REPEAT :=
|
|
|
1800 (repeat)
|
|
|
1801 | (write-repeat [REG | integer | string])
|
|
|
1802 | (write-read-repeat REG [integer | ARRAY])
|
|
|
1803 READ :=
|
|
|
1804 (read REG ...)
|
|
|
1805 | (read-if (REG OPERATOR ARG) CCL_BLOCK CCL_BLOCK)
|
|
|
1806 | (read-branch REG CCL_BLOCK [CCL_BLOCK ...])
|
|
|
1807 WRITE :=
|
|
|
1808 (write REG ...)
|
|
|
1809 | (write EXPRESSION)
|
|
|
1810 | (write integer) | (write string) | (write REG ARRAY)
|
|
|
1811 | string
|
|
|
1812 CALL := (call ccl-program-name)
|
|
|
1813 END := (end)
|
|
|
1814
|
|
|
1815 REG := r0 | r1 | r2 | r3 | r4 | r5 | r6 | r7
|
|
|
1816 ARG := REG | integer
|
|
|
1817 OPERATOR :=
|
|
|
1818 + | - | * | / | % | & | '|' | ^ | << | >> | <8 | >8 | //
|
|
|
1819 | < | > | == | <= | >= | != | de-sjis | en-sjis
|
|
|
1820 ASSIGNMENT_OPERATOR :=
|
|
|
1821 += | -= | *= | /= | %= | &= | '|=' | ^= | <<= | >>=
|
|
|
1822 ARRAY := '[' integer ... ']'
|
|
|
1823 @end format
|
|
|
1824
|
|
|
1825 @node CCL Statements, CCL Expressions, CCL Syntax, CCL
|
|
|
1826 @comment Node, Next, Previous, Up
|
|
|
1827 @subsection CCL Statements
|
|
|
1828
|
|
442
|
1829 The Emacs Code Conversion Language provides the following statement
|
|
428
|
1830 types: @dfn{set}, @dfn{if}, @dfn{branch}, @dfn{loop}, @dfn{repeat},
|
|
|
1831 @dfn{break}, @dfn{read}, @dfn{write}, @dfn{call}, and @dfn{end}.
|
|
|
1832
|
|
|
1833 @heading Set statement:
|
|
|
1834
|
|
442
|
1835 The @dfn{set} statement has three variants with the syntaxes
|
|
428
|
1836 @samp{(@var{reg} = @var{expression})},
|
|
|
1837 @samp{(@var{reg} @var{assignment_operator} @var{expression})}, and
|
|
|
1838 @samp{@var{integer}}. The assignment operator variation of the
|
|
|
1839 @dfn{set} statement works the same way as the corresponding C expression
|
|
|
1840 statement does. The assignment operators are @code{+=}, @code{-=},
|
|
|
1841 @code{*=}, @code{/=}, @code{%=}, @code{&=}, @code{|=}, @code{^=},
|
|
|
1842 @code{<<=}, and @code{>>=}, and they have the same meanings as in C. A
|
|
|
1843 "naked integer" @var{integer} is equivalent to a @var{set} statement of
|
|
|
1844 the form @code{(r0 = @var{integer})}.
|
|
|
1845
|
|
|
1846 @heading I/O statements:
|
|
|
1847
|
|
442
|
1848 The @dfn{read} statement takes one or more registers as arguments. It
|
|
444
|
1849 reads one byte (a C char) from the input into each register in turn.
|
|
428
|
1850
|
|
442
|
1851 The @dfn{write} takes several forms. In the form @samp{(write @var{reg}
|
|
428
|
1852 ...)} it takes one or more registers as arguments and writes each in
|
|
|
1853 turn to the output. The integer in a register (interpreted as an
|
|
|
1854 Emchar) is encoded to multibyte form (ie, Bufbytes) and written to the
|
|
|
1855 current output buffer. If it is less than 256, it is written as is.
|
|
|
1856 The forms @samp{(write @var{expression})} and @samp{(write
|
|
|
1857 @var{integer})} are treated analogously. The form @samp{(write
|
|
|
1858 @var{string})} writes the constant string to the output. A
|
|
|
1859 "naked string" @samp{@var{string}} is equivalent to the statement @samp{(write
|
|
|
1860 @var{string})}. The form @samp{(write @var{reg} @var{array})} writes
|
|
|
1861 the @var{reg}th element of the @var{array} to the output.
|
|
|
1862
|
|
|
1863 @heading Conditional statements:
|
|
|
1864
|
|
442
|
1865 The @dfn{if} statement takes an @var{expression}, a @var{CCL block}, and
|
|
428
|
1866 an optional @var{second CCL block} as arguments. If the
|
|
|
1867 @var{expression} evaluates to non-zero, the first @var{CCL block} is
|
|
|
1868 executed. Otherwise, if there is a @var{second CCL block}, it is
|
|
|
1869 executed.
|
|
|
1870
|
|
442
|
1871 The @dfn{read-if} variant of the @dfn{if} statement takes an
|
|
428
|
1872 @var{expression}, a @var{CCL block}, and an optional @var{second CCL
|
|
|
1873 block} as arguments. The @var{expression} must have the form
|
|
|
1874 @code{(@var{reg} @var{operator} @var{operand})} (where @var{operand} is
|
|
|
1875 a register or an integer). The @code{read-if} statement first reads
|
|
|
1876 from the input into the first register operand in the @var{expression},
|
|
|
1877 then conditionally executes a CCL block just as the @code{if} statement
|
|
|
1878 does.
|
|
|
1879
|
|
442
|
1880 The @dfn{branch} statement takes an @var{expression} and one or more CCL
|
|
428
|
1881 blocks as arguments. The CCL blocks are treated as a zero-indexed
|
|
|
1882 array, and the @code{branch} statement uses the @var{expression} as the
|
|
|
1883 index of the CCL block to execute. Null CCL blocks may be used as
|
|
|
1884 no-ops, continuing execution with the statement following the
|
|
|
1885 @code{branch} statement in the containing CCL block. Out-of-range
|
|
444
|
1886 values for the @var{expression} are also treated as no-ops.
|
|
428
|
1887
|
|
442
|
1888 The @dfn{read-branch} variant of the @dfn{branch} statement takes an
|
|
428
|
1889 @var{register}, a @var{CCL block}, and an optional @var{second CCL
|
|
|
1890 block} as arguments. The @code{read-branch} statement first reads from
|
|
|
1891 the input into the @var{register}, then conditionally executes a CCL
|
|
|
1892 block just as the @code{branch} statement does.
|
|
|
1893
|
|
|
1894 @heading Loop control statements:
|
|
|
1895
|
|
442
|
1896 The @dfn{loop} statement creates a block with an implied jump from the
|
|
444
|
1897 end of the block back to its head. The loop is exited on a @code{break}
|
|
428
|
1898 statement, and continued without executing the tail by a @code{repeat}
|
|
|
1899 statement.
|
|
|
1900
|
|
442
|
1901 The @dfn{break} statement, written @samp{(break)}, terminates the
|
|
428
|
1902 current loop and continues with the next statement in the current
|
|
444
|
1903 block.
|
|
428
|
1904
|
|
442
|
1905 The @dfn{repeat} statement has three variants, @code{repeat},
|
|
428
|
1906 @code{write-repeat}, and @code{write-read-repeat}. Each continues the
|
|
|
1907 current loop from its head, possibly after performing I/O.
|
|
|
1908 @code{repeat} takes no arguments and does no I/O before jumping.
|
|
444
|
1909 @code{write-repeat} takes a single argument (a register, an
|
|
428
|
1910 integer, or a string), writes it to the output, then jumps.
|
|
|
1911 @code{write-read-repeat} takes one or two arguments. The first must
|
|
|
1912 be a register. The second may be an integer or an array; if absent, it
|
|
|
1913 is implicitly set to the first (register) argument.
|
|
|
1914 @code{write-read-repeat} writes its second argument to the output, then
|
|
|
1915 reads from the input into the register, and finally jumps. See the
|
|
|
1916 @code{write} and @code{read} statements for the semantics of the I/O
|
|
|
1917 operations for each type of argument.
|
|
|
1918
|
|
|
1919 @heading Other control statements:
|
|
|
1920
|
|
442
|
1921 The @dfn{call} statement, written @samp{(call @var{ccl-program-name})},
|
|
428
|
1922 executes a CCL program as a subroutine. It does not return a value to
|
|
|
1923 the caller, but can modify the register status.
|
|
|
1924
|
|
442
|
1925 The @dfn{end} statement, written @samp{(end)}, terminates the CCL
|
|
428
|
1926 program successfully, and returns to caller (which may be a CCL
|
|
|
1927 program). It does not alter the status of the registers.
|
|
|
1928
|
|
|
1929 @node CCL Expressions, Calling CCL, CCL Statements, CCL
|
|
|
1930 @comment Node, Next, Previous, Up
|
|
|
1931 @subsection CCL Expressions
|
|
|
1932
|
|
442
|
1933 CCL, unlike Lisp, uses infix expressions. The simplest CCL expressions
|
|
428
|
1934 consist of a single @var{operand}, either a register (one of @code{r0},
|
|
|
1935 ..., @code{r0}) or an integer. Complex expressions are lists of the
|
|
|
1936 form @code{( @var{expression} @var{operator} @var{operand} )}. Unlike
|
|
|
1937 C, assignments are not expressions.
|
|
|
1938
|
|
442
|
1939 In the following table, @var{X} is the target resister for a @dfn{set}.
|
|
428
|
1940 In subexpressions, this is implicitly @code{r7}. This means that
|
|
|
1941 @code{>8}, @code{//}, @code{de-sjis}, and @code{en-sjis} cannot be used
|
|
|
1942 freely in subexpressions, since they return parts of their values in
|
|
|
1943 @code{r7}. @var{Y} may be an expression, register, or integer, while
|
|
|
1944 @var{Z} must be a register or an integer.
|
|
|
1945
|
|
|
1946 @multitable @columnfractions .22 .14 .09 .55
|
|
|
1947 @item Name @tab Operator @tab Code @tab C-like Description
|
|
|
1948 @item CCL_PLUS @tab @code{+} @tab 0x00 @tab X = Y + Z
|
|
|
1949 @item CCL_MINUS @tab @code{-} @tab 0x01 @tab X = Y - Z
|
|
|
1950 @item CCL_MUL @tab @code{*} @tab 0x02 @tab X = Y * Z
|
|
|
1951 @item CCL_DIV @tab @code{/} @tab 0x03 @tab X = Y / Z
|
|
|
1952 @item CCL_MOD @tab @code{%} @tab 0x04 @tab X = Y % Z
|
|
|
1953 @item CCL_AND @tab @code{&} @tab 0x05 @tab X = Y & Z
|
|
|
1954 @item CCL_OR @tab @code{|} @tab 0x06 @tab X = Y | Z
|
|
|
1955 @item CCL_XOR @tab @code{^} @tab 0x07 @tab X = Y ^ Z
|
|
|
1956 @item CCL_LSH @tab @code{<<} @tab 0x08 @tab X = Y << Z
|
|
|
1957 @item CCL_RSH @tab @code{>>} @tab 0x09 @tab X = Y >> Z
|
|
|
1958 @item CCL_LSH8 @tab @code{<8} @tab 0x0A @tab X = (Y << 8) | Z
|
|
|
1959 @item CCL_RSH8 @tab @code{>8} @tab 0x0B @tab X = Y >> 8, r[7] = Y & 0xFF
|
|
|
1960 @item CCL_DIVMOD @tab @code{//} @tab 0x0C @tab X = Y / Z, r[7] = Y % Z
|
|
|
1961 @item CCL_LS @tab @code{<} @tab 0x10 @tab X = (X < Y)
|
|
|
1962 @item CCL_GT @tab @code{>} @tab 0x11 @tab X = (X > Y)
|
|
|
1963 @item CCL_EQ @tab @code{==} @tab 0x12 @tab X = (X == Y)
|
|
|
1964 @item CCL_LE @tab @code{<=} @tab 0x13 @tab X = (X <= Y)
|
|
|
1965 @item CCL_GE @tab @code{>=} @tab 0x14 @tab X = (X >= Y)
|
|
|
1966 @item CCL_NE @tab @code{!=} @tab 0x15 @tab X = (X != Y)
|
|
|
1967 @item CCL_ENCODE_SJIS @tab @code{en-sjis} @tab 0x16 @tab X = HIGHER_BYTE (SJIS (Y, Z))
|
|
|
1968 @item @tab @tab @tab r[7] = LOWER_BYTE (SJIS (Y, Z)
|
|
|
1969 @item CCL_DECODE_SJIS @tab @code{de-sjis} @tab 0x17 @tab X = HIGHER_BYTE (DE-SJIS (Y, Z))
|
|
|
1970 @item @tab @tab @tab r[7] = LOWER_BYTE (DE-SJIS (Y, Z))
|
|
|
1971 @end multitable
|
|
|
1972
|
|
442
|
1973 The CCL operators are as in C, with the addition of CCL_LSH8, CCL_RSH8,
|
|
428
|
1974 CCL_DIVMOD, CCL_ENCODE_SJIS, and CCL_DECODE_SJIS. The CCL_ENCODE_SJIS
|
|
|
1975 and CCL_DECODE_SJIS treat their first and second bytes as the high and
|
|
|
1976 low bytes of a two-byte character code. (SJIS stands for Shift JIS, an
|
|
|
1977 encoding of Japanese characters used by Microsoft. CCL_ENCODE_SJIS is a
|
|
|
1978 complicated transformation of the Japanese standard JIS encoding to
|
|
|
1979 Shift JIS. CCL_DECODE_SJIS is its inverse.) It is somewhat odd to
|
|
|
1980 represent the SJIS operations in infix form.
|
|
|
1981
|
|
442
|
1982 @node Calling CCL, CCL Examples, CCL Expressions, CCL
|
|
428
|
1983 @comment Node, Next, Previous, Up
|
|
|
1984 @subsection Calling CCL
|
|
|
1985
|
|
442
|
1986 CCL programs are called automatically during Emacs buffer I/O when the
|
|
428
|
1987 external representation has a coding system type of @code{shift-jis},
|
|
|
1988 @code{big5}, or @code{ccl}. The program is specified by the coding
|
|
|
1989 system (@pxref{Coding Systems}). You can also call CCL programs from
|
|
|
1990 other CCL programs, and from Lisp using these functions:
|
|
|
1991
|
|
|
1992 @defun ccl-execute ccl-program status
|
|
|
1993 Execute @var{ccl-program} with registers initialized by
|
|
|
1994 @var{status}. @var{ccl-program} is a vector of compiled CCL code
|
|
444
|
1995 created by @code{ccl-compile}. It is an error for the program to try to
|
|
428
|
1996 execute a CCL I/O command. @var{status} must be a vector of nine
|
|
|
1997 values, specifying the initial value for the R0, R1 .. R7 registers and
|
|
|
1998 for the instruction counter IC. A @code{nil} value for a register
|
|
|
1999 initializer causes the register to be set to 0. A @code{nil} value for
|
|
|
2000 the IC initializer causes execution to start at the beginning of the
|
|
|
2001 program. When the program is done, @var{status} is modified (by
|
|
|
2002 side-effect) to contain the ending values for the corresponding
|
|
444
|
2003 registers and IC.
|
|
428
|
2004 @end defun
|
|
|
2005
|
|
444
|
2006 @defun ccl-execute-on-string ccl-program status string &optional continue
|
|
428
|
2007 Execute @var{ccl-program} with initial @var{status} on
|
|
|
2008 @var{string}. @var{ccl-program} is a vector of compiled CCL code
|
|
|
2009 created by @code{ccl-compile}. @var{status} must be a vector of nine
|
|
|
2010 values, specifying the initial value for the R0, R1 .. R7 registers and
|
|
|
2011 for the instruction counter IC. A @code{nil} value for a register
|
|
|
2012 initializer causes the register to be set to 0. A @code{nil} value for
|
|
|
2013 the IC initializer causes execution to start at the beginning of the
|
|
444
|
2014 program. An optional fourth argument @var{continue}, if non-@code{nil}, causes
|
|
428
|
2015 the IC to
|
|
|
2016 remain on the unsatisfied read operation if the program terminates due
|
|
|
2017 to exhaustion of the input buffer. Otherwise the IC is set to the end
|
|
444
|
2018 of the program. When the program is done, @var{status} is modified (by
|
|
428
|
2019 side-effect) to contain the ending values for the corresponding
|
|
|
2020 registers and IC. Returns the resulting string.
|
|
|
2021 @end defun
|
|
|
2022
|
|
442
|
2023 To call a CCL program from another CCL program, it must first be
|
|
428
|
2024 registered:
|
|
|
2025
|
|
|
2026 @defun register-ccl-program name ccl-program
|
|
444
|
2027 Register @var{name} for CCL program @var{ccl-program} in
|
|
|
2028 @code{ccl-program-table}. @var{ccl-program} should be the compiled form of
|
|
|
2029 a CCL program, or @code{nil}. Return index number of the registered CCL
|
|
428
|
2030 program.
|
|
|
2031 @end defun
|
|
|
2032
|
|
442
|
2033 Information about the processor time used by the CCL interpreter can be
|
|
428
|
2034 obtained using these functions:
|
|
|
2035
|
|
|
2036 @defun ccl-elapsed-time
|
|
|
2037 Returns the elapsed processor time of the CCL interpreter as cons of
|
|
|
2038 user and system time, as
|
|
|
2039 floating point numbers measured in seconds. If only one
|
|
|
2040 overall value can be determined, the return value will be a cons of that
|
|
|
2041 value and 0.
|
|
|
2042 @end defun
|
|
|
2043
|
|
|
2044 @defun ccl-reset-elapsed-time
|
|
|
2045 Resets the CCL interpreter's internal elapsed time registers.
|
|
|
2046 @end defun
|
|
|
2047
|
|
442
|
2048 @node CCL Examples, , Calling CCL, CCL
|
|
428
|
2049 @comment Node, Next, Previous, Up
|
|
|
2050 @subsection CCL Examples
|
|
|
2051
|
|
442
|
2052 This section is not yet written.
|
|
428
|
2053
|
|
775
|
2054 @node Category Tables, Unicode Support, CCL, MULE
|
|
428
|
2055 @section Category Tables
|
|
|
2056
|
|
|
2057 A category table is a type of char table used for keeping track of
|
|
|
2058 categories. Categories are used for classifying characters for use in
|
|
440
|
2059 regexps---you can refer to a category rather than having to use a
|
|
428
|
2060 complicated [] expression (and category lookups are significantly
|
|
|
2061 faster).
|
|
|
2062
|
|
|
2063 There are 95 different categories available, one for each printable
|
|
|
2064 character (including space) in the ASCII charset. Each category is
|
|
|
2065 designated by one such character, called a @dfn{category designator}.
|
|
|
2066 They are specified in a regexp using the syntax @samp{\cX}, where X is a
|
|
|
2067 category designator. (This is not yet implemented.)
|
|
|
2068
|
|
|
2069 A category table specifies, for each character, the categories that
|
|
|
2070 the character is in. Note that a character can be in more than one
|
|
|
2071 category. More specifically, a category table maps from a character to
|
|
|
2072 either the value @code{nil} (meaning the character is in no categories)
|
|
|
2073 or a 95-element bit vector, specifying for each of the 95 categories
|
|
|
2074 whether the character is in that category.
|
|
|
2075
|
|
|
2076 Special Lisp functions are provided that abstract this, so you do not
|
|
|
2077 have to directly manipulate bit vectors.
|
|
|
2078
|
|
444
|
2079 @defun category-table-p object
|
|
|
2080 This function returns @code{t} if @var{object} is a category table.
|
|
428
|
2081 @end defun
|
|
|
2082
|
|
|
2083 @defun category-table &optional buffer
|
|
|
2084 This function returns the current category table. This is the one
|
|
|
2085 specified by the current buffer, or by @var{buffer} if it is
|
|
|
2086 non-@code{nil}.
|
|
|
2087 @end defun
|
|
|
2088
|
|
|
2089 @defun standard-category-table
|
|
|
2090 This function returns the standard category table. This is the one used
|
|
|
2091 for new buffers.
|
|
|
2092 @end defun
|
|
|
2093
|
|
444
|
2094 @defun copy-category-table &optional category-table
|
|
|
2095 This function returns a new category table which is a copy of
|
|
|
2096 @var{category-table}, which defaults to the standard category table.
|
|
428
|
2097 @end defun
|
|
|
2098
|
|
444
|
2099 @defun set-category-table category-table &optional buffer
|
|
|
2100 This function selects @var{category-table} as the new category table for
|
|
|
2101 @var{buffer}. @var{buffer} defaults to the current buffer if omitted.
|
|
428
|
2102 @end defun
|
|
|
2103
|
|
444
|
2104 @defun category-designator-p object
|
|
|
2105 This function returns @code{t} if @var{object} is a category designator (a
|
|
428
|
2106 char in the range @samp{' '} to @samp{'~'}).
|
|
|
2107 @end defun
|
|
|
2108
|
|
444
|
2109 @defun category-table-value-p object
|
|
|
2110 This function returns @code{t} if @var{object} is a category table value.
|
|
428
|
2111 Valid values are @code{nil} or a bit vector of size 95.
|
|
|
2112 @end defun
|
|
|
2113
|
|
775
|
2114
|
|
|
2115 @c Added 2002-03-13 sjt
|
|
1183
|
2116 @node Unicode Support, Charset Unification, Category Tables, MULE
|
|
775
|
2117 @section Unicode Support
|
|
|
2118 @cindex unicode
|
|
|
2119 @cindex utf-8
|
|
|
2120 @cindex utf-16
|
|
|
2121 @cindex ucs-2
|
|
|
2122 @cindex ucs-4
|
|
|
2123 @cindex bmp
|
|
|
2124 @cindex basic multilingual plance
|
|
|
2125
|
|
|
2126 Unicode support was added by Ben Wing to XEmacs 21.5.6.
|
|
|
2127
|
|
|
2128 @defun set-language-unicode-precedence-list list
|
|
|
2129 Set the language-specific precedence list used for Unicode decoding.
|
|
|
2130 This is a list of charsets, which are consulted in order for a translation
|
|
|
2131 matching a given Unicode character. If no matches are found, the charsets
|
|
|
2132 in the default precedence list (see
|
|
|
2133 @code{set-default-unicode-precedence-list}) are consulted, and then all
|
|
|
2134 remaining charsets, in some arbitrary order.
|
|
|
2135
|
|
|
2136 The language-specific precedence list is meant to be set as part of the
|
|
|
2137 language environment initialization; the default precedence list is meant
|
|
|
2138 to be set by the user.
|
|
|
2139 @end defun
|
|
|
2140
|
|
|
2141 @defun language-unicode-precedence-list
|
|
|
2142 Return the language-specific precedence list used for Unicode decoding.
|
|
|
2143 See @code{set-language-unicode-precedence-list} for more information.
|
|
|
2144 @end defun
|
|
|
2145
|
|
|
2146 @defun set-default-unicode-precedence-list list
|
|
|
2147 Set the default precedence list used for Unicode decoding.
|
|
|
2148 This is meant to be set by the user. See
|
|
|
2149 `set-language-unicode-precedence-list' for more information.
|
|
|
2150 @end defun
|
|
|
2151
|
|
|
2152 @defun default-unicode-precedence-list
|
|
|
2153 Return the default precedence list used for Unicode decoding.
|
|
|
2154 See @code{set-language-unicode-precedence-list} for more information.
|
|
|
2155 @end defun
|
|
|
2156
|
|
|
2157 @defun set-unicode-conversion character code
|
|
|
2158 Add conversion information between Unicode codepoints and characters.
|
|
|
2159 @var{character} is one of the following:
|
|
|
2160
|
|
|
2161 @c #### fix this markup
|
|
|
2162 -- A character (in which case @var{code} must be a non-negative integer)
|
|
|
2163 -- A vector of characters (in which case @var{code} must be a vector of
|
|
|
2164 non-negative integers of the same length)
|
|
|
2165
|
|
|
2166 Values of @var{code} above 2^20 - 1 are allowed for the purpose of specifying
|
|
|
2167 private characters, but will cause errors when converted to UTF-16 or UTF-32.
|
|
|
2168 UCS-4 and UTF-8 can handle values to 2^31 - 1, but XEmacs Lisp integers top
|
|
|
2169 out at 2^30 - 1.
|
|
|
2170 @end defun
|
|
|
2171
|
|
|
2172 @defun character-to-unicode character
|
|
|
2173 Convert @var{character} to Unicode codepoint.
|
|
|
2174 When there is no international support (i.e. MULE is not defined),
|
|
|
2175 this function simply does @code{char-to-int}.
|
|
|
2176 @end defun
|
|
|
2177
|
|
|
2178 @defun unicode-to-character code [charsets]
|
|
|
2179 Convert Unicode codepoint @var{code} to character.
|
|
|
2180 @var{code} should be a non-negative integer.
|
|
|
2181 If @var{charsets} is given, it should be a list of charsets, and only those
|
|
|
2182 charsets will be consulted, in the given order, for a translation.
|
|
|
2183 Otherwise, the default ordering of all charsets will be given (see
|
|
|
2184 @code{set-unicode-charset-precedence}).
|
|
|
2185
|
|
|
2186 When there is no international support (i.e. MULE is not defined),
|
|
|
2187 this function simply does @code{int-to-char} and ignores the
|
|
|
2188 @var{charsets} argument.
|
|
|
2189 @end defun
|
|
|
2190
|
|
|
2191 @defun parse-unicode-translation-table filename charset start end offset flags
|
|
|
2192 Parse Unicode translation data in @var{filename} for MULE @var{charset}.
|
|
|
2193 Data is text, in the form of one translation per line -- charset
|
|
|
2194 codepoint followed by Unicode codepoint. Numbers are decimal or hex
|
|
|
2195 \(preceded by 0x). Comments are marked with a #. Charset codepoints
|
|
|
2196 for two-dimensional charsets should have the first octet stored in the
|
|
|
2197 high 8 bits of the hex number and the second in the low 8 bits.
|
|
|
2198
|
|
|
2199 If @var{start} and @var{end} are given, only charset codepoints within
|
|
|
2200 the given range will be processed. If @var{offset} is given, that value
|
|
|
2201 will be added to all charset codepoints in the file to obtain the
|
|
|
2202 internal charset codepoint. @var{start} and @var{end} apply to the
|
|
|
2203 codepoints in the file, before @var{offset} is applied.
|
|
|
2204
|
|
|
2205 (Note that, as usual, we assume that octets are in the range 32 to
|
|
|
2206 127 or 33 to 126. If you have a table in kuten form, with octets in
|
|
|
2207 the range 1 to 94, you will have to use an offset of 5140,
|
|
|
2208 i.e. 0x2020.)
|
|
|
2209
|
|
|
2210 @var{flags}, if specified, control further how the tables are interpreted
|
|
|
2211 and are used to special-case certain known table weirdnesses in the
|
|
|
2212 Unicode tables:
|
|
|
2213
|
|
|
2214 @table @code
|
|
|
2215 @item ignore-first-column'
|
|
|
2216 Exactly as it sounds. The JIS X 0208 tables have 3 columns of data instead
|
|
|
2217 of 2; the first is the Shift-JIS codepoint.
|
|
|
2218
|
|
|
2219 @item big5
|
|
|
2220 The charset codepoint is a Big Five codepoint; convert it to the
|
|
|
2221 proper hacked-up codepoint in `chinese-big5-1' or `chinese-big5-2'.
|
|
|
2222 @end table
|
|
|
2223 @end defun
|
|
|
2224
|
|
1183
|
2225
|
|
|
2226 @node Charset Unification, Charsets and Coding Systems, Unicode Support, MULE
|
|
|
2227 @section Character Set Unification
|
|
|
2228
|
|
|
2229 Mule suffers from a design defect that causes it to consider the ISO
|
|
|
2230 Latin character sets to be disjoint. This results in oddities such as
|
|
|
2231 files containing both ISO 8859/1 and ISO 8859/15 codes, and using ISO
|
|
|
2232 2022 control sequences to switch between them, as well as more plausible
|
|
|
2233 but often unnecessary combinations like ISO 8859/1 with ISO 8859/2.
|
|
|
2234 This can be very annoying when sending messages or even in simple
|
|
|
2235 editing on a single host. Unification works around the problem by
|
|
|
2236 converting as many characters as possible to use a single Latin coded
|
|
|
2237 character set before saving the buffer.
|
|
|
2238
|
|
|
2239 This node and its children were ripp'd untimely from
|
|
|
2240 @file{latin-unity.texi}, and have been quickly converted for use here.
|
|
|
2241 However as APIs are likely to diverge, beware of inaccuracies. Please
|
|
|
2242 report any you discover with @kbd{M-x report-xemacs-bug RET}, as well
|
|
|
2243 as any ambiguities or downright unintelligible passages.
|
|
|
2244
|
|
|
2245 A lot of the stuff here doesn't belong here; it belongs in the
|
|
|
2246 @ref{Top, , , xemacs, XEmacs User's Manual}. Report those as bugs,
|
|
|
2247 too, preferably with patches.
|
|
|
2248
|
|
|
2249 @menu
|
|
|
2250 * Overview:: Unification history and general information.
|
|
|
2251 * Usage:: An overview of the operation of Unification.
|
|
|
2252 * Configuration:: Configuring Unification for use.
|
|
|
2253 * Theory of Operation:: How Unification works.
|
|
|
2254 * What Unification Cannot Do for You:: Inherent problems of 8-bit charsets.
|
|
|
2255 * Charsets and Coding Systems:: Reference lists with annotations.
|
|
1188
|
2256 * Unification Internals:: Utilities and implementation details.
|
|
1183
|
2257 @end menu
|
|
|
2258
|
|
|
2259 @node Overview, Usage, Charset Unification, Charset Unification
|
|
|
2260 @subsection An Overview of Unification
|
|
|
2261
|
|
|
2262 Mule suffers from a design defect that causes it to consider the ISO
|
|
|
2263 Latin character sets to be disjoint. This manifests itself when a user
|
|
|
2264 enters characters using input methods associated with different coded
|
|
|
2265 character sets into a single buffer.
|
|
|
2266
|
|
|
2267 A very important example involves email. Many sites, especially in the
|
|
|
2268 U.S., default to use of the ISO 8859/1 coded character set (also called
|
|
|
2269 ``Latin 1,'' though these are somewhat different concepts). However,
|
|
|
2270 ISO 8859/1 provides a generic CURRENCY SIGN character. Now that the
|
|
|
2271 Euro has become the official currency of most countries in Europe, this
|
|
|
2272 is unsatisfactory (and in practice, useless). So Europeans generally
|
|
|
2273 use ISO 8859/15, which is nearly identical to ISO 8859/1 for most
|
|
|
2274 languages, except that it substitutes EURO SIGN for CURRENCY SIGN.
|
|
|
2275
|
|
|
2276 Suppose a European user yanks text from a post encoded in ISO 8859/1
|
|
|
2277 into a message composition buffer, and enters some text including the
|
|
|
2278 Euro sign. Then Mule will consider the buffer to contain both ISO
|
|
|
2279 8859/1 and ISO 8859/15 text, and MUAs such as Gnus will (if naively
|
|
|
2280 programmed) send the message as a multipart mixed MIME body!
|
|
|
2281
|
|
|
2282 This is clearly stupid. What is not as obvious is that, just as any
|
|
|
2283 European can include American English in their text because ASCII is a
|
|
|
2284 subset of ISO 8859/15, most European languages which use Latin
|
|
|
2285 characters (eg, German and Polish) can typically be mixed while using
|
|
|
2286 only one Latin coded character set (in this case, ISO 8859/2). However,
|
|
|
2287 this often depends on exactly what text is to be encoded.
|
|
|
2288
|
|
|
2289 Unification works around the problem by converting as many characters as
|
|
|
2290 possible to use a single Latin coded character set before saving the
|
|
|
2291 buffer.
|
|
|
2292
|
|
|
2293 @node Usage, Configuration, Overview, Charset Unification
|
|
|
2294 @subsection Operation of Unification
|
|
|
2295
|
|
|
2296 Normally, Unification works in the background by installing
|
|
|
2297 @code{unity-sanity-check} on @code{write-region-pre-hook}. This is
|
|
|
2298 done by default for the ISO 8859 Latin family of character sets. The
|
|
|
2299 user activates this functionality for other character set families by
|
|
|
2300 invoking @code{enable-unification}, either interactively or in her
|
|
|
2301 init file. @xref{Init File, , , xemacs}. Unification can be
|
|
|
2302 deactivated by invoking @code{disable-unification}.
|
|
|
2303
|
|
|
2304 Unification also provides a few functions for remapping or recoding the
|
|
|
2305 buffer by hand. To @dfn{remap} a character means to change the buffer
|
|
|
2306 representation of the character by using another coded character set.
|
|
|
2307 Remapping never changes the identity of the character, but may involve
|
|
|
2308 altering the code point of the character. To @dfn{recode} a character
|
|
|
2309 means to simply change the coded character set. Recoding never alters
|
|
|
2310 the code point of the character, but may change the identity of the
|
|
|
2311 character. @xref{Theory of Operation}.
|
|
|
2312
|
|
|
2313 There are a few variables which determine which coding systems are
|
|
|
2314 always acceptable to Unification: @code{unity-ucs-list},
|
|
|
2315 @code{unity-preferred-coding-system-list}, and
|
|
|
2316 @code{unity-preapproved-coding-system-list}. The latter two default
|
|
|
2317 to @code{()}, and should probably be avoided because they short-circuit
|
|
|
2318 the sanity check. If you find you need to use them, consider reporting
|
|
|
2319 it as a bug or request for enhancement. Because they seem unsafe, the
|
|
|
2320 recommended interface is likely to change.
|
|
|
2321
|
|
|
2322 @menu
|
|
|
2323 * Basic Functionality:: User interface and customization.
|
|
|
2324 * Interactive Usage:: Treating text by hand.
|
|
|
2325 Also documents the hook function(s).
|
|
|
2326 @end menu
|
|
|
2327
|
|
|
2328
|
|
|
2329 @node Basic Functionality, Interactive Usage, , Usage
|
|
|
2330 @section Basic Functionality
|
|
|
2331
|
|
|
2332 These functions and user options initialize and configure Unification.
|
|
|
2333 In normal use, none of these should be needed.
|
|
|
2334
|
|
|
2335 @strong{These APIs are certain to change.}
|
|
|
2336
|
|
|
2337 @defun enable-unification
|
|
|
2338 Set up hooks and initialize variables for latin-unity.
|
|
|
2339
|
|
|
2340 There are no arguments.
|
|
|
2341
|
|
|
2342 This function is idempotent. It will reinitialize any hooks or variables
|
|
|
2343 that are not in initial state.
|
|
|
2344 @end defun
|
|
|
2345
|
|
|
2346 @defun disable-unification
|
|
|
2347 There are no arguments.
|
|
|
2348
|
|
|
2349 Clean up hooks and void variables used by latin-unity.
|
|
|
2350 @end defun
|
|
|
2351
|
|
|
2352 @defopt unity-ucs-list
|
|
|
2353 List of coding systems considered to be universal.
|
|
|
2354
|
|
|
2355 The default value is @code{'(utf-8 iso-2022-7 ctext escape-quoted)}.
|
|
|
2356
|
|
|
2357 Order matters; coding systems earlier in the list will be preferred when
|
|
|
2358 recommending a coding system. These coding systems will not be used
|
|
|
2359 without querying the user (unless they are also present in
|
|
|
2360 @code{unity-preapproved-coding-system-list}), and follow the
|
|
|
2361 @code{unity-preferred-coding-system-list} in the list of suggested
|
|
|
2362 coding systems.
|
|
|
2363
|
|
|
2364 If none of the preferred coding systems are feasible, the first in
|
|
|
2365 this list will be the default.
|
|
|
2366
|
|
|
2367 Notes on certain coding systems: @code{escape-quoted} is a special
|
|
|
2368 coding system used for autosaves and compiled Lisp in Mule. You should
|
|
|
2369 @c #### fix in latin-unity.texi
|
|
|
2370 never delete this, although it is rare that a user would want to use it
|
|
|
2371 directly. Unification does not try to be \"smart\" about other general
|
|
|
2372 ISO 2022 coding systems, such as ISO-2022-JP. (They are not recognized
|
|
|
2373 as equivalent to @code{iso-2022-7}.) If your preferred coding system is
|
|
|
2374 one of these, you may consider adding it to @code{unity-ucs-list}.
|
|
|
2375 However, this will typically have the side effect that (eg) ISO 8859/1
|
|
|
2376 files will be saved in 7-bit form with ISO 2022 escape sequences.
|
|
|
2377 @end defopt
|
|
|
2378
|
|
|
2379 Coding systems which are not Latin and not in
|
|
|
2380 @code{unity-ucs-list} are handled by short circuiting checks of
|
|
|
2381 coding system against the next two variables.
|
|
|
2382
|
|
|
2383 @defopt unity-preapproved-coding-system-list
|
|
|
2384 List of coding systems used without querying the user if feasible.
|
|
|
2385
|
|
|
2386 The default value is @samp{(buffer-default preferred)}.
|
|
|
2387
|
|
|
2388 The first feasible coding system in this list is used. The special values
|
|
|
2389 @samp{preferred} and @samp{buffer-default} may be present:
|
|
|
2390
|
|
|
2391 @table @code
|
|
|
2392 @item buffer-default
|
|
|
2393 Use the coding system used by @samp{write-region}, if feasible.
|
|
|
2394
|
|
|
2395 @item preferred
|
|
|
2396 Use the coding system specified by @samp{prefer-coding-system} if feasible.
|
|
|
2397 @end table
|
|
|
2398
|
|
|
2399 "Feasible" means that all characters in the buffer can be represented by
|
|
|
2400 the coding system. Coding systems in @samp{unity-ucs-list} are
|
|
|
2401 always considered feasible. Other feasible coding systems are computed
|
|
|
2402 by @samp{unity-representations-feasible-region}.
|
|
|
2403
|
|
|
2404 Note that the first universal coding system in this list shadows all
|
|
|
2405 other coding systems. In particular, if your preferred coding system is
|
|
|
2406 a universal coding system, and @code{preferred} is a member of this
|
|
|
2407 list, unification will blithely convert all your files to that coding
|
|
|
2408 system. This is considered a feature, but it may surprise most users.
|
|
|
2409 Users who don't like this behavior should put @code{preferred} in
|
|
|
2410 @code{unity-preferred-coding-system-list}.
|
|
|
2411 @end defopt
|
|
|
2412
|
|
|
2413 @defopt unity-preferred-coding-system-list
|
|
|
2414 @c #### fix in latin-unity.texi
|
|
|
2415 List of coding systems suggested to the user if feasible.
|
|
|
2416
|
|
|
2417 The default value is @samp{(iso-8859-1 iso-8859-15 iso-8859-2 iso-8859-3
|
|
|
2418 iso-8859-4 iso-8859-9)}.
|
|
|
2419
|
|
|
2420 If none of the coding systems in
|
|
|
2421 @c #### fix in latin-unity.texi
|
|
|
2422 @code{unity-preapproved-coding-system-list} are feasible, this list
|
|
|
2423 will be recommended to the user, followed by the
|
|
|
2424 @code{unity-ucs-list}. The first coding system in this list is default. The
|
|
|
2425 special values @samp{preferred} and @samp{buffer-default} may be
|
|
|
2426 present:
|
|
|
2427
|
|
|
2428 @table @code
|
|
|
2429 @item buffer-default
|
|
|
2430 Use the coding system used by @samp{write-region}, if feasible.
|
|
|
2431
|
|
|
2432 @item preferred
|
|
|
2433 Use the coding system specified by @samp{prefer-coding-system} if feasible.
|
|
|
2434 @end table
|
|
|
2435
|
|
|
2436 "Feasible" means that all characters in the buffer can be represented by
|
|
|
2437 the coding system. Coding systems in @samp{unity-ucs-list} are
|
|
|
2438 always considered feasible. Other feasible coding systems are computed
|
|
|
2439 by @samp{unity-representations-feasible-region}.
|
|
|
2440 @end defopt
|
|
|
2441
|
|
|
2442
|
|
|
2443 @defvar unity-iso-8859-1-aliases
|
|
|
2444 List of coding systems to be treated as aliases of ISO 8859/1.
|
|
|
2445
|
|
|
2446 The default value is '(iso-8859-1).
|
|
|
2447
|
|
|
2448 This is not a user variable; to customize input of coding systems or
|
|
|
2449 charsets, @samp{unity-coding-system-alias-alist} or
|
|
|
2450 @samp{unity-charset-alias-alist}.
|
|
|
2451 @end defvar
|
|
|
2452
|
|
|
2453
|
|
|
2454 @node Interactive Usage, , Basic Functionality, Usage
|
|
|
2455 @section Interactive Usage
|
|
|
2456
|
|
|
2457 First, the hook function @code{unity-sanity-check} is documented.
|
|
|
2458 (It is placed here because it is not an interactive function, and there
|
|
|
2459 is not yet a programmer's section of the manual.)
|
|
|
2460
|
|
|
2461 These functions provide access to internal functionality (such as the
|
|
|
2462 remapping function) and to extra functionality (the recoding functions
|
|
|
2463 and the test function).
|
|
|
2464
|
|
|
2465
|
|
|
2466 @defun unity-sanity-check begin end filename append visit lockname &optional coding-system
|
|
|
2467
|
|
|
2468 Check if @var{coding-system} can represent all characters between
|
|
|
2469 @var{begin} and @var{end}.
|
|
|
2470
|
|
|
2471 For compatibility with old broken versions of @code{write-region},
|
|
|
2472 @var{coding-system} defaults to @code{buffer-file-coding-system}.
|
|
|
2473 @var{filename}, @var{append}, @var{visit}, and @var{lockname} are
|
|
|
2474 ignored.
|
|
|
2475
|
|
|
2476 Return nil if buffer-file-coding-system is not (ISO-2022-compatible)
|
|
|
2477 Latin. If @code{buffer-file-coding-system} is safe for the charsets
|
|
|
2478 actually present in the buffer, return it. Otherwise, ask the user to
|
|
|
2479 choose a coding system, and return that.
|
|
|
2480
|
|
|
2481 This function does @emph{not} do the safe thing when
|
|
|
2482 @code{buffer-file-coding-system} is nil (aka no-conversion). It
|
|
|
2483 considers that ``non-Latin,'' and passes it on to the Mule detection
|
|
|
2484 mechanism.
|
|
|
2485
|
|
|
2486 This function is intended for use as a @code{write-region-pre-hook}. It
|
|
|
2487 does nothing except return @var{coding-system} if @code{write-region}
|
|
|
2488 handlers are inhibited.
|
|
|
2489 @end defun
|
|
|
2490
|
|
|
2491 @defun unity-buffer-representations-feasible
|
|
|
2492
|
|
|
2493 There are no arguments.
|
|
|
2494
|
|
|
2495 Apply unity-region-representations-feasible to the current buffer.
|
|
|
2496 @end defun
|
|
|
2497
|
|
|
2498 @defun unity-region-representations-feasible begin end &optional buf
|
|
|
2499
|
|
|
2500 Return character sets that can represent the text from @var{begin} to @var{end} in @var{buf}.
|
|
|
2501
|
|
|
2502 @var{buf} defaults to the current buffer. Called interactively, will be
|
|
|
2503 applied to the region. Function assumes @var{begin} <= @var{end}.
|
|
|
2504
|
|
|
2505 The return value is a cons. The car is the list of character sets
|
|
|
2506 that can individually represent all of the non-ASCII portion of the
|
|
|
2507 buffer, and the cdr is the list of character sets that can
|
|
|
2508 individually represent all of the ASCII portion.
|
|
|
2509
|
|
|
2510 The following is taken from a comment in the source. Please refer to
|
|
|
2511 the source to be sure of an accurate description.
|
|
|
2512
|
|
|
2513 The basic algorithm is to map over the region, compute the set of
|
|
|
2514 charsets that can represent each character (the ``feasible charset''),
|
|
|
2515 and take the intersection of those sets.
|
|
|
2516
|
|
|
2517 The current implementation takes advantage of the fact that ASCII
|
|
|
2518 characters are common and cannot change asciisets. Then using
|
|
|
2519 skip-chars-forward makes motion over ASCII subregions very fast.
|
|
|
2520
|
|
|
2521 This same strategy could be applied generally by precomputing classes
|
|
|
2522 of characters equivalent according to their effect on latinsets, and
|
|
|
2523 adding a whole class to the skip-chars-forward string once a member is
|
|
|
2524 found.
|
|
|
2525
|
|
|
2526 Probably efficiency is a function of the number of characters matched,
|
|
|
2527 or maybe the length of the match string? With @code{skip-category-forward}
|
|
|
2528 over a precomputed category table it should be really fast. In practice
|
|
|
2529 for Latin character sets there are only 29 classes.
|
|
|
2530 @end defun
|
|
|
2531
|
|
|
2532 @defun unity-remap-region begin end character-set &optional coding-system
|
|
|
2533
|
|
|
2534 Remap characters between @var{begin} and @var{end} to equivalents in
|
|
|
2535 @var{character-set}. Optional argument @var{coding-system} may be a
|
|
|
2536 coding system name (a symbol) or nil. Characters with no equivalent are
|
|
|
2537 left as-is.
|
|
|
2538
|
|
|
2539 When called interactively, @var{begin} and @var{end} are set to the
|
|
|
2540 beginning and end, respectively, of the active region, and the function
|
|
|
2541 prompts for @var{character-set}. The function does completion, knows
|
|
|
2542 how to guess a character set name from a coding system name, and also
|
|
|
2543 provides some common aliases. See @code{unity-guess-charset}.
|
|
|
2544 There is no way to specify @var{coding-system}, as it has no useful
|
|
|
2545 function interactively.
|
|
|
2546
|
|
|
2547 Return @var{coding-system} if @var{coding-system} can encode all
|
|
|
2548 characters in the region, t if @var{coding-system} is nil and the coding
|
|
|
2549 system with G0 = 'ascii and G1 = @var{character-set} can encode all
|
|
|
2550 characters, and otherwise nil. Note that a non-null return does
|
|
|
2551 @emph{not} mean it is safe to write the file, only the specified region.
|
|
|
2552 (This behavior is useful for multipart MIME encoding and the like.)
|
|
|
2553
|
|
|
2554 Note: by default this function is quite fascist about universal coding
|
|
|
2555 systems. It only admits @samp{utf-8}, @samp{iso-2022-7}, and
|
|
|
2556 @samp{ctext}. Customize @code{unity-approved-ucs-list} to change
|
|
|
2557 this.
|
|
|
2558
|
|
|
2559 This function remaps characters that are artificially distinguished by Mule
|
|
|
2560 internal code. It may change the code point as well as the character set.
|
|
|
2561 To recode characters that were decoded in the wrong coding system, use
|
|
|
2562 @code{unity-recode-region}.
|
|
|
2563 @end defun
|
|
|
2564
|
|
|
2565 @defun unity-recode-region begin end wrong-cs right-cs
|
|
|
2566
|
|
|
2567 Recode characters between @var{begin} and @var{end} from @var{wrong-cs}
|
|
|
2568 to @var{right-cs}.
|
|
|
2569
|
|
|
2570 @var{wrong-cs} and @var{right-cs} are character sets. Characters retain
|
|
|
2571 the same code point but the character set is changed. Only characters
|
|
|
2572 from @var{wrong-cs} are changed to @var{right-cs}. The identity of the
|
|
|
2573 character may change. Note that this could be dangerous, if characters
|
|
|
2574 whose identities you do not want changed are included in the region.
|
|
|
2575 This function cannot guess which characters you want changed, and which
|
|
|
2576 should be left alone.
|
|
|
2577
|
|
|
2578 When called interactively, @var{begin} and @var{end} are set to the
|
|
|
2579 beginning and end, respectively, of the active region, and the function
|
|
|
2580 prompts for @var{wrong-cs} and @var{right-cs}. The function does
|
|
|
2581 completion, knows how to guess a character set name from a coding system
|
|
|
2582 name, and also provides some common aliases. See
|
|
|
2583 @code{unity-guess-charset}.
|
|
|
2584
|
|
|
2585 Another way to accomplish this, but using coding systems rather than
|
|
|
2586 character sets to specify the desired recoding, is
|
|
|
2587 @samp{unity-recode-coding-region}. That function may be faster
|
|
|
2588 but is somewhat more dangerous, because it may recode more than one
|
|
|
2589 character set.
|
|
|
2590
|
|
|
2591 To change from one Mule representation to another without changing identity
|
|
|
2592 of any characters, use @samp{unity-remap-region}.
|
|
|
2593 @end defun
|
|
|
2594
|
|
|
2595 @defun unity-recode-coding-region begin end wrong-cs right-cs
|
|
|
2596
|
|
|
2597 Recode text between @var{begin} and @var{end} from @var{wrong-cs} to
|
|
|
2598 @var{right-cs}.
|
|
|
2599
|
|
|
2600 @var{wrong-cs} and @var{right-cs} are coding systems. Characters retain
|
|
|
2601 the same code point but the character set is changed. The identity of
|
|
|
2602 characters may change. This is an inherently dangerous function;
|
|
|
2603 multilingual text may be recoded in unexpected ways. #### It's also
|
|
|
2604 dangerous because the coding systems are not sanity-checked in the
|
|
|
2605 current implementation.
|
|
|
2606
|
|
|
2607 When called interactively, @var{begin} and @var{end} are set to the
|
|
|
2608 beginning and end, respectively, of the active region, and the function
|
|
|
2609 prompts for @var{wrong-cs} and @var{right-cs}. The function does
|
|
|
2610 completion, knows how to guess a coding system name from a character set
|
|
|
2611 name, and also provides some common aliases. See
|
|
|
2612 @code{unity-guess-coding-system}.
|
|
|
2613
|
|
|
2614 Another, safer, way to accomplish this, using character sets rather
|
|
|
2615 than coding systems to specify the desired recoding, is to use
|
|
|
2616 @c #### fixme in latin-unity.texi
|
|
|
2617 @code{unity-recode-region}.
|
|
|
2618
|
|
|
2619 To change from one Mule representation to another without changing identity
|
|
|
2620 of any characters, use @code{unity-remap-region}.
|
|
|
2621 @end defun
|
|
|
2622
|
|
|
2623 Helper functions for input of coding system and character set names.
|
|
|
2624
|
|
|
2625 @defun unity-guess-charset candidate
|
|
|
2626 Guess a charset based on the symbol @var{candidate}.
|
|
|
2627
|
|
|
2628 @var{candidate} itself is not tried as the value.
|
|
|
2629
|
|
|
2630 Uses the natural mapping in @samp{unity-cset-codesys-alist}, and
|
|
|
2631 the values in @samp{unity-charset-alias-alist}."
|
|
|
2632 @end defun
|
|
|
2633
|
|
|
2634 @defun unity-guess-coding-system candidate
|
|
|
2635 Guess a coding system based on the symbol @var{candidate}.
|
|
|
2636
|
|
|
2637 @var{candidate} itself is not tried as the value.
|
|
|
2638
|
|
|
2639 Uses the natural mapping in @samp{unity-cset-codesys-alist}, and
|
|
|
2640 the values in @samp{unity-coding-system-alias-alist}."
|
|
|
2641 @end defun
|
|
|
2642
|
|
|
2643 @defun unity-example
|
|
|
2644
|
|
|
2645 A cheesy example for Unification.
|
|
|
2646
|
|
|
2647 At present it just makes a multilingual buffer. To test, setq
|
|
|
2648 buffer-file-coding-system to some value, make the buffer dirty (eg
|
|
|
2649 with RET BackSpace), and save.
|
|
|
2650 @end defun
|
|
|
2651
|
|
|
2652
|
|
|
2653 @node Configuration, Theory of Operation, Usage, Charset Unification
|
|
|
2654 @subsection Configuring Unification for Use
|
|
|
2655
|
|
|
2656 If you want Unification to be automatically initialized, invoke
|
|
|
2657 @samp{enable-unification} with no arguments in your init file.
|
|
|
2658 @xref{Init File, , , xemacs}. If you are using GNU Emacs or an XEmacs
|
|
|
2659 earlier than 21.1, you should also load @file{auto-autoloads} using the
|
|
|
2660 full path (@emph{never} @samp{require} @file{auto-autoloads} libraries).
|
|
|
2661
|
|
|
2662 You may wish to define aliases for commonly used character sets and
|
|
|
2663 coding systems for convenience in input.
|
|
|
2664
|
|
|
2665 @defopt unity-charset-alias-alist
|
|
|
2666 Alist mapping aliases to Mule charset names (symbols)."
|
|
|
2667
|
|
|
2668 The default value is
|
|
|
2669 @example
|
|
|
2670 ((latin-1 . latin-iso8859-1)
|
|
|
2671 (latin-2 . latin-iso8859-2)
|
|
|
2672 (latin-3 . latin-iso8859-3)
|
|
|
2673 (latin-4 . latin-iso8859-4)
|
|
|
2674 (latin-5 . latin-iso8859-9)
|
|
|
2675 (latin-9 . latin-iso8859-15)
|
|
|
2676 (latin-10 . latin-iso8859-16))
|
|
|
2677 @end example
|
|
|
2678
|
|
|
2679 If a charset does not exist on your system, it will not complete and you
|
|
|
2680 will not be able to enter it in response to prompts. A real charset
|
|
|
2681 with the same name as an alias in this list will shadow the alias.
|
|
|
2682 @end defopt
|
|
|
2683
|
|
|
2684 @defopt unity-coding-system-alias-alist nil
|
|
|
2685 Alist mapping aliases to Mule coding system names (symbols).
|
|
|
2686
|
|
|
2687 The default value is @samp{nil}.
|
|
|
2688 @end defopt
|
|
|
2689
|
|
|
2690
|
|
|
2691 @node Theory of Operation, What Unification Cannot Do for You, Configuration, Charset Unification
|
|
|
2692 @subsection Theory of Operation
|
|
|
2693
|
|
|
2694 Standard encodings suffer from the design defect that they do not
|
|
|
2695 provide a reliable way to recognize which coded character sets in use.
|
|
|
2696 @xref{What Unification Cannot Do for You}. There are scores of
|
|
|
2697 character sets which can be represented by a single octet (8-bit byte),
|
|
|
2698 whose union contains many hundreds of characters. Obviously this
|
|
|
2699 results in great confusion, since you can't tell the players without a
|
|
|
2700 scorecard, and there is no scorecard.
|
|
|
2701
|
|
|
2702 There are two ways to solve this problem. The first is to create a
|
|
|
2703 universal coded character set. This is the concept behind Unicode.
|
|
|
2704 However, there have been satisfactory (nearly) universal character sets
|
|
|
2705 for several decades, but even today many Westerners resist using Unicode
|
|
|
2706 because they consider its space requirements excessive. On the other
|
|
|
2707 hand, Asians dislike Unicode because they consider it to be incomplete.
|
|
|
2708 (This is partly, but not entirely, political.)
|
|
|
2709
|
|
|
2710 In any case, Unicode only solves the internal representation problem.
|
|
|
2711 Many data sets will contain files in ``legacy'' encodings, and Unicode
|
|
|
2712 does not help distinguish among them.
|
|
|
2713
|
|
|
2714 The second approach is to embed information about the encodings used in
|
|
|
2715 a document in its text. This approach is taken by the ISO 2022
|
|
|
2716 standard. This would solve the problem completely from the users' of
|
|
|
2717 view, except that ISO 2022 is basically not implemented at all, in the
|
|
|
2718 sense that few applications or systems implement more than a small
|
|
|
2719 subset of ISO 2022 functionality. This is due to the fact that
|
|
|
2720 mono-literate users object to the presence of escape sequences in their
|
|
|
2721 texts (which they, with some justification, consider data corruption).
|
|
|
2722 Programmers are more than willing to cater to these users, since
|
|
|
2723 implementing ISO 2022 is a painstaking task.
|
|
|
2724
|
|
|
2725 In fact, Emacs/Mule adopts both of these approaches. Internally it uses
|
|
|
2726 a universal character set, @dfn{Mule code}. Externally it uses ISO 2022
|
|
|
2727 techniques both to save files in forms robust to encoding issues, and as
|
|
|
2728 hints when attempting to ``guess'' an unknown encoding. However, Mule
|
|
|
2729 suffers from a design defect, namely it embeds the character set
|
|
|
2730 information that ISO 2022 attaches to runs of characters by introducing
|
|
|
2731 them with a control sequence in each character. That causes Mule to
|
|
|
2732 consider the ISO Latin character sets to be disjoint. This manifests
|
|
|
2733 itself when a user enters characters using input methods associated with
|
|
|
2734 different coded character sets into a single buffer.
|
|
|
2735
|
|
|
2736 There are two problems stemming from this design. First, Mule
|
|
1188
|
2737 represents the same character in different ways. Abstractly, 'ó'
|
|
1183
|
2738 (LATIN SMALL LETTER O WITH ACUTE) can get represented as
|
|
|
2739 [latin-iso8859-1 #x73] or as [latin-iso8859-2 #x73]. So what looks like
|
|
1188
|
2740 'óó' in the display might actually be represented [latin-iso8859-1
|
|
1183
|
2741 #x73][latin-iso8859-2 #x73] in the buffer, and saved as [#xF3 ESC - B
|
|
|
2742 #xF3 ESC - A] in the file. In some cases this treatment would be
|
|
|
2743 appropriate (consider HYPHEN, MINUS SIGN, EN DASH, EM DASH, and U+4E00
|
|
|
2744 (the CJK ideographic character meaning ``one'')), and although arguably
|
|
|
2745 incorrect it is convenient when mixing the CJK scripts. But in the case
|
|
|
2746 of the Latin scripts this is wrong.
|
|
|
2747
|
|
|
2748 Worse yet, it is very likely to occur when mixing ``different'' encodings
|
|
|
2749 (such as ISO 8859/1 and ISO 8859/15) that differ only in a few code
|
|
|
2750 points that are almost never used. A very important example involves
|
|
|
2751 email. Many sites, especially in the U.S., default to use of the ISO
|
|
|
2752 8859/1 coded character set (also called ``Latin 1,'' though these are
|
|
|
2753 somewhat different concepts). However, ISO 8859/1 provides a generic
|
|
|
2754 CURRENCY SIGN character. Now that the Euro has become the official
|
|
|
2755 currency of most countries in Europe, this is unsatisfactory (and in
|
|
|
2756 practice, useless). So Europeans generally use ISO 8859/15, which is
|
|
|
2757 nearly identical to ISO 8859/1 for most languages, except that it
|
|
|
2758 substitutes EURO SIGN for CURRENCY SIGN.
|
|
|
2759
|
|
|
2760 Suppose a European user yanks text from a post encoded in ISO 8859/1
|
|
|
2761 into a message composition buffer, and enters some text including the
|
|
|
2762 Euro sign. Then Mule will consider the buffer to contain both ISO
|
|
|
2763 8859/1 and ISO 8859/15 text, and MUAs such as Gnus will (if naively
|
|
|
2764 programmed) send the message as a multipart mixed MIME body!
|
|
|
2765
|
|
|
2766 This is clearly stupid. What is not as obvious is that, just as any
|
|
|
2767 European can include American English in their text because ASCII is a
|
|
|
2768 subset of ISO 8859/15, most European languages which use Latin
|
|
|
2769 characters (eg, German and Polish) can typically be mixed while using
|
|
|
2770 only one Latin coded character set (in the case of German and Polish,
|
|
|
2771 ISO 8859/2). However, this often depends on exactly what text is to be
|
|
|
2772 encoded (even for the same pair of languages).
|
|
|
2773
|
|
|
2774 Unification works around the problem by converting as many characters as
|
|
|
2775 possible to use a single Latin coded character set before saving the
|
|
|
2776 buffer.
|
|
|
2777
|
|
|
2778 Because the problem is rarely noticable in editing a buffer, but tends
|
|
|
2779 to manifest when that buffer is exported to a file or process, the
|
|
|
2780 Unification package uses the strategy of examining the buffer prior to
|
|
|
2781 export. If use of multiple Latin coded character sets is detected,
|
|
|
2782 Unification attempts to unify them by finding a single coded character
|
|
|
2783 set which contains all of the Latin characters in the buffer.
|
|
|
2784
|
|
|
2785 The primary purpose of Unification is to fix the problem by giving the
|
|
|
2786 user the choice to change the representation of all characters to one
|
|
|
2787 character set and give sensible recommendations based on context. In
|
|
1188
|
2788 the 'ó' example, either ISO 8859/1 or ISO 8859/2 is satisfactory, and
|
|
1183
|
2789 both will be suggested. In the EURO SIGN example, only ISO 8859/15
|
|
|
2790 makes sense, and that is what will be recommended. In both cases, the
|
|
|
2791 user will be reminded that there are universal encodings available.
|
|
|
2792
|
|
|
2793 I call this @dfn{remapping} (from the universal character set to a
|
|
|
2794 particular ISO 8859 coded character set). It is mere accident that this
|
|
|
2795 letter has the same code point in both character sets. (Not entirely,
|
|
|
2796 but there are many examples of Latin characters that have different code
|
|
|
2797 points in different Latin-X sets.)
|
|
|
2798
|
|
1188
|
2799 Note that, in the 'ó' example, that treating the buffer in this way will
|
|
1183
|
2800 result in a representation such as [latin-iso8859-2
|
|
|
2801 #x73][latin-iso8859-2 #x73], and the file will be saved as [#xF3 #xF3].
|
|
|
2802 This is guaranteed to occasionally result in the second problem you
|
|
|
2803 observed, to which we now turn.
|
|
|
2804
|
|
|
2805 This problem is that, although the file is intended to be an
|
|
|
2806 ISO-8859/2-encoded file, in an ISO 8859/1 locale Mule (and every POSIX
|
|
|
2807 compliant program---this is required by the standard, obvious if you
|
|
|
2808 think a bit, @pxref{What Unification Cannot Do for You}) will read that
|
|
|
2809 file as [latin-iso8859-1 #x73] [latin-iso8859-1 #x73]. Of course this
|
|
|
2810 is no problem if all of the characters in the file are contained in ISO
|
|
|
2811 8859/1, but suppose there are some which are not, but are contained in
|
|
|
2812 the (intended) ISO 8859/2.
|
|
|
2813
|
|
|
2814 You now want to fix this, but not by finding the same character in
|
|
|
2815 another set. Instead, you want to simply change the character set that
|
|
|
2816 Mule associates with that buffer position without changing the code.
|
|
|
2817 (This is conceptually somewhat distinct from the first problem, and
|
|
|
2818 logically ought to be handled in the code that defines coding systems.
|
|
|
2819 However, unification is not an unreasonable place for it.) Unification
|
|
|
2820 provides two functions (one fast and dangerous, the other slow and
|
|
|
2821 careful) to handle this. I call this @dfn{recoding}, because the
|
|
|
2822 transformation actually involves @emph{encoding} the buffer to file
|
|
|
2823 representation, then @emph{decoding} it to buffer representation (in a
|
|
|
2824 different character set). This cannot be done automatically because
|
|
|
2825 Mule can have no idea what the correct encoding is---after all, it
|
|
|
2826 already gave you its best guess. @xref{What Unification Cannot Do for
|
|
|
2827 You}. So these functions must be invoked by the user. @xref{Interactive
|
|
|
2828 Usage}.
|
|
|
2829
|
|
|
2830
|
|
|
2831 @node What Unification Cannot Do for You, Unification Internals, Theory of Operation, Charset Unification
|
|
|
2832 @subsection What Unification Cannot Do for You
|
|
|
2833
|
|
|
2834 Unification @strong{cannot} save you if you insist on exporting data in
|
|
|
2835 8-bit encodings in a multilingual environment. @emph{You will
|
|
|
2836 eventually corrupt data if you do this.} It is not Mule's, or any
|
|
|
2837 application's, fault. You will have only yourself to blame; consider
|
|
|
2838 yourself warned. (It is true that Mule has bugs, which make Mule
|
|
|
2839 somewhat more dangerous and inconvenient than some naive applications.
|
|
|
2840 We're working to address those, but no application can remedy the
|
|
|
2841 inherent defect of 8-bit encodings.)
|
|
|
2842
|
|
|
2843 Use standard universal encodings, preferably Unicode (UTF-8) unless
|
|
|
2844 applicable standards indicate otherwise. The most important such case
|
|
|
2845 is Internet messages, where MIME should be used, whether or not the
|
|
|
2846 subordinate encoding is a universal encoding. (Note that since one of
|
|
|
2847 the important provisions of MIME is the @samp{Content-Type} header,
|
|
|
2848 which has the charset parameter, MIME is to be considered a universal
|
|
|
2849 encoding for the purposes of this manual. Of course, technically
|
|
|
2850 speaking it's neither a coded character set nor a coding extension
|
|
|
2851 technique compliant with ISO 2022.)
|
|
|
2852
|
|
|
2853 As mentioned earlier, the problem is that standard encodings suffer from
|
|
|
2854 the design defect that they do not provide a reliable way to recognize
|
|
|
2855 which coded character sets are in use. There are scores of character
|
|
|
2856 sets which can be represented by a single octet (8-bit byte), whose
|
|
|
2857 union contains many hundreds of characters. Thus any 8-bit coded
|
|
|
2858 character set must contain characters that share code points used for
|
|
|
2859 different characters in other coded character sets.
|
|
|
2860
|
|
|
2861 This means that a given file's intended encoding cannot be identified
|
|
|
2862 with 100% reliability unless it contains encoding markers such as those
|
|
|
2863 provided by MIME or ISO 2022.
|
|
|
2864
|
|
|
2865 Unification actually makes it more likely that you will have problems of
|
|
|
2866 this kind. Traditionally Mule has been ``helpful'' by simply using an
|
|
|
2867 ISO 2022 universal coding system when the current buffer coding system
|
|
|
2868 cannot handle all the characters in the buffer. This has the effect
|
|
|
2869 that, because the file contains control sequences, it is not recognized
|
|
|
2870 as being in the locale's normal 8-bit encoding. It may be annoying if
|
|
|
2871 you are not a Mule expert, but your data is automatically recoverable
|
|
|
2872 with a tool you already have: Mule.
|
|
|
2873
|
|
|
2874 However, with unification, Mule converts to a single 8-bit character set
|
|
|
2875 when possible. But typically this will @emph{not} be in your usual
|
|
|
2876 locale. Ie, the times that an ISO 8859/1 user will need Unification is
|
|
|
2877 when there are ISO 8859/2 characters in the buffer. But then most
|
|
|
2878 likely the file will be saved in a pure 8-bit encoding that is not ISO
|
|
|
2879 8859/1, ie, ISO 8859/2. Mule's autorecognizer (which is probably the
|
|
|
2880 most sophisticated yet available) cannot tell the difference between ISO
|
|
|
2881 8859/1 and ISO 8859/2, and in a Western European locale will choose the
|
|
|
2882 former even though the latter was intended. Even the extension
|
|
|
2883 (``statistical recognition'') planned for XEmacs 22 is unlikely to be at
|
|
|
2884 all accurate in the case of mixed codes.
|
|
|
2885
|
|
|
2886 So now consider adding some additional ISO 8859/1 text to the buffer.
|
|
|
2887 If it includes any ISO 8859/1 codes that are used by different
|
|
|
2888 characters in ISO 8859/2, you now have a file that cannot be
|
|
|
2889 mechanically disentangled. You need a human being who can recognize
|
|
|
2890 that @emph{this is German and Swedish} and stays in Latin-1, while
|
|
|
2891 @emph{that is Polish} and needs to be recoded to Latin-2.
|
|
|
2892
|
|
|
2893 Moral: switch to a universal coded character set, preferably Unicode
|
|
|
2894 using the UTF-8 transformation format. If you really need the space,
|
|
|
2895 compress your files.
|
|
|
2896
|
|
|
2897
|
|
|
2898 @node Unification Internals, , What Unification Cannot Do for You, Charset Unification
|
|
|
2899 @subsection Internals
|
|
|
2900
|
|
|
2901 No internals documentation yet.
|
|
|
2902
|
|
|
2903 @file{unity-utils.el} provides one utility function.
|
|
|
2904
|
|
|
2905 @defun unity-dump-tables
|
|
|
2906
|
|
|
2907 Dump the temporary table created by loading @file{unity-utils.el}
|
|
|
2908 to @file{unity-tables.el}. Loading the latter file initializes
|
|
|
2909 @samp{unity-equivalences}.
|
|
|
2910 @end defun
|
|
|
2911
|
|
|
2912
|
|
|
2913 @node Charsets and Coding Systems, , Charset Unification, MULE
|
|
|
2914 @subsection Charsets and Coding Systems
|
|
|
2915
|
|
|
2916 This section provides reference lists of Mule charsets and coding
|
|
|
2917 systems. Mule charsets are typically named by character set and
|
|
|
2918 standard.
|
|
|
2919
|
|
|
2920 @table @strong
|
|
|
2921 @item ASCII variants
|
|
|
2922
|
|
|
2923 Identification of equivalent characters in these sets is not properly
|
|
|
2924 implemented. Unification does not distinguish the two charsets.
|
|
|
2925
|
|
|
2926 @samp{ascii} @samp{latin-jisx0201}
|
|
|
2927
|
|
|
2928 @item Extended Latin
|
|
|
2929
|
|
|
2930 Characters from the following ISO 2022 conformant charsets are
|
|
|
2931 identified with equivalents in other charsets in the group by
|
|
|
2932 Unification.
|
|
|
2933
|
|
|
2934 @samp{latin-iso8859-1} @samp{latin-iso8859-15} @samp{latin-iso8859-2}
|
|
|
2935 @samp{latin-iso8859-3} @samp{latin-iso8859-4} @samp{latin-iso8859-9}
|
|
|
2936 @samp{latin-iso8859-13} @samp{latin-iso8859-16}
|
|
|
2937
|
|
|
2938 The follow charsets are Latin variants which are not understood by
|
|
|
2939 Unification. In addition, many of the Asian language standards provide
|
|
|
2940 ASCII, at least, and sometimes other Latin characters. None of these
|
|
|
2941 are identified with their ISO 8859 equivalents.
|
|
|
2942
|
|
|
2943 @samp{vietnamese-viscii-lower}
|
|
|
2944 @samp{vietnamese-viscii-upper}
|
|
|
2945
|
|
|
2946 @item Other character sets
|
|
|
2947
|
|
|
2948 @samp{arabic-1-column}
|
|
|
2949 @samp{arabic-2-column}
|
|
|
2950 @samp{arabic-digit}
|
|
|
2951 @samp{arabic-iso8859-6}
|
|
|
2952 @samp{chinese-big5-1}
|
|
|
2953 @samp{chinese-big5-2}
|
|
|
2954 @samp{chinese-cns11643-1}
|
|
|
2955 @samp{chinese-cns11643-2}
|
|
|
2956 @samp{chinese-cns11643-3}
|
|
|
2957 @samp{chinese-cns11643-4}
|
|
|
2958 @samp{chinese-cns11643-5}
|
|
|
2959 @samp{chinese-cns11643-6}
|
|
|
2960 @samp{chinese-cns11643-7}
|
|
|
2961 @samp{chinese-gb2312}
|
|
|
2962 @samp{chinese-isoir165}
|
|
|
2963 @samp{cyrillic-iso8859-5}
|
|
|
2964 @samp{ethiopic}
|
|
|
2965 @samp{greek-iso8859-7}
|
|
|
2966 @samp{hebrew-iso8859-8}
|
|
|
2967 @samp{ipa}
|
|
|
2968 @samp{japanese-jisx0208}
|
|
|
2969 @samp{japanese-jisx0208-1978}
|
|
|
2970 @samp{japanese-jisx0212}
|
|
|
2971 @samp{katakana-jisx0201}
|
|
|
2972 @samp{korean-ksc5601}
|
|
|
2973 @samp{sisheng}
|
|
|
2974 @samp{thai-tis620}
|
|
|
2975 @samp{thai-xtis}
|
|
|
2976
|
|
|
2977 @item Non-graphic charsets
|
|
|
2978
|
|
|
2979 @samp{control-1}
|
|
|
2980 @end table
|
|
|
2981
|
|
|
2982 @table @strong
|
|
|
2983 @item No conversion
|
|
|
2984
|
|
|
2985 Some of these coding systems may specify EOL conventions. Note that
|
|
|
2986 @samp{iso-8859-1} is a no-conversion coding system, not an ISO 2022
|
|
|
2987 coding system. Although unification attempts to compensate for this, it
|
|
|
2988 is possible that the @samp{iso-8859-1} coding system will behave
|
|
|
2989 differently from other ISO 8859 coding systems.
|
|
|
2990
|
|
|
2991 @samp{binary} @samp{no-conversion} @samp{raw-text} @samp{iso-8859-1}
|
|
|
2992
|
|
|
2993 @item Latin coding systems
|
|
|
2994
|
|
|
2995 These coding systems are all single-byte, 8-bit ISO 2022 coding systems,
|
|
|
2996 combining ASCII in the GL register (bytes with high-bit clear) and an
|
|
|
2997 extended Latin character set in the GR register (bytes with high-bit set).
|
|
|
2998
|
|
|
2999 @samp{iso-8859-15} @samp{iso-8859-2} @samp{iso-8859-3} @samp{iso-8859-4}
|
|
|
3000 @samp{iso-8859-9} @samp{iso-8859-13} @samp{iso-8859-14} @samp{iso-8859-16}
|
|
|
3001
|
|
|
3002 These coding systems are single-byte, 8-bit coding systems that do not
|
|
|
3003 conform to international standards. They should be avoided in all
|
|
|
3004 potentially multilingual contexts, including any text distributed over
|
|
|
3005 the Internet and World Wide Web.
|
|
|
3006
|
|
|
3007 @samp{windows-1251}
|
|
|
3008
|
|
|
3009 @item Multilingual coding systems
|
|
|
3010
|
|
|
3011 The following ISO-2022-based coding systems are useful for multilingual
|
|
|
3012 text.
|
|
|
3013
|
|
|
3014 @samp{ctext} @samp{iso-2022-lock} @samp{iso-2022-7} @samp{iso-2022-7bit}
|
|
|
3015 @samp{iso-2022-7bit-ss2} @samp{iso-2022-8} @samp{iso-2022-8bit-ss2}
|
|
|
3016
|
|
|
3017 XEmacs also supports Unicode with the Mule-UCS package. These are the
|
|
|
3018 preferred coding systems for multilingual use. (There is a possible
|
|
|
3019 exception for texts that mix several Asian ideographic character sets.)
|
|
|
3020
|
|
|
3021 @samp{utf-16-be} @samp{utf-16-be-no-signature} @samp{utf-16-le}
|
|
|
3022 @samp{utf-16-le-no-signature} @samp{utf-7} @samp{utf-7-safe}
|
|
|
3023 @samp{utf-8} @samp{utf-8-ws}
|
|
|
3024
|
|
|
3025 Development versions of XEmacs (the 21.5 series) support Unicode
|
|
|
3026 internally, with (at least) the following coding systems implemented:
|
|
|
3027
|
|
|
3028 @samp{utf-16-be} @samp{utf-16-be-bom} @samp{utf-16-le}
|
|
|
3029 @samp{utf-16-le-bom} @samp{utf-8} @samp{utf-8-bom}
|
|
|
3030
|
|
|
3031 @item Asian ideographic languages
|
|
|
3032
|
|
|
3033 The following coding systems are based on ISO 2022, and are more or less
|
|
|
3034 suitable for encoding multilingual texts. They all can represent ASCII
|
|
|
3035 at least, and sometimes several other foreign character sets, without
|
|
|
3036 resort to arbitrary ISO 2022 designations. However, these subsets are
|
|
|
3037 not identified with the corresponding national standards in XEmacs Mule.
|
|
|
3038
|
|
|
3039 @samp{chinese-euc} @samp{cn-big5} @samp{cn-gb-2312} @samp{gb2312}
|
|
|
3040 @samp{hz} @samp{hz-gb-2312} @samp{old-jis} @samp{japanese-euc}
|
|
|
3041 @samp{junet} @samp{euc-japan} @samp{euc-jp} @samp{iso-2022-jp}
|
|
|
3042 @samp{iso-2022-jp-1978-irv} @samp{iso-2022-jp-2} @samp{euc-kr}
|
|
|
3043 @samp{korean-euc} @samp{iso-2022-kr} @samp{iso-2022-int-1}
|
|
|
3044
|
|
|
3045 The following coding systems cannot be used for general multilingual
|
|
|
3046 text and do not cooperate well with other coding systems.
|
|
|
3047
|
|
|
3048 @samp{big5} @samp{shift_jis}
|
|
|
3049
|
|
|
3050 @item Other languages
|
|
|
3051
|
|
|
3052 The following coding systems are based on ISO 2022. Though none of them
|
|
|
3053 provides any Latin characters beyond ASCII, XEmacs Mule allows (and up
|
|
|
3054 to 21.4 defaults to) use of ISO 2022 control sequences to designate
|
|
|
3055 other character sets for inclusion the text.
|
|
|
3056
|
|
|
3057 @samp{iso-8859-5} @samp{iso-8859-7} @samp{iso-8859-8}
|
|
|
3058 @samp{ctext-hebrew}
|
|
|
3059
|
|
|
3060 The following are character sets that do not conform to ISO 2022 and
|
|
|
3061 thus cannot be safely used in a multilingual context.
|
|
|
3062
|
|
|
3063 @samp{alternativnyj} @samp{koi8-r} @samp{tis-620} @samp{viqr}
|
|
|
3064 @samp{viscii} @samp{vscii}
|
|
|
3065
|
|
|
3066 @item Special coding systems
|
|
|
3067
|
|
|
3068 Mule uses the following coding systems for special purposes.
|
|
|
3069
|
|
|
3070 @samp{automatic-conversion} @samp{undecided} @samp{escape-quoted}
|
|
|
3071
|
|
|
3072 @samp{escape-quoted} is especially important, as it is used internally
|
|
|
3073 as the coding system for autosaved data.
|
|
|
3074
|
|
|
3075 The following coding systems are aliases for others, and are used for
|
|
|
3076 communication with the host operating system.
|
|
|
3077
|
|
|
3078 @samp{file-name} @samp{keyboard} @samp{terminal}
|
|
|
3079
|
|
|
3080 @end table
|
|
|
3081
|
|
|
3082 Mule detection of coding systems is actually limited to detection of
|
|
|
3083 classes of coding systems called @dfn{coding categories}. These coding
|
|
|
3084 categories are identified by the ISO 2022 control sequences they use, if
|
|
|
3085 any, by their conformance to ISO 2022 restrictions on code points that
|
|
|
3086 may be used, and by characteristic patterns of use of 8-bit code points.
|
|
|
3087
|
|
|
3088 @samp{no-conversion}
|
|
|
3089 @samp{utf-8}
|
|
|
3090 @samp{ucs-4}
|
|
|
3091 @samp{iso-7}
|
|
|
3092 @samp{iso-lock-shift}
|
|
|
3093 @samp{iso-8-1}
|
|
|
3094 @samp{iso-8-2}
|
|
|
3095 @samp{iso-8-designate}
|
|
|
3096 @samp{shift-jis}
|
|
|
3097 @samp{big5}
|
|
|
3098
|
|
|
3099
|
|
|
3100 @c end of mule.texi
|
|
|
3101
|
