|
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.
|
|
428
|
27 @end menu
|
|
|
28
|
|
442
|
29 @node Internationalization Terminology, Charsets, , MULE
|
|
428
|
30 @section Internationalization Terminology
|
|
|
31
|
|
442
|
32 In internationalization terminology, a string of text is divided up
|
|
428
|
33 into @dfn{characters}, which are the printable units that make up the
|
|
|
34 text. A single character is (for example) a capital @samp{A}, the
|
|
442
|
35 number @samp{2}, a Katakana character, a Hangul character, a Kanji
|
|
|
36 ideograph (an @dfn{ideograph} is a ``picture'' character, such as is
|
|
|
37 used in Japanese Kanji, Chinese Hanzi, and Korean Hanja; typically there
|
|
|
38 are thousands of such ideographs in each language), etc. The basic
|
|
|
39 property of a character is that it is the smallest unit of text with
|
|
|
40 semantic significance in text processing.
|
|
|
41
|
|
|
42 Human beings normally process text visually, so to a first approximation
|
|
|
43 a character may be identified with its shape. Note that the same
|
|
|
44 character may be drawn by two different people (or in two different
|
|
|
45 fonts) in slightly different ways, although the "basic shape" will be the
|
|
|
46 same. But consider the works of Scott Kim; human beings can recognize
|
|
|
47 hugely variant shapes as the "same" character. Sometimes, especially
|
|
|
48 where characters are extremely complicated to write, completely
|
|
|
49 different shapes may be defined as the "same" character in national
|
|
|
50 standards. The Taiwanese variant of Hanzi is generally the most
|
|
444
|
51 complicated; over the centuries, the Japanese, Koreans, and the People's
|
|
442
|
52 Republic of China have adopted simplifications of the shape, but the
|
|
|
53 line of descent from the original shape is recorded, and the meanings
|
|
|
54 and pronunciation of different forms of the same character are
|
|
|
55 considered to be identical within each language. (Of course, it may
|
|
|
56 take a specialist to recognize the related form; the point is that the
|
|
|
57 relations are standardized, despite the differing shapes.)
|
|
428
|
58
|
|
|
59 In some cases, the differences will be significant enough that it is
|
|
|
60 actually possible to identify two or more distinct shapes that both
|
|
|
61 represent the same character. For example, the lowercase letters
|
|
440
|
62 @samp{a} and @samp{g} each have two distinct possible shapes---the
|
|
428
|
63 @samp{a} can optionally have a curved tail projecting off the top, and
|
|
|
64 the @samp{g} can be formed either of two loops, or of one loop and a
|
|
|
65 tail hanging off the bottom. Such distinct possible shapes of a
|
|
|
66 character are called @dfn{glyphs}. The important characteristic of two
|
|
|
67 glyphs making up the same character is that the choice between one or
|
|
|
68 the other is purely stylistic and has no linguistic effect on a word
|
|
|
69 (this is the reason why a capital @samp{A} and lowercase @samp{a}
|
|
440
|
70 are different characters rather than different glyphs---e.g.
|
|
428
|
71 @samp{Aspen} is a city while @samp{aspen} is a kind of tree).
|
|
|
72
|
|
|
73 Note that @dfn{character} and @dfn{glyph} are used differently
|
|
|
74 here than elsewhere in XEmacs.
|
|
|
75
|
|
442
|
76 A @dfn{character set} is essentially a set of related characters. ASCII,
|
|
428
|
77 for example, is a set of 94 characters (or 128, if you count
|
|
|
78 non-printing characters). Other character sets are ISO8859-1 (ASCII
|
|
|
79 plus various accented characters and other international symbols),
|
|
442
|
80 JIS X 0201 (ASCII, more or less, plus half-width Katakana), JIS X 0208
|
|
|
81 (Japanese Kanji), JIS X 0212 (a second set of less-used Japanese Kanji),
|
|
428
|
82 GB2312 (Mainland Chinese Hanzi), etc.
|
|
|
83
|
|
442
|
84 The definition of a character set will implicitly or explicitly give
|
|
|
85 it an @dfn{ordering}, a way of assigning a number to each character in
|
|
|
86 the set. For many character sets, there is a natural ordering, for
|
|
|
87 example the ``ABC'' ordering of the Roman letters. But it is not clear
|
|
|
88 whether digits should come before or after the letters, and in fact
|
|
|
89 different European languages treat the ordering of accented characters
|
|
|
90 differently. It is useful to use the natural order where available, of
|
|
|
91 course. The number assigned to any particular character is called the
|
|
|
92 character's @dfn{code point}. (Within a given character set, each
|
|
|
93 character has a unique code point. Thus the word "set" is ill-chosen;
|
|
|
94 different orderings of the same characters are different character sets.
|
|
|
95 Identifying characters is simple enough for alphabetic character sets,
|
|
|
96 but the difference in ordering can cause great headaches when the same
|
|
|
97 thousands of characters are used by different cultures as in the Hanzi.)
|
|
428
|
98
|
|
442
|
99 A code point may be broken into a number of @dfn{position codes}. The
|
|
|
100 number of position codes required to index a particular character in a
|
|
|
101 character set is called the @dfn{dimension} of the character set. For
|
|
|
102 practical purposes, a position code may be thought of as a byte-sized
|
|
|
103 index. The printing characters of ASCII, being a relatively small
|
|
|
104 character set, is of dimension one, and each character in the set is
|
|
|
105 indexed using a single position code, in the range 1 through 94. Use of
|
|
|
106 this unusual range, rather than the familiar 33 through 126, is an
|
|
|
107 intentional abstraction; to understand the programming issues you must
|
|
|
108 break the equation between character sets and encodings.
|
|
|
109
|
|
|
110 JIS X 0208, i.e. Japanese Kanji, has thousands of characters, and is
|
|
|
111 of dimension two -- every character is indexed by two position codes,
|
|
|
112 each in the range 1 through 94. (This number ``94'' is not a
|
|
|
113 coincidence; we shall see that the JIS position codes were chosen so
|
|
|
114 that JIS kanji could be encoded without using codes that in ASCII are
|
|
|
115 associated with device control functions.) Note that the choice of the
|
|
|
116 range here is somewhat arbitrary. You could just as easily index the
|
|
|
117 printing characters in ASCII using numbers in the range 0 through 93, 2
|
|
|
118 through 95, 3 through 96, etc. In fact, the standardized
|
|
|
119 @emph{encoding} for the ASCII @emph{character set} uses the range 33
|
|
|
120 through 126.
|
|
428
|
121
|
|
|
122 An @dfn{encoding} is a way of numerically representing characters from
|
|
|
123 one or more character sets into a stream of like-sized numerical values
|
|
|
124 called @dfn{words}; typically these are 8-bit, 16-bit, or 32-bit
|
|
|
125 quantities. If an encoding encompasses only one character set, then the
|
|
|
126 position codes for the characters in that character set could be used
|
|
442
|
127 directly. (This is the case with the trivial cipher used by children,
|
|
|
128 assigning 1 to `A', 2 to `B', and so on.) However, even with ASCII,
|
|
|
129 other considerations intrude. For example, why are the upper- and
|
|
|
130 lowercase alphabets separated by 8 characters? Why do the digits start
|
|
|
131 with `0' being assigned the code 48? In both cases because semantically
|
|
|
132 interesting operations (case conversion and numerical value extraction)
|
|
|
133 become convenient masking operations. Other artificial aspects (the
|
|
|
134 control characters being assigned to codes 0--31 and 127) are historical
|
|
|
135 accidents. (The use of 127 for @samp{DEL} is an artifact of the "punch
|
|
|
136 once" nature of paper tape, for example.)
|
|
|
137
|
|
|
138 Naive use of the position code is not possible, however, if more than
|
|
|
139 one character set is to be used in the encoding. For example, printed
|
|
|
140 Japanese text typically requires characters from multiple character sets
|
|
|
141 -- ASCII, JIS X 0208, and JIS X 0212, to be specific. Each of these is
|
|
|
142 indexed using one or more position codes in the range 1 through 94, so
|
|
|
143 the position codes could not be used directly or there would be no way
|
|
|
144 to tell which character was meant. Different Japanese encodings handle
|
|
|
145 this differently -- JIS uses special escape characters to denote
|
|
|
146 different character sets; EUC sets the high bit of the position codes
|
|
|
147 for JIS X 0208 and JIS X 0212, and puts a special extra byte before each
|
|
|
148 JIS X 0212 character; etc. (JIS, EUC, and most of the other encodings
|
|
|
149 you will encounter in files are 7-bit or 8-bit encodings. There is one
|
|
|
150 common 16-bit encoding, which is Unicode; this strives to represent all
|
|
|
151 the world's characters in a single large character set. 32-bit
|
|
|
152 encodings are often used internally in programs, such as XEmacs with
|
|
|
153 MULE support, to simplify the code that manipulates them; however, they
|
|
|
154 are not used externally because they are not very space-efficient.)
|
|
|
155
|
|
|
156 A general method of handling text using multiple character sets
|
|
|
157 (whether for multilingual text, or simply text in an extremely
|
|
|
158 complicated single language like Japanese) is defined in the
|
|
|
159 international standard ISO 2022. ISO 2022 will be discussed in more
|
|
|
160 detail later (@pxref{ISO 2022}), but for now suffice it to say that text
|
|
|
161 needs control functions (at least spacing), and if escape sequences are
|
|
|
162 to be used, an escape sequence introducer. It was decided to make all
|
|
|
163 text streams compatible with ASCII in the sense that the codes 0--31
|
|
|
164 (and 128-159) would always be control codes, never graphic characters,
|
|
|
165 and where defined by the character set the @samp{SPC} character would be
|
|
|
166 assigned code 32, and @samp{DEL} would be assigned 127. Thus there are
|
|
|
167 94 code points remaining if 7 bits are used. This is the reason that
|
|
|
168 most character sets are defined using position codes in the range 1
|
|
|
169 through 94. Then ISO 2022 compatible encodings are produced by shifting
|
|
|
170 the position codes 1 to 94 into character codes 33 to 126, or (if 8 bit
|
|
|
171 codes are available) into character codes 161 to 254.
|
|
428
|
172
|
|
|
173 Encodings are classified as either @dfn{modal} or @dfn{non-modal}. In
|
|
442
|
174 a @dfn{modal encoding}, there are multiple states that the encoding can
|
|
|
175 be in, and the interpretation of the values in the stream depends on the
|
|
428
|
176 current global state of the encoding. Special values in the encoding,
|
|
|
177 called @dfn{escape sequences}, are used to change the global state.
|
|
|
178 JIS, for example, is a modal encoding. The bytes @samp{ESC $ B}
|
|
|
179 indicate that, from then on, bytes are to be interpreted as position
|
|
442
|
180 codes for JIS X 0208, rather than as ASCII. This effect is cancelled
|
|
428
|
181 using the bytes @samp{ESC ( B}, which mean ``switch from whatever the
|
|
442
|
182 current state is to ASCII''. To switch to JIS X 0212, the escape
|
|
|
183 sequence @samp{ESC $ ( D}. (Note that here, as is common, the escape
|
|
|
184 sequences do in fact begin with @samp{ESC}. This is not necessarily the
|
|
|
185 case, however. Some encodings use control characters called "locking
|
|
|
186 shifts" (effect persists until cancelled) to switch character sets.)
|
|
428
|
187
|
|
442
|
188 A @dfn{non-modal encoding} has no global state that extends past the
|
|
428
|
189 character currently being interpreted. EUC, for example, is a
|
|
442
|
190 non-modal encoding. Characters in JIS X 0208 are encoded by setting
|
|
|
191 the high bit of the position codes, and characters in JIS X 0212 are
|
|
428
|
192 encoded by doing the same but also prefixing the character with the
|
|
|
193 byte 0x8F.
|
|
|
194
|
|
|
195 The advantage of a modal encoding is that it is generally more
|
|
442
|
196 space-efficient, and is easily extendible because there are essentially
|
|
428
|
197 an arbitrary number of escape sequences that can be created. The
|
|
|
198 disadvantage, however, is that it is much more difficult to work with
|
|
|
199 if it is not being processed in a sequential manner. In the non-modal
|
|
|
200 EUC encoding, for example, the byte 0x41 always refers to the letter
|
|
|
201 @samp{A}; whereas in JIS, it could either be the letter @samp{A}, or
|
|
442
|
202 one of the two position codes in a JIS X 0208 character, or one of the
|
|
|
203 two position codes in a JIS X 0212 character. Determining exactly which
|
|
428
|
204 one is meant could be difficult and time-consuming if the previous
|
|
442
|
205 bytes in the string have not already been processed, or impossible if
|
|
|
206 they are drawn from an external stream that cannot be rewound.
|
|
428
|
207
|
|
|
208 Non-modal encodings are further divided into @dfn{fixed-width} and
|
|
|
209 @dfn{variable-width} formats. A fixed-width encoding always uses
|
|
|
210 the same number of words per character, whereas a variable-width
|
|
|
211 encoding does not. EUC is a good example of a variable-width
|
|
|
212 encoding: one to three bytes are used per character, depending on
|
|
|
213 the character set. 16-bit and 32-bit encodings are nearly always
|
|
|
214 fixed-width, and this is in fact one of the main reasons for using
|
|
|
215 an encoding with a larger word size. The advantages of fixed-width
|
|
|
216 encodings should be obvious. The advantages of variable-width
|
|
|
217 encodings are that they are generally more space-efficient and allow
|
|
442
|
218 for compatibility with existing 8-bit encodings such as ASCII. (For
|
|
|
219 example, in Unicode ASCII characters are simply promoted to a 16-bit
|
|
|
220 representation. That means that every ASCII character contains a
|
|
|
221 @samp{NUL} byte; evidently all of the standard string manipulation
|
|
|
222 functions will lose badly in a fixed-width Unicode environment.)
|
|
428
|
223
|
|
442
|
224 The bytes in an 8-bit encoding are often referred to as @dfn{octets}
|
|
|
225 rather than simply as bytes. This terminology dates back to the days
|
|
|
226 before 8-bit bytes were universal, when some computers had 9-bit bytes,
|
|
|
227 others had 10-bit bytes, etc.
|
|
428
|
228
|
|
442
|
229 @node Charsets, MULE Characters, Internationalization Terminology, MULE
|
|
428
|
230 @section Charsets
|
|
|
231
|
|
|
232 A @dfn{charset} in MULE is an object that encapsulates a
|
|
|
233 particular character set as well as an ordering of those characters.
|
|
|
234 Charsets are permanent objects and are named using symbols, like
|
|
|
235 faces.
|
|
|
236
|
|
|
237 @defun charsetp object
|
|
|
238 This function returns non-@code{nil} if @var{object} is a charset.
|
|
|
239 @end defun
|
|
|
240
|
|
|
241 @menu
|
|
|
242 * Charset Properties:: Properties of a charset.
|
|
|
243 * Basic Charset Functions:: Functions for working with charsets.
|
|
|
244 * Charset Property Functions:: Functions for accessing charset properties.
|
|
|
245 * Predefined Charsets:: Predefined charset objects.
|
|
|
246 @end menu
|
|
|
247
|
|
442
|
248 @node Charset Properties, Basic Charset Functions, , Charsets
|
|
428
|
249 @subsection Charset Properties
|
|
|
250
|
|
|
251 Charsets have the following properties:
|
|
|
252
|
|
|
253 @table @code
|
|
|
254 @item name
|
|
|
255 A symbol naming the charset. Every charset must have a different name;
|
|
|
256 this allows a charset to be referred to using its name rather than
|
|
|
257 the actual charset object.
|
|
|
258 @item doc-string
|
|
|
259 A documentation string describing the charset.
|
|
|
260 @item registry
|
|
|
261 A regular expression matching the font registry field for this character
|
|
|
262 set. For example, both the @code{ascii} and @code{latin-iso8859-1}
|
|
|
263 charsets use the registry @code{"ISO8859-1"}. This field is used to
|
|
|
264 choose an appropriate font when the user gives a general font
|
|
|
265 specification such as @samp{-*-courier-medium-r-*-140-*}, i.e. a
|
|
|
266 14-point upright medium-weight Courier font.
|
|
|
267 @item dimension
|
|
|
268 Number of position codes used to index a character in the character set.
|
|
|
269 XEmacs/MULE can only handle character sets of dimension 1 or 2.
|
|
|
270 This property defaults to 1.
|
|
|
271 @item chars
|
|
|
272 Number of characters in each dimension. In XEmacs/MULE, the only
|
|
|
273 allowed values are 94 or 96. (There are a couple of pre-defined
|
|
|
274 character sets, such as ASCII, that do not follow this, but you cannot
|
|
|
275 define new ones like this.) Defaults to 94. Note that if the dimension
|
|
|
276 is 2, the character set thus described is 94x94 or 96x96.
|
|
|
277 @item columns
|
|
|
278 Number of columns used to display a character in this charset.
|
|
|
279 Only used in TTY mode. (Under X, the actual width of a character
|
|
|
280 can be derived from the font used to display the characters.)
|
|
|
281 If unspecified, defaults to the dimension. (This is almost
|
|
|
282 always the correct value, because character sets with dimension 2
|
|
|
283 are usually ideograph character sets, which need two columns to
|
|
|
284 display the intricate ideographs.)
|
|
|
285 @item direction
|
|
|
286 A symbol, either @code{l2r} (left-to-right) or @code{r2l}
|
|
|
287 (right-to-left). Defaults to @code{l2r}. This specifies the
|
|
|
288 direction that the text should be displayed in, and will be
|
|
|
289 left-to-right for most charsets but right-to-left for Hebrew
|
|
|
290 and Arabic. (Right-to-left display is not currently implemented.)
|
|
|
291 @item final
|
|
|
292 Final byte of the standard ISO 2022 escape sequence designating this
|
|
|
293 charset. Must be supplied. Each combination of (@var{dimension},
|
|
|
294 @var{chars}) defines a separate namespace for final bytes, and each
|
|
|
295 charset within a particular namespace must have a different final byte.
|
|
|
296 Note that ISO 2022 restricts the final byte to the range 0x30 - 0x7E if
|
|
|
297 dimension == 1, and 0x30 - 0x5F if dimension == 2. Note also that final
|
|
|
298 bytes in the range 0x30 - 0x3F are reserved for user-defined (not
|
|
|
299 official) character sets. For more information on ISO 2022, see @ref{Coding
|
|
|
300 Systems}.
|
|
|
301 @item graphic
|
|
|
302 0 (use left half of font on output) or 1 (use right half of font on
|
|
|
303 output). Defaults to 0. This specifies how to convert the position
|
|
|
304 codes that index a character in a character set into an index into the
|
|
|
305 font used to display the character set. With @code{graphic} set to 0,
|
|
|
306 position codes 33 through 126 map to font indices 33 through 126; with
|
|
|
307 it set to 1, position codes 33 through 126 map to font indices 161
|
|
|
308 through 254 (i.e. the same number but with the high bit set). For
|
|
|
309 example, for a font whose registry is ISO8859-1, the left half of the
|
|
|
310 font (octets 0x20 - 0x7F) is the @code{ascii} charset, while the right
|
|
|
311 half (octets 0xA0 - 0xFF) is the @code{latin-iso8859-1} charset.
|
|
|
312 @item ccl-program
|
|
|
313 A compiled CCL program used to convert a character in this charset into
|
|
|
314 an index into the font. This is in addition to the @code{graphic}
|
|
|
315 property. If a CCL program is defined, the position codes of a
|
|
|
316 character will first be processed according to @code{graphic} and
|
|
|
317 then passed through the CCL program, with the resulting values used
|
|
|
318 to index the font.
|
|
|
319
|
|
442
|
320 This is used, for example, in the Big5 character set (used in Taiwan).
|
|
428
|
321 This character set is not ISO-2022-compliant, and its size (94x157) does
|
|
|
322 not fit within the maximum 96x96 size of ISO-2022-compliant character
|
|
|
323 sets. As a result, XEmacs/MULE splits it (in a rather complex fashion,
|
|
|
324 so as to group the most commonly used characters together) into two
|
|
|
325 charset objects (@code{big5-1} and @code{big5-2}), each of size 94x94,
|
|
|
326 and each charset object uses a CCL program to convert the modified
|
|
|
327 position codes back into standard Big5 indices to retrieve a character
|
|
|
328 from a Big5 font.
|
|
|
329 @end table
|
|
|
330
|
|
442
|
331 Most of the above properties can only be set when the charset is
|
|
|
332 initialized, and cannot be changed later.
|
|
|
333 @xref{Charset Property Functions}.
|
|
428
|
334
|
|
442
|
335 @node Basic Charset Functions, Charset Property Functions, Charset Properties, Charsets
|
|
428
|
336 @subsection Basic Charset Functions
|
|
|
337
|
|
|
338 @defun find-charset charset-or-name
|
|
|
339 This function retrieves the charset of the given name. If
|
|
|
340 @var{charset-or-name} is a charset object, it is simply returned.
|
|
|
341 Otherwise, @var{charset-or-name} should be a symbol. If there is no
|
|
|
342 such charset, @code{nil} is returned. Otherwise the associated charset
|
|
|
343 object is returned.
|
|
|
344 @end defun
|
|
|
345
|
|
|
346 @defun get-charset name
|
|
|
347 This function retrieves the charset of the given name. Same as
|
|
|
348 @code{find-charset} except an error is signalled if there is no such
|
|
|
349 charset instead of returning @code{nil}.
|
|
|
350 @end defun
|
|
|
351
|
|
|
352 @defun charset-list
|
|
|
353 This function returns a list of the names of all defined charsets.
|
|
|
354 @end defun
|
|
|
355
|
|
|
356 @defun make-charset name doc-string props
|
|
|
357 This function defines a new character set. This function is for use
|
|
442
|
358 with MULE support. @var{name} is a symbol, the name by which the
|
|
428
|
359 character set is normally referred. @var{doc-string} is a string
|
|
|
360 describing the character set. @var{props} is a property list,
|
|
|
361 describing the specific nature of the character set. The recognized
|
|
|
362 properties are @code{registry}, @code{dimension}, @code{columns},
|
|
|
363 @code{chars}, @code{final}, @code{graphic}, @code{direction}, and
|
|
|
364 @code{ccl-program}, as previously described.
|
|
|
365 @end defun
|
|
|
366
|
|
|
367 @defun make-reverse-direction-charset charset new-name
|
|
|
368 This function makes a charset equivalent to @var{charset} but which goes
|
|
|
369 in the opposite direction. @var{new-name} is the name of the new
|
|
|
370 charset. The new charset is returned.
|
|
|
371 @end defun
|
|
|
372
|
|
|
373 @defun charset-from-attributes dimension chars final &optional direction
|
|
|
374 This function returns a charset with the given @var{dimension},
|
|
|
375 @var{chars}, @var{final}, and @var{direction}. If @var{direction} is
|
|
|
376 omitted, both directions will be checked (left-to-right will be returned
|
|
|
377 if character sets exist for both directions).
|
|
|
378 @end defun
|
|
|
379
|
|
|
380 @defun charset-reverse-direction-charset charset
|
|
|
381 This function returns the charset (if any) with the same dimension,
|
|
|
382 number of characters, and final byte as @var{charset}, but which is
|
|
|
383 displayed in the opposite direction.
|
|
|
384 @end defun
|
|
|
385
|
|
442
|
386 @node Charset Property Functions, Predefined Charsets, Basic Charset Functions, Charsets
|
|
428
|
387 @subsection Charset Property Functions
|
|
|
388
|
|
442
|
389 All of these functions accept either a charset name or charset object.
|
|
428
|
390
|
|
|
391 @defun charset-property charset prop
|
|
|
392 This function returns property @var{prop} of @var{charset}.
|
|
|
393 @xref{Charset Properties}.
|
|
|
394 @end defun
|
|
|
395
|
|
442
|
396 Convenience functions are also provided for retrieving individual
|
|
428
|
397 properties of a charset.
|
|
|
398
|
|
|
399 @defun charset-name charset
|
|
|
400 This function returns the name of @var{charset}. This will be a symbol.
|
|
|
401 @end defun
|
|
|
402
|
|
444
|
403 @defun charset-description charset
|
|
|
404 This function returns the documentation string of @var{charset}.
|
|
428
|
405 @end defun
|
|
|
406
|
|
|
407 @defun charset-registry charset
|
|
|
408 This function returns the registry of @var{charset}.
|
|
|
409 @end defun
|
|
|
410
|
|
|
411 @defun charset-dimension charset
|
|
|
412 This function returns the dimension of @var{charset}.
|
|
|
413 @end defun
|
|
|
414
|
|
|
415 @defun charset-chars charset
|
|
|
416 This function returns the number of characters per dimension of
|
|
|
417 @var{charset}.
|
|
|
418 @end defun
|
|
|
419
|
|
444
|
420 @defun charset-width charset
|
|
428
|
421 This function returns the number of display columns per character (in
|
|
|
422 TTY mode) of @var{charset}.
|
|
|
423 @end defun
|
|
|
424
|
|
|
425 @defun charset-direction charset
|
|
440
|
426 This function returns the display direction of @var{charset}---either
|
|
428
|
427 @code{l2r} or @code{r2l}.
|
|
|
428 @end defun
|
|
|
429
|
|
444
|
430 @defun charset-iso-final-char charset
|
|
428
|
431 This function returns the final byte of the ISO 2022 escape sequence
|
|
|
432 designating @var{charset}.
|
|
|
433 @end defun
|
|
|
434
|
|
444
|
435 @defun charset-iso-graphic-plane charset
|
|
428
|
436 This function returns either 0 or 1, depending on whether the position
|
|
|
437 codes of characters in @var{charset} map to the left or right half
|
|
|
438 of their font, respectively.
|
|
|
439 @end defun
|
|
|
440
|
|
|
441 @defun charset-ccl-program charset
|
|
|
442 This function returns the CCL program, if any, for converting
|
|
|
443 position codes of characters in @var{charset} into font indices.
|
|
|
444 @end defun
|
|
|
445
|
|
442
|
446 The only property of a charset that can currently be set after
|
|
428
|
447 the charset has been created is the CCL program.
|
|
|
448
|
|
|
449 @defun set-charset-ccl-program charset ccl-program
|
|
|
450 This function sets the @code{ccl-program} property of @var{charset} to
|
|
|
451 @var{ccl-program}.
|
|
|
452 @end defun
|
|
|
453
|
|
442
|
454 @node Predefined Charsets, , Charset Property Functions, Charsets
|
|
428
|
455 @subsection Predefined Charsets
|
|
|
456
|
|
442
|
457 The following charsets are predefined in the C code.
|
|
428
|
458
|
|
|
459 @example
|
|
|
460 Name Type Fi Gr Dir Registry
|
|
|
461 --------------------------------------------------------------
|
|
|
462 ascii 94 B 0 l2r ISO8859-1
|
|
|
463 control-1 94 0 l2r ---
|
|
|
464 latin-iso8859-1 94 A 1 l2r ISO8859-1
|
|
|
465 latin-iso8859-2 96 B 1 l2r ISO8859-2
|
|
|
466 latin-iso8859-3 96 C 1 l2r ISO8859-3
|
|
|
467 latin-iso8859-4 96 D 1 l2r ISO8859-4
|
|
|
468 cyrillic-iso8859-5 96 L 1 l2r ISO8859-5
|
|
|
469 arabic-iso8859-6 96 G 1 r2l ISO8859-6
|
|
|
470 greek-iso8859-7 96 F 1 l2r ISO8859-7
|
|
|
471 hebrew-iso8859-8 96 H 1 r2l ISO8859-8
|
|
|
472 latin-iso8859-9 96 M 1 l2r ISO8859-9
|
|
|
473 thai-tis620 96 T 1 l2r TIS620
|
|
|
474 katakana-jisx0201 94 I 1 l2r JISX0201.1976
|
|
|
475 latin-jisx0201 94 J 0 l2r JISX0201.1976
|
|
|
476 japanese-jisx0208-1978 94x94 @@ 0 l2r JISX0208.1978
|
|
|
477 japanese-jisx0208 94x94 B 0 l2r JISX0208.19(83|90)
|
|
|
478 japanese-jisx0212 94x94 D 0 l2r JISX0212
|
|
|
479 chinese-gb2312 94x94 A 0 l2r GB2312
|
|
|
480 chinese-cns11643-1 94x94 G 0 l2r CNS11643.1
|
|
|
481 chinese-cns11643-2 94x94 H 0 l2r CNS11643.2
|
|
|
482 chinese-big5-1 94x94 0 0 l2r Big5
|
|
|
483 chinese-big5-2 94x94 1 0 l2r Big5
|
|
|
484 korean-ksc5601 94x94 C 0 l2r KSC5601
|
|
|
485 composite 96x96 0 l2r ---
|
|
|
486 @end example
|
|
|
487
|
|
442
|
488 The following charsets are predefined in the Lisp code.
|
|
428
|
489
|
|
|
490 @example
|
|
|
491 Name Type Fi Gr Dir Registry
|
|
|
492 --------------------------------------------------------------
|
|
|
493 arabic-digit 94 2 0 l2r MuleArabic-0
|
|
|
494 arabic-1-column 94 3 0 r2l MuleArabic-1
|
|
|
495 arabic-2-column 94 4 0 r2l MuleArabic-2
|
|
|
496 sisheng 94 0 0 l2r sisheng_cwnn\|OMRON_UDC_ZH
|
|
|
497 chinese-cns11643-3 94x94 I 0 l2r CNS11643.1
|
|
|
498 chinese-cns11643-4 94x94 J 0 l2r CNS11643.1
|
|
|
499 chinese-cns11643-5 94x94 K 0 l2r CNS11643.1
|
|
|
500 chinese-cns11643-6 94x94 L 0 l2r CNS11643.1
|
|
|
501 chinese-cns11643-7 94x94 M 0 l2r CNS11643.1
|
|
|
502 ethiopic 94x94 2 0 l2r Ethio
|
|
|
503 ascii-r2l 94 B 0 r2l ISO8859-1
|
|
|
504 ipa 96 0 1 l2r MuleIPA
|
|
|
505 vietnamese-lower 96 1 1 l2r VISCII1.1
|
|
|
506 vietnamese-upper 96 2 1 l2r VISCII1.1
|
|
|
507 @end example
|
|
|
508
|
|
|
509 For all of the above charsets, the dimension and number of columns are
|
|
|
510 the same.
|
|
|
511
|
|
442
|
512 Note that ASCII, Control-1, and Composite are handled specially.
|
|
428
|
513 This is why some of the fields are blank; and some of the filled-in
|
|
|
514 fields (e.g. the type) are not really accurate.
|
|
|
515
|
|
442
|
516 @node MULE Characters, Composite Characters, Charsets, MULE
|
|
428
|
517 @section MULE Characters
|
|
|
518
|
|
|
519 @defun make-char charset arg1 &optional arg2
|
|
|
520 This function makes a multi-byte character from @var{charset} and octets
|
|
|
521 @var{arg1} and @var{arg2}.
|
|
|
522 @end defun
|
|
|
523
|
|
444
|
524 @defun char-charset character
|
|
|
525 This function returns the character set of char @var{character}.
|
|
428
|
526 @end defun
|
|
|
527
|
|
444
|
528 @defun char-octet character &optional n
|
|
428
|
529 This function returns the octet (i.e. position code) numbered @var{n}
|
|
444
|
530 (should be 0 or 1) of char @var{character}. @var{n} defaults to 0 if omitted.
|
|
428
|
531 @end defun
|
|
|
532
|
|
|
533 @defun find-charset-region start end &optional buffer
|
|
|
534 This function returns a list of the charsets in the region between
|
|
|
535 @var{start} and @var{end}. @var{buffer} defaults to the current buffer
|
|
|
536 if omitted.
|
|
|
537 @end defun
|
|
|
538
|
|
|
539 @defun find-charset-string string
|
|
|
540 This function returns a list of the charsets in @var{string}.
|
|
|
541 @end defun
|
|
|
542
|
|
442
|
543 @node Composite Characters, Coding Systems, MULE Characters, MULE
|
|
428
|
544 @section Composite Characters
|
|
|
545
|
|
442
|
546 Composite characters are not yet completely implemented.
|
|
428
|
547
|
|
|
548 @defun make-composite-char string
|
|
|
549 This function converts a string into a single composite character. The
|
|
|
550 character is the result of overstriking all the characters in the
|
|
|
551 string.
|
|
|
552 @end defun
|
|
|
553
|
|
444
|
554 @defun composite-char-string character
|
|
428
|
555 This function returns a string of the characters comprising a composite
|
|
|
556 character.
|
|
|
557 @end defun
|
|
|
558
|
|
|
559 @defun compose-region start end &optional buffer
|
|
|
560 This function composes the characters in the region from @var{start} to
|
|
|
561 @var{end} in @var{buffer} into one composite character. The composite
|
|
|
562 character replaces the composed characters. @var{buffer} defaults to
|
|
|
563 the current buffer if omitted.
|
|
|
564 @end defun
|
|
|
565
|
|
|
566 @defun decompose-region start end &optional buffer
|
|
|
567 This function decomposes any composite characters in the region from
|
|
|
568 @var{start} to @var{end} in @var{buffer}. This converts each composite
|
|
|
569 character into one or more characters, the individual characters out of
|
|
|
570 which the composite character was formed. Non-composite characters are
|
|
|
571 left as-is. @var{buffer} defaults to the current buffer if omitted.
|
|
|
572 @end defun
|
|
|
573
|
|
442
|
574 @node Coding Systems, CCL, Composite Characters, MULE
|
|
|
575 @section Coding Systems
|
|
|
576
|
|
|
577 A coding system is an object that defines how text containing multiple
|
|
|
578 character sets is encoded into a stream of (typically 8-bit) bytes. The
|
|
|
579 coding system is used to decode the stream into a series of characters
|
|
|
580 (which may be from multiple charsets) when the text is read from a file
|
|
|
581 or process, and is used to encode the text back into the same format
|
|
|
582 when it is written out to a file or process.
|
|
|
583
|
|
|
584 For example, many ISO-2022-compliant coding systems (such as Compound
|
|
|
585 Text, which is used for inter-client data under the X Window System) use
|
|
|
586 escape sequences to switch between different charsets -- Japanese Kanji,
|
|
|
587 for example, is invoked with @samp{ESC $ ( B}; ASCII is invoked with
|
|
|
588 @samp{ESC ( B}; and Cyrillic is invoked with @samp{ESC - L}. See
|
|
|
589 @code{make-coding-system} for more information.
|
|
|
590
|
|
|
591 Coding systems are normally identified using a symbol, and the symbol is
|
|
|
592 accepted in place of the actual coding system object whenever a coding
|
|
|
593 system is called for. (This is similar to how faces and charsets work.)
|
|
|
594
|
|
|
595 @defun coding-system-p object
|
|
|
596 This function returns non-@code{nil} if @var{object} is a coding system.
|
|
|
597 @end defun
|
|
428
|
598
|
|
442
|
599 @menu
|
|
|
600 * Coding System Types:: Classifying coding systems.
|
|
|
601 * ISO 2022:: An international standard for
|
|
|
602 charsets and encodings.
|
|
|
603 * EOL Conversion:: Dealing with different ways of denoting
|
|
|
604 the end of a line.
|
|
|
605 * Coding System Properties:: Properties of a coding system.
|
|
|
606 * Basic Coding System Functions:: Working with coding systems.
|
|
|
607 * Coding System Property Functions:: Retrieving a coding system's properties.
|
|
|
608 * Encoding and Decoding Text:: Encoding and decoding text.
|
|
|
609 * Detection of Textual Encoding:: Determining how text is encoded.
|
|
|
610 * Big5 and Shift-JIS Functions:: Special functions for these non-standard
|
|
|
611 encodings.
|
|
|
612 * Predefined Coding Systems:: Coding systems implemented by MULE.
|
|
|
613 @end menu
|
|
428
|
614
|
|
442
|
615 @node Coding System Types, ISO 2022, , Coding Systems
|
|
|
616 @subsection Coding System Types
|
|
|
617
|
|
|
618 The coding system type determines the basic algorithm XEmacs will use to
|
|
|
619 decode or encode a data stream. Character encodings will be converted
|
|
|
620 to the MULE encoding, escape sequences processed, and newline sequences
|
|
|
621 converted to XEmacs's internal representation. There are three basic
|
|
|
622 classes of coding system type: no-conversion, ISO-2022, and special.
|
|
|
623
|
|
|
624 No conversion allows you to look at the file's internal representation.
|
|
|
625 Since XEmacs is basically a text editor, "no conversion" does convert
|
|
|
626 newline conventions by default. (Use the 'binary coding-system if this
|
|
|
627 is not desired.)
|
|
428
|
628
|
|
442
|
629 ISO 2022 (@pxref{ISO 2022}) is the basic international standard regulating
|
|
|
630 use of "coded character sets for the exchange of data", ie, text
|
|
|
631 streams. ISO 2022 contains functions that make it possible to encode
|
|
|
632 text streams to comply with restrictions of the Internet mail system and
|
|
|
633 de facto restrictions of most file systems (eg, use of the separator
|
|
|
634 character in file names). Coding systems which are not ISO 2022
|
|
|
635 conformant can be difficult to handle. Perhaps more important, they are
|
|
|
636 not adaptable to multilingual information interchange, with the obvious
|
|
|
637 exception of ISO 10646 (Unicode). (Unicode is partially supported by
|
|
|
638 XEmacs with the addition of the Lisp package ucs-conv.)
|
|
|
639
|
|
|
640 The special class of coding systems includes automatic detection, CCL (a
|
|
|
641 "little language" embedded as an interpreter, useful for translating
|
|
|
642 between variants of a single character set), non-ISO-2022-conformant
|
|
|
643 encodings like Unicode, Shift JIS, and Big5, and MULE internal coding.
|
|
|
644 (NB: this list is based on XEmacs 21.2. Terminology may vary slightly
|
|
|
645 for other versions of XEmacs and for GNU Emacs 20.)
|
|
|
646
|
|
|
647 @table @code
|
|
|
648 @item no-conversion
|
|
|
649 No conversion, for binary files, and a few special cases of non-ISO-2022
|
|
|
650 coding systems where conversion is done by hook functions (usually
|
|
|
651 implemented in CCL). On output, graphic characters that are not in
|
|
|
652 ASCII or Latin-1 will be replaced by a @samp{?}. (For a
|
|
|
653 no-conversion-encoded buffer, these characters will only be present if
|
|
|
654 you explicitly insert them.)
|
|
|
655 @item iso2022
|
|
|
656 Any ISO-2022-compliant encoding. Among others, this includes JIS (the
|
|
|
657 Japanese encoding commonly used for e-mail), national variants of EUC
|
|
|
658 (the standard Unix encoding for Japanese and other languages), and
|
|
|
659 Compound Text (an encoding used in X11). You can specify more specific
|
|
|
660 information about the conversion with the @var{flags} argument.
|
|
|
661 @item ucs-4
|
|
|
662 ISO 10646 UCS-4 encoding. A 31-bit fixed-width superset of Unicode.
|
|
|
663 @item utf-8
|
|
|
664 ISO 10646 UTF-8 encoding. A ``file system safe'' transformation format
|
|
|
665 that can be used with both UCS-4 and Unicode.
|
|
|
666 @item undecided
|
|
|
667 Automatic conversion. XEmacs attempts to detect the coding system used
|
|
|
668 in the file.
|
|
|
669 @item shift-jis
|
|
|
670 Shift-JIS (a Japanese encoding commonly used in PC operating systems).
|
|
|
671 @item big5
|
|
|
672 Big5 (the encoding commonly used for Taiwanese).
|
|
|
673 @item ccl
|
|
|
674 The conversion is performed using a user-written pseudo-code program.
|
|
|
675 CCL (Code Conversion Language) is the name of this pseudo-code. For
|
|
|
676 example, CCL is used to map KOI8-R characters (an encoding for Russian
|
|
|
677 Cyrillic) to ISO8859-5 (the form used internally by MULE).
|
|
|
678 @item internal
|
|
|
679 Write out or read in the raw contents of the memory representing the
|
|
|
680 buffer's text. This is primarily useful for debugging purposes, and is
|
|
|
681 only enabled when XEmacs has been compiled with @code{DEBUG_XEMACS} set
|
|
|
682 (the @samp{--debug} configure option). @strong{Warning}: Reading in a
|
|
|
683 file using @code{internal} conversion can result in an internal
|
|
|
684 inconsistency in the memory representing a buffer's text, which will
|
|
|
685 produce unpredictable results and may cause XEmacs to crash. Under
|
|
|
686 normal circumstances you should never use @code{internal} conversion.
|
|
428
|
687 @end table
|
|
|
688
|
|
442
|
689 @node ISO 2022, EOL Conversion, Coding System Types, Coding Systems
|
|
|
690 @section ISO 2022
|
|
|
691
|
|
|
692 This section briefly describes the ISO 2022 encoding standard. A more
|
|
|
693 thorough treatment is available in the original document of ISO
|
|
|
694 2022 as well as various national standards (such as JIS X 0202).
|
|
428
|
695
|
|
442
|
696 Character sets (@dfn{charsets}) are classified into the following four
|
|
|
697 categories, according to the number of characters in the charset:
|
|
|
698 94-charset, 96-charset, 94x94-charset, and 96x96-charset. This means
|
|
|
699 that although an ISO 2022 coding system may have variable width
|
|
|
700 characters, each charset used is fixed-width (in contrast to the MULE
|
|
|
701 character set and UTF-8, for example).
|
|
|
702
|
|
|
703 ISO 2022 provides for switching between character sets via escape
|
|
|
704 sequences. This switching is somewhat complicated, because ISO 2022
|
|
|
705 provides for both legacy applications like Internet mail that accept
|
|
444
|
706 only 7 significant bits in some contexts (RFC 822 headers, for example),
|
|
442
|
707 and more modern "8-bit clean" applications. It also provides for
|
|
|
708 compact and transparent representation of languages like Japanese which
|
|
|
709 mix ASCII and a national script (even outside of computer programs).
|
|
428
|
710
|
|
442
|
711 First, ISO 2022 codified prevailing practice by dividing the code space
|
|
|
712 into "control" and "graphic" regions. The code points 0x00-0x1F and
|
|
|
713 0x80-0x9F are reserved for "control characters", while "graphic
|
|
|
714 characters" must be assigned to code points in the regions 0x20-0x7F and
|
|
|
715 0xA0-0xFF. The positions 0x20 and 0x7F are special, and under some
|
|
|
716 circumstances must be assigned the graphic character "ASCII SPACE" and
|
|
|
717 the control character "ASCII DEL" respectively.
|
|
428
|
718
|
|
442
|
719 The various regions are given the name C0 (0x00-0x1F), GL (0x20-0x7F),
|
|
|
720 C1 (0x80-0x9F), and GR (0xA0-0xFF). GL and GR stand for "graphic left"
|
|
|
721 and "graphic right", respectively, because of the standard method of
|
|
|
722 displaying graphic character sets in tables with the high byte indexing
|
|
444
|
723 columns and the low byte indexing rows. I don't find it very intuitive,
|
|
442
|
724 but these are called "registers".
|
|
|
725
|
|
|
726 An ISO 2022-conformant encoding for a graphic character set must use a
|
|
|
727 fixed number of bytes per character, and the values must fit into a
|
|
|
728 single register; that is, each byte must range over either 0x20-0x7F, or
|
|
|
729 0xA0-0xFF. It is not allowed to extend the range of the repertoire of a
|
|
|
730 character set by using both ranges at the same. This is why a standard
|
|
|
731 character set such as ISO 8859-1 is actually considered by ISO 2022 to
|
|
|
732 be an aggregation of two character sets, ASCII and LATIN-1, and why it
|
|
|
733 is technically incorrect to refer to ISO 8859-1 as "Latin 1". Also, a
|
|
|
734 single character's bytes must all be drawn from the same register; this
|
|
|
735 is why Shift JIS (for Japanese) and Big 5 (for Chinese) are not ISO
|
|
|
736 2022-compatible encodings.
|
|
428
|
737
|
|
442
|
738 The reason for this restriction becomes clear when you attempt to define
|
|
|
739 an efficient, robust encoding for a language like Japanese. Like ISO
|
|
|
740 8859, Japanese encodings are aggregations of several character sets. In
|
|
|
741 practice, the vast majority of characters are drawn from the "JIS Roman"
|
|
|
742 character set (a derivative of ASCII; it won't hurt to think of it as
|
|
|
743 ASCII) and the JIS X 0208 standard "basic Japanese" character set
|
|
|
744 including not only ideographic characters ("kanji") but syllabic
|
|
|
745 Japanese characters ("kana"), a wide variety of symbols, and many
|
|
|
746 alphabetic characters (Roman, Greek, and Cyrillic) as well. Although
|
|
|
747 JIS X 0208 includes the whole Roman alphabet, as a 2-byte code it is not
|
|
|
748 suited to programming; thus the inclusion of ASCII in the standard
|
|
|
749 Japanese encodings.
|
|
428
|
750
|
|
442
|
751 For normal Japanese text such as in newspapers, a broad repertoire of
|
|
|
752 approximately 3000 characters is used. Evidently this won't fit into
|
|
|
753 one byte; two must be used. But much of the text processed by Japanese
|
|
|
754 computers is computer source code, nearly all of which is ASCII. A not
|
|
|
755 insignificant portion of ordinary text is English (as such or as
|
|
|
756 borrowed Japanese vocabulary) or other languages which can represented
|
|
|
757 at least approximately in ASCII, as well. It seems reasonable then to
|
|
|
758 represent ASCII in one byte, and JIS X 0208 in two. And this is exactly
|
|
|
759 what the Extended Unix Code for Japanese (EUC-JP) does. ASCII is
|
|
|
760 invoked to the GL register, and JIS X 0208 is invoked to the GR
|
|
|
761 register. Thus, each byte can be tested for its character set by
|
|
|
762 looking at the high bit; if set, it is Japanese, if clear, it is ASCII.
|
|
|
763 Furthermore, since control characters like newline can never be part of
|
|
|
764 a graphic character, even in the case of corruption in transmission the
|
|
|
765 stream will be resynchronized at every line break, on the order of 60-80
|
|
|
766 bytes. This coding system requires no escape sequences or special
|
|
|
767 control codes to represent 99.9% of all Japanese text.
|
|
428
|
768
|
|
442
|
769 Note carefully the distinction between the character sets (ASCII and JIS
|
|
|
770 X 0208), the encoding (EUC-JP), and the coding system (ISO 2022). The
|
|
|
771 JIS X 0208 character set is used in three different encodings for
|
|
|
772 Japanese, but in ISO-2022-JP it is invoked into GL (so the high bit is
|
|
|
773 always clear), in EUC-JP it is invoked into GR (setting the high bit in
|
|
|
774 the process), and in Shift JIS the high bit may be set or reset, and the
|
|
|
775 significant bits are shifted within the 16-bit character so that the two
|
|
|
776 main character sets can coexist with a third (the "halfwidth katakana"
|
|
|
777 of JIS X 0201). As the name implies, the ISO-2022-JP encoding is also a
|
|
|
778 version of the ISO-2022 coding system.
|
|
428
|
779
|
|
442
|
780 In order to systematically treat subsidiary character sets (like the
|
|
|
781 "halfwidth katakana" already mentioned, and the "supplementary kanji" of
|
|
|
782 JIS X 0212), four further registers are defined: G0, G1, G2, and G3.
|
|
|
783 Unlike GL and GR, they are not logically distinguished by internal
|
|
|
784 format. Instead, the process of "invocation" mentioned earlier is
|
|
|
785 broken into two steps: first, a character set is @dfn{designated} to one
|
|
|
786 of the registers G0-G3 by use of an @dfn{escape sequence} of the form:
|
|
428
|
787
|
|
|
788 @example
|
|
440
|
789 ESC [@var{I}] @var{I} @var{F}
|
|
428
|
790 @end example
|
|
|
791
|
|
442
|
792 where @var{I} is an intermediate character or characters in the range
|
|
|
793 0x20 - 0x3F, and @var{F}, from the range 0x30-0x7Fm is the final
|
|
|
794 character identifying this charset. (Final characters in the range
|
|
|
795 0x30-0x3F are reserved for private use and will never have a publicly
|
|
|
796 registered meaning.)
|
|
|
797
|
|
|
798 Then that register is @dfn{invoked} to either GL or GR, either
|
|
|
799 automatically (designations to G0 normally involve invocation to GL as
|
|
|
800 well), or by use of shifting (affecting only the following character in
|
|
|
801 the data stream) or locking (effective until the next designation or
|
|
|
802 locking) control sequences. An encoding conformant to ISO 2022 is
|
|
|
803 typically defined by designating the initial contents of the G0-G3
|
|
|
804 registers, specifying an 7 or 8 bit environment, and specifying whether
|
|
|
805 further designations will be recognized.
|
|
|
806
|
|
|
807 Some examples of character sets and the registered final characters
|
|
|
808 @var{F} used to designate them:
|
|
428
|
809
|
|
442
|
810 @need 1000
|
|
|
811 @table @asis
|
|
|
812 @item 94-charset
|
|
|
813 ASCII (B), left (J) and right (I) half of JIS X 0201, ...
|
|
|
814 @item 96-charset
|
|
|
815 Latin-1 (A), Latin-2 (B), Latin-3 (C), ...
|
|
|
816 @item 94x94-charset
|
|
|
817 GB2312 (A), JIS X 0208 (B), KSC5601 (C), ...
|
|
|
818 @item 96x96-charset
|
|
|
819 none for the moment
|
|
|
820 @end table
|
|
|
821
|
|
|
822 The meanings of the various characters in these sequences, where not
|
|
|
823 specified by the ISO 2022 standard (such as the ESC character), are
|
|
|
824 assigned by @dfn{ECMA}, the European Computer Manufacturers Association.
|
|
|
825
|
|
|
826 The meaning of intermediate characters are:
|
|
428
|
827
|
|
|
828 @example
|
|
|
829 @group
|
|
440
|
830 $ [0x24]: indicate charset of dimension 2 (94x94 or 96x96).
|
|
|
831 ( [0x28]: designate to G0 a 94-charset whose final byte is @var{F}.
|
|
|
832 ) [0x29]: designate to G1 a 94-charset whose final byte is @var{F}.
|
|
|
833 * [0x2A]: designate to G2 a 94-charset whose final byte is @var{F}.
|
|
|
834 + [0x2B]: designate to G3 a 94-charset whose final byte is @var{F}.
|
|
442
|
835 , [0x2C]: designate to G0 a 96-charset whose final byte is @var{F}.
|
|
440
|
836 - [0x2D]: designate to G1 a 96-charset whose final byte is @var{F}.
|
|
|
837 . [0x2E]: designate to G2 a 96-charset whose final byte is @var{F}.
|
|
|
838 / [0x2F]: designate to G3 a 96-charset whose final byte is @var{F}.
|
|
428
|
839 @end group
|
|
|
840 @end example
|
|
|
841
|
|
442
|
842 The comma may be used in files read and written only by MULE, as a MULE
|
|
|
843 extension, but this is illegal in ISO 2022. (The reason is that in ISO
|
|
|
844 2022 G0 must be a 94-member character set, with 0x20 assigned the value
|
|
|
845 SPACE, and 0x7F assigned the value DEL.)
|
|
428
|
846
|
|
442
|
847 Here are examples of designations:
|
|
428
|
848
|
|
|
849 @example
|
|
|
850 @group
|
|
440
|
851 ESC ( B : designate to G0 ASCII
|
|
|
852 ESC - A : designate to G1 Latin-1
|
|
|
853 ESC $ ( A or ESC $ A : designate to G0 GB2312
|
|
|
854 ESC $ ( B or ESC $ B : designate to G0 JISX0208
|
|
|
855 ESC $ ) C : designate to G1 KSC5601
|
|
428
|
856 @end group
|
|
|
857 @end example
|
|
|
858
|
|
442
|
859 (The short forms used to designate GB2312 and JIS X 0208 are for
|
|
|
860 backwards compatibility; the long forms are preferred.)
|
|
|
861
|
|
|
862 To use a charset designated to G2 or G3, and to use a charset designated
|
|
428
|
863 to G1 in a 7-bit environment, you must explicitly invoke G1, G2, or G3
|
|
|
864 into GL. There are two types of invocation, Locking Shift (forever) and
|
|
|
865 Single Shift (one character only).
|
|
|
866
|
|
442
|
867 Locking Shift is done as follows:
|
|
428
|
868
|
|
|
869 @example
|
|
440
|
870 LS0 or SI (0x0F): invoke G0 into GL
|
|
|
871 LS1 or SO (0x0E): invoke G1 into GL
|
|
|
872 LS2: invoke G2 into GL
|
|
|
873 LS3: invoke G3 into GL
|
|
|
874 LS1R: invoke G1 into GR
|
|
|
875 LS2R: invoke G2 into GR
|
|
|
876 LS3R: invoke G3 into GR
|
|
428
|
877 @end example
|
|
|
878
|
|
442
|
879 Single Shift is done as follows:
|
|
428
|
880
|
|
|
881 @example
|
|
|
882 @group
|
|
440
|
883 SS2 or ESC N: invoke G2 into GL
|
|
|
884 SS3 or ESC O: invoke G3 into GL
|
|
428
|
885 @end group
|
|
|
886 @end example
|
|
|
887
|
|
442
|
888 The shift functions (such as LS1R and SS3) are represented by control
|
|
|
889 characters (from C1) in 8 bit environments and by escape sequences in 7
|
|
|
890 bit environments.
|
|
|
891
|
|
428
|
892 (#### Ben says: I think the above is slightly incorrect. It appears that
|
|
|
893 SS2 invokes G2 into GR and SS3 invokes G3 into GR, whereas ESC N and
|
|
444
|
894 ESC O behave as indicated. The above definitions will not parse
|
|
428
|
895 EUC-encoded text correctly, and it looks like the code in mule-coding.c
|
|
|
896 has similar problems.)
|
|
|
897
|
|
442
|
898 Evidently there are a lot of ISO-2022-compliant ways of encoding
|
|
|
899 multilingual text. Now, in the world, there exist many coding systems
|
|
|
900 such as X11's Compound Text, Japanese JUNET code, and so-called EUC
|
|
|
901 (Extended UNIX Code); all of these are variants of ISO 2022.
|
|
428
|
902
|
|
442
|
903 In MULE, we characterize a version of ISO 2022 by the following
|
|
|
904 attributes:
|
|
428
|
905
|
|
|
906 @enumerate
|
|
|
907 @item
|
|
442
|
908 The character sets initially designated to G0 thru G3.
|
|
428
|
909 @item
|
|
442
|
910 Whether short form designations are allowed for Japanese and Chinese.
|
|
428
|
911 @item
|
|
442
|
912 Whether ASCII should be designated to G0 before control characters.
|
|
428
|
913 @item
|
|
442
|
914 Whether ASCII should be designated to G0 at the end of line.
|
|
428
|
915 @item
|
|
|
916 7-bit environment or 8-bit environment.
|
|
|
917 @item
|
|
442
|
918 Whether Locking Shifts are used or not.
|
|
428
|
919 @item
|
|
442
|
920 Whether to use ASCII or the variant JIS X 0201-1976-Roman.
|
|
428
|
921 @item
|
|
442
|
922 Whether to use JIS X 0208-1983 or the older version JIS X 0208-1976.
|
|
428
|
923 @end enumerate
|
|
|
924
|
|
|
925 (The last two are only for Japanese.)
|
|
|
926
|
|
442
|
927 By specifying these attributes, you can create any variant
|
|
428
|
928 of ISO 2022.
|
|
|
929
|
|
442
|
930 Here are several examples:
|
|
428
|
931
|
|
|
932 @example
|
|
|
933 @group
|
|
442
|
934 ISO-2022-JP -- Coding system used in Japanese email (RFC 1463 #### check).
|
|
440
|
935 1. G0 <- ASCII, G1..3 <- never used
|
|
|
936 2. Yes.
|
|
|
937 3. Yes.
|
|
|
938 4. Yes.
|
|
|
939 5. 7-bit environment
|
|
|
940 6. No.
|
|
|
941 7. Use ASCII
|
|
442
|
942 8. Use JIS X 0208-1983
|
|
428
|
943 @end group
|
|
|
944
|
|
|
945 @group
|
|
442
|
946 ctext -- X11 Compound Text
|
|
|
947 1. G0 <- ASCII, G1 <- Latin-1, G2,3 <- never used.
|
|
440
|
948 2. No.
|
|
|
949 3. No.
|
|
|
950 4. Yes.
|
|
442
|
951 5. 8-bit environment.
|
|
440
|
952 6. No.
|
|
442
|
953 7. Use ASCII.
|
|
|
954 8. Use JIS X 0208-1983.
|
|
428
|
955 @end group
|
|
|
956
|
|
|
957 @group
|
|
442
|
958 euc-china -- Chinese EUC. Often called the "GB encoding", but that is
|
|
|
959 technically incorrect.
|
|
|
960 1. G0 <- ASCII, G1 <- GB 2312, G2,3 <- never used.
|
|
440
|
961 2. No.
|
|
|
962 3. Yes.
|
|
|
963 4. Yes.
|
|
442
|
964 5. 8-bit environment.
|
|
440
|
965 6. No.
|
|
442
|
966 7. Use ASCII.
|
|
|
967 8. Use JIS X 0208-1983.
|
|
428
|
968 @end group
|
|
|
969
|
|
|
970 @group
|
|
442
|
971 ISO-2022-KR -- Coding system used in Korean email.
|
|
|
972 1. G0 <- ASCII, G1 <- KSC 5601, G2,3 <- never used.
|
|
440
|
973 2. No.
|
|
|
974 3. Yes.
|
|
|
975 4. Yes.
|
|
442
|
976 5. 7-bit environment.
|
|
440
|
977 6. Yes.
|
|
442
|
978 7. Use ASCII.
|
|
|
979 8. Use JIS X 0208-1983.
|
|
428
|
980 @end group
|
|
|
981 @end example
|
|
|
982
|
|
442
|
983 MULE creates all of these coding systems by default.
|
|
428
|
984
|
|
442
|
985 @node EOL Conversion, Coding System Properties, ISO 2022, Coding Systems
|
|
428
|
986 @subsection EOL Conversion
|
|
|
987
|
|
|
988 @table @code
|
|
|
989 @item nil
|
|
|
990 Automatically detect the end-of-line type (LF, CRLF, or CR). Also
|
|
|
991 generate subsidiary coding systems named @code{@var{name}-unix},
|
|
|
992 @code{@var{name}-dos}, and @code{@var{name}-mac}, that are identical to
|
|
|
993 this coding system but have an EOL-TYPE value of @code{lf}, @code{crlf},
|
|
|
994 and @code{cr}, respectively.
|
|
|
995 @item lf
|
|
|
996 The end of a line is marked externally using ASCII LF. Since this is
|
|
|
997 also the way that XEmacs represents an end-of-line internally,
|
|
|
998 specifying this option results in no end-of-line conversion. This is
|
|
|
999 the standard format for Unix text files.
|
|
|
1000 @item crlf
|
|
|
1001 The end of a line is marked externally using ASCII CRLF. This is the
|
|
|
1002 standard format for MS-DOS text files.
|
|
|
1003 @item cr
|
|
|
1004 The end of a line is marked externally using ASCII CR. This is the
|
|
|
1005 standard format for Macintosh text files.
|
|
|
1006 @item t
|
|
|
1007 Automatically detect the end-of-line type but do not generate subsidiary
|
|
|
1008 coding systems. (This value is converted to @code{nil} when stored
|
|
|
1009 internally, and @code{coding-system-property} will return @code{nil}.)
|
|
|
1010 @end table
|
|
|
1011
|
|
442
|
1012 @node Coding System Properties, Basic Coding System Functions, EOL Conversion, Coding Systems
|
|
428
|
1013 @subsection Coding System Properties
|
|
|
1014
|
|
|
1015 @table @code
|
|
|
1016 @item mnemonic
|
|
|
1017 String to be displayed in the modeline when this coding system is
|
|
|
1018 active.
|
|
|
1019
|
|
|
1020 @item eol-type
|
|
|
1021 End-of-line conversion to be used. It should be one of the types
|
|
|
1022 listed in @ref{EOL Conversion}.
|
|
|
1023
|
|
442
|
1024 @item eol-lf
|
|
444
|
1025 The coding system which is the same as this one, except that it uses the
|
|
442
|
1026 Unix line-breaking convention.
|
|
|
1027
|
|
|
1028 @item eol-crlf
|
|
444
|
1029 The coding system which is the same as this one, except that it uses the
|
|
442
|
1030 DOS line-breaking convention.
|
|
|
1031
|
|
|
1032 @item eol-cr
|
|
444
|
1033 The coding system which is the same as this one, except that it uses the
|
|
442
|
1034 Macintosh line-breaking convention.
|
|
|
1035
|
|
428
|
1036 @item post-read-conversion
|
|
|
1037 Function called after a file has been read in, to perform the decoding.
|
|
444
|
1038 Called with two arguments, @var{start} and @var{end}, denoting a region of
|
|
428
|
1039 the current buffer to be decoded.
|
|
|
1040
|
|
|
1041 @item pre-write-conversion
|
|
|
1042 Function called before a file is written out, to perform the encoding.
|
|
444
|
1043 Called with two arguments, @var{start} and @var{end}, denoting a region of
|
|
428
|
1044 the current buffer to be encoded.
|
|
|
1045 @end table
|
|
|
1046
|
|
442
|
1047 The following additional properties are recognized if @var{type} is
|
|
428
|
1048 @code{iso2022}:
|
|
|
1049
|
|
|
1050 @table @code
|
|
|
1051 @item charset-g0
|
|
|
1052 @itemx charset-g1
|
|
|
1053 @itemx charset-g2
|
|
|
1054 @itemx charset-g3
|
|
|
1055 The character set initially designated to the G0 - G3 registers.
|
|
|
1056 The value should be one of
|
|
|
1057
|
|
|
1058 @itemize @bullet
|
|
|
1059 @item
|
|
|
1060 A charset object (designate that character set)
|
|
|
1061 @item
|
|
|
1062 @code{nil} (do not ever use this register)
|
|
|
1063 @item
|
|
|
1064 @code{t} (no character set is initially designated to the register, but
|
|
|
1065 may be later on; this automatically sets the corresponding
|
|
|
1066 @code{force-g*-on-output} property)
|
|
|
1067 @end itemize
|
|
|
1068
|
|
|
1069 @item force-g0-on-output
|
|
|
1070 @itemx force-g1-on-output
|
|
|
1071 @itemx force-g2-on-output
|
|
|
1072 @itemx force-g3-on-output
|
|
|
1073 If non-@code{nil}, send an explicit designation sequence on output
|
|
|
1074 before using the specified register.
|
|
|
1075
|
|
|
1076 @item short
|
|
|
1077 If non-@code{nil}, use the short forms @samp{ESC $ @@}, @samp{ESC $ A},
|
|
|
1078 and @samp{ESC $ B} on output in place of the full designation sequences
|
|
|
1079 @samp{ESC $ ( @@}, @samp{ESC $ ( A}, and @samp{ESC $ ( B}.
|
|
|
1080
|
|
|
1081 @item no-ascii-eol
|
|
|
1082 If non-@code{nil}, don't designate ASCII to G0 at each end of line on
|
|
|
1083 output. Setting this to non-@code{nil} also suppresses other
|
|
|
1084 state-resetting that normally happens at the end of a line.
|
|
|
1085
|
|
|
1086 @item no-ascii-cntl
|
|
|
1087 If non-@code{nil}, don't designate ASCII to G0 before control chars on
|
|
|
1088 output.
|
|
|
1089
|
|
|
1090 @item seven
|
|
|
1091 If non-@code{nil}, use 7-bit environment on output. Otherwise, use 8-bit
|
|
|
1092 environment.
|
|
|
1093
|
|
|
1094 @item lock-shift
|
|
|
1095 If non-@code{nil}, use locking-shift (SO/SI) instead of single-shift or
|
|
|
1096 designation by escape sequence.
|
|
|
1097
|
|
|
1098 @item no-iso6429
|
|
|
1099 If non-@code{nil}, don't use ISO6429's direction specification.
|
|
|
1100
|
|
|
1101 @item escape-quoted
|
|
444
|
1102 If non-@code{nil}, literal control characters that are the same as the
|
|
428
|
1103 beginning of a recognized ISO 2022 or ISO 6429 escape sequence (in
|
|
|
1104 particular, ESC (0x1B), SO (0x0E), SI (0x0F), SS2 (0x8E), SS3 (0x8F),
|
|
|
1105 and CSI (0x9B)) are ``quoted'' with an escape character so that they can
|
|
|
1106 be properly distinguished from an escape sequence. (Note that doing
|
|
|
1107 this results in a non-portable encoding.) This encoding flag is used for
|
|
|
1108 byte-compiled files. Note that ESC is a good choice for a quoting
|
|
|
1109 character because there are no escape sequences whose second byte is a
|
|
|
1110 character from the Control-0 or Control-1 character sets; this is
|
|
|
1111 explicitly disallowed by the ISO 2022 standard.
|
|
|
1112
|
|
|
1113 @item input-charset-conversion
|
|
|
1114 A list of conversion specifications, specifying conversion of characters
|
|
|
1115 in one charset to another when decoding is performed. Each
|
|
|
1116 specification is a list of two elements: the source charset, and the
|
|
|
1117 destination charset.
|
|
|
1118
|
|
|
1119 @item output-charset-conversion
|
|
|
1120 A list of conversion specifications, specifying conversion of characters
|
|
|
1121 in one charset to another when encoding is performed. The form of each
|
|
|
1122 specification is the same as for @code{input-charset-conversion}.
|
|
|
1123 @end table
|
|
|
1124
|
|
442
|
1125 The following additional properties are recognized (and required) if
|
|
428
|
1126 @var{type} is @code{ccl}:
|
|
|
1127
|
|
|
1128 @table @code
|
|
|
1129 @item decode
|
|
|
1130 CCL program used for decoding (converting to internal format).
|
|
|
1131
|
|
|
1132 @item encode
|
|
|
1133 CCL program used for encoding (converting to external format).
|
|
|
1134 @end table
|
|
|
1135
|
|
442
|
1136 The following properties are used internally: @var{eol-cr},
|
|
|
1137 @var{eol-crlf}, @var{eol-lf}, and @var{base}.
|
|
|
1138
|
|
|
1139 @node Basic Coding System Functions, Coding System Property Functions, Coding System Properties, Coding Systems
|
|
428
|
1140 @subsection Basic Coding System Functions
|
|
|
1141
|
|
|
1142 @defun find-coding-system coding-system-or-name
|
|
|
1143 This function retrieves the coding system of the given name.
|
|
|
1144
|
|
442
|
1145 If @var{coding-system-or-name} is a coding-system object, it is simply
|
|
428
|
1146 returned. Otherwise, @var{coding-system-or-name} should be a symbol.
|
|
|
1147 If there is no such coding system, @code{nil} is returned. Otherwise
|
|
|
1148 the associated coding system object is returned.
|
|
|
1149 @end defun
|
|
|
1150
|
|
|
1151 @defun get-coding-system name
|
|
|
1152 This function retrieves the coding system of the given name. Same as
|
|
|
1153 @code{find-coding-system} except an error is signalled if there is no
|
|
|
1154 such coding system instead of returning @code{nil}.
|
|
|
1155 @end defun
|
|
|
1156
|
|
|
1157 @defun coding-system-list
|
|
|
1158 This function returns a list of the names of all defined coding systems.
|
|
|
1159 @end defun
|
|
|
1160
|
|
|
1161 @defun coding-system-name coding-system
|
|
|
1162 This function returns the name of the given coding system.
|
|
|
1163 @end defun
|
|
|
1164
|
|
442
|
1165 @defun coding-system-base coding-system
|
|
|
1166 Returns the base coding system (undecided EOL convention)
|
|
|
1167 coding system.
|
|
|
1168 @end defun
|
|
|
1169
|
|
428
|
1170 @defun make-coding-system name type &optional doc-string props
|
|
|
1171 This function registers symbol @var{name} as a coding system.
|
|
|
1172
|
|
|
1173 @var{type} describes the conversion method used and should be one of
|
|
|
1174 the types listed in @ref{Coding System Types}.
|
|
|
1175
|
|
|
1176 @var{doc-string} is a string describing the coding system.
|
|
|
1177
|
|
|
1178 @var{props} is a property list, describing the specific nature of the
|
|
|
1179 character set. Recognized properties are as in @ref{Coding System
|
|
|
1180 Properties}.
|
|
|
1181 @end defun
|
|
|
1182
|
|
|
1183 @defun copy-coding-system old-coding-system new-name
|
|
|
1184 This function copies @var{old-coding-system} to @var{new-name}. If
|
|
|
1185 @var{new-name} does not name an existing coding system, a new one will
|
|
|
1186 be created.
|
|
|
1187 @end defun
|
|
|
1188
|
|
|
1189 @defun subsidiary-coding-system coding-system eol-type
|
|
|
1190 This function returns the subsidiary coding system of
|
|
|
1191 @var{coding-system} with eol type @var{eol-type}.
|
|
|
1192 @end defun
|
|
|
1193
|
|
442
|
1194 @node Coding System Property Functions, Encoding and Decoding Text, Basic Coding System Functions, Coding Systems
|
|
428
|
1195 @subsection Coding System Property Functions
|
|
|
1196
|
|
|
1197 @defun coding-system-doc-string coding-system
|
|
|
1198 This function returns the doc string for @var{coding-system}.
|
|
|
1199 @end defun
|
|
|
1200
|
|
|
1201 @defun coding-system-type coding-system
|
|
|
1202 This function returns the type of @var{coding-system}.
|
|
|
1203 @end defun
|
|
|
1204
|
|
|
1205 @defun coding-system-property coding-system prop
|
|
|
1206 This function returns the @var{prop} property of @var{coding-system}.
|
|
|
1207 @end defun
|
|
|
1208
|
|
442
|
1209 @node Encoding and Decoding Text, Detection of Textual Encoding, Coding System Property Functions, Coding Systems
|
|
428
|
1210 @subsection Encoding and Decoding Text
|
|
|
1211
|
|
|
1212 @defun decode-coding-region start end coding-system &optional buffer
|
|
|
1213 This function decodes the text between @var{start} and @var{end} which
|
|
|
1214 is encoded in @var{coding-system}. This is useful if you've read in
|
|
|
1215 encoded text from a file without decoding it (e.g. you read in a
|
|
|
1216 JIS-formatted file but used the @code{binary} or @code{no-conversion} coding
|
|
|
1217 system, so that it shows up as @samp{^[$B!<!+^[(B}). The length of the
|
|
|
1218 encoded text is returned. @var{buffer} defaults to the current buffer
|
|
|
1219 if unspecified.
|
|
|
1220 @end defun
|
|
|
1221
|
|
|
1222 @defun encode-coding-region start end coding-system &optional buffer
|
|
|
1223 This function encodes the text between @var{start} and @var{end} using
|
|
|
1224 @var{coding-system}. This will, for example, convert Japanese
|
|
|
1225 characters into stuff such as @samp{^[$B!<!+^[(B} if you use the JIS
|
|
|
1226 encoding. The length of the encoded text is returned. @var{buffer}
|
|
|
1227 defaults to the current buffer if unspecified.
|
|
|
1228 @end defun
|
|
|
1229
|
|
442
|
1230 @node Detection of Textual Encoding, Big5 and Shift-JIS Functions, Encoding and Decoding Text, Coding Systems
|
|
428
|
1231 @subsection Detection of Textual Encoding
|
|
|
1232
|
|
|
1233 @defun coding-category-list
|
|
|
1234 This function returns a list of all recognized coding categories.
|
|
|
1235 @end defun
|
|
|
1236
|
|
|
1237 @defun set-coding-priority-list list
|
|
|
1238 This function changes the priority order of the coding categories.
|
|
|
1239 @var{list} should be a list of coding categories, in descending order of
|
|
|
1240 priority. Unspecified coding categories will be lower in priority than
|
|
|
1241 all specified ones, in the same relative order they were in previously.
|
|
|
1242 @end defun
|
|
|
1243
|
|
|
1244 @defun coding-priority-list
|
|
|
1245 This function returns a list of coding categories in descending order of
|
|
|
1246 priority.
|
|
|
1247 @end defun
|
|
|
1248
|
|
|
1249 @defun set-coding-category-system coding-category coding-system
|
|
|
1250 This function changes the coding system associated with a coding category.
|
|
|
1251 @end defun
|
|
|
1252
|
|
|
1253 @defun coding-category-system coding-category
|
|
|
1254 This function returns the coding system associated with a coding category.
|
|
|
1255 @end defun
|
|
|
1256
|
|
|
1257 @defun detect-coding-region start end &optional buffer
|
|
|
1258 This function detects coding system of the text in the region between
|
|
|
1259 @var{start} and @var{end}. Returned value is a list of possible coding
|
|
|
1260 systems ordered by priority. If only ASCII characters are found, it
|
|
|
1261 returns @code{autodetect} or one of its subsidiary coding systems
|
|
|
1262 according to a detected end-of-line type. Optional arg @var{buffer}
|
|
|
1263 defaults to the current buffer.
|
|
|
1264 @end defun
|
|
|
1265
|
|
442
|
1266 @node Big5 and Shift-JIS Functions, Predefined Coding Systems, Detection of Textual Encoding, Coding Systems
|
|
428
|
1267 @subsection Big5 and Shift-JIS Functions
|
|
|
1268
|
|
442
|
1269 These are special functions for working with the non-standard
|
|
428
|
1270 Shift-JIS and Big5 encodings.
|
|
|
1271
|
|
|
1272 @defun decode-shift-jis-char code
|
|
442
|
1273 This function decodes a JIS X 0208 character of Shift-JIS coding-system.
|
|
428
|
1274 @var{code} is the character code in Shift-JIS as a cons of type bytes.
|
|
|
1275 The corresponding character is returned.
|
|
|
1276 @end defun
|
|
|
1277
|
|
444
|
1278 @defun encode-shift-jis-char character
|
|
|
1279 This function encodes a JIS X 0208 character @var{character} to
|
|
|
1280 SHIFT-JIS coding-system. The corresponding character code in SHIFT-JIS
|
|
|
1281 is returned as a cons of two bytes.
|
|
428
|
1282 @end defun
|
|
|
1283
|
|
|
1284 @defun decode-big5-char code
|
|
|
1285 This function decodes a Big5 character @var{code} of BIG5 coding-system.
|
|
|
1286 @var{code} is the character code in BIG5. The corresponding character
|
|
|
1287 is returned.
|
|
|
1288 @end defun
|
|
|
1289
|
|
444
|
1290 @defun encode-big5-char character
|
|
|
1291 This function encodes the Big5 character @var{character} to BIG5
|
|
428
|
1292 coding-system. The corresponding character code in Big5 is returned.
|
|
|
1293 @end defun
|
|
|
1294
|
|
442
|
1295 @node Predefined Coding Systems, , Big5 and Shift-JIS Functions, Coding Systems
|
|
|
1296 @subsection Coding Systems Implemented
|
|
|
1297
|
|
|
1298 MULE initializes most of the commonly used coding systems at XEmacs's
|
|
|
1299 startup. A few others are initialized only when the relevant language
|
|
|
1300 environment is selected and support libraries are loaded. (NB: The
|
|
444
|
1301 following list is based on XEmacs 21.2.19, the development branch at the
|
|
442
|
1302 time of writing. The list may be somewhat different for other
|
|
|
1303 versions. Recent versions of GNU Emacs 20 implement a few more rare
|
|
|
1304 coding systems; work is being done to port these to XEmacs.)
|
|
|
1305
|
|
444
|
1306 Unfortunately, there is not a consistent naming convention for character
|
|
|
1307 sets, and for practical purposes coding systems often take their name
|
|
442
|
1308 from their principal character sets (ASCII, KOI8-R, Shift JIS). Others
|
|
444
|
1309 take their names from the coding system (ISO-2022-JP, EUC-KR), and a few
|
|
|
1310 from their non-text usages (internal, binary). To provide for this, and
|
|
442
|
1311 for the fact that many coding systems have several common names, an
|
|
|
1312 aliasing system is provided. Finally, some effort has been made to use
|
|
|
1313 names that are registered as MIME charsets (this is why the name
|
|
|
1314 'shift_jis contains that un-Lisp-y underscore).
|
|
|
1315
|
|
|
1316 There is a systematic naming convention regarding end-of-line (EOL)
|
|
|
1317 conventions for different systems. A coding system whose name ends in
|
|
|
1318 "-unix" forces the assumptions that lines are broken by newlines (0x0A).
|
|
|
1319 A coding system whose name ends in "-mac" forces the assumptions that
|
|
|
1320 lines are broken by ASCII CRs (0x0D). A coding system whose name ends
|
|
|
1321 in "-dos" forces the assumptions that lines are broken by CRLF sequences
|
|
|
1322 (0x0D 0x0A). These subsidiary coding systems are automatically derived
|
|
|
1323 from a base coding system. Use of the base coding system implies
|
|
|
1324 autodetection of the text file convention. (The fact that the -unix,
|
|
|
1325 -mac, and -dos are derived from a base system results in them showing up
|
|
|
1326 as "aliases" in `list-coding-systems'.) These subsidiaries have a
|
|
|
1327 consistent modeline indicator as well. "-dos" coding systems have ":T"
|
|
|
1328 appended to their modeline indicator, while "-mac" coding systems have
|
|
|
1329 ":t" appended (eg, "ISO8:t" for iso-2022-8-mac).
|
|
|
1330
|
|
|
1331 In the following table, each coding system is given with its mode line
|
|
|
1332 indicator in parentheses. Non-textual coding systems are listed first,
|
|
|
1333 followed by textual coding systems and their aliases. (The coding system
|
|
|
1334 subsidiary modeline indicators ":T" and ":t" will be omitted from the
|
|
|
1335 table of coding systems.)
|
|
|
1336
|
|
|
1337 ### SJT 1999-08-23 Maybe should order these by language? Definitely
|
|
|
1338 need language usage for the ISO-8859 family.
|
|
|
1339
|
|
|
1340 Note that although true coding system aliases have been implemented for
|
|
444
|
1341 XEmacs 21.2, the coding system initialization has not yet been converted
|
|
442
|
1342 as of 21.2.19. So coding systems described as aliases have the same
|
|
|
1343 properties as the aliased coding system, but will not be equal as Lisp
|
|
|
1344 objects.
|
|
|
1345
|
|
|
1346 @table @code
|
|
|
1347
|
|
|
1348 @item automatic-conversion
|
|
|
1349 @itemx undecided
|
|
|
1350 @itemx undecided-dos
|
|
|
1351 @itemx undecided-mac
|
|
|
1352 @itemx undecided-unix
|
|
|
1353
|
|
|
1354 Modeline indicator: @code{Auto}. A type @code{undecided} coding system.
|
|
|
1355 Attempts to determine an appropriate coding system from file contents or
|
|
|
1356 the environment.
|
|
|
1357
|
|
|
1358 @item raw-text
|
|
|
1359 @itemx no-conversion
|
|
|
1360 @itemx raw-text-dos
|
|
|
1361 @itemx raw-text-mac
|
|
|
1362 @itemx raw-text-unix
|
|
|
1363 @itemx no-conversion-dos
|
|
|
1364 @itemx no-conversion-mac
|
|
|
1365 @itemx no-conversion-unix
|
|
|
1366
|
|
|
1367 Modeline indicator: @code{Raw}. A type @code{no-conversion} coding system,
|
|
|
1368 which converts only line-break-codes. An implementation quirk means
|
|
|
1369 that this coding system is also used for ISO8859-1.
|
|
|
1370
|
|
|
1371 @item binary
|
|
|
1372 Modeline indicator: @code{Binary}. A type @code{no-conversion} coding
|
|
|
1373 system which does no character coding or EOL conversions. An alias for
|
|
|
1374 @code{raw-text-unix}.
|
|
|
1375
|
|
|
1376 @item alternativnyj
|
|
|
1377 @itemx alternativnyj-dos
|
|
|
1378 @itemx alternativnyj-mac
|
|
|
1379 @itemx alternativnyj-unix
|
|
|
1380
|
|
|
1381 Modeline indicator: @code{Cy.Alt}. A type @code{ccl} coding system used for
|
|
|
1382 Alternativnyj, an encoding of the Cyrillic alphabet.
|
|
|
1383
|
|
|
1384 @item big5
|
|
|
1385 @itemx big5-dos
|
|
|
1386 @itemx big5-mac
|
|
|
1387 @itemx big5-unix
|
|
|
1388
|
|
|
1389 Modeline indicator: @code{Zh/Big5}. A type @code{big5} coding system used for
|
|
|
1390 BIG5, the most common encoding of traditional Chinese as used in Taiwan.
|
|
|
1391
|
|
|
1392 @item cn-gb-2312
|
|
|
1393 @itemx cn-gb-2312-dos
|
|
|
1394 @itemx cn-gb-2312-mac
|
|
|
1395 @itemx cn-gb-2312-unix
|
|
|
1396
|
|
|
1397 Modeline indicator: @code{Zh-GB/EUC}. A type @code{iso2022} coding system used
|
|
|
1398 for simplified Chinese (as used in the People's Republic of China), with
|
|
|
1399 the @code{ascii} (G0), @code{chinese-gb2312} (G1), and @code{sisheng}
|
|
|
1400 (G2) character sets initially designated. Chinese EUC (Extended Unix
|
|
|
1401 Code).
|
|
|
1402
|
|
|
1403 @item ctext-hebrew
|
|
|
1404 @itemx ctext-hebrew-dos
|
|
|
1405 @itemx ctext-hebrew-mac
|
|
|
1406 @itemx ctext-hebrew-unix
|
|
|
1407
|
|
|
1408 Modeline indicator: @code{CText/Hbrw}. A type @code{iso2022} coding system
|
|
|
1409 with the @code{ascii} (G0) and @code{hebrew-iso8859-8} (G1) character
|
|
|
1410 sets initially designated for Hebrew.
|
|
|
1411
|
|
|
1412 @item ctext
|
|
|
1413 @itemx ctext-dos
|
|
|
1414 @itemx ctext-mac
|
|
|
1415 @itemx ctext-unix
|
|
|
1416
|
|
|
1417 Modeline indicator: @code{CText}. A type @code{iso2022} 8-bit coding system
|
|
|
1418 with the @code{ascii} (G0) and @code{latin-iso8859-1} (G1) character
|
|
|
1419 sets initially designated. X11 Compound Text Encoding. Often
|
|
|
1420 mistakenly recognized instead of EUC encodings; usual cause is
|
|
|
1421 inappropriate setting of @code{coding-priority-list}.
|
|
|
1422
|
|
|
1423 @item escape-quoted
|
|
|
1424
|
|
|
1425 Modeline indicator: @code{ESC/Quot}. A type @code{iso2022} 8-bit coding
|
|
|
1426 system with the @code{ascii} (G0) and @code{latin-iso8859-1} (G1)
|
|
|
1427 character sets initially designated and escape quoting. Unix EOL
|
|
|
1428 conversion (ie, no conversion). It is used for .ELC files.
|
|
|
1429
|
|
|
1430 @item euc-jp
|
|
|
1431 @itemx euc-jp-dos
|
|
|
1432 @itemx euc-jp-mac
|
|
|
1433 @itemx euc-jp-unix
|
|
|
1434
|
|
|
1435 Modeline indicator: @code{Ja/EUC}. A type @code{iso2022} 8-bit coding system
|
|
|
1436 with @code{ascii} (G0), @code{japanese-jisx0208} (G1),
|
|
|
1437 @code{katakana-jisx0201} (G2), and @code{japanese-jisx0212} (G3)
|
|
|
1438 initially designated. Japanese EUC (Extended Unix Code).
|
|
|
1439
|
|
|
1440 @item euc-kr
|
|
|
1441 @itemx euc-kr-dos
|
|
|
1442 @itemx euc-kr-mac
|
|
|
1443 @itemx euc-kr-unix
|
|
|
1444
|
|
|
1445 Modeline indicator: @code{ko/EUC}. A type @code{iso2022} 8-bit coding system
|
|
|
1446 with @code{ascii} (G0) and @code{korean-ksc5601} (G1) initially
|
|
|
1447 designated. Korean EUC (Extended Unix Code).
|
|
|
1448
|
|
|
1449 @item hz-gb-2312
|
|
|
1450 Modeline indicator: @code{Zh-GB/Hz}. A type @code{no-conversion} coding
|
|
|
1451 system with Unix EOL convention (ie, no conversion) using
|
|
|
1452 post-read-decode and pre-write-encode functions to translate the Hz/ZW
|
|
|
1453 coding system used for Chinese.
|
|
|
1454
|
|
|
1455 @item iso-2022-7bit
|
|
|
1456 @itemx iso-2022-7bit-unix
|
|
|
1457 @itemx iso-2022-7bit-dos
|
|
|
1458 @itemx iso-2022-7bit-mac
|
|
|
1459 @itemx iso-2022-7
|
|
|
1460
|
|
|
1461 Modeline indicator: @code{ISO7}. A type @code{iso2022} 7-bit coding system
|
|
|
1462 with @code{ascii} (G0) initially designated. Other character sets must
|
|
|
1463 be explicitly designated to be used.
|
|
|
1464
|
|
|
1465 @item iso-2022-7bit-ss2
|
|
|
1466 @itemx iso-2022-7bit-ss2-dos
|
|
|
1467 @itemx iso-2022-7bit-ss2-mac
|
|
|
1468 @itemx iso-2022-7bit-ss2-unix
|
|
|
1469
|
|
|
1470 Modeline indicator: @code{ISO7/SS}. A type @code{iso2022} 7-bit coding system
|
|
|
1471 with @code{ascii} (G0) initially designated. Other character sets must
|
|
|
1472 be explicitly designated to be used. SS2 is used to invoke a
|
|
|
1473 96-charset, one character at a time.
|
|
|
1474
|
|
|
1475 @item iso-2022-8
|
|
|
1476 @itemx iso-2022-8-dos
|
|
|
1477 @itemx iso-2022-8-mac
|
|
|
1478 @itemx iso-2022-8-unix
|
|
|
1479
|
|
|
1480 Modeline indicator: @code{ISO8}. A type @code{iso2022} 8-bit coding system
|
|
|
1481 with @code{ascii} (G0) and @code{latin-iso8859-1} (G1) initially
|
|
|
1482 designated. Other character sets must be explicitly designated to be
|
|
|
1483 used. No single-shift or locking-shift.
|
|
|
1484
|
|
|
1485 @item iso-2022-8bit-ss2
|
|
|
1486 @itemx iso-2022-8bit-ss2-dos
|
|
|
1487 @itemx iso-2022-8bit-ss2-mac
|
|
|
1488 @itemx iso-2022-8bit-ss2-unix
|
|
|
1489
|
|
|
1490 Modeline indicator: @code{ISO8/SS}. A type @code{iso2022} 8-bit coding system
|
|
|
1491 with @code{ascii} (G0) and @code{latin-iso8859-1} (G1) initially
|
|
|
1492 designated. Other character sets must be explicitly designated to be
|
|
|
1493 used. SS2 is used to invoke a 96-charset, one character at a time.
|
|
|
1494
|
|
|
1495 @item iso-2022-int-1
|
|
|
1496 @itemx iso-2022-int-1-dos
|
|
|
1497 @itemx iso-2022-int-1-mac
|
|
|
1498 @itemx iso-2022-int-1-unix
|
|
|
1499
|
|
|
1500 Modeline indicator: @code{INT-1}. A type @code{iso2022} 7-bit coding system
|
|
|
1501 with @code{ascii} (G0) and @code{korean-ksc5601} (G1) initially
|
|
|
1502 designated. ISO-2022-INT-1.
|
|
|
1503
|
|
|
1504 @item iso-2022-jp-1978-irv
|
|
|
1505 @itemx iso-2022-jp-1978-irv-dos
|
|
|
1506 @itemx iso-2022-jp-1978-irv-mac
|
|
|
1507 @itemx iso-2022-jp-1978-irv-unix
|
|
|
1508
|
|
|
1509 Modeline indicator: @code{Ja-78/7bit}. A type @code{iso2022} 7-bit coding
|
|
|
1510 system. For compatibility with old Japanese terminals; if you need to
|
|
|
1511 know, look at the source.
|
|
|
1512
|
|
|
1513 @item iso-2022-jp
|
|
|
1514 @itemx iso-2022-jp-2 (ISO7/SS)
|
|
|
1515 @itemx iso-2022-jp-dos
|
|
|
1516 @itemx iso-2022-jp-mac
|
|
|
1517 @itemx iso-2022-jp-unix
|
|
|
1518 @itemx iso-2022-jp-2-dos
|
|
|
1519 @itemx iso-2022-jp-2-mac
|
|
|
1520 @itemx iso-2022-jp-2-unix
|
|
|
1521
|
|
|
1522 Modeline indicator: @code{MULE/7bit}. A type @code{iso2022} 7-bit coding
|
|
|
1523 system with @code{ascii} (G0) initially designated, and complex
|
|
|
1524 specifications to insure backward compatibility with old Japanese
|
|
|
1525 systems. Used for communication with mail and news in Japan. The "-2"
|
|
|
1526 versions also use SS2 to invoke a 96-charset one character at a time.
|
|
|
1527
|
|
|
1528 @item iso-2022-kr
|
|
|
1529 Modeline indicator: @code{Ko/7bit} A type @code{iso2022} 7-bit coding
|
|
|
1530 system with @code{ascii} (G0) and @code{korean-ksc5601} (G1) initially
|
|
|
1531 designated. Used for e-mail in Korea.
|
|
|
1532
|
|
|
1533 @item iso-2022-lock
|
|
|
1534 @itemx iso-2022-lock-dos
|
|
|
1535 @itemx iso-2022-lock-mac
|
|
|
1536 @itemx iso-2022-lock-unix
|
|
|
1537
|
|
|
1538 Modeline indicator: @code{ISO7/Lock}. A type @code{iso2022} 7-bit coding
|
|
|
1539 system with @code{ascii} (G0) initially designated, using Locking-Shift
|
|
|
1540 to invoke a 96-charset.
|
|
|
1541
|
|
|
1542 @item iso-8859-1
|
|
|
1543 @itemx iso-8859-1-dos
|
|
|
1544 @itemx iso-8859-1-mac
|
|
|
1545 @itemx iso-8859-1-unix
|
|
|
1546
|
|
|
1547 Due to implementation, this is not a type @code{iso2022} coding system,
|
|
|
1548 but rather an alias for the @code{raw-text} coding system.
|
|
|
1549
|
|
|
1550 @item iso-8859-2
|
|
|
1551 @itemx iso-8859-2-dos
|
|
|
1552 @itemx iso-8859-2-mac
|
|
|
1553 @itemx iso-8859-2-unix
|
|
|
1554
|
|
|
1555 Modeline indicator: @code{MIME/Ltn-2}. A type @code{iso2022} coding
|
|
|
1556 system with @code{ascii} (G0) and @code{latin-iso8859-2} (G1) initially
|
|
|
1557 invoked.
|
|
|
1558
|
|
|
1559 @item iso-8859-3
|
|
|
1560 @itemx iso-8859-3-dos
|
|
|
1561 @itemx iso-8859-3-mac
|
|
|
1562 @itemx iso-8859-3-unix
|
|
|
1563
|
|
|
1564 Modeline indicator: @code{MIME/Ltn-3}. A type @code{iso2022} coding system
|
|
|
1565 with @code{ascii} (G0) and @code{latin-iso8859-3} (G1) initially
|
|
|
1566 invoked.
|
|
|
1567
|
|
|
1568 @item iso-8859-4
|
|
|
1569 @itemx iso-8859-4-dos
|
|
|
1570 @itemx iso-8859-4-mac
|
|
|
1571 @itemx iso-8859-4-unix
|
|
|
1572
|
|
|
1573 Modeline indicator: @code{MIME/Ltn-4}. A type @code{iso2022} coding system
|
|
|
1574 with @code{ascii} (G0) and @code{latin-iso8859-4} (G1) initially
|
|
|
1575 invoked.
|
|
|
1576
|
|
|
1577 @item iso-8859-5
|
|
|
1578 @itemx iso-8859-5-dos
|
|
|
1579 @itemx iso-8859-5-mac
|
|
|
1580 @itemx iso-8859-5-unix
|
|
|
1581
|
|
|
1582 Modeline indicator: @code{ISO8/Cyr}. A type @code{iso2022} coding system with
|
|
|
1583 @code{ascii} (G0) and @code{cyrillic-iso8859-5} (G1) initially invoked.
|
|
|
1584
|
|
|
1585 @item iso-8859-7
|
|
|
1586 @itemx iso-8859-7-dos
|
|
|
1587 @itemx iso-8859-7-mac
|
|
|
1588 @itemx iso-8859-7-unix
|
|
|
1589
|
|
|
1590 Modeline indicator: @code{Grk}. A type @code{iso2022} coding system with
|
|
|
1591 @code{ascii} (G0) and @code{greek-iso8859-7} (G1) initially invoked.
|
|
|
1592
|
|
|
1593 @item iso-8859-8
|
|
|
1594 @itemx iso-8859-8-dos
|
|
|
1595 @itemx iso-8859-8-mac
|
|
|
1596 @itemx iso-8859-8-unix
|
|
|
1597
|
|
|
1598 Modeline indicator: @code{MIME/Hbrw}. A type @code{iso2022} coding system with
|
|
|
1599 @code{ascii} (G0) and @code{hebrew-iso8859-8} (G1) initially invoked.
|
|
|
1600
|
|
|
1601 @item iso-8859-9
|
|
|
1602 @itemx iso-8859-9-dos
|
|
|
1603 @itemx iso-8859-9-mac
|
|
|
1604 @itemx iso-8859-9-unix
|
|
|
1605
|
|
|
1606 Modeline indicator: @code{MIME/Ltn-5}. A type @code{iso2022} coding system
|
|
|
1607 with @code{ascii} (G0) and @code{latin-iso8859-9} (G1) initially
|
|
|
1608 invoked.
|
|
|
1609
|
|
|
1610 @item koi8-r
|
|
|
1611 @itemx koi8-r-dos
|
|
|
1612 @itemx koi8-r-mac
|
|
|
1613 @itemx koi8-r-unix
|
|
|
1614
|
|
|
1615 Modeline indicator: @code{KOI8}. A type @code{ccl} coding-system used for
|
|
|
1616 KOI8-R, an encoding of the Cyrillic alphabet.
|
|
|
1617
|
|
|
1618 @item shift_jis
|
|
|
1619 @itemx shift_jis-dos
|
|
|
1620 @itemx shift_jis-mac
|
|
|
1621 @itemx shift_jis-unix
|
|
|
1622
|
|
|
1623 Modeline indicator: @code{Ja/SJIS}. A type @code{shift-jis} coding-system
|
|
|
1624 implementing the Shift-JIS encoding for Japanese. The underscore is to
|
|
|
1625 conform to the MIME charset implementing this encoding.
|
|
|
1626
|
|
|
1627 @item tis-620
|
|
|
1628 @itemx tis-620-dos
|
|
|
1629 @itemx tis-620-mac
|
|
|
1630 @itemx tis-620-unix
|
|
|
1631
|
|
|
1632 Modeline indicator: @code{TIS620}. A type @code{ccl} encoding for Thai. The
|
|
|
1633 external encoding is defined by TIS620, the internal encoding is
|
|
|
1634 peculiar to MULE, and called @code{thai-xtis}.
|
|
|
1635
|
|
|
1636 @item viqr
|
|
|
1637
|
|
|
1638 Modeline indicator: @code{VIQR}. A type @code{no-conversion} coding
|
|
|
1639 system with Unix EOL convention (ie, no conversion) using
|
|
|
1640 post-read-decode and pre-write-encode functions to translate the VIQR
|
|
|
1641 coding system for Vietnamese.
|
|
|
1642
|
|
|
1643 @item viscii
|
|
|
1644 @itemx viscii-dos
|
|
|
1645 @itemx viscii-mac
|
|
|
1646 @itemx viscii-unix
|
|
|
1647
|
|
|
1648 Modeline indicator: @code{VISCII}. A type @code{ccl} coding-system used
|
|
|
1649 for VISCII 1.1 for Vietnamese. Differs slightly from VSCII; VISCII is
|
|
|
1650 given priority by XEmacs.
|
|
|
1651
|
|
|
1652 @item vscii
|
|
|
1653 @itemx vscii-dos
|
|
|
1654 @itemx vscii-mac
|
|
|
1655 @itemx vscii-unix
|
|
|
1656
|
|
|
1657 Modeline indicator: @code{VSCII}. A type @code{ccl} coding-system used
|
|
|
1658 for VSCII 1.1 for Vietnamese. Differs slightly from VISCII, which is
|
|
|
1659 given priority by XEmacs. Use
|
|
|
1660 @code{(prefer-coding-system 'vietnamese-vscii)} to give priority to VSCII.
|
|
|
1661
|
|
|
1662 @end table
|
|
|
1663
|
|
428
|
1664 @node CCL, Category Tables, Coding Systems, MULE
|
|
|
1665 @section CCL
|
|
|
1666
|
|
442
|
1667 CCL (Code Conversion Language) is a simple structured programming
|
|
428
|
1668 language designed for character coding conversions. A CCL program is
|
|
|
1669 compiled to CCL code (represented by a vector of integers) and executed
|
|
|
1670 by the CCL interpreter embedded in Emacs. The CCL interpreter
|
|
|
1671 implements a virtual machine with 8 registers called @code{r0}, ...,
|
|
|
1672 @code{r7}, a number of control structures, and some I/O operators. Take
|
|
|
1673 care when using registers @code{r0} (used in implicit @dfn{set}
|
|
|
1674 statements) and especially @code{r7} (used internally by several
|
|
444
|
1675 statements and operations, especially for multiple return values and I/O
|
|
428
|
1676 operations).
|
|
|
1677
|
|
442
|
1678 CCL is used for code conversion during process I/O and file I/O for
|
|
428
|
1679 non-ISO2022 coding systems. (It is the only way for a user to specify a
|
|
|
1680 code conversion function.) It is also used for calculating the code
|
|
|
1681 point of an X11 font from a character code. However, since CCL is
|
|
|
1682 designed as a powerful programming language, it can be used for more
|
|
|
1683 generic calculation where efficiency is demanded. A combination of
|
|
|
1684 three or more arithmetic operations can be calculated faster by CCL than
|
|
|
1685 by Emacs Lisp.
|
|
|
1686
|
|
442
|
1687 @strong{Warning:} The code in @file{src/mule-ccl.c} and
|
|
428
|
1688 @file{$packages/lisp/mule-base/mule-ccl.el} is the definitive
|
|
|
1689 description of CCL's semantics. The previous version of this section
|
|
|
1690 contained several typos and obsolete names left from earlier versions of
|
|
|
1691 MULE, and many may remain. (I am not an experienced CCL programmer; the
|
|
|
1692 few who know CCL well find writing English painful.)
|
|
|
1693
|
|
442
|
1694 A CCL program transforms an input data stream into an output data
|
|
428
|
1695 stream. The input stream, held in a buffer of constant bytes, is left
|
|
|
1696 unchanged. The buffer may be filled by an external input operation,
|
|
|
1697 taken from an Emacs buffer, or taken from a Lisp string. The output
|
|
|
1698 buffer is a dynamic array of bytes, which can be written by an external
|
|
|
1699 output operation, inserted into an Emacs buffer, or returned as a Lisp
|
|
|
1700 string.
|
|
|
1701
|
|
442
|
1702 A CCL program is a (Lisp) list containing two or three members. The
|
|
428
|
1703 first member is the @dfn{buffer magnification}, which indicates the
|
|
|
1704 required minimum size of the output buffer as a multiple of the input
|
|
|
1705 buffer. It is followed by the @dfn{main block} which executes while
|
|
|
1706 there is input remaining, and an optional @dfn{EOF block} which is
|
|
|
1707 executed when the input is exhausted. Both the main block and the EOF
|
|
|
1708 block are CCL blocks.
|
|
|
1709
|
|
442
|
1710 A @dfn{CCL block} is either a CCL statement or list of CCL statements.
|
|
444
|
1711 A @dfn{CCL statement} is either a @dfn{set statement} (either an integer
|
|
428
|
1712 or an @dfn{assignment}, which is a list of a register to receive the
|
|
444
|
1713 assignment, an assignment operator, and an expression) or a @dfn{control
|
|
428
|
1714 statement} (a list starting with a keyword, whose allowable syntax
|
|
|
1715 depends on the keyword).
|
|
|
1716
|
|
|
1717 @menu
|
|
|
1718 * CCL Syntax:: CCL program syntax in BNF notation.
|
|
|
1719 * CCL Statements:: Semantics of CCL statements.
|
|
|
1720 * CCL Expressions:: Operators and expressions in CCL.
|
|
|
1721 * Calling CCL:: Running CCL programs.
|
|
|
1722 * CCL Examples:: The encoding functions for Big5 and KOI-8.
|
|
|
1723 @end menu
|
|
|
1724
|
|
442
|
1725 @node CCL Syntax, CCL Statements, , CCL
|
|
428
|
1726 @comment Node, Next, Previous, Up
|
|
|
1727 @subsection CCL Syntax
|
|
|
1728
|
|
442
|
1729 The full syntax of a CCL program in BNF notation:
|
|
428
|
1730
|
|
|
1731 @format
|
|
|
1732 CCL_PROGRAM :=
|
|
|
1733 (BUFFER_MAGNIFICATION
|
|
|
1734 CCL_MAIN_BLOCK
|
|
|
1735 [ CCL_EOF_BLOCK ])
|
|
|
1736
|
|
|
1737 BUFFER_MAGNIFICATION := integer
|
|
|
1738 CCL_MAIN_BLOCK := CCL_BLOCK
|
|
|
1739 CCL_EOF_BLOCK := CCL_BLOCK
|
|
|
1740
|
|
|
1741 CCL_BLOCK :=
|
|
|
1742 STATEMENT | (STATEMENT [STATEMENT ...])
|
|
|
1743 STATEMENT :=
|
|
|
1744 SET | IF | BRANCH | LOOP | REPEAT | BREAK | READ | WRITE
|
|
|
1745 | CALL | END
|
|
|
1746
|
|
|
1747 SET :=
|
|
|
1748 (REG = EXPRESSION)
|
|
|
1749 | (REG ASSIGNMENT_OPERATOR EXPRESSION)
|
|
|
1750 | integer
|
|
|
1751
|
|
|
1752 EXPRESSION := ARG | (EXPRESSION OPERATOR ARG)
|
|
|
1753
|
|
|
1754 IF := (if EXPRESSION CCL_BLOCK [CCL_BLOCK])
|
|
|
1755 BRANCH := (branch EXPRESSION CCL_BLOCK [CCL_BLOCK ...])
|
|
|
1756 LOOP := (loop STATEMENT [STATEMENT ...])
|
|
|
1757 BREAK := (break)
|
|
|
1758 REPEAT :=
|
|
|
1759 (repeat)
|
|
|
1760 | (write-repeat [REG | integer | string])
|
|
|
1761 | (write-read-repeat REG [integer | ARRAY])
|
|
|
1762 READ :=
|
|
|
1763 (read REG ...)
|
|
|
1764 | (read-if (REG OPERATOR ARG) CCL_BLOCK CCL_BLOCK)
|
|
|
1765 | (read-branch REG CCL_BLOCK [CCL_BLOCK ...])
|
|
|
1766 WRITE :=
|
|
|
1767 (write REG ...)
|
|
|
1768 | (write EXPRESSION)
|
|
|
1769 | (write integer) | (write string) | (write REG ARRAY)
|
|
|
1770 | string
|
|
|
1771 CALL := (call ccl-program-name)
|
|
|
1772 END := (end)
|
|
|
1773
|
|
|
1774 REG := r0 | r1 | r2 | r3 | r4 | r5 | r6 | r7
|
|
|
1775 ARG := REG | integer
|
|
|
1776 OPERATOR :=
|
|
|
1777 + | - | * | / | % | & | '|' | ^ | << | >> | <8 | >8 | //
|
|
|
1778 | < | > | == | <= | >= | != | de-sjis | en-sjis
|
|
|
1779 ASSIGNMENT_OPERATOR :=
|
|
|
1780 += | -= | *= | /= | %= | &= | '|=' | ^= | <<= | >>=
|
|
|
1781 ARRAY := '[' integer ... ']'
|
|
|
1782 @end format
|
|
|
1783
|
|
|
1784 @node CCL Statements, CCL Expressions, CCL Syntax, CCL
|
|
|
1785 @comment Node, Next, Previous, Up
|
|
|
1786 @subsection CCL Statements
|
|
|
1787
|
|
442
|
1788 The Emacs Code Conversion Language provides the following statement
|
|
428
|
1789 types: @dfn{set}, @dfn{if}, @dfn{branch}, @dfn{loop}, @dfn{repeat},
|
|
|
1790 @dfn{break}, @dfn{read}, @dfn{write}, @dfn{call}, and @dfn{end}.
|
|
|
1791
|
|
|
1792 @heading Set statement:
|
|
|
1793
|
|
442
|
1794 The @dfn{set} statement has three variants with the syntaxes
|
|
428
|
1795 @samp{(@var{reg} = @var{expression})},
|
|
|
1796 @samp{(@var{reg} @var{assignment_operator} @var{expression})}, and
|
|
|
1797 @samp{@var{integer}}. The assignment operator variation of the
|
|
|
1798 @dfn{set} statement works the same way as the corresponding C expression
|
|
|
1799 statement does. The assignment operators are @code{+=}, @code{-=},
|
|
|
1800 @code{*=}, @code{/=}, @code{%=}, @code{&=}, @code{|=}, @code{^=},
|
|
|
1801 @code{<<=}, and @code{>>=}, and they have the same meanings as in C. A
|
|
|
1802 "naked integer" @var{integer} is equivalent to a @var{set} statement of
|
|
|
1803 the form @code{(r0 = @var{integer})}.
|
|
|
1804
|
|
|
1805 @heading I/O statements:
|
|
|
1806
|
|
442
|
1807 The @dfn{read} statement takes one or more registers as arguments. It
|
|
444
|
1808 reads one byte (a C char) from the input into each register in turn.
|
|
428
|
1809
|
|
442
|
1810 The @dfn{write} takes several forms. In the form @samp{(write @var{reg}
|
|
428
|
1811 ...)} it takes one or more registers as arguments and writes each in
|
|
|
1812 turn to the output. The integer in a register (interpreted as an
|
|
|
1813 Emchar) is encoded to multibyte form (ie, Bufbytes) and written to the
|
|
|
1814 current output buffer. If it is less than 256, it is written as is.
|
|
|
1815 The forms @samp{(write @var{expression})} and @samp{(write
|
|
|
1816 @var{integer})} are treated analogously. The form @samp{(write
|
|
|
1817 @var{string})} writes the constant string to the output. A
|
|
|
1818 "naked string" @samp{@var{string}} is equivalent to the statement @samp{(write
|
|
|
1819 @var{string})}. The form @samp{(write @var{reg} @var{array})} writes
|
|
|
1820 the @var{reg}th element of the @var{array} to the output.
|
|
|
1821
|
|
|
1822 @heading Conditional statements:
|
|
|
1823
|
|
442
|
1824 The @dfn{if} statement takes an @var{expression}, a @var{CCL block}, and
|
|
428
|
1825 an optional @var{second CCL block} as arguments. If the
|
|
|
1826 @var{expression} evaluates to non-zero, the first @var{CCL block} is
|
|
|
1827 executed. Otherwise, if there is a @var{second CCL block}, it is
|
|
|
1828 executed.
|
|
|
1829
|
|
442
|
1830 The @dfn{read-if} variant of the @dfn{if} statement takes an
|
|
428
|
1831 @var{expression}, a @var{CCL block}, and an optional @var{second CCL
|
|
|
1832 block} as arguments. The @var{expression} must have the form
|
|
|
1833 @code{(@var{reg} @var{operator} @var{operand})} (where @var{operand} is
|
|
|
1834 a register or an integer). The @code{read-if} statement first reads
|
|
|
1835 from the input into the first register operand in the @var{expression},
|
|
|
1836 then conditionally executes a CCL block just as the @code{if} statement
|
|
|
1837 does.
|
|
|
1838
|
|
442
|
1839 The @dfn{branch} statement takes an @var{expression} and one or more CCL
|
|
428
|
1840 blocks as arguments. The CCL blocks are treated as a zero-indexed
|
|
|
1841 array, and the @code{branch} statement uses the @var{expression} as the
|
|
|
1842 index of the CCL block to execute. Null CCL blocks may be used as
|
|
|
1843 no-ops, continuing execution with the statement following the
|
|
|
1844 @code{branch} statement in the containing CCL block. Out-of-range
|
|
444
|
1845 values for the @var{expression} are also treated as no-ops.
|
|
428
|
1846
|
|
442
|
1847 The @dfn{read-branch} variant of the @dfn{branch} statement takes an
|
|
428
|
1848 @var{register}, a @var{CCL block}, and an optional @var{second CCL
|
|
|
1849 block} as arguments. The @code{read-branch} statement first reads from
|
|
|
1850 the input into the @var{register}, then conditionally executes a CCL
|
|
|
1851 block just as the @code{branch} statement does.
|
|
|
1852
|
|
|
1853 @heading Loop control statements:
|
|
|
1854
|
|
442
|
1855 The @dfn{loop} statement creates a block with an implied jump from the
|
|
444
|
1856 end of the block back to its head. The loop is exited on a @code{break}
|
|
428
|
1857 statement, and continued without executing the tail by a @code{repeat}
|
|
|
1858 statement.
|
|
|
1859
|
|
442
|
1860 The @dfn{break} statement, written @samp{(break)}, terminates the
|
|
428
|
1861 current loop and continues with the next statement in the current
|
|
444
|
1862 block.
|
|
428
|
1863
|
|
442
|
1864 The @dfn{repeat} statement has three variants, @code{repeat},
|
|
428
|
1865 @code{write-repeat}, and @code{write-read-repeat}. Each continues the
|
|
|
1866 current loop from its head, possibly after performing I/O.
|
|
|
1867 @code{repeat} takes no arguments and does no I/O before jumping.
|
|
444
|
1868 @code{write-repeat} takes a single argument (a register, an
|
|
428
|
1869 integer, or a string), writes it to the output, then jumps.
|
|
|
1870 @code{write-read-repeat} takes one or two arguments. The first must
|
|
|
1871 be a register. The second may be an integer or an array; if absent, it
|
|
|
1872 is implicitly set to the first (register) argument.
|
|
|
1873 @code{write-read-repeat} writes its second argument to the output, then
|
|
|
1874 reads from the input into the register, and finally jumps. See the
|
|
|
1875 @code{write} and @code{read} statements for the semantics of the I/O
|
|
|
1876 operations for each type of argument.
|
|
|
1877
|
|
|
1878 @heading Other control statements:
|
|
|
1879
|
|
442
|
1880 The @dfn{call} statement, written @samp{(call @var{ccl-program-name})},
|
|
428
|
1881 executes a CCL program as a subroutine. It does not return a value to
|
|
|
1882 the caller, but can modify the register status.
|
|
|
1883
|
|
442
|
1884 The @dfn{end} statement, written @samp{(end)}, terminates the CCL
|
|
428
|
1885 program successfully, and returns to caller (which may be a CCL
|
|
|
1886 program). It does not alter the status of the registers.
|
|
|
1887
|
|
|
1888 @node CCL Expressions, Calling CCL, CCL Statements, CCL
|
|
|
1889 @comment Node, Next, Previous, Up
|
|
|
1890 @subsection CCL Expressions
|
|
|
1891
|
|
442
|
1892 CCL, unlike Lisp, uses infix expressions. The simplest CCL expressions
|
|
428
|
1893 consist of a single @var{operand}, either a register (one of @code{r0},
|
|
|
1894 ..., @code{r0}) or an integer. Complex expressions are lists of the
|
|
|
1895 form @code{( @var{expression} @var{operator} @var{operand} )}. Unlike
|
|
|
1896 C, assignments are not expressions.
|
|
|
1897
|
|
442
|
1898 In the following table, @var{X} is the target resister for a @dfn{set}.
|
|
428
|
1899 In subexpressions, this is implicitly @code{r7}. This means that
|
|
|
1900 @code{>8}, @code{//}, @code{de-sjis}, and @code{en-sjis} cannot be used
|
|
|
1901 freely in subexpressions, since they return parts of their values in
|
|
|
1902 @code{r7}. @var{Y} may be an expression, register, or integer, while
|
|
|
1903 @var{Z} must be a register or an integer.
|
|
|
1904
|
|
|
1905 @multitable @columnfractions .22 .14 .09 .55
|
|
|
1906 @item Name @tab Operator @tab Code @tab C-like Description
|
|
|
1907 @item CCL_PLUS @tab @code{+} @tab 0x00 @tab X = Y + Z
|
|
|
1908 @item CCL_MINUS @tab @code{-} @tab 0x01 @tab X = Y - Z
|
|
|
1909 @item CCL_MUL @tab @code{*} @tab 0x02 @tab X = Y * Z
|
|
|
1910 @item CCL_DIV @tab @code{/} @tab 0x03 @tab X = Y / Z
|
|
|
1911 @item CCL_MOD @tab @code{%} @tab 0x04 @tab X = Y % Z
|
|
|
1912 @item CCL_AND @tab @code{&} @tab 0x05 @tab X = Y & Z
|
|
|
1913 @item CCL_OR @tab @code{|} @tab 0x06 @tab X = Y | Z
|
|
|
1914 @item CCL_XOR @tab @code{^} @tab 0x07 @tab X = Y ^ Z
|
|
|
1915 @item CCL_LSH @tab @code{<<} @tab 0x08 @tab X = Y << Z
|
|
|
1916 @item CCL_RSH @tab @code{>>} @tab 0x09 @tab X = Y >> Z
|
|
|
1917 @item CCL_LSH8 @tab @code{<8} @tab 0x0A @tab X = (Y << 8) | Z
|
|
|
1918 @item CCL_RSH8 @tab @code{>8} @tab 0x0B @tab X = Y >> 8, r[7] = Y & 0xFF
|
|
|
1919 @item CCL_DIVMOD @tab @code{//} @tab 0x0C @tab X = Y / Z, r[7] = Y % Z
|
|
|
1920 @item CCL_LS @tab @code{<} @tab 0x10 @tab X = (X < Y)
|
|
|
1921 @item CCL_GT @tab @code{>} @tab 0x11 @tab X = (X > Y)
|
|
|
1922 @item CCL_EQ @tab @code{==} @tab 0x12 @tab X = (X == Y)
|
|
|
1923 @item CCL_LE @tab @code{<=} @tab 0x13 @tab X = (X <= Y)
|
|
|
1924 @item CCL_GE @tab @code{>=} @tab 0x14 @tab X = (X >= Y)
|
|
|
1925 @item CCL_NE @tab @code{!=} @tab 0x15 @tab X = (X != Y)
|
|
|
1926 @item CCL_ENCODE_SJIS @tab @code{en-sjis} @tab 0x16 @tab X = HIGHER_BYTE (SJIS (Y, Z))
|
|
|
1927 @item @tab @tab @tab r[7] = LOWER_BYTE (SJIS (Y, Z)
|
|
|
1928 @item CCL_DECODE_SJIS @tab @code{de-sjis} @tab 0x17 @tab X = HIGHER_BYTE (DE-SJIS (Y, Z))
|
|
|
1929 @item @tab @tab @tab r[7] = LOWER_BYTE (DE-SJIS (Y, Z))
|
|
|
1930 @end multitable
|
|
|
1931
|
|
442
|
1932 The CCL operators are as in C, with the addition of CCL_LSH8, CCL_RSH8,
|
|
428
|
1933 CCL_DIVMOD, CCL_ENCODE_SJIS, and CCL_DECODE_SJIS. The CCL_ENCODE_SJIS
|
|
|
1934 and CCL_DECODE_SJIS treat their first and second bytes as the high and
|
|
|
1935 low bytes of a two-byte character code. (SJIS stands for Shift JIS, an
|
|
|
1936 encoding of Japanese characters used by Microsoft. CCL_ENCODE_SJIS is a
|
|
|
1937 complicated transformation of the Japanese standard JIS encoding to
|
|
|
1938 Shift JIS. CCL_DECODE_SJIS is its inverse.) It is somewhat odd to
|
|
|
1939 represent the SJIS operations in infix form.
|
|
|
1940
|
|
442
|
1941 @node Calling CCL, CCL Examples, CCL Expressions, CCL
|
|
428
|
1942 @comment Node, Next, Previous, Up
|
|
|
1943 @subsection Calling CCL
|
|
|
1944
|
|
442
|
1945 CCL programs are called automatically during Emacs buffer I/O when the
|
|
428
|
1946 external representation has a coding system type of @code{shift-jis},
|
|
|
1947 @code{big5}, or @code{ccl}. The program is specified by the coding
|
|
|
1948 system (@pxref{Coding Systems}). You can also call CCL programs from
|
|
|
1949 other CCL programs, and from Lisp using these functions:
|
|
|
1950
|
|
|
1951 @defun ccl-execute ccl-program status
|
|
|
1952 Execute @var{ccl-program} with registers initialized by
|
|
|
1953 @var{status}. @var{ccl-program} is a vector of compiled CCL code
|
|
444
|
1954 created by @code{ccl-compile}. It is an error for the program to try to
|
|
428
|
1955 execute a CCL I/O command. @var{status} must be a vector of nine
|
|
|
1956 values, specifying the initial value for the R0, R1 .. R7 registers and
|
|
|
1957 for the instruction counter IC. A @code{nil} value for a register
|
|
|
1958 initializer causes the register to be set to 0. A @code{nil} value for
|
|
|
1959 the IC initializer causes execution to start at the beginning of the
|
|
|
1960 program. When the program is done, @var{status} is modified (by
|
|
|
1961 side-effect) to contain the ending values for the corresponding
|
|
444
|
1962 registers and IC.
|
|
428
|
1963 @end defun
|
|
|
1964
|
|
444
|
1965 @defun ccl-execute-on-string ccl-program status string &optional continue
|
|
428
|
1966 Execute @var{ccl-program} with initial @var{status} on
|
|
|
1967 @var{string}. @var{ccl-program} is a vector of compiled CCL code
|
|
|
1968 created by @code{ccl-compile}. @var{status} must be a vector of nine
|
|
|
1969 values, specifying the initial value for the R0, R1 .. R7 registers and
|
|
|
1970 for the instruction counter IC. A @code{nil} value for a register
|
|
|
1971 initializer causes the register to be set to 0. A @code{nil} value for
|
|
|
1972 the IC initializer causes execution to start at the beginning of the
|
|
444
|
1973 program. An optional fourth argument @var{continue}, if non-@code{nil}, causes
|
|
428
|
1974 the IC to
|
|
|
1975 remain on the unsatisfied read operation if the program terminates due
|
|
|
1976 to exhaustion of the input buffer. Otherwise the IC is set to the end
|
|
444
|
1977 of the program. When the program is done, @var{status} is modified (by
|
|
428
|
1978 side-effect) to contain the ending values for the corresponding
|
|
|
1979 registers and IC. Returns the resulting string.
|
|
|
1980 @end defun
|
|
|
1981
|
|
442
|
1982 To call a CCL program from another CCL program, it must first be
|
|
428
|
1983 registered:
|
|
|
1984
|
|
|
1985 @defun register-ccl-program name ccl-program
|
|
444
|
1986 Register @var{name} for CCL program @var{ccl-program} in
|
|
|
1987 @code{ccl-program-table}. @var{ccl-program} should be the compiled form of
|
|
|
1988 a CCL program, or @code{nil}. Return index number of the registered CCL
|
|
428
|
1989 program.
|
|
|
1990 @end defun
|
|
|
1991
|
|
442
|
1992 Information about the processor time used by the CCL interpreter can be
|
|
428
|
1993 obtained using these functions:
|
|
|
1994
|
|
|
1995 @defun ccl-elapsed-time
|
|
|
1996 Returns the elapsed processor time of the CCL interpreter as cons of
|
|
|
1997 user and system time, as
|
|
|
1998 floating point numbers measured in seconds. If only one
|
|
|
1999 overall value can be determined, the return value will be a cons of that
|
|
|
2000 value and 0.
|
|
|
2001 @end defun
|
|
|
2002
|
|
|
2003 @defun ccl-reset-elapsed-time
|
|
|
2004 Resets the CCL interpreter's internal elapsed time registers.
|
|
|
2005 @end defun
|
|
|
2006
|
|
442
|
2007 @node CCL Examples, , Calling CCL, CCL
|
|
428
|
2008 @comment Node, Next, Previous, Up
|
|
|
2009 @subsection CCL Examples
|
|
|
2010
|
|
442
|
2011 This section is not yet written.
|
|
428
|
2012
|
|
775
|
2013 @node Category Tables, Unicode Support, CCL, MULE
|
|
428
|
2014 @section Category Tables
|
|
|
2015
|
|
|
2016 A category table is a type of char table used for keeping track of
|
|
|
2017 categories. Categories are used for classifying characters for use in
|
|
440
|
2018 regexps---you can refer to a category rather than having to use a
|
|
428
|
2019 complicated [] expression (and category lookups are significantly
|
|
|
2020 faster).
|
|
|
2021
|
|
|
2022 There are 95 different categories available, one for each printable
|
|
|
2023 character (including space) in the ASCII charset. Each category is
|
|
|
2024 designated by one such character, called a @dfn{category designator}.
|
|
|
2025 They are specified in a regexp using the syntax @samp{\cX}, where X is a
|
|
|
2026 category designator. (This is not yet implemented.)
|
|
|
2027
|
|
|
2028 A category table specifies, for each character, the categories that
|
|
|
2029 the character is in. Note that a character can be in more than one
|
|
|
2030 category. More specifically, a category table maps from a character to
|
|
|
2031 either the value @code{nil} (meaning the character is in no categories)
|
|
|
2032 or a 95-element bit vector, specifying for each of the 95 categories
|
|
|
2033 whether the character is in that category.
|
|
|
2034
|
|
|
2035 Special Lisp functions are provided that abstract this, so you do not
|
|
|
2036 have to directly manipulate bit vectors.
|
|
|
2037
|
|
444
|
2038 @defun category-table-p object
|
|
|
2039 This function returns @code{t} if @var{object} is a category table.
|
|
428
|
2040 @end defun
|
|
|
2041
|
|
|
2042 @defun category-table &optional buffer
|
|
|
2043 This function returns the current category table. This is the one
|
|
|
2044 specified by the current buffer, or by @var{buffer} if it is
|
|
|
2045 non-@code{nil}.
|
|
|
2046 @end defun
|
|
|
2047
|
|
|
2048 @defun standard-category-table
|
|
|
2049 This function returns the standard category table. This is the one used
|
|
|
2050 for new buffers.
|
|
|
2051 @end defun
|
|
|
2052
|
|
444
|
2053 @defun copy-category-table &optional category-table
|
|
|
2054 This function returns a new category table which is a copy of
|
|
|
2055 @var{category-table}, which defaults to the standard category table.
|
|
428
|
2056 @end defun
|
|
|
2057
|
|
444
|
2058 @defun set-category-table category-table &optional buffer
|
|
|
2059 This function selects @var{category-table} as the new category table for
|
|
|
2060 @var{buffer}. @var{buffer} defaults to the current buffer if omitted.
|
|
428
|
2061 @end defun
|
|
|
2062
|
|
444
|
2063 @defun category-designator-p object
|
|
|
2064 This function returns @code{t} if @var{object} is a category designator (a
|
|
428
|
2065 char in the range @samp{' '} to @samp{'~'}).
|
|
|
2066 @end defun
|
|
|
2067
|
|
444
|
2068 @defun category-table-value-p object
|
|
|
2069 This function returns @code{t} if @var{object} is a category table value.
|
|
428
|
2070 Valid values are @code{nil} or a bit vector of size 95.
|
|
|
2071 @end defun
|
|
|
2072
|
|
775
|
2073
|
|
|
2074 @c Added 2002-03-13 sjt
|
|
|
2075 @node Unicode Support, , Category Tables, MULE
|
|
|
2076 @section Unicode Support
|
|
|
2077 @cindex unicode
|
|
|
2078 @cindex utf-8
|
|
|
2079 @cindex utf-16
|
|
|
2080 @cindex ucs-2
|
|
|
2081 @cindex ucs-4
|
|
|
2082 @cindex bmp
|
|
|
2083 @cindex basic multilingual plance
|
|
|
2084
|
|
|
2085 Unicode support was added by Ben Wing to XEmacs 21.5.6.
|
|
|
2086
|
|
|
2087 @defun set-language-unicode-precedence-list list
|
|
|
2088 Set the language-specific precedence list used for Unicode decoding.
|
|
|
2089 This is a list of charsets, which are consulted in order for a translation
|
|
|
2090 matching a given Unicode character. If no matches are found, the charsets
|
|
|
2091 in the default precedence list (see
|
|
|
2092 @code{set-default-unicode-precedence-list}) are consulted, and then all
|
|
|
2093 remaining charsets, in some arbitrary order.
|
|
|
2094
|
|
|
2095 The language-specific precedence list is meant to be set as part of the
|
|
|
2096 language environment initialization; the default precedence list is meant
|
|
|
2097 to be set by the user.
|
|
|
2098 @end defun
|
|
|
2099
|
|
|
2100 @defun language-unicode-precedence-list
|
|
|
2101 Return the language-specific precedence list used for Unicode decoding.
|
|
|
2102 See @code{set-language-unicode-precedence-list} for more information.
|
|
|
2103 @end defun
|
|
|
2104
|
|
|
2105 @defun set-default-unicode-precedence-list list
|
|
|
2106 Set the default precedence list used for Unicode decoding.
|
|
|
2107 This is meant to be set by the user. See
|
|
|
2108 `set-language-unicode-precedence-list' for more information.
|
|
|
2109 @end defun
|
|
|
2110
|
|
|
2111 @defun default-unicode-precedence-list
|
|
|
2112 Return the default precedence list used for Unicode decoding.
|
|
|
2113 See @code{set-language-unicode-precedence-list} for more information.
|
|
|
2114 @end defun
|
|
|
2115
|
|
|
2116 @defun set-unicode-conversion character code
|
|
|
2117 Add conversion information between Unicode codepoints and characters.
|
|
|
2118 @var{character} is one of the following:
|
|
|
2119
|
|
|
2120 @c #### fix this markup
|
|
|
2121 -- A character (in which case @var{code} must be a non-negative integer)
|
|
|
2122 -- A vector of characters (in which case @var{code} must be a vector of
|
|
|
2123 non-negative integers of the same length)
|
|
|
2124
|
|
|
2125 Values of @var{code} above 2^20 - 1 are allowed for the purpose of specifying
|
|
|
2126 private characters, but will cause errors when converted to UTF-16 or UTF-32.
|
|
|
2127 UCS-4 and UTF-8 can handle values to 2^31 - 1, but XEmacs Lisp integers top
|
|
|
2128 out at 2^30 - 1.
|
|
|
2129 @end defun
|
|
|
2130
|
|
|
2131 @defun character-to-unicode character
|
|
|
2132 Convert @var{character} to Unicode codepoint.
|
|
|
2133 When there is no international support (i.e. MULE is not defined),
|
|
|
2134 this function simply does @code{char-to-int}.
|
|
|
2135 @end defun
|
|
|
2136
|
|
|
2137 @defun unicode-to-character code [charsets]
|
|
|
2138 Convert Unicode codepoint @var{code} to character.
|
|
|
2139 @var{code} should be a non-negative integer.
|
|
|
2140 If @var{charsets} is given, it should be a list of charsets, and only those
|
|
|
2141 charsets will be consulted, in the given order, for a translation.
|
|
|
2142 Otherwise, the default ordering of all charsets will be given (see
|
|
|
2143 @code{set-unicode-charset-precedence}).
|
|
|
2144
|
|
|
2145 When there is no international support (i.e. MULE is not defined),
|
|
|
2146 this function simply does @code{int-to-char} and ignores the
|
|
|
2147 @var{charsets} argument.
|
|
|
2148 @end defun
|
|
|
2149
|
|
|
2150 @defun parse-unicode-translation-table filename charset start end offset flags
|
|
|
2151 Parse Unicode translation data in @var{filename} for MULE @var{charset}.
|
|
|
2152 Data is text, in the form of one translation per line -- charset
|
|
|
2153 codepoint followed by Unicode codepoint. Numbers are decimal or hex
|
|
|
2154 \(preceded by 0x). Comments are marked with a #. Charset codepoints
|
|
|
2155 for two-dimensional charsets should have the first octet stored in the
|
|
|
2156 high 8 bits of the hex number and the second in the low 8 bits.
|
|
|
2157
|
|
|
2158 If @var{start} and @var{end} are given, only charset codepoints within
|
|
|
2159 the given range will be processed. If @var{offset} is given, that value
|
|
|
2160 will be added to all charset codepoints in the file to obtain the
|
|
|
2161 internal charset codepoint. @var{start} and @var{end} apply to the
|
|
|
2162 codepoints in the file, before @var{offset} is applied.
|
|
|
2163
|
|
|
2164 (Note that, as usual, we assume that octets are in the range 32 to
|
|
|
2165 127 or 33 to 126. If you have a table in kuten form, with octets in
|
|
|
2166 the range 1 to 94, you will have to use an offset of 5140,
|
|
|
2167 i.e. 0x2020.)
|
|
|
2168
|
|
|
2169 @var{flags}, if specified, control further how the tables are interpreted
|
|
|
2170 and are used to special-case certain known table weirdnesses in the
|
|
|
2171 Unicode tables:
|
|
|
2172
|
|
|
2173 @table @code
|
|
|
2174 @item ignore-first-column'
|
|
|
2175 Exactly as it sounds. The JIS X 0208 tables have 3 columns of data instead
|
|
|
2176 of 2; the first is the Shift-JIS codepoint.
|
|
|
2177
|
|
|
2178 @item big5
|
|
|
2179 The charset codepoint is a Big Five codepoint; convert it to the
|
|
|
2180 proper hacked-up codepoint in `chinese-big5-1' or `chinese-big5-2'.
|
|
|
2181 @end table
|
|
|
2182 @end defun
|
|
|
2183
|
