Mercurial > emacs
annotate lispref/nonascii.texi @ 74340:ba613bb7aa38
** kzeitler@lucent.com, Nov 29: Cursor placement with mouse in long
lines with wrapped tab
Fixed.
author | Chong Yidong <cyd@stupidchicken.com> |
---|---|
date | Thu, 30 Nov 2006 21:00:32 +0000 |
parents | ad9a6e48c18a |
children | 6d19c76d81c5 c358d0861b16 |
rev | line source |
---|---|
21006 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
64889
e836425ee789
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
63583
diff
changeset
|
3 @c Copyright (C) 1998, 1999, 2002, 2003, 2004, |
68648
067115a6e738
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
68285
diff
changeset
|
4 @c 2005, 2006 Free Software Foundation, Inc. |
21006 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/characters | |
7 @node Non-ASCII Characters, Searching and Matching, Text, Top | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
8 @chapter Non-@acronym{ASCII} Characters |
21006 | 9 @cindex multibyte characters |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
10 @cindex non-@acronym{ASCII} characters |
21006 | 11 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
12 This chapter covers the special issues relating to non-@acronym{ASCII} |
21006 | 13 characters and how they are stored in strings and buffers. |
14 | |
15 @menu | |
28635
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
16 * Text Representations:: Unibyte and multibyte representations |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
17 * Converting Representations:: Converting unibyte to multibyte and vice versa. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
18 * Selecting a Representation:: Treating a byte sequence as unibyte or multi. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
19 * Character Codes:: How unibyte and multibyte relate to |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
20 codes of individual characters. |
54036
9706b0221102
(Translation of Characters): Give examples of use.
Richard M. Stallman <rms@gnu.org>
parents:
53431
diff
changeset
|
21 * Character Sets:: The space of possible character codes |
28635
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
22 is divided into various character sets. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
23 * Chars and Bytes:: More information about multibyte encodings. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
24 * Splitting Characters:: Converting a character to its byte sequence. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
25 * Scanning Charsets:: Which character sets are used in a buffer? |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
26 * Translation of Characters:: Translation tables are used for conversion. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
27 * Coding Systems:: Coding systems are conversions for saving files. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
28 * Input Methods:: Input methods allow users to enter various |
40834 | 29 non-ASCII characters without special keyboards. |
28635
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
30 * Locales:: Interacting with the POSIX locale. |
21006 | 31 @end menu |
32 | |
33 @node Text Representations | |
34 @section Text Representations | |
35 @cindex text representations | |
36 | |
37 Emacs has two @dfn{text representations}---two ways to represent text | |
38 in a string or buffer. These are called @dfn{unibyte} and | |
39 @dfn{multibyte}. Each string, and each buffer, uses one of these two | |
40 representations. For most purposes, you can ignore the issue of | |
41 representations, because Emacs converts text between them as | |
42 appropriate. Occasionally in Lisp programming you will need to pay | |
43 attention to the difference. | |
44 | |
45 @cindex unibyte text | |
46 In unibyte representation, each character occupies one byte and | |
47 therefore the possible character codes range from 0 to 255. Codes 0 | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
48 through 127 are @acronym{ASCII} characters; the codes from 128 through 255 |
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
49 are used for one non-@acronym{ASCII} character set (you can choose which |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
50 character set by setting the variable @code{nonascii-insert-offset}). |
21006 | 51 |
52 @cindex leading code | |
53 @cindex multibyte text | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
54 @cindex trailing codes |
21006 | 55 In multibyte representation, a character may occupy more than one |
56 byte, and as a result, the full range of Emacs character codes can be | |
57 stored. The first byte of a multibyte character is always in the range | |
58 128 through 159 (octal 0200 through 0237). These values are called | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
59 @dfn{leading codes}. The second and subsequent bytes of a multibyte |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
60 character are always in the range 160 through 255 (octal 0240 through |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
61 0377); these values are @dfn{trailing codes}. |
21006 | 62 |
28877 | 63 Some sequences of bytes are not valid in multibyte text: for example, |
32523 | 64 a single isolated byte in the range 128 through 159 is not allowed. But |
65 character codes 128 through 159 can appear in multibyte text, | |
66 represented as two-byte sequences. All the character codes 128 through | |
67 255 are possible (though slightly abnormal) in multibyte text; they | |
28877 | 68 appear in multibyte buffers and strings when you do explicit encoding |
69 and decoding (@pxref{Explicit Encoding}). | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
70 |
21006 | 71 In a buffer, the buffer-local value of the variable |
72 @code{enable-multibyte-characters} specifies the representation used. | |
24952 | 73 The representation for a string is determined and recorded in the string |
74 when the string is constructed. | |
21006 | 75 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
76 @defvar enable-multibyte-characters |
21006 | 77 This variable specifies the current buffer's text representation. |
78 If it is non-@code{nil}, the buffer contains multibyte text; otherwise, | |
79 it contains unibyte text. | |
80 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
81 You cannot set this variable directly; instead, use the function |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
82 @code{set-buffer-multibyte} to change a buffer's representation. |
21006 | 83 @end defvar |
84 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
85 @defvar default-enable-multibyte-characters |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
86 This variable's value is entirely equivalent to @code{(default-value |
21006 | 87 'enable-multibyte-characters)}, and setting this variable changes that |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
88 default value. Setting the local binding of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
89 @code{enable-multibyte-characters} in a specific buffer is not allowed, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
90 but changing the default value is supported, and it is a reasonable |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
91 thing to do, because it has no effect on existing buffers. |
21006 | 92 |
93 The @samp{--unibyte} command line option does its job by setting the | |
94 default value to @code{nil} early in startup. | |
95 @end defvar | |
96 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
97 @defun position-bytes position |
60501
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
98 Return the byte-position corresponding to buffer position |
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
99 @var{position} in the current buffer. This is 1 at the start of the |
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
100 buffer, and counts upward in bytes. If @var{position} is out of |
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
101 range, the value is @code{nil}. |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
102 @end defun |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
103 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
104 @defun byte-to-position byte-position |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
105 Return the buffer position corresponding to byte-position |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
106 @var{byte-position} in the current buffer. If @var{byte-position} is |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
107 out of range, the value is @code{nil}. |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
108 @end defun |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
109 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
110 @defun multibyte-string-p string |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
111 Return @code{t} if @var{string} is a multibyte string. |
21006 | 112 @end defun |
113 | |
114 @node Converting Representations | |
115 @section Converting Text Representations | |
116 | |
117 Emacs can convert unibyte text to multibyte; it can also convert | |
118 multibyte text to unibyte, though this conversion loses information. In | |
119 general these conversions happen when inserting text into a buffer, or | |
120 when putting text from several strings together in one string. You can | |
121 also explicitly convert a string's contents to either representation. | |
122 | |
123 Emacs chooses the representation for a string based on the text that | |
124 it is constructed from. The general rule is to convert unibyte text to | |
125 multibyte text when combining it with other multibyte text, because the | |
126 multibyte representation is more general and can hold whatever | |
127 characters the unibyte text has. | |
128 | |
129 When inserting text into a buffer, Emacs converts the text to the | |
130 buffer's representation, as specified by | |
131 @code{enable-multibyte-characters} in that buffer. In particular, when | |
132 you insert multibyte text into a unibyte buffer, Emacs converts the text | |
133 to unibyte, even though this conversion cannot in general preserve all | |
134 the characters that might be in the multibyte text. The other natural | |
135 alternative, to convert the buffer contents to multibyte, is not | |
136 acceptable because the buffer's representation is a choice made by the | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
137 user that cannot be overridden automatically. |
21006 | 138 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
139 Converting unibyte text to multibyte text leaves @acronym{ASCII} characters |
32523 | 140 unchanged, and likewise character codes 128 through 159. It converts |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
141 the non-@acronym{ASCII} codes 160 through 255 by adding the value |
32523 | 142 @code{nonascii-insert-offset} to each character code. By setting this |
143 variable, you specify which character set the unibyte characters | |
144 correspond to (@pxref{Character Sets}). For example, if | |
145 @code{nonascii-insert-offset} is 2048, which is @code{(- (make-char | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
146 'latin-iso8859-1) 128)}, then the unibyte non-@acronym{ASCII} characters |
32523 | 147 correspond to Latin 1. If it is 2688, which is @code{(- (make-char |
148 'greek-iso8859-7) 128)}, then they correspond to Greek letters. | |
21006 | 149 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
150 Converting multibyte text to unibyte is simpler: it discards all but |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
151 the low 8 bits of each character code. If @code{nonascii-insert-offset} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
152 has a reasonable value, corresponding to the beginning of some character |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
153 set, this conversion is the inverse of the other: converting unibyte |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
154 text to multibyte and back to unibyte reproduces the original unibyte |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
155 text. |
21006 | 156 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
157 @defvar nonascii-insert-offset |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
158 This variable specifies the amount to add to a non-@acronym{ASCII} character |
21006 | 159 when converting unibyte text to multibyte. It also applies when |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
160 @code{self-insert-command} inserts a character in the unibyte |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
161 non-@acronym{ASCII} range, 128 through 255. However, the functions |
29265 | 162 @code{insert} and @code{insert-char} do not perform this conversion. |
21006 | 163 |
164 The right value to use to select character set @var{cs} is @code{(- | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
165 (make-char @var{cs}) 128)}. If the value of |
21006 | 166 @code{nonascii-insert-offset} is zero, then conversion actually uses the |
167 value for the Latin 1 character set, rather than zero. | |
168 @end defvar | |
169 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
170 @defvar nonascii-translation-table |
21006 | 171 This variable provides a more general alternative to |
172 @code{nonascii-insert-offset}. You can use it to specify independently | |
173 how to translate each code in the range of 128 through 255 into a | |
29265 | 174 multibyte character. The value should be a char-table, or @code{nil}. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
175 If this is non-@code{nil}, it overrides @code{nonascii-insert-offset}. |
21006 | 176 @end defvar |
177 | |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
178 The next three functions either return the argument @var{string}, or a |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
179 newly created string with no text properties. |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
180 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
181 @defun string-make-unibyte string |
21006 | 182 This function converts the text of @var{string} to unibyte |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
183 representation, if it isn't already, and returns the result. If |
45652
ccaf0199f9dc
(Converting Representations): Update the description of what
Eli Zaretskii <eliz@gnu.org>
parents:
43634
diff
changeset
|
184 @var{string} is a unibyte string, it is returned unchanged. Multibyte |
ccaf0199f9dc
(Converting Representations): Update the description of what
Eli Zaretskii <eliz@gnu.org>
parents:
43634
diff
changeset
|
185 character codes are converted to unibyte according to |
ccaf0199f9dc
(Converting Representations): Update the description of what
Eli Zaretskii <eliz@gnu.org>
parents:
43634
diff
changeset
|
186 @code{nonascii-translation-table} or, if that is @code{nil}, using |
ccaf0199f9dc
(Converting Representations): Update the description of what
Eli Zaretskii <eliz@gnu.org>
parents:
43634
diff
changeset
|
187 @code{nonascii-insert-offset}. If the lookup in the translation table |
ccaf0199f9dc
(Converting Representations): Update the description of what
Eli Zaretskii <eliz@gnu.org>
parents:
43634
diff
changeset
|
188 fails, this function takes just the low 8 bits of each character. |
21006 | 189 @end defun |
190 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
191 @defun string-make-multibyte string |
21006 | 192 This function converts the text of @var{string} to multibyte |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
193 representation, if it isn't already, and returns the result. If |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
194 @var{string} is a multibyte string or consists entirely of |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
195 @acronym{ASCII} characters, it is returned unchanged. In particular, |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
196 if @var{string} is unibyte and entirely @acronym{ASCII}, the returned |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
197 string is unibyte. (When the characters are all @acronym{ASCII}, |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
198 Emacs primitives will treat the string the same way whether it is |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
199 unibyte or multibyte.) If @var{string} is unibyte and contains |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
200 non-@acronym{ASCII} characters, the function |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
201 @code{unibyte-char-to-multibyte} is used to convert each unibyte |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
202 character to a multibyte character. |
21006 | 203 @end defun |
204 | |
51990
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
205 @defun string-to-multibyte string |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
206 This function returns a multibyte string containing the same sequence |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
207 of character codes as @var{string}. Unlike |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
208 @code{string-make-multibyte}, this function unconditionally returns a |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
209 multibyte string. If @var{string} is a multibyte string, it is |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
210 returned unchanged. |
51990
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
211 @end defun |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
212 |
53431
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
213 @defun multibyte-char-to-unibyte char |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
214 This convert the multibyte character @var{char} to a unibyte |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
215 character, based on @code{nonascii-translation-table} and |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
216 @code{nonascii-insert-offset}. |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
217 @end defun |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
218 |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
219 @defun unibyte-char-to-multibyte char |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
220 This convert the unibyte character @var{char} to a multibyte |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
221 character, based on @code{nonascii-translation-table} and |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
222 @code{nonascii-insert-offset}. |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
223 @end defun |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
224 |
21006 | 225 @node Selecting a Representation |
226 @section Selecting a Representation | |
227 | |
228 Sometimes it is useful to examine an existing buffer or string as | |
229 multibyte when it was unibyte, or vice versa. | |
230 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
231 @defun set-buffer-multibyte multibyte |
21006 | 232 Set the representation type of the current buffer. If @var{multibyte} |
233 is non-@code{nil}, the buffer becomes multibyte. If @var{multibyte} | |
234 is @code{nil}, the buffer becomes unibyte. | |
235 | |
236 This function leaves the buffer contents unchanged when viewed as a | |
237 sequence of bytes. As a consequence, it can change the contents viewed | |
238 as characters; a sequence of two bytes which is treated as one character | |
239 in multibyte representation will count as two characters in unibyte | |
29265 | 240 representation. Character codes 128 through 159 are an exception. They |
241 are represented by one byte in a unibyte buffer, but when the buffer is | |
242 set to multibyte, they are converted to two-byte sequences, and vice | |
243 versa. | |
21006 | 244 |
245 This function sets @code{enable-multibyte-characters} to record which | |
246 representation is in use. It also adjusts various data in the buffer | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
247 (including overlays, text properties and markers) so that they cover the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
248 same text as they did before. |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
249 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
250 You cannot use @code{set-buffer-multibyte} on an indirect buffer, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
251 because indirect buffers always inherit the representation of the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
252 base buffer. |
21006 | 253 @end defun |
254 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
255 @defun string-as-unibyte string |
21006 | 256 This function returns a string with the same bytes as @var{string} but |
257 treating each byte as a character. This means that the value may have | |
258 more characters than @var{string} has. | |
259 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
260 If @var{string} is already a unibyte string, then the value is |
33912 | 261 @var{string} itself. Otherwise it is a newly created string, with no |
262 text properties. If @var{string} is multibyte, any characters it | |
50653
6f6abeeda7ed
(Selecting a Representation): Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
263 contains of charset @code{eight-bit-control} or @code{eight-bit-graphic} |
33912 | 264 are converted to the corresponding single byte. |
21006 | 265 @end defun |
266 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
267 @defun string-as-multibyte string |
21006 | 268 This function returns a string with the same bytes as @var{string} but |
269 treating each multibyte sequence as one character. This means that the | |
270 value may have fewer characters than @var{string} has. | |
271 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
272 If @var{string} is already a multibyte string, then the value is |
33912 | 273 @var{string} itself. Otherwise it is a newly created string, with no |
274 text properties. If @var{string} is unibyte and contains any individual | |
275 8-bit bytes (i.e.@: not part of a multibyte form), they are converted to | |
50653
6f6abeeda7ed
(Selecting a Representation): Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
276 the corresponding multibyte character of charset @code{eight-bit-control} |
6f6abeeda7ed
(Selecting a Representation): Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
277 or @code{eight-bit-graphic}. |
21006 | 278 @end defun |
279 | |
280 @node Character Codes | |
281 @section Character Codes | |
282 @cindex character codes | |
283 | |
284 The unibyte and multibyte text representations use different character | |
285 codes. The valid character codes for unibyte representation range from | |
286 0 to 255---the values that can fit in one byte. The valid character | |
287 codes for multibyte representation range from 0 to 524287, but not all | |
28877 | 288 values in that range are valid. The values 128 through 255 are not |
32523 | 289 entirely proper in multibyte text, but they can occur if you do explicit |
28877 | 290 encoding and decoding (@pxref{Explicit Encoding}). Some other character |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
291 codes cannot occur at all in multibyte text. Only the @acronym{ASCII} codes |
32523 | 292 0 through 127 are completely legitimate in both representations. |
21006 | 293 |
29265 | 294 @defun char-valid-p charcode &optional genericp |
60677
0daf01e514e4
(Character Codes): Minor fix.
Richard M. Stallman <rms@gnu.org>
parents:
60501
diff
changeset
|
295 This returns @code{t} if @var{charcode} is valid (either for unibyte |
0daf01e514e4
(Character Codes): Minor fix.
Richard M. Stallman <rms@gnu.org>
parents:
60501
diff
changeset
|
296 text or for multibyte text). |
21006 | 297 |
298 @example | |
299 (char-valid-p 65) | |
300 @result{} t | |
301 (char-valid-p 256) | |
302 @result{} nil | |
303 (char-valid-p 2248) | |
304 @result{} t | |
305 @end example | |
29265 | 306 |
51703
b8860fc285cb
Minor Texinfo usage fix.
Richard M. Stallman <rms@gnu.org>
parents:
50653
diff
changeset
|
307 If the optional argument @var{genericp} is non-@code{nil}, this |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
308 function also returns @code{t} if @var{charcode} is a generic |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
309 character (@pxref{Splitting Characters}). |
21006 | 310 @end defun |
311 | |
312 @node Character Sets | |
313 @section Character Sets | |
314 @cindex character sets | |
315 | |
316 Emacs classifies characters into various @dfn{character sets}, each of | |
317 which has a name which is a symbol. Each character belongs to one and | |
318 only one character set. | |
319 | |
320 In general, there is one character set for each distinct script. For | |
321 example, @code{latin-iso8859-1} is one character set, | |
322 @code{greek-iso8859-7} is another, and @code{ascii} is another. An | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
323 Emacs character set can hold at most 9025 characters; therefore, in some |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
324 cases, characters that would logically be grouped together are split |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
325 into several character sets. For example, one set of Chinese |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
326 characters, generally known as Big 5, is divided into two Emacs |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
327 character sets, @code{chinese-big5-1} and @code{chinese-big5-2}. |
21006 | 328 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
329 @acronym{ASCII} characters are in character set @code{ascii}. The |
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
330 non-@acronym{ASCII} characters 128 through 159 are in character set |
28900 | 331 @code{eight-bit-control}, and codes 160 through 255 are in character set |
332 @code{eight-bit-graphic}. | |
333 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
334 @defun charsetp object |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
335 Returns @code{t} if @var{object} is a symbol that names a character set, |
21006 | 336 @code{nil} otherwise. |
337 @end defun | |
338 | |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
339 @defvar charset-list |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
340 The value is a list of all defined character set names. |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
341 @end defvar |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
342 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
343 @defun charset-list |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
344 This function returns the value of @code{charset-list}. It is only |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
345 provided for backward compatibility. |
21006 | 346 @end defun |
347 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
348 @defun char-charset character |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
349 This function returns the name of the character set that @var{character} |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
350 belongs to, or the symbol @code{unknown} if @var{character} is not a |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
351 valid character. |
21006 | 352 @end defun |
353 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
354 @defun charset-plist charset |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
355 This function returns the charset property list of the character set |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
356 @var{charset}. Although @var{charset} is a symbol, this is not the same |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
357 as the property list of that symbol. Charset properties are used for |
52788
814620b1c1af
Don't mention preferred-coding-system.
Dave Love <fx@gnu.org>
parents:
52401
diff
changeset
|
358 special purposes within Emacs. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
359 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
360 |
60501
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
361 @deffn Command list-charset-chars charset |
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
362 This command displays a list of characters in the character set |
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
363 @var{charset}. |
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
364 @end deffn |
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
365 |
21006 | 366 @node Chars and Bytes |
367 @section Characters and Bytes | |
368 @cindex bytes and characters | |
369 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
370 @cindex introduction sequence |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
371 @cindex dimension (of character set) |
21006 | 372 In multibyte representation, each character occupies one or more |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
373 bytes. Each character set has an @dfn{introduction sequence}, which is |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
374 normally one or two bytes long. (Exception: the @code{ascii} character |
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
375 set and the @code{eight-bit-graphic} character set have a zero-length |
29265 | 376 introduction sequence.) The introduction sequence is the beginning of |
377 the byte sequence for any character in the character set. The rest of | |
378 the character's bytes distinguish it from the other characters in the | |
379 same character set. Depending on the character set, there are either | |
380 one or two distinguishing bytes; the number of such bytes is called the | |
381 @dfn{dimension} of the character set. | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
382 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
383 @defun charset-dimension charset |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
384 This function returns the dimension of @var{charset}; at present, the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
385 dimension is always 1 or 2. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
386 @end defun |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
387 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
388 @defun charset-bytes charset |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
389 This function returns the number of bytes used to represent a character |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
390 in character set @var{charset}. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
391 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
392 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
393 This is the simplest way to determine the byte length of a character |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
394 set's introduction sequence: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
395 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
396 @example |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
397 (- (charset-bytes @var{charset}) |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
398 (charset-dimension @var{charset})) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
399 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
400 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
401 @node Splitting Characters |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
402 @section Splitting Characters |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
403 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
404 The functions in this section convert between characters and the byte |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
405 values used to represent them. For most purposes, there is no need to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
406 be concerned with the sequence of bytes used to represent a character, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
407 because Emacs translates automatically when necessary. |
21006 | 408 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
409 @defun split-char character |
21006 | 410 Return a list containing the name of the character set of |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
411 @var{character}, followed by one or two byte values (integers) which |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
412 identify @var{character} within that character set. The number of byte |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
413 values is the character set's dimension. |
21006 | 414 |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
415 If @var{character} is invalid as a character code, @code{split-char} |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
416 returns a list consisting of the symbol @code{unknown} and @var{character}. |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
417 |
21006 | 418 @example |
419 (split-char 2248) | |
420 @result{} (latin-iso8859-1 72) | |
421 (split-char 65) | |
422 @result{} (ascii 65) | |
29265 | 423 (split-char 128) |
424 @result{} (eight-bit-control 128) | |
21006 | 425 @end example |
426 @end defun | |
427 | |
34811 | 428 @defun make-char charset &optional code1 code2 |
429 This function returns the character in character set @var{charset} whose | |
430 position codes are @var{code1} and @var{code2}. This is roughly the | |
431 inverse of @code{split-char}. Normally, you should specify either one | |
432 or both of @var{code1} and @var{code2} according to the dimension of | |
433 @var{charset}. For example, | |
21006 | 434 |
435 @example | |
436 (make-char 'latin-iso8859-1 72) | |
437 @result{} 2248 | |
438 @end example | |
52788
814620b1c1af
Don't mention preferred-coding-system.
Dave Love <fx@gnu.org>
parents:
52401
diff
changeset
|
439 |
814620b1c1af
Don't mention preferred-coding-system.
Dave Love <fx@gnu.org>
parents:
52401
diff
changeset
|
440 Actually, the eighth bit of both @var{code1} and @var{code2} is zeroed |
814620b1c1af
Don't mention preferred-coding-system.
Dave Love <fx@gnu.org>
parents:
52401
diff
changeset
|
441 before they are used to index @var{charset}. Thus you may use, for |
814620b1c1af
Don't mention preferred-coding-system.
Dave Love <fx@gnu.org>
parents:
52401
diff
changeset
|
442 instance, an ISO 8859 character code rather than subtracting 128, as |
814620b1c1af
Don't mention preferred-coding-system.
Dave Love <fx@gnu.org>
parents:
52401
diff
changeset
|
443 is necessary to index the corresponding Emacs charset. |
21006 | 444 @end defun |
445 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
446 @cindex generic characters |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
447 If you call @code{make-char} with no @var{byte-values}, the result is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
448 a @dfn{generic character} which stands for @var{charset}. A generic |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
449 character is an integer, but it is @emph{not} valid for insertion in the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
450 buffer as a character. It can be used in @code{char-table-range} to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
451 refer to the whole character set (@pxref{Char-Tables}). |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
452 @code{char-valid-p} returns @code{nil} for generic characters. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
453 For example: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
454 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
455 @example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
456 (make-char 'latin-iso8859-1) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
457 @result{} 2176 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
458 (char-valid-p 2176) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
459 @result{} nil |
29265 | 460 (char-valid-p 2176 t) |
461 @result{} t | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
462 (split-char 2176) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
463 @result{} (latin-iso8859-1 0) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
464 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
465 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
466 The character sets @code{ascii}, @code{eight-bit-control}, and |
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
467 @code{eight-bit-graphic} don't have corresponding generic characters. If |
34811 | 468 @var{charset} is one of them and you don't supply @var{code1}, |
469 @code{make-char} returns the character code corresponding to the | |
470 smallest code in @var{charset}. | |
29265 | 471 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
472 @node Scanning Charsets |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
473 @section Scanning for Character Sets |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
474 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
475 Sometimes it is useful to find out which character sets appear in a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
476 part of a buffer or a string. One use for this is in determining which |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
477 coding systems (@pxref{Coding Systems}) are capable of representing all |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
478 of the text in question. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
479 |
60501
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
480 @defun charset-after &optional pos |
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
481 This function return the charset of a character in the current buffer |
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
482 at position @var{pos}. If @var{pos} is omitted or @code{nil}, it |
70506
f7aff7b6d4af
* commands.texi (Event Input Misc):
Romain Francoise <romain@orebokech.com>
parents:
68648
diff
changeset
|
483 defaults to the current value of point. If @var{pos} is out of range, |
60501
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
484 the value is @code{nil}. |
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
485 @end defun |
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
486 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
487 @defun find-charset-region beg end &optional translation |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
488 This function returns a list of the character sets that appear in the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
489 current buffer between positions @var{beg} and @var{end}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
490 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
491 The optional argument @var{translation} specifies a translation table to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
492 be used in scanning the text (@pxref{Translation of Characters}). If it |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
493 is non-@code{nil}, then each character in the region is translated |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
494 through this table, and the value returned describes the translated |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
495 characters instead of the characters actually in the buffer. |
28887 | 496 @end defun |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
497 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
498 @defun find-charset-string string &optional translation |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
499 This function returns a list of the character sets that appear in the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
500 string @var{string}. It is just like @code{find-charset-region}, except |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
501 that it applies to the contents of @var{string} instead of part of the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
502 current buffer. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
503 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
504 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
505 @node Translation of Characters |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
506 @section Translation of Characters |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
507 @cindex character translation tables |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
508 @cindex translation tables |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
509 |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
510 A @dfn{translation table} is a char-table that specifies a mapping |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
511 of characters into characters. These tables are used in encoding and |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
512 decoding, and for other purposes. Some coding systems specify their |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
513 own particular translation tables; there are also default translation |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
514 tables which apply to all other coding systems. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
515 |
54036
9706b0221102
(Translation of Characters): Give examples of use.
Richard M. Stallman <rms@gnu.org>
parents:
53431
diff
changeset
|
516 For instance, the coding-system @code{utf-8} has a translation table |
9706b0221102
(Translation of Characters): Give examples of use.
Richard M. Stallman <rms@gnu.org>
parents:
53431
diff
changeset
|
517 that maps characters of various charsets (e.g., |
9706b0221102
(Translation of Characters): Give examples of use.
Richard M. Stallman <rms@gnu.org>
parents:
53431
diff
changeset
|
518 @code{latin-iso8859-@var{x}}) into Unicode character sets. This way, |
9706b0221102
(Translation of Characters): Give examples of use.
Richard M. Stallman <rms@gnu.org>
parents:
53431
diff
changeset
|
519 it can encode Latin-2 characters into UTF-8. Meanwhile, |
9706b0221102
(Translation of Characters): Give examples of use.
Richard M. Stallman <rms@gnu.org>
parents:
53431
diff
changeset
|
520 @code{unify-8859-on-decoding-mode} operates by specifying |
9706b0221102
(Translation of Characters): Give examples of use.
Richard M. Stallman <rms@gnu.org>
parents:
53431
diff
changeset
|
521 @code{standard-translation-table-for-decode} to translate |
9706b0221102
(Translation of Characters): Give examples of use.
Richard M. Stallman <rms@gnu.org>
parents:
53431
diff
changeset
|
522 Latin-@var{x} characters into corresponding Unicode characters. |
9706b0221102
(Translation of Characters): Give examples of use.
Richard M. Stallman <rms@gnu.org>
parents:
53431
diff
changeset
|
523 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
524 @defun make-translation-table &rest translations |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
525 This function returns a translation table based on the argument |
35752 | 526 @var{translations}. Each element of @var{translations} should be a |
527 list of elements of the form @code{(@var{from} . @var{to})}; this says | |
528 to translate the character @var{from} into @var{to}. | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
529 |
35493 | 530 The arguments and the forms in each argument are processed in order, |
531 and if a previous form already translates @var{to} to some other | |
532 character, say @var{to-alt}, @var{from} is also translated to | |
533 @var{to-alt}. | |
534 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
535 You can also map one whole character set into another character set with |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
536 the same dimension. To do this, you specify a generic character (which |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
537 designates a character set) for @var{from} (@pxref{Splitting Characters}). |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
538 In this case, if @var{to} is also a generic character, its character |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
539 set should have the same dimension as @var{from}'s. Then the |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
540 translation table translates each character of @var{from}'s character |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
541 set into the corresponding character of @var{to}'s character set. If |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
542 @var{from} is a generic character and @var{to} is an ordinary |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
543 character, then the translation table translates every character of |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
544 @var{from}'s character set into @var{to}. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
545 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
546 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
547 In decoding, the translation table's translations are applied to the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
548 characters that result from ordinary decoding. If a coding system has |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
549 property @code{translation-table-for-decode}, that specifies the |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
550 translation table to use. (This is a property of the coding system, |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
551 as returned by @code{coding-system-get}, not a property of the symbol |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
552 that is the coding system's name. @xref{Coding System Basics,, Basic |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
553 Concepts of Coding Systems}.) Otherwise, if |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
554 @code{standard-translation-table-for-decode} is non-@code{nil}, |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
555 decoding uses that table. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
556 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
557 In encoding, the translation table's translations are applied to the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
558 characters in the buffer, and the result of translation is actually |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
559 encoded. If a coding system has property |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
560 @code{translation-table-for-encode}, that specifies the translation |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
561 table to use. Otherwise the variable |
23433
a53274056f20
Fix names of standard-translation-table-for-decode(encode).
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
562 @code{standard-translation-table-for-encode} specifies the translation |
a53274056f20
Fix names of standard-translation-table-for-decode(encode).
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
563 table. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
564 |
23433
a53274056f20
Fix names of standard-translation-table-for-decode(encode).
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
565 @defvar standard-translation-table-for-decode |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
566 This is the default translation table for decoding, for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
567 coding systems that don't specify any other translation table. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
568 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
569 |
23433
a53274056f20
Fix names of standard-translation-table-for-decode(encode).
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
570 @defvar standard-translation-table-for-encode |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
571 This is the default translation table for encoding, for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
572 coding systems that don't specify any other translation table. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
573 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
574 |
51990
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
575 @defvar translation-table-for-input |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
576 Self-inserting characters are translated through this translation |
68285
2a5c4effbefd
(Translation of Characters): Search cmds use
Richard M. Stallman <rms@gnu.org>
parents:
65369
diff
changeset
|
577 table before they are inserted. Search commands also translate their |
2a5c4effbefd
(Translation of Characters): Search cmds use
Richard M. Stallman <rms@gnu.org>
parents:
65369
diff
changeset
|
578 input through this table, so they can compare more reliably with |
2a5c4effbefd
(Translation of Characters): Search cmds use
Richard M. Stallman <rms@gnu.org>
parents:
65369
diff
changeset
|
579 what's in the buffer. |
54036
9706b0221102
(Translation of Characters): Give examples of use.
Richard M. Stallman <rms@gnu.org>
parents:
53431
diff
changeset
|
580 |
9706b0221102
(Translation of Characters): Give examples of use.
Richard M. Stallman <rms@gnu.org>
parents:
53431
diff
changeset
|
581 @code{set-buffer-file-coding-system} sets this variable so that your |
9706b0221102
(Translation of Characters): Give examples of use.
Richard M. Stallman <rms@gnu.org>
parents:
53431
diff
changeset
|
582 keyboard input gets translated into the character sets that the buffer |
68285
2a5c4effbefd
(Translation of Characters): Search cmds use
Richard M. Stallman <rms@gnu.org>
parents:
65369
diff
changeset
|
583 is likely to contain. This variable automatically becomes |
2a5c4effbefd
(Translation of Characters): Search cmds use
Richard M. Stallman <rms@gnu.org>
parents:
65369
diff
changeset
|
584 buffer-local when set. |
51990
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
585 @end defvar |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
586 |
21006 | 587 @node Coding Systems |
588 @section Coding Systems | |
589 | |
590 @cindex coding system | |
591 When Emacs reads or writes a file, and when Emacs sends text to a | |
592 subprocess or receives text from a subprocess, it normally performs | |
593 character code conversion and end-of-line conversion as specified | |
594 by a particular @dfn{coding system}. | |
595 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
596 How to define a coding system is an arcane matter, and is not |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
597 documented here. |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
598 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
599 @menu |
28635
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
600 * Coding System Basics:: Basic concepts. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
601 * Encoding and I/O:: How file I/O functions handle coding systems. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
602 * Lisp and Coding Systems:: Functions to operate on coding system names. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
603 * User-Chosen Coding Systems:: Asking the user to choose a coding system. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
604 * Default Coding Systems:: Controlling the default choices. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
605 * Specifying Coding Systems:: Requesting a particular coding system |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
606 for a single file operation. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
607 * Explicit Encoding:: Encoding or decoding text without doing I/O. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
608 * Terminal I/O Encoding:: Use of encoding for terminal I/O. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
609 * MS-DOS File Types:: How DOS "text" and "binary" files |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
610 relate to coding systems. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
611 @end menu |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
612 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
613 @node Coding System Basics |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
614 @subsection Basic Concepts of Coding Systems |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
615 |
21006 | 616 @cindex character code conversion |
617 @dfn{Character code conversion} involves conversion between the encoding | |
618 used inside Emacs and some other encoding. Emacs supports many | |
619 different encodings, in that it can convert to and from them. For | |
620 example, it can convert text to or from encodings such as Latin 1, Latin | |
621 2, Latin 3, Latin 4, Latin 5, and several variants of ISO 2022. In some | |
622 cases, Emacs supports several alternative encodings for the same | |
623 characters; for example, there are three coding systems for the Cyrillic | |
624 (Russian) alphabet: ISO, Alternativnyj, and KOI8. | |
625 | |
626 Most coding systems specify a particular character code for | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
627 conversion, but some of them leave the choice unspecified---to be chosen |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
628 heuristically for each file, based on the data. |
21006 | 629 |
61233
5c7a0c8de2df
(Coding System Basics): Another cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
61218
diff
changeset
|
630 In general, a coding system doesn't guarantee roundtrip identity: |
5c7a0c8de2df
(Coding System Basics): Another cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
61218
diff
changeset
|
631 decoding a byte sequence using coding system, then encoding the |
5c7a0c8de2df
(Coding System Basics): Another cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
61218
diff
changeset
|
632 resulting text in the same coding system, can produce a different byte |
5c7a0c8de2df
(Coding System Basics): Another cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
61218
diff
changeset
|
633 sequence. However, the following coding systems do guarantee that the |
5c7a0c8de2df
(Coding System Basics): Another cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
61218
diff
changeset
|
634 byte sequence will be the same as what you originally decoded: |
61185
447c3b4db32f
(Coding System Basics): Describe about rondtrip
Kenichi Handa <handa@m17n.org>
parents:
60677
diff
changeset
|
635 |
447c3b4db32f
(Coding System Basics): Describe about rondtrip
Kenichi Handa <handa@m17n.org>
parents:
60677
diff
changeset
|
636 @quotation |
447c3b4db32f
(Coding System Basics): Describe about rondtrip
Kenichi Handa <handa@m17n.org>
parents:
60677
diff
changeset
|
637 chinese-big5 chinese-iso-8bit cyrillic-iso-8bit emacs-mule |
447c3b4db32f
(Coding System Basics): Describe about rondtrip
Kenichi Handa <handa@m17n.org>
parents:
60677
diff
changeset
|
638 greek-iso-8bit hebrew-iso-8bit iso-latin-1 iso-latin-2 iso-latin-3 |
447c3b4db32f
(Coding System Basics): Describe about rondtrip
Kenichi Handa <handa@m17n.org>
parents:
60677
diff
changeset
|
639 iso-latin-4 iso-latin-5 iso-latin-8 iso-latin-9 iso-safe |
447c3b4db32f
(Coding System Basics): Describe about rondtrip
Kenichi Handa <handa@m17n.org>
parents:
60677
diff
changeset
|
640 japanese-iso-8bit japanese-shift-jis korean-iso-8bit raw-text |
447c3b4db32f
(Coding System Basics): Describe about rondtrip
Kenichi Handa <handa@m17n.org>
parents:
60677
diff
changeset
|
641 @end quotation |
447c3b4db32f
(Coding System Basics): Describe about rondtrip
Kenichi Handa <handa@m17n.org>
parents:
60677
diff
changeset
|
642 |
61233
5c7a0c8de2df
(Coding System Basics): Another cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
61218
diff
changeset
|
643 Encoding buffer text and then decoding the result can also fail to |
5c7a0c8de2df
(Coding System Basics): Another cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
61218
diff
changeset
|
644 reproduce the original text. For instance, if you encode Latin-2 |
61218
59673cc65537
(Coding System Basics): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents:
61185
diff
changeset
|
645 characters with @code{utf-8} and decode the result using the same |
59673cc65537
(Coding System Basics): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents:
61185
diff
changeset
|
646 coding system, you'll get Unicode characters (of charset |
61233
5c7a0c8de2df
(Coding System Basics): Another cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
61218
diff
changeset
|
647 @code{mule-unicode-0100-24ff}). If you encode Unicode characters with |
5c7a0c8de2df
(Coding System Basics): Another cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
61218
diff
changeset
|
648 @code{iso-latin-2} and decode the result with the same coding system, |
5c7a0c8de2df
(Coding System Basics): Another cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
61218
diff
changeset
|
649 you'll get Latin-2 characters. |
61185
447c3b4db32f
(Coding System Basics): Describe about rondtrip
Kenichi Handa <handa@m17n.org>
parents:
60677
diff
changeset
|
650 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
651 @cindex end of line conversion |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
652 @dfn{End of line conversion} handles three different conventions used |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
653 on various systems for representing end of line in files. The Unix |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
654 convention is to use the linefeed character (also called newline). The |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
655 DOS convention is to use a carriage-return and a linefeed at the end of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
656 a line. The Mac convention is to use just carriage-return. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
657 |
21006 | 658 @cindex base coding system |
659 @cindex variant coding system | |
660 @dfn{Base coding systems} such as @code{latin-1} leave the end-of-line | |
661 conversion unspecified, to be chosen based on the data. @dfn{Variant | |
662 coding systems} such as @code{latin-1-unix}, @code{latin-1-dos} and | |
663 @code{latin-1-mac} specify the end-of-line conversion explicitly as | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
664 well. Most base coding systems have three corresponding variants whose |
21006 | 665 names are formed by adding @samp{-unix}, @samp{-dos} and @samp{-mac}. |
666 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
667 The coding system @code{raw-text} is special in that it prevents |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
668 character code conversion, and causes the buffer visited with that |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
669 coding system to be a unibyte buffer. It does not specify the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
670 end-of-line conversion, allowing that to be determined as usual by the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
671 data, and has the usual three variants which specify the end-of-line |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
672 conversion. @code{no-conversion} is equivalent to @code{raw-text-unix}: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
673 it specifies no conversion of either character codes or end-of-line. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
674 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
675 The coding system @code{emacs-mule} specifies that the data is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
676 represented in the internal Emacs encoding. This is like |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
677 @code{raw-text} in that no code conversion happens, but different in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
678 that the result is multibyte data. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
679 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
680 @defun coding-system-get coding-system property |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
681 This function returns the specified property of the coding system |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
682 @var{coding-system}. Most coding system properties exist for internal |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
683 purposes, but one that you might find useful is @code{mime-charset}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
684 That property's value is the name used in MIME for the character coding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
685 which this coding system can read and write. Examples: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
686 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
687 @example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
688 (coding-system-get 'iso-latin-1 'mime-charset) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
689 @result{} iso-8859-1 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
690 (coding-system-get 'iso-2022-cn 'mime-charset) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
691 @result{} iso-2022-cn |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
692 (coding-system-get 'cyrillic-koi8 'mime-charset) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
693 @result{} koi8-r |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
694 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
695 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
696 The value of the @code{mime-charset} property is also defined |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
697 as an alias for the coding system. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
698 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
699 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
700 @node Encoding and I/O |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
701 @subsection Encoding and I/O |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
702 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
703 The principal purpose of coding systems is for use in reading and |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
704 writing files. The function @code{insert-file-contents} uses |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
705 a coding system for decoding the file data, and @code{write-region} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
706 uses one to encode the buffer contents. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
707 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
708 You can specify the coding system to use either explicitly |
60501
ac9848689bc2
(Text Representations): Clarify position-bytes.
Richard M. Stallman <rms@gnu.org>
parents:
54036
diff
changeset
|
709 (@pxref{Specifying Coding Systems}), or implicitly using a default |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
710 mechanism (@pxref{Default Coding Systems}). But these methods may not |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
711 completely specify what to do. For example, they may choose a coding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
712 system such as @code{undefined} which leaves the character code |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
713 conversion to be determined from the data. In these cases, the I/O |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
714 operation finishes the job of choosing a coding system. Very often |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
715 you will want to find out afterwards which coding system was chosen. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
716 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
717 @defvar buffer-file-coding-system |
65369
822218f80ae4
2005-09-08 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64889
diff
changeset
|
718 This buffer-local variable records the coding system that was used to visit |
822218f80ae4
2005-09-08 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64889
diff
changeset
|
719 the current buffer. It is used for saving the buffer, and for writing part |
43632
faa7540b3866
(Encoding and I/O): Mention select-safe-coding-system in the documentation
Eli Zaretskii <eliz@gnu.org>
parents:
40855
diff
changeset
|
720 of the buffer with @code{write-region}. If the text to be written |
faa7540b3866
(Encoding and I/O): Mention select-safe-coding-system in the documentation
Eli Zaretskii <eliz@gnu.org>
parents:
40855
diff
changeset
|
721 cannot be safely encoded using the coding system specified by this |
faa7540b3866
(Encoding and I/O): Mention select-safe-coding-system in the documentation
Eli Zaretskii <eliz@gnu.org>
parents:
40855
diff
changeset
|
722 variable, these operations select an alternative encoding by calling |
faa7540b3866
(Encoding and I/O): Mention select-safe-coding-system in the documentation
Eli Zaretskii <eliz@gnu.org>
parents:
40855
diff
changeset
|
723 the function @code{select-safe-coding-system} (@pxref{User-Chosen |
faa7540b3866
(Encoding and I/O): Mention select-safe-coding-system in the documentation
Eli Zaretskii <eliz@gnu.org>
parents:
40855
diff
changeset
|
724 Coding Systems}). If selecting a different encoding requires to ask |
faa7540b3866
(Encoding and I/O): Mention select-safe-coding-system in the documentation
Eli Zaretskii <eliz@gnu.org>
parents:
40855
diff
changeset
|
725 the user to specify a coding system, @code{buffer-file-coding-system} |
faa7540b3866
(Encoding and I/O): Mention select-safe-coding-system in the documentation
Eli Zaretskii <eliz@gnu.org>
parents:
40855
diff
changeset
|
726 is updated to the newly selected coding system. |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
727 |
43632
faa7540b3866
(Encoding and I/O): Mention select-safe-coding-system in the documentation
Eli Zaretskii <eliz@gnu.org>
parents:
40855
diff
changeset
|
728 @code{buffer-file-coding-system} does @emph{not} affect sending text |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
729 to a subprocess. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
730 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
731 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
732 @defvar save-buffer-coding-system |
29265 | 733 This variable specifies the coding system for saving the buffer (by |
734 overriding @code{buffer-file-coding-system}). Note that it is not used | |
735 for @code{write-region}. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
736 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
737 When a command to save the buffer starts out to use |
29265 | 738 @code{buffer-file-coding-system} (or @code{save-buffer-coding-system}), |
739 and that coding system cannot handle | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
740 the actual text in the buffer, the command asks the user to choose |
43632
faa7540b3866
(Encoding and I/O): Mention select-safe-coding-system in the documentation
Eli Zaretskii <eliz@gnu.org>
parents:
40855
diff
changeset
|
741 another coding system (by calling @code{select-safe-coding-system}). |
faa7540b3866
(Encoding and I/O): Mention select-safe-coding-system in the documentation
Eli Zaretskii <eliz@gnu.org>
parents:
40855
diff
changeset
|
742 After that happens, the command also updates |
faa7540b3866
(Encoding and I/O): Mention select-safe-coding-system in the documentation
Eli Zaretskii <eliz@gnu.org>
parents:
40855
diff
changeset
|
743 @code{buffer-file-coding-system} to represent the coding system that |
faa7540b3866
(Encoding and I/O): Mention select-safe-coding-system in the documentation
Eli Zaretskii <eliz@gnu.org>
parents:
40855
diff
changeset
|
744 the user specified. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
745 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
746 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
747 @defvar last-coding-system-used |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
748 I/O operations for files and subprocesses set this variable to the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
749 coding system name that was used. The explicit encoding and decoding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
750 functions (@pxref{Explicit Encoding}) set it too. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
751 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
752 @strong{Warning:} Since receiving subprocess output sets this variable, |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
753 it can change whenever Emacs waits; therefore, you should copy the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
754 value shortly after the function call that stores the value you are |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
755 interested in. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
756 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
757 |
23110
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
758 The variable @code{selection-coding-system} specifies how to encode |
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
759 selections for the window system. @xref{Window System Selections}. |
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
760 |
53431
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
761 @defvar file-name-coding-system |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
762 The variable @code{file-name-coding-system} specifies the coding |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
763 system to use for encoding file names. Emacs encodes file names using |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
764 that coding system for all file operations. If |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
765 @code{file-name-coding-system} is @code{nil}, Emacs uses a default |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
766 coding system determined by the selected language environment. In the |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
767 default language environment, any non-@acronym{ASCII} characters in |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
768 file names are not encoded specially; they appear in the file system |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
769 using the internal Emacs representation. |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
770 @end defvar |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
771 |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
772 @strong{Warning:} if you change @code{file-name-coding-system} (or |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
773 the language environment) in the middle of an Emacs session, problems |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
774 can result if you have already visited files whose names were encoded |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
775 using the earlier coding system and are handled differently under the |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
776 new coding system. If you try to save one of these buffers under the |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
777 visited file name, saving may use the wrong file name, or it may get |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
778 an error. If such a problem happens, use @kbd{C-x C-w} to specify a |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
779 new file name for that buffer. |
3addbe38d8a6
(Converting Representations):
Richard M. Stallman <rms@gnu.org>
parents:
53302
diff
changeset
|
780 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
781 @node Lisp and Coding Systems |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
782 @subsection Coding Systems in Lisp |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
783 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
784 Here are the Lisp facilities for working with coding systems: |
21006 | 785 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
786 @defun coding-system-list &optional base-only |
21006 | 787 This function returns a list of all coding system names (symbols). If |
788 @var{base-only} is non-@code{nil}, the value includes only the | |
29265 | 789 base coding systems. Otherwise, it includes alias and variant coding |
790 systems as well. | |
21006 | 791 @end defun |
792 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
793 @defun coding-system-p object |
21006 | 794 This function returns @code{t} if @var{object} is a coding system |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
795 name or @code{nil}. |
21006 | 796 @end defun |
797 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
798 @defun check-coding-system coding-system |
21006 | 799 This function checks the validity of @var{coding-system}. |
800 If that is valid, it returns @var{coding-system}. | |
801 Otherwise it signals an error with condition @code{coding-system-error}. | |
802 @end defun | |
803 | |
70610
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
804 @cindex EOL conversion |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
805 @cindex end-of-line conversion |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
806 @cindex line end conversion |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
807 @defun coding-system-eol-type coding-system |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
808 This function returns the type of end-of-line (a.k.a.@: @dfn{eol}) |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
809 conversion used by @var{coding-system}. If @var{coding-system} |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
810 specifies a certain eol conversion, the return value is an integer 0, |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
811 1, or 2, standing for @code{unix}, @code{dos}, and @code{mac}, |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
812 respectively. If @var{coding-system} doesn't specify eol conversion |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
813 explicitly, the return value is a vector of coding systems, each one |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
814 with one of the possible eol conversion types, like this: |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
815 |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
816 @lisp |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
817 (coding-system-eol-type 'latin-1) |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
818 @result{} [latin-1-unix latin-1-dos latin-1-mac] |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
819 @end lisp |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
820 |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
821 @noindent |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
822 If this function returns a vector, Emacs will decide, as part of the |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
823 text encoding or decoding process, what eol conversion to use. For |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
824 decoding, the end-of-line format of the text is auto-detected, and the |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
825 eol conversion is set to match it (e.g., DOS-style CRLF format will |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
826 imply @code{dos} eol conversion). For encoding, the eol conversion is |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
827 taken from the appropriate default coding system (e.g., |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
828 @code{default-buffer-file-coding-system} for |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
829 @code{buffer-file-coding-system}), or from the default eol conversion |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
830 appropriate for the underlying platform. |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
831 @end defun |
d4b2c31464f8
(Lisp and Coding Systems): Document coding-system-eol-type. Add index entries
Eli Zaretskii <eliz@gnu.org>
parents:
70506
diff
changeset
|
832 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
833 @defun coding-system-change-eol-conversion coding-system eol-type |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
834 This function returns a coding system which is like @var{coding-system} |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
835 except for its eol conversion, which is specified by @code{eol-type}. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
836 @var{eol-type} should be @code{unix}, @code{dos}, @code{mac}, or |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
837 @code{nil}. If it is @code{nil}, the returned coding system determines |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
838 the end-of-line conversion from the data. |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
839 |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
840 @var{eol-type} may also be 0, 1 or 2, standing for @code{unix}, |
53302
ad4360363d82
Remove trailing whitespace
Luc Teirlinck <teirllm@auburn.edu>
parents:
53291
diff
changeset
|
841 @code{dos} and @code{mac}, respectively. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
842 @end defun |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
843 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
844 @defun coding-system-change-text-conversion eol-coding text-coding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
845 This function returns a coding system which uses the end-of-line |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
846 conversion of @var{eol-coding}, and the text conversion of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
847 @var{text-coding}. If @var{text-coding} is @code{nil}, it returns |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
848 @code{undecided}, or one of its variants according to @var{eol-coding}. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
849 @end defun |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
850 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
851 @defun find-coding-systems-region from to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
852 This function returns a list of coding systems that could be used to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
853 encode a text between @var{from} and @var{to}. All coding systems in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
854 the list can safely encode any multibyte characters in that portion of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
855 the text. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
856 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
857 If the text contains no multibyte characters, the function returns the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
858 list @code{(undecided)}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
859 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
860 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
861 @defun find-coding-systems-string string |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
862 This function returns a list of coding systems that could be used to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
863 encode the text of @var{string}. All coding systems in the list can |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
864 safely encode any multibyte characters in @var{string}. If the text |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
865 contains no multibyte characters, this returns the list |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
866 @code{(undecided)}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
867 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
868 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
869 @defun find-coding-systems-for-charsets charsets |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
870 This function returns a list of coding systems that could be used to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
871 encode all the character sets in the list @var{charsets}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
872 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
873 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
874 @defun detect-coding-region start end &optional highest |
21006 | 875 This function chooses a plausible coding system for decoding the text |
28877 | 876 from @var{start} to @var{end}. This text should be a byte sequence |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
877 (@pxref{Explicit Encoding}). |
21006 | 878 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
879 Normally this function returns a list of coding systems that could |
21006 | 880 handle decoding the text that was scanned. They are listed in order of |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
881 decreasing priority. But if @var{highest} is non-@code{nil}, then the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
882 return value is just one coding system, the one that is highest in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
883 priority. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
884 |
72551
ad9a6e48c18a
(Lisp and Coding Systems): Fix description of
Kenichi Handa <handa@m17n.org>
parents:
71700
diff
changeset
|
885 If the region contains only @acronym{ASCII} characters except for such |
ad9a6e48c18a
(Lisp and Coding Systems): Fix description of
Kenichi Handa <handa@m17n.org>
parents:
71700
diff
changeset
|
886 ISO-2022 control characters ISO-2022 as @code{ESC}, the value is |
ad9a6e48c18a
(Lisp and Coding Systems): Fix description of
Kenichi Handa <handa@m17n.org>
parents:
71700
diff
changeset
|
887 @code{undecided} or @code{(undecided)}, or a variant specifying |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
888 end-of-line conversion, if that can be deduced from the text. |
21006 | 889 @end defun |
890 | |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
891 @defun detect-coding-string string &optional highest |
21006 | 892 This function is like @code{detect-coding-region} except that it |
893 operates on the contents of @var{string} instead of bytes in the buffer. | |
894 @end defun | |
895 | |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
896 @xref{Coding systems for a subprocess,, Process Information}, in |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
897 particular the description of the functions |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
898 @code{process-coding-system} and @code{set-process-coding-system}, for |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
899 how to examine or set the coding systems used for I/O to a subprocess. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
900 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
901 @node User-Chosen Coding Systems |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
902 @subsection User-Chosen Coding Systems |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
903 |
43632
faa7540b3866
(Encoding and I/O): Mention select-safe-coding-system in the documentation
Eli Zaretskii <eliz@gnu.org>
parents:
40855
diff
changeset
|
904 @cindex select safe coding system |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
905 @defun select-safe-coding-system from to &optional default-coding-system accept-default-p file |
39204
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
906 This function selects a coding system for encoding specified text, |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
907 asking the user to choose if necessary. Normally the specified text |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
908 is the text in the current buffer between @var{from} and @var{to}. If |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
909 @var{from} is a string, the string specifies the text to encode, and |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
910 @var{to} is ignored. |
39204
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
911 |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
912 If @var{default-coding-system} is non-@code{nil}, that is the first |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
913 coding system to try; if that can handle the text, |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
914 @code{select-safe-coding-system} returns that coding system. It can |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
915 also be a list of coding systems; then the function tries each of them |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
916 one by one. After trying all of them, it next tries the current |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
917 buffer's value of @code{buffer-file-coding-system} (if it is not |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
918 @code{undecided}), then the value of |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
919 @code{default-buffer-file-coding-system} and finally the user's most |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
920 preferred coding system, which the user can set using the command |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
921 @code{prefer-coding-system} (@pxref{Recognize Coding,, Recognizing |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
922 Coding Systems, emacs, The GNU Emacs Manual}). |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
923 |
39204
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
924 If one of those coding systems can safely encode all the specified |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
925 text, @code{select-safe-coding-system} chooses it and returns it. |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
926 Otherwise, it asks the user to choose from a list of coding systems |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
927 which can encode all the text, and returns the user's choice. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
928 |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
929 @var{default-coding-system} can also be a list whose first element is |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
930 t and whose other elements are coding systems. Then, if no coding |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
931 system in the list can handle the text, @code{select-safe-coding-system} |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
932 queries the user immediately, without trying any of the three |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
933 alternatives described above. |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
934 |
39204
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
935 The optional argument @var{accept-default-p}, if non-@code{nil}, |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
936 should be a function to determine whether a coding system selected |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
937 without user interaction is acceptable. @code{select-safe-coding-system} |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
938 calls this function with one argument, the base coding system of the |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
939 selected coding system. If @var{accept-default-p} returns @code{nil}, |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
940 @code{select-safe-coding-system} rejects the silently selected coding |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
941 system, and asks the user to select a coding system from a list of |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
942 possible candidates. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
943 |
39204
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
944 @vindex select-safe-coding-system-accept-default-p |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
945 If the variable @code{select-safe-coding-system-accept-default-p} is |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
946 non-@code{nil}, its value overrides the value of |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
947 @var{accept-default-p}. |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
948 |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
949 As a final step, before returning the chosen coding system, |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
950 @code{select-safe-coding-system} checks whether that coding system is |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
951 consistent with what would be selected if the contents of the region |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
952 were read from a file. (If not, this could lead to data corruption in |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
953 a file subsequently re-visited and edited.) Normally, |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
954 @code{select-safe-coding-system} uses @code{buffer-file-name} as the |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
955 file for this purpose, but if @var{file} is non-@code{nil}, it uses |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
956 that file instead (this can be relevant for @code{write-region} and |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
957 similar functions). If it detects an apparent inconsistency, |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
958 @code{select-safe-coding-system} queries the user before selecting the |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
959 coding system. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
960 @end defun |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
961 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
962 Here are two functions you can use to let the user specify a coding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
963 system, with completion. @xref{Completion}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
964 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
965 @defun read-coding-system prompt &optional default |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
966 This function reads a coding system using the minibuffer, prompting with |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
967 string @var{prompt}, and returns the coding system name as a symbol. If |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
968 the user enters null input, @var{default} specifies which coding system |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
969 to return. It should be a symbol or a string. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
970 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
971 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
972 @defun read-non-nil-coding-system prompt |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
973 This function reads a coding system using the minibuffer, prompting with |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
974 string @var{prompt}, and returns the coding system name as a symbol. If |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
975 the user tries to enter null input, it asks the user to try again. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
976 @xref{Coding Systems}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
977 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
978 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
979 @node Default Coding Systems |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
980 @subsection Default Coding Systems |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
981 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
982 This section describes variables that specify the default coding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
983 system for certain files or when running certain subprograms, and the |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
984 function that I/O operations use to access them. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
985 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
986 The idea of these variables is that you set them once and for all to the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
987 defaults you want, and then do not change them again. To specify a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
988 particular coding system for a particular operation in a Lisp program, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
989 don't change these variables; instead, override them using |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
990 @code{coding-system-for-read} and @code{coding-system-for-write} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
991 (@pxref{Specifying Coding Systems}). |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
992 |
39204
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
993 @defvar auto-coding-regexp-alist |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
994 This variable is an alist of text patterns and corresponding coding |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
995 systems. Each element has the form @code{(@var{regexp} |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
996 . @var{coding-system})}; a file whose first few kilobytes match |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
997 @var{regexp} is decoded with @var{coding-system} when its contents are |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
998 read into a buffer. The settings in this alist take priority over |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
999 @code{coding:} tags in the files and the contents of |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
1000 @code{file-coding-system-alist} (see below). The default value is set |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
1001 so that Emacs automatically recognizes mail files in Babyl format and |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
1002 reads them with no code conversions. |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
1003 @end defvar |
8f8df4d24f48
(User-Chosen Coding Systems) <select-safe-coding-system>: Document
Eli Zaretskii <eliz@gnu.org>
parents:
35752
diff
changeset
|
1004 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1005 @defvar file-coding-system-alist |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1006 This variable is an alist that specifies the coding systems to use for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1007 reading and writing particular files. Each element has the form |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1008 @code{(@var{pattern} . @var{coding})}, where @var{pattern} is a regular |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1009 expression that matches certain file names. The element applies to file |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1010 names that match @var{pattern}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1011 |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1012 The @sc{cdr} of the element, @var{coding}, should be either a coding |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1013 system, a cons cell containing two coding systems, or a function name (a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1014 symbol with a function definition). If @var{coding} is a coding system, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1015 that coding system is used for both reading the file and writing it. If |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1016 @var{coding} is a cons cell containing two coding systems, its @sc{car} |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1017 specifies the coding system for decoding, and its @sc{cdr} specifies the |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1018 coding system for encoding. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1019 |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1020 If @var{coding} is a function name, the function should take one |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1021 argument, a list of all arguments passed to |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1022 @code{find-operation-coding-system}. It must return a coding system |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1023 or a cons cell containing two coding systems. This value has the same |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1024 meaning as described above. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1025 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1026 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1027 @defvar process-coding-system-alist |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1028 This variable is an alist specifying which coding systems to use for a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1029 subprocess, depending on which program is running in the subprocess. It |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1030 works like @code{file-coding-system-alist}, except that @var{pattern} is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1031 matched against the program name used to start the subprocess. The coding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1032 system or systems specified in this alist are used to initialize the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1033 coding systems used for I/O to the subprocess, but you can specify |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1034 other coding systems later using @code{set-process-coding-system}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1035 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1036 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1037 @strong{Warning:} Coding systems such as @code{undecided}, which |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1038 determine the coding system from the data, do not work entirely reliably |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1039 with asynchronous subprocess output. This is because Emacs handles |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1040 asynchronous subprocess output in batches, as it arrives. If the coding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1041 system leaves the character code conversion unspecified, or leaves the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1042 end-of-line conversion unspecified, Emacs must try to detect the proper |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1043 conversion from one batch at a time, and this does not always work. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1044 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1045 Therefore, with an asynchronous subprocess, if at all possible, use a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1046 coding system which determines both the character code conversion and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1047 the end of line conversion---that is, one like @code{latin-1-unix}, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1048 rather than @code{undecided} or @code{latin-1}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1049 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1050 @defvar network-coding-system-alist |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1051 This variable is an alist that specifies the coding system to use for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1052 network streams. It works much like @code{file-coding-system-alist}, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1053 with the difference that the @var{pattern} in an element may be either a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1054 port number or a regular expression. If it is a regular expression, it |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1055 is matched against the network service name used to open the network |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1056 stream. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1057 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1058 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1059 @defvar default-process-coding-system |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1060 This variable specifies the coding systems to use for subprocess (and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1061 network stream) input and output, when nothing else specifies what to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1062 do. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1063 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1064 The value should be a cons cell of the form @code{(@var{input-coding} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1065 . @var{output-coding})}. Here @var{input-coding} applies to input from |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1066 the subprocess, and @var{output-coding} applies to output to it. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1067 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1068 |
51990
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1069 @defvar auto-coding-functions |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1070 This variable holds a list of functions that try to determine a |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1071 coding system for a file based on its undecoded contents. |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1072 |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1073 Each function in this list should be written to look at text in the |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1074 current buffer, but should not modify it in any way. The buffer will |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1075 contain undecoded text of parts of the file. Each function should |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1076 take one argument, @var{size}, which tells it how many characters to |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1077 look at, starting from point. If the function succeeds in determining |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1078 a coding system for the file, it should return that coding system. |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1079 Otherwise, it should return @code{nil}. |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1080 |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1081 If a file has a @samp{coding:} tag, that takes precedence, so these |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1082 functions won't be called. |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1083 @end defvar |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1084 |
21006 | 1085 @defun find-operation-coding-system operation &rest arguments |
1086 This function returns the coding system to use (by default) for | |
1087 performing @var{operation} with @var{arguments}. The value has this | |
1088 form: | |
1089 | |
1090 @example | |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1091 (@var{decoding-system} . @var{encoding-system}) |
21006 | 1092 @end example |
1093 | |
1094 The first element, @var{decoding-system}, is the coding system to use | |
1095 for decoding (in case @var{operation} does decoding), and | |
1096 @var{encoding-system} is the coding system for encoding (in case | |
1097 @var{operation} does encoding). | |
1098 | |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
61233
diff
changeset
|
1099 The argument @var{operation} should be a symbol, any one of |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
61233
diff
changeset
|
1100 @code{insert-file-contents}, @code{write-region}, |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
61233
diff
changeset
|
1101 @code{start-process}, @code{call-process}, @code{call-process-region}, |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
61233
diff
changeset
|
1102 or @code{open-network-stream}. These are the names of the Emacs I/O |
71069
e212d28d8ffe
(Default Coding Systems): Fix it some more.
Eli Zaretskii <eliz@gnu.org>
parents:
71049
diff
changeset
|
1103 primitives that can do character code and eol conversion. |
21006 | 1104 |
1105 The remaining arguments should be the same arguments that might be given | |
71069
e212d28d8ffe
(Default Coding Systems): Fix it some more.
Eli Zaretskii <eliz@gnu.org>
parents:
71049
diff
changeset
|
1106 to the corresponding I/O primitive. Depending on the primitive, one |
e212d28d8ffe
(Default Coding Systems): Fix it some more.
Eli Zaretskii <eliz@gnu.org>
parents:
71049
diff
changeset
|
1107 of those arguments is selected as the @dfn{target}. For example, if |
21006 | 1108 @var{operation} does file I/O, whichever argument specifies the file |
1109 name is the target. For subprocess primitives, the process name is the | |
1110 target. For @code{open-network-stream}, the target is the service name | |
1111 or port number. | |
1112 | |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
61233
diff
changeset
|
1113 Depending on @var{operation}, this function looks up the target in |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
61233
diff
changeset
|
1114 @code{file-coding-system-alist}, @code{process-coding-system-alist}, |
71069
e212d28d8ffe
(Default Coding Systems): Fix it some more.
Eli Zaretskii <eliz@gnu.org>
parents:
71049
diff
changeset
|
1115 or @code{network-coding-system-alist}. If the target is found in the |
e212d28d8ffe
(Default Coding Systems): Fix it some more.
Eli Zaretskii <eliz@gnu.org>
parents:
71049
diff
changeset
|
1116 alist, @code{find-operation-coding-system} returns its association in |
e212d28d8ffe
(Default Coding Systems): Fix it some more.
Eli Zaretskii <eliz@gnu.org>
parents:
71049
diff
changeset
|
1117 the alist; otherwise it returns @code{nil}. |
71042
e4fb6bb5e7e5
(find-operation-coding-system): Describe the new
Kenichi Handa <handa@m17n.org>
parents:
70663
diff
changeset
|
1118 |
e4fb6bb5e7e5
(find-operation-coding-system): Describe the new
Kenichi Handa <handa@m17n.org>
parents:
70663
diff
changeset
|
1119 If @var{operation} is @code{insert-file-contents}, the argument |
e4fb6bb5e7e5
(find-operation-coding-system): Describe the new
Kenichi Handa <handa@m17n.org>
parents:
70663
diff
changeset
|
1120 corresponding to the target may be a cons cell of the form |
71049
2be0c252ff66
(Default Coding Systems): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents:
71042
diff
changeset
|
1121 @code{(@var{filename} . @var{buffer})}). In that case, @var{filename} |
71069
e212d28d8ffe
(Default Coding Systems): Fix it some more.
Eli Zaretskii <eliz@gnu.org>
parents:
71049
diff
changeset
|
1122 is a file name to look up in @code{file-coding-system-alist}, and |
71082
2a24c2deed9a
(Default Coding Systems): Further clarification.
Richard M. Stallman <rms@gnu.org>
parents:
71069
diff
changeset
|
1123 @var{buffer} is a buffer that contains the file's contents (not yet |
2a24c2deed9a
(Default Coding Systems): Further clarification.
Richard M. Stallman <rms@gnu.org>
parents:
71069
diff
changeset
|
1124 decoded). If @code{file-coding-system-alist} specifies a function to |
2a24c2deed9a
(Default Coding Systems): Further clarification.
Richard M. Stallman <rms@gnu.org>
parents:
71069
diff
changeset
|
1125 call for this file, and that function needs to examine the file's |
2a24c2deed9a
(Default Coding Systems): Further clarification.
Richard M. Stallman <rms@gnu.org>
parents:
71069
diff
changeset
|
1126 contents (as it usually does), it should examine the contents of |
2a24c2deed9a
(Default Coding Systems): Further clarification.
Richard M. Stallman <rms@gnu.org>
parents:
71069
diff
changeset
|
1127 @var{buffer} instead of reading the file. |
21006 | 1128 @end defun |
1129 | |
1130 @node Specifying Coding Systems | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1131 @subsection Specifying a Coding System for One Operation |
21006 | 1132 |
1133 You can specify the coding system for a specific operation by binding | |
1134 the variables @code{coding-system-for-read} and/or | |
1135 @code{coding-system-for-write}. | |
1136 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1137 @defvar coding-system-for-read |
21006 | 1138 If this variable is non-@code{nil}, it specifies the coding system to |
1139 use for reading a file, or for input from a synchronous subprocess. | |
1140 | |
1141 It also applies to any asynchronous subprocess or network stream, but in | |
1142 a different way: the value of @code{coding-system-for-read} when you | |
1143 start the subprocess or open the network stream specifies the input | |
1144 decoding method for that subprocess or network stream. It remains in | |
1145 use for that subprocess or network stream unless and until overridden. | |
1146 | |
1147 The right way to use this variable is to bind it with @code{let} for a | |
1148 specific I/O operation. Its global value is normally @code{nil}, and | |
1149 you should not globally set it to any other value. Here is an example | |
1150 of the right way to use the variable: | |
1151 | |
1152 @example | |
1153 ;; @r{Read the file with no character code conversion.} | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
1154 ;; @r{Assume @acronym{crlf} represents end-of-line.} |
54036
9706b0221102
(Translation of Characters): Give examples of use.
Richard M. Stallman <rms@gnu.org>
parents:
53431
diff
changeset
|
1155 (let ((coding-system-for-read 'emacs-mule-dos)) |
21006 | 1156 (insert-file-contents filename)) |
1157 @end example | |
1158 | |
1159 When its value is non-@code{nil}, @code{coding-system-for-read} takes | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1160 precedence over all other methods of specifying a coding system to use for |
21006 | 1161 input, including @code{file-coding-system-alist}, |
1162 @code{process-coding-system-alist} and | |
1163 @code{network-coding-system-alist}. | |
1164 @end defvar | |
1165 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1166 @defvar coding-system-for-write |
21006 | 1167 This works much like @code{coding-system-for-read}, except that it |
1168 applies to output rather than input. It affects writing to files, | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
1169 as well as sending output to subprocesses and net connections. |
21006 | 1170 |
1171 When a single operation does both input and output, as do | |
1172 @code{call-process-region} and @code{start-process}, both | |
1173 @code{coding-system-for-read} and @code{coding-system-for-write} | |
1174 affect it. | |
1175 @end defvar | |
1176 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1177 @defvar inhibit-eol-conversion |
21006 | 1178 When this variable is non-@code{nil}, no end-of-line conversion is done, |
1179 no matter which coding system is specified. This applies to all the | |
1180 Emacs I/O and subprocess primitives, and to the explicit encoding and | |
1181 decoding functions (@pxref{Explicit Encoding}). | |
1182 @end defvar | |
1183 | |
1184 @node Explicit Encoding | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1185 @subsection Explicit Encoding and Decoding |
21006 | 1186 @cindex encoding text |
1187 @cindex decoding text | |
1188 | |
1189 All the operations that transfer text in and out of Emacs have the | |
1190 ability to use a coding system to encode or decode the text. | |
1191 You can also explicitly encode and decode text using the functions | |
1192 in this section. | |
1193 | |
1194 The result of encoding, and the input to decoding, are not ordinary | |
28877 | 1195 text. They logically consist of a series of byte values; that is, a |
1196 series of characters whose codes are in the range 0 through 255. In a | |
1197 multibyte buffer or string, character codes 128 through 159 are | |
1198 represented by multibyte sequences, but this is invisible to Lisp | |
1199 programs. | |
21006 | 1200 |
28877 | 1201 The usual way to read a file into a buffer as a sequence of bytes, so |
1202 you can decode the contents explicitly, is with | |
1203 @code{insert-file-contents-literally} (@pxref{Reading from Files}); | |
1204 alternatively, specify a non-@code{nil} @var{rawfile} argument when | |
1205 visiting a file with @code{find-file-noselect}. These methods result in | |
1206 a unibyte buffer. | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
1207 |
28877 | 1208 The usual way to use the byte sequence that results from explicitly |
1209 encoding text is to copy it to a file or process---for example, to write | |
1210 it with @code{write-region} (@pxref{Writing to Files}), and suppress | |
1211 encoding by binding @code{coding-system-for-write} to | |
1212 @code{no-conversion}. | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
1213 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
1214 Here are the functions to perform explicit encoding or decoding. The |
70663
3854e2f08147
(Explicit Encoding): Fix typo (encoding<->decoding).
Kenichi Handa <handa@m17n.org>
parents:
70610
diff
changeset
|
1215 encoding functions produce sequences of bytes; the decoding functions |
28877 | 1216 are meant to operate on sequences of bytes. All of these functions |
1217 discard text properties. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1218 |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1219 @deffn Command encode-coding-region start end coding-system |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1220 This command encodes the text from @var{start} to @var{end} according |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1221 to coding system @var{coding-system}. The encoded text replaces the |
28877 | 1222 original text in the buffer. The result of encoding is logically a |
1223 sequence of bytes, but the buffer remains multibyte if it was multibyte | |
1224 before. | |
21006 | 1225 |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1226 This command returns the length of the encoded text. |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1227 @end deffn |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1228 |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1229 @defun encode-coding-string string coding-system &optional nocopy |
21006 | 1230 This function encodes the text in @var{string} according to coding |
1231 system @var{coding-system}. It returns a new string containing the | |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1232 encoded text, except when @var{nocopy} is non-@code{nil}, in which |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1233 case the function may return @var{string} itself if the encoding |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1234 operation is trivial. The result of encoding is a unibyte string. |
21006 | 1235 @end defun |
1236 | |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1237 @deffn Command decode-coding-region start end coding-system |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1238 This command decodes the text from @var{start} to @var{end} according |
21006 | 1239 to coding system @var{coding-system}. The decoded text replaces the |
1240 original text in the buffer. To make explicit decoding useful, the text | |
28877 | 1241 before decoding ought to be a sequence of byte values, but both |
1242 multibyte and unibyte buffers are acceptable. | |
21006 | 1243 |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1244 This command returns the length of the decoded text. |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1245 @end deffn |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1246 |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1247 @defun decode-coding-string string coding-system &optional nocopy |
21006 | 1248 This function decodes the text in @var{string} according to coding |
1249 system @var{coding-system}. It returns a new string containing the | |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1250 decoded text, except when @var{nocopy} is non-@code{nil}, in which |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1251 case the function may return @var{string} itself if the decoding |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1252 operation is trivial. To make explicit decoding useful, the contents |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1253 of @var{string} ought to be a sequence of byte values, but a multibyte |
28877 | 1254 string is acceptable. |
21006 | 1255 @end defun |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1256 |
51990
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1257 @defun decode-coding-inserted-region from to filename &optional visit beg end replace |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1258 This function decodes the text from @var{from} to @var{to} as if |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1259 it were being read from file @var{filename} using @code{insert-file-contents} |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1260 using the rest of the arguments provided. |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1261 |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1262 The normal way to use this function is after reading text from a file |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1263 without decoding, if you decide you would rather have decoded it. |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1264 Instead of deleting the text and reading it again, this time with |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1265 decoding, you can call this function. |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1266 @end defun |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1267 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1268 @node Terminal I/O Encoding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1269 @subsection Terminal I/O Encoding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1270 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1271 Emacs can decode keyboard input using a coding system, and encode |
23110
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
1272 terminal output. This is useful for terminals that transmit or display |
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
1273 text using a particular encoding such as Latin-1. Emacs does not set |
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
1274 @code{last-coding-system-used} for encoding or decoding for the |
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
1275 terminal. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1276 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1277 @defun keyboard-coding-system |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1278 This function returns the coding system that is in use for decoding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1279 keyboard input---or @code{nil} if no coding system is to be used. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1280 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1281 |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1282 @deffn Command set-keyboard-coding-system coding-system |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1283 This command specifies @var{coding-system} as the coding system to |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1284 use for decoding keyboard input. If @var{coding-system} is @code{nil}, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1285 that means do not decode keyboard input. |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1286 @end deffn |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1287 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1288 @defun terminal-coding-system |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1289 This function returns the coding system that is in use for encoding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1290 terminal output---or @code{nil} for no encoding. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1291 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1292 |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1293 @deffn Command set-terminal-coding-system coding-system |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1294 This command specifies @var{coding-system} as the coding system to use |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1295 for encoding terminal output. If @var{coding-system} is @code{nil}, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1296 that means do not encode terminal output. |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1297 @end deffn |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1298 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1299 @node MS-DOS File Types |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1300 @subsection MS-DOS File Types |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1301 @cindex DOS file types |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1302 @cindex MS-DOS file types |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1303 @cindex Windows file types |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1304 @cindex file types on MS-DOS and Windows |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1305 @cindex text files and binary files |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1306 @cindex binary files and text files |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1307 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1308 On MS-DOS and Microsoft Windows, Emacs guesses the appropriate |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1309 end-of-line conversion for a file by looking at the file's name. This |
28877 | 1310 feature classifies files as @dfn{text files} and @dfn{binary files}. By |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1311 ``binary file'' we mean a file of literal byte values that are not |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1312 necessarily meant to be characters; Emacs does no end-of-line conversion |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1313 and no character code conversion for them. On the other hand, the bytes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1314 in a text file are intended to represent characters; when you create a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1315 new file whose name implies that it is a text file, Emacs uses DOS |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1316 end-of-line conversion. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1317 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1318 @defvar buffer-file-type |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1319 This variable, automatically buffer-local in each buffer, records the |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1320 file type of the buffer's visited file. When a buffer does not specify |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1321 a coding system with @code{buffer-file-coding-system}, this variable is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1322 used to determine which coding system to use when writing the contents |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1323 of the buffer. It should be @code{nil} for text, @code{t} for binary. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1324 If it is @code{t}, the coding system is @code{no-conversion}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1325 Otherwise, @code{undecided-dos} is used. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1326 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1327 Normally this variable is set by visiting a file; it is set to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1328 @code{nil} if the file was visited without any actual conversion. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1329 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1330 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1331 @defopt file-name-buffer-file-type-alist |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1332 This variable holds an alist for recognizing text and binary files. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1333 Each element has the form (@var{regexp} . @var{type}), where |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1334 @var{regexp} is matched against the file name, and @var{type} may be |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1335 @code{nil} for text, @code{t} for binary, or a function to call to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1336 compute which. If it is a function, then it is called with a single |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1337 argument (the file name) and should return @code{t} or @code{nil}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1338 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1339 When running on MS-DOS or MS-Windows, Emacs checks this alist to decide |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1340 which coding system to use when reading a file. For a text file, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1341 @code{undecided-dos} is used. For a binary file, @code{no-conversion} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1342 is used. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1343 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1344 If no element in this alist matches a given file name, then |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1345 @code{default-buffer-file-type} says how to treat the file. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1346 @end defopt |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1347 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1348 @defopt default-buffer-file-type |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1349 This variable says how to handle files for which |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1350 @code{file-name-buffer-file-type-alist} says nothing about the type. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1351 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1352 If this variable is non-@code{nil}, then these files are treated as |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1353 binary: the coding system @code{no-conversion} is used. Otherwise, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1354 nothing special is done for them---the coding system is deduced solely |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1355 from the file contents, in the usual Emacs fashion. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1356 @end defopt |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1357 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1358 @node Input Methods |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1359 @section Input Methods |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1360 @cindex input methods |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1361 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
1362 @dfn{Input methods} provide convenient ways of entering non-@acronym{ASCII} |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1363 characters from the keyboard. Unlike coding systems, which translate |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52788
diff
changeset
|
1364 non-@acronym{ASCII} characters to and from encodings meant to be read by |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1365 programs, input methods provide human-friendly commands. (@xref{Input |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1366 Methods,,, emacs, The GNU Emacs Manual}, for information on how users |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1367 use input methods to enter text.) How to define input methods is not |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1368 yet documented in this manual, but here we describe how to use them. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1369 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1370 Each input method has a name, which is currently a string; |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1371 in the future, symbols may also be usable as input method names. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1372 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1373 @defvar current-input-method |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1374 This variable holds the name of the input method now active in the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1375 current buffer. (It automatically becomes local in each buffer when set |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1376 in any fashion.) It is @code{nil} if no input method is active in the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1377 buffer now. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1378 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1379 |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1380 @defopt default-input-method |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1381 This variable holds the default input method for commands that choose an |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1382 input method. Unlike @code{current-input-method}, this variable is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1383 normally global. |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1384 @end defopt |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1385 |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1386 @deffn Command set-input-method input-method |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1387 This command activates input method @var{input-method} for the current |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1388 buffer. It also sets @code{default-input-method} to @var{input-method}. |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1389 If @var{input-method} is @code{nil}, this command deactivates any input |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1390 method for the current buffer. |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1391 @end deffn |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1392 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1393 @defun read-input-method-name prompt &optional default inhibit-null |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1394 This function reads an input method name with the minibuffer, prompting |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1395 with @var{prompt}. If @var{default} is non-@code{nil}, that is returned |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1396 by default, if the user enters empty input. However, if |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1397 @var{inhibit-null} is non-@code{nil}, empty input signals an error. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1398 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1399 The returned value is a string. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1400 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1401 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1402 @defvar input-method-alist |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1403 This variable defines all the supported input methods. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1404 Each element defines one input method, and should have the form: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1405 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1406 @example |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1407 (@var{input-method} @var{language-env} @var{activate-func} |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1408 @var{title} @var{description} @var{args}...) |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1409 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1410 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1411 Here @var{input-method} is the input method name, a string; |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1412 @var{language-env} is another string, the name of the language |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1413 environment this input method is recommended for. (That serves only for |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1414 documentation purposes.) |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1415 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1416 @var{activate-func} is a function to call to activate this method. The |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1417 @var{args}, if any, are passed as arguments to @var{activate-func}. All |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1418 told, the arguments to @var{activate-func} are @var{input-method} and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1419 the @var{args}. |
28877 | 1420 |
1421 @var{title} is a string to display in the mode line while this method is | |
1422 active. @var{description} is a string describing this method and what | |
1423 it is good for. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1424 @end defvar |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1425 |
23110
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
1426 The fundamental interface to input methods is through the |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1427 variable @code{input-method-function}. @xref{Reading One Event}, |
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1428 and @ref{Invoking the Input Method}. |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1429 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1430 @node Locales |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1431 @section Locales |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1432 @cindex locale |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1433 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1434 POSIX defines a concept of ``locales'' which control which language |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1435 to use in language-related features. These Emacs variables control |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1436 how Emacs interacts with these features. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1437 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1438 @defvar locale-coding-system |
43634
f55024232f5d
(Locales): locale-coding-system is used for decoding keyboard input on X.
Eli Zaretskii <eliz@gnu.org>
parents:
43632
diff
changeset
|
1439 @cindex keyboard input decoding on X |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1440 This variable specifies the coding system to use for decoding system |
43634
f55024232f5d
(Locales): locale-coding-system is used for decoding keyboard input on X.
Eli Zaretskii <eliz@gnu.org>
parents:
43632
diff
changeset
|
1441 error messages and---on X Window system only---keyboard input, for |
f55024232f5d
(Locales): locale-coding-system is used for decoding keyboard input on X.
Eli Zaretskii <eliz@gnu.org>
parents:
43632
diff
changeset
|
1442 encoding the format argument to @code{format-time-string}, and for |
f55024232f5d
(Locales): locale-coding-system is used for decoding keyboard input on X.
Eli Zaretskii <eliz@gnu.org>
parents:
43632
diff
changeset
|
1443 decoding the return value of @code{format-time-string}. |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1444 @end defvar |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1445 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1446 @defvar system-messages-locale |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1447 This variable specifies the locale to use for generating system error |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1448 messages. Changing the locale can cause messages to come out in a |
27362
ce0641caaa76
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1449 different language or in a different orthography. If the variable is |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1450 @code{nil}, the locale is specified by environment variables in the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1451 usual POSIX fashion. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1452 @end defvar |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1453 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1454 @defvar system-time-locale |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1455 This variable specifies the locale to use for formatting time values. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1456 Changing the locale can cause messages to appear according to the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1457 conventions of a different language. If the variable is @code{nil}, the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1458 locale is specified by environment variables in the usual POSIX fashion. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1459 @end defvar |
28877 | 1460 |
51990
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1461 @defun locale-info item |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1462 This function returns locale data @var{item} for the current POSIX |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1463 locale, if available. @var{item} should be one of these symbols: |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1464 |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1465 @table @code |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1466 @item codeset |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1467 Return the character set as a string (locale item @code{CODESET}). |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1468 |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1469 @item days |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1470 Return a 7-element vector of day names (locale items |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1471 @code{DAY_1} through @code{DAY_7}); |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1472 |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1473 @item months |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1474 Return a 12-element vector of month names (locale items @code{MON_1} |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1475 through @code{MON_12}). |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1476 |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1477 @item paper |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1478 Return a list @code{(@var{width} @var{height})} for the default paper |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1479 size measured in millimeters (locale items @code{PAPER_WIDTH} and |
51990
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1480 @code{PAPER_HEIGHT}). |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1481 @end table |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1482 |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1483 If the system can't provide the requested information, or if |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1484 @var{item} is not one of those symbols, the value is @code{nil}. All |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1485 strings in the return value are decoded using |
53291
04d2bf306bd2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
1486 @code{locale-coding-system}. @xref{Locales,,, libc, The GNU Libc Manual}, |
51990
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1487 for more information about locales and locale items. |
3e55792cc7f1
(Converting Representations): Add string-to-multibyte.
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1488 @end defun |
52401 | 1489 |
1490 @ignore | |
1491 arch-tag: be705bf8-941b-4c35-84fc-ad7d20ddb7cb | |
1492 @end ignore |