Mercurial > emacs
annotate lispref/nonascii.texi @ 28043:6070092c3b29
*** empty log message ***
author | Dave Love <fx@gnu.org> |
---|---|
date | Tue, 07 Mar 2000 20:31:06 +0000 |
parents | 0f5edee5242b |
children | cda2b6ed6aec |
rev | line source |
---|---|
21006 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
27189 | 3 @c Copyright (C) 1998, 1999 Free Software Foundation, Inc. |
21006 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/characters | |
6 @node Non-ASCII Characters, Searching and Matching, Text, Top | |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27362
diff
changeset
|
7 @chapter Non-@sc{ascii} Characters |
21006 | 8 @cindex multibyte characters |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27362
diff
changeset
|
9 @cindex non-@sc{ascii} characters |
21006 | 10 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
11 This chapter covers the special issues relating to non-@sc{ascii} |
21006 | 12 characters and how they are stored in strings and buffers. |
13 | |
14 @menu | |
15 * Text Representations:: | |
16 * Converting Representations:: | |
17 * Selecting a Representation:: | |
18 * Character Codes:: | |
19 * Character Sets:: | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
20 * Chars and Bytes:: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
21 * Splitting Characters:: |
21006 | 22 * Scanning Charsets:: |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
23 * Translation of Characters:: |
21006 | 24 * Coding Systems:: |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
25 * Input Methods:: |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
26 * Locales:: Interacting with the POSIX locale. |
21006 | 27 @end menu |
28 | |
29 @node Text Representations | |
30 @section Text Representations | |
31 @cindex text representations | |
32 | |
33 Emacs has two @dfn{text representations}---two ways to represent text | |
34 in a string or buffer. These are called @dfn{unibyte} and | |
35 @dfn{multibyte}. Each string, and each buffer, uses one of these two | |
36 representations. For most purposes, you can ignore the issue of | |
37 representations, because Emacs converts text between them as | |
38 appropriate. Occasionally in Lisp programming you will need to pay | |
39 attention to the difference. | |
40 | |
41 @cindex unibyte text | |
42 In unibyte representation, each character occupies one byte and | |
43 therefore the possible character codes range from 0 to 255. Codes 0 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
44 through 127 are @sc{ascii} characters; the codes from 128 through 255 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
45 are used for one non-@sc{ascii} character set (you can choose which |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
46 character set by setting the variable @code{nonascii-insert-offset}). |
21006 | 47 |
48 @cindex leading code | |
49 @cindex multibyte text | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
50 @cindex trailing codes |
21006 | 51 In multibyte representation, a character may occupy more than one |
52 byte, and as a result, the full range of Emacs character codes can be | |
53 stored. The first byte of a multibyte character is always in the range | |
54 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
|
55 @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
|
56 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
|
57 0377); these values are @dfn{trailing codes}. |
21006 | 58 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
59 Some sequences of bytes do not form meaningful multibyte characters: |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
60 for example, a single isolated byte in the range 128 through 255 is |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
61 never meaningful. Such byte sequences are not entirely valid, and never |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
62 appear in proper multibyte text (since that consists of a sequence of |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
63 @emph{characters}); but they can appear as part of ``raw bytes'' |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
64 (@pxref{Explicit Encoding}). |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
65 |
21006 | 66 In a buffer, the buffer-local value of the variable |
67 @code{enable-multibyte-characters} specifies the representation used. | |
24952 | 68 The representation for a string is determined and recorded in the string |
69 when the string is constructed. | |
21006 | 70 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
71 @defvar enable-multibyte-characters |
21006 | 72 This variable specifies the current buffer's text representation. |
73 If it is non-@code{nil}, the buffer contains multibyte text; otherwise, | |
74 it contains unibyte text. | |
75 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
76 You cannot set this variable directly; instead, use the function |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
77 @code{set-buffer-multibyte} to change a buffer's representation. |
21006 | 78 @end defvar |
79 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
80 @defvar default-enable-multibyte-characters |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
81 This variable's value is entirely equivalent to @code{(default-value |
21006 | 82 'enable-multibyte-characters)}, and setting this variable changes that |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
83 default value. Setting the local binding of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
84 @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
|
85 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
|
86 thing to do, because it has no effect on existing buffers. |
21006 | 87 |
88 The @samp{--unibyte} command line option does its job by setting the | |
89 default value to @code{nil} early in startup. | |
90 @end defvar | |
91 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
92 @defun position-bytes position |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
93 @tindex position-bytes |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
94 Return the byte-position corresponding to buffer position @var{position} |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
95 in the current buffer. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
96 @end defun |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
97 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
98 @defun byte-to-position byte-position |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
99 @tindex byte-to-position |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
100 Return the buffer position corresponding to byte-position |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
101 @var{byte-position} in the current buffer. |
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 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
104 @defun multibyte-string-p string |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
105 Return @code{t} if @var{string} is a multibyte string. |
21006 | 106 @end defun |
107 | |
108 @node Converting Representations | |
109 @section Converting Text Representations | |
110 | |
111 Emacs can convert unibyte text to multibyte; it can also convert | |
112 multibyte text to unibyte, though this conversion loses information. In | |
113 general these conversions happen when inserting text into a buffer, or | |
114 when putting text from several strings together in one string. You can | |
115 also explicitly convert a string's contents to either representation. | |
116 | |
117 Emacs chooses the representation for a string based on the text that | |
118 it is constructed from. The general rule is to convert unibyte text to | |
119 multibyte text when combining it with other multibyte text, because the | |
120 multibyte representation is more general and can hold whatever | |
121 characters the unibyte text has. | |
122 | |
123 When inserting text into a buffer, Emacs converts the text to the | |
124 buffer's representation, as specified by | |
125 @code{enable-multibyte-characters} in that buffer. In particular, when | |
126 you insert multibyte text into a unibyte buffer, Emacs converts the text | |
127 to unibyte, even though this conversion cannot in general preserve all | |
128 the characters that might be in the multibyte text. The other natural | |
129 alternative, to convert the buffer contents to multibyte, is not | |
130 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
|
131 user that cannot be overridden automatically. |
21006 | 132 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
133 Converting unibyte text to multibyte text leaves @sc{ascii} characters |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
134 unchanged, and likewise 128 through 159. It converts the non-@sc{ascii} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
135 codes 160 through 255 by adding the value @code{nonascii-insert-offset} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
136 to each character code. By setting this variable, you specify which |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
137 character set the unibyte characters correspond to (@pxref{Character |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
138 Sets}). For example, if @code{nonascii-insert-offset} is 2048, which is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
139 @code{(- (make-char 'latin-iso8859-1) 128)}, then the unibyte |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
140 non-@sc{ascii} characters correspond to Latin 1. If it is 2688, which |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
141 is @code{(- (make-char 'greek-iso8859-7) 128)}, then they correspond to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
142 Greek letters. |
21006 | 143 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
144 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
|
145 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
|
146 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
|
147 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
|
148 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
|
149 text. |
21006 | 150 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
151 @defvar nonascii-insert-offset |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
152 This variable specifies the amount to add to a non-@sc{ascii} character |
21006 | 153 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
|
154 @code{self-insert-command} inserts a character in the unibyte |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
155 non-@sc{ascii} range, 128 through 255. However, the function |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
156 @code{insert-char} does not perform this conversion. |
21006 | 157 |
158 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
|
159 (make-char @var{cs}) 128)}. If the value of |
21006 | 160 @code{nonascii-insert-offset} is zero, then conversion actually uses the |
161 value for the Latin 1 character set, rather than zero. | |
162 @end defvar | |
163 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
164 @defvar nonascii-translation-table |
21006 | 165 This variable provides a more general alternative to |
166 @code{nonascii-insert-offset}. You can use it to specify independently | |
167 how to translate each code in the range of 128 through 255 into a | |
168 multibyte character. The value should be a vector, or @code{nil}. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
169 If this is non-@code{nil}, it overrides @code{nonascii-insert-offset}. |
21006 | 170 @end defvar |
171 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
172 @defun string-make-unibyte string |
21006 | 173 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
|
174 representation, if it isn't already, and returns the result. If |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
175 @var{string} is a unibyte string, it is returned unchanged. |
21006 | 176 @end defun |
177 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
178 @defun string-make-multibyte string |
21006 | 179 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
|
180 representation, if it isn't already, and returns the result. If |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
181 @var{string} is a multibyte string, it is returned unchanged. |
21006 | 182 @end defun |
183 | |
184 @node Selecting a Representation | |
185 @section Selecting a Representation | |
186 | |
187 Sometimes it is useful to examine an existing buffer or string as | |
188 multibyte when it was unibyte, or vice versa. | |
189 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
190 @defun set-buffer-multibyte multibyte |
21006 | 191 Set the representation type of the current buffer. If @var{multibyte} |
192 is non-@code{nil}, the buffer becomes multibyte. If @var{multibyte} | |
193 is @code{nil}, the buffer becomes unibyte. | |
194 | |
195 This function leaves the buffer contents unchanged when viewed as a | |
196 sequence of bytes. As a consequence, it can change the contents viewed | |
197 as characters; a sequence of two bytes which is treated as one character | |
198 in multibyte representation will count as two characters in unibyte | |
199 representation. | |
200 | |
201 This function sets @code{enable-multibyte-characters} to record which | |
202 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
|
203 (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
|
204 same text as they did before. |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
205 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
206 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
|
207 because indirect buffers always inherit the representation of the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
208 base buffer. |
21006 | 209 @end defun |
210 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
211 @defun string-as-unibyte string |
21006 | 212 This function returns a string with the same bytes as @var{string} but |
213 treating each byte as a character. This means that the value may have | |
214 more characters than @var{string} has. | |
215 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
216 If @var{string} is already a unibyte string, then the value is |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
217 @var{string} itself. |
21006 | 218 @end defun |
219 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
220 @defun string-as-multibyte string |
21006 | 221 This function returns a string with the same bytes as @var{string} but |
222 treating each multibyte sequence as one character. This means that the | |
223 value may have fewer characters than @var{string} has. | |
224 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
225 If @var{string} is already a multibyte string, then the value is |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
226 @var{string} itself. |
21006 | 227 @end defun |
228 | |
229 @node Character Codes | |
230 @section Character Codes | |
231 @cindex character codes | |
232 | |
233 The unibyte and multibyte text representations use different character | |
234 codes. The valid character codes for unibyte representation range from | |
235 0 to 255---the values that can fit in one byte. The valid character | |
236 codes for multibyte representation range from 0 to 524287, but not all | |
237 values in that range are valid. In particular, the values 128 through | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
238 255 are not legitimate in multibyte text (though they can occur in ``raw |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
239 bytes''; @pxref{Explicit Encoding}). Only the @sc{ascii} codes 0 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
240 through 127 are fully legitimate in both representations. |
21006 | 241 |
242 @defun char-valid-p charcode | |
243 This returns @code{t} if @var{charcode} is valid for either one of the two | |
244 text representations. | |
245 | |
246 @example | |
247 (char-valid-p 65) | |
248 @result{} t | |
249 (char-valid-p 256) | |
250 @result{} nil | |
251 (char-valid-p 2248) | |
252 @result{} t | |
253 @end example | |
254 @end defun | |
255 | |
256 @node Character Sets | |
257 @section Character Sets | |
258 @cindex character sets | |
259 | |
260 Emacs classifies characters into various @dfn{character sets}, each of | |
261 which has a name which is a symbol. Each character belongs to one and | |
262 only one character set. | |
263 | |
264 In general, there is one character set for each distinct script. For | |
265 example, @code{latin-iso8859-1} is one character set, | |
266 @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
|
267 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
|
268 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
|
269 into several character sets. For example, one set of Chinese |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
270 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
|
271 character sets, @code{chinese-big5-1} and @code{chinese-big5-2}. |
21006 | 272 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
273 @defun charsetp object |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
274 Returns @code{t} if @var{object} is a symbol that names a character set, |
21006 | 275 @code{nil} otherwise. |
276 @end defun | |
277 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
278 @defun charset-list |
21006 | 279 This function returns a list of all defined character set names. |
280 @end defun | |
281 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
282 @defun char-charset character |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
283 This function returns the name of the character set that @var{character} |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
284 belongs to. |
21006 | 285 @end defun |
286 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
287 @defun charset-plist charset |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
288 @tindex charset-plist |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
289 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
|
290 @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
|
291 as the property list of that symbol. Charset properties are used for |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
292 special purposes within Emacs; for example, @code{x-charset-registry} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
293 helps determine which fonts to use (@pxref{Font Selection}). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
294 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
295 |
21006 | 296 @node Chars and Bytes |
297 @section Characters and Bytes | |
298 @cindex bytes and characters | |
299 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
300 @cindex introduction sequence |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
301 @cindex dimension (of character set) |
21006 | 302 In multibyte representation, each character occupies one or more |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
303 bytes. Each character set has an @dfn{introduction sequence}, which is |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
304 normally one or two bytes long. (Exception: the @sc{ascii} character |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
305 set has a zero-length introduction sequence.) The introduction sequence |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
306 is the beginning of the byte sequence for any character in the character |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
307 set. The rest of the character's bytes distinguish it from the other |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
308 characters in the same character set. Depending on the character set, |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
309 there are either one or two distinguishing bytes; the number of such |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
310 bytes is called the @dfn{dimension} of the character set. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
311 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
312 @defun charset-dimension charset |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
313 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
|
314 dimension is always 1 or 2. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
315 @end defun |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
316 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
317 @defun charset-bytes charset |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
318 @tindex charset-bytes |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
319 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
|
320 in character set @var{charset}. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
321 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
322 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
323 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
|
324 set's introduction sequence: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
325 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
326 @example |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
327 (- (charset-bytes @var{charset}) |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
328 (charset-dimension @var{charset})) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
329 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
330 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
331 @node Splitting Characters |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
332 @section Splitting Characters |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
333 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
334 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
|
335 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
|
336 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
|
337 because Emacs translates automatically when necessary. |
21006 | 338 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
339 @defun split-char character |
21006 | 340 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
|
341 @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
|
342 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
|
343 values is the character set's dimension. |
21006 | 344 |
345 @example | |
346 (split-char 2248) | |
347 @result{} (latin-iso8859-1 72) | |
348 (split-char 65) | |
349 @result{} (ascii 65) | |
350 @end example | |
351 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
352 Unibyte non-@sc{ascii} characters are considered as part of |
21006 | 353 the @code{ascii} character set: |
354 | |
355 @example | |
356 (split-char 192) | |
357 @result{} (ascii 192) | |
358 @end example | |
359 @end defun | |
360 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
361 @defun make-char charset &rest byte-values |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
362 This function returns the character in character set @var{charset} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
363 identified by @var{byte-values}. This is roughly the inverse of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
364 @code{split-char}. Normally, you should specify either one or two |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
365 @var{byte-values}, according to the dimension of @var{charset}. For |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
366 example, |
21006 | 367 |
368 @example | |
369 (make-char 'latin-iso8859-1 72) | |
370 @result{} 2248 | |
371 @end example | |
372 @end defun | |
373 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
374 @cindex generic characters |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
375 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
|
376 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
|
377 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
|
378 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
|
379 refer to the whole character set (@pxref{Char-Tables}). |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
380 @code{char-valid-p} returns @code{nil} for generic characters. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
381 For example: |
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 @example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
384 (make-char 'latin-iso8859-1) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
385 @result{} 2176 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
386 (char-valid-p 2176) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
387 @result{} nil |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
388 (split-char 2176) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
389 @result{} (latin-iso8859-1 0) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
390 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
391 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
392 @node Scanning Charsets |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
393 @section Scanning for Character Sets |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
394 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
395 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
|
396 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
|
397 coding systems (@pxref{Coding Systems}) are capable of representing all |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
398 of the text in question. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
399 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
400 @defun find-charset-region beg end &optional translation |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
401 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
|
402 current buffer between positions @var{beg} and @var{end}. |
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 optional argument @var{translation} specifies a translation table to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
405 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
|
406 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
|
407 through this table, and the value returned describes the translated |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
408 characters instead of the characters actually in the buffer. |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
409 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
410 In two peculiar cases, the value includes the symbol @code{unknown}: |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
411 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
412 @itemize @bullet |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
413 @item |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
414 When a unibyte buffer contains non-@sc{ascii} characters. |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
415 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
416 @item |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
417 When a multibyte buffer contains invalid byte-sequences (raw bytes). |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
418 @xref{Explicit Encoding}. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
419 @end itemize |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
420 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
421 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
422 @defun find-charset-string string &optional translation |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
423 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
|
424 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
|
425 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
|
426 current buffer. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
427 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
428 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
429 @node Translation of Characters |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
430 @section Translation of Characters |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
431 @cindex character translation tables |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
432 @cindex translation tables |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
433 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
434 A @dfn{translation table} specifies a mapping of characters |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
435 into characters. These tables are used in encoding and decoding, and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
436 for other purposes. Some coding systems specify their own particular |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
437 translation tables; there are also default translation tables which |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
438 apply to all other coding systems. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
439 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
440 @defun make-translation-table &rest translations |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
441 This function returns a translation table based on the argument |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
442 @var{translations}. Each element of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
443 @var{translations} should be a list of the form @code{(@var{from} |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
444 . @var{to})}; this says to translate the character @var{from} into |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
445 @var{to}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
446 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
447 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
|
448 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
|
449 designates a character set) for @var{from} (@pxref{Splitting Characters}). |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
450 In this case, @var{to} should also be a generic character, for another |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
451 character set of the same dimension. Then the translation table |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
452 translates each character of @var{from}'s character set into the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
453 corresponding character of @var{to}'s character set. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
454 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
455 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
456 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
|
457 characters that result from ordinary decoding. If a coding system has |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
458 property @code{character-translation-table-for-decode}, that specifies |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
459 the translation table to use. Otherwise, if |
23433
a53274056f20
Fix names of standard-translation-table-for-decode(encode).
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
460 @code{standard-translation-table-for-decode} is non-@code{nil}, decoding |
a53274056f20
Fix names of standard-translation-table-for-decode(encode).
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
461 uses that table. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
462 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
463 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
|
464 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
|
465 encoded. If a coding system has property |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
466 @code{character-translation-table-for-encode}, that specifies the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
467 translation 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
|
468 @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
|
469 table. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
470 |
23433
a53274056f20
Fix names of standard-translation-table-for-decode(encode).
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
471 @defvar standard-translation-table-for-decode |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
472 This is the default translation table for decoding, for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
473 coding systems that don't specify any other translation table. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
474 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
475 |
23433
a53274056f20
Fix names of standard-translation-table-for-decode(encode).
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
476 @defvar standard-translation-table-for-encode |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
477 This is the default translation table for encoding, for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
478 coding systems that don't specify any other translation table. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
479 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
480 |
21006 | 481 @node Coding Systems |
482 @section Coding Systems | |
483 | |
484 @cindex coding system | |
485 When Emacs reads or writes a file, and when Emacs sends text to a | |
486 subprocess or receives text from a subprocess, it normally performs | |
487 character code conversion and end-of-line conversion as specified | |
488 by a particular @dfn{coding system}. | |
489 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
490 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
|
491 documented here. |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
492 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
493 @menu |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
494 * Coding System Basics:: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
495 * Encoding and I/O:: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
496 * Lisp and Coding Systems:: |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
497 * User-Chosen Coding Systems:: |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
498 * Default Coding Systems:: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
499 * Specifying Coding Systems:: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
500 * Explicit Encoding:: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
501 * Terminal I/O Encoding:: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
502 * MS-DOS File Types:: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
503 @end menu |
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 Coding System Basics |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
506 @subsection Basic Concepts of Coding Systems |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
507 |
21006 | 508 @cindex character code conversion |
509 @dfn{Character code conversion} involves conversion between the encoding | |
510 used inside Emacs and some other encoding. Emacs supports many | |
511 different encodings, in that it can convert to and from them. For | |
512 example, it can convert text to or from encodings such as Latin 1, Latin | |
513 2, Latin 3, Latin 4, Latin 5, and several variants of ISO 2022. In some | |
514 cases, Emacs supports several alternative encodings for the same | |
515 characters; for example, there are three coding systems for the Cyrillic | |
516 (Russian) alphabet: ISO, Alternativnyj, and KOI8. | |
517 | |
518 Most coding systems specify a particular character code for | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
519 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
|
520 heuristically for each file, based on the data. |
21006 | 521 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
522 @cindex end of line conversion |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
523 @dfn{End of line conversion} handles three different conventions used |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
524 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
|
525 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
|
526 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
|
527 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
|
528 |
21006 | 529 @cindex base coding system |
530 @cindex variant coding system | |
531 @dfn{Base coding systems} such as @code{latin-1} leave the end-of-line | |
532 conversion unspecified, to be chosen based on the data. @dfn{Variant | |
533 coding systems} such as @code{latin-1-unix}, @code{latin-1-dos} and | |
534 @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
|
535 well. Most base coding systems have three corresponding variants whose |
21006 | 536 names are formed by adding @samp{-unix}, @samp{-dos} and @samp{-mac}. |
537 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
538 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
|
539 character code conversion, and causes the buffer visited with that |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
540 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
|
541 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
|
542 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
|
543 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
|
544 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
|
545 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
546 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
|
547 represented in the internal Emacs encoding. This is like |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
548 @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
|
549 that the result is multibyte data. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
550 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
551 @defun coding-system-get coding-system property |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
552 This function returns the specified property of the coding system |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
553 @var{coding-system}. Most coding system properties exist for internal |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
554 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
|
555 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
|
556 which this coding system can read and write. Examples: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
557 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
558 @example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
559 (coding-system-get 'iso-latin-1 'mime-charset) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
560 @result{} iso-8859-1 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
561 (coding-system-get 'iso-2022-cn 'mime-charset) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
562 @result{} iso-2022-cn |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
563 (coding-system-get 'cyrillic-koi8 'mime-charset) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
564 @result{} koi8-r |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
565 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
566 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
567 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
|
568 as an alias for the coding system. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
569 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
570 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
571 @node Encoding and I/O |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
572 @subsection Encoding and I/O |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
573 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
574 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
|
575 writing files. The function @code{insert-file-contents} uses |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
576 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
|
577 uses one to encode the buffer contents. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
578 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
579 You can specify the coding system to use either explicitly |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
580 (@pxref{Specifying Coding Systems}), or implicitly using the defaulting |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
581 mechanism (@pxref{Default Coding Systems}). But these methods may not |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
582 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
|
583 system such as @code{undefined} which leaves the character code |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
584 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
|
585 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
|
586 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
|
587 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
588 @defvar buffer-file-coding-system |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
589 This variable records the coding system that was used for visiting the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
590 current buffer. It is used for saving the buffer, and for writing part |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
591 of the buffer with @code{write-region}. When those operations ask the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
592 user to specify a different coding system, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
593 @code{buffer-file-coding-system} is updated to the coding system |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
594 specified. |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
595 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
596 However, @code{buffer-file-coding-system} does not affect sending text |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
597 to a subprocess. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
598 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
599 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
600 @defvar save-buffer-coding-system |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
601 This variable specifies the coding system for saving the buffer---but it |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
602 is not used for @code{write-region}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
603 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
604 When a command to save the buffer starts out to use |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
605 @code{save-buffer-coding-system}, and that coding system cannot handle |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
606 the actual text in the buffer, the command asks the user to choose |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
607 another coding system. After that happens, the command also updates |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
608 @code{save-buffer-coding-system} to represent the coding system that the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
609 user specified. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
610 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
611 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
612 @defvar last-coding-system-used |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
613 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
|
614 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
|
615 functions (@pxref{Explicit Encoding}) set it too. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
616 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
617 @strong{Warning:} Since receiving subprocess output sets this variable, |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
618 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
|
619 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
|
620 interested in. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
621 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
622 |
23110
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
623 The variable @code{selection-coding-system} specifies how to encode |
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
624 selections for the window system. @xref{Window System Selections}. |
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
625 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
626 @node Lisp and Coding Systems |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
627 @subsection Coding Systems in Lisp |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
628 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
629 Here are the Lisp facilities for working with coding systems: |
21006 | 630 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
631 @defun coding-system-list &optional base-only |
21006 | 632 This function returns a list of all coding system names (symbols). If |
633 @var{base-only} is non-@code{nil}, the value includes only the | |
634 base coding systems. Otherwise, it includes variant coding systems as well. | |
635 @end defun | |
636 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
637 @defun coding-system-p object |
21006 | 638 This function returns @code{t} if @var{object} is a coding system |
639 name. | |
640 @end defun | |
641 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
642 @defun check-coding-system coding-system |
21006 | 643 This function checks the validity of @var{coding-system}. |
644 If that is valid, it returns @var{coding-system}. | |
645 Otherwise it signals an error with condition @code{coding-system-error}. | |
646 @end defun | |
647 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
648 @defun coding-system-change-eol-conversion coding-system eol-type |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
649 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
|
650 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
|
651 @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
|
652 @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
|
653 the end-of-line conversion from the data. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
654 @end defun |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
655 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
656 @defun coding-system-change-text-conversion eol-coding text-coding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
657 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
|
658 conversion of @var{eol-coding}, and the text conversion of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
659 @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
|
660 @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
|
661 @end defun |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
662 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
663 @defun find-coding-systems-region from to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
664 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
|
665 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
|
666 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
|
667 the text. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
668 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
669 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
|
670 list @code{(undecided)}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
671 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
672 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
673 @defun find-coding-systems-string string |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
674 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
|
675 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
|
676 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
|
677 contains no multibyte characters, this returns the list |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
678 @code{(undecided)}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
679 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
680 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
681 @defun find-coding-systems-for-charsets charsets |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
682 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
|
683 encode all the character sets in the list @var{charsets}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
684 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
685 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
686 @defun detect-coding-region start end &optional highest |
21006 | 687 This function chooses a plausible coding system for decoding the text |
688 from @var{start} to @var{end}. This text should be ``raw bytes'' | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
689 (@pxref{Explicit Encoding}). |
21006 | 690 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
691 Normally this function returns a list of coding systems that could |
21006 | 692 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
|
693 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
|
694 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
|
695 priority. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
696 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
697 If the region contains only @sc{ascii} characters, the value |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
698 is @code{undecided} or @code{(undecided)}. |
21006 | 699 @end defun |
700 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
701 @defun detect-coding-string string highest |
21006 | 702 This function is like @code{detect-coding-region} except that it |
703 operates on the contents of @var{string} instead of bytes in the buffer. | |
704 @end defun | |
705 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
706 @xref{Process Information}, for how to examine or set the coding |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
707 systems used for I/O to a subprocess. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
708 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
709 @node User-Chosen Coding Systems |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
710 @subsection User-Chosen Coding Systems |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
711 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
712 @defun select-safe-coding-system from to &optional preferred-coding-system |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
713 This function selects a coding system for encoding the text between |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
714 @var{from} and @var{to}, asking the user to choose if necessary. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
715 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
716 The optional argument @var{preferred-coding-system} specifies a coding |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
717 system to try first. If that one can handle the text in the specified |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
718 region, then it is used. If this argument is omitted, the current |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
719 buffer's value of @code{buffer-file-coding-system} is tried first. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
720 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
721 If the region contains some multibyte characters that the preferred |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
722 coding system cannot encode, this function asks the user to choose from |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
723 a list of coding systems which can encode the text, and returns the |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
724 user's choice. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
725 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
726 One other kludgy feature: if @var{from} is a string, the string is the |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
727 target text, and @var{to} is ignored. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
728 @end defun |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
729 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
730 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
|
731 system, with completion. @xref{Completion}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
732 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
733 @defun read-coding-system prompt &optional default |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
734 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
|
735 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
|
736 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
|
737 to return. It should be a symbol or a string. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
738 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
739 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
740 @defun read-non-nil-coding-system prompt |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
741 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
|
742 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
|
743 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
|
744 @xref{Coding Systems}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
745 @end defun |
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 @node Default Coding Systems |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
748 @subsection Default Coding Systems |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
749 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
750 This section describes variables that specify the default coding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
751 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
|
752 function that I/O operations use to access them. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
753 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
754 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
|
755 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
|
756 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
|
757 don't change these variables; instead, override them using |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
758 @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
|
759 (@pxref{Specifying Coding Systems}). |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
760 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
761 @defvar file-coding-system-alist |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
762 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
|
763 reading and writing particular files. Each element has the form |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
764 @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
|
765 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
|
766 names that match @var{pattern}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
767 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
768 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
|
769 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
|
770 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
|
771 that coding system is used for both reading the file and writing it. If |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
772 @var{coding} is a cons cell containing two coding systems, its @sc{car} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
773 specifies the coding system for decoding, and its @sc{cdr} specifies the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
774 coding system for encoding. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
775 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
776 If @var{coding} is a function name, the function must return a coding |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
777 system or a cons cell containing two coding systems. This value is used |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
778 as described above. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
779 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
780 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
781 @defvar process-coding-system-alist |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
782 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
|
783 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
|
784 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
|
785 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
|
786 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
|
787 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
|
788 other coding systems later using @code{set-process-coding-system}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
789 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
790 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
791 @strong{Warning:} Coding systems such as @code{undecided}, which |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
792 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
|
793 with asynchronous subprocess output. This is because Emacs handles |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
794 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
|
795 system leaves the character code conversion unspecified, or leaves the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
796 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
|
797 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
|
798 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
799 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
|
800 coding system which determines both the character code conversion and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
801 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
|
802 rather than @code{undecided} or @code{latin-1}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
803 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
804 @defvar network-coding-system-alist |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
805 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
|
806 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
|
807 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
|
808 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
|
809 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
|
810 stream. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
811 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
812 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
813 @defvar default-process-coding-system |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
814 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
|
815 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
|
816 do. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
817 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
818 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
|
819 . @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
|
820 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
|
821 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
822 |
21006 | 823 @defun find-operation-coding-system operation &rest arguments |
824 This function returns the coding system to use (by default) for | |
825 performing @var{operation} with @var{arguments}. The value has this | |
826 form: | |
827 | |
828 @example | |
829 (@var{decoding-system} @var{encoding-system}) | |
830 @end example | |
831 | |
832 The first element, @var{decoding-system}, is the coding system to use | |
833 for decoding (in case @var{operation} does decoding), and | |
834 @var{encoding-system} is the coding system for encoding (in case | |
835 @var{operation} does encoding). | |
836 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
837 The argument @var{operation} should be a symbol, one of |
21006 | 838 @code{insert-file-contents}, @code{write-region}, @code{call-process}, |
839 @code{call-process-region}, @code{start-process}, or | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
840 @code{open-network-stream}. These are the names of the Emacs I/O primitives |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
841 that can do coding system conversion. |
21006 | 842 |
843 The remaining arguments should be the same arguments that might be given | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
844 to that I/O primitive. Depending on the primitive, one of those |
21006 | 845 arguments is selected as the @dfn{target}. For example, if |
846 @var{operation} does file I/O, whichever argument specifies the file | |
847 name is the target. For subprocess primitives, the process name is the | |
848 target. For @code{open-network-stream}, the target is the service name | |
849 or port number. | |
850 | |
851 This function looks up the target in @code{file-coding-system-alist}, | |
852 @code{process-coding-system-alist}, or | |
853 @code{network-coding-system-alist}, depending on @var{operation}. | |
854 @xref{Default Coding Systems}. | |
855 @end defun | |
856 | |
857 @node Specifying Coding Systems | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
858 @subsection Specifying a Coding System for One Operation |
21006 | 859 |
860 You can specify the coding system for a specific operation by binding | |
861 the variables @code{coding-system-for-read} and/or | |
862 @code{coding-system-for-write}. | |
863 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
864 @defvar coding-system-for-read |
21006 | 865 If this variable is non-@code{nil}, it specifies the coding system to |
866 use for reading a file, or for input from a synchronous subprocess. | |
867 | |
868 It also applies to any asynchronous subprocess or network stream, but in | |
869 a different way: the value of @code{coding-system-for-read} when you | |
870 start the subprocess or open the network stream specifies the input | |
871 decoding method for that subprocess or network stream. It remains in | |
872 use for that subprocess or network stream unless and until overridden. | |
873 | |
874 The right way to use this variable is to bind it with @code{let} for a | |
875 specific I/O operation. Its global value is normally @code{nil}, and | |
876 you should not globally set it to any other value. Here is an example | |
877 of the right way to use the variable: | |
878 | |
879 @example | |
880 ;; @r{Read the file with no character code conversion.} | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
881 ;; @r{Assume @sc{crlf} represents end-of-line.} |
21006 | 882 (let ((coding-system-for-write 'emacs-mule-dos)) |
883 (insert-file-contents filename)) | |
884 @end example | |
885 | |
886 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
|
887 precedence over all other methods of specifying a coding system to use for |
21006 | 888 input, including @code{file-coding-system-alist}, |
889 @code{process-coding-system-alist} and | |
890 @code{network-coding-system-alist}. | |
891 @end defvar | |
892 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
893 @defvar coding-system-for-write |
21006 | 894 This works much like @code{coding-system-for-read}, except that it |
895 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
|
896 as well as sending output to subprocesses and net connections. |
21006 | 897 |
898 When a single operation does both input and output, as do | |
899 @code{call-process-region} and @code{start-process}, both | |
900 @code{coding-system-for-read} and @code{coding-system-for-write} | |
901 affect it. | |
902 @end defvar | |
903 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
904 @defvar inhibit-eol-conversion |
21006 | 905 When this variable is non-@code{nil}, no end-of-line conversion is done, |
906 no matter which coding system is specified. This applies to all the | |
907 Emacs I/O and subprocess primitives, and to the explicit encoding and | |
908 decoding functions (@pxref{Explicit Encoding}). | |
909 @end defvar | |
910 | |
911 @node Explicit Encoding | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
912 @subsection Explicit Encoding and Decoding |
21006 | 913 @cindex encoding text |
914 @cindex decoding text | |
915 | |
916 All the operations that transfer text in and out of Emacs have the | |
917 ability to use a coding system to encode or decode the text. | |
918 You can also explicitly encode and decode text using the functions | |
919 in this section. | |
920 | |
921 @cindex raw bytes | |
922 The result of encoding, and the input to decoding, are not ordinary | |
923 text. They are ``raw bytes''---bytes that represent text in the same | |
924 way that an external file would. When a buffer contains raw bytes, it | |
925 is most natural to mark that buffer as using unibyte representation, | |
926 using @code{set-buffer-multibyte} (@pxref{Selecting a Representation}), | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
927 but this is not required. If the buffer's contents are only temporarily |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
928 raw, leave the buffer multibyte, which will be correct after you decode |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
929 them. |
21006 | 930 |
931 The usual way to get raw bytes in a buffer, for explicit decoding, is | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
932 to read them from a file with @code{insert-file-contents-literally} |
21006 | 933 (@pxref{Reading from Files}) or specify a non-@code{nil} @var{rawfile} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
934 argument when visiting a file with @code{find-file-noselect}. |
21006 | 935 |
936 The usual way to use the raw bytes that result from explicitly | |
937 encoding text is to copy them to a file or process---for example, to | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
938 write them with @code{write-region} (@pxref{Writing to Files}), and |
21006 | 939 suppress encoding for that @code{write-region} call by binding |
940 @code{coding-system-for-write} to @code{no-conversion}. | |
941 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
942 Raw bytes typically contain stray individual bytes with values in the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
943 range 128 through 255, that are legitimate only as part of multibyte |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
944 sequences. Even if the buffer is multibyte, Emacs treats each such |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
945 individual byte as a character and uses the byte value as its character |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
946 code. In this way, character codes 128 through 255 can be found in a |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
947 multibyte buffer, even though they are not legitimate multibyte |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
948 character codes. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
949 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
950 Raw bytes sometimes contain overlong byte-sequences that look like a |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
951 proper multibyte character plus extra superfluous trailing codes. For |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
952 most purposes, Emacs treats such a sequence in a buffer or string as a |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
953 single character, and if you look at its character code, you get the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
954 value that corresponds to the multibyte character |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
955 sequence---disregarding the extra trailing codes. This is not quite |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
956 clean, but raw bytes are used only in limited ways, so as a practical |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
957 matter it is not worth the trouble to treat this case differently. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
958 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
959 When a multibyte buffer contains illegitimate byte sequences, |
24952 | 960 sometimes insertion or deletion can cause them to coalesce into a |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
961 legitimate multibyte character. For example, suppose the buffer |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
962 contains the sequence 129 68 192, 68 being the character @samp{D}. If |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
963 you delete the @samp{D}, the bytes 129 and 192 become adjacent, and thus |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
964 become one multibyte character (Latin-1 A with grave accent). Point |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
965 moves to one side or the other of the character, since it cannot be |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
966 within a character. Don't be alarmed by this. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
967 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
968 Some really peculiar situations prevent proper coalescence. For |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
969 example, if you narrow the buffer so that the accessible portion begins |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
970 just before the @samp{D}, then delete the @samp{D}, the two surrounding |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
971 bytes cannot coalesce because one of them is outside the accessible |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
972 portion of the buffer. In this case, the deletion cannot be done, so |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
973 @code{delete-region} signals an error. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
974 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
975 Here are the functions to perform explicit encoding or decoding. The |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
976 decoding functions produce ``raw bytes''; the encoding functions are |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
977 meant to operate on ``raw bytes''. All of these functions discard text |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23433
diff
changeset
|
978 properties. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
979 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
980 @defun encode-coding-region start end coding-system |
21006 | 981 This function 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
|
982 to coding system @var{coding-system}. The encoded text replaces the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
983 original text in the buffer. The result of encoding is ``raw bytes,'' |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
984 but the buffer remains multibyte if it was multibyte before. |
21006 | 985 @end defun |
986 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
987 @defun encode-coding-string string coding-system |
21006 | 988 This function encodes the text in @var{string} according to coding |
989 system @var{coding-system}. It returns a new string containing the | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
990 encoded text. The result of encoding is a unibyte string of ``raw bytes.'' |
21006 | 991 @end defun |
992 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
993 @defun decode-coding-region start end coding-system |
21006 | 994 This function decodes the text from @var{start} to @var{end} according |
995 to coding system @var{coding-system}. The decoded text replaces the | |
996 original text in the buffer. To make explicit decoding useful, the text | |
997 before decoding ought to be ``raw bytes.'' | |
998 @end defun | |
999 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1000 @defun decode-coding-string string coding-system |
21006 | 1001 This function decodes the text in @var{string} according to coding |
1002 system @var{coding-system}. It returns a new string containing the | |
1003 decoded text. To make explicit decoding useful, the contents of | |
1004 @var{string} ought to be ``raw bytes.'' | |
1005 @end defun | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1006 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1007 @node Terminal I/O Encoding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1008 @subsection Terminal I/O Encoding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1009 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1010 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
|
1011 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
|
1012 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
|
1013 @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
|
1014 terminal. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1015 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1016 @defun keyboard-coding-system |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1017 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
|
1018 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
|
1019 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1020 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1021 @defun set-keyboard-coding-system coding-system |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1022 This function specifies @var{coding-system} as the coding system to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1023 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
|
1024 that means do not decode keyboard input. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1025 @end defun |
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 @defun terminal-coding-system |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1028 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
|
1029 terminal output---or @code{nil} for no encoding. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1030 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1031 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1032 @defun set-terminal-coding-system coding-system |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1033 This function specifies @var{coding-system} as the coding system to use |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1034 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
|
1035 that means do not encode terminal output. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1036 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1037 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1038 @node MS-DOS File Types |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1039 @subsection MS-DOS File Types |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1040 @cindex DOS file types |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1041 @cindex MS-DOS file types |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1042 @cindex Windows file types |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1043 @cindex file types on MS-DOS and Windows |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1044 @cindex text files and binary files |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1045 @cindex binary files and text files |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1046 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1047 On MS-DOS and Microsoft Windows, Emacs guesses the appropriate |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1048 end-of-line conversion for a file by looking at the file's name. This |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1049 feature classifies fils as @dfn{text files} and @dfn{binary files}. By |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1050 ``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
|
1051 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
|
1052 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
|
1053 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
|
1054 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
|
1055 end-of-line conversion. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1056 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1057 @defvar buffer-file-type |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1058 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
|
1059 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
|
1060 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
|
1061 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
|
1062 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
|
1063 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
|
1064 Otherwise, @code{undecided-dos} is used. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1065 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1066 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
|
1067 @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
|
1068 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1069 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1070 @defopt file-name-buffer-file-type-alist |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1071 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
|
1072 Each element has the form (@var{regexp} . @var{type}), where |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1073 @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
|
1074 @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
|
1075 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
|
1076 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
|
1077 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1078 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
|
1079 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
|
1080 @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
|
1081 is used. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1082 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1083 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
|
1084 @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
|
1085 @end defopt |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1086 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1087 @defopt default-buffer-file-type |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1088 This variable says how to handle files for which |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1089 @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
|
1090 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1091 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
|
1092 binary: the coding system @code{no-conversion} is used. Otherwise, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1093 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
|
1094 from the file contents, in the usual Emacs fashion. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1095 @end defopt |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1096 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1097 @node Input Methods |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1098 @section Input Methods |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1099 @cindex input methods |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1100 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1101 @dfn{Input methods} provide convenient ways of entering non-@sc{ascii} |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1102 characters from the keyboard. Unlike coding systems, which translate |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1103 non-@sc{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
|
1104 programs, input methods provide human-friendly commands. (@xref{Input |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1105 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
|
1106 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
|
1107 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
|
1108 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1109 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
|
1110 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
|
1111 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1112 @defvar current-input-method |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1113 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
|
1114 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
|
1115 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
|
1116 buffer now. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1117 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1118 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1119 @defvar default-input-method |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1120 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
|
1121 input method. Unlike @code{current-input-method}, this variable is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1122 normally global. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1123 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21006
diff
changeset
|
1124 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1125 @defun set-input-method input-method |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1126 This function activates input method @var{input-method} for the current |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1127 buffer. It also sets @code{default-input-method} to @var{input-method}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1128 If @var{input-method} is @code{nil}, this function deactivates any input |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1129 method for the current buffer. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1130 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1131 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1132 @defun read-input-method-name prompt &optional default inhibit-null |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1133 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
|
1134 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
|
1135 by default, if the user enters empty input. However, if |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1136 @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
|
1137 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1138 The returned value is a string. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1139 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1140 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1141 @defvar input-method-alist |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1142 This variable defines all the supported input methods. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1143 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
|
1144 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1145 @example |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1146 (@var{input-method} @var{language-env} @var{activate-func} |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1147 @var{title} @var{description} @var{args}...) |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1148 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1149 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1150 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
|
1151 @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
|
1152 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
|
1153 documentation purposes.) |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1154 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1155 @var{title} is a string to display in the mode line while this method is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1156 active. @var{description} is a string describing this method and what |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1157 it is good for. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1158 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1159 @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
|
1160 @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
|
1161 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
|
1162 the @var{args}. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1163 @end defvar |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1164 |
23110
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
1165 The fundamental interface to input methods is through the |
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
1166 variable @code{input-method-function}. @xref{Reading One Event}. |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1167 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1168 @node Locales |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1169 @section Locales |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1170 @cindex locale |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1171 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1172 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
|
1173 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
|
1174 how Emacs interacts with these features. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1175 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1176 @defvar locale-coding-system |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1177 @tindex locale-coding-system |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1178 This variable specifies the coding system to use for decoding system |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1179 error messages, for encoding the format argument to |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1180 @code{format-time-string}, and for decoding the return value of |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1181 @code{format-time-string}. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1182 @end defvar |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1183 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1184 @defvar system-messages-locale |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1185 @tindex system-messages-locale |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1186 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
|
1187 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
|
1188 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
|
1189 @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
|
1190 usual POSIX fashion. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1191 @end defvar |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1192 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1193 @defvar system-time-locale |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1194 @tindex system-time-locale |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1195 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
|
1196 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
|
1197 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
|
1198 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
|
1199 @end defvar |