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