Commit | Line | Data |
---|---|---|
b8d4c8d0 GM |
1 | @c -*-texinfo-*- |
2 | @c This is part of the GNU Emacs Lisp Reference Manual. | |
ab422c4d | 3 | @c Copyright (C) 1998-1999, 2001-2013 Free Software Foundation, Inc. |
b8d4c8d0 | 4 | @c See the file elisp.texi for copying conditions. |
ecc6530d | 5 | @node Non-ASCII Characters |
b8d4c8d0 GM |
6 | @chapter Non-@acronym{ASCII} Characters |
7 | @cindex multibyte characters | |
8 | @cindex characters, multi-byte | |
9 | @cindex non-@acronym{ASCII} characters | |
10 | ||
c4526e93 EZ |
11 | This chapter covers the special issues relating to characters and |
12 | how they are stored in strings and buffers. | |
b8d4c8d0 GM |
13 | |
14 | @menu | |
c4526e93 | 15 | * Text Representations:: How Emacs represents text. |
64a695bd | 16 | * Disabling Multibyte:: Controlling whether to use multibyte characters. |
b8d4c8d0 GM |
17 | * Converting Representations:: Converting unibyte to multibyte and vice versa. |
18 | * Selecting a Representation:: Treating a byte sequence as unibyte or multi. | |
19 | * Character Codes:: How unibyte and multibyte relate to | |
20 | codes of individual characters. | |
91211f07 EZ |
21 | * Character Properties:: Character attributes that define their |
22 | behavior and handling. | |
b8d4c8d0 GM |
23 | * Character Sets:: The space of possible character codes |
24 | is divided into various character sets. | |
b8d4c8d0 GM |
25 | * Scanning Charsets:: Which character sets are used in a buffer? |
26 | * Translation of Characters:: Translation tables are used for conversion. | |
27 | * Coding Systems:: Coding systems are conversions for saving files. | |
28 | * Input Methods:: Input methods allow users to enter various | |
29 | non-ASCII characters without special keyboards. | |
30 | * Locales:: Interacting with the POSIX locale. | |
31 | @end menu | |
32 | ||
33 | @node Text Representations | |
34 | @section Text Representations | |
c4526e93 EZ |
35 | @cindex text representation |
36 | ||
37 | Emacs buffers and strings support a large repertoire of characters | |
97d8273f | 38 | from many different scripts, allowing users to type and display text |
8cc8cecf | 39 | in almost any known written language. |
c4526e93 EZ |
40 | |
41 | @cindex character codepoint | |
42 | @cindex codespace | |
43 | @cindex Unicode | |
44 | To support this multitude of characters and scripts, Emacs closely | |
45 | follows the @dfn{Unicode Standard}. The Unicode Standard assigns a | |
46 | unique number, called a @dfn{codepoint}, to each and every character. | |
47 | The range of codepoints defined by Unicode, or the Unicode | |
85eeac93 CY |
48 | @dfn{codespace}, is @code{0..#x10FFFF} (in hexadecimal notation), |
49 | inclusive. Emacs extends this range with codepoints in the range | |
50 | @code{#x110000..#x3FFFFF}, which it uses for representing characters | |
51 | that are not unified with Unicode and @dfn{raw 8-bit bytes} that | |
52 | cannot be interpreted as characters. Thus, a character codepoint in | |
53 | Emacs is a 22-bit integer number. | |
c4526e93 EZ |
54 | |
55 | @cindex internal representation of characters | |
56 | @cindex characters, representation in buffers and strings | |
57 | @cindex multibyte text | |
58 | To conserve memory, Emacs does not hold fixed-length 22-bit numbers | |
59 | that are codepoints of text characters within buffers and strings. | |
60 | Rather, Emacs uses a variable-length internal representation of | |
61 | characters, that stores each character as a sequence of 1 to 5 8-bit | |
62 | bytes, depending on the magnitude of its codepoint@footnote{ | |
63 | This internal representation is based on one of the encodings defined | |
64 | by the Unicode Standard, called @dfn{UTF-8}, for representing any | |
65 | Unicode codepoint, but Emacs extends UTF-8 to represent the additional | |
8b80cdf5 | 66 | codepoints it uses for raw 8-bit bytes and characters not unified with |
97d8273f CY |
67 | Unicode.}. For example, any @acronym{ASCII} character takes up only 1 |
68 | byte, a Latin-1 character takes up 2 bytes, etc. We call this | |
69 | representation of text @dfn{multibyte}. | |
c4526e93 EZ |
70 | |
71 | Outside Emacs, characters can be represented in many different | |
72 | encodings, such as ISO-8859-1, GB-2312, Big-5, etc. Emacs converts | |
97d8273f | 73 | between these external encodings and its internal representation, as |
c4526e93 EZ |
74 | appropriate, when it reads text into a buffer or a string, or when it |
75 | writes text to a disk file or passes it to some other process. | |
76 | ||
77 | Occasionally, Emacs needs to hold and manipulate encoded text or | |
031c41de EZ |
78 | binary non-text data in its buffers or strings. For example, when |
79 | Emacs visits a file, it first reads the file's text verbatim into a | |
80 | buffer, and only then converts it to the internal representation. | |
81 | Before the conversion, the buffer holds encoded text. | |
b8d4c8d0 GM |
82 | |
83 | @cindex unibyte text | |
c4526e93 EZ |
84 | Encoded text is not really text, as far as Emacs is concerned, but |
85 | rather a sequence of raw 8-bit bytes. We call buffers and strings | |
86 | that hold encoded text @dfn{unibyte} buffers and strings, because | |
97d8273f CY |
87 | Emacs treats them as a sequence of individual bytes. Usually, Emacs |
88 | displays unibyte buffers and strings as octal codes such as | |
89 | @code{\237}. We recommend that you never use unibyte buffers and | |
c4526e93 | 90 | strings except for manipulating encoded text or binary non-text data. |
b8d4c8d0 GM |
91 | |
92 | In a buffer, the buffer-local value of the variable | |
93 | @code{enable-multibyte-characters} specifies the representation used. | |
94 | The representation for a string is determined and recorded in the string | |
95 | when the string is constructed. | |
96 | ||
8a14dec7 | 97 | @defvar enable-multibyte-characters |
b8d4c8d0 GM |
98 | This variable specifies the current buffer's text representation. |
99 | If it is non-@code{nil}, the buffer contains multibyte text; otherwise, | |
c4526e93 | 100 | it contains unibyte encoded text or binary non-text data. |
b8d4c8d0 GM |
101 | |
102 | You cannot set this variable directly; instead, use the function | |
103 | @code{set-buffer-multibyte} to change a buffer's representation. | |
8a14dec7 | 104 | @end defvar |
b8d4c8d0 GM |
105 | |
106 | @defun position-bytes position | |
c4526e93 EZ |
107 | Buffer positions are measured in character units. This function |
108 | returns the byte-position corresponding to buffer position | |
b8d4c8d0 GM |
109 | @var{position} in the current buffer. This is 1 at the start of the |
110 | buffer, and counts upward in bytes. If @var{position} is out of | |
111 | range, the value is @code{nil}. | |
112 | @end defun | |
113 | ||
114 | @defun byte-to-position byte-position | |
031c41de EZ |
115 | Return the buffer position, in character units, corresponding to given |
116 | @var{byte-position} in the current buffer. If @var{byte-position} is | |
117 | out of range, the value is @code{nil}. In a multibyte buffer, an | |
118 | arbitrary value of @var{byte-position} can be not at character | |
119 | boundary, but inside a multibyte sequence representing a single | |
120 | character; in this case, this function returns the buffer position of | |
121 | the character whose multibyte sequence includes @var{byte-position}. | |
122 | In other words, the value does not change for all byte positions that | |
123 | belong to the same character. | |
b8d4c8d0 GM |
124 | @end defun |
125 | ||
126 | @defun multibyte-string-p string | |
c4526e93 | 127 | Return @code{t} if @var{string} is a multibyte string, @code{nil} |
3323c263 EZ |
128 | otherwise. This function also returns @code{nil} if @var{string} is |
129 | some object other than a string. | |
b8d4c8d0 GM |
130 | @end defun |
131 | ||
132 | @defun string-bytes string | |
133 | @cindex string, number of bytes | |
134 | This function returns the number of bytes in @var{string}. | |
135 | If @var{string} is a multibyte string, this can be greater than | |
136 | @code{(length @var{string})}. | |
137 | @end defun | |
138 | ||
c4526e93 EZ |
139 | @defun unibyte-string &rest bytes |
140 | This function concatenates all its argument @var{bytes} and makes the | |
141 | result a unibyte string. | |
142 | @end defun | |
143 | ||
64a695bd XF |
144 | @node Disabling Multibyte |
145 | @section Disabling Multibyte Characters | |
146 | @cindex disabling multibyte | |
147 | ||
148 | By default, Emacs starts in multibyte mode: it stores the contents | |
149 | of buffers and strings using an internal encoding that represents | |
150 | non-@acronym{ASCII} characters using multi-byte sequences. Multibyte | |
151 | mode allows you to use all the supported languages and scripts without | |
152 | limitations. | |
153 | ||
154 | @cindex turn multibyte support on or off | |
155 | Under very special circumstances, you may want to disable multibyte | |
156 | character support, for a specific buffer. | |
157 | When multibyte characters are disabled in a buffer, we call | |
158 | that @dfn{unibyte mode}. In unibyte mode, each character in the | |
159 | buffer has a character code ranging from 0 through 255 (0377 octal); 0 | |
160 | through 127 (0177 octal) represent @acronym{ASCII} characters, and 128 | |
161 | (0200 octal) through 255 (0377 octal) represent non-@acronym{ASCII} | |
162 | characters. | |
163 | ||
164 | To edit a particular file in unibyte representation, visit it using | |
165 | @code{find-file-literally}. @xref{Visiting Functions}. You can | |
166 | convert a multibyte buffer to unibyte by saving it to a file, killing | |
167 | the buffer, and visiting the file again with | |
168 | @code{find-file-literally}. Alternatively, you can use @kbd{C-x | |
169 | @key{RET} c} (@code{universal-coding-system-argument}) and specify | |
170 | @samp{raw-text} as the coding system with which to visit or save a | |
171 | file. @xref{Text Coding, , Specifying a Coding System for File Text, | |
172 | emacs, GNU Emacs Manual}. Unlike @code{find-file-literally}, finding | |
173 | a file as @samp{raw-text} doesn't disable format conversion, | |
174 | uncompression, or auto mode selection. | |
175 | ||
176 | @c See http://debbugs.gnu.org/11226 for lack of unibyte tooltip. | |
177 | @vindex enable-multibyte-characters | |
178 | The buffer-local variable @code{enable-multibyte-characters} is | |
179 | non-@code{nil} in multibyte buffers, and @code{nil} in unibyte ones. | |
180 | The mode line also indicates whether a buffer is multibyte or not. | |
181 | With a graphical display, in a multibyte buffer, the portion of the | |
182 | mode line that indicates the character set has a tooltip that (amongst | |
183 | other things) says that the buffer is multibyte. In a unibyte buffer, | |
184 | the character set indicator is absent. Thus, in a unibyte buffer | |
185 | (when using a graphical display) there is normally nothing before the | |
186 | indication of the visited file's end-of-line convention (colon, | |
187 | backslash, etc.), unless you are using an input method. | |
188 | ||
189 | @findex toggle-enable-multibyte-characters | |
190 | You can turn off multibyte support in a specific buffer by invoking the | |
191 | command @code{toggle-enable-multibyte-characters} in that buffer. | |
192 | ||
b8d4c8d0 GM |
193 | @node Converting Representations |
194 | @section Converting Text Representations | |
195 | ||
196 | Emacs can convert unibyte text to multibyte; it can also convert | |
031c41de | 197 | multibyte text to unibyte, provided that the multibyte text contains |
8b80cdf5 | 198 | only @acronym{ASCII} and 8-bit raw bytes. In general, these |
031c41de EZ |
199 | conversions happen when inserting text into a buffer, or when putting |
200 | text from several strings together in one string. You can also | |
201 | explicitly convert a string's contents to either representation. | |
b8d4c8d0 | 202 | |
97d8273f CY |
203 | Emacs chooses the representation for a string based on the text from |
204 | which it is constructed. The general rule is to convert unibyte text | |
205 | to multibyte text when combining it with other multibyte text, because | |
206 | the multibyte representation is more general and can hold whatever | |
b8d4c8d0 GM |
207 | characters the unibyte text has. |
208 | ||
209 | When inserting text into a buffer, Emacs converts the text to the | |
210 | buffer's representation, as specified by | |
211 | @code{enable-multibyte-characters} in that buffer. In particular, when | |
212 | you insert multibyte text into a unibyte buffer, Emacs converts the text | |
213 | to unibyte, even though this conversion cannot in general preserve all | |
214 | the characters that might be in the multibyte text. The other natural | |
215 | alternative, to convert the buffer contents to multibyte, is not | |
216 | acceptable because the buffer's representation is a choice made by the | |
217 | user that cannot be overridden automatically. | |
218 | ||
97d8273f | 219 | Converting unibyte text to multibyte text leaves @acronym{ASCII} |
e4021ec1 | 220 | characters unchanged, and converts bytes with codes 128 through 255 to |
97d8273f | 221 | the multibyte representation of raw eight-bit bytes. |
b8d4c8d0 | 222 | |
031c41de EZ |
223 | Converting multibyte text to unibyte converts all @acronym{ASCII} |
224 | and eight-bit characters to their single-byte form, but loses | |
225 | information for non-@acronym{ASCII} characters by discarding all but | |
226 | the low 8 bits of each character's codepoint. Converting unibyte text | |
227 | to multibyte and back to unibyte reproduces the original unibyte text. | |
b8d4c8d0 | 228 | |
031c41de | 229 | The next two functions either return the argument @var{string}, or a |
b8d4c8d0 GM |
230 | newly created string with no text properties. |
231 | ||
b8d4c8d0 GM |
232 | @defun string-to-multibyte string |
233 | This function returns a multibyte string containing the same sequence | |
031c41de | 234 | of characters as @var{string}. If @var{string} is a multibyte string, |
8b80cdf5 EZ |
235 | it is returned unchanged. The function assumes that @var{string} |
236 | includes only @acronym{ASCII} characters and raw 8-bit bytes; the | |
237 | latter are converted to their multibyte representation corresponding | |
85eeac93 CY |
238 | to the codepoints @code{#x3FFF80} through @code{#x3FFFFF}, inclusive |
239 | (@pxref{Text Representations, codepoints}). | |
031c41de EZ |
240 | @end defun |
241 | ||
242 | @defun string-to-unibyte string | |
243 | This function returns a unibyte string containing the same sequence of | |
244 | characters as @var{string}. It signals an error if @var{string} | |
245 | contains a non-@acronym{ASCII} character. If @var{string} is a | |
8b80cdf5 EZ |
246 | unibyte string, it is returned unchanged. Use this function for |
247 | @var{string} arguments that contain only @acronym{ASCII} and eight-bit | |
248 | characters. | |
b8d4c8d0 GM |
249 | @end defun |
250 | ||
eed99101 | 251 | @c FIXME: Should `@var{character}' be `@var{byte}'? |
3e99b825 CY |
252 | @defun byte-to-string byte |
253 | @cindex byte to string | |
254 | This function returns a unibyte string containing a single byte of | |
35a30759 | 255 | character data, @var{character}. It signals an error if |
3e99b825 CY |
256 | @var{character} is not an integer between 0 and 255. |
257 | @end defun | |
b8d4c8d0 GM |
258 | |
259 | @defun multibyte-char-to-unibyte char | |
97d8273f CY |
260 | This converts the multibyte character @var{char} to a unibyte |
261 | character, and returns that character. If @var{char} is neither | |
262 | @acronym{ASCII} nor eight-bit, the function returns -1. | |
b8d4c8d0 GM |
263 | @end defun |
264 | ||
265 | @defun unibyte-char-to-multibyte char | |
266 | This convert the unibyte character @var{char} to a multibyte | |
8b80cdf5 EZ |
267 | character, assuming @var{char} is either @acronym{ASCII} or raw 8-bit |
268 | byte. | |
b8d4c8d0 GM |
269 | @end defun |
270 | ||
271 | @node Selecting a Representation | |
272 | @section Selecting a Representation | |
273 | ||
274 | Sometimes it is useful to examine an existing buffer or string as | |
275 | multibyte when it was unibyte, or vice versa. | |
276 | ||
277 | @defun set-buffer-multibyte multibyte | |
278 | Set the representation type of the current buffer. If @var{multibyte} | |
279 | is non-@code{nil}, the buffer becomes multibyte. If @var{multibyte} | |
280 | is @code{nil}, the buffer becomes unibyte. | |
281 | ||
282 | This function leaves the buffer contents unchanged when viewed as a | |
031c41de | 283 | sequence of bytes. As a consequence, it can change the contents |
97d8273f CY |
284 | viewed as characters; for instance, a sequence of three bytes which is |
285 | treated as one character in multibyte representation will count as | |
286 | three characters in unibyte representation. Eight-bit characters | |
031c41de EZ |
287 | representing raw bytes are an exception. They are represented by one |
288 | byte in a unibyte buffer, but when the buffer is set to multibyte, | |
289 | they are converted to two-byte sequences, and vice versa. | |
b8d4c8d0 GM |
290 | |
291 | This function sets @code{enable-multibyte-characters} to record which | |
292 | representation is in use. It also adjusts various data in the buffer | |
293 | (including overlays, text properties and markers) so that they cover the | |
294 | same text as they did before. | |
295 | ||
cd996018 CY |
296 | This function signals an error if the buffer is narrowed, since the |
297 | narrowing might have occurred in the middle of multibyte character | |
298 | sequences. | |
299 | ||
300 | This function also signals an error if the buffer is an indirect | |
301 | buffer. An indirect buffer always inherits the representation of its | |
b8d4c8d0 GM |
302 | base buffer. |
303 | @end defun | |
304 | ||
305 | @defun string-as-unibyte string | |
97d8273f CY |
306 | If @var{string} is already a unibyte string, this function returns |
307 | @var{string} itself. Otherwise, it returns a new string with the same | |
308 | bytes as @var{string}, but treating each byte as a separate character | |
309 | (so that the value may have more characters than @var{string}); as an | |
310 | exception, each eight-bit character representing a raw byte is | |
311 | converted into a single byte. The newly-created string contains no | |
031c41de | 312 | text properties. |
b8d4c8d0 GM |
313 | @end defun |
314 | ||
315 | @defun string-as-multibyte string | |
97d8273f CY |
316 | If @var{string} is a multibyte string, this function returns |
317 | @var{string} itself. Otherwise, it returns a new string with the same | |
318 | bytes as @var{string}, but treating each multibyte sequence as one | |
319 | character. This means that the value may have fewer characters than | |
320 | @var{string} has. If a byte sequence in @var{string} is invalid as a | |
321 | multibyte representation of a single character, each byte in the | |
322 | sequence is treated as a raw 8-bit byte. The newly-created string | |
323 | contains no text properties. | |
b8d4c8d0 GM |
324 | @end defun |
325 | ||
326 | @node Character Codes | |
327 | @section Character Codes | |
328 | @cindex character codes | |
329 | ||
ffdbc44b CY |
330 | The unibyte and multibyte text representations use different |
331 | character codes. The valid character codes for unibyte representation | |
85eeac93 CY |
332 | range from 0 to @code{#xFF} (255)---the values that can fit in one |
333 | byte. The valid character codes for multibyte representation range | |
334 | from 0 to @code{#x3FFFFF}. In this code space, values 0 through | |
335 | @code{#x7F} (127) are for @acronym{ASCII} characters, and values | |
336 | @code{#x80} (128) through @code{#x3FFF7F} (4194175) are for | |
337 | non-@acronym{ASCII} characters. | |
338 | ||
339 | Emacs character codes are a superset of the Unicode standard. | |
340 | Values 0 through @code{#x10FFFF} (1114111) correspond to Unicode | |
341 | characters of the same codepoint; values @code{#x110000} (1114112) | |
342 | through @code{#x3FFF7F} (4194175) represent characters that are not | |
343 | unified with Unicode; and values @code{#x3FFF80} (4194176) through | |
344 | @code{#x3FFFFF} (4194303) represent eight-bit raw bytes. | |
ffdbc44b CY |
345 | |
346 | @defun characterp charcode | |
347 | This returns @code{t} if @var{charcode} is a valid character, and | |
348 | @code{nil} otherwise. | |
b8d4c8d0 GM |
349 | |
350 | @example | |
80070260 | 351 | @group |
ffdbc44b | 352 | (characterp 65) |
b8d4c8d0 | 353 | @result{} t |
80070260 EZ |
354 | @end group |
355 | @group | |
ffdbc44b | 356 | (characterp 4194303) |
b8d4c8d0 | 357 | @result{} t |
80070260 EZ |
358 | @end group |
359 | @group | |
ffdbc44b CY |
360 | (characterp 4194304) |
361 | @result{} nil | |
80070260 EZ |
362 | @end group |
363 | @end example | |
364 | @end defun | |
365 | ||
366 | @cindex maximum value of character codepoint | |
367 | @cindex codepoint, largest value | |
368 | @defun max-char | |
369 | This function returns the largest value that a valid character | |
370 | codepoint can have. | |
371 | ||
372 | @example | |
373 | @group | |
374 | (characterp (max-char)) | |
375 | @result{} t | |
376 | @end group | |
377 | @group | |
378 | (characterp (1+ (max-char))) | |
379 | @result{} nil | |
380 | @end group | |
b8d4c8d0 | 381 | @end example |
b8d4c8d0 GM |
382 | @end defun |
383 | ||
106e6894 | 384 | @defun get-byte &optional pos string |
97d8273f CY |
385 | This function returns the byte at character position @var{pos} in the |
386 | current buffer. If the current buffer is unibyte, this is literally | |
387 | the byte at that position. If the buffer is multibyte, byte values of | |
031c41de EZ |
388 | @acronym{ASCII} characters are the same as character codepoints, |
389 | whereas eight-bit raw bytes are converted to their 8-bit codes. The | |
390 | function signals an error if the character at @var{pos} is | |
391 | non-@acronym{ASCII}. | |
392 | ||
393 | The optional argument @var{string} means to get a byte value from that | |
394 | string instead of the current buffer. | |
395 | @end defun | |
396 | ||
91211f07 EZ |
397 | @node Character Properties |
398 | @section Character Properties | |
399 | @cindex character properties | |
400 | A @dfn{character property} is a named attribute of a character that | |
401 | specifies how the character behaves and how it should be handled | |
402 | during text processing and display. Thus, character properties are an | |
403 | important part of specifying the character's semantics. | |
404 | ||
eed99101 XF |
405 | @c FIXME: Use the latest URI of this chapter? |
406 | @c http://www.unicode.org/versions/latest/ch04.pdf | |
434843ec | 407 | On the whole, Emacs follows the Unicode Standard in its implementation |
91211f07 EZ |
408 | of character properties. In particular, Emacs supports the |
409 | @uref{http://www.unicode.org/reports/tr23/, Unicode Character Property | |
410 | Model}, and the Emacs character property database is derived from the | |
411 | Unicode Character Database (@acronym{UCD}). See the | |
a9877c32 | 412 | @uref{http://www.unicode.org/versions/Unicode6.2.0/ch04.pdf, Character |
97d8273f CY |
413 | Properties chapter of the Unicode Standard}, for a detailed |
414 | description of Unicode character properties and their meaning. This | |
415 | section assumes you are already familiar with that chapter of the | |
416 | Unicode Standard, and want to apply that knowledge to Emacs Lisp | |
417 | programs. | |
91211f07 EZ |
418 | |
419 | In Emacs, each property has a name, which is a symbol, and a set of | |
af38459f | 420 | possible values, whose types depend on the property; if a character |
c06ea95e EZ |
421 | does not have a certain property, the value is @code{nil}. As a |
422 | general rule, the names of character properties in Emacs are produced | |
423 | from the corresponding Unicode properties by downcasing them and | |
424 | replacing each @samp{_} character with a dash @samp{-}. For example, | |
425 | @code{Canonical_Combining_Class} becomes | |
426 | @code{canonical-combining-class}. However, sometimes we shorten the | |
427 | names to make their use easier. | |
428 | ||
bca633fb EZ |
429 | @cindex unassigned character codepoints |
430 | Some codepoints are left @dfn{unassigned} by the | |
431 | @acronym{UCD}---they don't correspond to any character. The Unicode | |
432 | Standard defines default values of properties for such codepoints; | |
433 | they are mentioned below for each property. | |
434 | ||
97d8273f CY |
435 | Here is the full list of value types for all the character |
436 | properties that Emacs knows about: | |
91211f07 EZ |
437 | |
438 | @table @code | |
439 | @item name | |
049bcbcb CY |
440 | Corresponds to the @code{Name} Unicode property. The value is a |
441 | string consisting of upper-case Latin letters A to Z, digits, spaces, | |
bca633fb | 442 | and hyphen @samp{-} characters. For unassigned codepoints, the value |
77e5bcc5 | 443 | is @code{nil}. |
91211f07 | 444 | |
f8848423 | 445 | @cindex unicode general category |
91211f07 | 446 | @item general-category |
049bcbcb CY |
447 | Corresponds to the @code{General_Category} Unicode property. The |
448 | value is a symbol whose name is a 2-letter abbreviation of the | |
bca633fb EZ |
449 | character's classification. For unassigned codepoints, the value |
450 | is @code{Cn}. | |
91211f07 EZ |
451 | |
452 | @item canonical-combining-class | |
049bcbcb | 453 | Corresponds to the @code{Canonical_Combining_Class} Unicode property. |
bca633fb EZ |
454 | The value is an integer number. For unassigned codepoints, the value |
455 | is zero. | |
91211f07 | 456 | |
10862873 | 457 | @cindex bidirectional class of characters |
91211f07 | 458 | @item bidi-class |
af38459f EZ |
459 | Corresponds to the Unicode @code{Bidi_Class} property. The value is a |
460 | symbol whose name is the Unicode @dfn{directional type} of the | |
c094bb0c | 461 | character. Emacs uses this property when it reorders bidirectional |
bca633fb EZ |
462 | text for display (@pxref{Bidirectional Display}). For unassigned |
463 | codepoints, the value depends on the code blocks to which the | |
464 | codepoint belongs: most unassigned codepoints get the value of | |
465 | @code{L} (strong L), but some get values of @code{AL} (Arabic letter) | |
466 | or @code{R} (strong R). | |
91211f07 EZ |
467 | |
468 | @item decomposition | |
84f4a531 CY |
469 | Corresponds to the Unicode properties @code{Decomposition_Type} and |
470 | @code{Decomposition_Value}. The value is a list, whose first element | |
471 | may be a symbol representing a compatibility formatting tag, such as | |
472 | @code{small}@footnote{The Unicode specification writes these tag names | |
473 | inside @samp{<..>} brackets, but the tag names in Emacs do not include | |
1df7defd | 474 | the brackets; e.g., Unicode specifies @samp{<small>} where Emacs uses |
84f4a531 CY |
475 | @samp{small}. }; the other elements are characters that give the |
476 | compatibility decomposition sequence of this character. For | |
477 | unassigned codepoints, the value is the character itself. | |
91211f07 EZ |
478 | |
479 | @item decimal-digit-value | |
af38459f | 480 | Corresponds to the Unicode @code{Numeric_Value} property for |
44ee2147 XF |
481 | characters whose @code{Numeric_Type} is @samp{Decimal}. The value is |
482 | an integer number. For unassigned codepoints, the value is | |
483 | @code{nil}, which means @acronym{NaN}, or ``not-a-number''. | |
91211f07 | 484 | |
bc039a3b | 485 | @item digit-value |
af38459f | 486 | Corresponds to the Unicode @code{Numeric_Value} property for |
44ee2147 XF |
487 | characters whose @code{Numeric_Type} is @samp{Digit}. The value is an |
488 | integer number. Examples of such characters include compatibility | |
af38459f | 489 | subscript and superscript digits, for which the value is the |
bca633fb EZ |
490 | corresponding number. For unassigned codepoints, the value is |
491 | @code{nil}, which means @acronym{NaN}. | |
91211f07 EZ |
492 | |
493 | @item numeric-value | |
af38459f EZ |
494 | Corresponds to the Unicode @code{Numeric_Value} property for |
495 | characters whose @code{Numeric_Type} is @samp{Numeric}. The value of | |
97d8273f | 496 | this property is an integer or a floating-point number. Examples of |
af38459f | 497 | characters that have this property include fractions, subscripts, |
91211f07 | 498 | superscripts, Roman numerals, currency numerators, and encircled |
af38459f | 499 | numbers. For example, the value of this property for the character |
bca633fb EZ |
500 | @code{U+2155} (@sc{vulgar fraction one fifth}) is @code{0.2}. For |
501 | unassigned codepoints, the value is @code{nil}, which means | |
502 | @acronym{NaN}. | |
91211f07 | 503 | |
10862873 | 504 | @cindex mirroring of characters |
91211f07 | 505 | @item mirrored |
af38459f | 506 | Corresponds to the Unicode @code{Bidi_Mirrored} property. The value |
bca633fb EZ |
507 | of this property is a symbol, either @code{Y} or @code{N}. For |
508 | unassigned codepoints, the value is @code{N}. | |
91211f07 | 509 | |
10862873 EZ |
510 | @item mirroring |
511 | Corresponds to the Unicode @code{Bidi_Mirroring_Glyph} property. The | |
512 | value of this property is a character whose glyph represents the | |
513 | mirror image of the character's glyph, or @code{nil} if there's no | |
514 | defined mirroring glyph. All the characters whose @code{mirrored} | |
515 | property is @code{N} have @code{nil} as their @code{mirroring} | |
516 | property; however, some characters whose @code{mirrored} property is | |
517 | @code{Y} also have @code{nil} for @code{mirroring}, because no | |
c094bb0c EZ |
518 | appropriate characters exist with mirrored glyphs. Emacs uses this |
519 | property to display mirror images of characters when appropriate | |
bca633fb EZ |
520 | (@pxref{Bidirectional Display}). For unassigned codepoints, the value |
521 | is @code{nil}. | |
10862873 | 522 | |
91211f07 | 523 | @item old-name |
af38459f | 524 | Corresponds to the Unicode @code{Unicode_1_Name} property. The value |
77e5bcc5 EZ |
525 | is a string. Unassigned codepoints, and characters that have no value |
526 | for this property, the value is @code{nil}. | |
91211f07 EZ |
527 | |
528 | @item iso-10646-comment | |
af38459f | 529 | Corresponds to the Unicode @code{ISO_Comment} property. The value is |
bca633fb | 530 | a string. For unassigned codepoints, the value is an empty string. |
91211f07 EZ |
531 | |
532 | @item uppercase | |
af38459f | 533 | Corresponds to the Unicode @code{Simple_Uppercase_Mapping} property. |
bca633fb EZ |
534 | The value of this property is a single character. For unassigned |
535 | codepoints, the value is @code{nil}, which means the character itself. | |
91211f07 EZ |
536 | |
537 | @item lowercase | |
af38459f | 538 | Corresponds to the Unicode @code{Simple_Lowercase_Mapping} property. |
bca633fb EZ |
539 | The value of this property is a single character. For unassigned |
540 | codepoints, the value is @code{nil}, which means the character itself. | |
91211f07 EZ |
541 | |
542 | @item titlecase | |
af38459f | 543 | Corresponds to the Unicode @code{Simple_Titlecase_Mapping} property. |
91211f07 | 544 | @dfn{Title case} is a special form of a character used when the first |
af38459f | 545 | character of a word needs to be capitalized. The value of this |
bca633fb EZ |
546 | property is a single character. For unassigned codepoints, the value |
547 | is @code{nil}, which means the character itself. | |
91211f07 EZ |
548 | @end table |
549 | ||
550 | @defun get-char-code-property char propname | |
551 | This function returns the value of @var{char}'s @var{propname} property. | |
552 | ||
412a0972 XF |
553 | @c FIXME: Use ‘?\s’ instead of ‘? ’ for the space character in the |
554 | @c first example? --xfq | |
91211f07 EZ |
555 | @example |
556 | @group | |
557 | (get-char-code-property ? 'general-category) | |
558 | @result{} Zs | |
559 | @end group | |
560 | @group | |
561 | (get-char-code-property ?1 'general-category) | |
562 | @result{} Nd | |
563 | @end group | |
564 | @group | |
049bcbcb CY |
565 | ;; subscript 4 |
566 | (get-char-code-property ?\u2084 'digit-value) | |
91211f07 EZ |
567 | @result{} 4 |
568 | @end group | |
569 | @group | |
049bcbcb CY |
570 | ;; one fifth |
571 | (get-char-code-property ?\u2155 'numeric-value) | |
bc039a3b | 572 | @result{} 0.2 |
91211f07 EZ |
573 | @end group |
574 | @group | |
049bcbcb CY |
575 | ;; Roman IV |
576 | (get-char-code-property ?\u2163 'numeric-value) | |
bc039a3b | 577 | @result{} 4 |
91211f07 EZ |
578 | @end group |
579 | @end example | |
580 | @end defun | |
581 | ||
582 | @defun char-code-property-description prop value | |
583 | This function returns the description string of property @var{prop}'s | |
584 | @var{value}, or @code{nil} if @var{value} has no description. | |
585 | ||
586 | @example | |
587 | @group | |
588 | (char-code-property-description 'general-category 'Zs) | |
589 | @result{} "Separator, Space" | |
590 | @end group | |
591 | @group | |
592 | (char-code-property-description 'general-category 'Nd) | |
593 | @result{} "Number, Decimal Digit" | |
594 | @end group | |
595 | @group | |
596 | (char-code-property-description 'numeric-value '1/5) | |
597 | @result{} nil | |
598 | @end group | |
599 | @end example | |
600 | @end defun | |
601 | ||
602 | @defun put-char-code-property char propname value | |
603 | This function stores @var{value} as the value of the property | |
604 | @var{propname} for the character @var{char}. | |
605 | @end defun | |
606 | ||
f8848423 | 607 | @defvar unicode-category-table |
91211f07 | 608 | The value of this variable is a char-table (@pxref{Char-Tables}) that |
f8848423 EZ |
609 | specifies, for each character, its Unicode @code{General_Category} |
610 | property as a symbol. | |
611 | @end defvar | |
612 | ||
613 | @defvar char-script-table | |
2194b2a4 | 614 | @cindex script symbols |
f8848423 EZ |
615 | The value of this variable is a char-table that specifies, for each |
616 | character, a symbol whose name is the script to which the character | |
617 | belongs, according to the Unicode Standard classification of the | |
618 | Unicode code space into script-specific blocks. This char-table has a | |
619 | single extra slot whose value is the list of all script symbols. | |
91211f07 EZ |
620 | @end defvar |
621 | ||
622 | @defvar char-width-table | |
623 | The value of this variable is a char-table that specifies the width of | |
624 | each character in columns that it will occupy on the screen. | |
625 | @end defvar | |
626 | ||
627 | @defvar printable-chars | |
628 | The value of this variable is a char-table that specifies, for each | |
629 | character, whether it is printable or not. That is, if evaluating | |
630 | @code{(aref printable-chars char)} results in @code{t}, the character | |
631 | is printable, and if it results in @code{nil}, it is not. | |
632 | @end defvar | |
633 | ||
b8d4c8d0 GM |
634 | @node Character Sets |
635 | @section Character Sets | |
636 | @cindex character sets | |
637 | ||
031c41de EZ |
638 | @cindex charset |
639 | @cindex coded character set | |
640 | An Emacs @dfn{character set}, or @dfn{charset}, is a set of characters | |
641 | in which each character is assigned a numeric code point. (The | |
434843ec | 642 | Unicode Standard calls this a @dfn{coded character set}.) Each Emacs |
031c41de EZ |
643 | charset has a name which is a symbol. A single character can belong |
644 | to any number of different character sets, but it will generally have | |
645 | a different code point in each charset. Examples of character sets | |
646 | include @code{ascii}, @code{iso-8859-1}, @code{greek-iso8859-7}, and | |
647 | @code{windows-1255}. The code point assigned to a character in a | |
648 | charset is usually different from its code point used in Emacs buffers | |
649 | and strings. | |
650 | ||
651 | @cindex @code{emacs}, a charset | |
652 | @cindex @code{unicode}, a charset | |
653 | @cindex @code{eight-bit}, a charset | |
654 | Emacs defines several special character sets. The character set | |
655 | @code{unicode} includes all the characters whose Emacs code points are | |
85eeac93 | 656 | in the range @code{0..#x10FFFF}. The character set @code{emacs} |
031c41de EZ |
657 | includes all @acronym{ASCII} and non-@acronym{ASCII} characters. |
658 | Finally, the @code{eight-bit} charset includes the 8-bit raw bytes; | |
659 | Emacs uses it to represent raw bytes encountered in text. | |
b8d4c8d0 GM |
660 | |
661 | @defun charsetp object | |
662 | Returns @code{t} if @var{object} is a symbol that names a character set, | |
663 | @code{nil} otherwise. | |
664 | @end defun | |
665 | ||
666 | @defvar charset-list | |
667 | The value is a list of all defined character set names. | |
668 | @end defvar | |
669 | ||
031c41de | 670 | @defun charset-priority-list &optional highestp |
73e0cbc0 | 671 | This function returns a list of all defined character sets ordered by |
031c41de EZ |
672 | their priority. If @var{highestp} is non-@code{nil}, the function |
673 | returns a single character set of the highest priority. | |
674 | @end defun | |
675 | ||
676 | @defun set-charset-priority &rest charsets | |
677 | This function makes @var{charsets} the highest priority character sets. | |
b8d4c8d0 GM |
678 | @end defun |
679 | ||
106e6894 | 680 | @defun char-charset character &optional restriction |
031c41de EZ |
681 | This function returns the name of the character set of highest |
682 | priority that @var{character} belongs to. @acronym{ASCII} characters | |
683 | are an exception: for them, this function always returns @code{ascii}. | |
106e6894 CY |
684 | |
685 | If @var{restriction} is non-@code{nil}, it should be a list of | |
686 | charsets to search. Alternatively, it can be a coding system, in | |
687 | which case the returned charset must be supported by that coding | |
688 | system (@pxref{Coding Systems}). | |
b8d4c8d0 GM |
689 | @end defun |
690 | ||
4dfa4b9b | 691 | @c TODO: Explain the properties here and add indexes such as ‘charset property’. |
b8d4c8d0 | 692 | @defun charset-plist charset |
031c41de EZ |
693 | This function returns the property list of the character set |
694 | @var{charset}. Although @var{charset} is a symbol, this is not the | |
695 | same as the property list of that symbol. Charset properties include | |
696 | important information about the charset, such as its documentation | |
697 | string, short name, etc. | |
b8d4c8d0 GM |
698 | @end defun |
699 | ||
031c41de EZ |
700 | @defun put-charset-property charset propname value |
701 | This function sets the @var{propname} property of @var{charset} to the | |
702 | given @var{value}. | |
b8d4c8d0 GM |
703 | @end defun |
704 | ||
031c41de EZ |
705 | @defun get-charset-property charset propname |
706 | This function returns the value of @var{charset}s property | |
707 | @var{propname}. | |
b8d4c8d0 GM |
708 | @end defun |
709 | ||
031c41de EZ |
710 | @deffn Command list-charset-chars charset |
711 | This command displays a list of characters in the character set | |
712 | @var{charset}. | |
713 | @end deffn | |
b8d4c8d0 | 714 | |
8b80cdf5 EZ |
715 | Emacs can convert between its internal representation of a character |
716 | and the character's codepoint in a specific charset. The following | |
717 | two functions support these conversions. | |
718 | ||
719 | @c FIXME: decode-char and encode-char accept and ignore an additional | |
720 | @c argument @var{restriction}. When that argument actually makes a | |
721 | @c difference, it should be documented here. | |
031c41de EZ |
722 | @defun decode-char charset code-point |
723 | This function decodes a character that is assigned a @var{code-point} | |
724 | in @var{charset}, to the corresponding Emacs character, and returns | |
8b80cdf5 EZ |
725 | it. If @var{charset} doesn't contain a character of that code point, |
726 | the value is @code{nil}. If @var{code-point} doesn't fit in a Lisp | |
727 | integer (@pxref{Integer Basics, most-positive-fixnum}), it can be | |
728 | specified as a cons cell @code{(@var{high} . @var{low})}, where | |
031c41de EZ |
729 | @var{low} are the lower 16 bits of the value and @var{high} are the |
730 | high 16 bits. | |
b8d4c8d0 GM |
731 | @end defun |
732 | ||
031c41de EZ |
733 | @defun encode-char char charset |
734 | This function returns the code point assigned to the character | |
8b80cdf5 EZ |
735 | @var{char} in @var{charset}. If the result does not fit in a Lisp |
736 | integer, it is returned as a cons cell @code{(@var{high} . @var{low})} | |
737 | that fits the second argument of @code{decode-char} above. If | |
738 | @var{charset} doesn't have a codepoint for @var{char}, the value is | |
739 | @code{nil}. | |
b3f1f4a5 EZ |
740 | @end defun |
741 | ||
742 | The following function comes in handy for applying a certain | |
743 | function to all or part of the characters in a charset: | |
744 | ||
85eeac93 | 745 | @defun map-charset-chars function charset &optional arg from-code to-code |
b3f1f4a5 EZ |
746 | Call @var{function} for characters in @var{charset}. @var{function} |
747 | is called with two arguments. The first one is a cons cell | |
748 | @code{(@var{from} . @var{to})}, where @var{from} and @var{to} | |
749 | indicate a range of characters contained in charset. The second | |
85eeac93 | 750 | argument passed to @var{function} is @var{arg}. |
b3f1f4a5 EZ |
751 | |
752 | By default, the range of codepoints passed to @var{function} includes | |
8c9d5f9f KH |
753 | all the characters in @var{charset}, but optional arguments |
754 | @var{from-code} and @var{to-code} limit that to the range of | |
755 | characters between these two codepoints of @var{charset}. If either | |
756 | of them is @code{nil}, it defaults to the first or last codepoint of | |
757 | @var{charset}, respectively. | |
b8d4c8d0 GM |
758 | @end defun |
759 | ||
b8d4c8d0 GM |
760 | @node Scanning Charsets |
761 | @section Scanning for Character Sets | |
762 | ||
97d8273f CY |
763 | Sometimes it is useful to find out which character set a particular |
764 | character belongs to. One use for this is in determining which coding | |
765 | systems (@pxref{Coding Systems}) are capable of representing all of | |
766 | the text in question; another is to determine the font(s) for | |
767 | displaying that text. | |
b8d4c8d0 GM |
768 | |
769 | @defun charset-after &optional pos | |
031c41de | 770 | This function returns the charset of highest priority containing the |
97d8273f | 771 | character at position @var{pos} in the current buffer. If @var{pos} |
031c41de EZ |
772 | is omitted or @code{nil}, it defaults to the current value of point. |
773 | If @var{pos} is out of range, the value is @code{nil}. | |
b8d4c8d0 GM |
774 | @end defun |
775 | ||
776 | @defun find-charset-region beg end &optional translation | |
031c41de | 777 | This function returns a list of the character sets of highest priority |
8b80cdf5 | 778 | that contain characters in the current buffer between positions |
031c41de | 779 | @var{beg} and @var{end}. |
b8d4c8d0 | 780 | |
97d8273f CY |
781 | The optional argument @var{translation} specifies a translation table |
782 | to use for scanning the text (@pxref{Translation of Characters}). If | |
783 | it is non-@code{nil}, then each character in the region is translated | |
b8d4c8d0 GM |
784 | through this table, and the value returned describes the translated |
785 | characters instead of the characters actually in the buffer. | |
786 | @end defun | |
787 | ||
788 | @defun find-charset-string string &optional translation | |
97d8273f | 789 | This function returns a list of character sets of highest priority |
031c41de EZ |
790 | that contain characters in @var{string}. It is just like |
791 | @code{find-charset-region}, except that it applies to the contents of | |
792 | @var{string} instead of part of the current buffer. | |
b8d4c8d0 GM |
793 | @end defun |
794 | ||
795 | @node Translation of Characters | |
796 | @section Translation of Characters | |
797 | @cindex character translation tables | |
798 | @cindex translation tables | |
799 | ||
031c41de EZ |
800 | A @dfn{translation table} is a char-table (@pxref{Char-Tables}) that |
801 | specifies a mapping of characters into characters. These tables are | |
802 | used in encoding and decoding, and for other purposes. Some coding | |
803 | systems specify their own particular translation tables; there are | |
804 | also default translation tables which apply to all other coding | |
805 | systems. | |
b8d4c8d0 | 806 | |
031c41de EZ |
807 | A translation table has two extra slots. The first is either |
808 | @code{nil} or a translation table that performs the reverse | |
809 | translation; the second is the maximum number of characters to look up | |
8b80cdf5 EZ |
810 | for translating sequences of characters (see the description of |
811 | @code{make-translation-table-from-alist} below). | |
b8d4c8d0 GM |
812 | |
813 | @defun make-translation-table &rest translations | |
814 | This function returns a translation table based on the argument | |
815 | @var{translations}. Each element of @var{translations} should be a | |
816 | list of elements of the form @code{(@var{from} . @var{to})}; this says | |
817 | to translate the character @var{from} into @var{to}. | |
818 | ||
819 | The arguments and the forms in each argument are processed in order, | |
820 | and if a previous form already translates @var{to} to some other | |
821 | character, say @var{to-alt}, @var{from} is also translated to | |
822 | @var{to-alt}. | |
b8d4c8d0 GM |
823 | @end defun |
824 | ||
031c41de EZ |
825 | During decoding, the translation table's translations are applied to |
826 | the characters that result from ordinary decoding. If a coding system | |
97d8273f | 827 | has the property @code{:decode-translation-table}, that specifies the |
031c41de EZ |
828 | translation table to use, or a list of translation tables to apply in |
829 | sequence. (This is a property of the coding system, as returned by | |
830 | @code{coding-system-get}, not a property of the symbol that is the | |
831 | coding system's name. @xref{Coding System Basics,, Basic Concepts of | |
832 | Coding Systems}.) Finally, if | |
833 | @code{standard-translation-table-for-decode} is non-@code{nil}, the | |
834 | resulting characters are translated by that table. | |
835 | ||
836 | During encoding, the translation table's translations are applied to | |
837 | the characters in the buffer, and the result of translation is | |
838 | actually encoded. If a coding system has property | |
839 | @code{:encode-translation-table}, that specifies the translation table | |
840 | to use, or a list of translation tables to apply in sequence. In | |
841 | addition, if the variable @code{standard-translation-table-for-encode} | |
842 | is non-@code{nil}, it specifies the translation table to use for | |
843 | translating the result. | |
b8d4c8d0 GM |
844 | |
845 | @defvar standard-translation-table-for-decode | |
031c41de EZ |
846 | This is the default translation table for decoding. If a coding |
847 | systems specifies its own translation tables, the table that is the | |
848 | value of this variable, if non-@code{nil}, is applied after them. | |
b8d4c8d0 GM |
849 | @end defvar |
850 | ||
851 | @defvar standard-translation-table-for-encode | |
031c41de EZ |
852 | This is the default translation table for encoding. If a coding |
853 | systems specifies its own translation tables, the table that is the | |
854 | value of this variable, if non-@code{nil}, is applied after them. | |
b8d4c8d0 GM |
855 | @end defvar |
856 | ||
4dfa4b9b XF |
857 | @c FIXME: This variable is obsolete since 23.1. We should mention |
858 | @c that here or simply remove this defvar. --xfq | |
5c9c5c4b EZ |
859 | @defvar translation-table-for-input |
860 | Self-inserting characters are translated through this translation | |
861 | table before they are inserted. Search commands also translate their | |
862 | input through this table, so they can compare more reliably with | |
863 | what's in the buffer. | |
864 | ||
865 | This variable automatically becomes buffer-local when set. | |
866 | @end defvar | |
867 | ||
031c41de EZ |
868 | @defun make-translation-table-from-vector vec |
869 | This function returns a translation table made from @var{vec} that is | |
85eeac93 | 870 | an array of 256 elements to map bytes (values 0 through #xFF) to |
031c41de EZ |
871 | characters. Elements may be @code{nil} for untranslated bytes. The |
872 | returned table has a translation table for reverse mapping in the | |
8b80cdf5 | 873 | first extra slot, and the value @code{1} in the second extra slot. |
031c41de EZ |
874 | |
875 | This function provides an easy way to make a private coding system | |
876 | that maps each byte to a specific character. You can specify the | |
877 | returned table and the reverse translation table using the properties | |
878 | @code{:decode-translation-table} and @code{:encode-translation-table} | |
879 | respectively in the @var{props} argument to | |
880 | @code{define-coding-system}. | |
881 | @end defun | |
882 | ||
883 | @defun make-translation-table-from-alist alist | |
884 | This function is similar to @code{make-translation-table} but returns | |
885 | a complex translation table rather than a simple one-to-one mapping. | |
886 | Each element of @var{alist} is of the form @code{(@var{from} | |
97d8273f CY |
887 | . @var{to})}, where @var{from} and @var{to} are either characters or |
888 | vectors specifying a sequence of characters. If @var{from} is a | |
1df7defd | 889 | character, that character is translated to @var{to} (i.e., to a |
031c41de EZ |
890 | character or a character sequence). If @var{from} is a vector of |
891 | characters, that sequence is translated to @var{to}. The returned | |
892 | table has a translation table for reverse mapping in the first extra | |
8b80cdf5 EZ |
893 | slot, and the maximum length of all the @var{from} character sequences |
894 | in the second extra slot. | |
031c41de EZ |
895 | @end defun |
896 | ||
b8d4c8d0 GM |
897 | @node Coding Systems |
898 | @section Coding Systems | |
899 | ||
900 | @cindex coding system | |
901 | When Emacs reads or writes a file, and when Emacs sends text to a | |
902 | subprocess or receives text from a subprocess, it normally performs | |
903 | character code conversion and end-of-line conversion as specified | |
904 | by a particular @dfn{coding system}. | |
905 | ||
906 | How to define a coding system is an arcane matter, and is not | |
907 | documented here. | |
908 | ||
909 | @menu | |
910 | * Coding System Basics:: Basic concepts. | |
911 | * Encoding and I/O:: How file I/O functions handle coding systems. | |
912 | * Lisp and Coding Systems:: Functions to operate on coding system names. | |
913 | * User-Chosen Coding Systems:: Asking the user to choose a coding system. | |
914 | * Default Coding Systems:: Controlling the default choices. | |
915 | * Specifying Coding Systems:: Requesting a particular coding system | |
916 | for a single file operation. | |
917 | * Explicit Encoding:: Encoding or decoding text without doing I/O. | |
918 | * Terminal I/O Encoding:: Use of encoding for terminal I/O. | |
b8d4c8d0 GM |
919 | @end menu |
920 | ||
921 | @node Coding System Basics | |
922 | @subsection Basic Concepts of Coding Systems | |
923 | ||
924 | @cindex character code conversion | |
80070260 EZ |
925 | @dfn{Character code conversion} involves conversion between the |
926 | internal representation of characters used inside Emacs and some other | |
927 | encoding. Emacs supports many different encodings, in that it can | |
928 | convert to and from them. For example, it can convert text to or from | |
929 | encodings such as Latin 1, Latin 2, Latin 3, Latin 4, Latin 5, and | |
930 | several variants of ISO 2022. In some cases, Emacs supports several | |
931 | alternative encodings for the same characters; for example, there are | |
932 | three coding systems for the Cyrillic (Russian) alphabet: ISO, | |
933 | Alternativnyj, and KOI8. | |
934 | ||
af38459f EZ |
935 | Every coding system specifies a particular set of character code |
936 | conversions, but the coding system @code{undecided} is special: it | |
937 | leaves the choice unspecified, to be chosen heuristically for each | |
938 | file, based on the file's data. | |
b8d4c8d0 GM |
939 | |
940 | In general, a coding system doesn't guarantee roundtrip identity: | |
941 | decoding a byte sequence using coding system, then encoding the | |
942 | resulting text in the same coding system, can produce a different byte | |
80070260 EZ |
943 | sequence. But some coding systems do guarantee that the byte sequence |
944 | will be the same as what you originally decoded. Here are a few | |
945 | examples: | |
b8d4c8d0 GM |
946 | |
947 | @quotation | |
80070260 | 948 | iso-8859-1, utf-8, big5, shift_jis, euc-jp |
b8d4c8d0 GM |
949 | @end quotation |
950 | ||
951 | Encoding buffer text and then decoding the result can also fail to | |
80070260 EZ |
952 | reproduce the original text. For instance, if you encode a character |
953 | with a coding system which does not support that character, the result | |
954 | is unpredictable, and thus decoding it using the same coding system | |
955 | may produce a different text. Currently, Emacs can't report errors | |
956 | that result from encoding unsupported characters. | |
b8d4c8d0 GM |
957 | |
958 | @cindex EOL conversion | |
959 | @cindex end-of-line conversion | |
960 | @cindex line end conversion | |
80070260 EZ |
961 | @dfn{End of line conversion} handles three different conventions |
962 | used on various systems for representing end of line in files. The | |
963 | Unix convention, used on GNU and Unix systems, is to use the linefeed | |
964 | character (also called newline). The DOS convention, used on | |
965 | MS-Windows and MS-DOS systems, is to use a carriage-return and a | |
966 | linefeed at the end of a line. The Mac convention is to use just | |
87829449 XF |
967 | carriage-return. (This was the convention used on the Macintosh |
968 | system prior to OS X.) | |
b8d4c8d0 GM |
969 | |
970 | @cindex base coding system | |
971 | @cindex variant coding system | |
972 | @dfn{Base coding systems} such as @code{latin-1} leave the end-of-line | |
973 | conversion unspecified, to be chosen based on the data. @dfn{Variant | |
974 | coding systems} such as @code{latin-1-unix}, @code{latin-1-dos} and | |
975 | @code{latin-1-mac} specify the end-of-line conversion explicitly as | |
976 | well. Most base coding systems have three corresponding variants whose | |
977 | names are formed by adding @samp{-unix}, @samp{-dos} and @samp{-mac}. | |
978 | ||
02eccf6b | 979 | @vindex raw-text@r{ coding system} |
b8d4c8d0 | 980 | The coding system @code{raw-text} is special in that it prevents |
02eccf6b EZ |
981 | character code conversion, and causes the buffer visited with this |
982 | coding system to be a unibyte buffer. For historical reasons, you can | |
983 | save both unibyte and multibyte text with this coding system. When | |
984 | you use @code{raw-text} to encode multibyte text, it does perform one | |
985 | character code conversion: it converts eight-bit characters to their | |
986 | single-byte external representation. @code{raw-text} does not specify | |
987 | the end-of-line conversion, allowing that to be determined as usual by | |
988 | the data, and has the usual three variants which specify the | |
989 | end-of-line conversion. | |
990 | ||
991 | @vindex no-conversion@r{ coding system} | |
992 | @vindex binary@r{ coding system} | |
993 | @code{no-conversion} (and its alias @code{binary}) is equivalent to | |
994 | @code{raw-text-unix}: it specifies no conversion of either character | |
995 | codes or end-of-line. | |
b8d4c8d0 | 996 | |
80070260 | 997 | @vindex emacs-internal@r{ coding system} |
97d8273f CY |
998 | @vindex utf-8-emacs@r{ coding system} |
999 | The coding system @code{utf-8-emacs} specifies that the data is | |
1000 | represented in the internal Emacs encoding (@pxref{Text | |
1001 | Representations}). This is like @code{raw-text} in that no code | |
1002 | conversion happens, but different in that the result is multibyte | |
1003 | data. The name @code{emacs-internal} is an alias for | |
1004 | @code{utf-8-emacs}. | |
b8d4c8d0 GM |
1005 | |
1006 | @defun coding-system-get coding-system property | |
1007 | This function returns the specified property of the coding system | |
1008 | @var{coding-system}. Most coding system properties exist for internal | |
80070260 | 1009 | purposes, but one that you might find useful is @code{:mime-charset}. |
b8d4c8d0 GM |
1010 | That property's value is the name used in MIME for the character coding |
1011 | which this coding system can read and write. Examples: | |
1012 | ||
1013 | @example | |
80070260 | 1014 | (coding-system-get 'iso-latin-1 :mime-charset) |
b8d4c8d0 | 1015 | @result{} iso-8859-1 |
80070260 | 1016 | (coding-system-get 'iso-2022-cn :mime-charset) |
b8d4c8d0 | 1017 | @result{} iso-2022-cn |
80070260 | 1018 | (coding-system-get 'cyrillic-koi8 :mime-charset) |
b8d4c8d0 GM |
1019 | @result{} koi8-r |
1020 | @end example | |
1021 | ||
80070260 | 1022 | The value of the @code{:mime-charset} property is also defined |
b8d4c8d0 GM |
1023 | as an alias for the coding system. |
1024 | @end defun | |
1025 | ||
9097ad86 | 1026 | @cindex alias, for coding systems |
91211f07 EZ |
1027 | @defun coding-system-aliases coding-system |
1028 | This function returns the list of aliases of @var{coding-system}. | |
1029 | @end defun | |
1030 | ||
b8d4c8d0 GM |
1031 | @node Encoding and I/O |
1032 | @subsection Encoding and I/O | |
1033 | ||
1034 | The principal purpose of coding systems is for use in reading and | |
97d8273f CY |
1035 | writing files. The function @code{insert-file-contents} uses a coding |
1036 | system to decode the file data, and @code{write-region} uses one to | |
1037 | encode the buffer contents. | |
b8d4c8d0 GM |
1038 | |
1039 | You can specify the coding system to use either explicitly | |
1040 | (@pxref{Specifying Coding Systems}), or implicitly using a default | |
1041 | mechanism (@pxref{Default Coding Systems}). But these methods may not | |
1042 | completely specify what to do. For example, they may choose a coding | |
1043 | system such as @code{undefined} which leaves the character code | |
1044 | conversion to be determined from the data. In these cases, the I/O | |
1045 | operation finishes the job of choosing a coding system. Very often | |
1046 | you will want to find out afterwards which coding system was chosen. | |
1047 | ||
1048 | @defvar buffer-file-coding-system | |
e2e3f1d7 MR |
1049 | This buffer-local variable records the coding system used for saving the |
1050 | buffer and for writing part of the buffer with @code{write-region}. If | |
1051 | the text to be written cannot be safely encoded using the coding system | |
1052 | specified by this variable, these operations select an alternative | |
1053 | encoding by calling the function @code{select-safe-coding-system} | |
1054 | (@pxref{User-Chosen Coding Systems}). If selecting a different encoding | |
1055 | requires to ask the user to specify a coding system, | |
1056 | @code{buffer-file-coding-system} is updated to the newly selected coding | |
1057 | system. | |
b8d4c8d0 GM |
1058 | |
1059 | @code{buffer-file-coding-system} does @emph{not} affect sending text | |
1060 | to a subprocess. | |
1061 | @end defvar | |
1062 | ||
1063 | @defvar save-buffer-coding-system | |
1064 | This variable specifies the coding system for saving the buffer (by | |
1065 | overriding @code{buffer-file-coding-system}). Note that it is not used | |
1066 | for @code{write-region}. | |
1067 | ||
1068 | When a command to save the buffer starts out to use | |
1069 | @code{buffer-file-coding-system} (or @code{save-buffer-coding-system}), | |
1070 | and that coding system cannot handle | |
1071 | the actual text in the buffer, the command asks the user to choose | |
1072 | another coding system (by calling @code{select-safe-coding-system}). | |
1073 | After that happens, the command also updates | |
1074 | @code{buffer-file-coding-system} to represent the coding system that | |
1075 | the user specified. | |
1076 | @end defvar | |
1077 | ||
1078 | @defvar last-coding-system-used | |
1079 | I/O operations for files and subprocesses set this variable to the | |
1080 | coding system name that was used. The explicit encoding and decoding | |
1081 | functions (@pxref{Explicit Encoding}) set it too. | |
1082 | ||
1083 | @strong{Warning:} Since receiving subprocess output sets this variable, | |
1084 | it can change whenever Emacs waits; therefore, you should copy the | |
1085 | value shortly after the function call that stores the value you are | |
1086 | interested in. | |
1087 | @end defvar | |
1088 | ||
1089 | The variable @code{selection-coding-system} specifies how to encode | |
1090 | selections for the window system. @xref{Window System Selections}. | |
1091 | ||
1092 | @defvar file-name-coding-system | |
1093 | The variable @code{file-name-coding-system} specifies the coding | |
1094 | system to use for encoding file names. Emacs encodes file names using | |
1095 | that coding system for all file operations. If | |
1096 | @code{file-name-coding-system} is @code{nil}, Emacs uses a default | |
1097 | coding system determined by the selected language environment. In the | |
1098 | default language environment, any non-@acronym{ASCII} characters in | |
1099 | file names are not encoded specially; they appear in the file system | |
1100 | using the internal Emacs representation. | |
1101 | @end defvar | |
1102 | ||
1103 | @strong{Warning:} if you change @code{file-name-coding-system} (or | |
1104 | the language environment) in the middle of an Emacs session, problems | |
1105 | can result if you have already visited files whose names were encoded | |
1106 | using the earlier coding system and are handled differently under the | |
1107 | new coding system. If you try to save one of these buffers under the | |
1108 | visited file name, saving may use the wrong file name, or it may get | |
1109 | an error. If such a problem happens, use @kbd{C-x C-w} to specify a | |
1110 | new file name for that buffer. | |
1111 | ||
7df14908 EZ |
1112 | @cindex file-name encoding, MS-Windows |
1113 | On Windows 2000 and later, Emacs by default uses Unicode APIs to | |
1114 | pass file names to the OS, so the value of | |
1115 | @code{file-name-coding-system} is largely ignored. Lisp applications | |
1116 | that need to encode or decode file names on the Lisp level should use | |
1117 | @code{utf-8} coding-system when @code{system-type} is | |
1118 | @code{windows-nt}; the conversion of UTF-8 encoded file names to the | |
1119 | encoding appropriate for communicating with the OS is performed | |
1120 | internally by Emacs. | |
1121 | ||
b8d4c8d0 GM |
1122 | @node Lisp and Coding Systems |
1123 | @subsection Coding Systems in Lisp | |
1124 | ||
1125 | Here are the Lisp facilities for working with coding systems: | |
1126 | ||
0e90e7be | 1127 | @cindex list all coding systems |
b8d4c8d0 GM |
1128 | @defun coding-system-list &optional base-only |
1129 | This function returns a list of all coding system names (symbols). If | |
1130 | @var{base-only} is non-@code{nil}, the value includes only the | |
1131 | base coding systems. Otherwise, it includes alias and variant coding | |
1132 | systems as well. | |
1133 | @end defun | |
1134 | ||
1135 | @defun coding-system-p object | |
1136 | This function returns @code{t} if @var{object} is a coding system | |
1137 | name or @code{nil}. | |
1138 | @end defun | |
1139 | ||
0e90e7be EZ |
1140 | @cindex validity of coding system |
1141 | @cindex coding system, validity check | |
b8d4c8d0 | 1142 | @defun check-coding-system coding-system |
80070260 EZ |
1143 | This function checks the validity of @var{coding-system}. If that is |
1144 | valid, it returns @var{coding-system}. If @var{coding-system} is | |
1145 | @code{nil}, the function return @code{nil}. For any other values, it | |
1146 | signals an error whose @code{error-symbol} is @code{coding-system-error} | |
1147 | (@pxref{Signaling Errors, signal}). | |
b8d4c8d0 GM |
1148 | @end defun |
1149 | ||
0e90e7be | 1150 | @cindex eol type of coding system |
b8d4c8d0 GM |
1151 | @defun coding-system-eol-type coding-system |
1152 | This function returns the type of end-of-line (a.k.a.@: @dfn{eol}) | |
1153 | conversion used by @var{coding-system}. If @var{coding-system} | |
1154 | specifies a certain eol conversion, the return value is an integer 0, | |
1155 | 1, or 2, standing for @code{unix}, @code{dos}, and @code{mac}, | |
1156 | respectively. If @var{coding-system} doesn't specify eol conversion | |
1157 | explicitly, the return value is a vector of coding systems, each one | |
1158 | with one of the possible eol conversion types, like this: | |
1159 | ||
1160 | @lisp | |
1161 | (coding-system-eol-type 'latin-1) | |
1162 | @result{} [latin-1-unix latin-1-dos latin-1-mac] | |
1163 | @end lisp | |
1164 | ||
1165 | @noindent | |
1166 | If this function returns a vector, Emacs will decide, as part of the | |
1167 | text encoding or decoding process, what eol conversion to use. For | |
1168 | decoding, the end-of-line format of the text is auto-detected, and the | |
1169 | eol conversion is set to match it (e.g., DOS-style CRLF format will | |
1170 | imply @code{dos} eol conversion). For encoding, the eol conversion is | |
1171 | taken from the appropriate default coding system (e.g., | |
4e3b4528 | 1172 | default value of @code{buffer-file-coding-system} for |
b8d4c8d0 GM |
1173 | @code{buffer-file-coding-system}), or from the default eol conversion |
1174 | appropriate for the underlying platform. | |
1175 | @end defun | |
1176 | ||
0e90e7be | 1177 | @cindex eol conversion of coding system |
b8d4c8d0 GM |
1178 | @defun coding-system-change-eol-conversion coding-system eol-type |
1179 | This function returns a coding system which is like @var{coding-system} | |
1180 | except for its eol conversion, which is specified by @code{eol-type}. | |
1181 | @var{eol-type} should be @code{unix}, @code{dos}, @code{mac}, or | |
1182 | @code{nil}. If it is @code{nil}, the returned coding system determines | |
1183 | the end-of-line conversion from the data. | |
1184 | ||
1185 | @var{eol-type} may also be 0, 1 or 2, standing for @code{unix}, | |
1186 | @code{dos} and @code{mac}, respectively. | |
1187 | @end defun | |
1188 | ||
0e90e7be | 1189 | @cindex text conversion of coding system |
b8d4c8d0 GM |
1190 | @defun coding-system-change-text-conversion eol-coding text-coding |
1191 | This function returns a coding system which uses the end-of-line | |
1192 | conversion of @var{eol-coding}, and the text conversion of | |
1193 | @var{text-coding}. If @var{text-coding} is @code{nil}, it returns | |
1194 | @code{undecided}, or one of its variants according to @var{eol-coding}. | |
1195 | @end defun | |
1196 | ||
0e90e7be EZ |
1197 | @cindex safely encode region |
1198 | @cindex coding systems for encoding region | |
b8d4c8d0 GM |
1199 | @defun find-coding-systems-region from to |
1200 | This function returns a list of coding systems that could be used to | |
1201 | encode a text between @var{from} and @var{to}. All coding systems in | |
1202 | the list can safely encode any multibyte characters in that portion of | |
1203 | the text. | |
1204 | ||
1205 | If the text contains no multibyte characters, the function returns the | |
1206 | list @code{(undecided)}. | |
1207 | @end defun | |
1208 | ||
0e90e7be EZ |
1209 | @cindex safely encode a string |
1210 | @cindex coding systems for encoding a string | |
b8d4c8d0 GM |
1211 | @defun find-coding-systems-string string |
1212 | This function returns a list of coding systems that could be used to | |
1213 | encode the text of @var{string}. All coding systems in the list can | |
1214 | safely encode any multibyte characters in @var{string}. If the text | |
1215 | contains no multibyte characters, this returns the list | |
1216 | @code{(undecided)}. | |
1217 | @end defun | |
1218 | ||
0e90e7be EZ |
1219 | @cindex charset, coding systems to encode |
1220 | @cindex safely encode characters in a charset | |
b8d4c8d0 GM |
1221 | @defun find-coding-systems-for-charsets charsets |
1222 | This function returns a list of coding systems that could be used to | |
1223 | encode all the character sets in the list @var{charsets}. | |
1224 | @end defun | |
1225 | ||
91211f07 EZ |
1226 | @defun check-coding-systems-region start end coding-system-list |
1227 | This function checks whether coding systems in the list | |
1228 | @code{coding-system-list} can encode all the characters in the region | |
1229 | between @var{start} and @var{end}. If all of the coding systems in | |
1230 | the list can encode the specified text, the function returns | |
1231 | @code{nil}. If some coding systems cannot encode some of the | |
1232 | characters, the value is an alist, each element of which has the form | |
1233 | @code{(@var{coding-system1} @var{pos1} @var{pos2} @dots{})}, meaning | |
1234 | that @var{coding-system1} cannot encode characters at buffer positions | |
1235 | @var{pos1}, @var{pos2}, @enddots{}. | |
1236 | ||
1237 | @var{start} may be a string, in which case @var{end} is ignored and | |
1238 | the returned value references string indices instead of buffer | |
1239 | positions. | |
1240 | @end defun | |
1241 | ||
b8d4c8d0 GM |
1242 | @defun detect-coding-region start end &optional highest |
1243 | This function chooses a plausible coding system for decoding the text | |
80070260 | 1244 | from @var{start} to @var{end}. This text should be a byte sequence, |
1df7defd | 1245 | i.e., unibyte text or multibyte text with only @acronym{ASCII} and |
80070260 | 1246 | eight-bit characters (@pxref{Explicit Encoding}). |
b8d4c8d0 GM |
1247 | |
1248 | Normally this function returns a list of coding systems that could | |
1249 | handle decoding the text that was scanned. They are listed in order of | |
1250 | decreasing priority. But if @var{highest} is non-@code{nil}, then the | |
1251 | return value is just one coding system, the one that is highest in | |
1252 | priority. | |
1253 | ||
1254 | If the region contains only @acronym{ASCII} characters except for such | |
1255 | ISO-2022 control characters ISO-2022 as @code{ESC}, the value is | |
1256 | @code{undecided} or @code{(undecided)}, or a variant specifying | |
1257 | end-of-line conversion, if that can be deduced from the text. | |
0b4faef3 EZ |
1258 | |
1259 | If the region contains null bytes, the value is @code{no-conversion}, | |
1260 | even if the region contains text encoded in some coding system. | |
b8d4c8d0 GM |
1261 | @end defun |
1262 | ||
1263 | @defun detect-coding-string string &optional highest | |
1264 | This function is like @code{detect-coding-region} except that it | |
1265 | operates on the contents of @var{string} instead of bytes in the buffer. | |
91211f07 EZ |
1266 | @end defun |
1267 | ||
0e90e7be | 1268 | @cindex null bytes, and decoding text |
0b4faef3 EZ |
1269 | @defvar inhibit-null-byte-detection |
1270 | If this variable has a non-@code{nil} value, null bytes are ignored | |
1271 | when detecting the encoding of a region or a string. This allows to | |
1272 | correctly detect the encoding of text that contains null bytes, such | |
1273 | as Info files with Index nodes. | |
1274 | @end defvar | |
1275 | ||
1276 | @defvar inhibit-iso-escape-detection | |
1277 | If this variable has a non-@code{nil} value, ISO-2022 escape sequences | |
1278 | are ignored when detecting the encoding of a region or a string. The | |
1279 | result is that no text is ever detected as encoded in some ISO-2022 | |
1280 | encoding, and all escape sequences become visible in a buffer. | |
1281 | @strong{Warning:} @emph{Use this variable with extreme caution, | |
1282 | because many files in the Emacs distribution use ISO-2022 encoding.} | |
1283 | @end defvar | |
1284 | ||
0e90e7be | 1285 | @cindex charsets supported by a coding system |
91211f07 EZ |
1286 | @defun coding-system-charset-list coding-system |
1287 | This function returns the list of character sets (@pxref{Character | |
1288 | Sets}) supported by @var{coding-system}. Some coding systems that | |
1289 | support too many character sets to list them all yield special values: | |
1290 | @itemize @bullet | |
1291 | @item | |
91211f07 EZ |
1292 | If @var{coding-system} supports all Emacs characters, the value is |
1293 | @code{(emacs)}. | |
1294 | @item | |
91211f07 EZ |
1295 | If @var{coding-system} supports all Unicode characters, the value is |
1296 | @code{(unicode)}. | |
c9352587 CY |
1297 | @item |
1298 | If @var{coding-system} supports all ISO-2022 charsets, the value is | |
1299 | @code{iso-2022}. | |
1300 | @item | |
1301 | If @var{coding-system} supports all the characters in the internal | |
1302 | coding system used by Emacs version 21 (prior to the implementation of | |
1303 | internal Unicode support), the value is @code{emacs-mule}. | |
91211f07 | 1304 | @end itemize |
b8d4c8d0 GM |
1305 | @end defun |
1306 | ||
1307 | @xref{Coding systems for a subprocess,, Process Information}, in | |
1308 | particular the description of the functions | |
1309 | @code{process-coding-system} and @code{set-process-coding-system}, for | |
1310 | how to examine or set the coding systems used for I/O to a subprocess. | |
1311 | ||
1312 | @node User-Chosen Coding Systems | |
1313 | @subsection User-Chosen Coding Systems | |
1314 | ||
1315 | @cindex select safe coding system | |
1316 | @defun select-safe-coding-system from to &optional default-coding-system accept-default-p file | |
1317 | This function selects a coding system for encoding specified text, | |
1318 | asking the user to choose if necessary. Normally the specified text | |
1319 | is the text in the current buffer between @var{from} and @var{to}. If | |
1320 | @var{from} is a string, the string specifies the text to encode, and | |
1321 | @var{to} is ignored. | |
1322 | ||
77730170 EZ |
1323 | If the specified text includes raw bytes (@pxref{Text |
1324 | Representations}), @code{select-safe-coding-system} suggests | |
1325 | @code{raw-text} for its encoding. | |
1326 | ||
b8d4c8d0 GM |
1327 | If @var{default-coding-system} is non-@code{nil}, that is the first |
1328 | coding system to try; if that can handle the text, | |
1329 | @code{select-safe-coding-system} returns that coding system. It can | |
1330 | also be a list of coding systems; then the function tries each of them | |
1331 | one by one. After trying all of them, it next tries the current | |
1332 | buffer's value of @code{buffer-file-coding-system} (if it is not | |
4e3b4528 SM |
1333 | @code{undecided}), then the default value of |
1334 | @code{buffer-file-coding-system} and finally the user's most | |
b8d4c8d0 GM |
1335 | preferred coding system, which the user can set using the command |
1336 | @code{prefer-coding-system} (@pxref{Recognize Coding,, Recognizing | |
1337 | Coding Systems, emacs, The GNU Emacs Manual}). | |
1338 | ||
1339 | If one of those coding systems can safely encode all the specified | |
1340 | text, @code{select-safe-coding-system} chooses it and returns it. | |
1341 | Otherwise, it asks the user to choose from a list of coding systems | |
1342 | which can encode all the text, and returns the user's choice. | |
1343 | ||
1344 | @var{default-coding-system} can also be a list whose first element is | |
1345 | t and whose other elements are coding systems. Then, if no coding | |
1346 | system in the list can handle the text, @code{select-safe-coding-system} | |
1347 | queries the user immediately, without trying any of the three | |
1348 | alternatives described above. | |
1349 | ||
1350 | The optional argument @var{accept-default-p}, if non-@code{nil}, | |
1351 | should be a function to determine whether a coding system selected | |
1352 | without user interaction is acceptable. @code{select-safe-coding-system} | |
1353 | calls this function with one argument, the base coding system of the | |
1354 | selected coding system. If @var{accept-default-p} returns @code{nil}, | |
1355 | @code{select-safe-coding-system} rejects the silently selected coding | |
1356 | system, and asks the user to select a coding system from a list of | |
1357 | possible candidates. | |
1358 | ||
1359 | @vindex select-safe-coding-system-accept-default-p | |
1360 | If the variable @code{select-safe-coding-system-accept-default-p} is | |
9bd79893 GM |
1361 | non-@code{nil}, it should be a function taking a single argument. |
1362 | It is used in place of @var{accept-default-p}, overriding any | |
1363 | value supplied for this argument. | |
b8d4c8d0 GM |
1364 | |
1365 | As a final step, before returning the chosen coding system, | |
1366 | @code{select-safe-coding-system} checks whether that coding system is | |
1367 | consistent with what would be selected if the contents of the region | |
1368 | were read from a file. (If not, this could lead to data corruption in | |
1369 | a file subsequently re-visited and edited.) Normally, | |
1370 | @code{select-safe-coding-system} uses @code{buffer-file-name} as the | |
1371 | file for this purpose, but if @var{file} is non-@code{nil}, it uses | |
1372 | that file instead (this can be relevant for @code{write-region} and | |
1373 | similar functions). If it detects an apparent inconsistency, | |
1374 | @code{select-safe-coding-system} queries the user before selecting the | |
1375 | coding system. | |
1376 | @end defun | |
1377 | ||
1378 | Here are two functions you can use to let the user specify a coding | |
1379 | system, with completion. @xref{Completion}. | |
1380 | ||
1381 | @defun read-coding-system prompt &optional default | |
1382 | This function reads a coding system using the minibuffer, prompting with | |
1383 | string @var{prompt}, and returns the coding system name as a symbol. If | |
1384 | the user enters null input, @var{default} specifies which coding system | |
1385 | to return. It should be a symbol or a string. | |
1386 | @end defun | |
1387 | ||
1388 | @defun read-non-nil-coding-system prompt | |
1389 | This function reads a coding system using the minibuffer, prompting with | |
1390 | string @var{prompt}, and returns the coding system name as a symbol. If | |
1391 | the user tries to enter null input, it asks the user to try again. | |
1392 | @xref{Coding Systems}. | |
1393 | @end defun | |
1394 | ||
1395 | @node Default Coding Systems | |
1396 | @subsection Default Coding Systems | |
0e90e7be EZ |
1397 | @cindex default coding system |
1398 | @cindex coding system, automatically determined | |
b8d4c8d0 GM |
1399 | |
1400 | This section describes variables that specify the default coding | |
1401 | system for certain files or when running certain subprograms, and the | |
1402 | function that I/O operations use to access them. | |
1403 | ||
1404 | The idea of these variables is that you set them once and for all to the | |
1405 | defaults you want, and then do not change them again. To specify a | |
1406 | particular coding system for a particular operation in a Lisp program, | |
1407 | don't change these variables; instead, override them using | |
1408 | @code{coding-system-for-read} and @code{coding-system-for-write} | |
1409 | (@pxref{Specifying Coding Systems}). | |
1410 | ||
0e90e7be | 1411 | @cindex file contents, and default coding system |
01f17ae2 | 1412 | @defopt auto-coding-regexp-alist |
b8d4c8d0 GM |
1413 | This variable is an alist of text patterns and corresponding coding |
1414 | systems. Each element has the form @code{(@var{regexp} | |
1415 | . @var{coding-system})}; a file whose first few kilobytes match | |
1416 | @var{regexp} is decoded with @var{coding-system} when its contents are | |
1417 | read into a buffer. The settings in this alist take priority over | |
1418 | @code{coding:} tags in the files and the contents of | |
1419 | @code{file-coding-system-alist} (see below). The default value is set | |
1420 | so that Emacs automatically recognizes mail files in Babyl format and | |
1421 | reads them with no code conversions. | |
01f17ae2 | 1422 | @end defopt |
b8d4c8d0 | 1423 | |
0e90e7be | 1424 | @cindex file name, and default coding system |
01f17ae2 | 1425 | @defopt file-coding-system-alist |
b8d4c8d0 GM |
1426 | This variable is an alist that specifies the coding systems to use for |
1427 | reading and writing particular files. Each element has the form | |
1428 | @code{(@var{pattern} . @var{coding})}, where @var{pattern} is a regular | |
1429 | expression that matches certain file names. The element applies to file | |
1430 | names that match @var{pattern}. | |
1431 | ||
1432 | The @sc{cdr} of the element, @var{coding}, should be either a coding | |
1433 | system, a cons cell containing two coding systems, or a function name (a | |
1434 | symbol with a function definition). If @var{coding} is a coding system, | |
1435 | that coding system is used for both reading the file and writing it. If | |
1436 | @var{coding} is a cons cell containing two coding systems, its @sc{car} | |
1437 | specifies the coding system for decoding, and its @sc{cdr} specifies the | |
1438 | coding system for encoding. | |
1439 | ||
1440 | If @var{coding} is a function name, the function should take one | |
1441 | argument, a list of all arguments passed to | |
1442 | @code{find-operation-coding-system}. It must return a coding system | |
1443 | or a cons cell containing two coding systems. This value has the same | |
1444 | meaning as described above. | |
1445 | ||
1446 | If @var{coding} (or what returned by the above function) is | |
1447 | @code{undecided}, the normal code-detection is performed. | |
01f17ae2 | 1448 | @end defopt |
b8d4c8d0 | 1449 | |
01f17ae2 | 1450 | @defopt auto-coding-alist |
0e90e7be EZ |
1451 | This variable is an alist that specifies the coding systems to use for |
1452 | reading and writing particular files. Its form is like that of | |
1453 | @code{file-coding-system-alist}, but, unlike the latter, this variable | |
1454 | takes priority over any @code{coding:} tags in the file. | |
01f17ae2 | 1455 | @end defopt |
0e90e7be EZ |
1456 | |
1457 | @cindex program name, and default coding system | |
b8d4c8d0 GM |
1458 | @defvar process-coding-system-alist |
1459 | This variable is an alist specifying which coding systems to use for a | |
1460 | subprocess, depending on which program is running in the subprocess. It | |
1461 | works like @code{file-coding-system-alist}, except that @var{pattern} is | |
1462 | matched against the program name used to start the subprocess. The coding | |
1463 | system or systems specified in this alist are used to initialize the | |
1464 | coding systems used for I/O to the subprocess, but you can specify | |
1465 | other coding systems later using @code{set-process-coding-system}. | |
1466 | @end defvar | |
1467 | ||
1468 | @strong{Warning:} Coding systems such as @code{undecided}, which | |
1469 | determine the coding system from the data, do not work entirely reliably | |
1470 | with asynchronous subprocess output. This is because Emacs handles | |
1471 | asynchronous subprocess output in batches, as it arrives. If the coding | |
1472 | system leaves the character code conversion unspecified, or leaves the | |
1473 | end-of-line conversion unspecified, Emacs must try to detect the proper | |
1474 | conversion from one batch at a time, and this does not always work. | |
1475 | ||
1476 | Therefore, with an asynchronous subprocess, if at all possible, use a | |
1477 | coding system which determines both the character code conversion and | |
1478 | the end of line conversion---that is, one like @code{latin-1-unix}, | |
1479 | rather than @code{undecided} or @code{latin-1}. | |
1480 | ||
0e90e7be EZ |
1481 | @cindex port number, and default coding system |
1482 | @cindex network service name, and default coding system | |
b8d4c8d0 GM |
1483 | @defvar network-coding-system-alist |
1484 | This variable is an alist that specifies the coding system to use for | |
1485 | network streams. It works much like @code{file-coding-system-alist}, | |
1486 | with the difference that the @var{pattern} in an element may be either a | |
1487 | port number or a regular expression. If it is a regular expression, it | |
1488 | is matched against the network service name used to open the network | |
1489 | stream. | |
1490 | @end defvar | |
1491 | ||
1492 | @defvar default-process-coding-system | |
1493 | This variable specifies the coding systems to use for subprocess (and | |
1494 | network stream) input and output, when nothing else specifies what to | |
1495 | do. | |
1496 | ||
1497 | The value should be a cons cell of the form @code{(@var{input-coding} | |
1498 | . @var{output-coding})}. Here @var{input-coding} applies to input from | |
1499 | the subprocess, and @var{output-coding} applies to output to it. | |
1500 | @end defvar | |
1501 | ||
0e90e7be | 1502 | @cindex default coding system, functions to determine |
01f17ae2 | 1503 | @defopt auto-coding-functions |
b8d4c8d0 GM |
1504 | This variable holds a list of functions that try to determine a |
1505 | coding system for a file based on its undecoded contents. | |
1506 | ||
1507 | Each function in this list should be written to look at text in the | |
1508 | current buffer, but should not modify it in any way. The buffer will | |
1509 | contain undecoded text of parts of the file. Each function should | |
1510 | take one argument, @var{size}, which tells it how many characters to | |
1511 | look at, starting from point. If the function succeeds in determining | |
1512 | a coding system for the file, it should return that coding system. | |
1513 | Otherwise, it should return @code{nil}. | |
1514 | ||
1515 | If a file has a @samp{coding:} tag, that takes precedence, so these | |
1516 | functions won't be called. | |
01f17ae2 | 1517 | @end defopt |
b8d4c8d0 | 1518 | |
0e90e7be EZ |
1519 | @defun find-auto-coding filename size |
1520 | This function tries to determine a suitable coding system for | |
1521 | @var{filename}. It examines the buffer visiting the named file, using | |
1522 | the variables documented above in sequence, until it finds a match for | |
1523 | one of the rules specified by these variables. It then returns a cons | |
1524 | cell of the form @code{(@var{coding} . @var{source})}, where | |
1525 | @var{coding} is the coding system to use and @var{source} is a symbol, | |
1526 | one of @code{auto-coding-alist}, @code{auto-coding-regexp-alist}, | |
1527 | @code{:coding}, or @code{auto-coding-functions}, indicating which one | |
1528 | supplied the matching rule. The value @code{:coding} means the coding | |
1529 | system was specified by the @code{coding:} tag in the file | |
1530 | (@pxref{Specify Coding,, coding tag, emacs, The GNU Emacs Manual}). | |
1531 | The order of looking for a matching rule is @code{auto-coding-alist} | |
1532 | first, then @code{auto-coding-regexp-alist}, then the @code{coding:} | |
1533 | tag, and lastly @code{auto-coding-functions}. If no matching rule was | |
1534 | found, the function returns @code{nil}. | |
1535 | ||
1536 | The second argument @var{size} is the size of text, in characters, | |
1537 | following point. The function examines text only within @var{size} | |
1538 | characters after point. Normally, the buffer should be positioned at | |
1539 | the beginning when this function is called, because one of the places | |
1540 | for the @code{coding:} tag is the first one or two lines of the file; | |
1541 | in that case, @var{size} should be the size of the buffer. | |
1542 | @end defun | |
1543 | ||
1544 | @defun set-auto-coding filename size | |
1545 | This function returns a suitable coding system for file | |
1546 | @var{filename}. It uses @code{find-auto-coding} to find the coding | |
1547 | system. If no coding system could be determined, the function returns | |
1548 | @code{nil}. The meaning of the argument @var{size} is like in | |
1549 | @code{find-auto-coding}. | |
1550 | @end defun | |
1551 | ||
b8d4c8d0 GM |
1552 | @defun find-operation-coding-system operation &rest arguments |
1553 | This function returns the coding system to use (by default) for | |
1554 | performing @var{operation} with @var{arguments}. The value has this | |
1555 | form: | |
1556 | ||
1557 | @example | |
1558 | (@var{decoding-system} . @var{encoding-system}) | |
1559 | @end example | |
1560 | ||
1561 | The first element, @var{decoding-system}, is the coding system to use | |
1562 | for decoding (in case @var{operation} does decoding), and | |
1563 | @var{encoding-system} is the coding system for encoding (in case | |
1564 | @var{operation} does encoding). | |
1565 | ||
049bcbcb CY |
1566 | The argument @var{operation} is a symbol; it should be one of |
1567 | @code{write-region}, @code{start-process}, @code{call-process}, | |
1568 | @code{call-process-region}, @code{insert-file-contents}, or | |
1569 | @code{open-network-stream}. These are the names of the Emacs I/O | |
1570 | primitives that can do character code and eol conversion. | |
b8d4c8d0 GM |
1571 | |
1572 | The remaining arguments should be the same arguments that might be given | |
1573 | to the corresponding I/O primitive. Depending on the primitive, one | |
1574 | of those arguments is selected as the @dfn{target}. For example, if | |
1575 | @var{operation} does file I/O, whichever argument specifies the file | |
1576 | name is the target. For subprocess primitives, the process name is the | |
1577 | target. For @code{open-network-stream}, the target is the service name | |
1578 | or port number. | |
1579 | ||
1580 | Depending on @var{operation}, this function looks up the target in | |
1581 | @code{file-coding-system-alist}, @code{process-coding-system-alist}, | |
1582 | or @code{network-coding-system-alist}. If the target is found in the | |
1583 | alist, @code{find-operation-coding-system} returns its association in | |
1584 | the alist; otherwise it returns @code{nil}. | |
1585 | ||
1586 | If @var{operation} is @code{insert-file-contents}, the argument | |
1587 | corresponding to the target may be a cons cell of the form | |
69b3debc | 1588 | @code{(@var{filename} . @var{buffer})}. In that case, @var{filename} |
b8d4c8d0 GM |
1589 | is a file name to look up in @code{file-coding-system-alist}, and |
1590 | @var{buffer} is a buffer that contains the file's contents (not yet | |
1591 | decoded). If @code{file-coding-system-alist} specifies a function to | |
1592 | call for this file, and that function needs to examine the file's | |
1593 | contents (as it usually does), it should examine the contents of | |
1594 | @var{buffer} instead of reading the file. | |
1595 | @end defun | |
1596 | ||
1597 | @node Specifying Coding Systems | |
1598 | @subsection Specifying a Coding System for One Operation | |
1599 | ||
1600 | You can specify the coding system for a specific operation by binding | |
1601 | the variables @code{coding-system-for-read} and/or | |
1602 | @code{coding-system-for-write}. | |
1603 | ||
1604 | @defvar coding-system-for-read | |
1605 | If this variable is non-@code{nil}, it specifies the coding system to | |
1606 | use for reading a file, or for input from a synchronous subprocess. | |
1607 | ||
1608 | It also applies to any asynchronous subprocess or network stream, but in | |
1609 | a different way: the value of @code{coding-system-for-read} when you | |
1610 | start the subprocess or open the network stream specifies the input | |
1611 | decoding method for that subprocess or network stream. It remains in | |
1612 | use for that subprocess or network stream unless and until overridden. | |
1613 | ||
1614 | The right way to use this variable is to bind it with @code{let} for a | |
1615 | specific I/O operation. Its global value is normally @code{nil}, and | |
1616 | you should not globally set it to any other value. Here is an example | |
1617 | of the right way to use the variable: | |
1618 | ||
1619 | @example | |
1620 | ;; @r{Read the file with no character code conversion.} | |
c9352587 | 1621 | (let ((coding-system-for-read 'no-conversion)) |
b8d4c8d0 GM |
1622 | (insert-file-contents filename)) |
1623 | @end example | |
1624 | ||
1625 | When its value is non-@code{nil}, this variable takes precedence over | |
1626 | all other methods of specifying a coding system to use for input, | |
1627 | including @code{file-coding-system-alist}, | |
1628 | @code{process-coding-system-alist} and | |
1629 | @code{network-coding-system-alist}. | |
1630 | @end defvar | |
1631 | ||
1632 | @defvar coding-system-for-write | |
1633 | This works much like @code{coding-system-for-read}, except that it | |
1634 | applies to output rather than input. It affects writing to files, | |
1635 | as well as sending output to subprocesses and net connections. | |
1636 | ||
1637 | When a single operation does both input and output, as do | |
1638 | @code{call-process-region} and @code{start-process}, both | |
1639 | @code{coding-system-for-read} and @code{coding-system-for-write} | |
1640 | affect it. | |
1641 | @end defvar | |
1642 | ||
01f17ae2 | 1643 | @defopt inhibit-eol-conversion |
b8d4c8d0 GM |
1644 | When this variable is non-@code{nil}, no end-of-line conversion is done, |
1645 | no matter which coding system is specified. This applies to all the | |
1646 | Emacs I/O and subprocess primitives, and to the explicit encoding and | |
1647 | decoding functions (@pxref{Explicit Encoding}). | |
01f17ae2 | 1648 | @end defopt |
b8d4c8d0 | 1649 | |
91211f07 EZ |
1650 | @cindex priority order of coding systems |
1651 | @cindex coding systems, priority | |
1652 | Sometimes, you need to prefer several coding systems for some | |
1653 | operation, rather than fix a single one. Emacs lets you specify a | |
1654 | priority order for using coding systems. This ordering affects the | |
333f9019 | 1655 | sorting of lists of coding systems returned by functions such as |
91211f07 EZ |
1656 | @code{find-coding-systems-region} (@pxref{Lisp and Coding Systems}). |
1657 | ||
1658 | @defun coding-system-priority-list &optional highestp | |
1659 | This function returns the list of coding systems in the order of their | |
1660 | current priorities. Optional argument @var{highestp}, if | |
1661 | non-@code{nil}, means return only the highest priority coding system. | |
1662 | @end defun | |
1663 | ||
1664 | @defun set-coding-system-priority &rest coding-systems | |
1665 | This function puts @var{coding-systems} at the beginning of the | |
1666 | priority list for coding systems, thus making their priority higher | |
1667 | than all the rest. | |
1668 | @end defun | |
1669 | ||
1670 | @defmac with-coding-priority coding-systems &rest body@dots{} | |
1671 | This macro execute @var{body}, like @code{progn} does | |
1672 | (@pxref{Sequencing, progn}), with @var{coding-systems} at the front of | |
1673 | the priority list for coding systems. @var{coding-systems} should be | |
1674 | a list of coding systems to prefer during execution of @var{body}. | |
1675 | @end defmac | |
1676 | ||
b8d4c8d0 GM |
1677 | @node Explicit Encoding |
1678 | @subsection Explicit Encoding and Decoding | |
1679 | @cindex encoding in coding systems | |
1680 | @cindex decoding in coding systems | |
1681 | ||
1682 | All the operations that transfer text in and out of Emacs have the | |
1683 | ability to use a coding system to encode or decode the text. | |
1684 | You can also explicitly encode and decode text using the functions | |
1685 | in this section. | |
1686 | ||
1687 | The result of encoding, and the input to decoding, are not ordinary | |
1688 | text. They logically consist of a series of byte values; that is, a | |
80070260 EZ |
1689 | series of @acronym{ASCII} and eight-bit characters. In unibyte |
1690 | buffers and strings, these characters have codes in the range 0 | |
85eeac93 CY |
1691 | through #xFF (255). In a multibyte buffer or string, eight-bit |
1692 | characters have character codes higher than #xFF (@pxref{Text | |
1693 | Representations}), but Emacs transparently converts them to their | |
1694 | single-byte values when you encode or decode such text. | |
b8d4c8d0 GM |
1695 | |
1696 | The usual way to read a file into a buffer as a sequence of bytes, so | |
1697 | you can decode the contents explicitly, is with | |
1698 | @code{insert-file-contents-literally} (@pxref{Reading from Files}); | |
1699 | alternatively, specify a non-@code{nil} @var{rawfile} argument when | |
1700 | visiting a file with @code{find-file-noselect}. These methods result in | |
1701 | a unibyte buffer. | |
1702 | ||
1703 | The usual way to use the byte sequence that results from explicitly | |
1704 | encoding text is to copy it to a file or process---for example, to write | |
1705 | it with @code{write-region} (@pxref{Writing to Files}), and suppress | |
1706 | encoding by binding @code{coding-system-for-write} to | |
1707 | @code{no-conversion}. | |
1708 | ||
1709 | Here are the functions to perform explicit encoding or decoding. The | |
1710 | encoding functions produce sequences of bytes; the decoding functions | |
1711 | are meant to operate on sequences of bytes. All of these functions | |
80070260 EZ |
1712 | discard text properties. They also set @code{last-coding-system-used} |
1713 | to the precise coding system they used. | |
b8d4c8d0 | 1714 | |
80070260 | 1715 | @deffn Command encode-coding-region start end coding-system &optional destination |
b8d4c8d0 | 1716 | This command encodes the text from @var{start} to @var{end} according |
80070260 EZ |
1717 | to coding system @var{coding-system}. Normally, the encoded text |
1718 | replaces the original text in the buffer, but the optional argument | |
1719 | @var{destination} can change that. If @var{destination} is a buffer, | |
1720 | the encoded text is inserted in that buffer after point (point does | |
1721 | not move); if it is @code{t}, the command returns the encoded text as | |
1722 | a unibyte string without inserting it. | |
1723 | ||
1724 | If encoded text is inserted in some buffer, this command returns the | |
1725 | length of the encoded text. | |
1726 | ||
1727 | The result of encoding is logically a sequence of bytes, but the | |
1728 | buffer remains multibyte if it was multibyte before, and any 8-bit | |
1729 | bytes are converted to their multibyte representation (@pxref{Text | |
1730 | Representations}). | |
77730170 EZ |
1731 | |
1732 | @cindex @code{undecided} coding-system, when encoding | |
1733 | Do @emph{not} use @code{undecided} for @var{coding-system} when | |
1734 | encoding text, since that may lead to unexpected results. Instead, | |
1735 | use @code{select-safe-coding-system} (@pxref{User-Chosen Coding | |
1736 | Systems, select-safe-coding-system}) to suggest a suitable encoding, | |
1737 | if there's no obvious pertinent value for @var{coding-system}. | |
b8d4c8d0 GM |
1738 | @end deffn |
1739 | ||
80070260 | 1740 | @defun encode-coding-string string coding-system &optional nocopy buffer |
b8d4c8d0 GM |
1741 | This function encodes the text in @var{string} according to coding |
1742 | system @var{coding-system}. It returns a new string containing the | |
1743 | encoded text, except when @var{nocopy} is non-@code{nil}, in which | |
1744 | case the function may return @var{string} itself if the encoding | |
1745 | operation is trivial. The result of encoding is a unibyte string. | |
1746 | @end defun | |
1747 | ||
106e6894 | 1748 | @deffn Command decode-coding-region start end coding-system &optional destination |
b8d4c8d0 | 1749 | This command decodes the text from @var{start} to @var{end} according |
80070260 EZ |
1750 | to coding system @var{coding-system}. To make explicit decoding |
1751 | useful, the text before decoding ought to be a sequence of byte | |
1752 | values, but both multibyte and unibyte buffers are acceptable (in the | |
1753 | multibyte case, the raw byte values should be represented as eight-bit | |
1754 | characters). Normally, the decoded text replaces the original text in | |
1755 | the buffer, but the optional argument @var{destination} can change | |
1756 | that. If @var{destination} is a buffer, the decoded text is inserted | |
1757 | in that buffer after point (point does not move); if it is @code{t}, | |
1758 | the command returns the decoded text as a multibyte string without | |
1759 | inserting it. | |
1760 | ||
1761 | If decoded text is inserted in some buffer, this command returns the | |
1762 | length of the decoded text. | |
7d2a859f EZ |
1763 | |
1764 | This command puts a @code{charset} text property on the decoded text. | |
1765 | The value of the property states the character set used to decode the | |
1766 | original text. | |
b8d4c8d0 GM |
1767 | @end deffn |
1768 | ||
80070260 EZ |
1769 | @defun decode-coding-string string coding-system &optional nocopy buffer |
1770 | This function decodes the text in @var{string} according to | |
1771 | @var{coding-system}. It returns a new string containing the decoded | |
1772 | text, except when @var{nocopy} is non-@code{nil}, in which case the | |
1773 | function may return @var{string} itself if the decoding operation is | |
1774 | trivial. To make explicit decoding useful, the contents of | |
1775 | @var{string} ought to be a unibyte string with a sequence of byte | |
1776 | values, but a multibyte string is also acceptable (assuming it | |
1777 | contains 8-bit bytes in their multibyte form). | |
1778 | ||
1779 | If optional argument @var{buffer} specifies a buffer, the decoded text | |
1780 | is inserted in that buffer after point (point does not move). In this | |
1781 | case, the return value is the length of the decoded text. | |
7d2a859f EZ |
1782 | |
1783 | @cindex @code{charset}, text property | |
1784 | This function puts a @code{charset} text property on the decoded text. | |
1785 | The value of the property states the character set used to decode the | |
1786 | original text: | |
1787 | ||
1788 | @example | |
1789 | @group | |
1790 | (decode-coding-string "Gr\374ss Gott" 'latin-1) | |
1791 | @result{} #("Gr@"uss Gott" 0 9 (charset iso-8859-1)) | |
1792 | @end group | |
1793 | @end example | |
b8d4c8d0 GM |
1794 | @end defun |
1795 | ||
1796 | @defun decode-coding-inserted-region from to filename &optional visit beg end replace | |
1797 | This function decodes the text from @var{from} to @var{to} as if | |
1798 | it were being read from file @var{filename} using @code{insert-file-contents} | |
1799 | using the rest of the arguments provided. | |
1800 | ||
1801 | The normal way to use this function is after reading text from a file | |
1802 | without decoding, if you decide you would rather have decoded it. | |
1803 | Instead of deleting the text and reading it again, this time with | |
1804 | decoding, you can call this function. | |
1805 | @end defun | |
1806 | ||
1807 | @node Terminal I/O Encoding | |
1808 | @subsection Terminal I/O Encoding | |
1809 | ||
1810 | Emacs can decode keyboard input using a coding system, and encode | |
80070260 EZ |
1811 | terminal output. This is useful for terminals that transmit or |
1812 | display text using a particular encoding such as Latin-1. Emacs does | |
1813 | not set @code{last-coding-system-used} for encoding or decoding of | |
1814 | terminal I/O. | |
b8d4c8d0 | 1815 | |
3f1d322f | 1816 | @defun keyboard-coding-system &optional terminal |
b8d4c8d0 | 1817 | This function returns the coding system that is in use for decoding |
3f1d322f EZ |
1818 | keyboard input from @var{terminal}---or @code{nil} if no coding system |
1819 | is to be used for that terminal. If @var{terminal} is omitted or | |
1820 | @code{nil}, it means the selected frame's terminal. @xref{Multiple | |
1821 | Terminals}. | |
b8d4c8d0 GM |
1822 | @end defun |
1823 | ||
3f1d322f EZ |
1824 | @deffn Command set-keyboard-coding-system coding-system &optional terminal |
1825 | This command specifies @var{coding-system} as the coding system to use | |
1826 | for decoding keyboard input from @var{terminal}. If | |
1827 | @var{coding-system} is @code{nil}, that means do not decode keyboard | |
1828 | input. If @var{terminal} is a frame, it means that frame's terminal; | |
1829 | if it is @code{nil}, that means the currently selected frame's | |
1830 | terminal. @xref{Multiple Terminals}. | |
b8d4c8d0 GM |
1831 | @end deffn |
1832 | ||
106e6894 | 1833 | @defun terminal-coding-system &optional terminal |
b8d4c8d0 | 1834 | This function returns the coding system that is in use for encoding |
106e6894 CY |
1835 | terminal output from @var{terminal}---or @code{nil} if the output is |
1836 | not encoded. If @var{terminal} is a frame, it means that frame's | |
1837 | terminal; if it is @code{nil}, that means the currently selected | |
1838 | frame's terminal. | |
b8d4c8d0 GM |
1839 | @end defun |
1840 | ||
106e6894 | 1841 | @deffn Command set-terminal-coding-system coding-system &optional terminal |
b8d4c8d0 | 1842 | This command specifies @var{coding-system} as the coding system to use |
106e6894 CY |
1843 | for encoding terminal output from @var{terminal}. If |
1844 | @var{coding-system} is @code{nil}, terminal output is not encoded. If | |
1845 | @var{terminal} is a frame, it means that frame's terminal; if it is | |
1846 | @code{nil}, that means the currently selected frame's terminal. | |
b8d4c8d0 GM |
1847 | @end deffn |
1848 | ||
b8d4c8d0 GM |
1849 | @node Input Methods |
1850 | @section Input Methods | |
1851 | @cindex input methods | |
1852 | ||
1853 | @dfn{Input methods} provide convenient ways of entering non-@acronym{ASCII} | |
1854 | characters from the keyboard. Unlike coding systems, which translate | |
1855 | non-@acronym{ASCII} characters to and from encodings meant to be read by | |
1856 | programs, input methods provide human-friendly commands. (@xref{Input | |
1857 | Methods,,, emacs, The GNU Emacs Manual}, for information on how users | |
1858 | use input methods to enter text.) How to define input methods is not | |
1859 | yet documented in this manual, but here we describe how to use them. | |
1860 | ||
1861 | Each input method has a name, which is currently a string; | |
1862 | in the future, symbols may also be usable as input method names. | |
1863 | ||
1864 | @defvar current-input-method | |
1865 | This variable holds the name of the input method now active in the | |
1866 | current buffer. (It automatically becomes local in each buffer when set | |
1867 | in any fashion.) It is @code{nil} if no input method is active in the | |
1868 | buffer now. | |
1869 | @end defvar | |
1870 | ||
1871 | @defopt default-input-method | |
1872 | This variable holds the default input method for commands that choose an | |
1873 | input method. Unlike @code{current-input-method}, this variable is | |
1874 | normally global. | |
1875 | @end defopt | |
1876 | ||
1877 | @deffn Command set-input-method input-method | |
1878 | This command activates input method @var{input-method} for the current | |
1879 | buffer. It also sets @code{default-input-method} to @var{input-method}. | |
1880 | If @var{input-method} is @code{nil}, this command deactivates any input | |
1881 | method for the current buffer. | |
1882 | @end deffn | |
1883 | ||
1884 | @defun read-input-method-name prompt &optional default inhibit-null | |
1885 | This function reads an input method name with the minibuffer, prompting | |
1886 | with @var{prompt}. If @var{default} is non-@code{nil}, that is returned | |
1887 | by default, if the user enters empty input. However, if | |
1888 | @var{inhibit-null} is non-@code{nil}, empty input signals an error. | |
1889 | ||
1890 | The returned value is a string. | |
1891 | @end defun | |
1892 | ||
1893 | @defvar input-method-alist | |
1894 | This variable defines all the supported input methods. | |
1895 | Each element defines one input method, and should have the form: | |
1896 | ||
1897 | @example | |
1898 | (@var{input-method} @var{language-env} @var{activate-func} | |
1899 | @var{title} @var{description} @var{args}...) | |
1900 | @end example | |
1901 | ||
1902 | Here @var{input-method} is the input method name, a string; | |
1903 | @var{language-env} is another string, the name of the language | |
1904 | environment this input method is recommended for. (That serves only for | |
1905 | documentation purposes.) | |
1906 | ||
1907 | @var{activate-func} is a function to call to activate this method. The | |
1908 | @var{args}, if any, are passed as arguments to @var{activate-func}. All | |
1909 | told, the arguments to @var{activate-func} are @var{input-method} and | |
1910 | the @var{args}. | |
1911 | ||
1912 | @var{title} is a string to display in the mode line while this method is | |
1913 | active. @var{description} is a string describing this method and what | |
1914 | it is good for. | |
1915 | @end defvar | |
1916 | ||
1917 | The fundamental interface to input methods is through the | |
1918 | variable @code{input-method-function}. @xref{Reading One Event}, | |
1919 | and @ref{Invoking the Input Method}. | |
1920 | ||
1921 | @node Locales | |
1922 | @section Locales | |
1923 | @cindex locale | |
1924 | ||
1925 | POSIX defines a concept of ``locales'' which control which language | |
1926 | to use in language-related features. These Emacs variables control | |
1927 | how Emacs interacts with these features. | |
1928 | ||
1929 | @defvar locale-coding-system | |
1930 | @cindex keyboard input decoding on X | |
1931 | This variable specifies the coding system to use for decoding system | |
1932 | error messages and---on X Window system only---keyboard input, for | |
1933 | encoding the format argument to @code{format-time-string}, and for | |
1934 | decoding the return value of @code{format-time-string}. | |
1935 | @end defvar | |
1936 | ||
1937 | @defvar system-messages-locale | |
1938 | This variable specifies the locale to use for generating system error | |
1939 | messages. Changing the locale can cause messages to come out in a | |
1940 | different language or in a different orthography. If the variable is | |
1941 | @code{nil}, the locale is specified by environment variables in the | |
1942 | usual POSIX fashion. | |
1943 | @end defvar | |
1944 | ||
1945 | @defvar system-time-locale | |
1946 | This variable specifies the locale to use for formatting time values. | |
1947 | Changing the locale can cause messages to appear according to the | |
1948 | conventions of a different language. If the variable is @code{nil}, the | |
1949 | locale is specified by environment variables in the usual POSIX fashion. | |
1950 | @end defvar | |
1951 | ||
1952 | @defun locale-info item | |
1953 | This function returns locale data @var{item} for the current POSIX | |
1954 | locale, if available. @var{item} should be one of these symbols: | |
1955 | ||
1956 | @table @code | |
1957 | @item codeset | |
1958 | Return the character set as a string (locale item @code{CODESET}). | |
1959 | ||
1960 | @item days | |
1961 | Return a 7-element vector of day names (locale items | |
1962 | @code{DAY_1} through @code{DAY_7}); | |
1963 | ||
1964 | @item months | |
1965 | Return a 12-element vector of month names (locale items @code{MON_1} | |
1966 | through @code{MON_12}). | |
1967 | ||
1968 | @item paper | |
1969 | Return a list @code{(@var{width} @var{height})} for the default paper | |
1970 | size measured in millimeters (locale items @code{PAPER_WIDTH} and | |
1971 | @code{PAPER_HEIGHT}). | |
1972 | @end table | |
1973 | ||
1974 | If the system can't provide the requested information, or if | |
1975 | @var{item} is not one of those symbols, the value is @code{nil}. All | |
1976 | strings in the return value are decoded using | |
1977 | @code{locale-coding-system}. @xref{Locales,,, libc, The GNU Libc Manual}, | |
1978 | for more information about locales and locale items. | |
1979 | @end defun |